From 0f4607b187fcfeea94cef7ebd70935a3295f4443 Mon Sep 17 00:00:00 2001 From: Gerry Tan Date: Fri, 27 Sep 2024 12:04:52 +1000 Subject: [PATCH 01/47] Add typespec-csharp config for .NET SDK code generation (#30736) * typespec-csharp config for AzureTerraform * Rename AzureTerraform to Terraform --- .../Microsoft.AzureTerraform.Management/tspconfig.yaml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/specification/terraform/Microsoft.AzureTerraform.Management/tspconfig.yaml b/specification/terraform/Microsoft.AzureTerraform.Management/tspconfig.yaml index 2b37c676ebf5..b0969fdd42f9 100644 --- a/specification/terraform/Microsoft.AzureTerraform.Management/tspconfig.yaml +++ b/specification/terraform/Microsoft.AzureTerraform.Management/tspconfig.yaml @@ -7,6 +7,12 @@ options: emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/export.json" + "@azure-tools/typespec-csharp": + flavor: azure + package-dir: "Azure.ResourceManager.Terraform" + clear-output-folder: true + model-namespace: false + namespace: "{package-dir}" linter: extends: - "@azure-tools/typespec-azure-rulesets/resource-manager" From 937a53377c2585f81e34b3a1622aed6b1d622954 Mon Sep 17 00:00:00 2001 From: Weidong Xu Date: Fri, 27 Sep 2024 11:03:41 +0800 Subject: [PATCH 02/47] mgmt, codesigning, update tspconfig (#30744) * mgmt, codesigning, update tspconfig * Update python config * Update tspconfig.yaml * update client name for python * Update client.tsp * Update tspconfig.yaml * Update tspconfig.yaml for go --------- Co-authored-by: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com> Co-authored-by: ChenxiJiang333 Co-authored-by: Chenjie Shi --- .../CodeSigning.Management/client.tsp | 7 ++++ .../CodeSigning.Management/tspconfig.yaml | 36 +++++++++++++++++++ 2 files changed, 43 insertions(+) create mode 100644 specification/codesigning/CodeSigning.Management/client.tsp diff --git a/specification/codesigning/CodeSigning.Management/client.tsp b/specification/codesigning/CodeSigning.Management/client.tsp new file mode 100644 index 000000000000..740e592dc8e0 --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/client.tsp @@ -0,0 +1,7 @@ +import "./main.tsp"; +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; + +@@clientName(Microsoft.CodeSigning, "TrustedSigningMgmt", "python"); +@@clientName(Microsoft.CodeSigning, "TrustedSigningManagementClient", "java"); diff --git a/specification/codesigning/CodeSigning.Management/tspconfig.yaml b/specification/codesigning/CodeSigning.Management/tspconfig.yaml index 78c952a12b48..a500693e0357 100644 --- a/specification/codesigning/CodeSigning.Management/tspconfig.yaml +++ b/specification/codesigning/CodeSigning.Management/tspconfig.yaml @@ -1,3 +1,6 @@ +parameters: + "service-dir": + default: "sdk/trustedsigning" emit: - "@azure-tools/typespec-autorest" options: @@ -9,6 +12,39 @@ options: # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/codeSigningAccount.json" + "@azure-tools/typespec-java": + package-dir: "azure-resourcemanager-trustedsigning" + flavor: "azure" + namespace: "com.azure.resourcemanager.trustedsigning" + service-name: "Trusted Signing" + "@azure-tools/typespec-python": + package-dir: "azure-mgmt-trustedsigning" + package-name: "{package-dir}" + flavor: "azure" + generate-test: true + generate-sample: true + "@azure-tools/typespec-ts": + azureSdkForJs: true + isModularLibrary: true + generateMetadata: true + hierarchyClient: false + experimentalExtensibleEnums: true + enableOperationGroup: true + package-dir: "arm-trustedsigning" + flavor: "azure" + packageDetails: + name: "@azure/arm-trustedsigning" + "@azure-tools/typespec-go": + service-dir: "sdk/resourcemanager/trustedsigning" + package-dir: "armtrustedsigning" + module: "github.com/Azure/azure-sdk-for-go/{service-dir}/{package-dir}" + fix-const-stuttering: true + flavor: "azure" + generate-examples: true + generate-fakes: true + head-as-boolean: true + inject-spans: true + remove-unreferenced-types: true linter: extends: - "@azure-tools/typespec-azure-rulesets/resource-manager" From dc48f088106007d25303d5142e76f625d22d67e5 Mon Sep 17 00:00:00 2001 From: Jian Chen Date: Fri, 27 Sep 2024 13:19:07 +0800 Subject: [PATCH 03/47] [Service Linker] add 24-07-01-preview api version (#30743) * add 24-07-01-preview --------- Co-authored-by: Bryce Chen --- .../examples/ConfigurationNamesList.json | 52 + .../examples/ConnectorDryrunCreate.json | 116 + .../examples/ConnectorDryrunDelete.json | 13 + .../examples/ConnectorDryrunGet.json | 33 + .../examples/ConnectorDryrunList.json | 36 + .../examples/ConnectorDryrunUpdate.json | 78 + .../examples/ConnectorList.json | 34 + .../examples/Connectors.json | 43 + .../examples/DeleteConnector.json | 18 + .../examples/DeleteDryrun.json | 11 + .../examples/DeleteLinker.json | 16 + .../examples/GenerateConfigurations.json | 26 + .../examples/GetConfigurations.json | 41 + .../examples/GetDaprConfigurations.json | 33 + .../examples/GetDryrun.json | 32 + .../2024-07-01-preview/examples/Linker.json | 47 + .../LinkerGenerateConfigurations.json | 24 + .../examples/LinkerList.json | 32 + .../examples/ListDryrun.json | 35 + .../examples/OperationsList.json | 184 ++ .../examples/PatchConnector.json | 64 + .../examples/PatchDryrun.json | 77 + .../examples/PatchLinker.json | 59 + .../examples/PutConnector.json | 63 + .../examples/PutDryrun.json | 116 + .../examples/PutLinker.json | 68 + .../examples/ValidateConnectorSuccess.json | 38 + .../examples/ValidateLinkerSuccess.json | 38 + .../2024-07-01-preview/servicelinker.json | 2937 +++++++++++++++++ .../servicelinker/resource-manager/readme.md | 11 +- 30 files changed, 4374 insertions(+), 1 deletion(-) create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConfigurationNamesList.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunCreate.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunDelete.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunGet.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunList.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunUpdate.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorList.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/Connectors.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteConnector.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteDryrun.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteLinker.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GenerateConfigurations.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetConfigurations.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetDaprConfigurations.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetDryrun.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/Linker.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/LinkerGenerateConfigurations.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/LinkerList.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ListDryrun.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/OperationsList.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchConnector.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchDryrun.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchLinker.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutConnector.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutDryrun.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutLinker.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ValidateConnectorSuccess.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ValidateLinkerSuccess.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/servicelinker.json diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConfigurationNamesList.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConfigurationNamesList.json new file mode 100644 index 000000000000..57c406a4b875 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConfigurationNamesList.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "targetService": "MICROSOFT.APPCONFIGURATION/CONFIGURATIONSTORES", + "clientType": "none", + "authType": "systemAssignedIdentity", + "names": [ + { + "value": "AZURE_APPCONFIGURATION_ENDPOINT", + "description": "App configuration endpoint" + }, + { + "value": "AZURE_APPCONFIGURATION_SCOPE", + "description": "The scopes required for the token." + } + ] + } + }, + { + "properties": { + "targetService": "MICROSOFT.APPCONFIGURATION/CONFIGURATIONSTORES", + "clientType": "none", + "authType": "userAssignedIdentity", + "names": [ + { + "value": "AZURE_APPCONFIGURATION_ENDPOINT", + "description": "App configuration endpoint" + }, + { + "value": "AZURE_APPCONFIGURATION_CLIENTID", + "description": "The client(application) ID of the user identity." + }, + { + "value": "AZURE_APPCONFIGURATION_SCOPE", + "description": "The scopes required for getting token." + } + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunCreate.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunCreate.json new file mode 100644 index 000000000000..d4103f9d88e4 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunCreate.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "dryrunName": "dryrunName", + "parameters": { + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name", + "secretInfo": { + "secretType": "rawValue", + "value": "secret" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "dryrunName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/locations/westus/dryruns/dryrunName", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name" + } + }, + "prerequisiteResults": [ + { + "type": "basicError", + "code": "ResourceNotFound", + "message": "Target resource is not found" + }, + { + "type": "permissionsMissing", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc", + "permissions": [ + "Microsoft.DocumentDb/databaseAccounts/write" + ] + } + ], + "operationPreviews": [ + { + "name": "configFirewallRule", + "operationType": "configNetwork", + "description": "Config firewall rule for target service to allow source service access", + "action": "Microsoft.DocumentDb/databaseAccounts/write", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc" + } + ], + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "dryrunName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/locations/westus/dryruns/dryrunName", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name" + } + }, + "prerequisiteResults": [ + { + "type": "basicError", + "code": "ResourceNotFound", + "message": "Target resource is not found" + }, + { + "type": "permissionsMissing", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc", + "permissions": [ + "Microsoft.DocumentDb/databaseAccounts/write" + ] + } + ], + "operationPreviews": [ + { + "name": "configFirewallRule", + "operationType": "configNetwork", + "description": "Config firewall rule for target service to allow source service access", + "action": "Microsoft.DocumentDb/databaseAccounts/write", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc" + } + ], + "provisioningState": "Accepted" + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunDelete.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunDelete.json new file mode 100644 index 000000000000..d1cd053dfdf2 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "dryrunName": "dryrunName" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunGet.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunGet.json new file mode 100644 index 000000000000..e9fab0f0d0fb --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "dryrunName": "dryrunName" + }, + "responses": { + "200": { + "body": { + "name": "dryrunName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/locations/westus/dryruns/dryrunName", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "authInfo": { + "authType": "secret", + "name": "username" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + }, + "systemData": { + "createdAt": "2020-07-12T22:05:09Z" + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunList.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunList.json new file mode 100644 index 000000000000..b0d6cb39937d --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunList.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dryrunName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/locations/westus/dryruns/dryrunName", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "authInfo": { + "authType": "secret", + "name": "username" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + }, + "systemData": { + "createdAt": "2020-07-12T22:05:09Z" + } + } + ] + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunUpdate.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunUpdate.json new file mode 100644 index 000000000000..3f87be091230 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunUpdate.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "dryrunName": "dryrunName", + "parameters": { + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name", + "secretInfo": { + "secretType": "rawValue", + "value": "secret" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "dryrunName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/locations/westus/dryruns/dryrunName", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name" + } + }, + "prerequisiteResults": [ + { + "type": "basicError", + "code": "ResourceNotFound", + "message": "Target resource is not found" + }, + { + "type": "permissionsMissing", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc", + "permissions": [ + "Microsoft.DocumentDb/databaseAccounts/write" + ] + } + ], + "operationPreviews": [ + { + "name": "configFirewallRule", + "operationType": "configNetwork", + "description": "Config firewall rule for target service to allow source service access", + "action": "Microsoft.DocumentDb/databaseAccounts/write", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc" + } + ], + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorList.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorList.json new file mode 100644 index 000000000000..ac02963e6953 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/linkers/linkName", + "name": "linkName", + "type": "Microsoft.ServiceLinker/devConnectors", + "properties": { + "authInfo": { + "authType": "secret", + "name": "username" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + }, + "systemData": { + "createdAt": "2020-07-12T22:05:09Z" + } + } + ] + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/Connectors.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/Connectors.json new file mode 100644 index 000000000000..b774d9142b09 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/Connectors.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "connectorName": "connectorName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/devConnnectors/linkName", + "name": "linkName", + "type": "Microsoft.ServiceLinker/devConnectors", + "properties": { + "authInfo": { + "authType": "systemAssignedIdentity", + "roles": [ + "customizedOwner" + ] + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "publicNetworkSolution": { + "firewallRules": { + "ipRanges": [ + "182.22.120" + ], + "callerClientIP": "true" + }, + "action": "enable", + "deleteOrUpdateBehavior": "ForcedCleanup" + } + }, + "systemData": { + "createdAt": "2020-07-12T22:05:09Z" + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteConnector.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteConnector.json new file mode 100644 index 000000000000..1dc02aed0953 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteConnector.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "connectorName": "connectorName" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteDryrun.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteDryrun.json new file mode 100644 index 000000000000..b6d84517cba6 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteDryrun.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "dryrunName": "dryrunName" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteLinker.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteLinker.json new file mode 100644 index 000000000000..a2eb35ce6361 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteLinker.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "linkerName": "linkName" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GenerateConfigurations.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GenerateConfigurations.json new file mode 100644 index 000000000000..b51f80725ab6 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GenerateConfigurations.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "connectorName": "connectorName", + "parameters": { + "customizedKeys": { + "ASL_DocumentDb_ConnectionString": "MyConnectionstring" + } + } + }, + "responses": { + "200": { + "body": { + "configurations": [ + { + "name": "MyConnectionstring", + "value": "ConnectionString" + } + ] + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetConfigurations.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetConfigurations.json new file mode 100644 index 000000000000..39d787a2211d --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetConfigurations.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.App/containerApps/test-app", + "linkerName": "linkName" + }, + "responses": { + "200": { + "body": { + "configurations": [ + { + "name": "AZURE_POSTGRESQL_HOST", + "value": "Host", + "configType": "Default" + }, + { + "name": "AZURE_POSTGRESQL_USER", + "value": "Username", + "configType": "Default" + }, + { + "name": "AZURE_POSTGRESQL_DATABASE", + "value": "DatabaseName", + "configType": "Default" + }, + { + "name": "AZURE_POSTGRESQL_PORT", + "value": "Port", + "configType": "Default" + }, + { + "name": "AZURE_POSTGRESQL_PASSWORD", + "value": "SecretUri", + "configType": "KeyVaultSecret", + "keyVaultReferenceIdentity": "system" + } + ] + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetDaprConfigurations.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetDaprConfigurations.json new file mode 100644 index 000000000000..cdbc03e325fc --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetDaprConfigurations.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "targetType": "MICROSOFT.STORAGE/STORAGEACCOUNTS/BLOBSERVICES", + "authType": "secret", + "daprProperties": { + "version": "v1", + "componentType": "bindings", + "runtimeVersion": "1.10", + "bindingComponentDirection": "input", + "metadata": [ + { + "name": "containerName", + "description": "The name of the container to be used for Dapr state.", + "required": "true" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetDryrun.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetDryrun.json new file mode 100644 index 000000000000..6545c44b1163 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetDryrun.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "dryrunName": "dryrunName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/dryruns/dryrunName", + "name": "dryrunName", + "type": "Microsoft.ServiceLinker/dryruns", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "authInfo": { + "authType": "secret", + "name": "username" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + }, + "systemData": { + "createdAt": "2020-07-12T22:05:09Z" + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/Linker.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/Linker.json new file mode 100644 index 000000000000..eabc04aa76e7 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/Linker.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "linkerName": "linkName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName", + "name": "linkName", + "type": "Microsoft.ServiceLinker/links", + "properties": { + "authInfo": { + "authType": "secret", + "name": "name" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "secretStore": { + "keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/kvname" + }, + "scope": "AKS-Namespace", + "clientType": "dotnet", + "publicNetworkSolution": { + "action": "enable" + }, + "configurationInfo": { + "deleteOrUpdateBehavior": "ForcedCleanup", + "customizedKeys": { + "AZURE_MYSQL_CONNECTIONSTRING": "myConnectionstring", + "AZURE_MYSQL_SSLMODE": "mySslmode" + }, + "additionalConfigurations": { + "throttlingLimit": "100" + } + } + }, + "systemData": { + "createdAt": "2020-07-12T22:05:09Z" + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/LinkerGenerateConfigurations.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/LinkerGenerateConfigurations.json new file mode 100644 index 000000000000..20077dc3ba0b --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/LinkerGenerateConfigurations.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "linkerName": "linkName", + "parameters": { + "customizedKeys": { + "ASL_DocumentDb_ConnectionString": "MyConnectionstring" + } + } + }, + "responses": { + "200": { + "body": { + "configurations": [ + { + "name": "MyConnectionstring", + "value": "ConnectionString" + } + ] + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/LinkerList.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/LinkerList.json new file mode 100644 index 000000000000..99a8f52427c4 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/LinkerList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/links/linkName", + "name": "linkName", + "type": "Microsoft.ServiceLinker/links", + "properties": { + "authInfo": { + "authType": "secret", + "name": "username" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + }, + "systemData": { + "createdAt": "2020-07-12T22:05:09Z" + } + } + ] + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ListDryrun.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ListDryrun.json new file mode 100644 index 000000000000..4a8dde8c63f0 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ListDryrun.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/dryruns/dryrunName", + "name": "dryrunName", + "type": "Microsoft.ServiceLinker/dryruns", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "authInfo": { + "authType": "secret", + "name": "username" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + }, + "systemData": { + "createdAt": "2020-07-12T22:05:09Z" + } + } + ] + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/OperationsList.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/OperationsList.json new file mode 100644 index 000000000000..905bfe616da0 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/OperationsList.json @@ -0,0 +1,184 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "display": { + "description": "Register the subscription for Microsoft.ServiceLinker", + "operation": "Register the Microsoft.ServiceLinker", + "provider": "Microsoft.ServiceLinker", + "resource": "Microsoft.ServiceLinker" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/register/action" + }, + { + "display": { + "description": "Unregister the subscription for Microsoft.ServiceLinker", + "operation": "Unregister the Microsoft.ServiceLinker", + "provider": "Microsoft.ServiceLinker", + "resource": "Microsoft.ServiceLinker" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/unregister/action" + }, + { + "display": { + "description": "read operations", + "operation": "read_operations", + "provider": "Microsoft.ServiceLinker", + "resource": "operations" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/operations/read" + }, + { + "display": { + "description": "list dryrun jobs", + "operation": "Dryrun_List", + "provider": "Microsoft.ServiceLinker", + "resource": "dryruns" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/dryruns/read" + }, + { + "display": { + "description": "get a dryrun job", + "operation": "Dryrun_Get", + "provider": "Microsoft.ServiceLinker", + "resource": "dryruns" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/dryruns/read" + }, + { + "display": { + "description": "create a dryrun job to do necessary check before actual creation", + "operation": "Dryrun_Create", + "provider": "Microsoft.ServiceLinker", + "resource": "dryruns" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/dryruns/write" + }, + { + "display": { + "description": "delete a dryrun job", + "operation": "Dryrun_Delete", + "provider": "Microsoft.ServiceLinker", + "resource": "dryruns" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/dryruns/delete" + }, + { + "display": { + "description": "add a dryrun job to do necessary check before actual creation", + "operation": "Dryrun_Update", + "provider": "Microsoft.ServiceLinker", + "resource": "dryruns" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/dryruns/write" + }, + { + "display": { + "description": "read operationStatuses", + "operation": "read_operationStatuses", + "provider": "Microsoft.ServiceLinker", + "resource": "locations/operationStatuses" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/locations/operationStatuses/read" + }, + { + "display": { + "description": "write operationStatuses", + "operation": "write_operationStatuses", + "provider": "Microsoft.ServiceLinker", + "resource": "locations/operationStatuses" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/locations/operationStatuses/write" + }, + { + "display": { + "description": "Returns list of Linkers which connects to the resource.", + "operation": "Linker_List", + "provider": "Microsoft.ServiceLinker", + "resource": "linkers" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/linkers/read" + }, + { + "display": { + "description": "Returns Linker resource for a given name.", + "operation": "Linker_Get", + "provider": "Microsoft.ServiceLinker", + "resource": "linkers" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/linkers/read" + }, + { + "display": { + "description": "Create or update linker resource.", + "operation": "Linker_CreateOrUpdate", + "provider": "Microsoft.ServiceLinker", + "resource": "linkers" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/linkers/write" + }, + { + "display": { + "description": "Delete a link.", + "operation": "Linker_Delete", + "provider": "Microsoft.ServiceLinker", + "resource": "linkers" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/linkers/delete" + }, + { + "display": { + "description": "Operation to update an existing link.", + "operation": "Linker_Update", + "provider": "Microsoft.ServiceLinker", + "resource": "linkers" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/linkers/write" + }, + { + "display": { + "description": "Validate a link.", + "operation": "Linker_Validate", + "provider": "Microsoft.ServiceLinker", + "resource": "linkers" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/linkers/validateLinker/action" + }, + { + "display": { + "description": "list source configurations for a linker.", + "operation": "Linker_ListConfigurations", + "provider": "Microsoft.ServiceLinker", + "resource": "linkers" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/linkers/listConfigurations/action" + } + ] + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchConnector.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchConnector.json new file mode 100644 index 000000000000..a302ac667d38 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchConnector.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "connectorName": "connectorName", + "parameters": { + "properties": { + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "servicePrincipalSecret", + "clientId": "name", + "principalId": "id", + "secret": "secret" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName", + "type": "Microsoft.ServiceLinker/links", + "name": "linkName", + "properties": { + "authInfo": { + "authType": "servicePrincipalSecret", + "clientId": "name", + "principalId": "id" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName", + "type": "Microsoft.ServiceLinker/links", + "name": "linkName", + "properties": { + "authInfo": { + "authType": "servicePrincipalSecret", + "clientId": "name", + "principalId": "id" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchDryrun.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchDryrun.json new file mode 100644 index 000000000000..c7da10d3eac5 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchDryrun.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "dryrunName": "dryrunName", + "parameters": { + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name", + "secretInfo": { + "secretType": "rawValue", + "value": "secret" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/dryruns/dryrunName", + "type": "Microsoft.ServiceLinker/dryruns", + "name": "dryrunName", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name" + } + }, + "prerequisiteResults": [ + { + "type": "basicError", + "code": "ResourceNotFound", + "message": "Target resource is not found" + }, + { + "type": "permissionsMissing", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc", + "permissions": [ + "Microsoft.DocumentDb/databaseAccounts/write" + ] + } + ], + "operationPreviews": [ + { + "name": "configFirewallRule", + "operationType": "configNetwork", + "description": "Config firewall rule for target service to allow source service access", + "action": "Microsoft.DocumentDb/databaseAccounts/write", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc" + } + ], + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchLinker.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchLinker.json new file mode 100644 index 000000000000..6a85c703e63b --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchLinker.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "linkerName": "linkName", + "parameters": { + "properties": { + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "servicePrincipalSecret", + "clientId": "name", + "principalId": "id", + "secret": "secret" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName", + "type": "Microsoft.ServiceLinker/links", + "name": "linkName", + "properties": { + "authInfo": { + "authType": "servicePrincipalSecret", + "clientId": "name", + "principalId": "id" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName", + "type": "Microsoft.ServiceLinker/links", + "name": "linkName", + "properties": { + "authInfo": { + "authType": "servicePrincipalSecret", + "clientId": "name", + "principalId": "id" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutConnector.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutConnector.json new file mode 100644 index 000000000000..b85bfd26ae2e --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutConnector.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "connectorName": "connectorName", + "parameters": { + "properties": { + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret" + }, + "secretStore": { + "keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName", + "type": "Microsoft.ServiceLinker/links", + "name": "linkName", + "properties": { + "authInfo": { + "authType": "secret" + }, + "secretStore": { + "keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName", + "type": "Microsoft.ServiceLinker/links", + "name": "linkName", + "properties": { + "authInfo": { + "authType": "secret" + }, + "secretStore": { + "keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutDryrun.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutDryrun.json new file mode 100644 index 000000000000..65e6713bb9c6 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutDryrun.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "dryrunName": "dryrunName", + "parameters": { + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name", + "secretInfo": { + "secretType": "rawValue", + "value": "secret" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/dryruns/dryrunName", + "type": "Microsoft.ServiceLinker/dryruns", + "name": "dryrunName", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name" + } + }, + "prerequisiteResults": [ + { + "type": "basicError", + "code": "ResourceNotFound", + "message": "Target resource is not found" + }, + { + "type": "permissionsMissing", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc", + "permissions": [ + "Microsoft.DocumentDb/databaseAccounts/write" + ] + } + ], + "operationPreviews": [ + { + "name": "configFirewallRule", + "operationType": "configNetwork", + "description": "Config firewall rule for target service to allow source service access", + "action": "Microsoft.DocumentDb/databaseAccounts/write", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc" + } + ], + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/dryruns/dryrunName", + "type": "Microsoft.ServiceLinker/dryruns", + "name": "dryrunName", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name" + } + }, + "prerequisiteResults": [ + { + "type": "basicError", + "code": "ResourceNotFound", + "message": "Target resource is not found" + }, + { + "type": "permissionsMissing", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc", + "permissions": [ + "Microsoft.DocumentDb/databaseAccounts/write" + ] + } + ], + "operationPreviews": [ + { + "name": "configFirewallRule", + "operationType": "configNetwork", + "description": "Config firewall rule for target service to allow source service access", + "action": "Microsoft.DocumentDb/databaseAccounts/write", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc" + } + ], + "provisioningState": "Updating" + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutLinker.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutLinker.json new file mode 100644 index 000000000000..f678acb875be --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutLinker.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "linkerName": "linkName", + "parameters": { + "properties": { + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DBforPostgreSQL/servers/test-pg/databases/test-db" + }, + "vNetSolution": { + "type": "serviceEndpoint" + }, + "authInfo": { + "authType": "secret", + "name": "name", + "secretInfo": { + "secretType": "rawValue", + "value": "secret" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceLinker/links", + "name": "linkName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName", + "properties": { + "authInfo": { + "authType": "secret", + "name": "name" + }, + "vNetSolution": { + "type": "serviceEndpoint" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DBforPostgreSQL/servers/test-pg/databases/test-db" + } + } + } + }, + "201": { + "body": { + "type": "Microsoft.ServiceLinker/links", + "name": "linkName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName", + "properties": { + "authInfo": { + "authType": "secret", + "name": "name" + }, + "vNetSolution": { + "type": "serviceEndpoint" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DBforPostgreSQL/servers/test-pg/databases/test-db" + } + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ValidateConnectorSuccess.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ValidateConnectorSuccess.json new file mode 100644 index 000000000000..a2e570267b75 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ValidateConnectorSuccess.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "connectorName": "connectorName" + }, + "responses": { + "200": { + "body": { + "properties": { + "isConnectionAvailable": true, + "reportStartTimeUtc": "2020-07-12T22:05:09Z", + "reportEndTimeUtc": "2020-07-12T22:06:09Z", + "authType": "secret", + "validationDetail": [ + { + "name": "TargetExistence", + "description": "The target existence is validated", + "result": "success" + }, + { + "name": "TargetNetworkAccess", + "description": "Deny public network access is set to yes. Please confirm you are using private endpoint connection to access target resource.", + "result": "warning" + } + ] + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ValidateLinkerSuccess.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ValidateLinkerSuccess.json new file mode 100644 index 000000000000..3bb0f31ce67f --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ValidateLinkerSuccess.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "linkerName": "linkName" + }, + "responses": { + "200": { + "body": { + "properties": { + "isConnectionAvailable": true, + "reportStartTimeUtc": "2020-07-12T22:05:09Z", + "reportEndTimeUtc": "2020-07-12T22:06:09Z", + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db", + "targetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db", + "authType": "secret", + "validationDetail": [ + { + "name": "TargetExistence", + "description": "The target existence is validated", + "result": "success" + }, + { + "name": "TargetNetworkAccess", + "description": "Deny public network access is set to yes. Please confirm you are using private endpoint connection to access target resource.", + "result": "warning" + } + ] + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/servicelinker.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/servicelinker.json new file mode 100644 index 000000000000..3be7908389ae --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/servicelinker.json @@ -0,0 +1,2937 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.ServiceLinker", + "description": "Microsoft.ServiceLinker provider", + "version": "2024-07-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.ServiceLinker/locations/{location}/dryruns": { + "get": { + "tags": [ + "Connector" + ], + "operationId": "Connector_ListDryrun", + "description": "list dryrun jobs", + "x-ms-examples": { + "ConnectorDryrunList": { + "$ref": "./examples/ConnectorDryrunList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DryrunList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/dryruns/{dryrunName}": { + "get": { + "tags": [ + "Connector" + ], + "operationId": "Connector_GetDryrun", + "description": "get a dryrun job", + "x-ms-examples": { + "ConnectorDryrunGet": { + "$ref": "./examples/ConnectorDryrunGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dryrunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of dryrun.", + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DryrunResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Connector" + ], + "operationId": "Connector_CreateDryrun", + "description": "create a dryrun job to do necessary check before actual creation", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ConnectorDryrunCreate": { + "$ref": "./examples/ConnectorDryrunCreate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dryrunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of dryrun.", + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "description": "dryrun resource.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DryrunResource" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DryrunResource" + } + }, + "201": { + "description": "Long running operation", + "schema": { + "$ref": "#/definitions/DryrunResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Connector" + ], + "operationId": "Connector_UpdateDryrun", + "description": "update a dryrun job to do necessary check before actual creation", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ConnectorDryrunUpdate": { + "$ref": "./examples/ConnectorDryrunUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dryrunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of dryrun.", + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "description": "dryrun resource.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DryrunPatch" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DryrunResource" + } + }, + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Connector" + ], + "operationId": "Connector_DeleteDryrun", + "description": "delete a dryrun job", + "x-ms-examples": { + "ConnectorDryrunDelete": { + "$ref": "./examples/ConnectorDryrunDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dryrunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of dryrun.", + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "OK. The job is deleted." + }, + "204": { + "description": "Deleted. The job is not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors": { + "get": { + "deprecated": false, + "description": "Returns list of connector which connects to the resource, which supports to config the target service during the resource provision.", + "operationId": "Connector_List", + "x-ms-examples": { + "ConnectorList": { + "$ref": "./examples/ConnectorList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Connector details.", + "schema": { + "$ref": "#/definitions/ResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors/{connectorName}": { + "get": { + "description": "Returns Connector resource for a given name.", + "operationId": "Connector_Get", + "x-ms-examples": { + "Connector": { + "$ref": "./examples/Connectors.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ConnectorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Connector details.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "description": "Create or update Connector resource.", + "operationId": "Connector_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "PutConnector": { + "$ref": "./examples/PutConnector.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ConnectorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "description": "Connector details.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LinkerResource" + } + } + ], + "responses": { + "200": { + "description": "Successful.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "201": { + "description": "Long running operation.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Connector" + ], + "operationId": "Connector_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "description": "Delete a Connector.", + "x-ms-examples": { + "DeleteConnector": { + "$ref": "./examples/DeleteConnector.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ConnectorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The Connector is deleted." + }, + "202": { + "description": "Long running operation." + }, + "204": { + "description": "Deleted. The Connector is not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Connector" + ], + "operationId": "Connector_Update", + "description": "Operation to update an existing Connector.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "PatchConnector": { + "$ref": "./examples/PatchConnector.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ConnectorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "description": "Connector details.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LinkerPatch" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes a Connector.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "202": { + "description": "Long running operation.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors/{connectorName}/validate": { + "post": { + "tags": [ + "Connector" + ], + "operationId": "Connector_Validate", + "description": "Validate a Connector.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ValidateConnectorSuccess": { + "$ref": "./examples/ValidateConnectorSuccess.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ConnectorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ValidateOperationResult" + } + }, + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors/{connectorName}/generateConfigurations": { + "post": { + "tags": [ + "Connector" + ], + "operationId": "Connector_GenerateConfigurations", + "description": "Generate configurations for a Connector.", + "x-ms-examples": { + "GenerateConfiguration": { + "$ref": "./examples/GenerateConfigurations.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ConnectorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "description": "Connection Info, including format, secret store, etc", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ConfigurationInfo" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ConfigurationResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{resourceUri}/providers/Microsoft.ServiceLinker/linkers": { + "get": { + "deprecated": false, + "description": "Returns list of Linkers which connects to the resource. which supports to config both application and target service during the resource provision.", + "operationId": "Linker_List", + "x-ms-examples": { + "LinkerList": { + "$ref": "./examples/LinkerList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Linker details.", + "schema": { + "$ref": "#/definitions/ResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}": { + "get": { + "description": "Returns Linker resource for a given name.", + "operationId": "Linker_Get", + "x-ms-examples": { + "Linker": { + "$ref": "./examples/Linker.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LinkerNameParameter" + } + ], + "responses": { + "200": { + "description": "Linker details.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "description": "Create or update Linker resource.", + "operationId": "Linker_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "PutLinker": { + "$ref": "./examples/PutLinker.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LinkerNameParameter" + }, + { + "name": "parameters", + "description": "Linker details.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LinkerResource" + } + } + ], + "responses": { + "200": { + "description": "Successful.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "201": { + "description": "Long running operation.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Linkers" + ], + "operationId": "Linker_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "description": "Delete a Linker.", + "x-ms-examples": { + "DeleteLinker": { + "$ref": "./examples/DeleteLinker.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LinkerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The Linker is deleted." + }, + "202": { + "description": "Long running operation." + }, + "204": { + "description": "Deleted. The Linker is not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Linkers" + ], + "operationId": "Linker_Update", + "description": "Operation to update an existing Linker.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "PatchLinker": { + "$ref": "./examples/PatchLinker.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LinkerNameParameter" + }, + { + "name": "parameters", + "description": "Linker details.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LinkerPatch" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes a Linker.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "201": { + "description": "Long running operation.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}/validateLinker": { + "post": { + "tags": [ + "Linkers" + ], + "operationId": "Linker_Validate", + "description": "Validate a Linker.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ValidateLinkerSuccess": { + "$ref": "./examples/ValidateLinkerSuccess.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LinkerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ValidateOperationResult" + } + }, + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}/listConfigurations": { + "post": { + "tags": [ + "Linkers" + ], + "operationId": "Linker_ListConfigurations", + "description": "list source configurations for a Linker.", + "x-ms-examples": { + "GetConfiguration": { + "$ref": "./examples/GetConfigurations.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LinkerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ConfigurationResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{resourceUri}/providers/Microsoft.ServiceLinker/dryruns": { + "get": { + "tags": [ + "Linkers" + ], + "operationId": "Linkers_ListDryrun", + "description": "list dryrun jobs", + "x-ms-examples": { + "ListDryrun": { + "$ref": "./examples/ListDryrun.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DryrunList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.ServiceLinker/dryruns/{dryrunName}": { + "get": { + "tags": [ + "Linkers" + ], + "operationId": "Linkers_GetDryrun", + "description": "get a dryrun job", + "x-ms-examples": { + "GetDryrun": { + "$ref": "./examples/GetDryrun.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dryrunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of dryrun.", + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DryrunResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Linkers" + ], + "operationId": "Linkers_CreateDryrun", + "description": "create a dryrun job to do necessary check before actual creation", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "PutDryrun": { + "$ref": "./examples/PutDryrun.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dryrunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of dryrun.", + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "description": "dryrun resource.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DryrunResource" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DryrunResource" + } + }, + "201": { + "description": "Long running operation", + "schema": { + "$ref": "#/definitions/DryrunResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Linkers" + ], + "operationId": "Linkers_UpdateDryrun", + "description": "add a dryrun job to do necessary check before actual creation", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "PatchDryrun": { + "$ref": "./examples/PatchDryrun.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dryrunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of dryrun.", + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "description": "dryrun resource.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DryrunPatch" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DryrunResource" + } + }, + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Linkers" + ], + "operationId": "Linkers_DeleteDryrun", + "description": "delete a dryrun job", + "x-ms-examples": { + "DeleteDryrun": { + "$ref": "./examples/DeleteDryrun.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dryrunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of dryrun.", + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "OK. The job is deleted." + }, + "204": { + "description": "Deleted. The job is not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}/generateConfigurations": { + "post": { + "tags": [ + "Linkers" + ], + "operationId": "Linkers_GenerateConfigurations", + "description": "Generate configurations for a Linker.", + "x-ms-examples": { + "GenerateConfiguration": { + "$ref": "./examples/LinkerGenerateConfigurations.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LinkerNameParameter" + }, + { + "name": "parameters", + "description": "Connection Info, including format, secret store, etc", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ConfigurationInfo" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ConfigurationResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.ServiceLinker/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists the available ServiceLinker REST API operations.", + "x-ms-examples": { + "GetConfiguration": { + "$ref": "./examples/OperationsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ServiceLinker/configurationNames": { + "get": { + "tags": [ + "ConfigurationNames" + ], + "operationId": "ConfigurationNames_List", + "description": "Lists the configuration names generated by Service Connector for all target, client types, auth types.", + "x-ms-examples": { + "GetConfigurationNames": { + "$ref": "./examples/ConfigurationNamesList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter options." + }, + { + "name": "$skipToken", + "in": "query", + "required": false, + "type": "string", + "description": "OData skipToken option for pagination." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ConfigurationNameResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.ServiceLinker/daprConfigurations": { + "get": { + "tags": [ + "Linkers" + ], + "operationId": "Linkers_ListDaprConfigurations", + "description": "List the dapr configuration supported by Service Connector.", + "x-ms-examples": { + "GetDaprConfigurations": { + "$ref": "./examples/GetDaprConfigurations.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DaprConfigurationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "TargetServiceType": { + "description": "The target service type.", + "type": "string", + "enum": [ + "AzureResource", + "ConfluentBootstrapServer", + "ConfluentSchemaRegistry", + "SelfHostedServer", + "FabricPlatform" + ], + "x-ms-enum": { + "name": "targetServiceType", + "modelAsString": true + } + }, + "TargetServiceBase": { + "description": "The target service properties", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "description": "The target service type.", + "$ref": "#/definitions/TargetServiceType" + } + }, + "required": [ + "type" + ] + }, + "AzureResourceType": { + "description": "The azure resource type.", + "type": "string", + "enum": [ + "KeyVault", + "AppConfig" + ], + "x-ms-enum": { + "name": "azureResourceType", + "modelAsString": true + } + }, + "AzureResourcePropertiesBase": { + "description": "The azure resource properties", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "description": "The azure resource type.", + "$ref": "#/definitions/AzureResourceType" + } + }, + "required": [ + "type" + ] + }, + "AzureResource": { + "x-ms-discriminator-value": "AzureResource", + "type": "object", + "description": "The azure resource info when target service type is AzureResource", + "allOf": [ + { + "$ref": "#/definitions/TargetServiceBase" + } + ], + "properties": { + "id": { + "description": "The Id of azure resource.", + "type": "string" + }, + "resourceProperties": { + "x-nullable": true, + "description": "The azure resource connection related properties.", + "$ref": "#/definitions/AzureResourcePropertiesBase" + } + } + }, + "AzureKeyVaultProperties": { + "x-ms-discriminator-value": "KeyVault", + "type": "object", + "description": "The resource properties when type is Azure Key Vault", + "allOf": [ + { + "$ref": "#/definitions/AzureResourcePropertiesBase" + } + ], + "properties": { + "connectAsKubernetesCsiDriver": { + "x-nullable": true, + "description": "True if connect via Kubernetes CSI Driver.", + "type": "boolean" + } + } + }, + "AzureAppConfigProperties": { + "x-ms-discriminator-value": "AppConfig", + "type": "object", + "description": "The resource properties when type is Azure App Configuration", + "allOf": [ + { + "$ref": "#/definitions/AzureResourcePropertiesBase" + } + ], + "properties": { + "connectWithKubernetesExtension": { + "x-nullable": true, + "description": "True if connection enables app configuration kubernetes extension.", + "type": "boolean" + } + } + }, + "ConfluentBootstrapServer": { + "x-ms-discriminator-value": "ConfluentBootstrapServer", + "type": "object", + "description": "The service properties when target service type is ConfluentBootstrapServer", + "allOf": [ + { + "$ref": "#/definitions/TargetServiceBase" + } + ], + "properties": { + "endpoint": { + "description": "The endpoint of service.", + "type": "string" + } + } + }, + "FabricPlatform": { + "x-ms-discriminator-value": "FabricPlatform", + "type": "object", + "description": "The service properties when target service type is FabricPlatform", + "allOf": [ + { + "$ref": "#/definitions/TargetServiceBase" + } + ], + "properties": { + "endpoint": { + "description": "The endpoint of service.", + "type": "string" + } + } + }, + "SelfHostedServer": { + "x-ms-discriminator-value": "SelfHostedServer", + "type": "object", + "description": "The service properties when target service type is SelfHostedServer", + "allOf": [ + { + "$ref": "#/definitions/TargetServiceBase" + } + ], + "properties": { + "endpoint": { + "description": "The endpoint of service.", + "type": "string" + } + } + }, + "ConfluentSchemaRegistry": { + "x-ms-discriminator-value": "ConfluentSchemaRegistry", + "type": "object", + "description": "The service properties when target service type is ConfluentSchemaRegistry", + "allOf": [ + { + "$ref": "#/definitions/TargetServiceBase" + } + ], + "properties": { + "endpoint": { + "description": "The endpoint of service.", + "type": "string" + } + } + }, + "DeleteOrUpdateBehavior": { + "description": "The cleanup behavior to indicate whether clean up operation when resource is deleted or updated", + "type": "string", + "enum": [ + "Default", + "ForcedCleanup" + ], + "x-ms-enum": { + "name": "DeleteOrUpdateBehavior", + "modelAsString": true + } + }, + "ClientType": { + "description": "The application client type", + "type": "string", + "enum": [ + "none", + "dotnet", + "java", + "python", + "go", + "php", + "ruby", + "django", + "nodejs", + "springBoot", + "kafka-springBoot", + "jms-springBoot", + "dapr" + ], + "x-ms-enum": { + "name": "clientType", + "modelAsString": true + } + }, + "AuthType": { + "description": "The authentication type.", + "type": "string", + "enum": [ + "systemAssignedIdentity", + "userAssignedIdentity", + "servicePrincipalSecret", + "servicePrincipalCertificate", + "secret", + "accessKey", + "userAccount", + "easyAuthMicrosoftEntraID" + ], + "x-ms-enum": { + "name": "AuthType", + "modelAsString": true + } + }, + "SecretType": { + "description": "The secret type.", + "type": "string", + "enum": [ + "rawValue", + "keyVaultSecretUri", + "keyVaultSecretReference" + ], + "x-ms-enum": { + "name": "SecretType", + "modelAsString": true + } + }, + "SecretSourceType": { + "description": "The type of secret source.", + "type": "string", + "enum": [ + "rawValue", + "keyVaultSecret" + ], + "x-ms-enum": { + "name": "SecretSourceType", + "modelAsString": true + } + }, + "SecretInfoBase": { + "description": "The secret info", + "discriminator": "secretType", + "type": "object", + "properties": { + "secretType": { + "description": "The secret type.", + "$ref": "#/definitions/SecretType" + } + }, + "required": [ + "secretType" + ] + }, + "ValueSecretInfo": { + "x-ms-discriminator-value": "rawValue", + "type": "object", + "description": "The secret info when type is rawValue. It's for scenarios that user input the secret.", + "allOf": [ + { + "$ref": "#/definitions/SecretInfoBase" + } + ], + "properties": { + "value": { + "x-nullable": true, + "description": "The actual value of the secret.", + "type": "string", + "x-ms-secret": true + } + } + }, + "KeyVaultSecretReferenceSecretInfo": { + "x-ms-discriminator-value": "keyVaultSecretReference", + "type": "object", + "description": "The secret info when type is keyVaultSecretReference. It's for scenario that user provides a secret stored in user's keyvault and source is Azure Kubernetes. The key Vault's resource id is linked to secretStore.keyVaultId.", + "allOf": [ + { + "$ref": "#/definitions/SecretInfoBase" + } + ], + "properties": { + "name": { + "description": "Name of the Key Vault secret.", + "type": "string" + }, + "version": { + "x-nullable": true, + "description": "Version of the Key Vault secret.", + "type": "string" + } + } + }, + "KeyVaultSecretUriSecretInfo": { + "x-ms-discriminator-value": "keyVaultSecretUri", + "type": "object", + "description": "The secret info when type is keyVaultSecretUri. It's for scenario that user provides a secret stored in user's keyvault and source is Web App, Spring Cloud or Container App.", + "allOf": [ + { + "$ref": "#/definitions/SecretInfoBase" + } + ], + "properties": { + "value": { + "description": "URI to the keyvault secret", + "type": "string" + } + } + }, + "AuthInfoBase": { + "description": "The authentication info", + "discriminator": "authType", + "type": "object", + "properties": { + "authType": { + "description": "The authentication type.", + "$ref": "#/definitions/AuthType" + }, + "authMode": { + "description": "Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth.", + "$ref": "#/definitions/AuthMode" + } + }, + "required": [ + "authType" + ] + }, + "AccessKeyInfoBase": { + "description": "The access key directly from target resource properties, which target service is Azure Resource, such as Microsoft.Storage", + "x-ms-discriminator-value": "accessKey", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AuthInfoBase" + } + ], + "properties": { + "permissions": { + "description": "Permissions of the accessKey. `Read` and `Write` are for Azure Cosmos DB and Azure App Configuration, `Listen`, `Send` and `Manage` are for Azure Event Hub and Azure Service Bus.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "Read", + "Write", + "Listen", + "Send", + "Manage" + ], + "x-ms-enum": { + "name": "accessKeyPermissions", + "modelAsString": true + } + } + } + } + }, + "DatabaseAadAuthInfo": { + "description": "The extra auth info required by Database AAD authentication.", + "type": "object", + "properties": { + "userName": { + "x-nullable": true, + "description": "Username created in the database which is mapped to a user in AAD.", + "type": "string" + } + } + }, + "SecretAuthInfo": { + "x-ms-discriminator-value": "secret", + "type": "object", + "description": "The authentication info when authType is secret", + "allOf": [ + { + "$ref": "#/definitions/AuthInfoBase" + } + ], + "properties": { + "name": { + "x-nullable": true, + "description": "Username or account name for secret auth.", + "type": "string" + }, + "secretInfo": { + "x-nullable": true, + "description": "Password or key vault secret for secret auth.", + "$ref": "#/definitions/SecretInfoBase" + } + } + }, + "UserAssignedIdentityAuthInfo": { + "x-ms-discriminator-value": "userAssignedIdentity", + "type": "object", + "description": "The authentication info when authType is userAssignedIdentity", + "allOf": [ + { + "$ref": "#/definitions/AuthInfoBase" + }, + { + "$ref": "#/definitions/DatabaseAadAuthInfo" + } + ], + "properties": { + "clientId": { + "description": "Client Id for userAssignedIdentity.", + "type": "string" + }, + "subscriptionId": { + "description": "Subscription id for userAssignedIdentity.", + "type": "string" + }, + "deleteOrUpdateBehavior": { + "description": "Indicates whether to clean up previous operation when Linker is updating or deleting", + "$ref": "#/definitions/DeleteOrUpdateBehavior" + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional, this value specifies the Azure role to be assigned" + } + } + }, + "SystemAssignedIdentityAuthInfo": { + "x-ms-discriminator-value": "systemAssignedIdentity", + "type": "object", + "description": "The authentication info when authType is systemAssignedIdentity", + "allOf": [ + { + "$ref": "#/definitions/AuthInfoBase" + }, + { + "$ref": "#/definitions/DatabaseAadAuthInfo" + } + ], + "properties": { + "deleteOrUpdateBehavior": { + "description": "Indicates whether to clean up previous operation when Linker is updating or deleting", + "$ref": "#/definitions/DeleteOrUpdateBehavior" + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional, this value specifies the Azure role to be assigned" + } + } + }, + "ServicePrincipalSecretAuthInfo": { + "x-ms-discriminator-value": "servicePrincipalSecret", + "type": "object", + "description": "The authentication info when authType is servicePrincipal secret", + "allOf": [ + { + "$ref": "#/definitions/AuthInfoBase" + }, + { + "$ref": "#/definitions/DatabaseAadAuthInfo" + } + ], + "properties": { + "clientId": { + "description": "ServicePrincipal application clientId for servicePrincipal auth.", + "type": "string" + }, + "principalId": { + "description": "Principal Id for servicePrincipal auth.", + "type": "string" + }, + "secret": { + "description": "Secret for servicePrincipal auth.", + "type": "string", + "x-ms-secret": true + }, + "deleteOrUpdateBehavior": { + "description": "Indicates whether to clean up previous operation when Linker is updating or deleting", + "$ref": "#/definitions/DeleteOrUpdateBehavior" + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional, this value specifies the Azure roles to be assigned. Automatically " + } + }, + "required": [ + "clientId", + "principalId", + "secret" + ] + }, + "ServicePrincipalCertificateAuthInfo": { + "x-ms-discriminator-value": "servicePrincipalCertificate", + "type": "object", + "description": "The authentication info when authType is servicePrincipal certificate", + "allOf": [ + { + "$ref": "#/definitions/AuthInfoBase" + } + ], + "properties": { + "clientId": { + "description": "Application clientId for servicePrincipal auth.", + "type": "string" + }, + "principalId": { + "description": "Principal Id for servicePrincipal auth.", + "type": "string" + }, + "certificate": { + "description": "ServicePrincipal certificate for servicePrincipal auth.", + "type": "string", + "x-ms-secret": true + }, + "deleteOrUpdateBehavior": { + "description": "Indicates whether to clean up previous operation when Linker is updating or deleting", + "$ref": "#/definitions/DeleteOrUpdateBehavior" + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional, this value specifies the Azure roles to be assigned. Automatically " + } + }, + "required": [ + "clientId", + "principalId", + "certificate" + ] + }, + "UserAccountAuthInfo": { + "x-ms-discriminator-value": "userAccount", + "type": "object", + "description": "The authentication info when authType is user account", + "allOf": [ + { + "$ref": "#/definitions/AuthInfoBase" + }, + { + "$ref": "#/definitions/DatabaseAadAuthInfo" + } + ], + "properties": { + "principalId": { + "description": "Principal Id for user account.", + "type": "string" + }, + "deleteOrUpdateBehavior": { + "description": "Indicates whether to clean up previous operation when Linker is updating or deleting", + "$ref": "#/definitions/DeleteOrUpdateBehavior" + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional, this value specifies the Azure roles to be assigned. Automatically " + } + } + }, + "EasyAuthMicrosoftEntraIDAuthInfo": { + "x-ms-discriminator-value": "easyAuthMicrosoftEntraID", + "type": "object", + "description": "The authentication info when authType is EasyAuth Microsoft Entra ID", + "allOf": [ + { + "$ref": "#/definitions/AuthInfoBase" + } + ], + "properties": { + "clientId": { + "description": "Application clientId for EasyAuth Microsoft Entra ID.", + "type": "string" + }, + "secret": { + "description": "Application Secret for EasyAuth Microsoft Entra ID.", + "type": "string", + "x-ms-secret": true + }, + "deleteOrUpdateBehavior": { + "description": "Indicates whether to clean up previous operation when Linker is updating or deleting", + "$ref": "#/definitions/DeleteOrUpdateBehavior" + } + } + }, + "LinkerResource": { + "type": "object", + "description": "Linker of source and target resource", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource", + "description": "The resource model definition for an Azure Resource Manager proxy resource." + } + ], + "required": [ + "properties" + ], + "properties": { + "properties": { + "description": "The properties of the Linker.", + "$ref": "#/definitions/LinkerProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "x-nullable": true, + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "The system data." + } + } + }, + "LinkerPatch": { + "description": "A Linker to be updated.", + "type": "object", + "properties": { + "properties": { + "description": "Linker properties", + "type": "object", + "x-ms-client-flatten": true, + "$ref": "#/definitions/LinkerProperties" + } + } + }, + "ResourceList": { + "description": "The list of Linker.", + "type": "object", + "properties": { + "nextLink": { + "x-nullable": true, + "description": "The Linker used to get the next page of Linker list.", + "type": "string" + }, + "value": { + "description": "The list of Linkers.", + "type": "array", + "items": { + "$ref": "#/definitions/LinkerResource" + } + } + } + }, + "LinkerProperties": { + "description": "The properties of the Linker.", + "type": "object", + "properties": { + "targetService": { + "$ref": "#/definitions/TargetServiceBase", + "description": "The target service properties" + }, + "authInfo": { + "description": "The authentication type.", + "$ref": "#/definitions/AuthInfoBase" + }, + "clientType": { + "description": "The application client type", + "$ref": "#/definitions/ClientType" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state. " + }, + "vNetSolution": { + "x-nullable": true, + "description": "The VNet solution.", + "$ref": "#/definitions/VNetSolution" + }, + "secretStore": { + "x-nullable": true, + "description": "An option to store secret value in secure place", + "$ref": "#/definitions/SecretStore" + }, + "scope": { + "x-nullable": true, + "type": "string", + "description": "connection scope in source service." + }, + "publicNetworkSolution": { + "x-nullable": true, + "description": "The network solution.", + "$ref": "#/definitions/PublicNetworkSolution" + }, + "configurationInfo": { + "x-nullable": true, + "description": "The connection information consumed by applications, including secrets, connection strings.", + "$ref": "#/definitions/ConfigurationInfo" + } + } + }, + "LinkerConfigurationType": { + "description": "Type of configuration to determine whether the configuration can be modified after creation. KeyvaultSecret means the configuration references a key vault secret, such as App Service/ACA key vault reference. Default means the configuration is real value, such as user name, raw secret, etc.", + "type": "string", + "enum": [ + "Default", + "KeyVaultSecret" + ], + "x-ms-enum": { + "name": "LinkerConfigurationType", + "modelAsString": true + } + }, + "SourceConfiguration": { + "description": "A configuration item for source resource", + "type": "object", + "properties": { + "name": { + "description": "The name of setting.", + "type": "string" + }, + "value": { + "x-nullable": true, + "description": "The value of setting", + "type": "string" + }, + "configType": { + "description": "The type of setting", + "readOnly": true, + "$ref": "#/definitions/LinkerConfigurationType" + }, + "keyVaultReferenceIdentity": { + "x-nullable": true, + "description": "The identity for key vault reference, system or user-assigned managed identity ID", + "type": "string" + }, + "description": { + "x-nullable": true, + "description": "Descriptive information for the configuration", + "type": "string" + } + } + }, + "ConfigurationNameItem": { + "type": "object", + "properties": { + "properties": { + "x-nullable": true, + "description": "The result detail.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConfigurationNames" + } + } + }, + "ConfigurationNames": { + "type": "object", + "description": "The configuration names which will be set based on specific target resource, client type, auth type.", + "properties": { + "targetService": { + "type": "string", + "description": "The target service provider name and resource name." + }, + "clientType": { + "$ref": "#/definitions/ClientType", + "description": "The client type for configuration names." + }, + "authType": { + "$ref": "#/definitions/AuthType", + "description": "The auth type." + }, + "secretType": { + "$ref": "#/definitions/SecretSourceType", + "description": "Indicates where the secrets in configuration from. Used when secrets are from Keyvault." + }, + "daprProperties": { + "description": "Deprecated, please use #/definitions/DaprConfigurationList instead", + "$ref": "#/definitions/DaprProperties" + }, + "names": { + "type": "array", + "description": "The configuration names to be set in compute service environment.", + "items": { + "$ref": "#/definitions/ConfigurationName" + } + } + } + }, + "ConfigurationName": { + "type": "object", + "description": "The configuration names.", + "properties": { + "value": { + "type": "string" + }, + "description": { + "type": "string", + "description": "Description for the configuration name." + }, + "required": { + "type": "boolean", + "description": "Represent the configuration is required or not" + } + } + }, + "ConfigurationNameResult": { + "description": "Configuration Name list which will be set based on different target resource, client type, auth type.", + "type": "object", + "properties": { + "value": { + "description": "Expected configuration names for each target service.", + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationNameItem" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "ConfigurationResult": { + "description": "Configurations for source resource, include appSettings, connectionString and serviceBindings", + "type": "object", + "properties": { + "configurations": { + "description": "The configuration properties for source resource.", + "type": "array", + "items": { + "$ref": "#/definitions/SourceConfiguration" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ValidateOperationResult": { + "description": "The validation operation result for a Linker.", + "type": "object", + "properties": { + "properties": { + "x-nullable": true, + "description": "The validation result detail.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ValidateResult" + }, + "resourceId": { + "x-nullable": true, + "description": "Validated Linker id.", + "type": "string" + }, + "status": { + "x-nullable": true, + "description": "Validation operation status.", + "type": "string" + } + } + }, + "ValidateResult": { + "description": "The validation result for a Linker.", + "type": "object", + "properties": { + "linkerName": { + "x-nullable": true, + "description": "The linker name.", + "type": "string" + }, + "isConnectionAvailable": { + "x-nullable": true, + "description": "A boolean value indicating whether the connection is available or not", + "type": "boolean" + }, + "reportStartTimeUtc": { + "x-nullable": true, + "type": "string", + "format": "date-time", + "description": "The start time of the validation report." + }, + "reportEndTimeUtc": { + "x-nullable": true, + "type": "string", + "format": "date-time", + "description": "The end time of the validation report." + }, + "sourceId": { + "x-nullable": true, + "description": "The resource id of the Linker source application.", + "type": "string" + }, + "targetId": { + "x-nullable": true, + "description": "The resource Id of target service.", + "type": "string" + }, + "authType": { + "x-nullable": true, + "description": "The authentication type.", + "$ref": "#/definitions/AuthType" + }, + "validationDetail": { + "description": "The detail of validation result", + "type": "array", + "items": { + "$ref": "#/definitions/ValidationResultItem" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ValidationResultItem": { + "description": "The validation item for a Linker.", + "type": "object", + "properties": { + "name": { + "description": "The validation item name.", + "type": "string" + }, + "description": { + "x-nullable": true, + "description": "The display name of validation item", + "type": "string" + }, + "result": { + "x-nullable": true, + "description": "The result of validation", + "type": "string", + "enum": [ + "success", + "failure", + "warning" + ], + "x-ms-enum": { + "name": "ValidationResultStatus", + "modelAsString": true + } + }, + "errorMessage": { + "x-nullable": true, + "description": "The error message of validation result", + "type": "string" + }, + "errorCode": { + "x-nullable": true, + "description": "The error code of validation result", + "type": "string" + } + } + }, + "VNetSolution": { + "type": "object", + "description": "The VNet solution for linker", + "properties": { + "type": { + "x-nullable": true, + "description": "Type of VNet solution.", + "type": "string", + "enum": [ + "serviceEndpoint", + "privateLink" + ], + "x-ms-enum": { + "name": "vNetSolutionType", + "modelAsString": true + } + }, + "deleteOrUpdateBehavior": { + "description": "Indicates whether to clean up previous operation when Linker is updating or deleting", + "$ref": "#/definitions/DeleteOrUpdateBehavior" + } + } + }, + "PublicNetworkSolution": { + "type": "object", + "description": "Indicates public network solution, include firewall rules", + "properties": { + "deleteOrUpdateBehavior": { + "description": "Indicates whether to clean up previous operation(such as firewall rules) when Linker is updating or deleting", + "$ref": "#/definitions/DeleteOrUpdateBehavior" + }, + "action": { + "description": "Optional. Indicates public network solution. If enable, enable public network access of target service with best try. Default is enable. If optOut, opt out public network access configuration.", + "$ref": "#/definitions/ActionType" + }, + "firewallRules": { + "description": "Describe firewall rules of target service to make sure source application could connect to the target.", + "$ref": "#/definitions/FirewallRules" + } + } + }, + "FirewallRules": { + "type": "object", + "description": "Target service's firewall rules. to allow connections from source service.", + "properties": { + "ipRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account." + }, + "azureServices": { + "description": "Allow Azure services to access the target service if true.", + "$ref": "#/definitions/AllowType" + }, + "callerClientIP": { + "description": "Allow caller client IP to access the target service if true. the property is used when connecting local application to target service.", + "$ref": "#/definitions/AllowType" + } + } + }, + "ConfigurationInfo": { + "type": "object", + "description": "The configuration information, used to generate configurations or save to applications", + "properties": { + "deleteOrUpdateBehavior": { + "description": "Indicates whether to clean up previous operation when Linker is updating or deleting", + "$ref": "#/definitions/DeleteOrUpdateBehavior" + }, + "action": { + "description": "Optional, indicate whether to apply configurations on source application. If enable, generate configurations and applied to the source application. Default is enable. If optOut, no configuration change will be made on source.", + "$ref": "#/definitions/ActionType" + }, + "customizedKeys": { + "description": "Optional. A dictionary of default key name and customized key name mapping. If not specified, default key name will be used for generate configurations", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "daprProperties": { + "description": "Indicates some additional properties for dapr client type", + "$ref": "#/definitions/DaprProperties" + }, + "additionalConfigurations": { + "description": "A dictionary of additional configurations to be added. Service will auto generate a set of basic configurations and this property is to full fill more customized configurations", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "additionalConnectionStringProperties": { + "description": "A dictionary of additional properties to be added in the end of connection string.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "configurationStore": { + "x-nullable": true, + "description": "An option to store configuration into different place", + "$ref": "#/definitions/ConfigurationStore" + } + } + }, + "ConfigurationStore": { + "type": "object", + "description": "An option to store configuration into different place", + "properties": { + "appConfigurationId": { + "x-nullable": true, + "type": "string", + "description": "The app configuration id to store configuration" + } + } + }, + "DaprProperties": { + "type": "object", + "description": "Indicates some additional properties for dapr client type", + "properties": { + "version": { + "x-nullable": true, + "type": "string", + "description": "The dapr component version" + }, + "componentType": { + "x-nullable": true, + "type": "string", + "description": "The dapr component type" + }, + "secretStoreComponent": { + "x-nullable": true, + "type": "string", + "description": "The name of a secret store dapr to retrieve secret" + }, + "metadata": { + "description": "Additional dapr metadata", + "type": "array", + "items": { + "$ref": "#/definitions/DaprMetadata" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "scopes": { + "description": "The dapr component scopes", + "type": "array", + "items": { + "type": "string" + } + }, + "runtimeVersion": { + "x-nullable": true, + "type": "string", + "readOnly": true, + "description": "The runtime version supported by the properties" + }, + "bindingComponentDirection": { + "x-nullable": true, + "type": "string", + "enum": [ + "input", + "output" + ], + "x-ms-enum": { + "name": "DaprBindingComponentDirection", + "modelAsString": true + }, + "readOnly": true, + "description": "The direction supported by the dapr binding component" + } + } + }, + "DaprMetadata": { + "description": "The dapr component metadata.", + "type": "object", + "properties": { + "name": { + "description": "Metadata property name.", + "type": "string" + }, + "value": { + "description": "Metadata property value.", + "type": "string" + }, + "secretRef": { + "description": "The secret name where dapr could get value", + "type": "string" + }, + "description": { + "description": "The description of the metadata, returned from configuration api", + "type": "string" + }, + "required": { + "description": "The value indicating whether the metadata is required or not", + "type": "string", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "DaprMetadataRequired", + "modelAsString": true + } + } + } + }, + "SecretStore": { + "type": "object", + "description": "An option to store secret value in secure place", + "properties": { + "keyVaultId": { + "x-nullable": true, + "type": "string", + "description": "The key vault id to store secret" + }, + "keyVaultSecretName": { + "x-nullable": true, + "type": "string", + "description": "The key vault secret name to store secret, only valid when storing one secret" + } + } + }, + "DryrunList": { + "description": "The list of dryrun.", + "type": "object", + "properties": { + "nextLink": { + "x-nullable": true, + "description": "The link used to get the next page of dryrun list.", + "type": "string" + }, + "value": { + "description": "The list of dryrun.", + "type": "array", + "items": { + "$ref": "#/definitions/DryrunResource" + } + } + } + }, + "DryrunResource": { + "type": "object", + "description": "a dryrun job resource", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource", + "description": "The resource model definition for an Azure Resource Manager proxy resource." + } + ], + "properties": { + "properties": { + "description": "The properties of the dryrun job.", + "$ref": "#/definitions/DryrunProperties", + "x-ms-client-flatten": true + } + } + }, + "DryrunPatch": { + "type": "object", + "description": "a dryrun job to be updated.", + "properties": { + "properties": { + "description": "The properties of the dryrun job.", + "$ref": "#/definitions/DryrunProperties", + "x-ms-client-flatten": true + } + } + }, + "DryrunProperties": { + "description": "The properties of the dryrun job", + "type": "object", + "properties": { + "parameters": { + "description": "The parameters of the dryrun", + "$ref": "#/definitions/DryrunParameters" + }, + "prerequisiteResults": { + "readOnly": true, + "description": "the result of the dryrun", + "type": "array", + "items": { + "$ref": "#/definitions/DryrunPrerequisiteResult" + }, + "x-ms-identifiers": [] + }, + "operationPreviews": { + "readOnly": true, + "description": "the preview of the operations for creation", + "type": "array", + "items": { + "$ref": "#/definitions/DryrunOperationPreview" + }, + "x-ms-identifiers": [] + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state. " + } + } + }, + "DryrunActionName": { + "description": "The name of action for you dryrun job.", + "type": "string", + "enum": [ + "createOrUpdate" + ], + "x-ms-enum": { + "name": "DryrunActionName", + "modelAsString": true + } + }, + "DryrunParameters": { + "description": "The parameters of the dryrun", + "discriminator": "actionName", + "type": "object", + "properties": { + "actionName": { + "$ref": "#/definitions/DryrunActionName" + } + }, + "required": [ + "actionName" + ] + }, + "CreateOrUpdateDryrunParameters": { + "x-ms-discriminator-value": "createOrUpdate", + "type": "object", + "description": "The dryrun parameters for creation or update a linker", + "allOf": [ + { + "$ref": "#/definitions/DryrunParameters" + }, + { + "$ref": "#/definitions/LinkerProperties" + } + ] + }, + "DryrunPrerequisiteResultType": { + "description": "The type of dryrun result.", + "type": "string", + "enum": [ + "basicError", + "permissionsMissing" + ], + "x-ms-enum": { + "name": "DryrunPrerequisiteResultType", + "modelAsString": true + } + }, + "DryrunPrerequisiteResult": { + "description": "A result of dryrun", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/DryrunPrerequisiteResultType" + } + }, + "required": [ + "type" + ] + }, + "BasicErrorDryrunPrerequisiteResult": { + "x-ms-discriminator-value": "basicError", + "description": "The represent of basic error", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DryrunPrerequisiteResult" + } + ], + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + } + }, + "PermissionsMissingDryrunPrerequisiteResult": { + "x-ms-discriminator-value": "permissionsMissing", + "description": "The represent of missing permissions", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DryrunPrerequisiteResult" + } + ], + "properties": { + "scope": { + "description": "The permission scope", + "type": "string" + }, + "permissions": { + "description": "The permission list", + "type": "array", + "items": { + "type": "string" + } + }, + "recommendedRole": { + "description": "The recommended role to resolve permissions missing", + "type": "string" + } + } + }, + "DryrunOperationPreview": { + "description": "The preview of the operations for creation", + "type": "object", + "properties": { + "name": { + "description": "The operation name", + "type": "string" + }, + "operationType": { + "description": "The operation type", + "type": "string", + "enum": [ + "configConnection", + "configNetwork", + "configAuth" + ], + "x-ms-enum": { + "name": "DryrunPreviewOperationType", + "modelAsString": true + } + }, + "description": { + "description": "The description of the operation", + "type": "string" + }, + "action": { + "description": "The action defined by RBAC, refer https://docs.microsoft.com/azure/role-based-access-control/role-definitions#actions-format", + "type": "string" + }, + "scope": { + "description": "The scope of the operation, refer https://docs.microsoft.com/azure/role-based-access-control/scope-overview", + "type": "string" + } + } + }, + "ActionType": { + "description": "Indicates how to apply the connector operations, such as opt out network configuration, opt in configuration.", + "type": "string", + "enum": [ + "enable", + "optOut" + ], + "x-ms-enum": { + "name": "actionType", + "modelAsString": true + } + }, + "AuthMode": { + "description": "Indicates how to apply the authentication configuration operations.", + "type": "string", + "enum": [ + "optInAllAuth", + "optOutAllAuth" + ], + "x-ms-enum": { + "name": "authMode", + "modelAsString": true, + "values": [ + { + "value": "optInAllAuth", + "description": "Default authentication configuration according to the authentication type." + }, + { + "value": "optOutAllAuth", + "description": "Skip all authentication configuration such as enabling managed identity and granting RBAC roles" + } + ] + } + }, + "AllowType": { + "description": "Whether to allow firewall rules.", + "type": "string", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "allowType", + "modelAsString": true + } + }, + "DaprConfigurationList": { + "description": "Dapr configuration list supported by Service Connector", + "type": "object", + "properties": { + "value": { + "description": "The list of dapr configurations", + "type": "array", + "items": { + "$ref": "#/definitions/DaprConfigurationResource" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "DaprConfigurationResource": { + "description": "Represent one resource of the dapr configuration list", + "type": "object", + "properties": { + "properties": { + "description": "The properties of the dapr configuration.", + "$ref": "#/definitions/DaprConfigurationProperties", + "x-ms-client-flatten": true + } + } + }, + "DaprConfigurationProperties": { + "type": "object", + "properties": { + "targetType": { + "type": "string", + "description": "Supported target resource type, extract from resource id, uppercase" + }, + "authType": { + "$ref": "#/definitions/AuthType" + }, + "daprProperties": { + "$ref": "#/definitions/DaprProperties" + } + } + } + }, + "parameters": { + "LinkerNameParameter": { + "name": "linkerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name Linker resource.", + "x-ms-parameter-location": "method" + }, + "ConnectorNameParameter": { + "name": "connectorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of resource.", + "x-ms-parameter-location": "method" + }, + "ResourceUriParameter": { + "name": "resourceUri", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified Azure Resource manager identifier of the resource to be connected.", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "method" + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the target subscription.", + "minLength": 1, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/servicelinker/resource-manager/readme.md b/specification/servicelinker/resource-manager/readme.md index 96b6eb39a705..7d8caa630389 100644 --- a/specification/servicelinker/resource-manager/readme.md +++ b/specification/servicelinker/resource-manager/readme.md @@ -28,7 +28,7 @@ These are the global settings for the ServiceLinker. title: ServiceLinkerManagementClient openapi-type: arm openapi-subtype : rpaas -tag: package-2023-04-01-preview +tag: package-2024-07-01-preview ``` ### Tag: package-2021-11-01-preview @@ -85,6 +85,15 @@ input-file: - Microsoft.ServiceLinker/stable/2024-04-01/servicelinker.json ``` +### Tag: package-2024-07-01-preview + +These settings apply only when `--tag=package-2024-07-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-07-01-preview' +input-file: + - Microsoft.ServiceLinker/preview/2024-07-01-preview/servicelinker.json +``` + ## Suppression ``` yaml From b3f9d4cee052fcba1dfcf5da94f517e5c68417f9 Mon Sep 17 00:00:00 2001 From: abhi580 <43762309+abhi580@users.noreply.github.com> Date: Fri, 27 Sep 2024 11:32:23 +0530 Subject: [PATCH 04/47] Abhi580 migrate microsoft.migrate nonbreaking 2023 05 01 preview (#28274) * Adds base for updating Microsoft.Migrate/AssessmentProjects from version preview/2023-04-01-preview to version 2023-05-01-preview * Updates readme * Updates API version in new specs and examples * added 2023-05-01-preview changes * added prettierchecks * added prettier checks 2 * added ANF changed * handled failed checks * handled comments 2 * added supressions * fixed relative path for suppression * added final changes * fixed prettier checks * added Enum changes * added supreesion for additionalProperty and provisionaing State * added supression for UnSupportedPatchProperties * handled arm comments * changed totalStorage to float in avsSummary * added vcf BYOL changes * removed external storage ri example * fixed prettier checks * added supression for lintdiff * added final changes and handled comments * added error code fixes * fixed readme --- ...smentOperations_Create_MaximumSet_Gen.json | 146 + ...smentOperations_Delete_MaximumSet_Gen.json | 15 + ...Operations_DownloadUrl_MaximumSet_Gen.json | 25 + ...sessmentOperations_Get_MaximumSet_Gen.json | 65 + ...istByAssessmentProject_MaximumSet_Gen.json | 73 + ...sClusterOperations_Get_MaximumSet_Gen.json | 54 + ...ns_ListByAksAssessment_MaximumSet_Gen.json | 59 + ...ns_ListByAksAssessment_MaximumSet_Gen.json | 47 + ...sOptionsOperations_Get_MaximumSet_Gen.json | 38 + ...istByAssessmentProject_MaximumSet_Gen.json | 42 + ...sSummaryOperations_Get_MaximumSet_Gen.json | 63 + ...ns_ListByAksAssessment_MaximumSet_Gen.json | 67 + ...MachinesOperations_Get_MaximumSet_Gen.json | 129 + ...tions_ListByAssessment_MaximumSet_Gen.json | 137 + ...tabaseV2Operations_Get_MaximumSet_Gen.json | 225 + ..._ListBySqlAssessmentV2_MaximumSet_Gen.json | 233 + ...stanceV2Operations_Get_MaximumSet_Gen.json | 474 + ..._ListBySqlAssessmentV2_MaximumSet_Gen.json | 505 + ...MachinesOperations_Get_MaximumSet_Gen.json | 155 + ..._ListBySqlAssessmentV2_MaximumSet_Gen.json | 163 + ...edEntityOperations_Get_MaximumSet_Gen.json | 330 + ..._ListBySqlAssessmentV2_MaximumSet_Gen.json | 330 + ...WebAppV2Operations_Get_MaximumSet_Gen.json | 63 + ...stByWebAppAssessmentV2_MaximumSet_Gen.json | 71 + ...licationOperations_Get_MaximumSet_Gen.json | 73 + ...ns_ListByAksAssessment_MaximumSet_Gen.json | 81 + ...tOptionsOperations_Get_MaximumSet_Gen.json | 3079 ++ ...istByAssessmentProject_MaximumSet_Gen.json | 3083 ++ ...tSummaryOperations_Get_MaximumSet_Gen.json | 46 + ...istByAssessmentProject_MaximumSet_Gen.json | 50 + ...jectsOperations_Create_MaximumSet_Gen.json | 144 + ...jectsOperations_Delete_MaximumSet_Gen.json | 14 + ...ProjectsOperations_Get_MaximumSet_Gen.json | 69 + ...ns_ListByResourceGroup_MaximumSet_Gen.json | 73 + ...ons_ListBySubscription_MaximumSet_Gen.json | 72 + ...jectsOperations_Update_MaximumSet_Gen.json | 88 + ...mentsOperations_Create_MaximumSet_Gen.json | 236 + ...mentsOperations_Delete_MaximumSet_Gen.json | 16 + ...Operations_DownloadUrl_MaximumSet_Gen.json | 26 + ...essmentsOperations_Get_MaximumSet_Gen.json | 103 + ...Operations_ListByGroup_MaximumSet_Gen.json | 107 + ...MachinesOperations_Get_MaximumSet_Gen.json | 81 + ...ns_ListByAvsAssessment_MaximumSet_Gen.json | 89 + ...tOptionsOperations_Get_MaximumSet_Gen.json | 184 + ...istByAssessmentProject_MaximumSet_Gen.json | 188 + ...mentsOperations_Create_MaximumSet_Gen.json | 326 + ...mentsOperations_Delete_MaximumSet_Gen.json | 16 + ...Operations_DownloadUrl_MaximumSet_Gen.json | 26 + ...essmentsOperations_Get_MaximumSet_Gen.json | 148 + ...Operations_ListByGroup_MaximumSet_Gen.json | 152 + ...sSummaryOperations_Get_MaximumSet_Gen.json | 269 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 273 + ...sSummaryOperations_Get_MaximumSet_Gen.json | 291 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 295 + ...rations_CompareSummary_MaximumSet_Gen.json | 185 + ...sCaseOperations_Create_MaximumSet_Gen.json | 410 + ...sCaseOperations_Delete_MaximumSet_Gen.json | 15 + ...s_GetReportDownloadUrl_MaximumSet_Gen.json | 25 + ...nessCaseOperations_Get_MaximumSet_Gen.json | 151 + ...istByAssessmentProject_MaximumSet_Gen.json | 155 + ...wSummaryOperations_Get_MaximumSet_Gen.json | 123 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 127 + ...sSummaryOperations_Get_MaximumSet_Gen.json | 252 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 256 + ...MachinesOperations_Get_MaximumSet_Gen.json | 40 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 48 + ...MachinesOperations_Get_MaximumSet_Gen.json | 40 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 48 + ...EntitiesOperations_Get_MaximumSet_Gen.json | 41 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 49 + ...dWebAppsOperations_Get_MaximumSet_Gen.json | 38 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 46 + ...roupsOperations_Create_MaximumSet_Gen.json | 85 + ...roupsOperations_Delete_MaximumSet_Gen.json | 15 + .../GroupsOperations_Get_MaximumSet_Gen.json | 44 + ...istByAssessmentProject_MaximumSet_Gen.json | 48 + ...rations_UpdateMachines_MaximumSet_Gen.json | 58 + ...ctorsOperations_Create_MaximumSet_Gen.json | 98 + ...ctorsOperations_Delete_MaximumSet_Gen.json | 15 + ...llectorsOperations_Get_MaximumSet_Gen.json | 45 + ...istByAssessmentProject_MaximumSet_Gen.json | 49 + ...ctorsOperations_Create_MaximumSet_Gen.json | 62 + ...ctorsOperations_Delete_MaximumSet_Gen.json | 15 + ...llectorsOperations_Get_MaximumSet_Gen.json | 33 + ...istByAssessmentProject_MaximumSet_Gen.json | 37 + ...MachinesOperations_Get_MaximumSet_Gen.json | 89 + ...istByAssessmentProject_MaximumSet_Gen.json | 97 + .../Operations_List_MaximumSet_Gen.json | 28 + ...ctionOperations_Delete_MaximumSet_Gen.json | 15 + ...nnectionOperations_Get_MaximumSet_Gen.json | 39 + ...istByAssessmentProject_MaximumSet_Gen.json | 43 + ...ctionOperations_Update_MaximumSet_Gen.json | 76 + ...ResourceOperations_Get_MaximumSet_Gen.json | 37 + ...istByAssessmentProject_MaximumSet_Gen.json | 41 + ...ctorsOperations_Create_MaximumSet_Gen.json | 98 + ...ctorsOperations_Delete_MaximumSet_Gen.json | 15 + ...llectorsOperations_Get_MaximumSet_Gen.json | 45 + ...istByAssessmentProject_MaximumSet_Gen.json | 49 + ...tOptionsOperations_Get_MaximumSet_Gen.json | 1635 + ...istByAssessmentProject_MaximumSet_Gen.json | 1639 + ...entV2Operations_Create_MaximumSet_Gen.json | 219 + ...entV2Operations_Delete_MaximumSet_Gen.json | 16 + ...Operations_DownloadUrl_MaximumSet_Gen.json | 26 + ...ssmentV2Operations_Get_MaximumSet_Gen.json | 94 + ...Operations_ListByGroup_MaximumSet_Gen.json | 254 + ...2SummaryOperations_Get_MaximumSet_Gen.json | 128 + ..._ListBySqlAssessmentV2_MaximumSet_Gen.json | 132 + ...ectorOperations_Create_MaximumSet_Gen.json | 97 + ...ectorOperations_Delete_MaximumSet_Gen.json | 15 + ...ollectorOperations_Get_MaximumSet_Gen.json | 45 + ...istByAssessmentProject_MaximumSet_Gen.json | 49 + ...ctorsOperations_Create_MaximumSet_Gen.json | 98 + ...ctorsOperations_Delete_MaximumSet_Gen.json | 15 + ...llectorsOperations_Get_MaximumSet_Gen.json | 45 + ...istByAssessmentProject_MaximumSet_Gen.json | 49 + ...tOptionsOperations_Get_MaximumSet_Gen.json | 56 + ...istByAssessmentProject_MaximumSet_Gen.json | 60 + ...entV2Operations_Create_MaximumSet_Gen.json | 167 + ...entV2Operations_Delete_MaximumSet_Gen.json | 16 + ...Operations_DownloadUrl_MaximumSet_Gen.json | 26 + ...ssmentV2Operations_Get_MaximumSet_Gen.json | 70 + ...Operations_ListByGroup_MaximumSet_Gen.json | 74 + ...2SummaryOperations_Get_MaximumSet_Gen.json | 61 + ...stByWebAppAssessmentV2_MaximumSet_Gen.json | 65 + ...ectorOperations_Create_MaximumSet_Gen.json | 99 + ...ectorOperations_Delete_MaximumSet_Gen.json | 15 + ...ollectorOperations_Get_MaximumSet_Gen.json | 46 + ...istByAssessmentProject_MaximumSet_Gen.json | 50 + ...cePlanV2Operations_Get_MaximumSet_Gen.json | 52 + ...stByWebAppAssessmentV2_MaximumSet_Gen.json | 60 + .../preview/2023-05-01-preview/migrate.json | 24820 ++++++++++++++++ .../migrate/resource-manager/readme.md | 32 + .../resource-manager/suppressions.yaml | 7 + 133 files changed, 46864 insertions(+) create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_DownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksClusterOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksClusterOperations_ListByAksAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksOptionsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedMachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlMachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebAppV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebApplicationOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentOptionsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Update_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_DownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_ListByGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessedMachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentOptionsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_CompareSummary_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedMachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedWebAppsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_UpdateMachines_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/MachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/MachinesOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/Operations_List_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Update_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateLinkResourceOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentOptionsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppServicePlanV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/migrate.json create mode 100644 specification/migrate/resource-manager/suppressions.yaml diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..a0d418f94535 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,146 @@ +{ + "title": "AksAssessmentOperations_Create", + "operationId": "AksAssessmentOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment", + "resource": { + "properties": { + "settings": { + "category": "All", + "savingsOptions": "None", + "consolidation": "Full", + "pricingTier": "Standard", + "azureLocation": "Unknown", + "environmentType": "Unknown", + "licensingProgram": "Default", + "currency": "Unknown", + "discountPercentage": 15, + "sizingCriteria": "PerformanceBased", + "performanceData": { + "timeRange": "Day", + "perfDataStartTime": "2023-11-07T06:51:24.320Z", + "perfDataEndTime": "2023-11-07T06:51:24.320Z", + "percentile": "Percentile50" + }, + "scalingFactor": 3 + }, + "scope": { + "serverGroupId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/groups/testgrp" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "settings": { + "category": "All", + "savingsOptions": "None", + "consolidation": "Full", + "pricingTier": "Standard", + "azureLocation": "Unknown", + "environmentType": "Unknown", + "licensingProgram": "Default", + "currency": "Unknown", + "discountPercentage": 15, + "sizingCriteria": "PerformanceBased", + "performanceData": { + "timeRange": "Day", + "perfDataStartTime": "2023-11-07T06:51:24.320Z", + "perfDataEndTime": "2023-11-07T06:51:24.320Z", + "percentile": "Percentile50" + }, + "scalingFactor": 3 + }, + "details": { + "webAppCount": 25, + "webServerCount": 29, + "machineCount": 15, + "totalMonthlyCost": 1, + "pricesTimestamp": "2023-11-07T06:51:24.320Z", + "confidenceRatingInPercentage": 1, + "createdTimestamp": "2023-11-07T06:51:24.320Z", + "updatedTimestamp": "2023-11-07T06:51:24.320Z", + "status": "Created" + }, + "scope": { + "serverGroupId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/groups/testgrp" + }, + "provisioningState": "Unknown" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment", + "name": "testaksassessment", + "type": "AKSAssessment", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "settings": { + "category": "All", + "savingsOptions": "None", + "consolidation": "Full", + "pricingTier": "Standard", + "azureLocation": "Unknown", + "environmentType": "Unknown", + "licensingProgram": "Default", + "currency": "Unknown", + "discountPercentage": 15, + "sizingCriteria": "PerformanceBased", + "performanceData": { + "timeRange": "Day", + "perfDataStartTime": "2023-11-07T06:51:24.320Z", + "perfDataEndTime": "2023-11-07T06:51:24.320Z", + "percentile": "Percentile50" + }, + "scalingFactor": 3 + }, + "details": { + "webAppCount": 25, + "webServerCount": 29, + "machineCount": 15, + "totalMonthlyCost": 1, + "pricesTimestamp": "2023-11-07T06:51:24.320Z", + "confidenceRatingInPercentage": 1, + "createdTimestamp": "2023-11-07T06:51:24.320Z", + "updatedTimestamp": "2023-11-07T06:51:24.320Z", + "status": "Created" + }, + "scope": { + "serverGroupId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/groups/testgrp" + }, + "provisioningState": "Unknown" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment", + "name": "testaksassessment", + "type": "AKSAssessment", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..a6797bf0e74c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "AksAssessmentOperations_Delete", + "operationId": "AksAssessmentOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_DownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_DownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..65bcf8c345e3 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_DownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "title": "AksAssessmentOperations_DownloadUrl", + "operationId": "AksAssessmentOperations_DownloadUrl", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment", + "body": {} + }, + "responses": { + "200": { + "body": { + "assessmentReportUrl": "vthjjfdenyh", + "expirationTime": "2023-11-07T06:51:25.205Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..379b0af21ae4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,65 @@ +{ + "title": "AksAssessmentOperations_Get", + "operationId": "AksAssessmentOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": { + "body": { + "properties": { + "settings": { + "category": "All", + "savingsOptions": "None", + "consolidation": "Full", + "pricingTier": "Standard", + "azureLocation": "Unknown", + "environmentType": "Unknown", + "licensingProgram": "Default", + "currency": "Unknown", + "discountPercentage": 15, + "sizingCriteria": "PerformanceBased", + "performanceData": { + "timeRange": "Day", + "perfDataStartTime": "2023-11-07T06:51:24.320Z", + "perfDataEndTime": "2023-11-07T06:51:24.320Z", + "percentile": "Percentile50" + }, + "scalingFactor": 3 + }, + "details": { + "webAppCount": 25, + "webServerCount": 29, + "machineCount": 15, + "totalMonthlyCost": 1, + "pricesTimestamp": "2023-11-07T06:51:24.320Z", + "confidenceRatingInPercentage": 1, + "createdTimestamp": "2023-11-07T06:51:24.320Z", + "updatedTimestamp": "2023-11-07T06:51:24.320Z", + "status": "Created" + }, + "scope": { + "serverGroupId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/groups/testgrp" + }, + "provisioningState": "Unknown" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment", + "name": "testaksassessment", + "type": "AKSAssessment", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..eb1d3d3c010f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "title": "AksAssessmentOperations_ListByAssessmentProject", + "operationId": "AksAssessmentOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "continuationToken": "polt", + "$top": 5, + "$filter": "azekdtdhupdngbqxzdppicwf", + "totalRecordCount": 18, + "projectName": "testproject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "settings": { + "category": "All", + "savingsOptions": "None", + "consolidation": "Full", + "pricingTier": "Standard", + "azureLocation": "Unknown", + "environmentType": "Unknown", + "licensingProgram": "Default", + "currency": "Unknown", + "discountPercentage": 15, + "sizingCriteria": "PerformanceBased", + "performanceData": { + "timeRange": "Day", + "perfDataStartTime": "2023-11-07T06:51:24.320Z", + "perfDataEndTime": "2023-11-07T06:51:24.320Z", + "percentile": "Percentile50" + }, + "scalingFactor": 3 + }, + "details": { + "webAppCount": 25, + "webServerCount": 29, + "machineCount": 15, + "totalMonthlyCost": 1, + "pricesTimestamp": "2023-11-07T06:51:24.320Z", + "confidenceRatingInPercentage": 1, + "createdTimestamp": "2023-11-07T06:51:24.320Z", + "updatedTimestamp": "2023-11-07T06:51:24.320Z", + "status": "Created" + }, + "scope": { + "serverGroupId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/groups/testgrp" + }, + "provisioningState": "Unknown" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment", + "name": "testaksassessment", + "type": "AKSAssessment", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksClusterOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksClusterOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..9c6a658b3732 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksClusterOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,54 @@ +{ + "title": "AksClusterOperations_Get", + "operationId": "AksClusterOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment", + "clusterName": "testaksassessment-cluster" + }, + "responses": { + "200": { + "body": { + "properties": { + "name": "testaksassessment-cluster", + "nodePools": [ + { + "id": "testaksassessmentCostDetail", + "name": "testaksassessmentCostDetail", + "clusterName": "testaksassessment-cluster", + "mode": "User", + "osType": "Linux", + "armSkuName": "StandardDS_v2", + "nodeCount": 1, + "podCount": 1, + "monthlyCost": 10, + "podApproxMonthlyCost": 10 + } + ], + "region": "Unknown", + "userNodePoolCount": 0, + "userNodeCount": 6, + "systemNodePoolCount": 16, + "systemNodeCount": 18, + "podCount": 26, + "monthlyCost": 14 + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment/clusters/testaksassessment-cluster", + "name": "testaksassessment-cluster", + "type": "AKSAssessmentCluster", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksClusterOperations_ListByAksAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksClusterOperations_ListByAksAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..44c2cc38ac41 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksClusterOperations_ListByAksAssessment_MaximumSet_Gen.json @@ -0,0 +1,59 @@ +{ + "title": "AksClusterOperations_ListByAksAssessment", + "operationId": "AksClusterOperations_ListByAksAssessment", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "$filter": "sfmesuqkmjezolfjvalm", + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "name": "testaksassessment-cluster", + "nodePools": [ + { + "id": "testaksassessmentCostDetail", + "name": "testaksassessmentCostDetail", + "clusterName": "testaksassessment-cluster", + "mode": "User", + "osType": "Linux", + "armSkuName": "StandardDS_v2", + "nodeCount": 1, + "podCount": 1, + "monthlyCost": 10, + "podApproxMonthlyCost": 10 + } + ], + "region": "Unknown", + "userNodePoolCount": 0, + "userNodeCount": 6, + "systemNodePoolCount": 16, + "systemNodeCount": 18, + "podCount": 26, + "monthlyCost": 14 + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment/clusters/testaksassessment-cluster", + "name": "testaksassessment-cluster", + "type": "AKSAssessmentCluster", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..237b9ac37848 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen.json @@ -0,0 +1,47 @@ +{ + "title": "AksCostDetailOperations_ListByAksAssessment", + "operationId": "AksCostDetailOperations_ListByAksAssessment", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "$filter": "ww", + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "id": "testaksassessmentCostDetail", + "name": "testaksassessmentCostDetail", + "clusterName": "testaksassessment-cluster", + "mode": "User", + "osType": "Linux", + "armSkuName": "StandardDS_v2", + "nodeCount": 16, + "podCount": 7, + "monthlyCost": 6, + "podApproxMonthlyCost": 27 + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment/costDetails/testaksassessmentCostDetail", + "name": "testaksassessmentCostDetail", + "type": "AKSAssessmentCostDetail", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksOptionsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksOptionsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..ae168b3c0e76 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksOptionsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,38 @@ +{ + "title": "AksOptionsOperations_Get", + "operationId": "AksOptionsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentOptionsName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "edges": { + "AKS": { + "AzureLocation": [ + "EastAsia" + ] + } + } + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessmentOptions/default", + "name": "default", + "type": "AKSAssessmentOptions", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..4294d53b5da0 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "AksOptionsOperations_ListByAssessmentProject", + "operationId": "AksOptionsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "edges": { + "AKS": { + "AzureLocation": [ + "EastAsia" + ] + } + } + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessmentOptions/default", + "name": "default", + "type": "AKSAssessmentOptions", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..604a335908a9 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,63 @@ +{ + "title": "AksSummaryOperations_Get", + "operationId": "AksSummaryOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment", + "summaryName": "AKS" + }, + "responses": { + "200": { + "body": { + "properties": { + "aksAssessmentSummary": { + "skuSummary": { + "StandardDS_v2": { + "count": 17, + "monthlyCost": 18 + } + }, + "webAppSummary": { + "IIS": { + "count": 17, + "monthlyCost": 18 + } + }, + "webServerSummary": { + "IIS": 13 + }, + "webAppCount": 19, + "webServerCount": 28, + "machineCount": 17, + "totalMonthlyCost": 6 + }, + "assessmentName": "testaksassessment", + "summaryName": "testaksassessmentsummary", + "suitabilityPerTarget": { + "AKS": { + "Ready": 11 + } + }, + "monthlyComputeCost": 8, + "monthlyStorageCost": 26, + "confidenceScore": 7 + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment/summaries/AKS", + "name": "AKS", + "type": "AKSAssessmentSummary", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..c081413b984b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen.json @@ -0,0 +1,67 @@ +{ + "title": "AksSummaryOperations_ListByAksAssessment", + "operationId": "AksSummaryOperations_ListByAksAssessment", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "aksAssessmentSummary": { + "skuSummary": { + "StandardDS_v2": { + "count": 17, + "monthlyCost": 18 + } + }, + "webAppSummary": { + "IIS": { + "count": 17, + "monthlyCost": 18 + } + }, + "webServerSummary": { + "IIS": 13 + }, + "webAppCount": 19, + "webServerCount": 28, + "machineCount": 17, + "totalMonthlyCost": 6 + }, + "assessmentName": "testaksassessment", + "summaryName": "testaksassessmentsummary", + "suitabilityPerTarget": { + "AKS": { + "Ready": 11 + } + }, + "monthlyComputeCost": 8, + "monthlyStorageCost": 26, + "confidenceScore": 7 + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment/summaries/AKS", + "name": "AKS", + "type": "AKSAssessmentSummary", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedMachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedMachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..0fcdfdae30f3 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedMachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,129 @@ +{ + "title": "AssessedMachinesOperations_Get", + "operationId": "AssessedMachinesOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D8E1C413-E65F-40C0-8A7E-743D6B7A6AE9", + "resourceGroupName": "rgopenapi", + "projectName": "pavqtntysjn", + "groupName": "smawqdmhfngray", + "assessmentName": "qjlumxyqsitd", + "assessedMachineName": "oqxjeheiipjmuo" + }, + "responses": { + "200": { + "body": { + "properties": { + "errors": [], + "disks": { + "6000C297-455f-f81e-37b7-dc17da4433d4": { + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "NumberOfReadOperationsPerSecondMissing", + "recommendedDiskSize": "StandardSSD_E10", + "recommendedDiskType": "StandardSSD", + "gigabytesForRecommendedDiskSize": 17, + "recommendDiskThroughputInMbps": 13, + "recommendedDiskIops": 7, + "monthlyStorageCost": 5, + "name": "6000C297-455f-f81e-37b7-dc17da4433d4", + "displayName": "scsi0:0", + "gigabytesProvisioned": 8, + "megabytesPerSecondOfRead": 9, + "megabytesPerSecondOfWrite": 29, + "numberOfReadOperationsPerSecond": 12, + "numberOfWriteOperationsPerSecond": 28 + } + }, + "monthlyUltraStorageCost": 11, + "hostProcessor": { + "name": "Intel(R) Xeon(R) Gold 5220R CPU @ 2.20GHz", + "numberOfSockets": 2, + "numberOfCoresPerSocket": 24 + }, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 273.792, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 14.88, + "description": null + } + ], + "monthlyBandwidthCost": 4, + "monthlyStorageCost": 10, + "monthlyPremiumStorageCost": 6, + "monthlyStandardSsdStorageCost": 4, + "networkAdapters": { + "4000": { + "suitability": "Suitable", + "suitabilityDetail": "NotApplicable", + "suitabilityExplanation": "MegabytesOfDataTransmittedMissing, MegabytesOfDataRecievedMissing", + "monthlyBandwidthCosts": 4, + "netGigabytesTransmittedPerMonth": 6, + "displayName": "VM Network", + "macAddress": "00:50:56:95:98:e8", + "ipAddresses": [ + "2404:f801:4800:1c:c4c2:1cd:7154:a028" + ], + "megabytesPerSecondReceived": 10, + "megabytesPerSecondTransmitted": 24 + } + }, + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 0, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2018-10-09T00:00:00Z", + "extendedSupportEndDate": "2023-10-10T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "2024-10-08T00:00:00Z", + "extendedSecurityUpdateYear2EndDate": "2025-10-14T00:00:00Z", + "extendedSecurityUpdateYear3EndDate": "2026-10-13T00:00:00Z" + }, + "recommendedSize": "Standard_F4s_v2", + "numberOfCoresForRecommendedSize": 8, + "megabytesOfMemoryForRecommendedSize": 27, + "monthlyComputeCostForRecommendedSize": 1, + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "PercentageOfCoresUtilizedMissing", + "type": "AssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2016 or later (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-26T09:14:13.8168575Z", + "updatedTimestamp": "2023-09-26T09:14:13.8168575Z", + "displayName": "SQLTestDBVM28", + "description": null, + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app18700site/machines/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3_50150976-65ec-de99-1b54-a52710c3066e", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app18700site/vcenters/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3", + "datacenterManagementServerName": "idclab-vcen67.fareast.corp.microsoft.com", + "megabytesOfMemory": 21, + "numberOfCores": 7, + "confidenceRatingInPercentage": 14, + "percentageCoresUtilization": 24, + "percentageMemoryUtilization": 5, + "suitability": "Suitable" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1/assessedMachines/50fa865c-8c5c-4371-b7eb-5b900d7f9451", + "name": "riigi", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments/assessedMachines", + "systemData": { + "createdBy": "jsfqnyqqwykkv", + "createdByType": "sakanwar", + "createdAt": "2023-09-26T12:46:17.892Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T12:46:17.892Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..579f4b0d2fcf --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen.json @@ -0,0 +1,137 @@ +{ + "title": "AssessedMachinesOperations_ListByAssessment", + "operationId": "AssessedMachinesOperations_ListByAssessment", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D8E1C413-E65F-40C0-8A7E-743D6B7A6AE9", + "resourceGroupName": "rgopenapi", + "$filter": "sbkdovsfqldhdb", + "pageSize": 10, + "continuationToken": "hbyseetshbplfkjmpjhsiurqgt", + "totalRecordCount": 25, + "projectName": "sloqixzfjk", + "groupName": "kjuepxerwseq", + "assessmentName": "rhzcmubwrrkhtocsibu" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "errors": [], + "disks": { + "6000C297-455f-f81e-37b7-dc17da4433d4": { + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "NumberOfReadOperationsPerSecondMissing", + "recommendedDiskSize": "StandardSSD_E10", + "recommendedDiskType": "StandardSSD", + "gigabytesForRecommendedDiskSize": 17, + "recommendDiskThroughputInMbps": 13, + "recommendedDiskIops": 7, + "monthlyStorageCost": 5, + "name": "6000C297-455f-f81e-37b7-dc17da4433d4", + "displayName": "scsi0:0", + "gigabytesProvisioned": 8, + "megabytesPerSecondOfRead": 9, + "megabytesPerSecondOfWrite": 29, + "numberOfReadOperationsPerSecond": 12, + "numberOfWriteOperationsPerSecond": 28 + } + }, + "monthlyUltraStorageCost": 11, + "hostProcessor": { + "name": "Intel(R) Xeon(R) Gold 5220R CPU @ 2.20GHz", + "numberOfSockets": 2, + "numberOfCoresPerSocket": 24 + }, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 273.792, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 14.88, + "description": null + } + ], + "monthlyBandwidthCost": 4, + "monthlyStorageCost": 10, + "monthlyPremiumStorageCost": 6, + "monthlyStandardSsdStorageCost": 4, + "networkAdapters": { + "4000": { + "suitability": "Suitable", + "suitabilityDetail": "NotApplicable", + "suitabilityExplanation": "MegabytesOfDataTransmittedMissing, MegabytesOfDataRecievedMissing", + "monthlyBandwidthCosts": 4, + "netGigabytesTransmittedPerMonth": 6, + "displayName": "VM Network", + "macAddress": "00:50:56:95:98:e8", + "ipAddresses": [ + "2404:f801:4800:1c:c4c2:1cd:7154:a028" + ], + "megabytesPerSecondReceived": 10, + "megabytesPerSecondTransmitted": 24 + } + }, + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 0, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2018-10-09T00:00:00Z", + "extendedSupportEndDate": "2023-10-10T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "2024-10-08T00:00:00Z", + "extendedSecurityUpdateYear2EndDate": "2025-10-14T00:00:00Z", + "extendedSecurityUpdateYear3EndDate": "2026-10-13T00:00:00Z" + }, + "recommendedSize": "Standard_F4s_v2", + "numberOfCoresForRecommendedSize": 8, + "megabytesOfMemoryForRecommendedSize": 27, + "monthlyComputeCostForRecommendedSize": 1, + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "PercentageOfCoresUtilizedMissing", + "type": "AssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2016 or later (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-26T09:14:13.8168575Z", + "updatedTimestamp": "2023-09-26T09:14:13.8168575Z", + "displayName": "SQLTestDBVM28", + "description": null, + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app18700site/machines/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3_50150976-65ec-de99-1b54-a52710c3066e", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app18700site/vcenters/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3", + "datacenterManagementServerName": "idclab-vcen67.fareast.corp.microsoft.com", + "megabytesOfMemory": 21, + "numberOfCores": 7, + "confidenceRatingInPercentage": 14, + "percentageCoresUtilization": 24, + "percentageMemoryUtilization": 5, + "suitability": "Suitable" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1/assessedMachines/50fa865c-8c5c-4371-b7eb-5b900d7f9451", + "name": "riigi", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments/assessedMachines", + "systemData": { + "createdBy": "jsfqnyqqwykkv", + "createdByType": "sakanwar", + "createdAt": "2023-09-26T12:46:17.892Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T12:46:17.892Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..916961c77ed7 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,225 @@ +{ + "title": "AssessedSqlDatabaseV2Operations_Get", + "operationId": "AssessedSqlDatabaseV2Operations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "assessedSqlDatabaseName": "858eb860-9e07-417c-91b6-bca1bffb3bf5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlDatabases/858eb860-9e07-417c-91b6-bca1bffb3bf5", + "name": "858eb860-9e07-417c-91b6-bca1bffb3bf5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlDatabases", + "properties": { + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "bufferCacheSizeInMB": 18.875576036866359, + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 9, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2019-07-09T00:00:00Z", + "extendedSupportEndDate": "2024-07-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "azureSqlMISuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 0.0, + "monthlyStorageCost": 0.0, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "NotSuitable", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "SkuNotFound", + "issueCategory": "Issue", + "impactedObjects": [ + { + "objectName": "Finance_User10", + "objectType": "SqlDatabase" + } + ] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": { + "azureSqlServiceTier": "GeneralPurpose", + "azureSqlComputeTier": "Provisioned", + "azureSqlHardwareGeneration": "Gen5", + "storageMaxSizeInMB": 1024.0, + "predictedDataSizeInMB": 10.0, + "predictedLogSizeInMB": 5.0, + "cores": 2, + "azureSqlTargetType": "AzureSqlDatabase" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 118.999824, + "monthlyStorageCost": 0.69, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [ + { + "reasoningId": "DatabaseCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsDatabaseStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "TotalStorageConsumedByDataFilesInGB", + "contextValue": "0.01" + }, + { + "contextKey": "TotalStorageConsumedByLogFilesInGB", + "contextValue": "0.005" + }, + { + "contextKey": "TotalRecommendedStorageInGB", + "contextValue": "1024" + } + ] + }, + { + "reasoningId": "MeetsProvisionedComputeTierRequirement", + "reasoningString": null, + "reasoningCategory": "ComputeTier", + "contextParameters": [ + { + "contextKey": "ComputeTier", + "contextValue": "Provisioned" + } + ] + }, + { + "reasoningId": "MeetsServiceTierRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "ServiceTier", + "contextValue": "GeneralPurpose" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "Finance_User10", + "objectType": "SqlDatabase" + } + ] + } + ] + }, + "isDatabaseHighlyAvailable": false, + "linkedAvailabilityGroupOverview": null, + "sizingCriterion": "AsOnPremises", + "machineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/machines/cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "assessedSqlInstanceArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlInstances/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "machineName": "SQLHAVM17", + "instanceName": "MSSQLSERVER", + "databaseName": "Finance_User10", + "databaseSizeInMB": 15.0, + "compatibilityLevel": "CompatLevel120", + "sqlDatabaseSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/mastersites/fci-ankit-test6065mastersite/sqlsites/fci-ankit-test6065sqlsites/sqldatabases/ea92ba27-3656-5370-8bcc-e5eed9d7ba5e", + "percentageCoresUtilization": 100.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0, + "confidenceRatingInPercentage": 0.0, + "createdTimestamp": "2023-09-08T05:22:34.8572031Z", + "updatedTimestamp": "2023-09-08T05:22:36.4665924Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..d1a70164a4c1 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,233 @@ +{ + "title": "AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2", + "operationId": "AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "$filter": "(contains(Properties/DatabaseName,'adv130'))", + "pageSize": 23, + "totalRecordCount": 1, + "continuationToken": null, + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlDatabases/858eb860-9e07-417c-91b6-bca1bffb3bf5", + "name": "858eb860-9e07-417c-91b6-bca1bffb3bf5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlDatabases", + "properties": { + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "bufferCacheSizeInMB": 18.875576036866359, + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 9, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2019-07-09T00:00:00Z", + "extendedSupportEndDate": "2024-07-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "azureSqlMISuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 0.0, + "monthlyStorageCost": 0.0, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "NotSuitable", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "SkuNotFound", + "issueCategory": "Issue", + "impactedObjects": [ + { + "objectName": "Finance_User10", + "objectType": "SqlDatabase" + } + ] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": { + "azureSqlServiceTier": "GeneralPurpose", + "azureSqlComputeTier": "Provisioned", + "azureSqlHardwareGeneration": "Gen5", + "storageMaxSizeInMB": 1024.0, + "predictedDataSizeInMB": 10.0, + "predictedLogSizeInMB": 5.0, + "cores": 2, + "azureSqlTargetType": "AzureSqlDatabase" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 118.999824, + "monthlyStorageCost": 0.69, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [ + { + "reasoningId": "DatabaseCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsDatabaseStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "TotalStorageConsumedByDataFilesInGB", + "contextValue": "0.01" + }, + { + "contextKey": "TotalStorageConsumedByLogFilesInGB", + "contextValue": "0.005" + }, + { + "contextKey": "TotalRecommendedStorageInGB", + "contextValue": "1024" + } + ] + }, + { + "reasoningId": "MeetsProvisionedComputeTierRequirement", + "reasoningString": null, + "reasoningCategory": "ComputeTier", + "contextParameters": [ + { + "contextKey": "ComputeTier", + "contextValue": "Provisioned" + } + ] + }, + { + "reasoningId": "MeetsServiceTierRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "ServiceTier", + "contextValue": "GeneralPurpose" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "Finance_User10", + "objectType": "SqlDatabase" + } + ] + } + ] + }, + "isDatabaseHighlyAvailable": false, + "linkedAvailabilityGroupOverview": null, + "sizingCriterion": "AsOnPremises", + "machineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/machines/cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "assessedSqlInstanceArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlInstances/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "machineName": "SQLHAVM17", + "instanceName": "MSSQLSERVER", + "databaseName": "Finance_User10", + "databaseSizeInMB": 15.0, + "compatibilityLevel": "CompatLevel120", + "sqlDatabaseSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/mastersites/fci-ankit-test6065mastersite/sqlsites/fci-ankit-test6065sqlsites/sqldatabases/ea92ba27-3656-5370-8bcc-e5eed9d7ba5e", + "percentageCoresUtilization": 100.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0, + "confidenceRatingInPercentage": 0.0, + "createdTimestamp": "2023-09-08T05:22:34.8572031Z", + "updatedTimestamp": "2023-09-08T05:22:36.4665924Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..b98abfa180da --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,474 @@ +{ + "title": "AssessedSqlInstanceV2Operations_Get", + "operationId": "AssessedSqlInstanceV2Operations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "assessedSqlInstanceName": "3c6574cf-b4e1-4fdc-93db-6bbcc570dda2" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlInstances/3c6574cf-b4e1-4fdc-93db-6bbcc570dda2", + "name": "3c6574cf-b4e1-4fdc-93db-6bbcc570dda2", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlInstances", + "properties": { + "azureSqlVMSuitabilityDetails": { + "azureSqlSku": { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.56 + } + ], + "logDiskSizes": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.56 + } + ], + "azureSqlTargetType": "AzureSqlVirtualMachine" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 32.94432, + "monthlyStorageCost": 3.12, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "MigrateDataFromSourceSqlServerToVM", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "MigrateNonReplicatedDatabasesAndAutoSeedSecondaryIfNeeded", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "MigratePrimaryReplicaAndAllOtherReplicasToIaaS", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [ + { + "reasoningId": "VirtualMachineCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineMemoryRequirement", + "reasoningString": null, + "reasoningCategory": "MemoryType", + "contextParameters": [ + { + "contextKey": "BufferPoolSizeInGB", + "contextValue": "4" + }, + { + "contextKey": "RAMRecommendedInGB", + "contextValue": "8" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "CommaSeperatedManagedDisks", + "contextValue": "2 PremiumSSD(P2)" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineFamilyRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "VirtualMachineSize", + "contextValue": "standardDASv4Family" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlVirtualMachine", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "memoryInUseInMB": 4096.0, + "hasScanOccurred": true, + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "azureSqlMISuitabilityDetails": { + "azureSqlSku": { + "azureSqlServiceTier": "BusinessCritical", + "azureSqlComputeTier": "Provisioned", + "azureSqlHardwareGeneration": "Gen5", + "storageMaxSizeInMB": 32768.0, + "predictedDataSizeInMB": 112.0, + "predictedLogSizeInMB": 112.0, + "cores": 4, + "azureSqlTargetType": "AzureSqlManagedInstance" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 475.999296, + "monthlyStorageCost": 0.0, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [ + { + "reasoningId": "InstanceCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "4" + } + ] + }, + { + "reasoningId": "MeetsInstanceStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "TotalStorageConsumedByDataFilesInGB", + "contextValue": "0.109" + }, + { + "contextKey": "TotalStorageConsumedByLogFilesInGB", + "contextValue": "0.109" + }, + { + "contextKey": "TotalRecommendedStorageInGB", + "contextValue": "32" + }, + { + "contextKey": "IncrementsInStorageInGB", + "contextValue": "32" + }, + { + "contextKey": "MaxAvailableStorageInGB", + "contextValue": "1024" + } + ] + }, + { + "reasoningId": "MeetsAlwaysOnInstanceReplicaRequirementWithoutSecondaries", + "reasoningString": null, + "reasoningCategory": "AlwaysOnAG", + "contextParameters": [ + { + "contextKey": "AlwaysOnDatabaseServiceTier", + "contextValue": "BusinessCritical" + } + ] + }, + { + "reasoningId": "MeetsProvisionedComputeTierRequirement", + "reasoningString": null, + "reasoningCategory": "ComputeTier", + "contextParameters": [ + { + "contextKey": "ComputeTier", + "contextValue": "Provisioned" + } + ] + }, + { + "reasoningId": "MeetsServiceTierRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "ServiceTier", + "contextValue": "BusinessCritical" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 833.165424, + "monthlyStorageCost": 24.69, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "storageTypeBasedDetails": [ + { + "storageType": "Rows", + "diskSizeInMB": 112.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + }, + { + "storageType": "Log", + "diskSizeInMB": 112.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + ], + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 34, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2021-07-13T00:00:00Z", + "extendedSupportEndDate": "2026-07-14T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "fciMetadata": null, + "availabilityReplicaSummary": { + "numberOfSynchronousReadReplicas": 0, + "numberOfSynchronousNonReadReplicas": 0, + "numberOfAsynchronousReadReplicas": 0, + "numberOfAsynchronousNonReadReplicas": 0, + "numberOfPrimaryReplicas": 6 + }, + "isClustered": false, + "isHighAvailabilityEnabled": true, + "recommendedTargetReasonings": [ + { + "reasoningId": "RecommendedWithWarningsForSQLVM", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "MigrationIssuesCount", + "contextValue": "0" + }, + { + "contextKey": "MigrationWarningsCount", + "contextValue": "1" + }, + { + "contextKey": "RecommendedCost", + "contextValue": "36.06432" + } + ] + }, + { + "reasoningId": "RecommendedCost", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "RecommendedCost", + "contextValue": "36.06432" + } + ] + } + ], + "sizingCriterion": "AsOnPremises", + "machineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/machines/184b8433-6991-45db-9f57-3dd3f6397a60", + "machineName": "SQLAGVM02", + "instanceName": "MSSQLSERVER", + "sqlInstanceSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/mastersites/fci-ankit-test6065mastersite/sqlsites/fci-ankit-test6065sqlsites/sqlservers/13c17b85-8842-4d50-a640-df0e45e56670", + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2016", + "numberOfCoresAllocated": 2, + "percentageCoresUtilization": 100.0, + "logicalDisks": [ + { + "diskId": "s:", + "diskSizeInMB": 104.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + }, + { + "diskId": "l:", + "diskSizeInMB": 104.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + }, + { + "diskId": "c:", + "diskSizeInMB": 16.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + ], + "databaseSummary": { + "numberOfUserDatabases": 6, + "totalDatabaseSizeInMB": 224.0, + "largestDatabaseSizeInMB": 144.0, + "totalDiscoveredUserDatabases": 7 + }, + "confidenceRatingInPercentage": 0.0, + "createdTimestamp": "2023-09-08T05:22:34.9353438Z", + "updatedTimestamp": "2023-09-08T05:22:35.9666076Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..e43e084aedc9 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,505 @@ +{ + "title": "AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2", + "operationId": "AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "$filter": "(contains(Properties/InstanceName,'MSSQLSERVER'))", + "pageSize": 23, + "continuationToken": null, + "totalRecordCount": 1, + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/dhlodhiccy/providers/Microsoft.Migrate/assessmentprojects/dhccy30279project/groups/test_paas_pref_grp_2812/sqlAssessments/test_train_250823/assessedSqlInstances/27b94796-026e-4278-a546-664d46977c0a", + "name": "27b94796-026e-4278-a546-664d46977c0a", + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlInstances", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "properties": { + "azureSqlVMSuitabilityDetails": { + "azureSqlSku": { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [ + { + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.2 + } + ], + "logDiskSizes": [ + { + "diskType": "Premium", + "diskSize": "Premium_P3", + "diskRedundancy": "LRS", + "storageCost": 2.4 + } + ], + "azureSqlTargetType": "AzureSqlVirtualMachine" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 26.361408, + "monthlyStorageCost": 3.6, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 15.0, + "description": null + } + ], + "securitySuitability": "Suitable", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "MigrateDataFromSourceSqlServerToVM", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [ + { + "reasoningId": "MeetsVirtualMachineCpuScalingFactorRequirement", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "CoreUtilizationPercentage", + "contextValue": "0" + }, + { + "contextKey": "AllocatedCores", + "contextValue": "4" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineMemoryRequirement", + "reasoningString": null, + "reasoningCategory": "MemoryType", + "contextParameters": [ + { + "contextKey": "BufferPoolSizeInGB", + "contextValue": "0" + }, + { + "contextKey": "RAMRecommendedInGB", + "contextValue": "8" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineIOPSRequirement", + "reasoningString": null, + "reasoningCategory": "IOPSType", + "contextParameters": [ + { + "contextKey": "VirtualMachineIOPSRequiredInIOPerSec", + "contextValue": "0" + }, + { + "contextKey": "VirtualMachineUncachedDiskIOPSAvailableInIOPerSec", + "contextValue": "3200" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineIOThroughputRequirement", + "reasoningString": null, + "reasoningCategory": "ThroughputType", + "contextParameters": [ + { + "contextKey": "VirtualMachineIOThroughputRequiredInInMBPerSec", + "contextValue": "0" + }, + { + "contextKey": "VirtualMachineIOThroughputUncachedAvailableInIOPerSec", + "contextValue": "48" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "CommaSeperatedManagedDisks", + "contextValue": "1 PremiumSSD_P2,1 PremiumSSD_P3" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineFamilyRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "VirtualMachineSize", + "contextValue": "standardDASv4Family" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlVirtualMachine", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + } + ] + }, + "memoryInUseInMB": 0.0, + "hasScanOccurred": true, + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "azureSqlMISuitabilityDetails": { + "azureSqlSku": { + "azureSqlServiceTier": "GeneralPurpose", + "azureSqlComputeTier": "Provisioned", + "azureSqlHardwareGeneration": "Gen5", + "storageMaxSizeInMB": 65536.0, + "predictedDataSizeInMB": 6696.25, + "predictedLogSizeInMB": 14220.125, + "cores": 4, + "azureSqlTargetType": "AzureSqlManagedInstance" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 199.999104, + "monthlyStorageCost": 3.68, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 15.0, + "description": null + } + ], + "securitySuitability": "Suitable", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "MigrateDataFromSourceSqlServerToMI", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [ + { + "reasoningId": "MeetsInstanceCpuScalingFactorRequirement", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "CoreUtilizationPercentage", + "contextValue": "0" + }, + { + "contextKey": "AllocatedCores", + "contextValue": "4" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "4" + } + ] + }, + { + "reasoningId": "MeetsInstanceStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "TotalStorageConsumedByDataFilesInGB", + "contextValue": "6.539" + }, + { + "contextKey": "TotalStorageConsumedByLogFilesInGB", + "contextValue": "13.887" + }, + { + "contextKey": "TotalRecommendedStorageInGB", + "contextValue": "64" + }, + { + "contextKey": "IncrementsInStorageInGB", + "contextValue": "32" + }, + { + "contextKey": "MaxAvailableStorageInGB", + "contextValue": "2048" + } + ] + }, + { + "reasoningId": "MeetsInstanceIOThroughputRequirement", + "reasoningString": null, + "reasoningCategory": "ThroughputType", + "contextParameters": [ + { + "contextKey": "InstanceLevelThroughputRequiredInMBPerSec", + "contextValue": "0" + }, + { + "contextKey": "InstanceLevelThroughputAvailableInMBPerSec", + "contextValue": "10" + } + ] + }, + { + "reasoningId": "MeetsInstanceIOPSDataLogRequirement", + "reasoningString": null, + "reasoningCategory": "IOPSType", + "contextParameters": [ + { + "contextKey": "InstanceLevelIOPSRequiredInIOPerSec", + "contextValue": "0" + }, + { + "contextKey": "InstanceLevelIOPSAvailableInIOPerSec", + "contextValue": "6000" + } + ] + }, + { + "reasoningId": "MeetsProvisionedComputeTierRequirement", + "reasoningString": null, + "reasoningCategory": "ComputeTier", + "contextParameters": [ + { + "contextKey": "ComputeTier", + "contextValue": "Provisioned" + } + ] + }, + { + "reasoningId": "MeetsServiceTierRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "ServiceTier", + "contextValue": "GeneralPurpose" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 1199.994624, + "monthlyStorageCost": 7.13, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 15.0, + "description": null + } + ], + "securitySuitability": "Suitable", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "MigrateDataFromSourceSqlServerToDB", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "ServerCredentials", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "accessibilitytestdiag917", + "objectType": "ServerCredential" + } + ] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + } + ] + }, + "storageTypeBasedDetails": [ + { + "storageType": "Rows", + "diskSizeInMB": 6696.25, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + }, + { + "storageType": "Log", + "diskSizeInMB": 14220.125, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + ], + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 34, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2021-07-13T00:00:00Z", + "extendedSupportEndDate": "2026-07-14T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "fciMetadata": null, + "availabilityReplicaSummary": null, + "isClustered": false, + "isHighAvailabilityEnabled": false, + "recommendedTargetReasonings": [ + { + "reasoningId": "RecommendedForSQLVM", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "MigrationIssuesCount", + "contextValue": "0" + }, + { + "contextKey": "MigrationWarningsCount", + "contextValue": "0" + }, + { + "contextKey": "RecommendedCost", + "contextValue": "29.961408" + } + ] + }, + { + "reasoningId": "RecommendedCost", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "RecommendedCost", + "contextValue": "29.961408" + } + ] + }, + { + "reasoningId": "SQLMICost", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "SQLMICost", + "contextValue": "203.679104" + } + ] + }, + { + "reasoningId": "SQLDBCost", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "SQLDBCost", + "contextValue": "1207.124624" + } + ] + } + ], + "sizingCriterion": "PerformanceBased", + "machineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/dhlodhiccy/providers/Microsoft.Migrate/assessmentprojects/dhccy30279project/machines/daf51245-560b-4caa-9c18-5409ab93d319", + "machineName": "SQLTestDBVM46", + "instanceName": "MSSQLSERVER", + "sqlInstanceSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/dhlodhiccy/providers/microsoft.offazure/mastersites/dhccy37819mastersite/sqlsites/dhccy37819sqlsites/sqlservers/a5a6441d-9f63-463e-a720-73fecd90a2e4", + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2016", + "numberOfCoresAllocated": 4, + "percentageCoresUtilization": 0.0, + "logicalDisks": [ + { + "diskId": "d:", + "diskSizeInMB": 20916.375, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + ], + "databaseSummary": { + "numberOfUserDatabases": 12, + "totalDatabaseSizeInMB": 20916.375, + "largestDatabaseSizeInMB": 20815.0, + "totalDiscoveredUserDatabases": 12 + }, + "confidenceRatingInPercentage": 0.0, + "createdTimestamp": "2023-08-25T09:20:24.5544874Z", + "updatedTimestamp": "2023-08-25T09:20:25.2195402Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlMachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlMachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..a7fca64bc148 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlMachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,155 @@ +{ + "title": "AssessedSqlMachinesOperations_Get", + "operationId": "AssessedSqlMachinesOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "assessedSqlMachineName": "cc64c9dc-b38e-435d-85ad-d509df5d92c6" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlMachines/cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "name": "cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlMachines", + "properties": { + "biosGuid": null, + "fqdn": null, + "sqlInstances": [ + { + "instanceId": "291313e5-e25f-4b6b-9f21-165a2dd03650", + "instanceName": "MSSQLSERVER", + "sqlInstanceSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/mastersites/fci-ankit-test6065mastersite/sqlsites/fci-ankit-test6065sqlsites/sqlservers/291313e5-e25f-4b6b-9f21-165a2dd03650", + "sqlInstanceEntityId": "b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2014", + "isClustered": true, + "isHighAvailabilityEnabled": true, + "sqlFciState": "Active" + } + ], + "suitabilityDetail": "PercentageOfCoresUtilizedMissing, PercentageOfMemoryUtilizedMissing", + "suitabilityExplanation": "NotApplicable", + "recommendedVmSize": "Standard_D2as_v4", + "recommendedVmFamily": "Dasv4_series", + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Mainstream", + "eta": 64, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2024-01-09T00:00:00Z", + "extendedSupportEndDate": "2029-01-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "recommendedVmSizeNumberOfCores": 2, + "recommendedVmSizeMegabytesOfMemory": 8192.0, + "monthlyComputeCost": 32.94432, + "disks": { + "6000C293-381c-8460-c29b-ef937230e629": { + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "NumberOfReadOperationsPerSecondMissing, NumberOfWriteOperationsPerSecondMissing, MegabytesPerSecondOfReadMissing, MegabytesPerSecondOfWriteMissing", + "recommendedDiskSize": "Premium_P10", + "recommendedDiskType": "Premium", + "recommendedDiskSizeGigabytes": 128, + "recommendDiskThroughputInMbps": 100.0, + "recommendedDiskIops": 500.0, + "monthlyStorageCost": 19.71, + "name": "6000C293-381c-8460-c29b-ef937230e629", + "displayName": "scsi0:0", + "gigabytesProvisioned": 100.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + }, + "networkAdapters": { + "4000": { + "suitability": "Suitable", + "suitabilityDetail": "MegabytesOfDataTransmittedMissing, MegabytesOfDataRecievedMissing", + "suitabilityExplanation": "NotApplicable", + "monthlyBandwidthCosts": 0.0, + "netGigabytesTransmittedPerMonth": 0.0, + "name": "4000", + "displayName": "VM Network", + "macAddress": "00:50:56:82:b7:83", + "ipAddresses": [ + "2404:f801:4800:20:418c:eec9:86c5:aea1", + "2404:f801:4800:20:6113:238d:17f0:b246", + "10.150.91.119", + "10.150.91.138", + "10.150.91.139" + ], + "megabytesPerSecondReceived": 0.0, + "megabytesPerSecondTransmitted": 0.0 + } + }, + "monthlyBandwidthCost": 0.0, + "monthlyStorageCost": 19.71, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "migrationGuidelines": [ + { + "guidelineId": "MigrateNodeSinceItHasActiveFCIInstance", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "UseSharedDiskWitnessForWSFCIfNeeded", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ReconfigureAnyAvailabilityGroupsAfterMigration", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + } + ], + "sizingCriterion": "PerformanceBased", + "type": "SqlAssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2019 (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-08T05:22:34.8416411Z", + "updatedTimestamp": "2023-09-08T05:23:39.1749465Z", + "displayName": "SQLHAVM17", + "description": "", + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/vmwaresites/fci-ankit-test6904site/machines/10-150-91-150-202bfa1a-ad9f-414f-91ff-61f5ca0540aa_5002fdf3-5889-c2f8-86e5-3119b251331b", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/VMwareSites/fci-ankit-test6904site/vcenters/10-150-91-150-202bfa1a-ad9f-414f-91ff-61f5ca0540aa", + "datacenterManagementServerName": "10.150.91.150", + "megabytesOfMemory": 4096.0, + "numberOfCores": 2, + "confidenceRatingInPercentage": 0.0, + "percentageCoresUtilization": 0.0, + "percentageMemoryUtilization": 0.0, + "suitability": "Suitable" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..06215da53218 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,163 @@ +{ + "title": "AssessedSqlMachinesOperations_ListBySqlAssessmentV2", + "operationId": "AssessedSqlMachinesOperations_ListBySqlAssessmentV2", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "$filter": "(contains(Properties/DisplayName,'SQLHAVM17'))", + "pageSize": 23, + "totalRecordCount": 1, + "continuationToken": null, + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlMachines/cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "name": "cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlMachines", + "properties": { + "biosGuid": null, + "fqdn": null, + "sqlInstances": [ + { + "instanceId": "291313e5-e25f-4b6b-9f21-165a2dd03650", + "instanceName": "MSSQLSERVER", + "sqlInstanceSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/mastersites/fci-ankit-test6065mastersite/sqlsites/fci-ankit-test6065sqlsites/sqlservers/291313e5-e25f-4b6b-9f21-165a2dd03650", + "sqlInstanceEntityId": "b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2014", + "isClustered": true, + "isHighAvailabilityEnabled": true, + "sqlFciState": "Active" + } + ], + "suitabilityDetail": "PercentageOfCoresUtilizedMissing, PercentageOfMemoryUtilizedMissing", + "suitabilityExplanation": "NotApplicable", + "recommendedVmSize": "Standard_D2as_v4", + "recommendedVmFamily": "Dasv4_series", + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Mainstream", + "eta": 64, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2024-01-09T00:00:00Z", + "extendedSupportEndDate": "2029-01-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "recommendedVmSizeNumberOfCores": 2, + "recommendedVmSizeMegabytesOfMemory": 8192.0, + "monthlyComputeCost": 32.94432, + "disks": { + "6000C293-381c-8460-c29b-ef937230e629": { + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "NumberOfReadOperationsPerSecondMissing, NumberOfWriteOperationsPerSecondMissing, MegabytesPerSecondOfReadMissing, MegabytesPerSecondOfWriteMissing", + "recommendedDiskSize": "Premium_P10", + "recommendedDiskType": "Premium", + "recommendedDiskSizeGigabytes": 128, + "recommendDiskThroughputInMbps": 100.0, + "recommendedDiskIops": 500.0, + "monthlyStorageCost": 19.71, + "name": "6000C293-381c-8460-c29b-ef937230e629", + "displayName": "scsi0:0", + "gigabytesProvisioned": 100.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + }, + "networkAdapters": { + "4000": { + "suitability": "Suitable", + "suitabilityDetail": "MegabytesOfDataTransmittedMissing, MegabytesOfDataRecievedMissing", + "suitabilityExplanation": "NotApplicable", + "monthlyBandwidthCosts": 0.0, + "netGigabytesTransmittedPerMonth": 0.0, + "name": "4000", + "displayName": "VM Network", + "macAddress": "00:50:56:82:b7:83", + "ipAddresses": [ + "2404:f801:4800:20:418c:eec9:86c5:aea1", + "2404:f801:4800:20:6113:238d:17f0:b246", + "10.150.91.119", + "10.150.91.138", + "10.150.91.139" + ], + "megabytesPerSecondReceived": 0.0, + "megabytesPerSecondTransmitted": 0.0 + } + }, + "monthlyBandwidthCost": 0.0, + "monthlyStorageCost": 19.71, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "migrationGuidelines": [ + { + "guidelineId": "MigrateNodeSinceItHasActiveFCIInstance", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "UseSharedDiskWitnessForWSFCIfNeeded", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ReconfigureAnyAvailabilityGroupsAfterMigration", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + } + ], + "sizingCriterion": "PerformanceBased", + "type": "SqlAssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2019 (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-08T05:22:34.8416411Z", + "updatedTimestamp": "2023-09-08T05:23:39.1749465Z", + "displayName": "SQLHAVM17", + "description": "", + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/vmwaresites/fci-ankit-test6904site/machines/10-150-91-150-202bfa1a-ad9f-414f-91ff-61f5ca0540aa_5002fdf3-5889-c2f8-86e5-3119b251331b", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/VMwareSites/fci-ankit-test6904site/vcenters/10-150-91-150-202bfa1a-ad9f-414f-91ff-61f5ca0540aa", + "datacenterManagementServerName": "10.150.91.150", + "megabytesOfMemory": 4096.0, + "numberOfCores": 2, + "confidenceRatingInPercentage": 0.0, + "percentageCoresUtilization": 0.0, + "percentageMemoryUtilization": 0.0, + "suitability": "Suitable" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlMachines?api-version=2023-05-01-preview&pageSize=1&continuationToken=%5b%7b%22token%22%3a%22%2bRID%3a%7eOHlvANYGbAopzgkAAAAAAg%3d%3d%23RT%3a1%23TRC%3a1%23ISV%3a2%23IEO%3a65551%23QCF%3a8%23FPC%3aASnOCQAAAAACO84JAAAAAAI%3d%22%2c%22range%22%3a%7b%22min%22%3a%2205C1D9CD673390%22%2c%22max%22%3a%2205C1DFFFFFFFF4%22%7d%7d%5d&totalRecordCount=19" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..1bb7d4898f01 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,330 @@ +{ + "title": "AssessedSqlRecommendedEntityOperations_Get", + "operationId": "AssessedSqlRecommendedEntityOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "recommendedAssessedEntityName": "cc64c9dc-b38e-435d-85ad-d509df5d92c6" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/recommendedAssessedEntities/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "name": "b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/recommendedAssessedEntities", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "properties": { + "azureSqlVMSuitabilityDetails": { + "azureSqlSku": { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [], + "logDiskSizes": [], + "azureSqlTargetType": "AzureSqlVirtualMachine" + }, + "replicaAzureSqlSku": [ + { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [], + "logDiskSizes": [], + "azureSqlTargetType": "AzureSqlVirtualMachine" + } + ], + "sharedResources": { + "sharedDataDisks": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.6380000000000001 + } + ], + "sharedLogDisks": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.6380000000000001 + } + ], + "sharedTempDbDisks": [], + "numberOfMounts": 2, + "quorumWitness": { + "quorumWitnessType": "Disk" + } + }, + "monthlyComputeCost": 65.88864, + "monthlyStorageCost": 3.276, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": true, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "ProvisionInstanceAsFciOnSqlVM", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ProvisionDisksBasedOnLayoutInSku", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ProvisionSharedDiskForQuorum", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "MigrateNonReplicatedDatabasesAndAutoSeedSecondaryIfNeeded", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [ + { + "reasoningId": "VirtualMachineCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineMemoryRequirement", + "reasoningString": null, + "reasoningCategory": "MemoryType", + "contextParameters": [ + { + "contextKey": "BufferPoolSizeInGB", + "contextValue": "4" + }, + { + "contextKey": "RAMRecommendedInGB", + "contextValue": "8" + } + ] + }, + { + "reasoningId": "AlwaysOnVirtualMachineFCIDiskWitness", + "reasoningString": null, + "reasoningCategory": "AlwaysOnFCI", + "contextParameters": [] + }, + { + "reasoningId": "AlwaysOnVirtualMachineFCISharedZRSDisks", + "reasoningString": null, + "reasoningCategory": "AlwaysOnFCI", + "contextParameters": [] + }, + { + "reasoningId": "MeetsVirtualMachineStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "CommaSeperatedManagedDisks", + "contextValue": "" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineFamilyRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "VirtualMachineSize", + "contextValue": "standardDASv4Family" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlVirtualMachine", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "machineName": "FC7-SQL2K14.FPL.COM", + "instanceName": "MSSQLSERVER", + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 9, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2019-07-09T00:00:00Z", + "extendedSupportEndDate": "2024-07-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "dbCount": 217, + "discoveredDBCount": 217, + "hasScanOccurred": true, + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "azureSqlMISuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 0.0, + "monthlyStorageCost": 0.0, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "NotSuitable", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "SkuNotFound", + "issueCategory": "Issue", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 25822.9618079999, + "monthlyStorageCost": 149.73, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "assessedSqlEntityArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlInstances/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "isClustered": true, + "isHighAvailabilityEnabled": true, + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2014", + "sizingCriterion": "AsOnPremises" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..348298f89a97 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,330 @@ +{ + "title": "AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2", + "operationId": "AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "$filter": "(contains(Properties/InstanceName,'MSSQLSERVER'))", + "pageSize": 23, + "continuationToken": null, + "totalRecordCount": 1, + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/recommendedAssessedEntities/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "name": "b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/recommendedAssessedEntities", + "properties": { + "azureSqlVMSuitabilityDetails": { + "azureSqlSku": { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [], + "logDiskSizes": [], + "azureSqlTargetType": "AzureSqlVirtualMachine" + }, + "replicaAzureSqlSku": [ + { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [], + "logDiskSizes": [], + "azureSqlTargetType": "AzureSqlVirtualMachine" + } + ], + "sharedResources": { + "sharedDataDisks": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.6380000000000001 + } + ], + "sharedLogDisks": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.6380000000000001 + } + ], + "sharedTempDbDisks": [], + "numberOfMounts": 2, + "quorumWitness": { + "quorumWitnessType": "Disk" + } + }, + "monthlyComputeCost": 65.88864, + "monthlyStorageCost": 3.276, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": true, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "ProvisionInstanceAsFciOnSqlVM", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ProvisionDisksBasedOnLayoutInSku", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ProvisionSharedDiskForQuorum", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "MigrateNonReplicatedDatabasesAndAutoSeedSecondaryIfNeeded", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [ + { + "reasoningId": "VirtualMachineCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineMemoryRequirement", + "reasoningString": null, + "reasoningCategory": "MemoryType", + "contextParameters": [ + { + "contextKey": "BufferPoolSizeInGB", + "contextValue": "4" + }, + { + "contextKey": "RAMRecommendedInGB", + "contextValue": "8" + } + ] + }, + { + "reasoningId": "AlwaysOnVirtualMachineFCIDiskWitness", + "reasoningString": null, + "reasoningCategory": "AlwaysOnFCI", + "contextParameters": [] + }, + { + "reasoningId": "AlwaysOnVirtualMachineFCISharedZRSDisks", + "reasoningString": null, + "reasoningCategory": "AlwaysOnFCI", + "contextParameters": [] + }, + { + "reasoningId": "MeetsVirtualMachineStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "CommaSeperatedManagedDisks", + "contextValue": "" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineFamilyRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "VirtualMachineSize", + "contextValue": "standardDASv4Family" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlVirtualMachine", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "machineName": "FC7-SQL2K14.FPL.COM", + "instanceName": "MSSQLSERVER", + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 9, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2019-07-09T00:00:00Z", + "extendedSupportEndDate": "2024-07-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "dbCount": 217, + "discoveredDBCount": 217, + "hasScanOccurred": true, + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "azureSqlMISuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 0.0, + "monthlyStorageCost": 0.0, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "NotSuitable", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "SkuNotFound", + "issueCategory": "Issue", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 25822.9618079999, + "monthlyStorageCost": 149.73, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "assessedSqlEntityArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlInstances/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "isClustered": true, + "isHighAvailabilityEnabled": true, + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2014", + "sizingCriterion": "AsOnPremises" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/recommendedAssessedEntities?api-version=2023-05-01-preview&pageSize=1&continuationToken=%5b%7b%22token%22%3a%22%2bRID%3a%7eOHlvAMMvEvMxeAsAAAAABQ%3d%3d%23RT%3a1%23TRC%3a1%23ISV%3a2%23IEO%3a65567%23QCF%3a8%23FPC%3aATF4CwAAAAAFRXgLAAAAAAU%3d%22%2c%22range%22%3a%7b%22min%22%3a%2205C1D32F43775C%22%2c%22max%22%3a%2205C1DFFFFFFFFC%22%7d%7d%5d&totalRecordCount=21" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebAppV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebAppV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..6f7c1705b8a6 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebAppV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,63 @@ +{ + "title": "AssessedWebAppV2Operations_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "AssessedWebAppV2Operations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2", + "assessedWebAppName": "webapp1" + }, + "responses": { + "200": { + "body": { + "properties": { + "webAppType": "IIS", + "targetSpecificResult": { + "azureAppService": { + "assessmentResult": { + "appServicePlanName": "plan-001-azureappservice", + "suitability": "Suitable", + "securitySuitability": "Unknown", + "webAppSkuName": "Isolated", + "webAppSkuSize": "I1" + }, + "migrationIssues": [ + { + "issueId": "AppPoolIdentityCheck", + "issueCategory": "Info", + "issueDescriptionList": [ + "SpecificUser (SharePoint - 80), SpecificUser (SecurityTokenServiceApplicationPool)" + ] + } + ] + } + }, + "appServicePlanName": "plan-001-azureappservice,plan-001-azureappservicecontainer", + "machineName": "a404-r1w28r2-1", + "serverArmId": null, + "webServerName": "IIS Server", + "webAppName": "100%WebSite", + "discoveredWebAppId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/sumukk-ccy-bcs/providers/microsoft.offazure/mastersites/sumukk-ccy-bcs9880mastersite/webappsites/sumukk-ccy-bcs9880webappsites/iiswebapplications/aa096c1b26cd80dd76e547d61d722d04e1779a9c8d95ae1baa91bdb226eb5c3d-9e55bf838a799e058f7c0478ff1029d5224456ab0a1c30f3a8779ba7bb841e88", + "discoveredMachineId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/sumukk-ccy-bcs/providers/microsoft.offazure/vmwaresites/sumukk-ccy-bcs4557site/machines/idclab-vcen67-fareast-corp-micr-49743448-0440-4c6b-8300-eec352b87e73_5037cd30-828f-f362-c62c-d1715b8ede4c", + "confidenceRatingInPercentage": null, + "createdTimestamp": "2023-11-03T05:42:51.551Z", + "updatedTimestamp": "2023-11-03T05:42:51.551Z" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2/assessedWebApps/e1c05a87-93c7-4b01-bf19-a4db9bf791a8", + "name": "e1c05a87-93c7-4b01-bf19-a4db9bf791a8", + "type": "Microsoft.Migrate/assessmentprojects/groups/webAppAssessments/assessedWebApps", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..e04d18b4ae19 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,71 @@ +{ + "title": "AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "AssessedWebAppV2Operations_ListByWebAppAssessmentV2", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "$filter": "", + "pageSize": 23, + "continuationToken": "pwqummugahjguraaqqssuwmxic", + "totalRecordCount": 6, + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "akgugrp2", + "assessmentName": "assess1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "webAppType": "IIS", + "targetSpecificResult": { + "azureAppService": { + "assessmentResult": { + "appServicePlanName": "plan-003-azureappservicecontainer", + "suitability": "ConditionallySuitable", + "securitySuitability": "Suitable", + "webAppSkuName": "Premium_V3", + "webAppSkuSize": "P1 v3" + }, + "migrationIssues": [ + { + "issueId": "AuthCheckContainer", + "issueCategory": "Info", + "issueDescriptionList": [ + "windowsAuthentication (/)" + ] + } + ] + } + }, + "appServicePlanName": "plan-001-azureappservice", + "machineName": "windows-2k16", + "serverArmId": null, + "webServerName": "IIS Server", + "webAppName": "Microsoft Azure Migrate App Containerization", + "discoveredWebAppId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/sumukk-ccy-bcs/providers/microsoft.offazure/mastersites/sumukk-ccy-bcs9880mastersite/webappsites/sumukk-ccy-bcs9880webappsites/iiswebapplications/70c2efd9345164750ddf889a474512530466d8f7aaa85052b59a73ff6a4d41b1-ae625d98de8e57d253ae9812590de37f17f382bcd47da01c2f3f9be5350ae98e", + "discoveredMachineId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/sumukk-ccy-bcs/providers/microsoft.offazure/vmwaresites/sumukk-ccy-bcs4557site/machines/idclab-vcen67-fareast-corp-micr-49743448-0440-4c6b-8300-eec352b87e73_5015ed4a-5f13-8cd3-a4d4-1ec729e836ff", + "confidenceRatingInPercentage": 11, + "createdTimestamp": "2023-11-03T05:42:51.551Z", + "updatedTimestamp": "2023-11-03T05:42:51.551Z" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/groups/akgugrp2/webAppAssessments/akgutestappsvc2/assessedWebApps/2d4423e1-9b0d-466f-a2f1-4f68adaa3c76", + "name": "2d4423e1-9b0d-466f-a2f1-4f68adaa3c76", + "type": "Microsoft.Migrate/assessmentprojects/groups/webAppAssessments/assessedWebApps", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebApplicationOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebApplicationOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..ce2fec0cc3a0 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebApplicationOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "title": "AssessedWebApplicationOperations_Get", + "operationId": "AssessedWebApplicationOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment", + "assessedWorkload": "testaksassessmentapp" + }, + "responses": { + "200": { + "body": { + "properties": { + "suitabilityResult": { + "readiness": "Unknown", + "suitability": "NotSuitable", + "failedChecks": [ + { + "name": "check", + "behavior": "Issue", + "description": "check", + "cause": "check", + "recommendation": "upgrade IIS version", + "moreInfo": { + "title": "title", + "url": "https://www.bing.com" + } + } + ], + "suggestedMigrationTool": "None" + }, + "recommendationResult": { + "request": { + "cores": 12, + "memory": 28 + }, + "limit": { + "cores": 18, + "memory": 13 + }, + "osType": "Linux", + "clusterName": "testaksassessment-cluster", + "nodePoolId": "testaksassessmentCostDetail", + "nodePoolName": "testaksassessmentCostDetail", + "nodePoolArmSkuName": "StandardDS_v2", + "approxMonthlyCost": 3 + }, + "discoveryArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/webApps/webapp", + "displayName": "webapp", + "webServerArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/webServers/webserver", + "webServerDisplayName": "webserver", + "machineArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/machines/machine", + "machineDisplayName": "machine", + "webAppType": "IIS" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentprojects/testproject/aksAssessments/testaksassessment/assessedWebApps/testaksassessmentapp", + "name": "testaksassessmentapp", + "type": "AssessedWebApplication", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..51daadff6ff7 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen.json @@ -0,0 +1,81 @@ +{ + "title": "AssessedWebApplicationOperations_ListByAksAssessment", + "operationId": "AssessedWebApplicationOperations_ListByAksAssessment", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "continuationToken": "gjilveslqiowaembajtj", + "$top": 13, + "$filter": "zqvpvrpvghjnxamq", + "totalRecordCount": 23, + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "suitabilityResult": { + "readiness": "Unknown", + "suitability": "NotSuitable", + "failedChecks": [ + { + "name": "check", + "behavior": "Issue", + "description": "check", + "cause": "check", + "recommendation": "upgrade IIS version", + "moreInfo": { + "title": "title", + "url": "https://www.bing.com" + } + } + ], + "suggestedMigrationTool": "None" + }, + "recommendationResult": { + "request": { + "cores": 12, + "memory": 28 + }, + "limit": { + "cores": 18, + "memory": 13 + }, + "osType": "Linux", + "clusterName": "testaksassessment-cluster", + "nodePoolId": "testaksassessmentCostDetail", + "nodePoolName": "testaksassessmentCostDetail", + "nodePoolArmSkuName": "StandardDS_v2", + "approxMonthlyCost": 3 + }, + "discoveryArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/webApps/webapp", + "displayName": "webapp", + "webServerArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/webServers/webserver", + "webServerDisplayName": "webserver", + "machineArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/machines/machine", + "machineDisplayName": "machine", + "webAppType": "IIS" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentprojects/testproject/aksAssessments/testaksassessment/assessedWebApps/testaksassessmentapp", + "name": "testaksassessmentapp", + "type": "AssessedWebApplication", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentOptionsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentOptionsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..4bf59fede16d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentOptionsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,3079 @@ +{ + "title": "AssessmentOptionsOperations_Get", + "operationId": "AssessmentOptionsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "assessmentOptionsName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "vmFamilies": [ + { + "familyName": "Basic_A0_A4", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Standard_A0_A7", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Av2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "D_series", + "targetLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "ChinaEast", + "ChinaNorth", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized" + ] + }, + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dsv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "DC_Series", + "targetLocations": [ + "EastUs", + "WestEurope" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage", + "Confidential" + ] + }, + { + "familyName": "DS_series", + "targetLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "ChinaEast", + "ChinaNorth", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "DSv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Esv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ev5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Eav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Esv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Esv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ev3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ev4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "F_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized" + ] + }, + { + "familyName": "Fs_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Fsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "G_series", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "CanadaEast", + "EastUs2", + "JapanEast", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "GS_series", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "CanadaEast", + "EastUs2", + "JapanEast", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Lsv2_series", + "targetLocations": [ + "AustraliaEast", + "CentralIndia", + "CentralUs", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "StorageOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Msv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + } + ], + "reservedInstanceVmFamilies": [ + "D_series", + "Dv2_series", + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "Dv3_series", + "Dv4_series", + "Dv5_series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Edv5_series", + "Esv5_series", + "Ev5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "Esv3_series", + "Esv4_series", + "Ev3_series", + "Ev4_series", + "F_series", + "Fs_series", + "Fsv2_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "reservedInstanceSupportedLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "AustraliaCentral", + "AustraliaCentral2", + "CanadaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "KoreaCentral", + "KoreaSouth", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia", + "USGovIowa" + ], + "reservedInstanceSupportedCurrencies": [ + "USD", + "DKK", + "CAD", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SEK", + "GBP", + "INR", + "BRL", + "TWD", + "EUR", + "CHF", + "AUD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P", + "MSAZRUSGOV0003P" + ], + "ultraDiskVmFamilies": [ + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Dasv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Dsv3_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Dsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Dsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Dv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Esv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Ev5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Easv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Esv3_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Esv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Fs_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Fsv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Lsv2_series", + "targetLocations": [ + "CentralIndia", + "GermanyWestCentral", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Msv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + } + ], + "premiumDiskVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Ddsv4_series", + "Ddsv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "DC_Series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Esv5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Esv3_series", + "Esv4_series", + "Fs_series", + "Fsv2_series", + "GS_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "savingsPlanVmFamilies": [ + "D_series", + "Dv2_series", + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "Dv3_series", + "Dv4_series", + "Dv5_series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Edv5_series", + "Esv5_series", + "Ev5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "Esv3_series", + "Esv4_series", + "Ev3_series", + "Ev4_series", + "F_series", + "Fs_series", + "Fsv2_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "savingsPlanSupportedLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "AustraliaCentral", + "AustraliaCentral2", + "CanadaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorwayEast", + "NorwayWest", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestUs2", + "PolandCentral" + ] + }, + "type": "Microsoft.Migrate/assessmentprojects/{assessmentOptionsName}", + "name": "default", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/assessmentOptions/default", + "systemData": { + "createdBy": "asd", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "tnmop", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..85fd43eb9807 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,3083 @@ +{ + "title": "AssessmentOptionsOperations_ListByAssessmentProject", + "operationId": "AssessmentOptionsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "A926B99C-7F4C-4556-871E-20CB8C6ADB56", + "resourceGroupName": "rgmigrate", + "projectName": "fhodvffhuoqwbysrrqbizete" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "vmFamilies": [ + { + "familyName": "Basic_A0_A4", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Standard_A0_A7", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Av2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "D_series", + "targetLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "ChinaEast", + "ChinaNorth", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized" + ] + }, + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dsv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "DC_Series", + "targetLocations": [ + "EastUs", + "WestEurope" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage", + "Confidential" + ] + }, + { + "familyName": "DS_series", + "targetLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "ChinaEast", + "ChinaNorth", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "DSv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Esv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ev5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Eav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Esv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Esv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ev3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ev4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "F_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized" + ] + }, + { + "familyName": "Fs_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Fsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "G_series", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "CanadaEast", + "EastUs2", + "JapanEast", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "GS_series", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "CanadaEast", + "EastUs2", + "JapanEast", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Lsv2_series", + "targetLocations": [ + "AustraliaEast", + "CentralIndia", + "CentralUs", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "StorageOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Msv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + } + ], + "reservedInstanceVmFamilies": [ + "D_series", + "Dv2_series", + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "Dv3_series", + "Dv4_series", + "Dv5_series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Edv5_series", + "Esv5_series", + "Ev5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "Esv3_series", + "Esv4_series", + "Ev3_series", + "Ev4_series", + "F_series", + "Fs_series", + "Fsv2_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "reservedInstanceSupportedLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "AustraliaCentral", + "AustraliaCentral2", + "CanadaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "KoreaCentral", + "KoreaSouth", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia", + "USGovIowa" + ], + "reservedInstanceSupportedCurrencies": [ + "USD", + "DKK", + "CAD", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SEK", + "GBP", + "INR", + "BRL", + "TWD", + "EUR", + "CHF", + "AUD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P", + "MSAZRUSGOV0003P" + ], + "ultraDiskVmFamilies": [ + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Dasv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Dsv3_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Dsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Dsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Dv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Esv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Ev5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Easv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Esv3_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Esv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Fs_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Fsv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Lsv2_series", + "targetLocations": [ + "CentralIndia", + "GermanyWestCentral", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Msv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + } + ], + "premiumDiskVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Ddsv4_series", + "Ddsv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "DC_Series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Esv5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Esv3_series", + "Esv4_series", + "Fs_series", + "Fsv2_series", + "GS_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "savingsPlanVmFamilies": [ + "D_series", + "Dv2_series", + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "Dv3_series", + "Dv4_series", + "Dv5_series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Edv5_series", + "Esv5_series", + "Ev5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "Esv3_series", + "Esv4_series", + "Ev3_series", + "Ev4_series", + "F_series", + "Fs_series", + "Fsv2_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "savingsPlanSupportedLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "AustraliaCentral", + "AustraliaCentral2", + "CanadaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorwayEast", + "NorwayWest", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestUs2", + "PolandCentral" + ] + }, + "type": "Microsoft.Migrate/assessmentprojects/{assessmentOptionsName}", + "name": "default", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/assessmentOptions/default", + "systemData": { + "createdBy": "asd", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "tnmop", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..9696871525df --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "AssessmentProjectSummaryOperations_Get", + "operationId": "AssessmentProjectSummaryOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "piyushapp1", + "projectName": "PiyushApp15328project", + "projectSummaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "errorSummaryAffectedEntities": [ + { + "assessmentType": "MachineAssessment", + "count": 1 + }, + { + "assessmentType": "AvsAssessment", + "count": 2 + } + ], + "numberOfPrivateEndpointConnections": 0, + "numberOfGroups": 4, + "numberOfMachines": 4, + "numberOfImportMachines": 0, + "numberOfAssessments": 2, + "lastAssessmentTimestamp": "2023-09-15T07:23:46.901Z" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/piyushapp1/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/projectSummary/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/projectSummary", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..ee2e155990e9 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,50 @@ +{ + "title": "AssessmentProjectSummaryOperations_ListByAssessmentProject", + "operationId": "AssessmentProjectSummaryOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "piyushapp1", + "projectName": "PiyushApp15328project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "errorSummaryAffectedEntities": [ + { + "assessmentType": "MachineAssessment", + "count": 1 + }, + { + "assessmentType": "AvsAssessment", + "count": 2 + } + ], + "numberOfPrivateEndpointConnections": 0, + "numberOfGroups": 4, + "numberOfMachines": 4, + "numberOfImportMachines": 0, + "numberOfAssessments": 2, + "lastAssessmentTimestamp": "2023-09-15T07:23:46.901Z" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/piyushapp1/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/projectSummary/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/projectSummary", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/abcdef" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..58f9bd54652f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,144 @@ +{ + "title": "AssessmentProjectsOperations_Create", + "operationId": "AssessmentProjectsOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "resource": { + "properties": { + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..acd27b03c6a8 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,14 @@ +{ + "title": "AssessmentProjectsOperations_Delete", + "operationId": "AssessmentProjectsOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "A926B99C-7F4C-4556-871E-20CB8C6ADB56", + "resourceGroupName": "rgmigrate", + "projectName": "zqrsyncwahgydqvwuchkfd" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..cc5ab980f796 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,69 @@ +{ + "title": "AssessmentProjectsOperations_Get", + "operationId": "AssessmentProjectsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project" + }, + "responses": { + "200": { + "body": { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..ca1d41e95a05 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "title": "AssessmentProjectsOperations_ListByResourceGroup", + "operationId": "AssessmentProjectsOperations_ListByResourceGroup", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects?api-version=2023-05-01-preview&%24skiptoken=1ZFNboMwEIXv4nWMCT9pihRVKGIXqirAASZ44joIG82YtGqUu9c9Rndv8Unfe3oP4fA7nKybWFQPcWze%2b3N9GrpmqD9EJT5DWLhSagYHBmd0IYGflTAZ%2fax4vfBIdgnWO1bFRWcA6VVmMchC717k6xb2soSizHNd7ndpqgjZrzSiIb8urBgmcF9AaiF%2ftxqJVWtH8uyvIWmtIQiogBmZ%2f9yRuuEY%2bA0WK%2b%2bRjuJDlma5THO5LcVGNHXXD132L9s%2fNwJoro0hNHG37v2ELn5Qn1vx%2fAU%3d" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..a03eb31ea4fa --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,72 @@ +{ + "title": "AssessmentProjectsOperations_ListBySubscription", + "operationId": "AssessmentProjectsOperations_ListBySubscription", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/abcdefg" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Update_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..52c73465808e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Update_MaximumSet_Gen.json @@ -0,0 +1,88 @@ +{ + "title": "AssessmentProjectsOperations_Update", + "operationId": "AssessmentProjectsOperations_Update", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "properties": { + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "properties": { + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..fcdc9440e53d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,236 @@ +{ + "title": "AssessmentsOperations_Create", + "operationId": "AssessmentsOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm1", + "resource": { + "properties": { + "eaSubscriptionId": "kwsu", + "azurePricingTier": "Standard", + "azureStorageRedundancy": "Unknown", + "reservedInstance": "None", + "azureHybridUseBenefit": "Unknown", + "linuxAzureHybridUseBenefit": "Unknown", + "azureDiskTypes": [ + "Premium", + "StandardSSD" + ], + "azureVmFamilies": [ + "D_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "vmUptime": { + "daysPerMonth": 13, + "hoursPerDay": 26 + }, + "groupType": "Default", + "assessmentType": "Unknown", + "azureLocation": "njxbwdtsxzhichsnk", + "azureOfferCode": "Unknown", + "currency": "Unknown", + "scalingFactor": 24, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-09-26T09:36:48.491Z", + "perfDataEndTime": "2023-09-26T09:36:48.491Z", + "stage": "InProgress", + "discountPercentage": 6, + "sizingCriterion": "PerformanceBased", + "status": "Created", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "assessmentErrorSummary": {}, + "monthlyUltraStorageCost": 21, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 547.584, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 44.64, + "description": null + } + ], + "eaSubscriptionId": null, + "azurePricingTier": "Standard", + "azureStorageRedundancy": "LocallyRedundant", + "reservedInstance": "RI3Year", + "azureHybridUseBenefit": "Yes", + "linuxAzureHybridUseBenefit": "Yes", + "azureDiskTypes": [ + "Premium", + "StandardSSD" + ], + "azureVmFamilies": [ + "D_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "monthlyComputeCost": 10, + "monthlyBandwidthCost": 21, + "monthlyStorageCost": 20, + "monthlyPremiumStorageCost": 13, + "monthlyStandardSsdStorageCost": 3, + "suitabilitySummary": { + "suitable": 3 + }, + "numberOfMachines": 3, + "vmUptime": { + "daysPerMonth": 13, + "hoursPerDay": 20 + }, + "distributionBySupportStatus": { + "extended": 3 + }, + "distributionByServicePackInsight": {}, + "distributionByOsName": { + "microsoft Windows Server 2016 or later (64-bit)": 3 + }, + "groupType": "Default", + "assessmentType": "MachineAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 24, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-26T09:36:48.491Z", + "perfDataEndTime": "2023-09-26T09:36:48.491Z", + "stage": "InProgress", + "discountPercentage": 6, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 28, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T09:14:05.7322406Z", + "updatedTimestamp": "2023-09-26T09:14:05.7322406Z", + "status": "Created", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1", + "name": "asm1", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-26T09:36:29.583Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T09:36:29.583Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "assessmentErrorSummary": {}, + "monthlyUltraStorageCost": 21, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 547.584, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 44.64, + "description": null + } + ], + "eaSubscriptionId": null, + "azurePricingTier": "Standard", + "azureStorageRedundancy": "LocallyRedundant", + "reservedInstance": "RI3Year", + "azureHybridUseBenefit": "Yes", + "linuxAzureHybridUseBenefit": "Yes", + "azureDiskTypes": [ + "Premium", + "StandardSSD" + ], + "azureVmFamilies": [ + "D_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "monthlyComputeCost": 10, + "monthlyBandwidthCost": 21, + "monthlyStorageCost": 20, + "monthlyPremiumStorageCost": 13, + "monthlyStandardSsdStorageCost": 3, + "suitabilitySummary": { + "suitable": 3 + }, + "numberOfMachines": 3, + "vmUptime": { + "daysPerMonth": 13, + "hoursPerDay": 20 + }, + "distributionBySupportStatus": { + "extended": 3 + }, + "distributionByServicePackInsight": {}, + "distributionByOsName": { + "microsoft Windows Server 2016 or later (64-bit)": 3 + }, + "groupType": "Default", + "assessmentType": "MachineAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 24, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-26T09:36:48.491Z", + "perfDataEndTime": "2023-09-26T09:36:48.491Z", + "stage": "InProgress", + "discountPercentage": 6, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 28, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T09:14:05.7322406Z", + "updatedTimestamp": "2023-09-26T09:14:05.7322406Z", + "status": "Created", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1", + "name": "asm1", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-26T09:36:29.583Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T09:36:29.583Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..958ef8165c9d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "AssessmentsOperations_Delete", + "operationId": "AssessmentsOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_DownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_DownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..64a23188c49e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_DownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Get download URL for the assessment report.", + "operationId": "AssessmentsOperations_DownloadUrl", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm1", + "body": {} + }, + "responses": { + "200": { + "body": { + "assessmentReportUrl": "uri/uri/uri", + "expirationTime": "2023-09-26T09:36:57.114Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..04f31ac72755 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,103 @@ +{ + "title": "AssessmentsOperations_Get", + "operationId": "AssessmentsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm1" + }, + "responses": { + "200": { + "body": { + "properties": { + "assessmentErrorSummary": {}, + "monthlyUltraStorageCost": 21, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 547.584, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 44.64, + "description": null + } + ], + "eaSubscriptionId": null, + "azurePricingTier": "Standard", + "azureStorageRedundancy": "LocallyRedundant", + "reservedInstance": "RI3Year", + "azureHybridUseBenefit": "Yes", + "linuxAzureHybridUseBenefit": "Yes", + "azureDiskTypes": [ + "Premium", + "StandardSSD" + ], + "azureVmFamilies": [ + "D_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "monthlyComputeCost": 10, + "monthlyBandwidthCost": 21, + "monthlyStorageCost": 20, + "monthlyPremiumStorageCost": 13, + "monthlyStandardSsdStorageCost": 3, + "suitabilitySummary": { + "suitable": 3 + }, + "numberOfMachines": 3, + "vmUptime": { + "daysPerMonth": 13, + "hoursPerDay": 20 + }, + "distributionBySupportStatus": { + "extended": 3 + }, + "distributionByServicePackInsight": {}, + "distributionByOsName": { + "microsoft Windows Server 2016 or later (64-bit)": 3 + }, + "groupType": "Default", + "assessmentType": "MachineAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 24, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-26T09:36:48.491Z", + "perfDataEndTime": "2023-09-26T09:36:48.491Z", + "stage": "InProgress", + "discountPercentage": 6, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 28, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T09:14:05.7322406Z", + "updatedTimestamp": "2023-09-26T09:14:05.7322406Z", + "status": "Created", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1", + "name": "asm1", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-26T09:36:29.583Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T09:36:29.583Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_ListByGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_ListByGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..d0611cc70e56 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_ListByGroup_MaximumSet_Gen.json @@ -0,0 +1,107 @@ +{ + "title": "AssessmentsOperations_ListByGroup", + "operationId": "AssessmentsOperations_ListByGroup", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "assessmentErrorSummary": {}, + "monthlyUltraStorageCost": 21, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 547.584, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 44.64, + "description": null + } + ], + "eaSubscriptionId": null, + "azurePricingTier": "Standard", + "azureStorageRedundancy": "LocallyRedundant", + "reservedInstance": "RI3Year", + "azureHybridUseBenefit": "Yes", + "linuxAzureHybridUseBenefit": "Yes", + "azureDiskTypes": [ + "Premium", + "StandardSSD" + ], + "azureVmFamilies": [ + "D_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "monthlyComputeCost": 10, + "monthlyBandwidthCost": 21, + "monthlyStorageCost": 20, + "monthlyPremiumStorageCost": 13, + "monthlyStandardSsdStorageCost": 3, + "suitabilitySummary": { + "suitable": 3 + }, + "numberOfMachines": 3, + "vmUptime": { + "daysPerMonth": 13, + "hoursPerDay": 20 + }, + "distributionBySupportStatus": { + "extended": 3 + }, + "distributionByServicePackInsight": {}, + "distributionByOsName": { + "microsoft Windows Server 2016 or later (64-bit)": 3 + }, + "groupType": "Default", + "assessmentType": "MachineAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 24, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-26T09:36:48.491Z", + "perfDataEndTime": "2023-09-26T09:36:48.491Z", + "stage": "InProgress", + "discountPercentage": 6, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 28, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T09:14:05.7322406Z", + "updatedTimestamp": "2023-09-26T09:14:05.7322406Z", + "status": "Created", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1", + "name": "asm1", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-26T09:36:29.583Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T09:36:29.583Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessedMachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessedMachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..044fcc80ff5d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessedMachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,81 @@ +{ + "title": "AvsAssessedMachinesOperations_Get", + "operationId": "AvsAssessedMachinesOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2", + "avsAssessedMachineName": "b6d6fc6f-796f-4c16-96af-a6d22e0f12f7" + }, + "responses": { + "200": { + "body": { + "properties": { + "errors": [], + "disks": { + "6000C297-455f-f81e-37b7-dc17da4433d4": { + "name": "6000C297-455f-f81e-37b7-dc17da4433d4", + "displayName": "scsi0:0", + "gigabytesProvisioned": 80.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0, + "assessedExternalStorageType": "AnfPremium", + "estimatedDiskSizeInGB": 14, + "suitabilityDetail": "None" + } + }, + "networkAdapters": { + "4000": { + "macAddress": "00:50:56:95:7a:57", + "ipAddresses": [ + "2404:f801:4800:25:38fe:66de:64e4:5a26", + "10.150.9.214" + ], + "displayName": "VM Network", + "megabytesPerSecondReceived": 0.0, + "megabytesPerSecondTransmitted": 0.0 + } + }, + "storageInUseGB": 0.0, + "suitabilityExplanation": "IpV6NotSupported", + "suitabilityDetail": "None", + "type": "AvsAssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2016 or later (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-26T13:35:59.2324082Z", + "updatedTimestamp": "2023-09-26T13:35:59.2324082Z", + "displayName": "CustomerAE24Feb", + "description": "Microsoft Azure Migration Image on Windows Server 2016", + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app18700site/machines/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3_501505aa-baaa-af9d-8315-5a45209fd255", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app18700site/vcenters/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3", + "datacenterManagementServerName": "idclab-vcen67.fareast.corp.microsoft.com", + "megabytesOfMemory": 32768.0, + "numberOfCores": 8, + "confidenceRatingInPercentage": null, + "percentageCoresUtilization": 0.0, + "percentageMemoryUtilization": 0.0, + "suitability": "ConditionallySuitable" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2/avsAssessedMachines/18895660-c5e5-4247-8cfc-cd24e1fe57f3", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments/avsAssessedMachines", + "name": "18895660-c5e5-4247-8cfc-cd24e1fe57f3", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..9c4d52535114 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen.json @@ -0,0 +1,89 @@ +{ + "title": "AvsAssessedMachinesOperations_ListByAvsAssessment", + "operationId": "AvsAssessedMachinesOperations_ListByAvsAssessment", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2", + "$filter": "ujmwhhuloficljxcjyc", + "pageSize": 6, + "continuationToken": "qwrjeiukbcicfrkqlqsfukfc", + "totalRecordCount": 19 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "errors": [], + "disks": { + "6000C297-455f-f81e-37b7-dc17da4433d4": { + "name": "6000C297-455f-f81e-37b7-dc17da4433d4", + "displayName": "scsi0:0", + "gigabytesProvisioned": 80.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0, + "assessedExternalStorageType": "AnfPremium", + "estimatedDiskSizeInGB": 14, + "suitabilityDetail": "None" + } + }, + "networkAdapters": { + "4000": { + "macAddress": "00:50:56:95:7a:57", + "ipAddresses": [ + "2404:f801:4800:25:38fe:66de:64e4:5a26", + "10.150.9.214" + ], + "displayName": "VM Network", + "megabytesPerSecondReceived": 0.0, + "megabytesPerSecondTransmitted": 0.0 + } + }, + "storageInUseGB": 0.0, + "suitabilityExplanation": "IpV6NotSupported", + "suitabilityDetail": "None", + "type": "AvsAssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2016 or later (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-26T13:35:59.2324082Z", + "updatedTimestamp": "2023-09-26T13:35:59.2324082Z", + "displayName": "CustomerAE24Feb", + "description": "Microsoft Azure Migration Image on Windows Server 2016", + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app18700site/machines/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3_501505aa-baaa-af9d-8315-5a45209fd255", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app18700site/vcenters/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3", + "datacenterManagementServerName": "idclab-vcen67.fareast.corp.microsoft.com", + "megabytesOfMemory": 32768.0, + "numberOfCores": 8, + "confidenceRatingInPercentage": null, + "percentageCoresUtilization": 0.0, + "percentageMemoryUtilization": 0.0, + "suitability": "ConditionallySuitable" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2/avsAssessedMachines/18895660-c5e5-4247-8cfc-cd24e1fe57f3", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments/avsAssessedMachines", + "name": "18895660-c5e5-4247-8cfc-cd24e1fe57f3", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentOptionsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentOptionsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..1d4e5ae2b06e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentOptionsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,184 @@ +{ + "title": "AvsAssessmentOptionsOperations_Get", + "operationId": "AvsAssessmentOptionsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "avsAssessmentOptionsName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "avsNodes": [ + { + "nodeType": "AV36", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral" + ] + }, + { + "nodeType": "AV36P", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "UkSouth", + "NorthCentralUs", + "EastUs", + "WestUs2", + "SouthCentralUs", + "EastUs2", + "WestUs", + "QatarCentral", + "WestEurope" + ] + }, + { + "nodeType": "AV52", + "targetLocations": [ + "WestEurope", + "UkSouth", + "EastUs2" + ] + } + ], + "avsExternalStorageTypes": [ + { + "storageType": "AnfStandard", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral" + ] + }, + { + "storageType": "AnfPremium", + "targetLocations": [ + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral" + ] + } + ], + "failuresToTolerateAndRaidLevelValues": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt2Raid1", + "Ftt2Raid6", + "Ftt3Raid1" + ], + "reservedInstanceAvsNodes": [ + "AV36", + "AV36P", + "AV52" + ], + "reservedInstanceSupportedLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral", + "WestUs2", + "QatarCentral" + ], + "reservedInstanceSupportedCurrencies": [ + "USD", + "DKK", + "CAD", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SEK", + "GBP", + "INR", + "BRL", + "TWD", + "EUR", + "CHF", + "AUD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P" + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/avsAssessmentOptions/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/{assessmentOptionsName}", + "systemData": { + "createdBy": "asd", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "tnmop", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..d6d5f7e75d2c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,188 @@ +{ + "title": "AvsAssessmentOptionsOperations_ListByAssessmentProject", + "operationId": "AvsAssessmentOptionsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "avsNodes": [ + { + "nodeType": "AV36", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral" + ] + }, + { + "nodeType": "AV36P", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "UkSouth", + "NorthCentralUs", + "EastUs", + "WestUs2", + "SouthCentralUs", + "EastUs2", + "WestUs", + "QatarCentral", + "WestEurope" + ] + }, + { + "nodeType": "AV52", + "targetLocations": [ + "WestEurope", + "UkSouth", + "EastUs2" + ] + } + ], + "avsExternalStorageTypes": [ + { + "storageType": "AnfStandard", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral" + ] + }, + { + "storageType": "AnfPremium", + "targetLocations": [ + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral" + ] + } + ], + "failuresToTolerateAndRaidLevelValues": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt2Raid1", + "Ftt2Raid6", + "Ftt3Raid1" + ], + "reservedInstanceAvsNodes": [ + "AV36", + "AV36P", + "AV52" + ], + "reservedInstanceSupportedLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral", + "WestUs2", + "QatarCentral" + ], + "reservedInstanceSupportedCurrencies": [ + "USD", + "DKK", + "CAD", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SEK", + "GBP", + "INR", + "BRL", + "TWD", + "EUR", + "CHF", + "AUD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P" + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/avsAssessmentOptions/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/{assessmentOptionsName}", + "systemData": { + "createdBy": "asd", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "tnmop", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..8443a2476cc4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,326 @@ +{ + "title": "AvsAssessmentsOperations_Create", + "operationId": "AvsAssessmentsOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2", + "resource": { + "properties": { + "failuresToTolerateAndRaidLevel": "Unknown", + "failuresToTolerateAndRaidLevelList": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt3Raid1" + ], + "vcpuOversubscription": 4.0, + "nodeType": "Unknown", + "nodeTypes": [ + "AV36", + "AV52", + "AV36P", + "AV64" + ], + "avsAssessmentScenario": "NewAvsSddc", + "externalStorageTypes": [ + "AnfStandard", + "AnfPremium", + "AnfUltra" + ], + "isVcfByolEnabled": true, + "reservedInstance": "RI3Year", + "suitability": "Unknown", + "suitabilityExplanation": "Unknown", + "memOvercommit": 1.0, + "dedupeCompression": 1.5, + "isStretchClusterEnabled": true, + "groupType": "Default", + "assessmentType": "AvsAssessment", + "azureLocation": "EastUs", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-25T13:35:56.5671462Z", + "perfDataEndTime": "2023-09-26T13:35:56.5671462Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "AsOnPremises", + "status": "Created", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "failuresToTolerateAndRaidLevel": "Unknown", + "failuresToTolerateAndRaidLevelList": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt3Raid1" + ], + "vcpuOversubscription": 4.0, + "nodeType": "Unknown", + "nodeTypes": [ + "AV36", + "AV36P", + "AV52" + ], + "avsAssessmentScenario": "NewAvsSddc", + "externalStorageTypes": [ + "AnfStandard", + "AnfPremium", + "AnfUltra" + ], + "isVcfByolEnabled": true, + "costComponents": [ + { + "name": "MonthlyAvsNodeCost", + "value": 9088.5, + "description": "Monthly Cost of AVS Nodes." + }, + { + "name": "MonthlyAvsExternalStorageCost", + "value": 600.0, + "description": "Monthly AVS External Storage Cost for Assessment." + }, + { + "name": "MonthlyAvsNetworkCost", + "value": 120, + "description": "Monthly AVS Cost of Network." + }, + { + "name": "MonthlyVcfByolCostDifference", + "value": 7088.5, + "description": "Monthly compute cost difference between VCF BYOL and non VCF BYOL SKUs" + } + ], + "reservedInstance": "RI3Year", + "totalMonthlyCost": 9808.5, + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "numberOfNodes": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 77.43, + "totalCpuCores": 108.0, + "totalRamInGB": 1728.0, + "totalStorageInGB": 48128.0, + "numberOfMachines": 3, + "avsEstimatedNodes": [ + { + "monthlyPrice": 9088.5, + "nodeType": "AV36", + "nodeNumber": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 76.99, + "totalCpu": 108.0, + "totalRam": 1728.0, + "totalStorage": 46080.0, + "pricingModel": "RI3Year", + "fttRaidLevel": "Ftt1Raid1" + } + ], + "avsEstimatedExternalStorages": [ + { + "monthlyPrice": 250.0, + "storageType": "AnfStandard", + "totalStorageInGB": 1024.0, + "storageUtilization": 97.0 + }, + { + "monthlyPrice": 350.0, + "storageType": "AnfPremium", + "totalStorageInGB": 1024.0, + "storageUtilization": 78.0 + } + ], + "avsEstimatedNetworks": [ + { + "monthlyPrice": 120, + "networkType": "ExpressRouteUltra" + } + ], + "suitabilitySummary": { + "conditionallySuitable": 3 + }, + "memOvercommit": 1.0, + "dedupeCompression": 1.5, + "limitingFactor": "Storage", + "assessmentErrorSummary": {}, + "isStretchClusterEnabled": false, + "groupType": "Default", + "assessmentType": "AvsAssessment", + "azureLocation": "EastUs", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-25T13:35:56.5671462Z", + "perfDataEndTime": "2023-09-26T13:35:56.5671462Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "AsOnPremises", + "confidenceRatingInPercentage": 100.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T13:35:56.5983656Z", + "updatedTimestamp": "2023-09-26T13:36:01.1699411Z", + "status": "Completed", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2", + "name": "asm2", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "failuresToTolerateAndRaidLevel": "Unknown", + "failuresToTolerateAndRaidLevelList": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt3Raid1" + ], + "vcpuOversubscription": 4.0, + "nodeType": "Unknown", + "avsAssessmentScenario": "NewAvsSddc", + "nodeTypes": [ + "AV36", + "AV52", + "AV36P" + ], + "externalStorageTypes": [ + "AnfStandard", + "AnfPremium", + "AnfUltra" + ], + "isVcfByolEnabled": true, + "costComponents": [ + { + "name": "MonthlyAvsNodeCost", + "value": 9088.5, + "description": "Monthly Cost of AVS Nodes." + }, + { + "name": "MonthlyExternalStorageCost", + "value": 600.0, + "description": "Monthly External Storage Cost for Assessment." + }, + { + "name": "MonthlyNetworkCost", + "value": 120, + "description": "Monthly Cost of Network." + } + ], + "reservedInstance": "RI3Year", + "totalMonthlyCost": 9808.5, + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "numberOfNodes": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 77.43, + "totalCpuCores": 108.0, + "totalRamInGB": 1728.0, + "totalStorageInGB": 48128.0, + "numberOfMachines": 3, + "avsEstimatedNodes": [ + { + "monthlyPrice": 9088.5, + "nodeType": "AV36", + "nodeNumber": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 76.99, + "totalCpu": 108.0, + "totalRam": 1728.0, + "totalStorage": 46080.0, + "pricingModel": "RI3Year", + "fttRaidLevel": "Ftt1Raid1" + } + ], + "avsEstimatedExternalStorages": [ + { + "monthlyPrice": 250.0, + "storageType": "AnfStandard", + "totalStorageInGB": 1024.0, + "storageUtilization": 97.0 + }, + { + "monthlyPrice": 350.0, + "storageType": "AnfPremium", + "totalStorageInGB": 1024.0, + "storageUtilization": 78.0 + } + ], + "avsEstimatedNetworks": [ + { + "monthlyPrice": 120, + "networkType": "ExpressRouteUltra" + } + ], + "suitabilitySummary": { + "conditionallySuitable": 3 + }, + "memOvercommit": 1.0, + "dedupeCompression": 1.5, + "limitingFactor": "Storage", + "assessmentErrorSummary": {}, + "isStretchClusterEnabled": false, + "groupType": "Default", + "assessmentType": "AvsAssessment", + "azureLocation": "EastUs", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-25T13:35:56.5671462Z", + "perfDataEndTime": "2023-09-26T13:35:56.5671462Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "AsOnPremises", + "confidenceRatingInPercentage": 100.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T13:35:56.5983656Z", + "updatedTimestamp": "2023-09-26T13:36:01.1699411Z", + "status": "Completed", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2", + "name": "asm2", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..376b0f0cf896 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "AvsAssessmentsOperations_Delete", + "operationId": "AvsAssessmentsOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..d0832a337560 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Get download URL for the assessment report.", + "operationId": "AvsAssessmentsOperations_DownloadUrl", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2", + "body": {} + }, + "responses": { + "200": { + "body": { + "assessmentReportUrl": "fagqmlysjfwtt", + "expirationTime": "2023-09-15T07:22:40.818Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..220145e6ff94 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,148 @@ +{ + "title": "AvsAssessmentsOperations_Get", + "operationId": "AvsAssessmentsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2" + }, + "responses": { + "200": { + "body": { + "properties": { + "failuresToTolerateAndRaidLevel": "Unknown", + "failuresToTolerateAndRaidLevelList": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt3Raid1" + ], + "vcpuOversubscription": 4.0, + "nodeType": "Unknown", + "avsAssessmentScenario": "NewAvsSddc", + "nodeTypes": [ + "AV36", + "AV36P", + "AV52" + ], + "externalStorageTypes": [ + "AnfStandard", + "AnfPremium", + "AnfUltra" + ], + "isVcfByolEnabled": true, + "costComponents": [ + { + "name": "MonthlyAvsNodeCost", + "value": 9088.5, + "description": "Monthly Cost of AVS Nodes." + }, + { + "name": "MonthlyAvsExternalStorageCost", + "value": 600.0, + "description": "Monthly AVS External Storage Cost for Assessment." + }, + { + "name": "MonthlyAvsNetworkCost", + "value": 120, + "description": "Monthly AVS Cost of Network." + }, + { + "name": "MonthlyVcfByolCostDifference", + "value": 7088.5, + "description": "Monthly compute cost difference between VCF BYOL and non VCF BYOL SKUs" + } + ], + "reservedInstance": "RI3Year", + "totalMonthlyCost": 9808.5, + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "numberOfNodes": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 77.43, + "totalCpuCores": 108.0, + "totalRamInGB": 1728.0, + "totalStorageInGB": 48128.0, + "numberOfMachines": 3, + "avsEstimatedNodes": [ + { + "monthlyPrice": 9088.5, + "nodeType": "AV36", + "nodeNumber": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 76.99, + "totalCpu": 108.0, + "totalRam": 1728.0, + "totalStorage": 46080.0, + "pricingModel": "RI3Year", + "fttRaidLevel": "Ftt1Raid1" + } + ], + "avsEstimatedExternalStorages": [ + { + "monthlyPrice": 250.0, + "storageType": "AnfStandard", + "totalStorageInGB": 1024.0, + "storageUtilization": 97.0 + }, + { + "monthlyPrice": 350.0, + "storageType": "AnfPremium", + "totalStorageInGB": 1024.0, + "storageUtilization": 78.0 + } + ], + "avsEstimatedNetworks": [ + { + "monthlyPrice": 120, + "networkType": "ExpressRouteUltra" + } + ], + "suitabilitySummary": { + "conditionallySuitable": 3 + }, + "memOvercommit": 1.0, + "dedupeCompression": 1.5, + "limitingFactor": "Storage", + "assessmentErrorSummary": {}, + "isStretchClusterEnabled": false, + "groupType": "Default", + "assessmentType": "AvsAssessment", + "azureLocation": "EastUs", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-25T13:35:56.5671462Z", + "perfDataEndTime": "2023-09-26T13:35:56.5671462Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "AsOnPremises", + "confidenceRatingInPercentage": 100.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T13:35:56.5983656Z", + "updatedTimestamp": "2023-09-26T13:36:01.1699411Z", + "status": "Completed", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2", + "name": "asm2", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments", + "systemData": { + "createdBy": "sjghfaivpyryuvovuvcqegaorvhp", + "createdByType": "User", + "createdAt": "2024-02-15T18:24:02.548Z", + "lastModifiedBy": "fjkmzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-15T18:24:02.548Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..2914243e803b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen.json @@ -0,0 +1,152 @@ +{ + "title": "AvsAssessmentsOperations_ListByGroup", + "operationId": "AvsAssessmentsOperations_ListByGroup", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "failuresToTolerateAndRaidLevel": "Unknown", + "failuresToTolerateAndRaidLevelList": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt3Raid1" + ], + "vcpuOversubscription": 4.0, + "nodeType": "Unknown", + "avsAssessmentScenario": "NewAvsSddc", + "nodeTypes": [ + "AV36", + "AV36P", + "AV52" + ], + "externalStorageTypes": [ + "AnfStandard", + "AnfPremium", + "AnfUltra" + ], + "isVcfByolEnabled": true, + "costComponents": [ + { + "name": "MonthlyAvsNodeCost", + "value": 9088.5, + "description": "Monthly Cost of AVS Nodes." + }, + { + "name": "MonthlyAvsExternalStorageCost", + "value": 600.0, + "description": "Monthly AVS External Storage Cost for Assessment." + }, + { + "name": "MonthlyAvsNetworkCost", + "value": 120, + "description": "Monthly AVS Cost of Network." + }, + { + "name": "MonthlyVcfByolCostDifference", + "value": 7088.5, + "description": "Monthly compute cost difference between VCF BYOL and non VCF BYOL SKUs" + } + ], + "reservedInstance": "RI3Year", + "totalMonthlyCost": 9808.5, + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "numberOfNodes": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 77.43, + "totalCpuCores": 108.0, + "totalRamInGB": 1728.0, + "totalStorageInGB": 48128.0, + "numberOfMachines": 3, + "avsEstimatedNodes": [ + { + "monthlyPrice": 9088.5, + "nodeType": "AV36", + "nodeNumber": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 76.99, + "totalCpu": 108.0, + "totalRam": 1728.0, + "totalStorage": 46080.0, + "pricingModel": "RI3Year", + "fttRaidLevel": "Ftt1Raid1" + } + ], + "avsEstimatedExternalStorages": [ + { + "monthlyPrice": 250.0, + "storageType": "AnfStandard", + "totalStorageInGB": 1024.0, + "storageUtilization": 97.0 + }, + { + "monthlyPrice": 350.0, + "storageType": "AnfPremium", + "totalStorageInGB": 1024.0, + "storageUtilization": 78.0 + } + ], + "avsEstimatedNetworks": [ + { + "monthlyPrice": 120, + "networkType": "ExpressRouteUltra" + } + ], + "suitabilitySummary": { + "conditionallySuitable": 3 + }, + "memOvercommit": 1.0, + "dedupeCompression": 1.5, + "limitingFactor": "Storage", + "assessmentErrorSummary": {}, + "isStretchClusterEnabled": false, + "groupType": "Default", + "assessmentType": "AvsAssessment", + "azureLocation": "EastUs", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-25T13:35:56.5671462Z", + "perfDataEndTime": "2023-09-26T13:35:56.5671462Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "AsOnPremises", + "confidenceRatingInPercentage": 100.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T13:35:56.5983656Z", + "updatedTimestamp": "2023-09-26T13:36:01.1699411Z", + "status": "Completed", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2", + "name": "asm2", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments", + "systemData": { + "createdBy": "sjghfaivpyryuvovuvcqegaorvhp", + "createdByType": "User", + "createdAt": "2024-02-15T18:24:02.548Z", + "lastModifiedBy": "fjkmzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-15T18:24:02.548Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..893a17d43ac3 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,269 @@ +{ + "title": "BusinessCaseAvsSummaryOperations_Get", + "operationId": "BusinessCaseAvsSummaryOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "avsSummaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "azureAvsSummary": { + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0 + }, + "avsNodeSummary": { + "serversSuitableForMigration": 28, + "totalNumberOfServers": 4, + "cores": 17, + "memoryGb": 19, + "avsNodeCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "linuxAhubSavings": 18, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "estimatedCost": 29, + "osLicensingCost": 18, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedAvsNodeTypeSummary": [ + { + "avsNodeType": "AV36", + "numberOfNodes": 16, + "failuresToTolerateAndRaidLevel": "Ftt1Raid1" + } + ], + "estimatedExternalStorage": [ + { + "storageType": "AnfStandard", + "totalStorageInGB": 1024.0, + "storageUtilization": 97.0, + "totalStorageCost": 250 + }, + { + "storageType": "AnfPremium", + "totalStorageInGB": 1024.0, + "storageUtilization": 99.0, + "totalStorageCost": 350 + } + ], + "estimatedNetwork": [ + { + "skuType": "ExpressRouteUltra", + "cost": 200 + } + ], + "estimatedCostWithVcfByol": 24.0 + }, + "avsCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "linuxAhubSavings": 18, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + } + }, + "onPremisesAvsSummary": { + "servers": 29, + "cores": 26, + "memoryGb": 4, + "cpuUtilization": 24, + "memoryUtilization": 10, + "storageUtilization": 26, + "onPremisesIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesIaasCostForDecommissioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "osLicensingDetails": [ + { + "osType": "Windows", + "totalCost": 11, + "decomissionCost": 29 + } + ], + "distributionByOperatingSystem": [ + { + "osClassificationType": "WindowsOSInSupport", + "count": 4 + } + ], + "onPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionByVirtualization": [ + { + "virtualizationType": "Vmware", + "count": 30 + } + ], + "iaasOsSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "iaasSqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "distributionByOperatingSystemVersion": [ + { + "type": "Microsoft Windows Server 2016 Datacenter", + "count": 27 + } + ], + "distributionBySqlVersion": [ + { + "type": "SQL Server 2012", + "count": 27 + } + ], + "distributionBySqlEdition": [ + { + "type": "Enterprise Evaluation Edition", + "count": 27 + } + ] + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/avsSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/avsSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..db75126ff536 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,273 @@ +{ + "title": "BusinessCaseAvsSummaryOperations_ListByBusinessCase", + "operationId": "BusinessCaseAvsSummaryOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "azureAvsSummary": { + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0 + }, + "avsNodeSummary": { + "serversSuitableForMigration": 28, + "totalNumberOfServers": 4, + "cores": 17, + "memoryGb": 19, + "avsNodeCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "linuxAhubSavings": 18, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "estimatedCost": 29, + "osLicensingCost": 18, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedAvsNodeTypeSummary": [ + { + "avsNodeType": "AV36", + "numberOfNodes": 16, + "failuresToTolerateAndRaidLevel": "Ftt1Raid1" + } + ], + "estimatedExternalStorage": [ + { + "storageType": "AnfStandard", + "totalStorageInGB": 1024.0, + "storageUtilization": 97.0, + "totalStorageCost": 250 + }, + { + "storageType": "AnfPremium", + "totalStorageInGB": 1024.0, + "storageUtilization": 99.0, + "totalStorageCost": 350 + } + ], + "estimatedNetwork": [ + { + "skuType": "ExpressRouteUltra", + "cost": 200 + } + ], + "estimatedCostWithVcfByol": 24.0 + }, + "avsCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "linuxAhubSavings": 18, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + } + }, + "onPremisesAvsSummary": { + "servers": 29, + "cores": 26, + "memoryGb": 4, + "cpuUtilization": 24, + "memoryUtilization": 10, + "storageUtilization": 26, + "onPremisesIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesIaasCostForDecommissioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "osLicensingDetails": [ + { + "osType": "Windows", + "totalCost": 11, + "decomissionCost": 29 + } + ], + "distributionByOperatingSystem": [ + { + "osClassificationType": "WindowsOSInSupport", + "count": 4 + } + ], + "onPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionByVirtualization": [ + { + "virtualizationType": "Vmware", + "count": 30 + } + ], + "iaasOsSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "iaasSqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "distributionByOperatingSystemVersion": [ + { + "type": "Microsoft Windows Server 2016 Datacenter", + "count": 27 + } + ], + "distributionBySqlVersion": [ + { + "type": "SQL Server 2012", + "count": 27 + } + ], + "distributionBySqlEdition": [ + { + "type": "Enterprise Evaluation Edition", + "count": 27 + } + ] + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/avsSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/avsSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..1d7482a205d5 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,291 @@ +{ + "title": "BusinessCaseIaasSummaryOperations_Get", + "operationId": "BusinessCaseIaasSummaryOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "iaasSummaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "azureIaasSummary": { + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0 + }, + "azureIaasVmSummary": { + "serversSuitableForMigration": 15, + "totalNumberOfServers": 27, + "cores": 6, + "memoryGb": 26, + "azureVmCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "estimatedCost": 19, + "osLicensingCost": 12, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedVmFamilySummary": [ + { + "azureVmFamily": "Standard_F4", + "numberOfMachines": 26 + } + ], + "costByStorageType": [ + { + "storageType": "StandardSsd", + "cost": 12 + } + ] + }, + "azureIaasSqlSummary": { + "totalSqlEntities": 7, + "suitableSqlEntities": 21, + "azureSqlCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "estimatedCost": 23, + "osLicensingCost": 8, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedVmFamilySummary": [ + { + "azureVmFamily": "Standard_F4", + "numberOfMachines": 26 + } + ], + "costByStorageType": [ + { + "storageType": "StandardSsd", + "cost": 12 + } + ] + }, + "azureIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + } + }, + "onPremisesIaasSummary": { + "servers": 29, + "cores": 26, + "memoryGb": 4, + "cpuUtilization": 24, + "memoryUtilization": 10, + "storageUtilization": 26, + "onPremisesIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesIaasCostForDecommissioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "osLicensingDetails": [ + { + "osType": "Windows", + "totalCost": 11, + "decomissionCost": 29 + } + ], + "distributionByOperatingSystem": [ + { + "osClassificationType": "LinuxOSInSupport", + "count": 4 + } + ], + "onPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionByVirtualization": [ + { + "virtualizationType": "Vmware", + "count": 30 + } + ], + "iaasOsSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "iaasSqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "distributionByOperatingSystemVersion": [ + { + "type": "Ubuntu", + "count": 27 + } + ], + "distributionBySqlVersion": [ + { + "type": "SQL Server 2012", + "count": 27 + } + ], + "distributionBySqlEdition": [ + { + "type": "Enterprise Evaluation Edition", + "count": 27 + } + ] + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/iaasSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/iaasSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..c17c6c692c91 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,295 @@ +{ + "title": "BusinessCaseIaasSummaryOperations_ListByBusinessCase", + "operationId": "BusinessCaseIaasSummaryOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "azureIaasSummary": { + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0 + }, + "azureIaasVmSummary": { + "serversSuitableForMigration": 15, + "totalNumberOfServers": 27, + "cores": 6, + "memoryGb": 26, + "azureVmCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "estimatedCost": 19, + "osLicensingCost": 12, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedVmFamilySummary": [ + { + "azureVmFamily": "Standard_F4", + "numberOfMachines": 26 + } + ], + "costByStorageType": [ + { + "storageType": "StandardSsd", + "cost": 12 + } + ] + }, + "azureIaasSqlSummary": { + "totalSqlEntities": 7, + "suitableSqlEntities": 21, + "azureSqlCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "estimatedCost": 23, + "osLicensingCost": 8, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedVmFamilySummary": [ + { + "azureVmFamily": "Standard_F4", + "numberOfMachines": 26 + } + ], + "costByStorageType": [ + { + "storageType": "StandardSsd", + "cost": 12 + } + ] + }, + "azureIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + } + }, + "onPremisesIaasSummary": { + "servers": 29, + "cores": 26, + "memoryGb": 4, + "cpuUtilization": 24, + "memoryUtilization": 10, + "storageUtilization": 26, + "onPremisesIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesIaasCostForDecommissioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "osLicensingDetails": [ + { + "osType": "Windows", + "totalCost": 11, + "decomissionCost": 29 + } + ], + "distributionByOperatingSystem": [ + { + "osClassificationType": "LinuxOSInSupport", + "count": 4 + } + ], + "onPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionByVirtualization": [ + { + "virtualizationType": "Vmware", + "count": 30 + } + ], + "iaasOsSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "iaasSqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "distributionByOperatingSystemVersion": [ + { + "type": "Ubuntu", + "count": 27 + } + ], + "distributionBySqlVersion": [ + { + "type": "SQL Server 2012", + "count": 27 + } + ], + "distributionBySqlEdition": [ + { + "type": "Enterprise Evaluation Edition", + "count": 27 + } + ] + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/iaasSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/iaasSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_CompareSummary_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_CompareSummary_MaximumSet_Gen.json new file mode 100644 index 000000000000..e3f35a21e286 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_CompareSummary_MaximumSet_Gen.json @@ -0,0 +1,185 @@ +{ + "title": "Get Compare summary report for Business case.", + "operationId": "BusinessCaseOperations_CompareSummary", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "body": {} + }, + "responses": { + "200": { + "body": { + "azurePaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "azureIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "azureAvsCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesPaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesAvsCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesPaasDecommissionedCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesIaasDecommissionedCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesAvsDecommissionedCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..86c849d71731 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,410 @@ +{ + "title": "BusinessCaseOperations_Create", + "operationId": "BusinessCaseOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "resource": { + "properties": { + "settings": { + "azureSettings": { + "targetLocation": "WestUs2", + "discountPercentage": 83, + "currency": "USD", + "businessCaseType": "OptimizeForCost", + "workloadDiscoverySource": "Appliance", + "performanceDataStartTime": "2023-11-08T07:10:07.764Z", + "performanceDataEndTime": "2023-11-08T07:10:07.764Z", + "comfortFactor": 29, + "performanceUtilizationPercentile": 4, + "perYearMigrationCompletionPercentage": { + "Year0": 20, + "Year1": 30, + "Year2": 60, + "Year3": 90 + }, + "infrastructureGrowthRate": 83, + "wacc": 79, + "networkCostPercentage": 40, + "iaasLaborCostPercentage": 94, + "paasLaborCostPercentage": 47, + "avsLaborCostPercentage": 0, + "savingsOption": "RI3Year" + }, + "onPremiseSettings": { + "computeSettings": { + "hyperthreadCoreToMemoryRatio": 12, + "price": 16, + "sqlServerLicensing": [ + { + "version": "Enterprise", + "licenseCost": 27, + "softwareAssuranceCost": 16 + } + ], + "windowsServerLicensing": { + "licenseCost": 9, + "softwareAssuranceCost": 1, + "licensesPerCore": 11 + }, + "rhelLinuxServerLicensing": { + "licenseCost": 9 + }, + "suseLinuxServerLicensing": { + "licenseCost": 9 + }, + "virtualizationSoftwareSettings": { + "numberOfPhysicalCoresPerLicense": 17, + "softwareAssuranceCost": 14, + "licenseAndSupportList": [ + { + "licenseType": "VSphereStandard", + "licenseCost": 8, + "basicSupportCost": 22, + "productionSupportCost": 22 + } + ] + } + }, + "storageSettings": { + "costPerGbPerMonth": 22, + "maintainanceCostPercentageToAcquisitionCost": 1 + }, + "networkSettings": { + "hardwareSoftwareCostPercentage": 50, + "maintenanceCostPercentage": 48 + }, + "facilitySettings": { + "facilitiesCost": 7 + }, + "laborSettings": { + "physicalServersPerAdmin": 6, + "virtualMachinesPerAdmin": 24, + "hourlyAdminCost": 25 + }, + "securitySettings": { + "serverSecurityCostPerServerPerYear": 14, + "sqlServerSecurityCostPerServerPerYear": 7 + }, + "managementSettings": { + "hypervVirtualizationManagementSettings": { + "numberOfPhysicalCoresPerLicense": 2, + "softwareAssuranceCost": 11, + "licenseAndSupportList": [ + { + "licenseCost": 4, + "licenseType": "Standard" + } + ] + }, + "vsphereManagementSettings": { + "licenseAndSupportList": [ + { + "licenseType": "VSphereServerStandard", + "licenseCost": 6, + "basicSupportCost": 1, + "productionSupportCost": 18 + } + ] + }, + "thirdPartyManagementSettings": { + "licenseCost": 23, + "supportCost": 9 + }, + "otherManagementCostsSettings": { + "monitoringCostPerServerPerYear": 10, + "patchingCostPerServerPerYear": 18, + "dataProtectionCostPerServerPerYear": 18 + } + } + } + }, + "state": "InProgress" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "settings": { + "azureSettings": { + "targetLocation": "WestUs2", + "discountPercentage": 83, + "currency": "USD", + "businessCaseType": "OptimizeForCost", + "workloadDiscoverySource": "Appliance", + "performanceDataStartTime": "2023-11-08T07:10:07.764Z", + "performanceDataEndTime": "2023-11-08T07:10:07.764Z", + "comfortFactor": 29, + "performanceUtilizationPercentile": 4, + "perYearMigrationCompletionPercentage": { + "Year0": 20, + "Year1": 30, + "Year2": 60, + "Year3": 90 + }, + "infrastructureGrowthRate": 83, + "wacc": 79, + "networkCostPercentage": 40, + "iaasLaborCostPercentage": 94, + "paasLaborCostPercentage": 47, + "avsLaborCostPercentage": 0, + "savingsOption": "RI3Year" + }, + "onPremiseSettings": { + "computeSettings": { + "hyperthreadCoreToMemoryRatio": 12, + "price": 16, + "sqlServerLicensing": [ + { + "version": "Enterprise", + "licenseCost": 27, + "softwareAssuranceCost": 16 + } + ], + "windowsServerLicensing": { + "licenseCost": 9, + "softwareAssuranceCost": 1, + "licensesPerCore": 11 + }, + "rhelLinuxServerLicensing": { + "licenseCost": 9 + }, + "suseLinuxServerLicensing": { + "licenseCost": 9 + }, + "virtualizationSoftwareSettings": { + "numberOfPhysicalCoresPerLicense": 17, + "softwareAssuranceCost": 14, + "licenseAndSupportList": [ + { + "licenseType": "VSphereStandard", + "licenseCost": 8, + "basicSupportCost": 22, + "productionSupportCost": 22 + } + ] + } + }, + "storageSettings": { + "costPerGbPerMonth": 22, + "maintainanceCostPercentageToAcquisitionCost": 1 + }, + "networkSettings": { + "hardwareSoftwareCostPercentage": 50, + "maintenanceCostPercentage": 48 + }, + "facilitySettings": { + "facilitiesCost": 7 + }, + "laborSettings": { + "physicalServersPerAdmin": 6, + "virtualMachinesPerAdmin": 24, + "hourlyAdminCost": 25 + }, + "securitySettings": { + "serverSecurityCostPerServerPerYear": 14, + "sqlServerSecurityCostPerServerPerYear": 7 + }, + "managementSettings": { + "hypervVirtualizationManagementSettings": { + "numberOfPhysicalCoresPerLicense": 2, + "softwareAssuranceCost": 11, + "licenseAndSupportList": [ + { + "licenseCost": 4, + "licenseType": "Standard" + } + ] + }, + "vsphereManagementSettings": { + "licenseAndSupportList": [ + { + "licenseType": "VSphereServerStandard", + "licenseCost": 6, + "basicSupportCost": 1, + "productionSupportCost": 18 + } + ] + }, + "thirdPartyManagementSettings": { + "licenseCost": 23, + "supportCost": 9 + }, + "otherManagementCostsSettings": { + "monitoringCostPerServerPerYear": 10, + "patchingCostPerServerPerYear": 18, + "dataProtectionCostPerServerPerYear": 18 + } + } + } + }, + "state": "Completed", + "reportStatusDetails": [ + { + "reportType": "Excel", + "reportStatus": "Completed" + } + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case", + "name": "sample-business-case", + "type": "Microsoft.Migrate/assessmentProjects/businessCases", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "settings": { + "azureSettings": { + "targetLocation": "WestUs2", + "discountPercentage": 83, + "currency": "USD", + "businessCaseType": "OptimizeForCost", + "workloadDiscoverySource": "Appliance", + "performanceDataStartTime": "2023-11-08T07:10:07.764Z", + "performanceDataEndTime": "2023-11-08T07:10:07.764Z", + "comfortFactor": 29, + "performanceUtilizationPercentile": 4, + "perYearMigrationCompletionPercentage": { + "Year0": 20, + "Year1": 30, + "Year2": 60, + "Year3": 90 + }, + "infrastructureGrowthRate": 83, + "wacc": 79, + "networkCostPercentage": 40, + "iaasLaborCostPercentage": 94, + "paasLaborCostPercentage": 47, + "avsLaborCostPercentage": 0, + "savingsOption": "RI3Year" + }, + "onPremiseSettings": { + "computeSettings": { + "hyperthreadCoreToMemoryRatio": 12, + "price": 16, + "sqlServerLicensing": [ + { + "version": "Enterprise", + "licenseCost": 27, + "softwareAssuranceCost": 16 + } + ], + "windowsServerLicensing": { + "licenseCost": 9, + "softwareAssuranceCost": 1, + "licensesPerCore": 11 + }, + "rhelLinuxServerLicensing": { + "licenseCost": 9 + }, + "suseLinuxServerLicensing": { + "licenseCost": 9 + }, + "virtualizationSoftwareSettings": { + "numberOfPhysicalCoresPerLicense": 17, + "softwareAssuranceCost": 14, + "licenseAndSupportList": [ + { + "licenseType": "VSphereStandard", + "licenseCost": 8, + "basicSupportCost": 22, + "productionSupportCost": 22 + } + ] + } + }, + "storageSettings": { + "costPerGbPerMonth": 22, + "maintainanceCostPercentageToAcquisitionCost": 1 + }, + "networkSettings": { + "hardwareSoftwareCostPercentage": 50, + "maintenanceCostPercentage": 48 + }, + "facilitySettings": { + "facilitiesCost": 7 + }, + "laborSettings": { + "physicalServersPerAdmin": 6, + "virtualMachinesPerAdmin": 24, + "hourlyAdminCost": 25 + }, + "securitySettings": { + "serverSecurityCostPerServerPerYear": 14, + "sqlServerSecurityCostPerServerPerYear": 7 + }, + "managementSettings": { + "hypervVirtualizationManagementSettings": { + "numberOfPhysicalCoresPerLicense": 2, + "softwareAssuranceCost": 11, + "licenseAndSupportList": [ + { + "licenseCost": 4, + "licenseType": "Standard" + } + ] + }, + "vsphereManagementSettings": { + "licenseAndSupportList": [ + { + "licenseType": "VSphereServerStandard", + "licenseCost": 6, + "basicSupportCost": 1, + "productionSupportCost": 18 + } + ] + }, + "thirdPartyManagementSettings": { + "licenseCost": 23, + "supportCost": 9 + }, + "otherManagementCostsSettings": { + "monitoringCostPerServerPerYear": 10, + "patchingCostPerServerPerYear": 18, + "dataProtectionCostPerServerPerYear": 18 + } + } + } + }, + "state": "Completed", + "reportStatusDetails": [ + { + "reportType": "Excel", + "reportStatus": "Completed" + } + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case", + "name": "sample-business-case", + "type": "Microsoft.Migrate/assessmentProjects/businessCases", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..02c258c77124 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "BusinessCaseOperations_Delete", + "operationId": "BusinessCaseOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..215c3249743e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "title": "Get download URL for the business case report.", + "operationId": "BusinessCaseOperations_GetReportDownloadUrl", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "body": {} + }, + "responses": { + "200": { + "body": { + "businessCaseReportUrl": "mxwaejake", + "expirationTime": "2023-11-08T07:10:20.491Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..0cc302e6c3df --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,151 @@ +{ + "title": "BusinessCaseOperations_Get", + "operationId": "BusinessCaseOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "properties": { + "settings": { + "azureSettings": { + "targetLocation": "WestUs2", + "discountPercentage": 52, + "currency": "USD", + "businessCaseType": "OptimizeForCost", + "workloadDiscoverySource": "Appliance", + "performanceDataStartTime": "2023-10-05T11:57:41.237Z", + "performanceDataEndTime": "2023-10-05T11:57:41.237Z", + "comfortFactor": 8, + "performanceUtilizationPercentile": 64, + "perYearMigrationCompletionPercentage": { + "Year0": 20, + "Year1": 30, + "Year2": 60, + "Year3": 90 + }, + "infrastructureGrowthRate": 44, + "wacc": 5, + "networkCostPercentage": 71, + "iaasLaborCostPercentage": 73, + "paasLaborCostPercentage": 50, + "avsLaborCostPercentage": 69, + "savingsOption": "RI3Year" + }, + "onPremiseSettings": { + "computeSettings": { + "hyperthreadCoreToMemoryRatio": 5, + "price": 14, + "sqlServerLicensing": [ + { + "version": "Enterprise", + "licenseCost": 14, + "softwareAssuranceCost": 13 + } + ], + "windowsServerLicensing": { + "licenseCost": 13, + "softwareAssuranceCost": 14, + "licensesPerCore": 8 + }, + "rhelLinuxServerLicensing": { + "licenseCost": 9 + }, + "suseLinuxServerLicensing": { + "licenseCost": 9 + }, + "virtualizationSoftwareSettings": { + "numberOfPhysicalCoresPerLicense": 11, + "softwareAssuranceCost": 28, + "licenseAndSupportList": [ + { + "licenseType": "VSphereStandard", + "licenseCost": 16, + "basicSupportCost": 7, + "productionSupportCost": 25 + } + ] + } + }, + "storageSettings": { + "costPerGbPerMonth": 15, + "maintainanceCostPercentageToAcquisitionCost": 91 + }, + "networkSettings": { + "hardwareSoftwareCostPercentage": 79, + "maintenanceCostPercentage": 82 + }, + "facilitySettings": { + "facilitiesCost": 12 + }, + "laborSettings": { + "physicalServersPerAdmin": 30, + "virtualMachinesPerAdmin": 1, + "hourlyAdminCost": 15 + }, + "securitySettings": { + "serverSecurityCostPerServerPerYear": 2, + "sqlServerSecurityCostPerServerPerYear": 23 + }, + "managementSettings": { + "hypervVirtualizationManagementSettings": { + "numberOfPhysicalCoresPerLicense": 21, + "softwareAssuranceCost": 1, + "licenseAndSupportList": [ + { + "licenseCost": 12, + "licenseType": "Standard" + } + ] + }, + "vsphereManagementSettings": { + "licenseAndSupportList": [ + { + "licenseType": "VSphereServerStandard", + "licenseCost": 9, + "basicSupportCost": 11, + "productionSupportCost": 24 + } + ] + }, + "thirdPartyManagementSettings": { + "licenseCost": 6, + "supportCost": 2 + }, + "otherManagementCostsSettings": { + "monitoringCostPerServerPerYear": 15, + "patchingCostPerServerPerYear": 15, + "dataProtectionCostPerServerPerYear": 28 + } + } + } + }, + "state": "Completed", + "reportStatusDetails": [ + { + "reportType": "Excel", + "reportStatus": "Completed" + } + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5E8485F1-A440-404E-9F91-AFAC5A9993B2/resourceGroups/rgv2023-05-01-preview/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case", + "name": "sample-business-case", + "type": "Microsoft.Migrate/assessmentProjects/businessCases", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-10-05T11:57:41.238Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-05T11:57:41.238Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..b572a90d604f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,155 @@ +{ + "title": "BusinessCaseOperations_ListByAssessmentProject", + "operationId": "BusinessCaseOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "settings": { + "azureSettings": { + "targetLocation": "WestUs2", + "discountPercentage": 52, + "currency": "USD", + "businessCaseType": "OptimizeForCost", + "workloadDiscoverySource": "Appliance", + "performanceDataStartTime": "2023-10-05T11:57:41.237Z", + "performanceDataEndTime": "2023-10-05T11:57:41.237Z", + "comfortFactor": 8, + "performanceUtilizationPercentile": 64, + "perYearMigrationCompletionPercentage": { + "Year0": 20, + "Year1": 30, + "Year2": 60, + "Year3": 90 + }, + "infrastructureGrowthRate": 44, + "wacc": 5, + "networkCostPercentage": 71, + "iaasLaborCostPercentage": 73, + "paasLaborCostPercentage": 50, + "avsLaborCostPercentage": 69, + "savingsOption": "RI3Year" + }, + "onPremiseSettings": { + "computeSettings": { + "hyperthreadCoreToMemoryRatio": 5, + "price": 14, + "sqlServerLicensing": [ + { + "version": "Enterprise", + "licenseCost": 14, + "softwareAssuranceCost": 13 + } + ], + "windowsServerLicensing": { + "licenseCost": 13, + "softwareAssuranceCost": 14, + "licensesPerCore": 8 + }, + "rhelLinuxServerLicensing": { + "licenseCost": 9 + }, + "suseLinuxServerLicensing": { + "licenseCost": 9 + }, + "virtualizationSoftwareSettings": { + "numberOfPhysicalCoresPerLicense": 11, + "softwareAssuranceCost": 28, + "licenseAndSupportList": [ + { + "licenseType": "VSphereStandard", + "licenseCost": 16, + "basicSupportCost": 7, + "productionSupportCost": 25 + } + ] + } + }, + "storageSettings": { + "costPerGbPerMonth": 15, + "maintainanceCostPercentageToAcquisitionCost": 91 + }, + "networkSettings": { + "hardwareSoftwareCostPercentage": 79, + "maintenanceCostPercentage": 82 + }, + "facilitySettings": { + "facilitiesCost": 12 + }, + "laborSettings": { + "physicalServersPerAdmin": 30, + "virtualMachinesPerAdmin": 1, + "hourlyAdminCost": 15 + }, + "securitySettings": { + "serverSecurityCostPerServerPerYear": 2, + "sqlServerSecurityCostPerServerPerYear": 23 + }, + "managementSettings": { + "hypervVirtualizationManagementSettings": { + "numberOfPhysicalCoresPerLicense": 21, + "softwareAssuranceCost": 1, + "licenseAndSupportList": [ + { + "licenseCost": 12, + "licenseType": "Standard" + } + ] + }, + "vsphereManagementSettings": { + "licenseAndSupportList": [ + { + "licenseType": "VSphereServerStandard", + "licenseCost": 9, + "basicSupportCost": 11, + "productionSupportCost": 24 + } + ] + }, + "thirdPartyManagementSettings": { + "licenseCost": 6, + "supportCost": 2 + }, + "otherManagementCostsSettings": { + "monitoringCostPerServerPerYear": 15, + "patchingCostPerServerPerYear": 15, + "dataProtectionCostPerServerPerYear": 28 + } + } + } + }, + "state": "Completed", + "reportStatusDetails": [ + { + "reportType": "Excel", + "reportStatus": "Completed" + } + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5E8485F1-A440-404E-9F91-AFAC5A9993B2/resourceGroups/rgv2023-05-01-preview/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/businessCase1", + "name": "businessCase1", + "type": "Microsoft.Migrate/assessmentProjects/businessCases", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-10-05T11:57:41.238Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-05T11:57:41.238Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..cb0486793f9f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,123 @@ +{ + "title": "BusinessCaseOverviewSummaryOperations_Get", + "operationId": "BusinessCaseOverviewSummaryOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "overviewSummaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "totalAzureCost": 20, + "totalAzureIaasCost": 29, + "totalAzurePaasCost": 18, + "totalAzureAvsCost": 21, + "windowsAhubSavings": 26, + "linuxAhubSavings": 26, + "sqlAhubSavings": 29, + "totalOnPremisesCost": 20, + "esuSavingsFor4years": 20, + "managementCostSavings": 19, + "securityCostSavings": 8, + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0 + }, + "serversDiscovered": { + "vmWare": 6, + "hyperV": 28, + "physical": 16, + "notApplicable": 13 + }, + "utilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "iaasOsDistribution": { + "windows": 5, + "linux": 22, + "other": 14 + }, + "osSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "sqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "paasDistribution": { + "sqlServers": 28, + "iisWebServers": 9, + "webAppDistribution": { + "key683": 28 + } + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/overviewSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/overviewSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..8b85ff7b12ce --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,127 @@ +{ + "title": "BusinessCaseOverviewSummaryOperations_ListByBusinessCase", + "operationId": "BusinessCaseOverviewSummaryOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "totalAzureCost": 20, + "totalAzureIaasCost": 29, + "totalAzurePaasCost": 18, + "totalAzureAvsCost": 21, + "windowsAhubSavings": 26, + "linuxAhubSavings": 26, + "sqlAhubSavings": 29, + "totalOnPremisesCost": 20, + "esuSavingsFor4years": 20, + "managementCostSavings": 19, + "securityCostSavings": 8, + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0 + }, + "serversDiscovered": { + "vmWare": 6, + "hyperV": 28, + "physical": 16, + "notApplicable": 13 + }, + "utilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "iaasOsDistribution": { + "windows": 5, + "linux": 22, + "other": 14 + }, + "osSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "sqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "paasDistribution": { + "sqlServers": 28, + "iisWebServers": 9, + "webAppDistribution": { + "key683": 28 + } + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/overviewSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/overviewSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..96f3b16c2228 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,252 @@ +{ + "title": "BusinessCasePaasSummaryOperations_Get", + "operationId": "BusinessCasePaasSummaryOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "paasSummaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "azure": { + "totalSqlEntities": 1, + "suitableSqlEntities": 8, + "totalWebApps": 22, + "suitableWebApps": 8, + "cores": 3, + "memory": 29, + "storage": 8, + "estimatedCostByTarget": { + "azureSqlMiCost": 27, + "azureSqlDbCost": 6, + "appServiceCost": 5, + "appServiceContainerCost": 23, + "azureKubernetesServiceCost": 22 + }, + "estimatedSqlServerLicensingCost": 18, + "azureSqlSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "distributionByServiceTier": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ], + "distributionByServiceTierForSqlMi": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ], + "distributionByServiceTierForSqlDb": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ] + }, + "azureAppServiceSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 6, + "count": 27 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "azureAppServiceContainerSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 14, + "count": 30 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "azureKubernetesServiceSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 14, + "count": 30 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "totalAzurePaasCost": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + } + }, + "onPremises": { + "totalServers": 29, + "cpuUtilization": 18, + "memoryUtilization": 14, + "totalOnPremisesPaasCost": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesPaasCostForDecommisioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesPaasLicensingCost": { + "version": null, + "totalCost": 29, + "decomissionServerCost": 1 + }, + "onPremisesSqlSummary": { + "sqlInstances": 26, + "sqlDatabases": 21, + "distributionBySqlVersion": [ + { + "sqlVersion": "SQL Server 2019", + "numberOfInstances": 20 + } + ], + "sqlOnPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionBySqlEdition": [ + { + "type": "Enterprise Edition (64-bit)", + "count": 27 + } + ] + }, + "onPremisesWebAppSummary": { + "numberOfWebServers": 1, + "numberOfWebApplications": 27, + "numberOfWebAppsPerType": { + "key2586": 28 + } + }, + "osSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "sqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + } + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/paasSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/paasSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..9ee7b6b127b4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,256 @@ +{ + "title": "BusinessCasePaasSummaryOperations_ListByBusinessCase", + "operationId": "BusinessCasePaasSummaryOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "azure": { + "totalSqlEntities": 1, + "suitableSqlEntities": 8, + "totalWebApps": 22, + "suitableWebApps": 8, + "cores": 3, + "memory": 29, + "storage": 8, + "estimatedCostByTarget": { + "azureSqlMiCost": 27, + "azureSqlDbCost": 6, + "appServiceCost": 5, + "appServiceContainerCost": 23, + "azureKubernetesServiceCost": 22 + }, + "estimatedSqlServerLicensingCost": 18, + "azureSqlSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "distributionByServiceTier": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ], + "distributionByServiceTierForSqlMi": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ], + "distributionByServiceTierForSqlDb": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ] + }, + "azureAppServiceSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 6, + "count": 27 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "azureAppServiceContainerSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 14, + "count": 30 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "azureKubernetesServiceSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 14, + "count": 30 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "totalAzurePaasCost": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + } + }, + "onPremises": { + "totalServers": 29, + "cpuUtilization": 18, + "memoryUtilization": 14, + "totalOnPremisesPaasCost": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesPaasCostForDecommisioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesPaasLicensingCost": { + "version": null, + "totalCost": 29, + "decomissionServerCost": 1 + }, + "onPremisesSqlSummary": { + "sqlInstances": 26, + "sqlDatabases": 21, + "distributionBySqlVersion": [ + { + "sqlVersion": "SQL Server 2019", + "numberOfInstances": 20 + } + ], + "sqlOnPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionBySqlEdition": [ + { + "type": "Enterprise Edition (64-bit)", + "count": 27 + } + ] + }, + "onPremisesWebAppSummary": { + "numberOfWebServers": 1, + "numberOfWebApplications": 27, + "numberOfWebAppsPerType": { + "key2586": 28 + } + }, + "osSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "sqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + } + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/paasSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/paasSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..2c2eb7cd6b53 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "title": "EvaluatedAvsMachinesOperations_Get", + "operationId": "EvaluatedAvsMachinesOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "evaluatedAvsMachineName": "a404-r1w16-1.FPL.COM" + }, + "responses": { + "200": { + "body": { + "properties": { + "machineId": "a404-r1w16-1.FPL.COM", + "serverName": "a404-r1w16-1.FPL.COM", + "virtualizationType": "Vmware", + "activityState": "inconclusive", + "operatingSystemName": "Ubuntu", + "recommendedAzureTarget": "AzureVm", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedavsmachine/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedavsmachine", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..064037b1ffab --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "EvaluatedAvsMachinesOperations_ListByBusinessCase", + "operationId": "EvaluatedAvsMachinesOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "$filter": "zcwvgkjkvddoylnfkgclpytp", + "pageSize": 9, + "continuationToken": "er", + "totalRecordCount": 2, + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "machineId": "a404-r1w16-1.FPL.COM", + "serverName": "a404-r1w16-1.FPL.COM", + "virtualizationType": "Vmware", + "activityState": "inconclusive", + "operatingSystemName": "Ubuntu", + "recommendedAzureTarget": "AzureVm", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedavsmachine/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedavsmachine", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedMachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedMachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..fc339892f0fd --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedMachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "title": "EvaluatedMachinesOperations_Get", + "operationId": "EvaluatedMachinesOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "evaluatedMachineName": "a404-r1w16-1.FPL.COM" + }, + "responses": { + "200": { + "body": { + "properties": { + "machineId": "a404-r1w16-1.FPL.COM", + "serverName": "a404-r1w16-1.FPL.COM", + "virtualizationType": "Vmware", + "activityState": "inconclusive", + "operatingSystemName": "Ubuntu", + "recommendedAzureTarget": "AzureVm", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedmachine/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedmachine", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..35ed7d9ee09f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "EvaluatedMachinesOperations_ListByBusinessCase", + "operationId": "EvaluatedMachinesOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "$filter": "fyiccra", + "pageSize": 16, + "continuationToken": "mipqzxorbubmdjm", + "totalRecordCount": 28, + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "machineId": "a404-r1w16-1.FPL.COM", + "serverName": "a404-r1w16-1.FPL.COM", + "virtualizationType": "Vmware", + "activityState": "inconclusive", + "operatingSystemName": "Ubuntu", + "recommendedAzureTarget": "AzureVm", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedmachine/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedmachine", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..46dd3278c512 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "title": "EvaluatedSqlEntitiesOperations_Get", + "operationId": "EvaluatedSqlEntitiesOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "evaluatedSqlEntityName": "a404-r1w16-1.FPL.COM" + }, + "responses": { + "200": { + "body": { + "properties": { + "serverName": "a404-r1w16-1.FPL.COM", + "activityState": "active", + "sqlVersion": null, + "sqlEdition": null, + "recommendedAzureTarget": "AzureVirtualMachine", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "virtualizationType": "Vmware", + "dbCount": 1, + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedsqlentity/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedsqlentity", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..84d57567bd54 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "EvaluatedSqlEntitiesOperations_ListByBusinessCase", + "operationId": "EvaluatedSqlEntitiesOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "$filter": "rukrirndrwnypcf", + "pageSize": 13, + "continuationToken": "bqkhzxsvqhnarrffqtgeytrznivh", + "totalRecordCount": 12, + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "serverName": "a404-r1w16-1.FPL.COM", + "activityState": "active", + "sqlVersion": null, + "sqlEdition": null, + "recommendedAzureTarget": "AzureVirtualMachine", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "virtualizationType": "Vmware", + "dbCount": 1, + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedsqlentity/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedsqlentity", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedWebAppsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedWebAppsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..25cc686cab57 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedWebAppsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,38 @@ +{ + "title": "EvaluatedWebAppsOperations_Get", + "operationId": "EvaluatedWebAppsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "evaluatedWebAppName": "a404-r1w16-1.FPL.COM" + }, + "responses": { + "200": { + "body": { + "properties": { + "recommendedAzureTarget": "AzureVm", + "recommendedAzureSkuName": "Premium_V3", + "recommendedAzureSkuSize": "P1 v3", + "serverName": "a404-r1w16-1.FPL.COM", + "workload": "WebApps", + "activityState": "active", + "readyForMigration": "Ready" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedwebapp/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedwebapp", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..b35da02ac34c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "EvaluatedWebAppsOperations_ListByBusinessCase", + "operationId": "EvaluatedWebAppsOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "$filter": "pwrvmthelxikwweggf", + "pageSize": 18, + "continuationToken": "oizcutotskmhqxxmpwiqzvzyaubjt", + "totalRecordCount": 2, + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "recommendedAzureTarget": "AzureVm", + "recommendedAzureSkuName": "Premium_V3", + "recommendedAzureSkuSize": "P1 v3", + "serverName": "a404-r1w16-1.FPL.COM", + "workload": "WebApps", + "activityState": "active", + "readyForMigration": "Ready" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedwebapp/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedwebapp", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..8b3211b9c547 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,85 @@ +{ + "title": "GroupsOperations_Create", + "operationId": "GroupsOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "resource": { + "properties": { + "groupStatus": "Completed", + "groupType": "Default", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "groupStatus": "Completed", + "machineCount": 20, + "assessments": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1" + ], + "supportedAssessmentTypes": [ + "MachineAssessment", + "AvsAssessment" + ], + "areAssessmentsRunning": true, + "createdTimestamp": "2023-09-15T07:22:29.161Z", + "updatedTimestamp": "2023-09-15T07:22:29.161Z", + "groupType": "Default", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test", + "name": "kuchatur-test", + "type": "Microsoft.Migrate/assessmentprojects/groups", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "groupStatus": "Completed", + "machineCount": 20, + "assessments": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1" + ], + "supportedAssessmentTypes": [ + "MachineAssessment", + "AvsAssessment" + ], + "areAssessmentsRunning": true, + "createdTimestamp": "2023-09-15T07:22:29.161Z", + "updatedTimestamp": "2023-09-15T07:22:29.161Z", + "groupType": "Default", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test", + "name": "kuchatur-test", + "type": "Microsoft.Migrate/assessmentprojects/groups", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..236bfa69b784 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "GroupsOperations_Delete", + "operationId": "GroupsOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..2e8c0bc491a1 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,44 @@ +{ + "title": "GroupsOperations_Get", + "operationId": "GroupsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupStatus": "Completed", + "machineCount": 20, + "assessments": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1" + ], + "supportedAssessmentTypes": [ + "MachineAssessment", + "AvsAssessment" + ], + "areAssessmentsRunning": true, + "createdTimestamp": "2023-09-15T07:22:29.161Z", + "updatedTimestamp": "2023-09-15T07:22:29.161Z", + "groupType": "Default", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test", + "name": "kuchatur-test", + "type": "Microsoft.Migrate/assessmentprojects/groups", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..bb8806e74610 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "GroupsOperations_ListByAssessmentProject", + "operationId": "GroupsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupStatus": "Completed", + "machineCount": 20, + "assessments": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1" + ], + "supportedAssessmentTypes": [ + "MachineAssessment", + "AvsAssessment" + ], + "areAssessmentsRunning": true, + "createdTimestamp": "2023-09-15T07:22:29.161Z", + "updatedTimestamp": "2023-09-15T07:22:29.161Z", + "groupType": "Default", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test", + "name": "kuchatur-test", + "type": "Microsoft.Migrate/assessmentprojects/groups", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_UpdateMachines_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_UpdateMachines_MaximumSet_Gen.json new file mode 100644 index 000000000000..92535ad483eb --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_UpdateMachines_MaximumSet_Gen.json @@ -0,0 +1,58 @@ +{ + "title": "Update machines in group.", + "operationId": "GroupsOperations_UpdateMachines", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "body": { + "eTag": "*", + "properties": { + "operationType": "Add", + "machines": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/machines/18895660-c5e5-4247-8cfc-cd24e1fe57f3" + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "groupStatus": "Completed", + "machineCount": 20, + "assessments": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1" + ], + "supportedAssessmentTypes": [ + "MachineAssessment", + "AvsAssessment" + ], + "areAssessmentsRunning": true, + "createdTimestamp": "2023-09-15T07:22:29.161Z", + "updatedTimestamp": "2023-09-15T07:22:29.161Z", + "groupType": "Default", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test", + "name": "kuchatur-test", + "type": "Microsoft.Migrate/assessmentprojects/groups", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..2c525d06629b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,98 @@ +{ + "title": "HypervCollectorsOperations_Create", + "operationId": "HypervCollectorsOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "hypervCollectorName": "test-697cecollector", + "resource": { + "properties": { + "agentProperties": { + "id": "12f1d90f-b3fa-4926-8893-e56803a09af0", + "version": "2.0.1993.19", + "lastHeartbeatUtc": "2022-07-07T14:25:35.708325Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "audience": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "objectId": "01b9f9e2-2d82-414c-adaa-09ce259b6b44", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/HyperVSites/test-60527site", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/hypervcollectors/test-697cecollector", + "name": "test-697cecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/hypervcollectors", + "properties": { + "agentProperties": { + "id": "12f1d90f-b3fa-4926-8893-e56803a09af0", + "version": "2.0.1993.19", + "lastHeartbeatUtc": "2022-07-07T14:25:35.708325Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "audience": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "objectId": "01b9f9e2-2d82-414c-adaa-09ce259b6b44", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/HyperVSites/test-60527site", + "createdTimestamp": "2022-07-06T17:35:52.7505235Z", + "updatedTimestamp": "2023-02-16T12:23:47.9845327Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/hypervcollectors/test-697cecollector", + "name": "test-697cecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/hypervcollectors", + "properties": { + "agentProperties": { + "id": "12f1d90f-b3fa-4926-8893-e56803a09af0", + "version": "2.0.1993.19", + "lastHeartbeatUtc": "2022-07-07T14:25:35.708325Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "audience": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "objectId": "01b9f9e2-2d82-414c-adaa-09ce259b6b44", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/HyperVSites/test-60527site", + "createdTimestamp": "2022-07-06T17:35:52.7505235Z", + "updatedTimestamp": "2023-02-16T12:23:47.9845327Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..350f931b1618 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "HypervCollectorsOperations_Delete", + "operationId": "HypervCollectorsOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "hypervCollectorName": "test-697cecollector" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..f3606e653d5b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "HypervCollectorsOperations_Get", + "operationId": "HypervCollectorsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "hypervCollectorName": "test-697cecollector" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/hypervcollectors/test-697cecollector", + "name": "test-697cecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/hypervcollectors", + "properties": { + "agentProperties": { + "id": "12f1d90f-b3fa-4926-8893-e56803a09af0", + "version": "2.0.1993.19", + "lastHeartbeatUtc": "2022-07-07T14:25:35.708325Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "audience": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "objectId": "01b9f9e2-2d82-414c-adaa-09ce259b6b44", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/HyperVSites/test-60527site", + "createdTimestamp": "2022-07-06T17:35:52.7505235Z", + "updatedTimestamp": "2023-02-16T12:23:47.9845327Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..70558c2a051c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "HypervCollectorsOperations_ListByAssessmentProject", + "operationId": "HypervCollectorsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/hypervcollectors/test-697cecollector", + "name": "test-697cecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/hypervcollectors", + "properties": { + "agentProperties": { + "id": "12f1d90f-b3fa-4926-8893-e56803a09af0", + "version": "2.0.1993.19", + "lastHeartbeatUtc": "2022-07-07T14:25:35.708325Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "audience": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "objectId": "01b9f9e2-2d82-414c-adaa-09ce259b6b44", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/HyperVSites/test-60527site", + "createdTimestamp": "2022-07-06T17:35:52.7505235Z", + "updatedTimestamp": "2023-02-16T12:23:47.9845327Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..e8904f39703b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,62 @@ +{ + "title": "ImportCollectorsOperations_Create", + "operationId": "ImportCollectorsOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "importCollectorName": "importCollectore7d5", + "resource": { + "properties": { + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawRG/providers/microsoft.offazure/importsites/actualSEA37d4importSite", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/importcollectors/importCollectore7d5", + "name": "importCollectore7d5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/importcollectors", + "properties": { + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawRG/providers/microsoft.offazure/importsites/actualSEA37d4importSite", + "createdTimestamp": "2021-10-01T11:04:34.3408113Z", + "updatedTimestamp": "2023-02-16T12:23:48.3830682Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/importcollectors/importCollectore7d5", + "name": "importCollectore7d5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/importcollectors", + "properties": { + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawRG/providers/microsoft.offazure/importsites/actualSEA37d4importSite", + "createdTimestamp": "2021-10-01T11:04:34.3408113Z", + "updatedTimestamp": "2023-02-16T12:23:48.3830682Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..7919004da039 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "ImportCollectorsOperations_Delete", + "operationId": "ImportCollectorsOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "importCollectorName": "importCollectore7d5" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..d441848e7fd4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "ImportCollectorsOperations_Get", + "operationId": "ImportCollectorsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "importCollectorName": "importCollectore7d5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/importcollectors/importCollectore7d5", + "name": "importCollectore7d5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/importcollectors", + "properties": { + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawRG/providers/microsoft.offazure/importsites/actualSEA37d4importSite", + "createdTimestamp": "2021-10-01T11:04:34.3408113Z", + "updatedTimestamp": "2023-02-16T12:23:48.3830682Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..cd8e5436ce84 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "ImportCollectorsOperations_ListByAssessmentProject", + "operationId": "ImportCollectorsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/importcollectors/importCollectore7d5", + "name": "importCollectore7d5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/importcollectors", + "properties": { + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawRG/providers/microsoft.offazure/importsites/actualSEA37d4importSite", + "createdTimestamp": "2021-10-01T11:04:34.3408113Z", + "updatedTimestamp": "2023-02-16T12:23:48.3830682Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/MachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/MachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..159426f8d68c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/MachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,89 @@ +{ + "title": "MachinesOperations_Get", + "operationId": "MachinesOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "machineName": "55082b89-99e2-4c40-b63f-d4f4d6ba961d" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/machines/55082b89-99e2-4c40-b63f-d4f4d6ba961d", + "name": "55082b89-99e2-4c40-b63f-d4f4d6ba961d", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/machines", + "properties": { + "workloadSummary": { + "oracleInstances": 0, + "springApps": 0 + }, + "errors": [], + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 0, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2018-10-09T00:00:00Z", + "extendedSupportEndDate": "2023-10-10T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "2024-10-08T00:00:00Z", + "extendedSecurityUpdateYear2EndDate": "2025-10-14T00:00:00Z", + "extendedSecurityUpdateYear3EndDate": "2026-10-13T00:00:00Z" + }, + "hostProcessor": null, + "discoveryMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app48697site/machines/idclab-vcen65-fareast-corp-micr-7071f35f-082c-4333-9ca9-3fdd5254db17_50379cec-8534-dcd7-0c7e-b16f6572bf94", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app48697site/vcenters/idclab-vcen65-fareast-corp-micr-7071f35f-082c-4333-9ca9-3fdd5254db17", + "datacenterManagementServerName": "idclab-vcen65.fareast.corp.microsoft.com", + "bootType": "BIOS", + "displayName": "a410-r1w12r2-7", + "megabytesOfMemory": 30720.0, + "numberOfCores": 8, + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2012 (64-bit)", + "operatingSystemVersion": null, + "description": "", + "createdTimestamp": "2021-08-31T14:31:19.465845Z", + "disks": { + "6000C29d-4e28-24a9-eaee-02fa5a17dadf": { + "gigabytesAllocated": 150.0, + "displayName": "scsi0:0" + }, + "6000C297-a876-f49f-c202-0289620d5223": { + "gigabytesAllocated": 250.0, + "displayName": "scsi0:1" + }, + "6000C295-4e9d-4322-6690-aff91beffb82": { + "gigabytesAllocated": 50.0, + "displayName": "scsi0:2" + } + }, + "groups": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/azure-vmwaresolution-ame-15389", + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/rajoshtest" + ], + "networkAdapters": { + "4000": { + "macAddress": "00:50:56:b7:04:06", + "ipAddresses": [], + "displayName": "VM Network" + } + }, + "sqlInstances": [], + "webApplications": [], + "updatedTimestamp": "2023-08-03T16:22:11.2610571Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/MachinesOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/MachinesOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..b009dd1f59cb --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/MachinesOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,97 @@ +{ + "title": "MachinesOperations_ListByAssessmentProject", + "operationId": "MachinesOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "$filter": null, + "pageSize": 1, + "continuationToken": null, + "totalRecordCount": 1, + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/machines/55082b89-99e2-4c40-b63f-d4f4d6ba961d", + "name": "55082b89-99e2-4c40-b63f-d4f4d6ba961d", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/machines", + "properties": { + "workloadSummary": { + "oracleInstances": 0, + "springApps": 0 + }, + "errors": [], + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 0, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2018-10-09T00:00:00Z", + "extendedSupportEndDate": "2023-10-10T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "2024-10-08T00:00:00Z", + "extendedSecurityUpdateYear2EndDate": "2025-10-14T00:00:00Z", + "extendedSecurityUpdateYear3EndDate": "2026-10-13T00:00:00Z" + }, + "hostProcessor": null, + "discoveryMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app48697site/machines/idclab-vcen65-fareast-corp-micr-7071f35f-082c-4333-9ca9-3fdd5254db17_50379cec-8534-dcd7-0c7e-b16f6572bf94", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app48697site/vcenters/idclab-vcen65-fareast-corp-micr-7071f35f-082c-4333-9ca9-3fdd5254db17", + "datacenterManagementServerName": "idclab-vcen65.fareast.corp.microsoft.com", + "bootType": "BIOS", + "displayName": "a410-r1w12r2-7", + "megabytesOfMemory": 30720.0, + "numberOfCores": 8, + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2012 (64-bit)", + "operatingSystemVersion": null, + "description": "", + "createdTimestamp": "2021-08-31T14:31:19.465845Z", + "disks": { + "6000C29d-4e28-24a9-eaee-02fa5a17dadf": { + "gigabytesAllocated": 150.0, + "displayName": "scsi0:0" + }, + "6000C297-a876-f49f-c202-0289620d5223": { + "gigabytesAllocated": 250.0, + "displayName": "scsi0:1" + }, + "6000C295-4e9d-4322-6690-aff91beffb82": { + "gigabytesAllocated": 50.0, + "displayName": "scsi0:2" + } + }, + "groups": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/azure-vmwaresolution-ame-15389", + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/rajoshtest" + ], + "networkAdapters": { + "4000": { + "macAddress": "00:50:56:b7:04:06", + "ipAddresses": [], + "displayName": "VM Network" + } + }, + "sqlInstances": [], + "webApplications": [], + "updatedTimestamp": "2023-08-03T16:22:11.2610571Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/Operations_List_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..a47c702d4ad9 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2023-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AksAssessmentOperations_Get", + "isDataAction": true, + "display": { + "provider": "Microsoft.Migrate", + "resource": "AKSAssessment", + "operation": "GET", + "description": "AKSAssessment" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..bb4441759275 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "PrivateEndpointConnectionOperations_Delete", + "operationId": "PrivateEndpointConnectionOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "privateEndpointConnectionName": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..1ed91c2f7f5b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,39 @@ +{ + "title": "PrivateEndpointConnectionOperations_Get", + "operationId": "PrivateEndpointConnectionOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "privateEndpointConnectionName": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7" + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/privateEndpointConnections/sakanwar1204project1634pe", + "name": "sakanwar1204project1634pe", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..a0ee06195281 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,43 @@ +{ + "title": "PrivateEndpointConnectionOperations_ListByAssessmentProject", + "operationId": "PrivateEndpointConnectionOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/privateEndpointConnections/sakanwar1204project1634pe", + "name": "sakanwar1204project1634pe", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/avol" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Update_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..56ea66251470 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Update_MaximumSet_Gen.json @@ -0,0 +1,76 @@ +{ + "title": "PrivateEndpointConnectionOperations_Update", + "operationId": "PrivateEndpointConnectionOperations_Update", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "privateEndpointConnectionName": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "resource": { + "properties": { + "privateEndpoint": {}, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/privateEndpointConnections/sakanwar1204project1634pe", + "name": "sakanwar1204project1634pe", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "201": { + "headers": {}, + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/privateEndpointConnections/sakanwar1204project1634pe", + "name": "sakanwar1204project1634pe", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateLinkResourceOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateLinkResourceOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..66add9e9ec82 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateLinkResourceOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "PrivateLinkResourceOperations_Get", + "operationId": "PrivateLinkResourceOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "privateLinkResourceName": "Default" + }, + "responses": { + "200": { + "body": { + "properties": { + "requiredMembers": [ + "CollectorAgent" + ], + "requiredZoneNames": [ + "privatelink.test.migration.windowsazure.com" + ], + "groupId": "Default" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateLinkResources/Default", + "name": "Default", + "type": "Microsoft.Migrate/assessmentprojects/privateLinkResources", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..b07930fdc471 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "title": "PrivateLinkResourceOperations_ListByAssessmentProject", + "operationId": "PrivateLinkResourceOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "requiredMembers": [ + "CollectorAgent" + ], + "requiredZoneNames": [ + "privatelink.test.migration.windowsazure.com" + ], + "groupId": "Default" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateLinkResources/Default", + "name": "Default", + "type": "Microsoft.Migrate/assessmentprojects/privateLinkResources", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/abcd" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..b405d3d54016 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,98 @@ +{ + "title": "ServerCollectorsOperations_Create", + "operationId": "ServerCollectorsOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "serverCollectorName": "walter389fcollector", + "resource": { + "properties": { + "agentProperties": { + "id": "498e4965-bbb1-47c2-8613-345baff9c509", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "audience": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "objectId": "ddde6f96-87c8-420b-9d4d-f16a5090519e", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/ServerSites/walter7155site", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/servercollectors/walter389fcollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "walter389fcollector", + "type": "Microsoft.Migrate/assessmentprojects/servercollectors", + "properties": { + "agentProperties": { + "id": "498e4965-bbb1-47c2-8613-345baff9c509", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "audience": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "objectId": "ddde6f96-87c8-420b-9d4d-f16a5090519e", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/ServerSites/walter7155site", + "createdTimestamp": "2023-05-29T13:35:13.3621563Z", + "updatedTimestamp": "2023-09-25T07:28:34.8075563Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/servercollectors/walter389fcollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "walter389fcollector", + "type": "Microsoft.Migrate/assessmentprojects/servercollectors", + "properties": { + "agentProperties": { + "id": "498e4965-bbb1-47c2-8613-345baff9c509", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "audience": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "objectId": "ddde6f96-87c8-420b-9d4d-f16a5090519e", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/ServerSites/walter7155site", + "createdTimestamp": "2023-05-29T13:35:13.3621563Z", + "updatedTimestamp": "2023-09-25T07:28:34.8075563Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..be1cd1d47d55 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "ServerCollectorsOperations_Delete", + "operationId": "ServerCollectorsOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "serverCollectorName": "walter389fcollector" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..f89f2bc2a89b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "ServerCollectorsOperations_Get", + "operationId": "ServerCollectorsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "serverCollectorName": "walter389fcollector" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/servercollectors/walter389fcollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "walter389fcollector", + "type": "Microsoft.Migrate/assessmentprojects/servercollectors", + "properties": { + "agentProperties": { + "id": "498e4965-bbb1-47c2-8613-345baff9c509", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "audience": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "objectId": "ddde6f96-87c8-420b-9d4d-f16a5090519e", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/ServerSites/walter7155site", + "createdTimestamp": "2023-05-29T13:35:13.3621563Z", + "updatedTimestamp": "2023-09-25T07:28:34.8075563Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..8ef3c807b70b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "ServerCollectorsOperations_ListByAssessmentProject", + "operationId": "ServerCollectorsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/servercollectors/walter389fcollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "walter389fcollector", + "type": "Microsoft.Migrate/assessmentprojects/servercollectors", + "properties": { + "agentProperties": { + "id": "498e4965-bbb1-47c2-8613-345baff9c509", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "audience": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "objectId": "ddde6f96-87c8-420b-9d4d-f16a5090519e", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/ServerSites/walter7155site", + "createdTimestamp": "2023-05-29T13:35:13.3621563Z", + "updatedTimestamp": "2023-09-25T07:28:34.8075563Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentOptionsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentOptionsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..870a5fe98991 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentOptionsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,1635 @@ +{ + "title": "SqlAssessmentOptionsOperations_Get", + "operationId": "SqlAssessmentOptionsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "assessmentOptionsName": "default" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.Migrate/assessmentprojects/sqlAssessmentOptions", + "systemData": { + "createdAt": "2023-09-25T10:16:46.5581628Z", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "2023-09-25T10:16:46.5581628Z", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "properties": { + "vmFamilies": [ + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Eav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + } + ], + "reservedInstanceVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Edsv5_series", + "Edv5_series", + "Eadsv5_series", + "Easv4_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "premiumDiskVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Edsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "savingsPlanVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Edsv5_series", + "Edv5_series", + "Eadsv5_series", + "Easv4_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "savingsPlanSupportedLocations": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral" + ], + "savingsPlanSupportedLocationsForPaas": [], + "reservedInstanceSupportedLocationsForIaas": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "ItalyNorth", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "savingsPlanSupportedOffers": [ + "SavingsPlan1Year", + "SavingsPlan3Year" + ], + "sqlSkus": [ + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "NorwayWest", + "CanadaCentral", + "CanadaEast", + "GermanyNorth", + "SouthAfricaWest", + "EastAsia", + "NorwayEast", + "WestUs2", + "SouthIndia", + "EastUs", + "SouthCentralUs", + "UAENorth", + "AustraliaSoutheast", + "PolandCentral", + "KoreaCentral", + "UkWest", + "SwitzerlandNorth", + "NorthCentralUs", + "SoutheastAsia", + "BrazilSouth", + "FranceSouth", + "SwitzerlandWest", + "SwedenCentral", + "WestUs", + "AustraliaCentral2", + "NorthEurope", + "WestIndia", + "FranceCentral", + "ItalyNorth", + "KoreaSouth", + "GermanyWestCentral", + "JapanEast", + "WestEurope", + "WestCentralUs", + "SouthAfricaNorth", + "AustraliaCentral", + "UAECentral", + "UkSouth", + "JapanWest", + "CentralIndia", + "EastUs2", + "AustraliaEast", + "CentralUs", + "QatarCentral", + "ChinaNorth2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "BusinessCritical", + "targetLocations": [ + "AustraliaEast", + "SoutheastAsia", + "WestIndia", + "CanadaEast", + "NorthEurope", + "UAENorth", + "SouthAfricaNorth", + "EastUs", + "NorthCentralUs", + "BrazilSouth", + "WestCentralUs", + "UAECentral", + "CanadaCentral", + "JapanEast", + "CentralUs", + "FranceSouth", + "ItalyNorth", + "SouthCentralUs", + "UkWest", + "NorwayEast", + "FranceCentral", + "CentralIndia", + "AustraliaCentral2", + "EastAsia", + "WestUs", + "SouthAfricaWest", + "SwitzerlandWest", + "QatarCentral", + "AustraliaSoutheast", + "WestUs2", + "KoreaSouth", + "NorwayWest", + "GermanyWestCentral", + "JapanWest", + "UkSouth", + "WestEurope", + "KoreaCentral", + "EastUs2", + "SwedenCentral", + "AustraliaCentral", + "SouthIndia", + "GermanyNorth", + "SwitzerlandNorth", + "PolandCentral", + "ChinaEast2", + "ChinaEast", + "ChinaNorth", + "ChinaNorth2", + "USGovIowa", + "USGovVirginia", + "USGovArizona", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "PremiumSeriesMemoryOptimized", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "UAECentral", + "FranceSouth", + "SwitzerlandNorth", + "CentralIndia", + "NorthEurope", + "SwedenCentral", + "WestCentralUs", + "CanadaEast", + "AustraliaSoutheast", + "EastAsia", + "UAENorth", + "SwitzerlandWest", + "BrazilSouth", + "EastUs2", + "GermanyWestCentral", + "FranceCentral", + "WestUs", + "AustraliaCentral", + "NorwayWest", + "QatarCentral", + "WestUs2", + "UkWest", + "KoreaSouth", + "JapanWest", + "CanadaCentral", + "SoutheastAsia", + "PolandCentral", + "KoreaCentral", + "SouthCentralUs", + "GermanyNorth", + "ItalyNorth", + "EastUs", + "SouthAfricaWest", + "CentralUs", + "AustraliaEast", + "NorwayEast", + "WestEurope", + "WestIndia", + "NorthCentralUs", + "UkSouth", + "AustraliaCentral2", + "SouthAfricaNorth", + "JapanEast", + "SouthIndia", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovIowa", + "USGovVirginia" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "PremiumSeries", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "CentralIndia", + "AustraliaCentral", + "UAENorth", + "KoreaCentral", + "UAECentral", + "AustraliaSoutheast", + "SoutheastAsia", + "ItalyNorth", + "AustraliaEast", + "WestUs2", + "AustraliaCentral2", + "BrazilSouth", + "FranceSouth", + "JapanEast", + "NorthCentralUs", + "NorthEurope", + "PolandCentral", + "NorwayWest", + "UkSouth", + "SouthAfricaNorth", + "CanadaEast", + "WestIndia", + "GermanyWestCentral", + "NorwayEast", + "SwitzerlandWest", + "KoreaSouth", + "SwedenCentral", + "JapanWest", + "CentralUs", + "QatarCentral", + "WestEurope", + "CanadaCentral", + "SouthIndia", + "GermanyNorth", + "WestCentralUs", + "EastUs", + "SwitzerlandNorth", + "FranceCentral", + "SouthAfricaWest", + "UkWest", + "WestUs", + "SouthCentralUs", + "EastUs2", + "EastAsia", + "ChinaNorth2", + "ChinaEast2", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "GeneralPurpose", + "targetLocations": [ + "EastUs2", + "SouthCentralUs", + "GermanyWestCentral", + "AustraliaCentral", + "SouthAfricaWest", + "GermanyNorth", + "CanadaEast", + "WestUs", + "WestUs2", + "CanadaCentral", + "SouthAfricaNorth", + "FranceCentral", + "CentralUs", + "NorwayEast", + "JapanEast", + "UkWest", + "WestCentralUs", + "FranceSouth", + "BrazilSouth", + "KoreaSouth", + "EastAsia", + "UAENorth", + "CentralIndia", + "NorthEurope", + "AustraliaEast", + "KoreaCentral", + "SwitzerlandNorth", + "SwedenCentral", + "WestEurope", + "AustraliaCentral2", + "EastUs", + "PolandCentral", + "NorthCentralUs", + "UAECentral", + "ItalyNorth", + "SouthIndia", + "WestIndia", + "SoutheastAsia", + "AustraliaSoutheast", + "NorwayWest", + "JapanWest", + "SwitzerlandWest", + "QatarCentral", + "UkSouth", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "ChinaEast", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlManagedInstance", + "serviceTier": "GeneralPurpose", + "targetLocations": [ + "PolandCentral", + "JapanEast", + "SoutheastAsia", + "GermanyNorth", + "AustraliaCentral", + "UAECentral", + "GermanyWestCentral", + "NorwayWest", + "NorwayEast", + "AustraliaCentral2", + "SwitzerlandNorth", + "UAENorth", + "FranceSouth", + "BrazilSouth", + "CanadaEast", + "EastUs2", + "WestEurope", + "JapanWest", + "WestUs2", + "FranceCentral", + "WestIndia", + "SouthCentralUs", + "KoreaSouth", + "NorthEurope", + "SouthAfricaWest", + "SouthAfricaNorth", + "EastAsia", + "EastUs", + "ItalyNorth", + "SwedenCentral", + "KoreaCentral", + "AustraliaSoutheast", + "QatarCentral", + "CentralIndia", + "CanadaCentral", + "CentralUs", + "AustraliaEast", + "NorthCentralUs", + "WestCentralUs", + "SouthIndia", + "WestUs", + "UkSouth", + "SwitzerlandWest", + "UkWest", + "ChinaEast", + "ChinaNorth2", + "ChinaEast2", + "ChinaNorth", + "USGovTexas", + "USGovArizona", + "USGovIowa", + "USGovVirginia" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlManagedInstance", + "serviceTier": "BusinessCritical", + "targetLocations": [ + "NorwayWest", + "NorthEurope", + "GermanyNorth", + "KoreaSouth", + "EastUs2", + "CentralIndia", + "SoutheastAsia", + "SwedenCentral", + "WestUs", + "JapanEast", + "WestEurope", + "AustraliaEast", + "SouthAfricaNorth", + "UkSouth", + "UAENorth", + "NorthCentralUs", + "SouthAfricaWest", + "CanadaEast", + "UkWest", + "CentralUs", + "SouthCentralUs", + "WestUs2", + "NorwayEast", + "JapanWest", + "PolandCentral", + "WestCentralUs", + "EastAsia", + "SouthIndia", + "ItalyNorth", + "QatarCentral", + "FranceCentral", + "CanadaCentral", + "SwitzerlandWest", + "UAECentral", + "AustraliaCentral", + "SwitzerlandNorth", + "KoreaCentral", + "WestIndia", + "BrazilSouth", + "EastUs", + "FranceSouth", + "AustraliaCentral2", + "AustraliaSoutheast", + "GermanyWestCentral", + "ChinaEast2", + "ChinaEast", + "ChinaNorth2", + "ChinaNorth", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + } + ], + "reservedInstanceSqlTargets": [ + "AzureSqlDatabase", + "AzureSqlManagedInstance" + ], + "reservedInstanceSupportedLocations": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "ItalyNorth", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "reservedInstanceSupportedCurrencies": [ + "USD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P", + "MSAZRUSGOV0003P" + ], + "supportedOffers": [ + "MSAZR0003P" + ] + }, + "name": "default", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/sqlAssessmentOptions/default" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..7a5b8dc8a6f9 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,1639 @@ +{ + "title": "SqlAssessmentOptionsOperations_ListByAssessmentProject", + "operationId": "SqlAssessmentOptionsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.Migrate/assessmentprojects/sqlAssessmentOptions", + "systemData": { + "createdAt": "2023-09-25T10:16:46.5581628Z", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "2023-09-25T10:16:46.5581628Z", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "properties": { + "vmFamilies": [ + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Eav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + } + ], + "reservedInstanceVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Edsv5_series", + "Edv5_series", + "Eadsv5_series", + "Easv4_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "premiumDiskVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Edsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "savingsPlanVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Edsv5_series", + "Edv5_series", + "Eadsv5_series", + "Easv4_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "savingsPlanSupportedLocations": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral" + ], + "savingsPlanSupportedLocationsForPaas": [], + "reservedInstanceSupportedLocationsForIaas": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "ItalyNorth", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "savingsPlanSupportedOffers": [ + "SavingsPlan1Year", + "SavingsPlan3Year" + ], + "sqlSkus": [ + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "NorwayWest", + "CanadaCentral", + "CanadaEast", + "GermanyNorth", + "SouthAfricaWest", + "EastAsia", + "NorwayEast", + "WestUs2", + "SouthIndia", + "EastUs", + "SouthCentralUs", + "UAENorth", + "AustraliaSoutheast", + "PolandCentral", + "KoreaCentral", + "UkWest", + "SwitzerlandNorth", + "NorthCentralUs", + "SoutheastAsia", + "BrazilSouth", + "FranceSouth", + "SwitzerlandWest", + "SwedenCentral", + "WestUs", + "AustraliaCentral2", + "NorthEurope", + "WestIndia", + "FranceCentral", + "ItalyNorth", + "KoreaSouth", + "GermanyWestCentral", + "JapanEast", + "WestEurope", + "WestCentralUs", + "SouthAfricaNorth", + "AustraliaCentral", + "UAECentral", + "UkSouth", + "JapanWest", + "CentralIndia", + "EastUs2", + "AustraliaEast", + "CentralUs", + "QatarCentral", + "ChinaNorth2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "BusinessCritical", + "targetLocations": [ + "AustraliaEast", + "SoutheastAsia", + "WestIndia", + "CanadaEast", + "NorthEurope", + "UAENorth", + "SouthAfricaNorth", + "EastUs", + "NorthCentralUs", + "BrazilSouth", + "WestCentralUs", + "UAECentral", + "CanadaCentral", + "JapanEast", + "CentralUs", + "FranceSouth", + "ItalyNorth", + "SouthCentralUs", + "UkWest", + "NorwayEast", + "FranceCentral", + "CentralIndia", + "AustraliaCentral2", + "EastAsia", + "WestUs", + "SouthAfricaWest", + "SwitzerlandWest", + "QatarCentral", + "AustraliaSoutheast", + "WestUs2", + "KoreaSouth", + "NorwayWest", + "GermanyWestCentral", + "JapanWest", + "UkSouth", + "WestEurope", + "KoreaCentral", + "EastUs2", + "SwedenCentral", + "AustraliaCentral", + "SouthIndia", + "GermanyNorth", + "SwitzerlandNorth", + "PolandCentral", + "ChinaEast2", + "ChinaEast", + "ChinaNorth", + "ChinaNorth2", + "USGovIowa", + "USGovVirginia", + "USGovArizona", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "PremiumSeriesMemoryOptimized", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "UAECentral", + "FranceSouth", + "SwitzerlandNorth", + "CentralIndia", + "NorthEurope", + "SwedenCentral", + "WestCentralUs", + "CanadaEast", + "AustraliaSoutheast", + "EastAsia", + "UAENorth", + "SwitzerlandWest", + "BrazilSouth", + "EastUs2", + "GermanyWestCentral", + "FranceCentral", + "WestUs", + "AustraliaCentral", + "NorwayWest", + "QatarCentral", + "WestUs2", + "UkWest", + "KoreaSouth", + "JapanWest", + "CanadaCentral", + "SoutheastAsia", + "PolandCentral", + "KoreaCentral", + "SouthCentralUs", + "GermanyNorth", + "ItalyNorth", + "EastUs", + "SouthAfricaWest", + "CentralUs", + "AustraliaEast", + "NorwayEast", + "WestEurope", + "WestIndia", + "NorthCentralUs", + "UkSouth", + "AustraliaCentral2", + "SouthAfricaNorth", + "JapanEast", + "SouthIndia", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovIowa", + "USGovVirginia" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "PremiumSeries", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "CentralIndia", + "AustraliaCentral", + "UAENorth", + "KoreaCentral", + "UAECentral", + "AustraliaSoutheast", + "SoutheastAsia", + "ItalyNorth", + "AustraliaEast", + "WestUs2", + "AustraliaCentral2", + "BrazilSouth", + "FranceSouth", + "JapanEast", + "NorthCentralUs", + "NorthEurope", + "PolandCentral", + "NorwayWest", + "UkSouth", + "SouthAfricaNorth", + "CanadaEast", + "WestIndia", + "GermanyWestCentral", + "NorwayEast", + "SwitzerlandWest", + "KoreaSouth", + "SwedenCentral", + "JapanWest", + "CentralUs", + "QatarCentral", + "WestEurope", + "CanadaCentral", + "SouthIndia", + "GermanyNorth", + "WestCentralUs", + "EastUs", + "SwitzerlandNorth", + "FranceCentral", + "SouthAfricaWest", + "UkWest", + "WestUs", + "SouthCentralUs", + "EastUs2", + "EastAsia", + "ChinaNorth2", + "ChinaEast2", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "GeneralPurpose", + "targetLocations": [ + "EastUs2", + "SouthCentralUs", + "GermanyWestCentral", + "AustraliaCentral", + "SouthAfricaWest", + "GermanyNorth", + "CanadaEast", + "WestUs", + "WestUs2", + "CanadaCentral", + "SouthAfricaNorth", + "FranceCentral", + "CentralUs", + "NorwayEast", + "JapanEast", + "UkWest", + "WestCentralUs", + "FranceSouth", + "BrazilSouth", + "KoreaSouth", + "EastAsia", + "UAENorth", + "CentralIndia", + "NorthEurope", + "AustraliaEast", + "KoreaCentral", + "SwitzerlandNorth", + "SwedenCentral", + "WestEurope", + "AustraliaCentral2", + "EastUs", + "PolandCentral", + "NorthCentralUs", + "UAECentral", + "ItalyNorth", + "SouthIndia", + "WestIndia", + "SoutheastAsia", + "AustraliaSoutheast", + "NorwayWest", + "JapanWest", + "SwitzerlandWest", + "QatarCentral", + "UkSouth", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "ChinaEast", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlManagedInstance", + "serviceTier": "GeneralPurpose", + "targetLocations": [ + "PolandCentral", + "JapanEast", + "SoutheastAsia", + "GermanyNorth", + "AustraliaCentral", + "UAECentral", + "GermanyWestCentral", + "NorwayWest", + "NorwayEast", + "AustraliaCentral2", + "SwitzerlandNorth", + "UAENorth", + "FranceSouth", + "BrazilSouth", + "CanadaEast", + "EastUs2", + "WestEurope", + "JapanWest", + "WestUs2", + "FranceCentral", + "WestIndia", + "SouthCentralUs", + "KoreaSouth", + "NorthEurope", + "SouthAfricaWest", + "SouthAfricaNorth", + "EastAsia", + "EastUs", + "ItalyNorth", + "SwedenCentral", + "KoreaCentral", + "AustraliaSoutheast", + "QatarCentral", + "CentralIndia", + "CanadaCentral", + "CentralUs", + "AustraliaEast", + "NorthCentralUs", + "WestCentralUs", + "SouthIndia", + "WestUs", + "UkSouth", + "SwitzerlandWest", + "UkWest", + "ChinaEast", + "ChinaNorth2", + "ChinaEast2", + "ChinaNorth", + "USGovTexas", + "USGovArizona", + "USGovIowa", + "USGovVirginia" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlManagedInstance", + "serviceTier": "BusinessCritical", + "targetLocations": [ + "NorwayWest", + "NorthEurope", + "GermanyNorth", + "KoreaSouth", + "EastUs2", + "CentralIndia", + "SoutheastAsia", + "SwedenCentral", + "WestUs", + "JapanEast", + "WestEurope", + "AustraliaEast", + "SouthAfricaNorth", + "UkSouth", + "UAENorth", + "NorthCentralUs", + "SouthAfricaWest", + "CanadaEast", + "UkWest", + "CentralUs", + "SouthCentralUs", + "WestUs2", + "NorwayEast", + "JapanWest", + "PolandCentral", + "WestCentralUs", + "EastAsia", + "SouthIndia", + "ItalyNorth", + "QatarCentral", + "FranceCentral", + "CanadaCentral", + "SwitzerlandWest", + "UAECentral", + "AustraliaCentral", + "SwitzerlandNorth", + "KoreaCentral", + "WestIndia", + "BrazilSouth", + "EastUs", + "FranceSouth", + "AustraliaCentral2", + "AustraliaSoutheast", + "GermanyWestCentral", + "ChinaEast2", + "ChinaEast", + "ChinaNorth2", + "ChinaNorth", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + } + ], + "reservedInstanceSqlTargets": [ + "AzureSqlDatabase", + "AzureSqlManagedInstance" + ], + "reservedInstanceSupportedLocations": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "ItalyNorth", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "reservedInstanceSupportedCurrencies": [ + "USD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P", + "MSAZRUSGOV0003P" + ], + "supportedOffers": [ + "MSAZR0003P" + ] + }, + "name": "default", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/sqlAssessmentOptions/default" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..a40eb6a666c6 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Create_MaximumSet_Gen.json @@ -0,0 +1,219 @@ +{ + "title": "SqlAssessmentV2Operations_Create", + "operationId": "SqlAssessmentV2Operations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "resource": { + "properties": { + "entityUptime": { + "daysPerMonth": 30, + "hoursPerDay": 24 + }, + "osLicense": "Unknown", + "optimizationLogic": "MinimizeCost", + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Automatic", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Eadsv5_series" + ] + }, + "environmentType": "Production", + "reservedInstance": "None", + "reservedInstanceForVm": "None", + "sqlServerLicense": "Unknown", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "azureOfferCodeForVm": "MSAZR0003P", + "currency": "USD", + "percentile": "Percentile95", + "scalingFactor": 1, + "timeRange": "Day", + "discountPercentage": 0, + "sizingCriterion": "PerformanceBased", + "multiSubnetIntent": "DisasterRecovery", + "asyncCommitModeIntent": "DisasterRecovery", + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1", + "name": "test_swagger_1", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-07T05:21:45.9644382Z", + "perfDataEndTime": "2023-09-08T05:21:45.9644382Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-08T05:21:45.9800654Z", + "updatedTimestamp": "2023-09-08T05:23:45.2686461Z", + "status": "Completed", + "schemaVersion": "2.0" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1", + "name": "test_swagger_1", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-07T05:21:45.9644382Z", + "perfDataEndTime": "2023-09-08T05:21:45.9644382Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-08T05:21:45.9800654Z", + "updatedTimestamp": "2023-09-08T05:23:45.2686461Z", + "status": "Completed", + "schemaVersion": "2.0" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..f2e38db2e96e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "SqlAssessmentV2Operations_Delete", + "operationId": "SqlAssessmentV2Operations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..7acc1a52c057 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Get download URL for the assessment report.", + "operationId": "SqlAssessmentV2Operations_DownloadUrl", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "body": {} + }, + "responses": { + "200": { + "body": { + "assessmentReportUrl": "fagqmlysjfwtt", + "expirationTime": "2023-09-15T07:22:40.818Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..b58cef26efcb --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,94 @@ +{ + "title": "SqlAssessmentV2Operations_Get", + "operationId": "SqlAssessmentV2Operations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1", + "name": "test_swagger_1", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-07T05:21:45.9644382Z", + "perfDataEndTime": "2023-09-08T05:21:45.9644382Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-08T05:21:45.9800654Z", + "updatedTimestamp": "2023-09-08T05:23:45.2686461Z", + "status": "Completed", + "schemaVersion": "2.0" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..b96c917afe29 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json @@ -0,0 +1,254 @@ +{ + "title": "SqlAssessmentV2Operations_ListByGroup", + "operationId": "SqlAssessmentV2Operations_ListByGroup", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_assmt_hadr_1", + "name": "test_assmt_hadr_1", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-02-16T16:14:03.477007Z", + "perfDataEndTime": "2023-02-17T16:14:03.477007Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2022-12-20T00:00:00Z", + "createdTimestamp": "2023-01-04T14:17:43.1744405Z", + "updatedTimestamp": "2023-02-17T16:16:25.1524275Z", + "status": "Completed", + "schemaVersion": "2.0" + } + }, + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_assmt_hadr_2", + "name": "test_assmt_hadr_2", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-06T07:47:29.6769501Z", + "perfDataEndTime": "2023-09-07T07:47:29.6769501Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-07T07:47:29.6925964Z", + "updatedTimestamp": "2023-09-07T07:49:26.5732595Z", + "status": "Completed", + "schemaVersion": "2.0" + } + }, + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1", + "name": "test_swagger_1", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-07T05:21:45.9644382Z", + "perfDataEndTime": "2023-09-08T05:21:45.9644382Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-08T05:21:45.9800654Z", + "updatedTimestamp": "2023-09-08T05:23:45.2686461Z", + "status": "Completed", + "schemaVersion": "2.0" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..908b43ec5209 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,128 @@ +{ + "title": "SqlAssessmentV2SummaryOperations_Get", + "operationId": "SqlAssessmentV2SummaryOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "summaryName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/summaries/default", + "name": "default", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/summaries", + "properties": { + "assessmentSummary": { + "azureSqlManagedInstance": { + "suitabilitySummary": { + "notSuitable": 7, + "readinessUnknown": 15, + "suitableForSqlMI": 1 + }, + "monthlyComputeCost": 4581.992448, + "monthlyStorageCost": 0.0, + "monthlyLicenseCost": 6568.5107999999991, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureSqlVirtualMachine": { + "suitabilitySummary": { + "suitableForSqlVM": 21, + "readinessUnknown": 2 + }, + "monthlyComputeCost": 889.49663999999962, + "monthlyStorageCost": 73.943999999999988, + "monthlyLicenseCost": 25281.36, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureSqlDatabase": { + "suitabilitySummary": { + "readinessUnknown": 1468, + "suitableForSqlDB": 16 + }, + "monthlyComputeCost": 175079.07398399821, + "monthlyStorageCost": 1054.8825000000395, + "monthlyLicenseCost": 214401.07883999476, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureVirtualMachine": { + "suitabilitySummary": { + "suitableForVM": 19 + }, + "monthlyComputeCost": 625.94207999999981, + "monthlyStorageCost": 374.48999999999995, + "monthlyLicenseCost": 1300.5120000000002, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "recommended": { + "suitabilitySummary": { + "suitableForSqlVM": 19, + "suitableForVM": 4 + }, + "monthlyComputeCost": 823.60799999999972, + "monthlyStorageCost": 100.88400000000002, + "monthlyLicenseCost": 22912.896, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + } + }, + "distributionBySupportStatus": { + "extended": 11, + "outOfSupport": 9, + "mainstream": 3 + }, + "distributionByServicePackInsight": { + "unknown": 23 + }, + "distributionBySqlVersion": { + "sql Server 2014": 4, + "sql Server 2012": 9, + "sql Server 2019": 3, + "sql Server 2016": 5, + "sql Server 2017": 2 + }, + "distributionBySqlEdition": { + "enterprise Edition: Core-based Licensing (64-bit)": 15, + "web Edition": 1, + "express Edition (64-bit)": 2, + "enterprise Evaluation Edition (64-bit)": 1, + "enterprise Edition: Core-based Licensing": 1, + "enterprise Edition (64-bit)": 1, + "standard Edition (64-bit)": 2 + }, + "instanceDistributionBySizingCriterion": { + "performanceBased": 0, + "asOnPremises": 0, + "perfBasedFallbackToAsOnPremises": 23 + }, + "databaseDistributionBySizingCriterion": { + "performanceBased": 0, + "asOnPremises": 0, + "perfBasedFallbackToAsOnPremises": 1484 + }, + "numberOfMachines": 19, + "numberOfSqlInstances": 23, + "numberOfSqlDatabases": 1484, + "numberOfFciInstances": 4, + "numberOfSqlAvailabilityGroups": 5 + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..a974ed1660e7 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,132 @@ +{ + "title": "SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2", + "operationId": "SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/summaries/default", + "name": "default", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/summaries", + "properties": { + "assessmentSummary": { + "azureSqlManagedInstance": { + "suitabilitySummary": { + "notSuitable": 7, + "readinessUnknown": 15, + "suitableForSqlMI": 1 + }, + "monthlyComputeCost": 4581.992448, + "monthlyStorageCost": 0.0, + "monthlyLicenseCost": 6568.5107999999991, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureSqlVirtualMachine": { + "suitabilitySummary": { + "suitableForSqlVM": 21, + "readinessUnknown": 2 + }, + "monthlyComputeCost": 889.49663999999962, + "monthlyStorageCost": 73.943999999999988, + "monthlyLicenseCost": 25281.36, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureSqlDatabase": { + "suitabilitySummary": { + "readinessUnknown": 1468, + "suitableForSqlDB": 16 + }, + "monthlyComputeCost": 175079.07398399821, + "monthlyStorageCost": 1054.8825000000395, + "monthlyLicenseCost": 214401.07883999476, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureVirtualMachine": { + "suitabilitySummary": { + "suitableForVM": 19 + }, + "monthlyComputeCost": 625.94207999999981, + "monthlyStorageCost": 374.48999999999995, + "monthlyLicenseCost": 1300.5120000000002, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "recommended": { + "suitabilitySummary": { + "suitableForSqlVM": 19, + "suitableForVM": 4 + }, + "monthlyComputeCost": 823.60799999999972, + "monthlyStorageCost": 100.88400000000002, + "monthlyLicenseCost": 22912.896, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + } + }, + "distributionBySupportStatus": { + "extended": 11, + "outOfSupport": 9, + "mainstream": 3 + }, + "distributionByServicePackInsight": { + "unknown": 23 + }, + "distributionBySqlVersion": { + "sql Server 2014": 4, + "sql Server 2012": 9, + "sql Server 2019": 3, + "sql Server 2016": 5, + "sql Server 2017": 2 + }, + "distributionBySqlEdition": { + "enterprise Edition: Core-based Licensing (64-bit)": 15, + "web Edition": 1, + "express Edition (64-bit)": 2, + "enterprise Evaluation Edition (64-bit)": 1, + "enterprise Edition: Core-based Licensing": 1, + "enterprise Edition (64-bit)": 1, + "standard Edition (64-bit)": 2 + }, + "instanceDistributionBySizingCriterion": { + "performanceBased": 0, + "asOnPremises": 0, + "perfBasedFallbackToAsOnPremises": 23 + }, + "databaseDistributionBySizingCriterion": { + "performanceBased": 0, + "asOnPremises": 0, + "perfBasedFallbackToAsOnPremises": 1484 + }, + "numberOfMachines": 19, + "numberOfSqlInstances": 23, + "numberOfSqlDatabases": 1484, + "numberOfFciInstances": 4, + "numberOfSqlAvailabilityGroups": 5 + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..7dad7d97a34b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,97 @@ +{ + "title": "SqlCollectorOperations_Create", + "operationId": "SqlCollectorOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "collectorName": "fci-test0c1esqlsitecollector", + "resource": { + "properties": { + "agentProperties": { + "id": "630da710-4d44-41f7-a189-72fe3db5502b-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "db9c4c3d-477c-4d5a-817b-318276713565", + "audience": "db9c4c3d-477c-4d5a-817b-318276713565", + "objectId": "e50236ad-ad07-47d4-af71-ed7b52d200d5", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/MasterSites/fci-ankit-test6065mastersite/SqlSites/fci-ankit-test6065sqlsites" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-test6904project/sqlcollectors/fci-test0c1esqlsitecollector", + "name": "fci-test0c1esqlsitecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/sqlcollectors", + "properties": { + "agentProperties": { + "id": "630da710-4d44-41f7-a189-72fe3db5502b-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "db9c4c3d-477c-4d5a-817b-318276713565", + "audience": "db9c4c3d-477c-4d5a-817b-318276713565", + "objectId": "e50236ad-ad07-47d4-af71-ed7b52d200d5", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/MasterSites/fci-ankit-test6065mastersite/SqlSites/fci-ankit-test6065sqlsites", + "createdTimestamp": "2022-11-22T09:50:37.1061418Z", + "updatedTimestamp": "2023-02-16T12:17:52.9185188Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-test6904project/sqlcollectors/fci-test0c1esqlsitecollector", + "name": "fci-test0c1esqlsitecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/sqlcollectors", + "properties": { + "agentProperties": { + "id": "630da710-4d44-41f7-a189-72fe3db5502b-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "db9c4c3d-477c-4d5a-817b-318276713565", + "audience": "db9c4c3d-477c-4d5a-817b-318276713565", + "objectId": "e50236ad-ad07-47d4-af71-ed7b52d200d5", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/MasterSites/fci-ankit-test6065mastersite/SqlSites/fci-ankit-test6065sqlsites", + "createdTimestamp": "2022-11-22T09:50:37.1061418Z", + "updatedTimestamp": "2023-02-16T12:17:52.9185188Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..6fcfd6243e85 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "SqlCollectorOperations_Delete", + "operationId": "SqlCollectorOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "collectorName": "fci-test0c1esqlsitecollector" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..8d8c73d771a5 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "SqlCollectorOperations_Get", + "operationId": "SqlCollectorOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "collectorName": "fci-test0c1esqlsitecollector" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-test6904project/sqlcollectors/fci-test0c1esqlsitecollector", + "name": "fci-test0c1esqlsitecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/sqlcollectors", + "properties": { + "agentProperties": { + "id": "630da710-4d44-41f7-a189-72fe3db5502b-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "db9c4c3d-477c-4d5a-817b-318276713565", + "audience": "db9c4c3d-477c-4d5a-817b-318276713565", + "objectId": "e50236ad-ad07-47d4-af71-ed7b52d200d5", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/MasterSites/fci-ankit-test6065mastersite/SqlSites/fci-ankit-test6065sqlsites", + "createdTimestamp": "2022-11-22T09:50:37.1061418Z", + "updatedTimestamp": "2023-02-16T12:17:52.9185188Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..9e322501d3ea --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "SqlCollectorOperations_ListByAssessmentProject", + "operationId": "SqlCollectorOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/sqlcollectors/fci-ankit-test0c1esqlsitecollector", + "name": "fci-ankit-test0c1esqlsitecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/sqlcollectors", + "properties": { + "agentProperties": { + "id": "630da710-4d44-41f7-a189-72fe3db5502b-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "db9c4c3d-477c-4d5a-817b-318276713565", + "audience": "db9c4c3d-477c-4d5a-817b-318276713565", + "objectId": "e50236ad-ad07-47d4-af71-ed7b52d200d5", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/MasterSites/fci-ankit-test6065mastersite/SqlSites/fci-ankit-test6065sqlsites", + "createdTimestamp": "2022-11-22T09:50:37.1061418Z", + "updatedTimestamp": "2023-02-16T12:17:52.9185188Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..6039ffa97e75 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,98 @@ +{ + "title": "VmwareCollectorsOperations_Create", + "operationId": "VmwareCollectorsOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "vmWareCollectorName": "Vmware2258collector", + "resource": { + "properties": { + "agentProperties": { + "id": "fe243486-3318-41fa-aaba-c48b5df75308", + "version": "1.0.8.383", + "lastHeartbeatUtc": "2022-03-29T12:10:08.9167289Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "82b3e452-c0e8-4662-8347-58282925ae84", + "audience": "82b3e452-c0e8-4662-8347-58282925ae84", + "objectId": "3fc89111-1405-4938-9214-37aa4739401d", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/Vmware2744site", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/vmwarecollectors/Vmware2258collector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "Vmware2258collector", + "type": "Microsoft.Migrate/assessmentprojects/vmwarecollectors", + "properties": { + "agentProperties": { + "id": "fe243486-3318-41fa-aaba-c48b5df75308", + "version": "1.0.8.383", + "lastHeartbeatUtc": "2022-03-29T12:10:08.9167289Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "82b3e452-c0e8-4662-8347-58282925ae84", + "audience": "82b3e452-c0e8-4662-8347-58282925ae84", + "objectId": "3fc89111-1405-4938-9214-37aa4739401d", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/Vmware2744site", + "createdTimestamp": "2022-03-28T13:41:17.5560477Z", + "updatedTimestamp": "2023-02-16T12:23:45.9695649Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/vmwarecollectors/Vmware2258collector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "Vmware2258collector", + "type": "Microsoft.Migrate/assessmentprojects/vmwarecollectors", + "properties": { + "agentProperties": { + "id": "fe243486-3318-41fa-aaba-c48b5df75308", + "version": "1.0.8.383", + "lastHeartbeatUtc": "2022-03-29T12:10:08.9167289Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "82b3e452-c0e8-4662-8347-58282925ae84", + "audience": "82b3e452-c0e8-4662-8347-58282925ae84", + "objectId": "3fc89111-1405-4938-9214-37aa4739401d", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/Vmware2744site", + "createdTimestamp": "2022-03-28T13:41:17.5560477Z", + "updatedTimestamp": "2023-02-16T12:23:45.9695649Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..99c229a6db40 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "VmwareCollectorsOperations_Delete", + "operationId": "VmwareCollectorsOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "vmWareCollectorName": "Vmware2258collector" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..05f39123a1ab --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "VmwareCollectorsOperations_Get", + "operationId": "VmwareCollectorsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "vmWareCollectorName": "Vmware2258collector" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/vmwarecollectors/Vmware2258collector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "Vmware2258collector", + "type": "Microsoft.Migrate/assessmentprojects/vmwarecollectors", + "properties": { + "agentProperties": { + "id": "fe243486-3318-41fa-aaba-c48b5df75308", + "version": "1.0.8.383", + "lastHeartbeatUtc": "2022-03-29T12:10:08.9167289Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "82b3e452-c0e8-4662-8347-58282925ae84", + "audience": "82b3e452-c0e8-4662-8347-58282925ae84", + "objectId": "3fc89111-1405-4938-9214-37aa4739401d", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/Vmware2744site", + "createdTimestamp": "2022-03-28T13:41:17.5560477Z", + "updatedTimestamp": "2023-02-16T12:23:45.9695649Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..c819f602be15 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "VmwareCollectorsOperations_ListByAssessmentProject", + "operationId": "VmwareCollectorsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/vmwarecollectors/Vmware2258collector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "Vmware2258collector", + "type": "Microsoft.Migrate/assessmentprojects/vmwarecollectors", + "properties": { + "agentProperties": { + "id": "fe243486-3318-41fa-aaba-c48b5df75308", + "version": "1.0.8.383", + "lastHeartbeatUtc": "2022-03-29T12:10:08.9167289Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "82b3e452-c0e8-4662-8347-58282925ae84", + "audience": "82b3e452-c0e8-4662-8347-58282925ae84", + "objectId": "3fc89111-1405-4938-9214-37aa4739401d", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/Vmware2744site", + "createdTimestamp": "2022-03-28T13:41:17.5560477Z", + "updatedTimestamp": "2023-02-16T12:23:45.9695649Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..b48e8c4873c4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,56 @@ +{ + "title": "WebAppAssessmentOptionsOperations_Get", + "operationId": "WebAppAssessmentOptionsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "assessmentOptionsName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "webAppSkus": [ + { + "webAppTier": "Premium_V3", + "targetLocations": [ + "WestEurope" + ] + } + ], + "savingsPlanSupportedLocations": [ + "WestEurope" + ], + "reservedInstanceSupportedLocations": [ + "WestEurope" + ], + "reservedInstanceSupportedCurrencies": [ + "USD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P" + ], + "reservedInstanceSupportedWebAppTiers": [ + "Premium_V3" + ], + "savingsPlanSupportedWebAppTiers": [ + "Premium_V3" + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webAppAssessmentOptions/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/webAppAssessmentOptions", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..d3a440e7fb3b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,60 @@ +{ + "title": "WebAppAssessmentOptionsOperations_ListByAssessmentProject", + "operationId": "WebAppAssessmentOptionsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "92EA264C-A8A7-4192-A5E5-D9B487409240", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "webAppSkus": [ + { + "webAppTier": "Premium_V3", + "targetLocations": [ + "PolandCentral" + ] + } + ], + "savingsPlanSupportedLocations": [ + "Unknown" + ], + "reservedInstanceSupportedLocations": [ + "AustraliaSoutheast" + ], + "reservedInstanceSupportedCurrencies": [ + "USD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P" + ], + "reservedInstanceSupportedWebAppTiers": [ + "Premium_V3" + ], + "savingsPlanSupportedWebAppTiers": [ + "Premium_V3" + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webAppAssessmentOptions/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/webAppAssessmentOptions", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-06T05:40:17.507Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-06T05:40:17.507Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..bb14673c0e02 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Create_MaximumSet_Gen.json @@ -0,0 +1,167 @@ +{ + "title": "WebAppAssessmentV2Operations_Create_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2Operations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2", + "resource": { + "properties": { + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 18, + "hoursPerDay": 13 + }, + "eaSubscriptionId": "", + "appSvcNativeSettings": { + "isolationRequired": true + }, + "appSvcContainerSettings": { + "isolationRequired": true + }, + "discoveredEntityLightSummary": { + "numberOfServers": 5, + "numberOfWebApps": 23, + "numberOfMachines": 27 + }, + "azureSecurityOfferingType": "NO", + "reservedInstance": "None", + "groupType": "Default", + "assessmentType": "WebAppAssessment", + "azureLocation": "UkWest", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 17, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-11-03T05:42:45.496Z", + "perfDataEndTime": "2023-11-03T05:42:45.496Z", + "stage": "InProgress", + "discountPercentage": 13, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 13, + "status": "Created" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 18, + "hoursPerDay": 13 + }, + "eaSubscriptionId": "", + "appSvcNativeSettings": { + "isolationRequired": true + }, + "appSvcContainerSettings": { + "isolationRequired": true + }, + "discoveredEntityLightSummary": { + "numberOfServers": 5, + "numberOfWebApps": 23, + "numberOfMachines": 27 + }, + "azureSecurityOfferingType": "NO", + "reservedInstance": "None", + "groupType": "Default", + "assessmentType": "WebAppAssessment", + "azureLocation": "UkWest", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 17, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-11-03T05:42:45.496Z", + "perfDataEndTime": "2023-11-03T05:42:45.496Z", + "stage": "InProgress", + "discountPercentage": 13, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 13, + "pricesTimestamp": "2023-11-03T05:42:45.496Z", + "createdTimestamp": "2023-11-03T05:42:45.496Z", + "updatedTimestamp": "2023-11-03T05:42:45.496Z", + "status": "Created", + "schemaVersion": "2.0", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-v2-test", + "name": "anraghun-v2-test", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": "eatnpvdxza", + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": "rnfkzoaidy", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 18, + "hoursPerDay": 13 + }, + "eaSubscriptionId": "", + "appSvcNativeSettings": { + "isolationRequired": true + }, + "appSvcContainerSettings": { + "isolationRequired": true + }, + "discoveredEntityLightSummary": { + "numberOfServers": 5, + "numberOfWebApps": 23, + "numberOfMachines": 27 + }, + "azureSecurityOfferingType": "NO", + "reservedInstance": "None", + "groupType": "Default", + "assessmentType": "WebAppAssessment", + "azureLocation": "UkWest", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 17, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-11-03T05:42:45.496Z", + "perfDataEndTime": "2023-11-03T05:42:45.496Z", + "stage": "InProgress", + "discountPercentage": 13, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 13, + "pricesTimestamp": "2023-11-03T05:42:45.496Z", + "createdTimestamp": "2023-11-03T05:42:45.496Z", + "updatedTimestamp": "2023-11-03T05:42:45.496Z", + "status": "Created", + "schemaVersion": "2.0", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-v2-test", + "name": "anraghun-v2-test", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": "eatnpvdxza", + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": "rnfkzoaidy", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..ab39129ddebd --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "WebAppAssessmentV2Operations_Delete_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2Operations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..15631ba5ae4d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2Operations_DownloadUrl", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2", + "body": {} + }, + "responses": { + "200": { + "body": { + "assessmentReportUrl": "https://assessmentsrvcanccysa2.blob.core.windows.net/cc1325ff-d42f-4c45-bfb6-12069e45becb/anraghun-selfhost-v2anraghun-v2-testWebAppAssessment.xlsx?sv=2018-03-28&sr=b&sig=NYBG6gJmofvIQsk1K1tewWfX51BpFZWsvIy7gBXNYUE%3D&st=2023-11-03T05%3A51%3A39Z&se=2023-11-03T06%3A26%3A39Z&sp=r", + "expirationTime": "2023-11-03T05:42:09.465Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..53b3facf4279 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,70 @@ +{ + "title": "WebAppAssessmentV2Operations_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2Operations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-v2-test" + }, + "responses": { + "200": { + "body": { + "properties": { + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 18, + "hoursPerDay": 13 + }, + "eaSubscriptionId": "", + "appSvcNativeSettings": { + "isolationRequired": true + }, + "appSvcContainerSettings": { + "isolationRequired": true + }, + "discoveredEntityLightSummary": { + "numberOfServers": 5, + "numberOfWebApps": 23, + "numberOfMachines": 27 + }, + "azureSecurityOfferingType": "NO", + "reservedInstance": "None", + "groupType": "Default", + "assessmentType": "WebAppAssessment", + "azureLocation": "UkWest", + "azureOfferCode": "Unknown", + "currency": "MSAZR0003P", + "scalingFactor": 17, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-11-03T05:42:45.496Z", + "perfDataEndTime": "2023-11-03T05:42:45.496Z", + "stage": "InProgress", + "discountPercentage": 13, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 13, + "pricesTimestamp": "2023-11-03T05:42:45.496Z", + "createdTimestamp": "2023-11-03T05:42:45.496Z", + "updatedTimestamp": "2023-11-03T05:42:45.496Z", + "status": "Created", + "schemaVersion": "2.0", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2", + "name": "anraghun-selfhost-v2", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..e64efd28c39f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json @@ -0,0 +1,74 @@ +{ + "title": "WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2Operations_ListByGroup", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 18, + "hoursPerDay": 13 + }, + "eaSubscriptionId": "", + "appSvcNativeSettings": { + "isolationRequired": true + }, + "appSvcContainerSettings": { + "isolationRequired": true + }, + "discoveredEntityLightSummary": { + "numberOfServers": 5, + "numberOfWebApps": 23, + "numberOfMachines": 27 + }, + "azureSecurityOfferingType": "NO", + "reservedInstance": "None", + "groupType": "Default", + "assessmentType": "WebAppAssessment", + "azureLocation": "UkWest", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 17, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-11-03T05:42:45.496Z", + "perfDataEndTime": "2023-11-03T05:42:45.496Z", + "stage": "InProgress", + "discountPercentage": 13, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 13, + "pricesTimestamp": "2023-11-03T05:42:45.496Z", + "createdTimestamp": "2023-11-03T05:42:45.496Z", + "updatedTimestamp": "2023-11-03T05:42:45.496Z", + "status": "Created", + "schemaVersion": "2.0", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2", + "name": "anraghun-selfhost-v2", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..b4792774b016 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,61 @@ +{ + "title": "WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2SummaryOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2", + "summaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "assessmentSummary": { + "discoveredEntitiesSummary": { + "numberOfServers": 15, + "numberOfWebApps": 6, + "numberOfMachines": 24, + "webServerSummary": { + "iis": 13 + }, + "webAppSummary": { + "iis": 30 + } + } + }, + "targetSpecificSummary": { + "azureAppService": { + "readinessSummary": { + "suitable": 13 + }, + "recommendationResultSkuDetails": { + "isolated": { + "totalMonthlyCost": 21, + "monthlySecurityCost": 3, + "skuName": "Isolated", + "skuSize": "I1", + "appServicePlanCount": 4 + } + } + } + } + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2/summaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..a10fdde3de45 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,65 @@ +{ + "title": "WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "assessmentSummary": { + "discoveredEntitiesSummary": { + "numberOfServers": 15, + "numberOfWebApps": 6, + "numberOfMachines": 24, + "webServerSummary": { + "iis": 13 + }, + "webAppSummary": { + "iis": 30 + } + } + }, + "targetSpecificSummary": { + "azureAppService": { + "readinessSummary": { + "conditionallySuitable": 13 + }, + "recommendationResultSkuDetails": { + "isolated": { + "totalMonthlyCost": 584, + "monthlySecurityCost": 0, + "skuName": "Isolated", + "skuSize": "I1", + "appServicePlanCount": 2 + } + } + } + } + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2/summaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + ], + "nextLink": "https://microsoft.com/anxenhw" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..9339ee47caf4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,99 @@ +{ + "title": "WebAppCollectorOperations_Create", + "operationId": "WebAppCollectorOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "collectorName": "collector1", + "resource": { + "properties": { + "agentProperties": { + "id": "fed93df5-b787-4e3f-a764-e3d2b9101a59-agent", + "version": null, + "lastHeartbeatUtc": "2023-11-03T05:43:02.078Z", + "spnDetails": { + "authority": "https://login.microsoftonline.com/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "audience": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "objectId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "tenantId": "2f70d5e8-7adc-4c64-910a-7031079efc6e" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.OffAzure/MasterSites/sumukk-ccy-bcs9880mastersite/WebAppSites/sumukk-ccy-bcs9880webappsites" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "agentProperties": { + "id": "fed93df5-b787-4e3f-a764-e3d2b9101a59-agent", + "version": null, + "lastHeartbeatUtc": "2023-11-03T05:43:02.078Z", + "spnDetails": { + "authority": "https://login.microsoftonline.com/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "audience": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "objectId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "tenantId": "2f70d5e8-7adc-4c64-910a-7031079efc6e" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.OffAzure/MasterSites/sumukk-ccy-bcs9880mastersite/WebAppSites/sumukk-ccy-bcs9880webappsites", + "createdTimestamp": "2023-11-03T05:43:02.078Z", + "updatedTimestamp": "2023-11-03T05:43:02.078Z", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webappcollectors/sumukk-ccy-bcs4a93webappsitecollector", + "name": "sumukk-ccy-bcs4a93webappsitecollector", + "type": "Microsoft.Migrate/assessmentprojects/webappcollectors", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "agentProperties": { + "id": "fed93df5-b787-4e3f-a764-e3d2b9101a59-agent", + "version": null, + "lastHeartbeatUtc": "2023-11-03T05:43:02.078Z", + "spnDetails": { + "authority": "https://login.microsoftonline.com/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "audience": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "objectId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "tenantId": "2f70d5e8-7adc-4c64-910a-7031079efc6e" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.OffAzure/MasterSites/sumukk-ccy-bcs9880mastersite/WebAppSites/sumukk-ccy-bcs9880webappsites", + "createdTimestamp": "2023-11-03T05:43:02.078Z", + "updatedTimestamp": "2023-11-03T05:43:02.078Z", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webappcollectors/sumukk-ccy-bcs4a93webappsitecollector", + "name": "sumukk-ccy-bcs4a93webappsitecollector", + "type": "Microsoft.Migrate/assessmentprojects/webappcollectors", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..a451d12ce142 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "WebAppCollectorOperations_Delete", + "operationId": "WebAppCollectorOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "collectorName": "collector1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..2b35e4770378 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "WebAppCollectorOperations_Get", + "operationId": "WebAppCollectorOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "collectorName": "collector1" + }, + "responses": { + "200": { + "body": { + "properties": { + "agentProperties": { + "id": "fed93df5-b787-4e3f-a764-e3d2b9101a59-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.microsoftonline.com/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "audience": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "objectId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "tenantId": "2f70d5e8-7adc-4c64-910a-7031079efc6e" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.OffAzure/MasterSites/sumukk-ccy-bcs9880mastersite/WebAppSites/sumukk-ccy-bcs9880webappsites", + "createdTimestamp": "2023-11-03T05:43:02.078Z", + "updatedTimestamp": "2023-11-03T05:43:02.078Z", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webappcollectors/sumukk-ccy-bcs4a93webappsitecollector", + "name": "sumukk-ccy-bcs4a93webappsitecollector", + "type": "Microsoft.Migrate/assessmentprojects/webappcollectors", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..216dd036df36 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,50 @@ +{ + "title": "WebAppCollectorOperations_ListByAssessmentProject", + "operationId": "WebAppCollectorOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "agentProperties": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webappcollectors/sumukk-ccy-bcs4a93webappsitecollector", + "version": null, + "lastHeartbeatUtc": "2023-11-03T05:43:02.078Z", + "spnDetails": { + "authority": "https://login.microsoftonline.com/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "audience": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "objectId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "tenantId": "2f70d5e8-7adc-4c64-910a-7031079efc6e" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.OffAzure/MasterSites/sumukk-ccy-bcs9880mastersite/WebAppSites/sumukk-ccy-bcs9880webappsites", + "createdTimestamp": "2023-11-03T05:43:02.078Z", + "updatedTimestamp": "2023-11-03T05:43:02.078Z", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webappcollectors/sumukk-ccy-bcs4a93webappsitecollector", + "name": "sumukk-ccy-bcs4a93webappsitecollector", + "type": "Microsoft.Migrate/assessmentprojects/webappcollectors", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppServicePlanV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppServicePlanV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..53fceead7c22 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppServicePlanV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,52 @@ +{ + "title": "WebAppServicePlanV2Operations_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppServicePlanV2Operations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2", + "webAppServicePlanName": "plan-001" + }, + "responses": { + "200": { + "body": { + "properties": { + "webAppType": "IIS", + "webAppTargetType": "AzureAppService", + "webAppServicePlanName": "Plan-001", + "numberOfWebApps": 2, + "monthlyCost": 20, + "storage": 25, + "scaleOutInstances": 8, + "cores": 17, + "ram": 18, + "webAppSkuName": "Isolated", + "webAppSkuSize": "I1", + "createdTimestamp": "2023-11-03T05:42:59.387Z", + "updatedTimestamp": "2023-11-03T05:42:59.387Z", + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 16, + "description": null + } + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2/webAppServicePlans/plan-002-azureappservice", + "name": "plan-002-azureappservice", + "type": "Microsoft.Migrate/assessmentprojects/groups/webAppAssessments/webAppServicePlans", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..95878e631a15 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,60 @@ +{ + "title": "WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppServicePlanV2Operations_ListByWebAppAssessmentV2", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "$filter": "okepiszphg", + "pageSize": 18, + "$skipToken": "hcpyxryhoumfkypulwpsxxkzuu", + "totalRecordCount": 14, + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "webAppType": "IIS", + "webAppTargetType": "AzureAppService", + "webAppServicePlanName": "Plan-001", + "numberOfWebApps": 2, + "monthlyCost": 20, + "storage": 25, + "scaleOutInstances": 8, + "cores": 17, + "ram": 18, + "webAppSkuName": "Isolated", + "webAppSkuSize": "I1", + "createdTimestamp": "2023-11-03T05:42:59.387Z", + "updatedTimestamp": "2023-11-03T05:42:59.387Z", + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 16, + "description": null + } + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2/webAppServicePlans/plan-002-azureappservice", + "name": "plan-002-azureappservice", + "type": "Microsoft.Migrate/assessmentprojects/groups/webAppAssessments/webAppServicePlans", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/migrate.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/migrate.json new file mode 100644 index 000000000000..4780abbd83fd --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/migrate.json @@ -0,0 +1,24820 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Migrate Assessment Service", + "version": "2023-05-01-preview", + "description": "Azure Migrate Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "AssessmentProjectsOperations" + }, + { + "name": "AssessmentProjectSummaryOperations" + }, + { + "name": "MachinesOperations" + }, + { + "name": "GroupsOperations" + }, + { + "name": "AssessmentsOperations" + }, + { + "name": "AssessmentOptionsOperations" + }, + { + "name": "AssessedMachinesOperations" + }, + { + "name": "HypervCollectorsOperations" + }, + { + "name": "VmwareCollectorsOperations" + }, + { + "name": "ServerCollectorsOperations" + }, + { + "name": "ImportCollectorsOperations" + }, + { + "name": "PrivateEndpointConnectionOperations" + }, + { + "name": "PrivateLinkResourceOperations" + }, + { + "name": "AvsAssessmentsOperations" + }, + { + "name": "AvsAssessmentOptionsOperations" + }, + { + "name": "AvsAssessedMachinesOperations" + }, + { + "name": "SqlAssessmentV2SummaryOperations" + }, + { + "name": "SqlAssessmentV2Operations" + }, + { + "name": "SqlAssessmentOptionsOperations" + }, + { + "name": "AssessedSqlMachinesOperations" + }, + { + "name": "AssessedSqlRecommendedEntityOperations" + }, + { + "name": "AssessedSqlInstanceV2Operations" + }, + { + "name": "AssessedSqlDatabaseV2Operations" + }, + { + "name": "SqlCollectorOperations" + }, + { + "name": "WebAppAssessmentV2SummaryOperations" + }, + { + "name": "WebAppAssessmentV2Operations" + }, + { + "name": "WebAppAssessmentOptionsOperations" + }, + { + "name": "AssessedWebAppV2Operations" + }, + { + "name": "WebAppServicePlanV2Operations" + }, + { + "name": "WebAppCollectorOperations" + }, + { + "name": "BusinessCaseOperations" + }, + { + "name": "BusinessCaseIaasSummaryOperations" + }, + { + "name": "BusinessCasePaasSummaryOperations" + }, + { + "name": "BusinessCaseOverviewSummaryOperations" + }, + { + "name": "BusinessCaseAvsSummaryOperations" + }, + { + "name": "EvaluatedMachinesOperations" + }, + { + "name": "EvaluatedSqlEntitiesOperations" + }, + { + "name": "EvaluatedWebAppsOperations" + }, + { + "name": "EvaluatedAvsMachinesOperations" + }, + { + "name": "AKSAssessmentOperations" + }, + { + "name": "AssessedWebApplicationOperations" + }, + { + "name": "AKSOptionsOperations" + }, + { + "name": "AKSSummaryOperations" + }, + { + "name": "AKSClusterOperations" + }, + { + "name": "AKSCostDetailOperations" + } + ], + "paths": { + "/providers/Microsoft.Migrate/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List_MaximumSet_Gen": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Migrate/assessmentProjects": { + "get": { + "operationId": "AssessmentProjectsOperations_ListBySubscription", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "List AssessmentProject resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProjectListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects": { + "get": { + "operationId": "AssessmentProjectsOperations_ListByResourceGroup", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "List AssessmentProject resources by resource group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProjectListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}": { + "get": { + "operationId": "AssessmentProjectsOperations_Get", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "Get a AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProject" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentProjectsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "AssessmentProjectsOperations_Create", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "Create a AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AssessmentProject" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AssessmentProject' update operation succeeded", + "schema": { + "$ref": "#/definitions/AssessmentProject" + } + }, + "201": { + "description": "Resource 'AssessmentProject' create operation succeeded", + "schema": { + "$ref": "#/definitions/AssessmentProject" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AssessmentProjectsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "AssessmentProjectsOperations_Update", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "Update a AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AssessmentProjectUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProject" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AssessmentProjectsOperations_Update_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "AssessmentProjectsOperations_Delete", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "Delete a AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentProjectsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessmentOptions": { + "get": { + "operationId": "AksOptionsOperations_ListByAssessmentProject", + "tags": [ + "AKSOptionsOperations" + ], + "description": "List AKSAssessmentOptions resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSAssessmentOptionsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessmentOptions/{assessmentOptionsName}": { + "get": { + "operationId": "AksOptionsOperations_Get", + "tags": [ + "AKSOptionsOperations" + ], + "description": "Get a AKSAssessmentOptions", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentOptionsName", + "in": "path", + "description": "AKS Assessment Options Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSAssessmentOptions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AksOptionsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AksOptionsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments": { + "get": { + "operationId": "AksAssessmentOperations_ListByAssessmentProject", + "tags": [ + "AKSAssessmentOperations" + ], + "description": "List AKSAssessment resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Continuation Token Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Page Size Query Parameter.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total Record Count Query Parameter.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSAssessmentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}": { + "get": { + "operationId": "AksAssessmentOperations_Get", + "tags": [ + "AKSAssessmentOperations" + ], + "description": "Get a AKSAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSAssessment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AksAssessmentOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AksAssessmentOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "AksAssessmentOperations_Create", + "tags": [ + "AKSAssessmentOperations" + ], + "description": "Create a AKSAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AKSAssessment" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AKSAssessment' update operation succeeded", + "schema": { + "$ref": "#/definitions/AKSAssessment" + } + }, + "201": { + "description": "Resource 'AKSAssessment' create operation succeeded", + "schema": { + "$ref": "#/definitions/AKSAssessment" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AksAssessmentOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/AksAssessmentOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "AksAssessmentOperations_Delete", + "tags": [ + "AKSAssessmentOperations" + ], + "description": "Delete a AKSAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AksAssessmentOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/AksAssessmentOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/assessedWebApps": { + "get": { + "operationId": "AssessedWebApplicationOperations_ListByAksAssessment", + "tags": [ + "AssessedWebApplicationOperations" + ], + "description": "List AssessedWebApplication resources by AKSAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Continuation Token Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Page Size Query Parameter.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total Record Count Query Parameter.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedWebApplicationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen": { + "$ref": "./examples/AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/assessedWebApps/{assessedWorkload}": { + "get": { + "operationId": "AssessedWebApplicationOperations_Get", + "tags": [ + "AssessedWebApplicationOperations" + ], + "description": "Get a AssessedWebApplication", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedWorkload", + "in": "path", + "description": "Assessed Web Application Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedWebApplication" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedWebApplicationOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedWebApplicationOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/clusters": { + "get": { + "operationId": "AksClusterOperations_ListByAksAssessment", + "tags": [ + "AKSClusterOperations" + ], + "description": "List AKSCluster resources by AKSAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AksClusterOperations_ListByAksAssessment_MaximumSet_Gen": { + "$ref": "./examples/AksClusterOperations_ListByAksAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/clusters/{clusterName}": { + "get": { + "operationId": "AksClusterOperations_Get", + "tags": [ + "AKSClusterOperations" + ], + "description": "Get a AKSCluster", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "clusterName", + "in": "path", + "description": "AKS Cluster Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSCluster" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AksClusterOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AksClusterOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/costDetails": { + "get": { + "operationId": "AksCostDetailOperations_ListByAksAssessment", + "tags": [ + "AKSCostDetailOperations" + ], + "description": "List AKSCostDetail resources by AKSAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSCostDetailListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen": { + "$ref": "./examples/AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/downloadUrl": { + "post": { + "operationId": "AksAssessmentOperations_DownloadUrl", + "tags": [ + "AKSAssessmentOperations" + ], + "description": "Get URL for downloading AKS Assessment Report.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AksAssessmentOperations_DownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/AksAssessmentOperations_DownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/summaries": { + "get": { + "operationId": "AksSummaryOperations_ListByAksAssessment", + "tags": [ + "AKSSummaryOperations" + ], + "description": "List AKSSummary resources by AKSAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen": { + "$ref": "./examples/AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/summaries/{summaryName}": { + "get": { + "operationId": "AksSummaryOperations_Get", + "tags": [ + "AKSSummaryOperations" + ], + "description": "Get a AKSSummary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "summaryName", + "in": "path", + "description": "AKS Assessment Summary Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AksSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AksSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/assessmentOptions": { + "get": { + "operationId": "AssessmentOptionsOperations_ListByAssessmentProject", + "tags": [ + "AssessmentOptionsOperations" + ], + "description": "List AssessmentOptions resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentOptionsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/assessmentOptions/{assessmentOptionsName}": { + "get": { + "operationId": "AssessmentOptionsOperations_Get", + "tags": [ + "AssessmentOptionsOperations" + ], + "description": "Get a AssessmentOptions", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentOptionsName", + "in": "path", + "description": " assessment options ARM name. Accepted value is 'default'", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentOptions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentOptionsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessmentOptionsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/avsAssessmentOptions": { + "get": { + "operationId": "AvsAssessmentOptionsOperations_ListByAssessmentProject", + "tags": [ + "AvsAssessmentOptionsOperations" + ], + "description": "List AvsAssessmentOptions resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessmentOptionsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/avsAssessmentOptions/{avsAssessmentOptionsName}": { + "get": { + "operationId": "AvsAssessmentOptionsOperations_Get", + "tags": [ + "AvsAssessmentOptionsOperations" + ], + "description": "Get a AvsAssessmentOptions", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "avsAssessmentOptionsName", + "in": "path", + "description": "AVS Assessment options ARM name. Accepted value is 'default'", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessmentOptions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AvsAssessmentOptionsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentOptionsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases": { + "get": { + "operationId": "BusinessCaseOperations_ListByAssessmentProject", + "tags": [ + "BusinessCaseOperations" + ], + "description": "List BusinessCase resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/BusinessCaseListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}": { + "get": { + "operationId": "BusinessCaseOperations_Get", + "tags": [ + "BusinessCaseOperations" + ], + "description": "Get a BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/BusinessCase" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCaseOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "BusinessCaseOperations_Create", + "tags": [ + "BusinessCaseOperations" + ], + "description": "Create a BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/BusinessCase" + } + } + ], + "responses": { + "200": { + "description": "Resource 'BusinessCase' update operation succeeded", + "schema": { + "$ref": "#/definitions/BusinessCase" + } + }, + "201": { + "description": "Resource 'BusinessCase' create operation succeeded", + "schema": { + "$ref": "#/definitions/BusinessCase" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BusinessCaseOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "BusinessCaseOperations_Delete", + "tags": [ + "BusinessCaseOperations" + ], + "description": "Delete a BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCaseOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/avsSummaries": { + "get": { + "operationId": "BusinessCaseAvsSummaryOperations_ListByBusinessCase", + "tags": [ + "BusinessCaseAvsSummaryOperations" + ], + "description": "List AvsSummary resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/avsSummaries/{avsSummaryName}": { + "get": { + "operationId": "BusinessCaseAvsSummaryOperations_Get", + "tags": [ + "BusinessCaseAvsSummaryOperations" + ], + "description": "Get a AvsSummary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "avsSummaryName", + "in": "path", + "description": "Gets the Name of the Avs Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/compareSummary": { + "post": { + "operationId": "BusinessCaseOperations_CompareSummary", + "tags": [ + "BusinessCaseOperations" + ], + "summary": "Get Compare summary report for Business case.", + "description": "A long-running resource action.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/CompareSummary" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BusinessCaseOperations_CompareSummary_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_CompareSummary_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedAvsMachines": { + "get": { + "operationId": "EvaluatedAvsMachinesOperations_ListByBusinessCase", + "tags": [ + "EvaluatedAvsMachinesOperations" + ], + "description": "List EvaluatedAvsMachine resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedAvsMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedAvsMachines/{evaluatedAvsMachineName}": { + "get": { + "operationId": "EvaluatedAvsMachinesOperations_Get", + "tags": [ + "EvaluatedAvsMachinesOperations" + ], + "description": "Get a EvaluatedAvsMachine", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "evaluatedAvsMachineName", + "in": "path", + "description": "Business case Evaluated AVS machine ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedAvsMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedMachines": { + "get": { + "operationId": "EvaluatedMachinesOperations_ListByBusinessCase", + "tags": [ + "EvaluatedMachinesOperations" + ], + "description": "List EvaluatedMachine resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedMachines/{evaluatedMachineName}": { + "get": { + "operationId": "EvaluatedMachinesOperations_Get", + "tags": [ + "EvaluatedMachinesOperations" + ], + "description": "Get a EvaluatedMachine", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "evaluatedMachineName", + "in": "path", + "description": "Business case Evaluated machine ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EvaluatedMachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedMachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedSqlEntities": { + "get": { + "operationId": "EvaluatedSqlEntitiesOperations_ListByBusinessCase", + "tags": [ + "EvaluatedSqlEntitiesOperations" + ], + "description": "List EvaluatedSqlEntity resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedSqlEntityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedSqlEntities/{evaluatedSqlEntityName}": { + "get": { + "operationId": "EvaluatedSqlEntitiesOperations_Get", + "tags": [ + "EvaluatedSqlEntitiesOperations" + ], + "description": "Get a EvaluatedSqlEntity", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "evaluatedSqlEntityName", + "in": "path", + "description": "Business case Evaluated sql entity ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedSqlEntity" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedWebApps": { + "get": { + "operationId": "EvaluatedWebAppsOperations_ListByBusinessCase", + "tags": [ + "EvaluatedWebAppsOperations" + ], + "description": "List EvaluatedWebApp resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedWebAppListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedWebApps/{evaluatedWebAppName}": { + "get": { + "operationId": "EvaluatedWebAppsOperations_Get", + "tags": [ + "EvaluatedWebAppsOperations" + ], + "description": "Get a EvaluatedWebApp", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "evaluatedWebAppName", + "in": "path", + "description": "Business case Evaluated web App ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedWebApp" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EvaluatedWebAppsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedWebAppsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/getReportDownloadUrl": { + "post": { + "operationId": "BusinessCaseOperations_GetReportDownloadUrl", + "tags": [ + "BusinessCaseOperations" + ], + "summary": "Get download URL for the business case report.", + "description": "Get the URL for downloading the business case in a report format.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ReportDownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/iaasSummaries": { + "get": { + "operationId": "BusinessCaseIaasSummaryOperations_ListByBusinessCase", + "tags": [ + "BusinessCaseIaasSummaryOperations" + ], + "description": "List IaasSummary resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/IaasSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/iaasSummaries/{iaasSummaryName}": { + "get": { + "operationId": "BusinessCaseIaasSummaryOperations_Get", + "tags": [ + "BusinessCaseIaasSummaryOperations" + ], + "description": "Get a IaasSummary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "iaasSummaryName", + "in": "path", + "description": "Gets the Name of the Iaas Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/IaasSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/overviewSummaries": { + "get": { + "operationId": "BusinessCaseOverviewSummaryOperations_ListByBusinessCase", + "tags": [ + "BusinessCaseOverviewSummaryOperations" + ], + "description": "List OverviewSummary resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/OverviewSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/overviewSummaries/{overviewSummaryName}": { + "get": { + "operationId": "BusinessCaseOverviewSummaryOperations_Get", + "tags": [ + "BusinessCaseOverviewSummaryOperations" + ], + "description": "Get a OverviewSummary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "overviewSummaryName", + "in": "path", + "description": "Gets the Name of the Overview Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/OverviewSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/paasSummaries": { + "get": { + "operationId": "BusinessCasePaasSummaryOperations_ListByBusinessCase", + "tags": [ + "BusinessCasePaasSummaryOperations" + ], + "description": "List PaasSummary resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PaasSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/paasSummaries/{paasSummaryName}": { + "get": { + "operationId": "BusinessCasePaasSummaryOperations_Get", + "tags": [ + "BusinessCasePaasSummaryOperations" + ], + "description": "Get a PaasSummary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "paasSummaryName", + "in": "path", + "description": "Gets the Name of the Paas Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PaasSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups": { + "get": { + "operationId": "GroupsOperations_ListByAssessmentProject", + "tags": [ + "GroupsOperations" + ], + "description": "List Group resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/GroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GroupsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/GroupsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}": { + "get": { + "operationId": "GroupsOperations_Get", + "tags": [ + "GroupsOperations" + ], + "description": "Get a Group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Group" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GroupsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/GroupsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "GroupsOperations_Create", + "tags": [ + "GroupsOperations" + ], + "description": "Create a Group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Group" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Group' update operation succeeded", + "schema": { + "$ref": "#/definitions/Group" + } + }, + "201": { + "description": "Resource 'Group' create operation succeeded", + "schema": { + "$ref": "#/definitions/Group" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "GroupsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/GroupsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "GroupsOperations_Delete", + "tags": [ + "GroupsOperations" + ], + "description": "Delete a Group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GroupsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/GroupsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments": { + "get": { + "operationId": "AssessmentsOperations_ListByGroup", + "tags": [ + "AssessmentsOperations" + ], + "description": "List Assessment resources by Group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessmentsOperations_ListByGroup_MaximumSet_Gen": { + "$ref": "./examples/AssessmentsOperations_ListByGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}": { + "get": { + "operationId": "AssessmentsOperations_Get", + "tags": [ + "AssessmentsOperations" + ], + "description": "Get a Assessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Assessment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessmentsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "AssessmentsOperations_Create", + "tags": [ + "AssessmentsOperations" + ], + "description": "Create a Assessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Assessment" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Assessment' update operation succeeded", + "schema": { + "$ref": "#/definitions/Assessment" + } + }, + "201": { + "description": "Resource 'Assessment' create operation succeeded", + "schema": { + "$ref": "#/definitions/Assessment" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AssessmentsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/AssessmentsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "AssessmentsOperations_Delete", + "tags": [ + "AssessmentsOperations" + ], + "description": "Delete a Assessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/AssessmentsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}/assessedMachines": { + "get": { + "operationId": "AssessedMachinesOperations_ListByAssessment", + "tags": [ + "AssessedMachinesOperations" + ], + "description": "List AssessedMachine resources by Assessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen": { + "$ref": "./examples/AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}/assessedMachines/{assessedMachineName}": { + "get": { + "operationId": "AssessedMachinesOperations_Get", + "tags": [ + "AssessedMachinesOperations" + ], + "description": "Get a AssessedMachine", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedMachineName", + "in": "path", + "description": "Machine assessment Assessed Machine ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedMachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedMachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}/downloadUrl": { + "post": { + "operationId": "AssessmentsOperations_DownloadUrl", + "tags": [ + "AssessmentsOperations" + ], + "summary": "Get download URL for the assessment report.", + "description": "Get the URL for downloading the assessment in a report format.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AssessmentsOperations_DownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/AssessmentsOperations_DownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments": { + "get": { + "operationId": "AvsAssessmentsOperations_ListByGroup", + "tags": [ + "AvsAssessmentsOperations" + ], + "description": "List AvsAssessment resources by Group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessmentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}": { + "get": { + "operationId": "AvsAssessmentsOperations_Get", + "tags": [ + "AvsAssessmentsOperations" + ], + "description": "Get a AvsAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AvsAssessmentsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "AvsAssessmentsOperations_Create", + "tags": [ + "AvsAssessmentsOperations" + ], + "description": "Create a AvsAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AvsAssessment" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AvsAssessment' update operation succeeded", + "schema": { + "$ref": "#/definitions/AvsAssessment" + } + }, + "201": { + "description": "Resource 'AvsAssessment' create operation succeeded", + "schema": { + "$ref": "#/definitions/AvsAssessment" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AvsAssessmentsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "AvsAssessmentsOperations_Delete", + "tags": [ + "AvsAssessmentsOperations" + ], + "description": "Delete a AvsAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AvsAssessmentsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}/avsAssessedMachines": { + "get": { + "operationId": "AvsAssessedMachinesOperations_ListByAvsAssessment", + "tags": [ + "AvsAssessedMachinesOperations" + ], + "description": "List AvsAssessedMachine resources by AvsAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessedMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}/avsAssessedMachines/{avsAssessedMachineName}": { + "get": { + "operationId": "AvsAssessedMachinesOperations_Get", + "tags": [ + "AvsAssessedMachinesOperations" + ], + "description": "Get a AvsAssessedMachine", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "avsAssessedMachineName", + "in": "path", + "description": "AVS assessment Assessed Machine ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessedMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AvsAssessedMachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessedMachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}/downloadUrl": { + "post": { + "operationId": "AvsAssessmentsOperations_DownloadUrl", + "tags": [ + "AvsAssessmentsOperations" + ], + "summary": "Get download URL for the assessment report.", + "description": "Get the URL for downloading the assessment in a report format.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments": { + "get": { + "operationId": "SqlAssessmentV2Operations_ListByGroup", + "tags": [ + "SqlAssessmentV2Operations" + ], + "description": "List SqlAssessmentV2 resources by Group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}": { + "get": { + "operationId": "SqlAssessmentV2Operations_Get", + "tags": [ + "SqlAssessmentV2Operations" + ], + "description": "Get a SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlAssessmentV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2Operations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "SqlAssessmentV2Operations_Create", + "tags": [ + "SqlAssessmentV2Operations" + ], + "description": "Create a SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlAssessmentV2" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SqlAssessmentV2' update operation succeeded", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2" + } + }, + "201": { + "description": "Resource 'SqlAssessmentV2' create operation succeeded", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SqlAssessmentV2Operations_Create_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2Operations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "SqlAssessmentV2Operations_Delete", + "tags": [ + "SqlAssessmentV2Operations" + ], + "description": "Delete a SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlAssessmentV2Operations_Delete_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2Operations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlDatabases": { + "get": { + "operationId": "AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2", + "tags": [ + "AssessedSqlDatabaseV2Operations" + ], + "description": "List AssessedSqlDatabaseV2 resources by SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlDatabaseV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlDatabases/{assessedSqlDatabaseName}": { + "get": { + "operationId": "AssessedSqlDatabaseV2Operations_Get", + "tags": [ + "AssessedSqlDatabaseV2Operations" + ], + "description": "Get a AssessedSqlDatabaseV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedSqlDatabaseName", + "in": "path", + "description": "Sql assessment Assessed Databases ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlDatabaseV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlInstances": { + "get": { + "operationId": "AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2", + "tags": [ + "AssessedSqlInstanceV2Operations" + ], + "description": "List AssessedSqlInstanceV2 resources by SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlInstanceV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlInstances/{assessedSqlInstanceName}": { + "get": { + "operationId": "AssessedSqlInstanceV2Operations_Get", + "tags": [ + "AssessedSqlInstanceV2Operations" + ], + "description": "Get a AssessedSqlInstanceV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedSqlInstanceName", + "in": "path", + "description": "Sql assessment Assessed Instance ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlInstanceV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlMachines": { + "get": { + "operationId": "AssessedSqlMachinesOperations_ListBySqlAssessmentV2", + "tags": [ + "AssessedSqlMachinesOperations" + ], + "description": "List AssessedSqlMachine resources by SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlMachines/{assessedSqlMachineName}": { + "get": { + "operationId": "AssessedSqlMachinesOperations_Get", + "tags": [ + "AssessedSqlMachinesOperations" + ], + "description": "Get a AssessedSqlMachine", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedSqlMachineName", + "in": "path", + "description": "Sql assessment Assessed Machine ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedSqlMachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlMachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/downloadUrl": { + "post": { + "operationId": "SqlAssessmentV2Operations_DownloadUrl", + "tags": [ + "SqlAssessmentV2Operations" + ], + "summary": "Get download URL for the assessment report.", + "description": "Get the URL for downloading the assessment in a report format.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/recommendedAssessedEntities": { + "get": { + "operationId": "AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2", + "tags": [ + "AssessedSqlRecommendedEntityOperations" + ], + "description": "List AssessedSqlRecommendedEntity resources by SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlRecommendedEntityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/recommendedAssessedEntities/{recommendedAssessedEntityName}": { + "get": { + "operationId": "AssessedSqlRecommendedEntityOperations_Get", + "tags": [ + "AssessedSqlRecommendedEntityOperations" + ], + "description": "Get a AssessedSqlRecommendedEntity", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "recommendedAssessedEntityName", + "in": "path", + "description": "Sql assessment Assessed Recommended Entity ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlRecommendedEntity" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/summaries": { + "get": { + "operationId": "SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2", + "tags": [ + "SqlAssessmentV2SummaryOperations" + ], + "description": "List SqlAssessmentV2Summary resources by SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2SummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/summaries/{summaryName}": { + "get": { + "operationId": "SqlAssessmentV2SummaryOperations_Get", + "tags": [ + "SqlAssessmentV2SummaryOperations" + ], + "description": "Get a SqlAssessmentV2Summary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "summaryName", + "in": "path", + "description": "Gets the Name of the SQL Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2Summary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/updateMachines": { + "post": { + "operationId": "GroupsOperations_UpdateMachines", + "tags": [ + "GroupsOperations" + ], + "summary": "Update machines in group.", + "description": "Update machines in group by adding or removing machines.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateGroupBody" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Group" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "GroupsOperations_UpdateMachines_MaximumSet_Gen": { + "$ref": "./examples/GroupsOperations_UpdateMachines_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments": { + "get": { + "operationId": "WebAppAssessmentV2Operations_ListByGroup", + "tags": [ + "WebAppAssessmentV2Operations" + ], + "description": "List WebAppAssessmentV2 resources by Group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}": { + "get": { + "operationId": "WebAppAssessmentV2Operations_Get", + "tags": [ + "WebAppAssessmentV2Operations" + ], + "description": "Get a WebAppAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppAssessmentV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2Operations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "WebAppAssessmentV2Operations_Create", + "tags": [ + "WebAppAssessmentV2Operations" + ], + "description": "Create a WebAppAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2" + } + } + ], + "responses": { + "200": { + "description": "Resource 'WebAppAssessmentV2' update operation succeeded", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2" + } + }, + "201": { + "description": "Resource 'WebAppAssessmentV2' create operation succeeded", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "WebAppAssessmentV2Operations_Create_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2Operations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "WebAppAssessmentV2Operations_Delete", + "tags": [ + "WebAppAssessmentV2Operations" + ], + "description": "Delete a WebAppAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppAssessmentV2Operations_Delete_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2Operations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/assessedWebApps": { + "get": { + "operationId": "AssessedWebAppV2Operations_ListByWebAppAssessmentV2", + "tags": [ + "AssessedWebAppV2Operations" + ], + "description": "List AssessedWebAppV2 resources by WebAppAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedWebAppV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/assessedWebApps/{assessedWebAppName}": { + "get": { + "operationId": "AssessedWebAppV2Operations_Get", + "tags": [ + "AssessedWebAppV2Operations" + ], + "description": "Get a AssessedWebAppV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedWebAppName", + "in": "path", + "description": "Assessed web app ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedWebAppV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedWebAppV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedWebAppV2Operations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/downloadUrl": { + "post": { + "operationId": "WebAppAssessmentV2Operations_DownloadUrl", + "tags": [ + "WebAppAssessmentV2Operations" + ], + "summary": "Get download URL for the assessment report.", + "description": "Get the URL for downloading the assessment in a report format.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/summaries": { + "get": { + "operationId": "WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2", + "tags": [ + "WebAppAssessmentV2SummaryOperations" + ], + "description": "List WebAppAssessmentV2Summary resources by WebAppAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2SummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/summaries/{summaryName}": { + "get": { + "operationId": "WebAppAssessmentV2SummaryOperations_Get", + "tags": [ + "WebAppAssessmentV2SummaryOperations" + ], + "description": "Get a WebAppAssessmentV2Summary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "summaryName", + "in": "path", + "description": "Gets the Name of the Web app Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2Summary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/webAppServicePlans": { + "get": { + "operationId": "WebAppServicePlanV2Operations_ListByWebAppAssessmentV2", + "tags": [ + "WebAppServicePlanV2Operations" + ], + "description": "List WebAppServicePlanV2 resources by WebAppAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppServicePlanV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/webAppServicePlans/{webAppServicePlanName}": { + "get": { + "operationId": "WebAppServicePlanV2Operations_Get", + "tags": [ + "WebAppServicePlanV2Operations" + ], + "description": "Get a WebAppServicePlanV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "webAppServicePlanName", + "in": "path", + "description": "Web app service plan ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppServicePlanV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppServicePlanV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppServicePlanV2Operations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/hypervcollectors": { + "get": { + "operationId": "HypervCollectorsOperations_ListByAssessmentProject", + "tags": [ + "HypervCollectorsOperations" + ], + "description": "List HypervCollector resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/hypervcollectors/{hypervCollectorName}": { + "get": { + "operationId": "HypervCollectorsOperations_Get", + "tags": [ + "HypervCollectorsOperations" + ], + "description": "Get a HypervCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "hypervCollectorName", + "in": "path", + "description": "Hyper-V collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervCollectorsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/HypervCollectorsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "HypervCollectorsOperations_Create", + "tags": [ + "HypervCollectorsOperations" + ], + "description": "Create a HypervCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "hypervCollectorName", + "in": "path", + "description": "Hyper-V collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/HypervCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'HypervCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/HypervCollector" + } + }, + "201": { + "description": "Resource 'HypervCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/HypervCollector" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "HypervCollectorsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/HypervCollectorsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "HypervCollectorsOperations_Delete", + "tags": [ + "HypervCollectorsOperations" + ], + "description": "Delete a HypervCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "hypervCollectorName", + "in": "path", + "description": "Hyper-V collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervCollectorsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/HypervCollectorsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/importcollectors": { + "get": { + "operationId": "ImportCollectorsOperations_ListByAssessmentProject", + "tags": [ + "ImportCollectorsOperations" + ], + "description": "List ImportCollector resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/importcollectors/{importCollectorName}": { + "get": { + "operationId": "ImportCollectorsOperations_Get", + "tags": [ + "ImportCollectorsOperations" + ], + "description": "Get a ImportCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "importCollectorName", + "in": "path", + "description": "Import collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportCollectorsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/ImportCollectorsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "ImportCollectorsOperations_Create", + "tags": [ + "ImportCollectorsOperations" + ], + "description": "Create a ImportCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "importCollectorName", + "in": "path", + "description": "Import collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ImportCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ImportCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/ImportCollector" + } + }, + "201": { + "description": "Resource 'ImportCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/ImportCollector" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ImportCollectorsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/ImportCollectorsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "ImportCollectorsOperations_Delete", + "tags": [ + "ImportCollectorsOperations" + ], + "description": "Delete a ImportCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "importCollectorName", + "in": "path", + "description": "Import collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportCollectorsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/ImportCollectorsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/machines": { + "get": { + "operationId": "MachinesOperations_ListByAssessmentProject", + "tags": [ + "MachinesOperations" + ], + "description": "List Machine resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "MachinesOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/MachinesOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/machines/{machineName}": { + "get": { + "operationId": "MachinesOperations_Get", + "tags": [ + "MachinesOperations" + ], + "description": "Get a Machine", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "machineName", + "in": "path", + "description": "Assessible Machine ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Machine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/MachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections": { + "get": { + "operationId": "PrivateEndpointConnectionOperations_ListByAssessmentProject", + "tags": [ + "PrivateEndpointConnectionOperations" + ], + "description": "List PrivateEndpointConnection resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "operationId": "PrivateEndpointConnectionOperations_Get", + "tags": [ + "PrivateEndpointConnectionOperations" + ], + "description": "Get a PrivateEndpointConnection", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Private endpoint connection ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnectionOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "PrivateEndpointConnectionOperations_Update", + "tags": [ + "PrivateEndpointConnectionOperations" + ], + "description": "Create a PrivateEndpointConnection", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Private endpoint connection ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "Resource 'PrivateEndpointConnection' update operation succeeded", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "Resource 'PrivateEndpointConnection' create operation succeeded", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PrivateEndpointConnectionOperations_Update_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionOperations_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "PrivateEndpointConnectionOperations_Delete", + "tags": [ + "PrivateEndpointConnectionOperations" + ], + "description": "Delete a PrivateEndpointConnection", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Private endpoint connection ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateLinkResources": { + "get": { + "operationId": "PrivateLinkResourceOperations_ListByAssessmentProject", + "tags": [ + "PrivateLinkResourceOperations" + ], + "description": "List PrivateLinkResource resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateLinkResources/{privateLinkResourceName}": { + "get": { + "operationId": "PrivateLinkResourceOperations_Get", + "tags": [ + "PrivateLinkResourceOperations" + ], + "description": "Get a PrivateLinkResource", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "privateLinkResourceName", + "in": "path", + "description": "Private link resource ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkResourceOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/PrivateLinkResourceOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/projectSummary": { + "get": { + "operationId": "AssessmentProjectSummaryOperations_ListByAssessmentProject", + "tags": [ + "AssessmentProjectSummaryOperations" + ], + "description": "List AssessmentProjectSummary resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProjectSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/projectSummary/{projectSummaryName}": { + "get": { + "operationId": "AssessmentProjectSummaryOperations_Get", + "tags": [ + "AssessmentProjectSummaryOperations" + ], + "description": "Get a AssessmentProjectSummary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "projectSummaryName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProjectSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentProjectSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/servercollectors": { + "get": { + "operationId": "ServerCollectorsOperations_ListByAssessmentProject", + "tags": [ + "ServerCollectorsOperations" + ], + "description": "List ServerCollector resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/servercollectors/{serverCollectorName}": { + "get": { + "operationId": "ServerCollectorsOperations_Get", + "tags": [ + "ServerCollectorsOperations" + ], + "description": "Get a ServerCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "serverCollectorName", + "in": "path", + "description": "Physical server collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerCollectorsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/ServerCollectorsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "ServerCollectorsOperations_Create", + "tags": [ + "ServerCollectorsOperations" + ], + "description": "Create a ServerCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "serverCollectorName", + "in": "path", + "description": "Physical server collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ServerCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/ServerCollector" + } + }, + "201": { + "description": "Resource 'ServerCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/ServerCollector" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ServerCollectorsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/ServerCollectorsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "ServerCollectorsOperations_Delete", + "tags": [ + "ServerCollectorsOperations" + ], + "description": "Delete a ServerCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "serverCollectorName", + "in": "path", + "description": "Physical server collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerCollectorsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/ServerCollectorsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessmentOptions": { + "get": { + "operationId": "SqlAssessmentOptionsOperations_ListByAssessmentProject", + "tags": [ + "SqlAssessmentOptionsOperations" + ], + "description": "List SqlAssessmentOptions resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentOptionsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessmentOptions/{assessmentOptionsName}": { + "get": { + "operationId": "SqlAssessmentOptionsOperations_Get", + "tags": [ + "SqlAssessmentOptionsOperations" + ], + "description": "Get a SqlAssessmentOptions", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentOptionsName", + "in": "path", + "description": "Sql assessment options ARM name. Accepted values is 'default'", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentOptions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlAssessmentOptionsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentOptionsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlcollectors": { + "get": { + "operationId": "SqlCollectorOperations_ListByAssessmentProject", + "tags": [ + "SqlCollectorOperations" + ], + "description": "List SqlCollector resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlcollectors/{collectorName}": { + "get": { + "operationId": "SqlCollectorOperations_Get", + "tags": [ + "SqlCollectorOperations" + ], + "description": "Get a SqlCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Sql collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlCollectorOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlCollectorOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "SqlCollectorOperations_Create", + "tags": [ + "SqlCollectorOperations" + ], + "description": "Create a SqlCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Sql collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SqlCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/SqlCollector" + } + }, + "201": { + "description": "Resource 'SqlCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/SqlCollector" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SqlCollectorOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/SqlCollectorOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "SqlCollectorOperations_Delete", + "tags": [ + "SqlCollectorOperations" + ], + "description": "Delete a SqlCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Sql collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlCollectorOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/SqlCollectorOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/vmwarecollectors": { + "get": { + "operationId": "VmwareCollectorsOperations_ListByAssessmentProject", + "tags": [ + "VmwareCollectorsOperations" + ], + "description": "List VmwareCollector resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/vmwarecollectors/{vmWareCollectorName}": { + "get": { + "operationId": "VmwareCollectorsOperations_Get", + "tags": [ + "VmwareCollectorsOperations" + ], + "description": "Get a VmwareCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "vmWareCollectorName", + "in": "path", + "description": "VMware collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VmwareCollectorsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/VmwareCollectorsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "VmwareCollectorsOperations_Create", + "tags": [ + "VmwareCollectorsOperations" + ], + "description": "Create a VmwareCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "vmWareCollectorName", + "in": "path", + "description": "VMware collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/VmwareCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'VmwareCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/VmwareCollector" + } + }, + "201": { + "description": "Resource 'VmwareCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/VmwareCollector" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VmwareCollectorsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/VmwareCollectorsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "VmwareCollectorsOperations_Delete", + "tags": [ + "VmwareCollectorsOperations" + ], + "description": "Delete a VmwareCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "vmWareCollectorName", + "in": "path", + "description": "VMware collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VmwareCollectorsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/VmwareCollectorsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppAssessmentOptions": { + "get": { + "operationId": "WebAppAssessmentOptionsOperations_ListByAssessmentProject", + "tags": [ + "WebAppAssessmentOptionsOperations" + ], + "description": "List WebAppAssessmentOptions resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentOptionsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppAssessmentOptions/{assessmentOptionsName}": { + "get": { + "operationId": "WebAppAssessmentOptionsOperations_Get", + "tags": [ + "WebAppAssessmentOptionsOperations" + ], + "description": "Get a WebAppAssessmentOptions", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentOptionsName", + "in": "path", + "description": "Web app assessment options ARM name. Accepted values is 'default'", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentOptions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppCollectors": { + "get": { + "operationId": "WebAppCollectorOperations_ListByAssessmentProject", + "tags": [ + "WebAppCollectorOperations" + ], + "description": "List WebAppCollector resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppCollectors/{collectorName}": { + "get": { + "operationId": "WebAppCollectorOperations_Get", + "tags": [ + "WebAppCollectorOperations" + ], + "description": "Get a WebAppCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Web app collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppCollectorOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppCollectorOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "WebAppCollectorOperations_Create", + "tags": [ + "WebAppCollectorOperations" + ], + "description": "Create a WebAppCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Web app collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WebAppCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'WebAppCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/WebAppCollector" + } + }, + "201": { + "description": "Resource 'WebAppCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/WebAppCollector" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "WebAppCollectorOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/WebAppCollectorOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "WebAppCollectorOperations_Delete", + "tags": [ + "WebAppCollectorOperations" + ], + "description": "Delete a WebAppCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Web app collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppCollectorOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/WebAppCollectorOperations_Delete_MaximumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "AKSAssessment": { + "type": "object", + "description": "ARM model of AKS Assessment.", + "properties": { + "properties": { + "$ref": "#/definitions/AKSAssessmentProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AKSAssessmentDetails": { + "type": "object", + "description": "Data model of AKS Assessment Details.", + "properties": { + "webAppCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of web apps.", + "readOnly": true + }, + "webServerCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of web servers.", + "readOnly": true + }, + "machineCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of machines.", + "readOnly": true + }, + "totalMonthlyCost": { + "type": "number", + "format": "float", + "description": "Gets the total monthly cost.", + "readOnly": true + } + }, + "required": [ + "webAppCount", + "webServerCount", + "machineCount", + "totalMonthlyCost" + ], + "allOf": [ + { + "$ref": "#/definitions/AssessmentDetails" + } + ] + }, + "AKSAssessmentListResult": { + "type": "object", + "description": "The response of a AKSAssessment list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AKSAssessment items on this page", + "items": { + "$ref": "#/definitions/AKSAssessment" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AKSAssessmentOptions": { + "type": "object", + "description": "ARM model of AKS Assessment Options.", + "properties": { + "properties": { + "$ref": "#/definitions/AKSAssessmentOptionsProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AKSAssessmentOptionsListResult": { + "type": "object", + "description": "The response of a AKSAssessmentOptions list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AKSAssessmentOptions items on this page", + "items": { + "$ref": "#/definitions/AKSAssessmentOptions" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AKSAssessmentOptionsProperties": { + "type": "object", + "description": "ARM model of AKS Assessment Options Properties.", + "allOf": [ + { + "$ref": "#/definitions/OptionsArmPropertiesBase" + } + ] + }, + "AKSAssessmentProperties": { + "type": "object", + "description": "ARM model of AKS Assessment Properties.", + "properties": { + "settings": { + "$ref": "#/definitions/AKSAssessmentSettings", + "description": "Gets or sets AKS Assessment Settings." + }, + "details": { + "$ref": "#/definitions/AKSAssessmentDetails", + "description": "Gets AKS Assessment Details.", + "readOnly": true + } + }, + "required": [ + "settings" + ], + "allOf": [ + { + "$ref": "#/definitions/AssessmentPropertiesBase" + } + ] + }, + "AKSAssessmentSettings": { + "type": "object", + "description": "Data model of AKS Assessment Settings.", + "properties": { + "category": { + "$ref": "#/definitions/AzureVmCategory", + "description": "Gets or sets azure VM category." + }, + "savingsOptions": { + "$ref": "#/definitions/SavingsOptions", + "description": "Gets or sets savings options." + }, + "consolidation": { + "$ref": "#/definitions/ConsolidationType", + "description": "Gets or sets consolidation type." + }, + "pricingTier": { + "$ref": "#/definitions/PricingTier", + "description": "Gets or sets pricing tier." + } + }, + "required": [ + "category", + "savingsOptions", + "consolidation", + "pricingTier" + ], + "allOf": [ + { + "$ref": "#/definitions/AssessmentSettings" + } + ] + }, + "AKSAssessmentSummary": { + "type": "object", + "description": "Data model of AKS Assessment Summary.", + "properties": { + "skuSummary": { + "type": "object", + "description": "Gets SKU summary.", + "additionalProperties": { + "$ref": "#/definitions/SummaryDetails" + }, + "readOnly": true + }, + "webAppSummary": { + "type": "object", + "description": "Gets web app summary.", + "additionalProperties": { + "$ref": "#/definitions/SummaryDetails" + }, + "readOnly": true + }, + "webServerSummary": { + "type": "object", + "description": "Gets web server summary.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "webAppCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of web apps.", + "readOnly": true + }, + "webServerCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of web servers.", + "readOnly": true + }, + "machineCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of machines.", + "readOnly": true + }, + "totalMonthlyCost": { + "type": "number", + "format": "float", + "description": "Gets the total monthly cost.", + "readOnly": true + } + }, + "required": [ + "skuSummary", + "webAppSummary", + "webServerSummary", + "webAppCount", + "webServerCount", + "machineCount", + "totalMonthlyCost" + ] + }, + "AKSCluster": { + "type": "object", + "description": "ARM model of AKS Cluster.", + "properties": { + "properties": { + "$ref": "#/definitions/AKSClusterProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AKSClusterListResult": { + "type": "object", + "description": "The response of a AKSCluster list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AKSCluster items on this page", + "items": { + "$ref": "#/definitions/AKSCluster" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AKSClusterProperties": { + "type": "object", + "description": "ARM model of AKS Cluster Properties.", + "allOf": [ + { + "$ref": "#/definitions/Cluster" + } + ] + }, + "AKSCostDetail": { + "type": "object", + "description": "ARM model of AKS Cost Detail.", + "properties": { + "properties": { + "$ref": "#/definitions/AKSCostDetailProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AKSCostDetailListResult": { + "type": "object", + "description": "The response of a AKSCostDetail list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AKSCostDetail items on this page", + "items": { + "$ref": "#/definitions/AKSCostDetail" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AKSCostDetailProperties": { + "type": "object", + "description": "ARM model of AKS Cost Detail Properties.", + "allOf": [ + { + "$ref": "#/definitions/NodePool" + } + ] + }, + "AKSSummary": { + "type": "object", + "description": "ARM model of AKS Summary.", + "properties": { + "properties": { + "$ref": "#/definitions/AKSSummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AKSSummaryListResult": { + "type": "object", + "description": "The response of a AKSSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AKSSummary items on this page", + "items": { + "$ref": "#/definitions/AKSSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AKSSummaryProperties": { + "type": "object", + "description": "ARM model of AKS Summary Properties.", + "properties": { + "aksAssessmentSummary": { + "$ref": "#/definitions/AKSAssessmentSummary", + "description": "Gets AKS assessment summary.", + "readOnly": true + } + }, + "required": [ + "aksAssessmentSummary" + ], + "allOf": [ + { + "$ref": "#/definitions/SummaryPropertiesBase" + } + ] + }, + "ApiVersions": { + "type": "string", + "description": "Common API Versions for Assessment Project Tracked Resource.", + "enum": [ + "2019-10-01", + "2020-01-01", + "2020-05-01-preview", + "2022-02-02-preview", + "2022-08-01-preview", + "2023-03-03", + "2023-03-15", + "2023-04-01-preview", + "2023-05-01-preview", + "2023-07-07-preview" + ], + "x-ms-enum": { + "name": "ApiVersions", + "modelAsString": true, + "values": [ + { + "name": "v2019_10_01", + "value": "2019-10-01", + "description": "2019-10-01 API Version." + }, + { + "name": "v2020_01_01", + "value": "2020-01-01", + "description": "2020-01-01 API Version." + }, + { + "name": "v2020_05_01_preview", + "value": "2020-05-01-preview", + "description": "2020-05-01-preview API Version." + }, + { + "name": "v2022_02_02_preview", + "value": "2022-02-02-preview", + "description": "2022-02-02-preview API Version." + }, + { + "name": "v2022_08_01_preview", + "value": "2022-08-01-preview", + "description": "2022-08-01-preview API Version." + }, + { + "name": "v2023_03_03", + "value": "2023-03-03", + "description": "2023-03-03 API Version." + }, + { + "name": "v2023_03_15", + "value": "2023-03-15", + "description": "2023-03-15 API Version." + }, + { + "name": "v2023_04_01_preview", + "value": "2023-04-01-preview", + "description": "2023-04-01-preview API Version." + }, + { + "name": "v2023_05_01_preview", + "value": "2023-05-01-preview", + "description": "2023-05-01-preview API Version." + }, + { + "name": "v2023_07_07_preview", + "value": "2023-07-07-preview", + "description": "2023-07-07-preview API Version." + } + ] + } + }, + "AppServiceSku": { + "type": "object", + "description": "The app service SKU with corresponding cost.", + "properties": { + "skuName": { + "type": "string", + "description": "The SKU name.", + "readOnly": true + }, + "cost": { + "type": "number", + "format": "float", + "description": "The cost details.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The number of service plans recommended.", + "readOnly": true + } + } + }, + "AppSvcContainerSettings": { + "type": "object", + "description": "App service container settings.", + "properties": { + "isolationRequired": { + "type": "boolean", + "description": "Gets or sets the isolation required." + } + }, + "required": [ + "isolationRequired" + ] + }, + "AppSvcNativeSettings": { + "type": "object", + "description": "App service native settings.", + "properties": { + "isolationRequired": { + "type": "boolean", + "description": "Gets or sets the isolation required." + } + }, + "required": [ + "isolationRequired" + ] + }, + "AssessedDisk": { + "type": "object", + "properties": { + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability." + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureDiskSuitabilityExplanation", + "description": "Gets the suitability explanation." + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureDiskSuitabilityDetail", + "description": "Gets the suitability detail." + }, + "recommendedDiskSize": { + "$ref": "#/definitions/AzureDiskSize", + "description": "Gets the recommended disk size." + }, + "recommendedDiskType": { + "$ref": "#/definitions/AzureDiskType", + "description": "Gets the recommended disk type." + }, + "gigabytesForRecommendedDiskSize": { + "type": "integer", + "format": "int32", + "description": "Gets the recommended disk size." + }, + "recommendDiskThroughputInMbps": { + "type": "number", + "format": "float", + "description": "Gets the recommended disk throughput." + }, + "recommendedDiskIops": { + "type": "number", + "format": "float", + "description": "Gets the recommended disk iops." + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly storage cost." + }, + "name": { + "type": "string", + "description": "Gets the name." + }, + "displayName": { + "type": "string", + "description": "Gets the machine display name." + }, + "gigabytesProvisioned": { + "type": "number", + "format": "float", + "description": "Gets the gigabytes provisioned." + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of read." + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of write." + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of read operations per second." + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of write operations per second." + } + } + }, + "AssessedDiskData": { + "type": "object", + "description": "Assessed Disk data. Used in Assessed SQL machine DTO.", + "properties": { + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability." + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureDiskSuitabilityExplanation", + "description": "Gets the suitability explanation." + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureDiskSuitabilityDetail", + "description": "Gets the suitability detail." + }, + "recommendedDiskSize": { + "$ref": "#/definitions/AzureDiskSize", + "description": "Gets the recommended disk size." + }, + "recommendedDiskType": { + "$ref": "#/definitions/AzureDiskType", + "description": "Gets the recommended disk type." + }, + "recommendedDiskSizeGigabytes": { + "type": "integer", + "format": "int32", + "description": "Gets the recommended disk size." + }, + "recommendDiskThroughputInMbps": { + "type": "number", + "format": "float", + "description": "Gets the recommended disk throughput." + }, + "recommendedDiskIops": { + "type": "number", + "format": "float", + "description": "Gets the recommended disk iops." + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly storage cost." + }, + "name": { + "type": "string", + "description": "Gets the name." + }, + "displayName": { + "type": "string", + "description": "Gets the machine display name." + }, + "gigabytesProvisioned": { + "type": "number", + "format": "float", + "description": "Gets the gigabytes provisioned." + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of read." + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of write." + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of read operations per second." + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of write operations per second." + } + } + }, + "AssessedMachine": { + "type": "object", + "description": "Machine assessment Assessed Machine resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedMachineListResult": { + "type": "object", + "description": "The response of a AssessedMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedMachine items on this page", + "items": { + "$ref": "#/definitions/AssessedMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedMachineProperties": { + "type": "object", + "description": "Assessed machine properties class.", + "properties": { + "errors": { + "type": "array", + "description": "List of errors for this machine.", + "items": { + "$ref": "#/definitions/Error" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "disks": { + "type": "object", + "description": "Dictionary of disks attached to the machine. Key is ID of disk. Value is a disk object.", + "additionalProperties": { + "$ref": "#/definitions/AssessedDisk" + }, + "readOnly": true + }, + "monthlyUltraStorageCost": { + "type": "number", + "format": "float", + "description": "Monthly ultra storage cost.", + "readOnly": true + }, + "hostProcessor": { + "$ref": "#/definitions/ProcessorInfo", + "description": "Gets or sets the processor details of the host." + }, + "costComponents": { + "type": "array", + "description": "Gets or sets the collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "x-ms-identifiers": [] + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "monthlyBandwidthCost": { + "type": "number", + "format": "float", + "description": "Monthly networking cost.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Monthly storage cost.", + "readOnly": true + }, + "monthlyPremiumStorageCost": { + "type": "number", + "format": "float", + "description": "Monthly premium storage cost.", + "readOnly": true + }, + "monthlyStandardSsdStorageCost": { + "type": "number", + "format": "float", + "description": "Monthly standard SSD storage cost.", + "readOnly": true + }, + "networkAdapters": { + "type": "object", + "description": "List of Network Adapters that were assessed as part of this machine's\nassessment.", + "additionalProperties": { + "$ref": "#/definitions/AssessedNetworkAdapter" + }, + "readOnly": true + }, + "recommendedSize": { + "$ref": "#/definitions/AzureVmSize", + "description": "Recommended Azure Size for the machine.", + "readOnly": true + }, + "numberOfCoresForRecommendedSize": { + "type": "integer", + "format": "int32", + "description": "Number of cores for recommended size. Read Only.", + "readOnly": true + }, + "megabytesOfMemoryForRecommendedSize": { + "type": "number", + "format": "float", + "description": "Megabytes of memory for recommended size. Read Only.", + "readOnly": true + }, + "monthlyComputeCostForRecommendedSize": { + "type": "number", + "format": "float", + "description": "Monthly Compute cost calculated for Recommended size, for a 31-day month.", + "readOnly": true + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureVmSuitabilityExplanation", + "description": "Gets the explanation if machine is not suitable for cloud.", + "readOnly": true + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureVmSuitabilityDetail", + "description": "Gets the details if machine is not suitable for cloud.", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/AssessedMachineType", + "description": "Assessed machine type.", + "readOnly": true + }, + "bootType": { + "$ref": "#/definitions/MachineBootType", + "description": "Boot type of machine discovered in private data center.", + "readOnly": true + }, + "operatingSystemType": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemVersion": { + "type": "string", + "description": "Operating system version as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemArchitecture": { + "$ref": "#/definitions/GuestOperatingSystemArchitecture", + "description": "Operating system architecture as reported by datacenter management solution.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine last updated.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display Name of the Machine.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description for the machine.", + "readOnly": true + }, + "datacenterMachineArmId": { + "type": "string", + "description": "Data center machine ARM id.", + "readOnly": true + }, + "datacenterManagementServerArmId": { + "type": "string", + "description": "Data center management server ARM id.", + "readOnly": true + }, + "datacenterManagementServerName": { + "type": "string", + "description": "Data center management server name.", + "readOnly": true + }, + "megabytesOfMemory": { + "type": "number", + "format": "float", + "description": "Megabytes of memory found allocated for the machine in private data center.", + "readOnly": true + }, + "numberOfCores": { + "type": "integer", + "format": "int32", + "description": "Number of CPU cores found on the machine.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "percentageCoresUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Cores Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "percentageMemoryUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Memory Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets a value indicating whether machine is suitable for the cloud platform\nselected.", + "readOnly": true + } + } + }, + "AssessedMachineType": { + "type": "string", + "enum": [ + "Unknown", + "AssessedMachine", + "AvsAssessedMachine", + "SqlAssessedMachine" + ], + "x-ms-enum": { + "name": "AssessedMachineType", + "modelAsString": true + } + }, + "AssessedNetworkAdapter": { + "type": "object", + "description": "Assessed Network Adapter.", + "properties": { + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability." + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureNetworkAdapterSuitabilityDetail", + "description": "Gets the suitability detail." + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureNetworkAdapterSuitabilityExplanation", + "description": "Gets the suitability explanation." + }, + "monthlyBandwidthCosts": { + "type": "number", + "format": "float", + "description": "Gets the monthly bandwidth costs." + }, + "netGigabytesTransmittedPerMonth": { + "type": "number", + "format": "float", + "description": "Gets the net gigabytes transmitted per month." + }, + "displayName": { + "type": "string", + "description": "Gets the display name." + }, + "macAddress": { + "type": "string", + "description": "Gets the mac address." + }, + "ipAddresses": { + "type": "array", + "description": "Gets the ip addresses.", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "megabytesPerSecondReceived": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second received." + }, + "megabytesPerSecondTransmitted": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second transmitted." + } + } + }, + "AssessedSqlDatabaseV2": { + "type": "object", + "description": "Assessed SQL database web model class.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedSqlDatabaseV2Properties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedSqlDatabaseV2ListResult": { + "type": "object", + "description": "The response of a AssessedSqlDatabaseV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedSqlDatabaseV2 items on this page", + "items": { + "$ref": "#/definitions/AssessedSqlDatabaseV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedSqlDatabaseV2Properties": { + "type": "object", + "description": "Assessed SQL database properties web model.", + "properties": { + "recommendedAzureSqlTargetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets or sets the recommended azure SQL target type.", + "readOnly": true + }, + "recommendedSuitability": { + "$ref": "#/definitions/RecommendedSuitability", + "description": "Gets or sets the recommended azure SQL suitability.", + "readOnly": true + }, + "bufferCacheSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregated cache size of this database. This is a performance\ndata metric for this DB.", + "readOnly": true + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "azureSqlMISuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "Gets or sets the azure SQL MI suitability details.", + "readOnly": true + }, + "azureSqlDBSuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "Gets or sets the azure SQL DB suitability details.", + "readOnly": true + }, + "isDatabaseHighlyAvailable": { + "type": "boolean", + "description": "Gets a value indicating whether the assessed SQL database is highly available\nor not.", + "readOnly": true + }, + "linkedAvailabilityGroupOverview": { + "$ref": "#/definitions/SqlAvailabilityGroupDataOverview", + "description": "Gets the linked availability group overview if the database being assessed is\nhighly available.", + "readOnly": true + }, + "machineArmId": { + "type": "string", + "description": "Machine arm id.", + "readOnly": true + }, + "assessedSqlInstanceArmId": { + "type": "string", + "description": "Assessed SQL instance arm id.", + "readOnly": true + }, + "machineName": { + "type": "string", + "description": "Machine display name.", + "readOnly": true + }, + "instanceName": { + "type": "string", + "description": "SQL instance name.", + "readOnly": true + }, + "databaseName": { + "type": "string", + "description": "SQL database name.", + "readOnly": true + }, + "databaseSizeInMB": { + "type": "number", + "format": "float", + "description": "SQL database size in megabytes.", + "readOnly": true + }, + "compatibilityLevel": { + "$ref": "#/definitions/CompatibilityLevel", + "description": "Database compatibility level.", + "readOnly": true + }, + "sqlDatabaseSdsArmId": { + "type": "string", + "description": "SQL database SDS arm id.", + "readOnly": true + }, + "percentageCoresUtilization": { + "type": "number", + "format": "float", + "description": "The percentage of the total number of cores being utilized by the SQL database.", + "readOnly": true + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "The read throughput of the SQL database.", + "readOnly": true + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "The write throughput of the SQL database.", + "readOnly": true + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "The read operations per second of the SQL database.", + "readOnly": true + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "The write operations per second of the SQL database.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL database first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL database last updated.", + "readOnly": true + } + } + }, + "AssessedSqlInstanceDatabaseSummary": { + "type": "object", + "description": "Assessed Sql Instance Database Summary.", + "properties": { + "numberOfUserDatabases": { + "type": "integer", + "format": "int32", + "description": "Gets the number of user databases." + }, + "totalDatabaseSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the total database size in MB." + }, + "largestDatabaseSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the largest database size in MB." + }, + "totalDiscoveredUserDatabases": { + "type": "integer", + "format": "int32", + "description": "Gets the total discovered user databases." + } + } + }, + "AssessedSqlInstanceDiskDetails": { + "type": "object", + "description": "Assessed Sql Instance Disk Details.", + "properties": { + "diskId": { + "type": "string", + "description": "Gets the disk id." + }, + "diskSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the disk size in mb." + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of read." + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of write." + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of read operations per second." + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of write operations per second." + } + } + }, + "AssessedSqlInstanceStorageDetails": { + "type": "object", + "description": "Assessed Sql Instance Storage Details.", + "properties": { + "storageType": { + "type": "string", + "description": "Gets the storage type." + }, + "diskSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the disk size in mb." + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of read." + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of read." + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of read operations per second." + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of write operations per second." + } + } + }, + "AssessedSqlInstanceSummary": { + "type": "object", + "description": "Assessed Sql Instance Summary.", + "properties": { + "instanceId": { + "type": "string", + "description": "Gets the instance id." + }, + "instanceName": { + "type": "string", + "description": "Gets the instance name." + }, + "sqlInstanceSdsArmId": { + "type": "string", + "description": "Gets the instance arm id." + }, + "sqlInstanceEntityId": { + "type": "string", + "description": "Gets the instance entity id." + }, + "sqlEdition": { + "type": "string", + "description": "Gets the Sql edition." + }, + "sqlVersion": { + "type": "string", + "description": "Gets the Sql version." + }, + "isClustered": { + "type": "boolean", + "description": "Gets whether Sql is clustered." + }, + "isHighAvailabilityEnabled": { + "type": "boolean", + "description": "Gets whether Sql is highly available." + }, + "sqlFciState": { + "$ref": "#/definitions/SqlFCIState", + "description": "Gets the Sql Fci state." + } + } + }, + "AssessedSqlInstanceV2": { + "type": "object", + "description": "Assessed SQL instance web model class.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedSqlInstanceV2Properties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedSqlInstanceV2ListResult": { + "type": "object", + "description": "The response of a AssessedSqlInstanceV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedSqlInstanceV2 items on this page", + "items": { + "$ref": "#/definitions/AssessedSqlInstanceV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedSqlInstanceV2Properties": { + "type": "object", + "description": "Assessed SQL instance properties web model.", + "properties": { + "memoryInUseInMB": { + "type": "number", + "format": "float", + "description": "Gets or sets the memory used by SQL instance in megabytes.", + "readOnly": true + }, + "hasScanOccurred": { + "type": "boolean", + "description": "Gets or sets a value indicating whether SQL instance has been deep discovered.", + "readOnly": true + }, + "recommendedAzureSqlTargetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets or sets the recommended azure SQL target type.", + "readOnly": true + }, + "recommendedSuitability": { + "$ref": "#/definitions/RecommendedSuitability", + "description": "Gets or sets the recommended azure SQL suitability.", + "readOnly": true + }, + "azureSqlMISuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "SQL instance azure SQL MI suitability details.", + "readOnly": true + }, + "azureSqlDBSuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "SQL instance azure SQL DB suitability details.", + "readOnly": true + }, + "azureSqlVMSuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2IaasSuitabilityData", + "description": "SQL instance azure SQL VM suitability details.", + "readOnly": true + }, + "storageTypeBasedDetails": { + "type": "array", + "description": "Gets the storage details.", + "items": { + "$ref": "#/definitions/AssessedSqlInstanceStorageDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "fciMetadata": { + "$ref": "#/definitions/SqlFCIMetadata", + "description": "Gets the FCI metadata if this instance represents an FCI instance.", + "readOnly": true + }, + "availabilityReplicaSummary": { + "$ref": "#/definitions/SqlAvailabilityReplicaSummary", + "description": "Gets the overview counts of availability replicas in the assessed instance, by\ncommit mode and read type.", + "readOnly": true + }, + "isClustered": { + "type": "boolean", + "description": "Gets a value indicating whether the SQL instance is clustered or not.", + "readOnly": true + }, + "isHighAvailabilityEnabled": { + "type": "boolean", + "description": "Gets a value indicating whether the high availability is enabled or not.", + "readOnly": true + }, + "recommendedTargetReasonings": { + "type": "array", + "description": "Gets the list of recommended target reasoning.", + "items": { + "$ref": "#/definitions/SqlRecommendationReasoning" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "machineArmId": { + "type": "string", + "description": "Machine arm id.", + "readOnly": true + }, + "machineName": { + "type": "string", + "description": "Machine display name.", + "readOnly": true + }, + "instanceName": { + "type": "string", + "description": "SQL instance name.", + "readOnly": true + }, + "sqlInstanceSdsArmId": { + "type": "string", + "description": "SQL instance SDS arm id.", + "readOnly": true + }, + "sqlEdition": { + "type": "string", + "description": "SQL instance edition.", + "readOnly": true + }, + "sqlVersion": { + "type": "string", + "description": "SQL instance version.", + "readOnly": true + }, + "numberOfCoresAllocated": { + "type": "integer", + "format": "int32", + "description": "Number of CPU cores assigned to the SQL instance.", + "readOnly": true + }, + "percentageCoresUtilization": { + "type": "number", + "format": "float", + "description": "The percentage of the total number of cores being utilized by the SQL instance.", + "readOnly": true + }, + "logicalDisks": { + "type": "array", + "description": "The logical disk details.", + "items": { + "$ref": "#/definitions/AssessedSqlInstanceDiskDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "databaseSummary": { + "$ref": "#/definitions/AssessedSqlInstanceDatabaseSummary", + "description": "The databases summary.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL instance first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL instance last updated.", + "readOnly": true + } + } + }, + "AssessedSqlMachine": { + "type": "object", + "description": "SQL Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedSqlMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedSqlMachineListResult": { + "type": "object", + "description": "The response of a AssessedSqlMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedSqlMachine items on this page", + "items": { + "$ref": "#/definitions/AssessedSqlMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedSqlMachineProperties": { + "type": "object", + "description": "Assessed SQL machine properties.", + "properties": { + "biosGuid": { + "type": "string", + "description": "Gets or sets the BIOS GUID for the machine.", + "readOnly": true + }, + "fqdn": { + "type": "string", + "description": "Gets or sets the FQDN for the machine.", + "readOnly": true + }, + "sqlInstances": { + "type": "array", + "description": "Gets the list of SQL instances discovered on the machine.", + "items": { + "$ref": "#/definitions/AssessedSqlInstanceSummary" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureVmSuitabilityDetail", + "description": "Gets or sets the detailed messages that were set on the machine during\nevaluation.", + "readOnly": true + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureVmSuitabilityExplanation", + "description": "Gets or sets the explanation if machine is not suitable for cloud.", + "readOnly": true + }, + "recommendedVmSize": { + "$ref": "#/definitions/AzureVmSize", + "description": "Gets or sets the Recommended Azure Size for the machine.", + "readOnly": true + }, + "recommendedVmFamily": { + "$ref": "#/definitions/AzureVmFamily", + "description": "Gets or sets the Recommended Azure VM Family for the machine.", + "readOnly": true + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "recommendedVmSizeNumberOfCores": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Number of cores for recommended size.", + "readOnly": true + }, + "recommendedVmSizeMegabytesOfMemory": { + "type": "number", + "format": "float", + "description": "Gets or sets the Megabytes of memory for recommended size.", + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the monthly compute cost calculated for recommended size.", + "readOnly": true + }, + "disks": { + "type": "object", + "description": "Gets the list of data disks that were assessed as part of this assessment.", + "additionalProperties": { + "$ref": "#/definitions/AssessedDiskData" + }, + "readOnly": true + }, + "networkAdapters": { + "type": "object", + "description": "Gets the list of network adapters that were assessed as part of this assessment.", + "additionalProperties": { + "$ref": "#/definitions/SqlAssessedNetworkAdapter" + }, + "readOnly": true + }, + "monthlyBandwidthCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the monthly networking cost.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the monthly total storage cost.", + "readOnly": true + }, + "costComponents": { + "type": "array", + "description": "Gets the collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "x-ms-identifiers": [] + }, + "securitySuitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability for Microsoft cloud defender.", + "readOnly": true + }, + "migrationGuidelines": { + "type": "array", + "description": "Gets the list of migration guidelines applicable.", + "items": { + "$ref": "#/definitions/SqlMigrationGuideline" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "bootType": { + "$ref": "#/definitions/MachineBootType", + "description": "Boot type of machine discovered in private data center.", + "readOnly": true + }, + "operatingSystemType": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemVersion": { + "type": "string", + "description": "Operating system version as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemArchitecture": { + "$ref": "#/definitions/GuestOperatingSystemArchitecture", + "description": "Operating system architecture as reported by datacenter management solution.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine last updated.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display Name of the Machine.", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/AssessedMachineType", + "description": "Assessed machine type.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description for the machine.", + "readOnly": true + }, + "datacenterMachineArmId": { + "type": "string", + "description": "Data center machine ARM id.", + "readOnly": true + }, + "datacenterManagementServerArmId": { + "type": "string", + "description": "Data center management server ARM id.", + "readOnly": true + }, + "datacenterManagementServerName": { + "type": "string", + "description": "Data center management server name.", + "readOnly": true + }, + "megabytesOfMemory": { + "type": "number", + "format": "float", + "description": "Megabytes of memory found allocated for the machine in private data center.", + "readOnly": true + }, + "numberOfCores": { + "type": "integer", + "format": "int32", + "description": "Number of CPU cores found on the machine.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "percentageCoresUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Cores Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "percentageMemoryUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Memory Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets a value indicating whether machine is suitable for the cloud platform\nselected.", + "readOnly": true + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion.", + "readOnly": true + } + } + }, + "AssessedSqlRecommendedEntity": { + "type": "object", + "description": "SQL Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedSqlRecommendedEntityProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedSqlRecommendedEntityListResult": { + "type": "object", + "description": "The response of a AssessedSqlRecommendedEntity list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedSqlRecommendedEntity items on this page", + "items": { + "$ref": "#/definitions/AssessedSqlRecommendedEntity" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedSqlRecommendedEntityProperties": { + "type": "object", + "description": "Assessed SQL recommended entity properties.", + "properties": { + "machineName": { + "type": "string", + "description": "Gets or sets machine name.", + "readOnly": true + }, + "instanceName": { + "type": "string", + "description": "Gets or sets SQL instance name.", + "readOnly": true + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "dbCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets assessed database count.", + "readOnly": true + }, + "discoveredDBCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the total discovered database count.", + "readOnly": true + }, + "hasScanOccurred": { + "type": "boolean", + "description": "Gets or sets a value indicating whether instance deep discovery has occurred or\nnot.", + "readOnly": true + }, + "recommendedAzureSqlTargetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets or sets the recommended azure SQL target type.", + "readOnly": true + }, + "recommendedSuitability": { + "$ref": "#/definitions/RecommendedSuitability", + "description": "Gets or sets the recommended azure SQL suitability.", + "readOnly": true + }, + "azureSqlMISuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "SQL instance azure SQL MI suitability details.", + "readOnly": true + }, + "azureSqlDBSuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "SQL instance azure SQL DB suitability details.", + "readOnly": true + }, + "azureSqlVMSuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2IaasSuitabilityData", + "description": "SQL instance azure SQL VM suitability details.", + "readOnly": true + }, + "assessedSqlEntityArmId": { + "type": "string", + "description": "Gets or sets Arm id of assessed entity." + }, + "isClustered": { + "type": "boolean", + "description": "Gets or sets a value indicating whether the SQL instance is clustered or not.", + "readOnly": true + }, + "isHighAvailabilityEnabled": { + "type": "boolean", + "description": "Gets or sets a value indicating whether the high availability is enabled or not.", + "readOnly": true + }, + "sqlEdition": { + "type": "string", + "description": "Gets the SQL edition from the recommended entity if applicable.", + "readOnly": true + }, + "sqlVersion": { + "type": "string", + "description": "Gets the SQL version from the recommended entity if applicable.", + "readOnly": true + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion.", + "readOnly": true + } + } + }, + "AssessedWebApp": { + "type": "object", + "description": "Data model of Assessed Web App.", + "properties": { + "suitabilityResult": { + "$ref": "#/definitions/SuitabilityResult", + "description": "Gets suitability result.", + "readOnly": true + }, + "recommendationResult": { + "$ref": "#/definitions/RecommendationResult", + "description": "Gets recommendation result.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/WebApp" + } + ] + }, + "AssessedWebAppV2": { + "type": "object", + "description": "Assessed Web app web model class.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedWebAppV2Properties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedWebAppV2ListResult": { + "type": "object", + "description": "The response of a AssessedWebAppV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedWebAppV2 items on this page", + "items": { + "$ref": "#/definitions/AssessedWebAppV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedWebAppV2Properties": { + "type": "object", + "description": "Assessed Web app database properties web model.", + "properties": { + "webAppType": { + "$ref": "#/definitions/WebAppType", + "description": "Gets or sets the web app type.", + "readOnly": true + }, + "targetSpecificResult": { + "type": "object", + "description": "Gets or sets the target specific result.", + "additionalProperties": { + "$ref": "#/definitions/TargetSpecificResult" + }, + "readOnly": true + }, + "appServicePlanName": { + "type": "string", + "description": "Gets or sets the app service plan name.", + "readOnly": true + }, + "machineName": { + "type": "string", + "description": "Gets the machine name.", + "readOnly": true + }, + "serverArmId": { + "type": "string", + "description": "Gets or sets the server ARM Id.", + "readOnly": true + }, + "webServerName": { + "type": "string", + "description": "Gets or sets the web server name.", + "readOnly": true + }, + "webAppName": { + "type": "string", + "description": "Gets or sets web app name.", + "readOnly": true + }, + "discoveredWebAppId": { + "type": "string", + "description": "Gets the discovered web app ID.", + "readOnly": true + }, + "discoveredMachineId": { + "type": "string", + "description": "Machine arm id.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL database first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed Web app database last updated.", + "readOnly": true + } + }, + "required": [ + "appServicePlanName", + "machineName" + ] + }, + "AssessedWebApplication": { + "type": "object", + "description": "ARM model of Assessed Web Application.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedWebApplicationProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedWebApplicationListResult": { + "type": "object", + "description": "The response of a AssessedWebApplication list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedWebApplication items on this page", + "items": { + "$ref": "#/definitions/AssessedWebApplication" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedWebApplicationProperties": { + "type": "object", + "description": "ARM model of Assessed Web Application Properties.", + "allOf": [ + { + "$ref": "#/definitions/AssessedWebApp" + } + ] + }, + "Assessment": { + "type": "object", + "description": "Machine assessment resource.", + "properties": { + "properties": { + "$ref": "#/definitions/MachineAssessmentProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessmentDetails": { + "type": "object", + "description": "Data model of Details of Assessment Computation.", + "properties": { + "pricesTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets last time when rates were queried.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Gets Confidence score.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets date and time when assessment was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets date and time when assessment was last updated.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/AssessmentStatus", + "description": "Gets assessment status.", + "readOnly": true + } + }, + "required": [ + "createdTimestamp", + "updatedTimestamp", + "status" + ] + }, + "AssessmentListResult": { + "type": "object", + "description": "The response of a Assessment list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Assessment items on this page", + "items": { + "$ref": "#/definitions/Assessment" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessmentOptions": { + "type": "object", + "description": "Assessment options resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessmentOptionsProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessmentOptionsListResult": { + "type": "object", + "description": "The response of a AssessmentOptions list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessmentOptions items on this page", + "items": { + "$ref": "#/definitions/AssessmentOptions" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessmentOptionsProperties": { + "type": "object", + "description": "Assessment options properties.", + "properties": { + "vmFamilies": { + "type": "array", + "description": "Dictionary of VM families grouped by vm family name describing the targeted\nazure locations of VM family and the category of the family.", + "items": { + "$ref": "#/definitions/VmFamilyOptions" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "reservedInstanceVmFamilies": { + "type": "array", + "description": "List of supported VM Families.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "reservedInstanceSupportedLocations": { + "type": "array", + "description": "List of supported Azure regions for reserved instances.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "reservedInstanceSupportedCurrencies": { + "type": "array", + "description": "List of supported currencies for reserved instances.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "reservedInstanceSupportedOffers": { + "type": "array", + "description": "List of supported Azure offer codes for reserved instances.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "ultraDiskVmFamilies": { + "type": "array", + "description": "Ultra disk related assessment options.", + "items": { + "$ref": "#/definitions/UltraDiskAssessmentOptions" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "premiumDiskVmFamilies": { + "type": "array", + "description": "List of VM Families that support premium disks for assessments.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "savingsPlanVmFamilies": { + "type": "array", + "description": "List of VM Families that support Savings plan offer for assessments.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "savingsPlanSupportedLocations": { + "type": "array", + "description": "List of Azure locations that support Savings plan offer for assessments.", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "AssessmentProject": { + "type": "object", + "description": "An Assessment project site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/ProjectProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "AssessmentProjectListResult": { + "type": "object", + "description": "The response of a AssessmentProject list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessmentProject items on this page", + "items": { + "$ref": "#/definitions/AssessmentProject" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessmentProjectSummary": { + "type": "object", + "description": "Assessment project summary resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessmentProjectSummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessmentProjectSummaryListResult": { + "type": "object", + "description": "The response of a AssessmentProjectSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessmentProjectSummary items on this page", + "items": { + "$ref": "#/definitions/AssessmentProjectSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessmentProjectSummaryProperties": { + "type": "object", + "description": "Assessment project summary properties class.", + "properties": { + "errorSummaryAffectedEntities": { + "type": "array", + "description": "Gets the Error summary by feature. Contains number of affected Entities per\nfeature.", + "items": { + "$ref": "#/definitions/ErrorSummary" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "numberOfPrivateEndpointConnections": { + "type": "integer", + "format": "int32", + "description": "Gets the number of private endpoint connections.", + "readOnly": true + }, + "numberOfGroups": { + "type": "integer", + "format": "int32", + "description": "Gets the number of groups created in this project.", + "readOnly": true + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Gets the number of machines part of this project.", + "readOnly": true + }, + "numberOfImportMachines": { + "type": "integer", + "format": "int32", + "description": "Gets the number of import machines part of this project.", + "readOnly": true + }, + "numberOfAssessments": { + "type": "integer", + "format": "int32", + "description": "Gets the number of assessments created in this project.", + "readOnly": true + }, + "lastAssessmentTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets the last assessment timestamp.", + "readOnly": true + } + } + }, + "AssessmentProjectUpdate": { + "type": "object", + "description": "The type used for update operations of the AssessmentProject.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/AssessmentProjectUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "AssessmentProjectUpdateProperties": { + "type": "object", + "description": "The updatable properties of the AssessmentProject.", + "properties": { + "assessmentSolutionId": { + "type": "string", + "description": "Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects." + }, + "projectStatus": { + "$ref": "#/definitions/ProjectStatus", + "description": "Assessment project status." + }, + "customerWorkspaceId": { + "type": "string", + "description": "The ARM id of service map workspace created by customer." + }, + "customerWorkspaceLocation": { + "type": "string", + "description": "Location of service map workspace created by customer." + }, + "publicNetworkAccess": { + "type": "string", + "description": "This value can be set to 'enabled' to avoid breaking changes on existing\ncustomer resources and templates. If set to 'disabled', traffic over public\ninterface is not allowed, and private endpoint connections would be the\nexclusive access method." + }, + "customerStorageAccountArmId": { + "type": "string", + "description": "The ARM id of the storage account used for interactions when public access is\ndisabled." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "AssessmentPropertiesBase": { + "type": "object", + "description": "Base ARM model of Assessment ARM properties.", + "properties": { + "scope": { + "$ref": "#/definitions/AssessmentScopeParameters", + "description": "Gets or sets scope parameters to identify inventory items for assessment." + } + }, + "allOf": [ + { + "$ref": "#/definitions/MutableArmResource" + } + ] + }, + "AssessmentResult": { + "type": "object", + "description": "Assessment results.", + "properties": { + "appServicePlanName": { + "type": "string", + "description": "Gets or sets the app service plan name." + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets or sets the suitability." + }, + "securitySuitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets or sets the security suitability." + }, + "webAppSkuName": { + "type": "string", + "description": "Gets or sets the web app sku name." + }, + "webAppSkuSize": { + "type": "string", + "description": "Gets or sets the web app sku size." + } + }, + "required": [ + "appServicePlanName", + "suitability", + "securitySuitability", + "webAppSkuName", + "webAppSkuSize" + ] + }, + "AssessmentScopeParameters": { + "type": "object", + "description": "Data model of Assessment Scope Parameters.", + "properties": { + "serverGroupId": { + "type": "string", + "description": "Gets or sets the server group id." + } + } + }, + "AssessmentSettings": { + "type": "object", + "description": "Base data model of Assessment Settings.", + "properties": { + "azureLocation": { + "type": "string", + "description": "Gets or sets azure location." + }, + "environmentType": { + "$ref": "#/definitions/AzureEnvironmentType", + "description": "Gets or sets environment type." + }, + "licensingProgram": { + "$ref": "#/definitions/LicensingProgram", + "description": "Gets or sets licensing program." + }, + "currency": { + "$ref": "#/definitions/AzureCurrency", + "description": "Gets or sets currency." + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Gets or sets discount percentage." + }, + "sizingCriteria": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Gets or sets sizing criteria." + }, + "performanceData": { + "$ref": "#/definitions/PerfDataSettings", + "description": "Gets or sets performance data settings." + }, + "scalingFactor": { + "type": "number", + "format": "float", + "description": "Gets or sets scaling factor." + } + }, + "required": [ + "azureLocation", + "environmentType", + "licensingProgram", + "currency", + "sizingCriteria" + ] + }, + "AssessmentSizingCriterion": { + "type": "string", + "description": "Assessment Sizing Criteria.", + "enum": [ + "PerformanceBased", + "AsOnPremises" + ], + "x-ms-enum": { + "name": "AssessmentSizingCriterion", + "modelAsString": true, + "values": [ + { + "name": "PerformanceBased", + "value": "PerformanceBased", + "description": "Performance Data based Sizing." + }, + { + "name": "AsOnPremises", + "value": "AsOnPremises", + "description": "As On Premises or Static Data based Sizing." + } + ] + } + }, + "AssessmentStage": { + "type": "string", + "enum": [ + "InProgress", + "UnderReview", + "Approved" + ], + "x-ms-enum": { + "name": "AssessmentStage", + "modelAsString": true + } + }, + "AssessmentStatus": { + "type": "string", + "description": "Assessment Status.", + "enum": [ + "Created", + "Updated", + "Running", + "Completed", + "Invalid", + "OutOfSync", + "OutDated", + "Deleted" + ], + "x-ms-enum": { + "name": "AssessmentStatus", + "modelAsString": true, + "values": [ + { + "name": "Created", + "value": "Created", + "description": "Assessment is Created." + }, + { + "name": "Updated", + "value": "Updated", + "description": "Assessment is Updated." + }, + { + "name": "Running", + "value": "Running", + "description": "Assessment is currently running." + }, + { + "name": "Completed", + "value": "Completed", + "description": "Assessment is Completed or Ready." + }, + { + "name": "Invalid", + "value": "Invalid", + "description": "Assessment is Failed i.e. it is now invalid." + }, + { + "name": "OutOfSync", + "value": "OutOfSync", + "description": "Assessment is Out of Sync." + }, + { + "name": "OutDated", + "value": "OutDated", + "description": "Assessment is Out Dated." + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "Assessment is Deleted." + } + ] + } + }, + "AssessmentType": { + "type": "string", + "enum": [ + "Unknown", + "MachineAssessment", + "AvsAssessment", + "SqlAssessment", + "WebAppAssessment" + ], + "x-ms-enum": { + "name": "AssessmentType", + "modelAsString": true + } + }, + "AsyncCommitModeIntent": { + "type": "string", + "enum": [ + "None", + "HighAvailability", + "DisasterRecovery" + ], + "x-ms-enum": { + "name": "AsyncCommitModeIntent", + "modelAsString": true + } + }, + "AvsAssessedDisk": { + "type": "object", + "description": "AVS assessed disk web model class.", + "properties": { + "name": { + "type": "string", + "description": "Gets the ID of the disk.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Gets the display name of the disk.", + "readOnly": true + }, + "gigabytesProvisioned": { + "type": "number", + "format": "float", + "description": "Gigabytes Provisioned for a disk in private data center.", + "readOnly": true + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "Disk Read Throughput in MB/s.", + "readOnly": true + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "Disk Write Throughput in MB/s.", + "readOnly": true + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Read Operations per second.", + "readOnly": true + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Write Operations per second.", + "readOnly": true + }, + "assessedExternalStorageType": { + "$ref": "#/definitions/ExternalStorageType", + "description": "Associated storage Type recommended for Disk.", + "readOnly": true + }, + "estimatedDiskSizeInGB": { + "type": "number", + "format": "float", + "description": "Estimated Disk Size in GB.", + "readOnly": true + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureDiskSuitabilityDetail", + "description": "Gets the suitability detail.", + "readOnly": true + } + } + }, + "AvsAssessedMachine": { + "type": "object", + "description": "AVS assessment Assessed Machine resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AvsAssessedMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AvsAssessedMachineListResult": { + "type": "object", + "description": "The response of a AvsAssessedMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AvsAssessedMachine items on this page", + "items": { + "$ref": "#/definitions/AvsAssessedMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AvsAssessedMachineProperties": { + "type": "object", + "description": "AVS assessed machine properties web model.", + "properties": { + "errors": { + "type": "array", + "description": "List of errors for this machine.", + "items": { + "$ref": "#/definitions/Error" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "disks": { + "type": "object", + "description": "List of Disks that were assessed as part of this machine's assessment.", + "additionalProperties": { + "$ref": "#/definitions/AvsAssessedDisk" + }, + "readOnly": true + }, + "networkAdapters": { + "type": "object", + "description": "List of Network Adapters that were assessed as part of this machine's\nassessment.", + "additionalProperties": { + "$ref": "#/definitions/AvsAssessedNetworkAdapter" + }, + "readOnly": true + }, + "storageInUseGB": { + "type": "number", + "format": "float", + "description": "Gets the storage in use.", + "readOnly": true + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureAvsVmSuitabilityExplanation", + "description": "Gets the explanation if machine is not suitable for cloud.", + "readOnly": true + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureAvsVmSuitabilityDetail", + "description": "Gets the details if machine is not suitable for cloud.", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/AssessedMachineType", + "description": "Assessed machine type.", + "readOnly": true + }, + "bootType": { + "$ref": "#/definitions/MachineBootType", + "description": "Boot type of machine discovered in private data center.", + "readOnly": true + }, + "operatingSystemType": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemVersion": { + "type": "string", + "description": "Operating system version as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemArchitecture": { + "$ref": "#/definitions/GuestOperatingSystemArchitecture", + "description": "Operating system architecture as reported by datacenter management solution.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine last updated.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display Name of the Machine.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description for the machine.", + "readOnly": true + }, + "datacenterMachineArmId": { + "type": "string", + "description": "Data center machine ARM id.", + "readOnly": true + }, + "datacenterManagementServerArmId": { + "type": "string", + "description": "Data center management server ARM id.", + "readOnly": true + }, + "datacenterManagementServerName": { + "type": "string", + "description": "Data center management server name.", + "readOnly": true + }, + "megabytesOfMemory": { + "type": "number", + "format": "float", + "description": "Megabytes of memory found allocated for the machine in private data center.", + "readOnly": true + }, + "numberOfCores": { + "type": "integer", + "format": "int32", + "description": "Number of CPU cores found on the machine.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "percentageCoresUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Cores Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "percentageMemoryUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Memory Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets a value indicating whether machine is suitable for the cloud platform\nselected.", + "readOnly": true + } + } + }, + "AvsAssessedNetworkAdapter": { + "type": "object", + "description": "Second level object returned as part of AVS AssessedMachine REST resource.", + "properties": { + "macAddress": { + "type": "string", + "description": "Mac address of the NIC.", + "readOnly": true + }, + "ipAddresses": { + "type": "array", + "description": "IP V4 addresses for the machine.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Gets the display name of the network adapter.", + "readOnly": true + }, + "megabytesPerSecondReceived": { + "type": "number", + "format": "float", + "description": "Gets the Received data for Network Adapter in MB/s.\n This value is\nthe percentile of historical data based on options selected in Assessment.", + "readOnly": true + }, + "megabytesPerSecondTransmitted": { + "type": "number", + "format": "float", + "description": "Gets the Transmitted data for Network Adapter in MB/s.\n This value\nis the percentile of historical data based on options selected in Assessment.", + "readOnly": true + } + } + }, + "AvsAssessment": { + "type": "object", + "description": "AVS assessment resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AvsAssessmentProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AvsAssessmentListResult": { + "type": "object", + "description": "The response of a AvsAssessment list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AvsAssessment items on this page", + "items": { + "$ref": "#/definitions/AvsAssessment" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AvsAssessmentOptions": { + "type": "object", + "description": "AVS Assessment options resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AvsAssessmentOptionsProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AvsAssessmentOptionsListResult": { + "type": "object", + "description": "The response of a AvsAssessmentOptions list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AvsAssessmentOptions items on this page", + "items": { + "$ref": "#/definitions/AvsAssessmentOptions" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AvsAssessmentOptionsProperties": { + "type": "object", + "description": "AVS Assessment options properties.", + "properties": { + "avsNodes": { + "type": "array", + "description": "AVS SKU Nodes.", + "items": { + "$ref": "#/definitions/AvsSkuOptions" + }, + "x-ms-identifiers": [] + }, + "avsExternalStorageTypes": { + "type": "array", + "description": "AVS External Storage Types Supported.", + "items": { + "$ref": "#/definitions/AvsExternalStorageOptions" + }, + "x-ms-identifiers": [] + }, + "failuresToTolerateAndRaidLevelValues": { + "type": "array", + "description": "FTT and Raid level values.", + "items": { + "$ref": "#/definitions/FttAndRaidLevel" + } + }, + "reservedInstanceAvsNodes": { + "type": "array", + "description": "List of AVS nodes for RI.", + "items": { + "$ref": "#/definitions/AzureAvsNodeType" + } + }, + "reservedInstanceSupportedLocations": { + "type": "array", + "description": "List of supported Azure regions for reserved instances.", + "items": { + "$ref": "#/definitions/AzureLocation" + } + }, + "reservedInstanceSupportedCurrencies": { + "type": "array", + "description": "List of supported currencies for reserved instances.", + "items": { + "$ref": "#/definitions/AzureCurrency" + } + }, + "reservedInstanceSupportedOffers": { + "type": "array", + "description": "List of supported Azure offer codes for reserved instances.", + "items": { + "$ref": "#/definitions/AzureOfferCode" + } + } + } + }, + "AvsAssessmentProperties": { + "type": "object", + "description": "Properties of the AVS assessment.", + "properties": { + "assessmentErrorSummary": { + "type": "object", + "description": "Gets the assessment error summary.\n This is the number of machines\naffected by each type of error in this assessment.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "failuresToTolerateAndRaidLevel": { + "$ref": "#/definitions/FttAndRaidLevel", + "description": "Failures to tolerate and RAID level in a common property." + }, + "failuresToTolerateAndRaidLevelList": { + "type": "array", + "description": "List of Failures to tolerate and RAID levels in a common property.", + "items": { + "$ref": "#/definitions/FttAndRaidLevel" + } + }, + "vcpuOversubscription": { + "type": "number", + "format": "float", + "description": "VCPU over subscription." + }, + "nodeType": { + "$ref": "#/definitions/AzureAvsNodeType", + "description": "AVS node type." + }, + "nodeTypes": { + "type": "array", + "description": "AVS node types.", + "items": { + "$ref": "#/definitions/AzureAvsNodeType" + } + }, + "externalStorageTypes": { + "type": "array", + "description": "List of AVS external storage types.", + "items": { + "$ref": "#/definitions/ExternalStorageType" + } + }, + "avsAssessmentScenario": { + "$ref": "#/definitions/AvsAssessmentScenario", + "description": "AVS Assessment Scenario." + }, + "isVcfByolEnabled": { + "type": "boolean", + "description": "Is VCF license applied" + }, + "costComponents": { + "type": "array", + "description": "collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "reservedInstance": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Reserved instance." + }, + "totalMonthlyCost": { + "type": "number", + "format": "float", + "description": "Total monthly cost.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets or sets the Assessment cloud suitability.", + "readOnly": true + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureAvsSuitabilityExplanation", + "description": "Gets or sets the Assessment suitability explanation.", + "readOnly": true + }, + "numberOfNodes": { + "type": "integer", + "format": "int32", + "description": "Recommended number of nodes.", + "readOnly": true + }, + "cpuUtilization": { + "type": "number", + "format": "float", + "description": "Predicted CPU utilization.", + "readOnly": true + }, + "ramUtilization": { + "type": "number", + "format": "float", + "description": "Predicted RAM utilization.", + "readOnly": true + }, + "storageUtilization": { + "type": "number", + "format": "float", + "description": "Predicted storage utilization.", + "readOnly": true + }, + "totalCpuCores": { + "type": "number", + "format": "float", + "description": "Predicted total CPU cores used.", + "readOnly": true + }, + "totalRamInGB": { + "type": "number", + "format": "float", + "description": "Predicted total RAM used in GB.", + "readOnly": true + }, + "totalStorageInGB": { + "type": "number", + "format": "float", + "description": "Predicted total Storage used in GB.", + "readOnly": true + }, + "avsEstimatedNodes": { + "type": "array", + "description": "EstimatedNodes AVS SKU for Assessment.", + "items": { + "$ref": "#/definitions/AvsEstimatedNode" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "avsEstimatedExternalStorages": { + "type": "array", + "description": "Estimated External Storage for Assessment.", + "items": { + "$ref": "#/definitions/AvsEstimatedExternalStorage" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "avsEstimatedNetworks": { + "type": "array", + "description": "Estimated External Storage for Assessment.", + "items": { + "$ref": "#/definitions/AvsEstimatedNetwork" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Number of machines part of the assessment.", + "readOnly": true + }, + "suitabilitySummary": { + "type": "object", + "description": "Cloud suitability summary for all the machines in the assessment.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "memOvercommit": { + "type": "number", + "format": "float", + "description": "Memory overcommit." + }, + "dedupeCompression": { + "type": "number", + "format": "float", + "description": "De-duplication compression." + }, + "limitingFactor": { + "type": "string", + "description": "Limiting factor.", + "readOnly": true + }, + "isStretchClusterEnabled": { + "type": "boolean", + "description": "Is Stretch Cluster Enabled." + }, + "groupType": { + "$ref": "#/definitions/GroupType", + "description": "Gets the group type for the assessment.", + "readOnly": true + }, + "assessmentType": { + "$ref": "#/definitions/AssessmentType", + "description": "Assessment type of the assessment.", + "readOnly": true + }, + "azureLocation": { + "$ref": "#/definitions/AzureLocation", + "description": "Azure Location or Azure region where to which the machines will be migrated." + }, + "azureOfferCode": { + "$ref": "#/definitions/AzureOfferCode", + "description": "Azure Offer code according to which cost estimation is done." + }, + "currency": { + "$ref": "#/definitions/AzureCurrency", + "description": "Currency in which prices should be reported." + }, + "scalingFactor": { + "type": "number", + "format": "float", + "description": "Percentage of buffer that user wants on performance metrics when recommending\nAzure sizes." + }, + "percentile": { + "$ref": "#/definitions/Percentile", + "description": "Percentile of the utilization data values to be considered while assessing\nmachines." + }, + "timeRange": { + "$ref": "#/definitions/TimeRange", + "description": "Time Range for which the historic utilization data should be considered for\nassessment." + }, + "perfDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the start time to consider performance data for assessment." + }, + "perfDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the end time to consider performance data for assessment." + }, + "stage": { + "$ref": "#/definitions/AssessmentStage", + "description": "User configurable setting to display the Stage of Assessment.", + "readOnly": true + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Custom discount percentage." + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion." + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "pricesTimestamp": { + "type": "string", + "format": "date-time", + "description": "Time when the Azure Prices were queried. Date-Time represented in ISO-8601\nformat.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was last updated.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/AssessmentStatus", + "description": "Whether assessment is in valid state and all machines have been assessed.", + "readOnly": true + }, + "schemaVersion": { + "type": "string", + "description": "Schema version.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "AvsExternalStorageOptions": { + "type": "object", + "description": "AVS External Storage specific options.", + "properties": { + "storageType": { + "$ref": "#/definitions/ExternalStorageType", + "description": "AVS external storage type." + }, + "targetLocations": { + "type": "array", + "description": "List of locations where this storage type is available.", + "items": { + "$ref": "#/definitions/AzureLocation" + } + } + } + }, + "AvsNodeSummary": { + "type": "object", + "description": "Azure Avs Node summary.", + "properties": { + "serversSuitableForMigration": { + "type": "integer", + "format": "int32", + "description": "Servers suitable for migration.", + "readOnly": true + }, + "totalNumberOfServers": { + "type": "integer", + "format": "int32", + "description": "The total number of servers.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "The total number of Avs VM cores.", + "readOnly": true + }, + "memoryGb": { + "type": "number", + "format": "float", + "description": "The total memory in GB.", + "readOnly": true + }, + "avsNodeCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "estimatedCost": { + "type": "number", + "format": "float", + "description": "Estimated cost.", + "readOnly": true + }, + "osLicensingCost": { + "type": "number", + "format": "float", + "description": "OS licensing cost.", + "readOnly": true + }, + "estimatedCostByRecommendedOffer": { + "type": "array", + "description": "Estimated cost by offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "recommendedAvsNodeTypeSummary": { + "type": "array", + "description": "The recommended VM family summary.", + "items": { + "$ref": "#/definitions/RecommendedAvsNodeTypeSummary" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "estimatedExternalStorage": { + "type": "array", + "description": "Estimated External Storage", + "items": { + "$ref": "#/definitions/EstimatedExternalStorage" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "estimatedNetwork": { + "type": "array", + "description": "Estimated Network", + "items": { + "$ref": "#/definitions/EstimatedNetwork" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "estimatedCostWithVcfByol": { + "type": "number", + "format": "float", + "description": "Estimated Cost With VCF BYOL", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Represents errors which might have occurred while calculating AVS Node Summary", + "items": { + "$ref": "#/definitions/ErrorDetail" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AvsEstimatedExternalStorage": { + "type": "object", + "description": "Details on the Estimated External Storage for AVS Assessment.", + "properties": { + "monthlyPrice": { + "type": "number", + "format": "float", + "description": "Total monthly cost for type of storage." + }, + "storageType": { + "$ref": "#/definitions/ExternalStorageType", + "description": "Recommended External Storage." + }, + "totalStorageInGB": { + "type": "number", + "format": "float", + "description": "Predicted total Storage used in GB." + }, + "storageUtilization": { + "type": "number", + "format": "float", + "description": "Predicted storage utilization." + } + } + }, + "AvsEstimatedNetwork": { + "type": "object", + "description": "Details on the Estimated Network Costs for AVS Assessment.", + "properties": { + "monthlyPrice": { + "type": "number", + "format": "float", + "description": "Monthly cost for network type." + }, + "networkType": { + "$ref": "#/definitions/NetworkSkuType", + "description": "Recommended Network Sku." + } + } + }, + "AvsEstimatedNode": { + "type": "object", + "description": "Details on the Estimated nodes for AVS Assessment.", + "properties": { + "monthlyPrice": { + "type": "number", + "format": "float", + "description": "Total monthly cost for type and number of nodes." + }, + "nodeType": { + "$ref": "#/definitions/AzureAvsNodeType", + "description": "Recommended SKU." + }, + "nodeNumber": { + "type": "integer", + "format": "int32", + "description": "Number of nodes that will be needed." + }, + "cpuUtilization": { + "type": "number", + "format": "float", + "description": "Predicted CPU utilization." + }, + "ramUtilization": { + "type": "number", + "format": "float", + "description": "Predicted RAM utilization." + }, + "storageUtilization": { + "type": "number", + "format": "float", + "description": "Predicted storage utilization." + }, + "totalCpu": { + "type": "number", + "format": "float", + "description": "Predicted total CPU cores across the set of nodes." + }, + "totalRam": { + "type": "number", + "format": "float", + "description": "Predicted total RAM used in GB." + }, + "totalStorage": { + "type": "number", + "format": "float", + "description": "Predicted total Storage used in GB." + }, + "pricingModel": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Pricing model indicates what hour multiplier to use while estimating the Nodes cost." + }, + "fttRaidLevel": { + "$ref": "#/definitions/FttAndRaidLevel", + "description": "FttRaidLevel recommended for Node." + } + } + }, + "AvsSkuOptions": { + "type": "object", + "description": "AVS SKU specific options.", + "properties": { + "nodeType": { + "$ref": "#/definitions/AzureAvsNodeType", + "description": "AVS Node type." + }, + "targetLocations": { + "type": "array", + "description": "List of locations where this node type is available.", + "items": { + "$ref": "#/definitions/AzureLocation" + } + } + } + }, + "AvsSummary": { + "type": "object", + "description": "Avs summary REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AvsSummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AvsSummaryListResult": { + "type": "object", + "description": "The response of a AvsSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AvsSummary items on this page", + "items": { + "$ref": "#/definitions/AvsSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AvsSummaryProperties": { + "type": "object", + "description": "Avs summary properties class.", + "properties": { + "azureAvsSummary": { + "$ref": "#/definitions/AzureAvsSummary", + "description": "The Azure Avs summary.", + "readOnly": true + }, + "onPremisesAvsSummary": { + "$ref": "#/definitions/OnPremisesIaasSummary", + "description": "The on premises IaaS summary.", + "readOnly": true + } + } + }, + "AzureAppServiceContainerSummary": { + "type": "object", + "description": "Shows Azure App Service Container summary.", + "properties": { + "estimatedCostByOffer": { + "type": "array", + "description": "Estimated cost by recommendation offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionBySku": { + "type": "array", + "description": "Distribution by SKU.", + "items": { + "$ref": "#/definitions/WebAppTargetSku" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByApp": { + "type": "array", + "description": "Distribution by application type.", + "items": { + "$ref": "#/definitions/WebAppDistribution" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureAppServiceSummary": { + "type": "object", + "description": "Shows Azure App Service summary.", + "properties": { + "estimatedCostByOffer": { + "type": "array", + "description": "Estimated cost by recommendation offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionBySku": { + "type": "array", + "description": "Distribution by SKU.", + "items": { + "$ref": "#/definitions/AppServiceSku" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByApp": { + "type": "array", + "description": "Distribution by application type.", + "items": { + "$ref": "#/definitions/WebAppDistribution" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureAvsNodeType": { + "type": "string", + "enum": [ + "Unknown", + "AV36", + "AV36P", + "AV52", + "AV64" + ], + "x-ms-enum": { + "name": "AzureAvsNodeType", + "modelAsString": true + } + }, + "AzureAvsSuitabilityExplanation": { + "type": "string", + "enum": [ + "Unknown", + "NotApplicable", + "UnsupportedLocationForSelectedNode", + "InternalErrorInRecommendation", + "UnsupportedLocationForSelectedExternalStorageTypes" + ], + "x-ms-enum": { + "name": "AzureAvsSuitabilityExplanation", + "modelAsString": true + } + }, + "AzureAvsSummary": { + "type": "object", + "description": "The Azure AVS summary.", + "properties": { + "yearOnYearEstimates": { + "$ref": "#/definitions/YearOnYearEstimates", + "description": "Shows the year-on-year cost overall.", + "readOnly": true + }, + "avsNodeSummary": { + "$ref": "#/definitions/AvsNodeSummary", + "description": "Avs virtual machine summary.", + "readOnly": true + }, + "avsCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + } + } + }, + "AzureAvsVmSuitabilityDetail": { + "type": "string", + "enum": [ + "None", + "PercentageOfCoresUtilizedMissing", + "PercentageOfMemoryUtilizedMissing", + "PercentageOfCoresUtilizedOutOfRange", + "PercentageOfMemoryUtilizedOutOfRange", + "PercentageOfStorageUtilizedOutOfRange" + ], + "x-ms-enum": { + "name": "AzureAvsVmSuitabilityDetail", + "modelAsString": true + } + }, + "AzureAvsVmSuitabilityExplanation": { + "type": "string", + "enum": [ + "Unknown", + "NotApplicable", + "IpV6NotSupported", + "UnsupportedOperatingSystem" + ], + "x-ms-enum": { + "name": "AzureAvsVmSuitabilityExplanation", + "modelAsString": true + } + }, + "AzureCurrency": { + "type": "string", + "description": "Currency for Azure.", + "enum": [ + "Unknown", + "USD", + "DKK", + "CAD", + "IDR", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SAR", + "ZAR", + "SEK", + "TRY", + "GBP", + "MXN", + "MYR", + "INR", + "HKD", + "BRL", + "TWD", + "EUR", + "CHF", + "ARS", + "AUD", + "CNY" + ], + "x-ms-enum": { + "name": "AzureCurrency", + "modelAsString": true + } + }, + "AzureDiskSize": { + "type": "string", + "enum": [ + "Unknown", + "Standard_S4", + "Standard_S6", + "Standard_S10", + "Standard_S15", + "Standard_S20", + "Standard_S30", + "Standard_S40", + "Standard_S50", + "Standard_S60", + "Standard_S70", + "Standard_S80", + "Premium_P4", + "Premium_P6", + "Premium_P10", + "Premium_P15", + "Premium_P20", + "Premium_P30", + "Premium_P40", + "Premium_P50", + "Premium_P60", + "Premium_P70", + "Premium_P80", + "StandardSSD_E10", + "StandardSSD_E15", + "StandardSSD_E20", + "StandardSSD_E30", + "StandardSSD_E40", + "StandardSSD_E50", + "StandardSSD_E60", + "StandardSSD_E70", + "StandardSSD_E80", + "StandardSSD_E4", + "StandardSSD_E6", + "StandardSSD_E1", + "StandardSSD_E2", + "StandardSSD_E3", + "Premium_P1", + "Premium_P2", + "Premium_P3", + "Ultra", + "PremiumV2" + ], + "x-ms-enum": { + "name": "AzureDiskSize", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "StandardS4", + "value": "Standard_S4" + }, + { + "name": "StandardS6", + "value": "Standard_S6" + }, + { + "name": "StandardS10", + "value": "Standard_S10" + }, + { + "name": "StandardS15", + "value": "Standard_S15" + }, + { + "name": "StandardS20", + "value": "Standard_S20" + }, + { + "name": "StandardS30", + "value": "Standard_S30" + }, + { + "name": "StandardS40", + "value": "Standard_S40" + }, + { + "name": "StandardS50", + "value": "Standard_S50" + }, + { + "name": "StandardS60", + "value": "Standard_S60" + }, + { + "name": "StandardS70", + "value": "Standard_S70" + }, + { + "name": "StandardS80", + "value": "Standard_S80" + }, + { + "name": "PremiumP4", + "value": "Premium_P4" + }, + { + "name": "PremiumP6", + "value": "Premium_P6" + }, + { + "name": "PremiumP10", + "value": "Premium_P10" + }, + { + "name": "PremiumP15", + "value": "Premium_P15" + }, + { + "name": "PremiumP20", + "value": "Premium_P20" + }, + { + "name": "PremiumP30", + "value": "Premium_P30" + }, + { + "name": "PremiumP40", + "value": "Premium_P40" + }, + { + "name": "PremiumP50", + "value": "Premium_P50" + }, + { + "name": "PremiumP60", + "value": "Premium_P60" + }, + { + "name": "PremiumP70", + "value": "Premium_P70" + }, + { + "name": "PremiumP80", + "value": "Premium_P80" + }, + { + "name": "StandardSSDE10", + "value": "StandardSSD_E10" + }, + { + "name": "StandardSSDE15", + "value": "StandardSSD_E15" + }, + { + "name": "StandardSSDE20", + "value": "StandardSSD_E20" + }, + { + "name": "StandardSSDE30", + "value": "StandardSSD_E30" + }, + { + "name": "StandardSSDE40", + "value": "StandardSSD_E40" + }, + { + "name": "StandardSSDE50", + "value": "StandardSSD_E50" + }, + { + "name": "StandardSSDE60", + "value": "StandardSSD_E60" + }, + { + "name": "StandardSSDE70", + "value": "StandardSSD_E70" + }, + { + "name": "StandardSSDE80", + "value": "StandardSSD_E80" + }, + { + "name": "StandardSSDE4", + "value": "StandardSSD_E4" + }, + { + "name": "StandardSSDE6", + "value": "StandardSSD_E6" + }, + { + "name": "StandardSSDE1", + "value": "StandardSSD_E1" + }, + { + "name": "StandardSSDE2", + "value": "StandardSSD_E2" + }, + { + "name": "StandardSSDE3", + "value": "StandardSSD_E3" + }, + { + "name": "PremiumP1", + "value": "Premium_P1" + }, + { + "name": "PremiumP2", + "value": "Premium_P2" + }, + { + "name": "PremiumP3", + "value": "Premium_P3" + }, + { + "name": "Ultra", + "value": "Ultra" + }, + { + "name": "PremiumV2", + "value": "PremiumV2" + } + ] + } + }, + "AzureDiskSuitabilityDetail": { + "type": "string", + "enum": [ + "None", + "NumberOfReadOperationsPerSecondMissing", + "NumberOfWriteOperationsPerSecondMissing", + "MegabytesPerSecondOfReadMissing", + "MegabytesPerSecondOfWriteMissing", + "DiskGigabytesConsumedMissing", + "DiskGigabytesProvisionedMissing", + "NumberOfReadOperationsPerSecondOutOfRange", + "NumberOfWriteOperationsPerSecondOutOfRange", + "MegabytesPerSecondOfReadOutOfRange", + "MegabytesPerSecondOfWriteOutOfRange", + "DiskGigabytesConsumedOutOfRange", + "DiskGigabytesProvisionedOutOfRange" + ], + "x-ms-enum": { + "name": "AzureDiskSuitabilityDetail", + "modelAsString": true + } + }, + "AzureDiskSuitabilityExplanation": { + "type": "string", + "enum": [ + "Unknown", + "NotApplicable", + "DiskSizeGreaterThanSupported", + "NoSuitableDiskSizeForIops", + "NoSuitableDiskSizeForThroughput", + "NoDiskSizeFoundInSelectedLocation", + "NoDiskSizeFoundForSelectedRedundancy", + "InternalErrorOccurredForDiskEvaluation", + "NoEaPriceFoundForDiskSize" + ], + "x-ms-enum": { + "name": "AzureDiskSuitabilityExplanation", + "modelAsString": true + } + }, + "AzureDiskType": { + "type": "string", + "enum": [ + "Unknown", + "Standard", + "StandardSSD", + "Premium", + "StandardOrPremium", + "Ultra", + "PremiumV2" + ], + "x-ms-enum": { + "name": "AzureDiskType", + "modelAsString": true + } + }, + "AzureEnvironmentType": { + "type": "string", + "description": "Environment Type for Azure.", + "enum": [ + "Unknown", + "DevTest", + "Production" + ], + "x-ms-enum": { + "name": "AzureEnvironmentType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown. Indicates missing data." + }, + { + "name": "DevTest", + "value": "DevTest", + "description": "Development or Test Environment." + }, + { + "name": "Production", + "value": "Production", + "description": "Production Environment." + } + ] + } + }, + "AzureHybridUseBenefit": { + "type": "string", + "enum": [ + "Unknown", + "Yes", + "No" + ], + "x-ms-enum": { + "name": "AzureHybridUseBenefit", + "modelAsString": true + } + }, + "AzureIaasSqlSummary": { + "type": "object", + "description": "Azure Iaas sql server summary.", + "properties": { + "totalSqlEntities": { + "type": "integer", + "format": "int32", + "description": "Total SQL entities.", + "readOnly": true + }, + "suitableSqlEntities": { + "type": "integer", + "format": "int32", + "description": "Suitable SQL entities.", + "readOnly": true + }, + "azureSqlCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "estimatedCost": { + "type": "number", + "format": "float", + "description": "Estimated cost.", + "readOnly": true + }, + "osLicensingCost": { + "type": "number", + "format": "float", + "description": "OS licensing cost.", + "readOnly": true + }, + "estimatedCostByRecommendedOffer": { + "type": "array", + "description": "Estimated cost by offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "recommendedVmFamilySummary": { + "type": "array", + "description": "The recommended VM family summary.", + "items": { + "$ref": "#/definitions/RecommendedVmFamilySummary" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "costByStorageType": { + "type": "array", + "description": "The cost by storage type.", + "items": { + "$ref": "#/definitions/CostByStorageType" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureIaasSummary": { + "type": "object", + "description": "The Azure IaaS summary.", + "properties": { + "yearOnYearEstimates": { + "$ref": "#/definitions/YearOnYearEstimates", + "description": "Shows the year-on-year cost overall.", + "readOnly": true + }, + "azureIaasVmSummary": { + "$ref": "#/definitions/AzureIaasVmSummary", + "description": "Azure Iaas virtual machine summary.", + "readOnly": true + }, + "azureIaasSqlSummary": { + "$ref": "#/definitions/AzureIaasSqlSummary", + "description": "Azure Iaas sql server summary.", + "readOnly": true + }, + "azureIaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + } + } + }, + "AzureIaasVmSummary": { + "type": "object", + "description": "Azure Iaas virtual machine summary.", + "properties": { + "serversSuitableForMigration": { + "type": "integer", + "format": "int32", + "description": "Servers suitable for migration.", + "readOnly": true + }, + "totalNumberOfServers": { + "type": "integer", + "format": "int32", + "description": "The total number of servers.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "The total number of IaaS VM cores.", + "readOnly": true + }, + "memoryGb": { + "type": "number", + "format": "float", + "description": "The total memory in GB.", + "readOnly": true + }, + "azureVmCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "estimatedCost": { + "type": "number", + "format": "float", + "description": "Estimated cost.", + "readOnly": true + }, + "osLicensingCost": { + "type": "number", + "format": "float", + "description": "OS licensing cost.", + "readOnly": true + }, + "estimatedCostByRecommendedOffer": { + "type": "array", + "description": "Estimated cost by offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "recommendedVmFamilySummary": { + "type": "array", + "description": "The recommended VM family summary.", + "items": { + "$ref": "#/definitions/RecommendedVmFamilySummary" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "costByStorageType": { + "type": "array", + "description": "The cost by storage type.", + "items": { + "$ref": "#/definitions/CostByStorageType" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureKubernetesServiceSummary": { + "type": "object", + "description": "Shows Azure Kubernetes Service summary.", + "properties": { + "estimatedCostByOffer": { + "type": "array", + "description": "Estimated cost by recommendation offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionBySku": { + "type": "array", + "description": "Distribution by SKU.", + "items": { + "$ref": "#/definitions/WebAppTargetSku" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByApp": { + "type": "array", + "description": "Distribution by application type.", + "items": { + "$ref": "#/definitions/WebAppDistribution" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureLocation": { + "type": "string", + "description": "Location for Azure.", + "enum": [ + "Unknown", + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "CentralIndia", + "SouthIndia", + "WestIndia", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "WestUs2", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "WestCentralUs", + "GermanyCentral", + "GermanyNortheast", + "ChinaNorth", + "ChinaEast", + "USGovArizona", + "USGovTexas", + "USGovIowa", + "USGovVirginia", + "USDoDCentral", + "USDoDEast", + "FranceCentral", + "AustraliaCentral", + "SouthAfricaNorth", + "FranceSouth", + "AustraliaCentral2", + "SouthAfricaWest", + "GermanyNorth", + "GermanyWestCentral", + "NorwayEast", + "NorwayWest", + "ChinaEast2", + "ChinaNorth2", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UAECentral", + "UsNatEast", + "UsNatWest", + "UsSecEast", + "UsSecCentral", + "UsSecWest", + "SwedenCentral", + "QatarCentral" + ], + "x-ms-enum": { + "name": "AzureLocation", + "modelAsString": true + } + }, + "AzureManagedDiskSkuDTO": { + "type": "object", + "description": "Class representing an Azure Managed Disk SKU.", + "properties": { + "diskType": { + "$ref": "#/definitions/AzureManagedDiskSkuDTODiskType", + "description": "Gets the Type (\"tier\") of disk - e.g. standard, premium, ultra.", + "readOnly": true + }, + "diskSize": { + "$ref": "#/definitions/AzureDiskSize", + "description": "Gets the Size of the managed disk - e.g. P30, P40.", + "readOnly": true + }, + "diskRedundancy": { + "$ref": "#/definitions/AzureManagedDiskSkuDTODiskRedundancy", + "description": "Gets disk redundancy - e.g. LRS, ZRS.", + "readOnly": true + }, + "storageCost": { + "type": "number", + "format": "float", + "description": "Gets the managed disk storage cost.", + "readOnly": true + }, + "recommendedSizeInGib": { + "type": "number", + "format": "float", + "description": "Gets the recommended in GB of the managed disk.", + "readOnly": true + }, + "recommendedThroughputInMbps": { + "type": "number", + "format": "float", + "description": "Gets the recommended throughput in MBPS of the managed disk.", + "readOnly": true + }, + "recommendedIops": { + "type": "number", + "format": "float", + "description": "Gets the recommended IOPS of the managed disk.", + "readOnly": true + } + } + }, + "AzureManagedDiskSkuDTODiskRedundancy": { + "type": "string", + "enum": [ + "Unknown", + "LRS", + "ZRS" + ], + "x-ms-enum": { + "name": "AzureManagedDiskSkuDTODiskRedundancy", + "modelAsString": true + } + }, + "AzureManagedDiskSkuDTODiskType": { + "type": "string", + "enum": [ + "Unknown", + "Standard", + "StandardSSD", + "Premium", + "StandardOrPremium", + "Ultra", + "PremiumV2" + ], + "x-ms-enum": { + "name": "AzureManagedDiskSkuDTODiskType", + "modelAsString": true + } + }, + "AzureNetworkAdapterSuitabilityDetail": { + "type": "string", + "enum": [ + "None", + "MegabytesOfDataTransmittedMissing", + "MegabytesOfDataTransmittedOutOfRange", + "MegabytesOfDataRecievedMissing", + "MegabytesOfDataRecievedOutOfRange" + ], + "x-ms-enum": { + "name": "AzureNetworkAdapterSuitabilityDetail", + "modelAsString": true + } + }, + "AzureNetworkAdapterSuitabilityExplanation": { + "type": "string", + "enum": [ + "Unknown", + "NotApplicable", + "InternalErrorOccurred" + ], + "x-ms-enum": { + "name": "AzureNetworkAdapterSuitabilityExplanation", + "modelAsString": true + } + }, + "AzureOfferCode": { + "type": "string", + "enum": [ + "Unknown", + "MSAZR0003P", + "MSAZR0044P", + "MSAZR0059P", + "MSAZR0060P", + "MSAZR0062P", + "MSAZR0063P", + "MSAZR0064P", + "MSAZR0029P", + "MSAZR0022P", + "MSAZR0023P", + "MSAZR0148P", + "MSAZR0025P", + "MSAZR0036P", + "MSAZR0120P", + "MSAZR0121P", + "MSAZR0122P", + "MSAZR0123P", + "MSAZR0124P", + "MSAZR0125P", + "MSAZR0126P", + "MSAZR0127P", + "MSAZR0128P", + "MSAZR0129P", + "MSAZR0130P", + "MSAZR0111P", + "MSAZR0144P", + "MSAZR0149P", + "MSMCAZR0044P", + "MSMCAZR0059P", + "MSMCAZR0060P", + "MSMCAZR0063P", + "MSMCAZR0120P", + "MSMCAZR0121P", + "MSMCAZR0125P", + "MSMCAZR0128P", + "MSAZRDE0003P", + "MSAZRDE0044P", + "MSAZRUSGOV0003P", + "EA", + "MSAZR0243P", + "SavingsPlan1Year", + "SavingsPlan3Year" + ], + "x-ms-enum": { + "name": "AzureOfferCode", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "Msazr0003P", + "value": "MSAZR0003P" + }, + { + "name": "Msazr0044P", + "value": "MSAZR0044P" + }, + { + "name": "Msazr0059P", + "value": "MSAZR0059P" + }, + { + "name": "Msazr0060P", + "value": "MSAZR0060P" + }, + { + "name": "Msazr0062P", + "value": "MSAZR0062P" + }, + { + "name": "Msazr0063P", + "value": "MSAZR0063P" + }, + { + "name": "Msazr0064P", + "value": "MSAZR0064P" + }, + { + "name": "Msazr0029P", + "value": "MSAZR0029P" + }, + { + "name": "Msazr0022P", + "value": "MSAZR0022P" + }, + { + "name": "Msazr0023P", + "value": "MSAZR0023P" + }, + { + "name": "Msazr0148P", + "value": "MSAZR0148P" + }, + { + "name": "Msazr0025P", + "value": "MSAZR0025P" + }, + { + "name": "Msazr0036P", + "value": "MSAZR0036P" + }, + { + "name": "Msazr0120P", + "value": "MSAZR0120P" + }, + { + "name": "Msazr0121P", + "value": "MSAZR0121P" + }, + { + "name": "Msazr0122P", + "value": "MSAZR0122P" + }, + { + "name": "Msazr0123P", + "value": "MSAZR0123P" + }, + { + "name": "Msazr0124P", + "value": "MSAZR0124P" + }, + { + "name": "Msazr0125P", + "value": "MSAZR0125P" + }, + { + "name": "Msazr0126P", + "value": "MSAZR0126P" + }, + { + "name": "Msazr0127P", + "value": "MSAZR0127P" + }, + { + "name": "Msazr0128P", + "value": "MSAZR0128P" + }, + { + "name": "Msazr0129P", + "value": "MSAZR0129P" + }, + { + "name": "Msazr0130P", + "value": "MSAZR0130P" + }, + { + "name": "Msazr0111P", + "value": "MSAZR0111P" + }, + { + "name": "Msazr0144P", + "value": "MSAZR0144P" + }, + { + "name": "Msazr0149P", + "value": "MSAZR0149P" + }, + { + "name": "Msmcazr0044P", + "value": "MSMCAZR0044P" + }, + { + "name": "Msmcazr0059P", + "value": "MSMCAZR0059P" + }, + { + "name": "Msmcazr0060P", + "value": "MSMCAZR0060P" + }, + { + "name": "Msmcazr0063P", + "value": "MSMCAZR0063P" + }, + { + "name": "Msmcazr0120P", + "value": "MSMCAZR0120P" + }, + { + "name": "Msmcazr0121P", + "value": "MSMCAZR0121P" + }, + { + "name": "Msmcazr0125P", + "value": "MSMCAZR0125P" + }, + { + "name": "Msmcazr0128P", + "value": "MSMCAZR0128P" + }, + { + "name": "Msazrde0003P", + "value": "MSAZRDE0003P" + }, + { + "name": "Msazrde0044P", + "value": "MSAZRDE0044P" + }, + { + "name": "Msazrusgov0003P", + "value": "MSAZRUSGOV0003P" + }, + { + "name": "EA", + "value": "EA" + }, + { + "name": "Msazr0243P", + "value": "MSAZR0243P" + }, + { + "name": "SavingsPlan1Year", + "value": "SavingsPlan1Year" + }, + { + "name": "SavingsPlan3Year", + "value": "SavingsPlan3Year" + } + ] + } + }, + "AzurePaasSummary": { + "type": "object", + "description": "Shows the PaaS Azure summary.", + "properties": { + "totalSqlEntities": { + "type": "integer", + "format": "int32", + "description": "Number of Sql instances.", + "readOnly": true + }, + "suitableSqlEntities": { + "type": "integer", + "format": "int32", + "description": "Suitable Sql instances.", + "readOnly": true + }, + "totalWebApps": { + "type": "integer", + "format": "int32", + "description": "Number of web applications.", + "readOnly": true + }, + "suitableWebApps": { + "type": "integer", + "format": "int32", + "description": "Suitable web applications.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "Number of cores.", + "readOnly": true + }, + "memory": { + "type": "number", + "format": "float", + "description": "Memory Utilization.", + "readOnly": true + }, + "storage": { + "type": "number", + "format": "float", + "description": "Storage Utilization.", + "readOnly": true + }, + "estimatedCostByTarget": { + "$ref": "#/definitions/EstimatedCostByTarget", + "description": "Shows the estimated cost by target.", + "readOnly": true + }, + "estimatedSqlServerLicensingCost": { + "type": "number", + "format": "float", + "description": "estimated SQL Server licensing cost.", + "readOnly": true + }, + "azureSqlSummary": { + "$ref": "#/definitions/AzureSqlSummary", + "description": "Shows the Azure SQL details.", + "readOnly": true + }, + "azureAppServiceSummary": { + "$ref": "#/definitions/AzureAppServiceSummary", + "description": "Shows Azure App Service summary.", + "readOnly": true + }, + "azureAppServiceContainerSummary": { + "$ref": "#/definitions/AzureAppServiceContainerSummary", + "description": "Shows Azure App Service Container summary.", + "readOnly": true + }, + "azureKubernetesServiceSummary": { + "$ref": "#/definitions/AzureKubernetesServiceSummary", + "description": "Shows Azure Kubernetes Service summary.", + "readOnly": true + }, + "totalAzurePaasCost": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + } + } + }, + "AzurePricingTier": { + "type": "string", + "enum": [ + "Standard", + "Basic" + ], + "x-ms-enum": { + "name": "AzurePricingTier", + "modelAsString": true + } + }, + "AzureQuorumWitnessDTO": { + "type": "object", + "description": "Quorum Witness.", + "properties": { + "quorumWitnessType": { + "$ref": "#/definitions/AzureQuorumWitnessDTOQuorumWitnessType", + "description": "Gets quorum witness type.", + "readOnly": true + } + } + }, + "AzureQuorumWitnessDTOQuorumWitnessType": { + "type": "string", + "enum": [ + "Unknown", + "Cloud", + "Disk" + ], + "x-ms-enum": { + "name": "AzureQuorumWitnessDTOQuorumWitnessType", + "modelAsString": true + } + }, + "AzureReservedInstance": { + "type": "string", + "enum": [ + "None", + "RI1Year", + "RI3Year" + ], + "x-ms-enum": { + "name": "AzureReservedInstance", + "modelAsString": true + } + }, + "AzureResourceProperties": { + "type": "object", + "description": "Common properties for all azure tracked and proxy resources.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "AzureResourceProperties2": { + "type": "object", + "description": "Common properties for all azure tracked and proxy resources.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState2", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "AzureSecurityOfferingType": { + "type": "string", + "enum": [ + "NO", + "MDC" + ], + "x-ms-enum": { + "name": "AzureSecurityOfferingType", + "modelAsString": true + } + }, + "AzureSettings": { + "type": "object", + "description": "Azure settings for a business case.", + "properties": { + "targetLocation": { + "type": "string", + "description": "Gets or sets azure location." + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Gets azure Discount percentage.", + "minimum": 0, + "maximum": 100 + }, + "currency": { + "$ref": "#/definitions/BusinessCaseCurrency", + "description": "Business case Currency.", + "default": "USD" + }, + "businessCaseType": { + "$ref": "#/definitions/MigrationStrategy", + "description": "Migration Strategy.", + "default": "OptimizeForCost" + }, + "workloadDiscoverySource": { + "$ref": "#/definitions/DiscoverySource", + "description": "Workload discovery source.", + "default": "Appliance" + }, + "performanceDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets start time to use for performance." + }, + "performanceDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets end time to use for performance." + }, + "comfortFactor": { + "type": "number", + "format": "float", + "description": "Gets comfort factor.", + "default": 1 + }, + "performanceUtilizationPercentile": { + "type": "number", + "format": "float", + "description": "Gets utilization percentile for performance.", + "default": 95, + "minimum": 0, + "maximum": 100 + }, + "perYearMigrationCompletionPercentage": { + "type": "object", + "description": "Gets migration completion percentage per year.", + "additionalProperties": { + "format": "float", + "type": "number" + } + }, + "infrastructureGrowthRate": { + "type": "number", + "format": "float", + "description": "Gets infrastructure growth rate.", + "default": 5, + "minimum": 0, + "maximum": 100 + }, + "wacc": { + "type": "number", + "format": "float", + "description": "Gets wACC percentage.", + "minimum": 0, + "maximum": 100 + }, + "networkCostPercentage": { + "type": "number", + "format": "float", + "description": "Gets network cost percentage.", + "default": 5, + "minimum": 0, + "maximum": 100 + }, + "iaasLaborCostPercentage": { + "type": "number", + "format": "float", + "description": "Gets IaaS labour cost percentage.", + "default": 75, + "minimum": 0, + "maximum": 100 + }, + "paasLaborCostPercentage": { + "type": "number", + "format": "float", + "description": "Gets PaaS labour cost percentage.", + "default": 60, + "minimum": 0, + "maximum": 100 + }, + "avsLaborCostPercentage": { + "type": "number", + "format": "float", + "description": "Gets Avs labour cost percentage.", + "default": 75, + "minimum": 0, + "maximum": 100 + }, + "savingsOption": { + "$ref": "#/definitions/SavingsOption", + "description": "Gets the business case savings option type.", + "default": "RI3Year" + } + }, + "required": [ + "targetLocation", + "currency" + ] + }, + "AzureSqlDataBaseType": { + "type": "string", + "enum": [ + "Unknown", + "Automatic", + "SingleDatabase", + "ElasticPool" + ], + "x-ms-enum": { + "name": "AzureSqlDataBaseType", + "modelAsString": true + } + }, + "AzureSqlIaasSkuDTO": { + "type": "object", + "description": "Class representing Azure SQL IAAS SKU.", + "properties": { + "virtualMachineSize": { + "$ref": "#/definitions/AzureVirtualMachineSkuDTO", + "description": "Gets the The Azure Compute Virtual Machine.", + "readOnly": true + }, + "dataDiskSizes": { + "type": "array", + "description": "Gets the The list of data disk sizes.", + "items": { + "$ref": "#/definitions/AzureManagedDiskSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "logDiskSizes": { + "type": "array", + "description": "Gets the The list of log disk sizes.", + "items": { + "$ref": "#/definitions/AzureManagedDiskSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "azureSqlTargetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets the target type.", + "readOnly": true + } + } + }, + "AzureSqlInstanceType": { + "type": "string", + "enum": [ + "Unknown", + "Automatic", + "SingleInstance", + "InstancePools" + ], + "x-ms-enum": { + "name": "AzureSqlInstanceType", + "modelAsString": true + } + }, + "AzureSqlPaasSkuDTO": { + "type": "object", + "description": "Class representing Azure SQL PAAS SKU.", + "properties": { + "azureSqlServiceTier": { + "$ref": "#/definitions/AzureSqlServiceTier", + "description": "Gets the service tier.", + "readOnly": true + }, + "azureSqlComputeTier": { + "$ref": "#/definitions/ComputeTier", + "description": "Gets the compute tier.", + "readOnly": true + }, + "azureSqlHardwareGeneration": { + "$ref": "#/definitions/HardwareGeneration", + "description": "Gets the hardware generation.", + "readOnly": true + }, + "storageMaxSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the storage maximum size in megabytes.", + "readOnly": true + }, + "predictedDataSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the predicted data size in megabytes in the Azure SQL, will impact the\nbilling cost.", + "readOnly": true + }, + "predictedLogSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the predicted log size in megabytes in the Azure SQL, will impact the\nbilling cost.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "Gets the number of cores.", + "readOnly": true + }, + "azureSqlTargetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets the target type.", + "readOnly": true + } + } + }, + "AzureSqlPurchaseModel": { + "type": "string", + "enum": [ + "Unknown", + "VCore", + "DTU" + ], + "x-ms-enum": { + "name": "AzureSqlPurchaseModel", + "modelAsString": true + } + }, + "AzureSqlServiceTier": { + "type": "string", + "enum": [ + "Unknown", + "Automatic", + "GeneralPurpose", + "BusinessCritical", + "HyperScale" + ], + "x-ms-enum": { + "name": "AzureSqlServiceTier", + "modelAsString": true + } + }, + "AzureSqlSummary": { + "type": "object", + "description": "Shows the Azure SQL details.", + "properties": { + "estimatedCostByOffer": { + "type": "array", + "description": "Estimated cost by recommended offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByServiceTier": { + "type": "array", + "description": "Distribution by service tiers, retaining just to support older Business cases.", + "items": { + "$ref": "#/definitions/SqlServiceTier" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByServiceTierForSqlMi": { + "type": "array", + "description": "Distribution by service tiers for SQL MI.", + "items": { + "$ref": "#/definitions/SqlServiceTier" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByServiceTierForSqlDb": { + "type": "array", + "description": "Distribution by service tiers for SQL DB.", + "items": { + "$ref": "#/definitions/SqlServiceTier" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureStorageRedundancy": { + "type": "string", + "enum": [ + "Unknown", + "LocallyRedundant", + "ZoneRedundant", + "GeoRedundant", + "ReadAccessGeoRedundant" + ], + "x-ms-enum": { + "name": "AzureStorageRedundancy", + "modelAsString": true + } + }, + "AzureVirtualMachineSkuDTO": { + "type": "object", + "description": "Azure Virtual Machine SKU.", + "properties": { + "azureVmFamily": { + "$ref": "#/definitions/AzureVmFamily", + "description": "Gets the Virtual Machine Family, for example : standardMSFamily.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "Gets the Compute Size in vCores.", + "readOnly": true + }, + "azureSkuName": { + "$ref": "#/definitions/AzureVmSize", + "description": "Gets the Virtual Machine SKU name,: E.g. : Standard_F16s.", + "readOnly": true + }, + "availableCores": { + "type": "integer", + "format": "int32", + "description": "Gets the Available vCores. This can be less than the vCores in the Constrained\nvCPU VM Sizes.", + "readOnly": true + }, + "maxNetworkInterfaces": { + "type": "integer", + "format": "int32", + "description": "Gets the Max network interfaces.", + "readOnly": true + } + } + }, + "AzureVmCategory": { + "type": "string", + "description": "Azure VM Category.", + "enum": [ + "All", + "ComputeOptimized", + "GeneralPurpose", + "GpuOptimized", + "HighPerformanceCompute", + "MemoryOptimized", + "StorageOptimized", + "Isolated" + ], + "x-ms-enum": { + "name": "AzureVmCategory", + "modelAsString": true, + "values": [ + { + "name": "All", + "value": "All", + "description": "Indicates All categories of VM." + }, + { + "name": "ComputeOptimized", + "value": "ComputeOptimized", + "description": "Compute Optimized." + }, + { + "name": "GeneralPurpose", + "value": "GeneralPurpose", + "description": "General Purpose." + }, + { + "name": "GpuOptimized", + "value": "GpuOptimized", + "description": "GPU Optimized." + }, + { + "name": "HighPerformanceCompute", + "value": "HighPerformanceCompute", + "description": "High Performance Compute." + }, + { + "name": "MemoryOptimized", + "value": "MemoryOptimized", + "description": "Memory Optimized." + }, + { + "name": "StorageOptimized", + "value": "StorageOptimized", + "description": "Storage Optimized." + }, + { + "name": "Isolated", + "value": "Isolated", + "description": "Isolated VM." + } + ] + } + }, + "AzureVmFamily": { + "type": "string", + "enum": [ + "Unknown", + "Basic_A0_A4", + "Standard_A0_A7", + "Standard_A8_A11", + "Av2_series", + "D_series", + "Dv2_series", + "DS_series", + "DSv2_series", + "F_series", + "Fs_series", + "G_series", + "GS_series", + "H_series", + "Ls_series", + "Dsv3_series", + "Dv3_series", + "Fsv2_series", + "Ev3_series", + "Esv3_series", + "M_series", + "DC_Series", + "Lsv2_series", + "Ev4_series", + "Esv4_series", + "Edv4_series", + "Edsv4_series", + "Dv4_series", + "Dsv4_series", + "Ddv4_series", + "Ddsv4_series", + "Easv4_series", + "Dasv4_series", + "Mv2_series", + "Eav4_series", + "Dav4_series", + "Msv2_series", + "Mdsv2_series", + "Dv5_series", + "Dsv5_series", + "Ddv5_series", + "Ddsv5_series", + "Dasv5_series", + "Dadsv5_series", + "Ev5_series", + "Esv5_series", + "Edv5_series", + "Edsv5_series", + "Easv5_series", + "Eadsv5_series", + "Ebsv5_series", + "Ebdsv5_series" + ], + "x-ms-enum": { + "name": "AzureVmFamily", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "BasicA0A4", + "value": "Basic_A0_A4" + }, + { + "name": "StandardA0A7", + "value": "Standard_A0_A7" + }, + { + "name": "StandardA8A11", + "value": "Standard_A8_A11" + }, + { + "name": "Av2Series", + "value": "Av2_series" + }, + { + "name": "DSeries", + "value": "D_series" + }, + { + "name": "Dv2Series", + "value": "Dv2_series" + }, + { + "name": "DSSeries", + "value": "DS_series" + }, + { + "name": "DSv2Series", + "value": "DSv2_series" + }, + { + "name": "FSeries", + "value": "F_series" + }, + { + "name": "FsSeries", + "value": "Fs_series" + }, + { + "name": "GSeries", + "value": "G_series" + }, + { + "name": "GSSeries", + "value": "GS_series" + }, + { + "name": "HSeries", + "value": "H_series" + }, + { + "name": "LsSeries", + "value": "Ls_series" + }, + { + "name": "Dsv3Series", + "value": "Dsv3_series" + }, + { + "name": "Dv3Series", + "value": "Dv3_series" + }, + { + "name": "Fsv2Series", + "value": "Fsv2_series" + }, + { + "name": "Ev3Series", + "value": "Ev3_series" + }, + { + "name": "Esv3Series", + "value": "Esv3_series" + }, + { + "name": "MSeries", + "value": "M_series" + }, + { + "name": "DCSeries", + "value": "DC_Series" + }, + { + "name": "Lsv2Series", + "value": "Lsv2_series" + }, + { + "name": "Ev4Series", + "value": "Ev4_series" + }, + { + "name": "Esv4Series", + "value": "Esv4_series" + }, + { + "name": "Edv4Series", + "value": "Edv4_series" + }, + { + "name": "Edsv4Series", + "value": "Edsv4_series" + }, + { + "name": "Dv4Series", + "value": "Dv4_series" + }, + { + "name": "Dsv4Series", + "value": "Dsv4_series" + }, + { + "name": "Ddv4Series", + "value": "Ddv4_series" + }, + { + "name": "Ddsv4Series", + "value": "Ddsv4_series" + }, + { + "name": "Easv4Series", + "value": "Easv4_series" + }, + { + "name": "Dasv4Series", + "value": "Dasv4_series" + }, + { + "name": "Mv2Series", + "value": "Mv2_series" + }, + { + "name": "Eav4Series", + "value": "Eav4_series" + }, + { + "name": "Dav4Series", + "value": "Dav4_series" + }, + { + "name": "Msv2Series", + "value": "Msv2_series" + }, + { + "name": "Mdsv2Series", + "value": "Mdsv2_series" + }, + { + "name": "Dv5Series", + "value": "Dv5_series" + }, + { + "name": "Dsv5Series", + "value": "Dsv5_series" + }, + { + "name": "Ddv5Series", + "value": "Ddv5_series" + }, + { + "name": "Ddsv5Series", + "value": "Ddsv5_series" + }, + { + "name": "Dasv5Series", + "value": "Dasv5_series" + }, + { + "name": "Dadsv5Series", + "value": "Dadsv5_series" + }, + { + "name": "Ev5Series", + "value": "Ev5_series" + }, + { + "name": "Esv5Series", + "value": "Esv5_series" + }, + { + "name": "Edv5Series", + "value": "Edv5_series" + }, + { + "name": "Edsv5Series", + "value": "Edsv5_series" + }, + { + "name": "Easv5Series", + "value": "Easv5_series" + }, + { + "name": "Eadsv5Series", + "value": "Eadsv5_series" + }, + { + "name": "Ebsv5Series", + "value": "Ebsv5_series" + }, + { + "name": "Ebdsv5Series", + "value": "Ebdsv5_series" + } + ] + } + }, + "AzureVmSize": { + "type": "string", + "enum": [ + "Unknown", + "Basic_A0", + "Basic_A1", + "Basic_A2", + "Basic_A3", + "Basic_A4", + "Standard_A0", + "Standard_A1", + "Standard_A2", + "Standard_A3", + "Standard_A4", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A9", + "Standard_A10", + "Standard_A11", + "Standard_A1_v2", + "Standard_A2_v2", + "Standard_A4_v2", + "Standard_A8_v2", + "Standard_A2m_v2", + "Standard_A4m_v2", + "Standard_A8m_v2", + "Standard_D1", + "Standard_D2", + "Standard_D3", + "Standard_D4", + "Standard_D11", + "Standard_D12", + "Standard_D13", + "Standard_D14", + "Standard_D1_v2", + "Standard_D2_v2", + "Standard_D3_v2", + "Standard_D4_v2", + "Standard_D5_v2", + "Standard_D11_v2", + "Standard_D12_v2", + "Standard_D13_v2", + "Standard_D14_v2", + "Standard_D15_v2", + "Standard_DS1", + "Standard_DS2", + "Standard_DS3", + "Standard_DS4", + "Standard_DS11", + "Standard_DS12", + "Standard_DS13", + "Standard_DS14", + "Standard_DS1_v2", + "Standard_DS2_v2", + "Standard_DS3_v2", + "Standard_DS4_v2", + "Standard_DS5_v2", + "Standard_DS11_v2", + "Standard_DS12_v2", + "Standard_DS13_v2", + "Standard_DS14_v2", + "Standard_DS15_v2", + "Standard_F1", + "Standard_F2", + "Standard_F4", + "Standard_F8", + "Standard_F16", + "Standard_F1s", + "Standard_F2s", + "Standard_F4s", + "Standard_F8s", + "Standard_F16s", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS5", + "Standard_H8", + "Standard_H16", + "Standard_H8m", + "Standard_H16m", + "Standard_H16r", + "Standard_H16mr", + "Standard_L4s", + "Standard_L8s", + "Standard_L16s", + "Standard_L32s", + "Standard_D2s_v3", + "Standard_D4s_v3", + "Standard_D8s_v3", + "Standard_D16s_v3", + "Standard_D32s_v3", + "Standard_D64s_v3", + "Standard_D2_v3", + "Standard_D4_v3", + "Standard_D8_v3", + "Standard_D16_v3", + "Standard_D32_v3", + "Standard_D64_v3", + "Standard_F2s_v2", + "Standard_F4s_v2", + "Standard_F8s_v2", + "Standard_F16s_v2", + "Standard_F32s_v2", + "Standard_F64s_v2", + "Standard_F72s_v2", + "Standard_E2_v3", + "Standard_E4_v3", + "Standard_E8_v3", + "Standard_E16_v3", + "Standard_E32_v3", + "Standard_E64_v3", + "Standard_E2s_v3", + "Standard_E4s_v3", + "Standard_E8s_v3", + "Standard_E16s_v3", + "Standard_E32s_v3", + "Standard_E64s_v3", + "Standard_M64s", + "Standard_M64ms", + "Standard_M128s", + "Standard_M128ms", + "Standard_DC2s", + "Standard_DC4s", + "Standard_E20_v3", + "Standard_E20s_v3", + "Standard_E64i_v3", + "Standard_E64is_v3", + "Standard_M8ms", + "Standard_M16ms", + "Standard_M32ls", + "Standard_M32ms", + "Standard_M32ts", + "Standard_M64", + "Standard_M64ls", + "Standard_M64m", + "Standard_M128", + "Standard_M128m", + "Standard_L8s_v2", + "Standard_L16s_v2", + "Standard_L32s_v2", + "Standard_L48s_v2", + "Standard_L64s_v2", + "Standard_L80s_v2", + "Standard_D2_v4", + "Standard_D4_v4", + "Standard_D8_v4", + "Standard_D16_v4", + "Standard_D32_v4", + "Standard_D48_v4", + "Standard_D64_v4", + "Standard_D2s_v4", + "Standard_D4s_v4", + "Standard_D8s_v4", + "Standard_D16s_v4", + "Standard_D32s_v4", + "Standard_D48s_v4", + "Standard_D64s_v4", + "Standard_D2d_v4", + "Standard_D4d_v4", + "Standard_D8d_v4", + "Standard_D16d_v4", + "Standard_D32d_v4", + "Standard_D48d_v4", + "Standard_D64d_v4", + "Standard_D2ds_v4", + "Standard_D4ds_v4", + "Standard_D8ds_v4", + "Standard_D16ds_v4", + "Standard_D32ds_v4", + "Standard_D48ds_v4", + "Standard_D64ds_v4", + "Standard_E2_v4", + "Standard_E4_v4", + "Standard_E8_v4", + "Standard_E16_v4", + "Standard_E20_v4", + "Standard_E32_v4", + "Standard_E48_v4", + "Standard_E64_v4", + "Standard_E2s_v4", + "Standard_E4s_v4", + "Standard_E8s_v4", + "Standard_E16s_v4", + "Standard_E20s_v4", + "Standard_E32s_v4", + "Standard_E48s_v4", + "Standard_E64s_v4", + "Standard_E2d_v4", + "Standard_E4d_v4", + "Standard_E8d_v4", + "Standard_E16d_v4", + "Standard_E20d_v4", + "Standard_E32d_v4", + "Standard_E48d_v4", + "Standard_E64d_v4", + "Standard_E2ds_v4", + "Standard_E4ds_v4", + "Standard_E8ds_v4", + "Standard_E16ds_v4", + "Standard_E20ds_v4", + "Standard_E32ds_v4", + "Standard_E48ds_v4", + "Standard_E64ds_v4", + "Standard_E2as_v4", + "Standard_E4as_v4", + "Standard_E8as_v4", + "Standard_E16as_v4", + "Standard_E20as_v4", + "Standard_E32as_v4", + "Standard_E48as_v4", + "Standard_E64as_v4", + "Standard_E96as_v4", + "Standard_D2as_v4", + "Standard_D4as_v4", + "Standard_D8as_v4", + "Standard_D16as_v4", + "Standard_D32as_v4", + "Standard_D48as_v4", + "Standard_D64as_v4", + "Standard_D96as_v4", + "Standard_M208ms_v2", + "Standard_M208s_v2", + "Standard_M416ms_v2", + "Standard_M416s_v2", + "Standard_F48s_v2", + "Standard_E48_v3", + "Standard_E48s_v3", + "Standard_E80is_v4", + "Standard_E80ids_v4", + "Standard_E2a_v4", + "Standard_E4a_v4", + "Standard_E8a_v4", + "Standard_E16a_v4", + "Standard_E20a_v4", + "Standard_E32a_v4", + "Standard_E48a_v4", + "Standard_E64a_v4", + "Standard_E96a_v4", + "Standard_D2a_v4", + "Standard_D4a_v4", + "Standard_D8a_v4", + "Standard_D16a_v4", + "Standard_D32a_v4", + "Standard_D48a_v4", + "Standard_D64a_v4", + "Standard_D96a_v4", + "Standard_M32ms_v2", + "Standard_M64s_v2", + "Standard_M64ms_v2", + "Standard_M128s_v2", + "Standard_M128ms_v2", + "Standard_M192is_v2", + "Standard_M192ims_v2", + "Standard_M32dms_v2", + "Standard_M64ds_v2", + "Standard_M64dms_v2", + "Standard_M128ds_v2", + "Standard_M128dms_v2", + "Standard_M192ids_v2", + "Standard_M192idms_v2", + "Standard_D2_v5", + "Standard_D4_v5", + "Standard_D8_v5", + "Standard_D16_v5", + "Standard_D32_v5", + "Standard_D48_v5", + "Standard_D64_v5", + "Standard_D96_v5", + "Standard_D2s_v5", + "Standard_D4s_v5", + "Standard_D8s_v5", + "Standard_D16s_v5", + "Standard_D32s_v5", + "Standard_D48s_v5", + "Standard_D64s_v5", + "Standard_D96s_v5", + "Standard_D2d_v5", + "Standard_D4d_v5", + "Standard_D8d_v5", + "Standard_D16d_v5", + "Standard_D32d_v5", + "Standard_D48d_v5", + "Standard_D64d_v5", + "Standard_D96d_v5", + "Standard_D2ds_v5", + "Standard_D4ds_v5", + "Standard_D8ds_v5", + "Standard_D16ds_v5", + "Standard_D32ds_v5", + "Standard_D48ds_v5", + "Standard_D64ds_v5", + "Standard_D96ds_v5", + "Standard_D2as_v5", + "Standard_D4as_v5", + "Standard_D8as_v5", + "Standard_D16as_v5", + "Standard_D32as_v5", + "Standard_D48as_v5", + "Standard_D64as_v5", + "Standard_D96as_v5", + "Standard_D2ads_v5", + "Standard_D4ads_v5", + "Standard_D8ads_v5", + "Standard_D16ads_v5", + "Standard_D32ads_v5", + "Standard_D48ads_v5", + "Standard_D64ads_v5", + "Standard_D96ads_v5", + "Standard_E2_v5", + "Standard_E4_v5", + "Standard_E8_v5", + "Standard_E16_v5", + "Standard_E20_v5", + "Standard_E32_v5", + "Standard_E48_v5", + "Standard_E64_v5", + "Standard_E96_v5", + "Standard_E104i_v5", + "Standard_E2s_v5", + "Standard_E4s_v5", + "Standard_E8s_v5", + "Standard_E16s_v5", + "Standard_E20s_v5", + "Standard_E32s_v5", + "Standard_E48s_v5", + "Standard_E64s_v5", + "Standard_E96s_v5", + "Standard_E104is_v5", + "Standard_E2d_v5", + "Standard_E4d_v5", + "Standard_E8d_v5", + "Standard_E16d_v5", + "Standard_E20d_v5", + "Standard_E32d_v5", + "Standard_E48d_v5", + "Standard_E64d_v5", + "Standard_E96d_v5", + "Standard_E104id_v5", + "Standard_E2ds_v5", + "Standard_E4ds_v5", + "Standard_E8ds_v5", + "Standard_E16ds_v5", + "Standard_E20ds_v5", + "Standard_E32ds_v5", + "Standard_E48ds_v5", + "Standard_E64ds_v5", + "Standard_E96ds_v5", + "Standard_E104ids_v5", + "Standard_E2as_v5", + "Standard_E4as_v5", + "Standard_E8as_v5", + "Standard_E16as_v5", + "Standard_E20as_v5", + "Standard_E32as_v5", + "Standard_E48as_v5", + "Standard_E64as_v5", + "Standard_E96as_v5", + "Standard_E2ads_v5", + "Standard_E4ads_v5", + "Standard_E8ads_v5", + "Standard_E16ads_v5", + "Standard_E20ads_v5", + "Standard_E32ads_v5", + "Standard_E48ads_v5", + "Standard_E64ads_v5", + "Standard_E96ads_v5", + "Standard_M8_2ms", + "Standard_M8_4ms", + "Standard_M16_4ms", + "Standard_M16_8ms", + "Standard_M32_8ms", + "Standard_M32_16ms", + "Standard_M64_32ms", + "Standard_M64_16ms", + "Standard_M128_64ms", + "Standard_M128_32ms", + "Standard_E4_2s_v3", + "Standard_E8_4s_v3", + "Standard_E8_2s_v3", + "Standard_E16_8s_v3", + "Standard_E16_4s_v3", + "Standard_E32_16s_v3", + "Standard_E32_8s_v3", + "Standard_E64_32s_v3", + "Standard_E64_16s_v3", + "Standard_E4_2s_v4", + "Standard_E8_4s_v4", + "Standard_E8_2s_v4", + "Standard_E16_8s_v4", + "Standard_E16_4s_v4", + "Standard_E32_16s_v4", + "Standard_E32_8s_v4", + "Standard_E64_32s_v4", + "Standard_E64_16s_v4", + "Standard_E4_2ds_v4", + "Standard_E8_4ds_v4", + "Standard_E8_2ds_v4", + "Standard_E16_8ds_v4", + "Standard_E16_4ds_v4", + "Standard_E32_16ds_v4", + "Standard_E32_8ds_v4", + "Standard_E64_32ds_v4", + "Standard_E64_16ds_v4", + "Standard_E4_2as_v4", + "Standard_E8_4as_v4", + "Standard_E8_2as_v4", + "Standard_E16_8as_v4", + "Standard_E16_4as_v4", + "Standard_E32_16as_v4", + "Standard_E32_8as_v4", + "Standard_E64_32as_v4", + "Standard_E64_16as_v4", + "Standard_E96_48as_v4", + "Standard_E96_24as_v4", + "Standard_E4_2ads_v5", + "Standard_E8_4ads_v5", + "Standard_E8_2ads_v5", + "Standard_E16_8ads_v5", + "Standard_E16_4ads_v5", + "Standard_E32_16ads_v5", + "Standard_E32_8ads_v5", + "Standard_E64_32ads_v5", + "Standard_E64_16ads_v5", + "Standard_E96_48ads_v5", + "Standard_E96_24ads_v5", + "Standard_E4_2s_v5", + "Standard_E8_4s_v5", + "Standard_E8_2s_v5", + "Standard_E16_8s_v5", + "Standard_E16_4s_v5", + "Standard_E32_16s_v5", + "Standard_E32_8s_v5", + "Standard_E64_32s_v5", + "Standard_E64_16s_v5", + "Standard_E96_48s_v5", + "Standard_E96_24s_v5", + "Standard_E4_2ds_v5", + "Standard_E8_4ds_v5", + "Standard_E8_2ds_v5", + "Standard_E16_8ds_v5", + "Standard_E16_4ds_v5", + "Standard_E32_16ds_v5", + "Standard_E32_8ds_v5", + "Standard_E64_32ds_v5", + "Standard_E64_16ds_v5", + "Standard_E96_48ds_v5", + "Standard_E96_24ds_v5", + "Standard_E4_2as_v5", + "Standard_E8_4as_v5", + "Standard_E8_2as_v5", + "Standard_E16_8as_v5", + "Standard_E16_4as_v5", + "Standard_E32_16as_v5", + "Standard_E32_8as_v5", + "Standard_E64_32as_v5", + "Standard_E64_16as_v5", + "Standard_E96_48as_v5", + "Standard_E96_24as_v5", + "Standard_GS4_8", + "Standard_GS4_4", + "Standard_GS5_16", + "Standard_GS5_8", + "Standard_DS11_1_v2", + "Standard_DS12_2_v2", + "Standard_DS12_1_v2", + "Standard_DS13_4_v2", + "Standard_DS13_2_v2", + "Standard_DS14_8_v2", + "Standard_DS14_4_v2", + "Standard_M416_208s_v2", + "Standard_M416_208ms_v2", + "Standard_E2bs_v5", + "Standard_E4bs_v5", + "Standard_E8bs_v5", + "Standard_E16bs_v5", + "Standard_E32bs_v5", + "Standard_E48bs_v5", + "Standard_E64bs_v5", + "Standard_E2bds_v5", + "Standard_E4bds_v5", + "Standard_E8bds_v5", + "Standard_E16bds_v5", + "Standard_E32bds_v5", + "Standard_E48bds_v5", + "Standard_E64bds_v5" + ], + "x-ms-enum": { + "name": "AzureVmSize", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "BasicA0", + "value": "Basic_A0" + }, + { + "name": "BasicA1", + "value": "Basic_A1" + }, + { + "name": "BasicA2", + "value": "Basic_A2" + }, + { + "name": "BasicA3", + "value": "Basic_A3" + }, + { + "name": "BasicA4", + "value": "Basic_A4" + }, + { + "name": "StandardA0", + "value": "Standard_A0" + }, + { + "name": "StandardA1", + "value": "Standard_A1" + }, + { + "name": "StandardA2", + "value": "Standard_A2" + }, + { + "name": "StandardA3", + "value": "Standard_A3" + }, + { + "name": "StandardA4", + "value": "Standard_A4" + }, + { + "name": "StandardA5", + "value": "Standard_A5" + }, + { + "name": "StandardA6", + "value": "Standard_A6" + }, + { + "name": "StandardA7", + "value": "Standard_A7" + }, + { + "name": "StandardA8", + "value": "Standard_A8" + }, + { + "name": "StandardA9", + "value": "Standard_A9" + }, + { + "name": "StandardA10", + "value": "Standard_A10" + }, + { + "name": "StandardA11", + "value": "Standard_A11" + }, + { + "name": "StandardA1V2", + "value": "Standard_A1_v2" + }, + { + "name": "StandardA2V2", + "value": "Standard_A2_v2" + }, + { + "name": "StandardA4V2", + "value": "Standard_A4_v2" + }, + { + "name": "StandardA8V2", + "value": "Standard_A8_v2" + }, + { + "name": "StandardA2MV2", + "value": "Standard_A2m_v2" + }, + { + "name": "StandardA4MV2", + "value": "Standard_A4m_v2" + }, + { + "name": "StandardA8MV2", + "value": "Standard_A8m_v2" + }, + { + "name": "StandardD1", + "value": "Standard_D1" + }, + { + "name": "StandardD2", + "value": "Standard_D2" + }, + { + "name": "StandardD3", + "value": "Standard_D3" + }, + { + "name": "StandardD4", + "value": "Standard_D4" + }, + { + "name": "StandardD11", + "value": "Standard_D11" + }, + { + "name": "StandardD12", + "value": "Standard_D12" + }, + { + "name": "StandardD13", + "value": "Standard_D13" + }, + { + "name": "StandardD14", + "value": "Standard_D14" + }, + { + "name": "StandardD1V2", + "value": "Standard_D1_v2" + }, + { + "name": "StandardD2V2", + "value": "Standard_D2_v2" + }, + { + "name": "StandardD3V2", + "value": "Standard_D3_v2" + }, + { + "name": "StandardD4V2", + "value": "Standard_D4_v2" + }, + { + "name": "StandardD5V2", + "value": "Standard_D5_v2" + }, + { + "name": "StandardD11V2", + "value": "Standard_D11_v2" + }, + { + "name": "StandardD12V2", + "value": "Standard_D12_v2" + }, + { + "name": "StandardD13V2", + "value": "Standard_D13_v2" + }, + { + "name": "StandardD14V2", + "value": "Standard_D14_v2" + }, + { + "name": "StandardD15V2", + "value": "Standard_D15_v2" + }, + { + "name": "StandardDS1", + "value": "Standard_DS1" + }, + { + "name": "StandardDS2", + "value": "Standard_DS2" + }, + { + "name": "StandardDS3", + "value": "Standard_DS3" + }, + { + "name": "StandardDS4", + "value": "Standard_DS4" + }, + { + "name": "StandardDS11", + "value": "Standard_DS11" + }, + { + "name": "StandardDS12", + "value": "Standard_DS12" + }, + { + "name": "StandardDS13", + "value": "Standard_DS13" + }, + { + "name": "StandardDS14", + "value": "Standard_DS14" + }, + { + "name": "StandardDS1V2", + "value": "Standard_DS1_v2" + }, + { + "name": "StandardDS2V2", + "value": "Standard_DS2_v2" + }, + { + "name": "StandardDS3V2", + "value": "Standard_DS3_v2" + }, + { + "name": "StandardDS4V2", + "value": "Standard_DS4_v2" + }, + { + "name": "StandardDS5V2", + "value": "Standard_DS5_v2" + }, + { + "name": "StandardDS11V2", + "value": "Standard_DS11_v2" + }, + { + "name": "StandardDS12V2", + "value": "Standard_DS12_v2" + }, + { + "name": "StandardDS13V2", + "value": "Standard_DS13_v2" + }, + { + "name": "StandardDS14V2", + "value": "Standard_DS14_v2" + }, + { + "name": "StandardDS15V2", + "value": "Standard_DS15_v2" + }, + { + "name": "StandardF1", + "value": "Standard_F1" + }, + { + "name": "StandardF2", + "value": "Standard_F2" + }, + { + "name": "StandardF4", + "value": "Standard_F4" + }, + { + "name": "StandardF8", + "value": "Standard_F8" + }, + { + "name": "StandardF16", + "value": "Standard_F16" + }, + { + "name": "StandardF1S", + "value": "Standard_F1s" + }, + { + "name": "StandardF2S", + "value": "Standard_F2s" + }, + { + "name": "StandardF4S", + "value": "Standard_F4s" + }, + { + "name": "StandardF8S", + "value": "Standard_F8s" + }, + { + "name": "StandardF16S", + "value": "Standard_F16s" + }, + { + "name": "StandardG1", + "value": "Standard_G1" + }, + { + "name": "StandardG2", + "value": "Standard_G2" + }, + { + "name": "StandardG3", + "value": "Standard_G3" + }, + { + "name": "StandardG4", + "value": "Standard_G4" + }, + { + "name": "StandardG5", + "value": "Standard_G5" + }, + { + "name": "StandardGS1", + "value": "Standard_GS1" + }, + { + "name": "StandardGS2", + "value": "Standard_GS2" + }, + { + "name": "StandardGS3", + "value": "Standard_GS3" + }, + { + "name": "StandardGS4", + "value": "Standard_GS4" + }, + { + "name": "StandardGS5", + "value": "Standard_GS5" + }, + { + "name": "StandardH8", + "value": "Standard_H8" + }, + { + "name": "StandardH16", + "value": "Standard_H16" + }, + { + "name": "StandardH8M", + "value": "Standard_H8m" + }, + { + "name": "StandardH16M", + "value": "Standard_H16m" + }, + { + "name": "StandardH16R", + "value": "Standard_H16r" + }, + { + "name": "StandardH16Mr", + "value": "Standard_H16mr" + }, + { + "name": "StandardL4S", + "value": "Standard_L4s" + }, + { + "name": "StandardL8S", + "value": "Standard_L8s" + }, + { + "name": "StandardL16S", + "value": "Standard_L16s" + }, + { + "name": "StandardL32S", + "value": "Standard_L32s" + }, + { + "name": "StandardD2SV3", + "value": "Standard_D2s_v3" + }, + { + "name": "StandardD4SV3", + "value": "Standard_D4s_v3" + }, + { + "name": "StandardD8SV3", + "value": "Standard_D8s_v3" + }, + { + "name": "StandardD16SV3", + "value": "Standard_D16s_v3" + }, + { + "name": "StandardD32SV3", + "value": "Standard_D32s_v3" + }, + { + "name": "StandardD64SV3", + "value": "Standard_D64s_v3" + }, + { + "name": "StandardD2V3", + "value": "Standard_D2_v3" + }, + { + "name": "StandardD4V3", + "value": "Standard_D4_v3" + }, + { + "name": "StandardD8V3", + "value": "Standard_D8_v3" + }, + { + "name": "StandardD16V3", + "value": "Standard_D16_v3" + }, + { + "name": "StandardD32V3", + "value": "Standard_D32_v3" + }, + { + "name": "StandardD64V3", + "value": "Standard_D64_v3" + }, + { + "name": "StandardF2SV2", + "value": "Standard_F2s_v2" + }, + { + "name": "StandardF4SV2", + "value": "Standard_F4s_v2" + }, + { + "name": "StandardF8SV2", + "value": "Standard_F8s_v2" + }, + { + "name": "StandardF16SV2", + "value": "Standard_F16s_v2" + }, + { + "name": "StandardF32SV2", + "value": "Standard_F32s_v2" + }, + { + "name": "StandardF64SV2", + "value": "Standard_F64s_v2" + }, + { + "name": "StandardF72SV2", + "value": "Standard_F72s_v2" + }, + { + "name": "StandardE2V3", + "value": "Standard_E2_v3" + }, + { + "name": "StandardE4V3", + "value": "Standard_E4_v3" + }, + { + "name": "StandardE8V3", + "value": "Standard_E8_v3" + }, + { + "name": "StandardE16V3", + "value": "Standard_E16_v3" + }, + { + "name": "StandardE32V3", + "value": "Standard_E32_v3" + }, + { + "name": "StandardE64V3", + "value": "Standard_E64_v3" + }, + { + "name": "StandardE2SV3", + "value": "Standard_E2s_v3" + }, + { + "name": "StandardE4SV3", + "value": "Standard_E4s_v3" + }, + { + "name": "StandardE8SV3", + "value": "Standard_E8s_v3" + }, + { + "name": "StandardE16SV3", + "value": "Standard_E16s_v3" + }, + { + "name": "StandardE32SV3", + "value": "Standard_E32s_v3" + }, + { + "name": "StandardE64SV3", + "value": "Standard_E64s_v3" + }, + { + "name": "StandardM64S", + "value": "Standard_M64s" + }, + { + "name": "StandardM64Ms", + "value": "Standard_M64ms" + }, + { + "name": "StandardM128S", + "value": "Standard_M128s" + }, + { + "name": "StandardM128Ms", + "value": "Standard_M128ms" + }, + { + "name": "StandardDC2S", + "value": "Standard_DC2s" + }, + { + "name": "StandardDC4S", + "value": "Standard_DC4s" + }, + { + "name": "StandardE20V3", + "value": "Standard_E20_v3" + }, + { + "name": "StandardE20SV3", + "value": "Standard_E20s_v3" + }, + { + "name": "StandardE64IV3", + "value": "Standard_E64i_v3" + }, + { + "name": "StandardE64IsV3", + "value": "Standard_E64is_v3" + }, + { + "name": "StandardM8Ms", + "value": "Standard_M8ms" + }, + { + "name": "StandardM16Ms", + "value": "Standard_M16ms" + }, + { + "name": "StandardM32Ls", + "value": "Standard_M32ls" + }, + { + "name": "StandardM32Ms", + "value": "Standard_M32ms" + }, + { + "name": "StandardM32Ts", + "value": "Standard_M32ts" + }, + { + "name": "StandardM64", + "value": "Standard_M64" + }, + { + "name": "StandardM64Ls", + "value": "Standard_M64ls" + }, + { + "name": "StandardM64M", + "value": "Standard_M64m" + }, + { + "name": "StandardM128", + "value": "Standard_M128" + }, + { + "name": "StandardM128M", + "value": "Standard_M128m" + }, + { + "name": "StandardL8SV2", + "value": "Standard_L8s_v2" + }, + { + "name": "StandardL16SV2", + "value": "Standard_L16s_v2" + }, + { + "name": "StandardL32SV2", + "value": "Standard_L32s_v2" + }, + { + "name": "StandardL48SV2", + "value": "Standard_L48s_v2" + }, + { + "name": "StandardL64SV2", + "value": "Standard_L64s_v2" + }, + { + "name": "StandardL80SV2", + "value": "Standard_L80s_v2" + }, + { + "name": "StandardD2V4", + "value": "Standard_D2_v4" + }, + { + "name": "StandardD4V4", + "value": "Standard_D4_v4" + }, + { + "name": "StandardD8V4", + "value": "Standard_D8_v4" + }, + { + "name": "StandardD16V4", + "value": "Standard_D16_v4" + }, + { + "name": "StandardD32V4", + "value": "Standard_D32_v4" + }, + { + "name": "StandardD48V4", + "value": "Standard_D48_v4" + }, + { + "name": "StandardD64V4", + "value": "Standard_D64_v4" + }, + { + "name": "StandardD2SV4", + "value": "Standard_D2s_v4" + }, + { + "name": "StandardD4SV4", + "value": "Standard_D4s_v4" + }, + { + "name": "StandardD8SV4", + "value": "Standard_D8s_v4" + }, + { + "name": "StandardD16SV4", + "value": "Standard_D16s_v4" + }, + { + "name": "StandardD32SV4", + "value": "Standard_D32s_v4" + }, + { + "name": "StandardD48SV4", + "value": "Standard_D48s_v4" + }, + { + "name": "StandardD64SV4", + "value": "Standard_D64s_v4" + }, + { + "name": "StandardD2DV4", + "value": "Standard_D2d_v4" + }, + { + "name": "StandardD4DV4", + "value": "Standard_D4d_v4" + }, + { + "name": "StandardD8DV4", + "value": "Standard_D8d_v4" + }, + { + "name": "StandardD16DV4", + "value": "Standard_D16d_v4" + }, + { + "name": "StandardD32DV4", + "value": "Standard_D32d_v4" + }, + { + "name": "StandardD48DV4", + "value": "Standard_D48d_v4" + }, + { + "name": "StandardD64DV4", + "value": "Standard_D64d_v4" + }, + { + "name": "StandardD2DsV4", + "value": "Standard_D2ds_v4" + }, + { + "name": "StandardD4DsV4", + "value": "Standard_D4ds_v4" + }, + { + "name": "StandardD8DsV4", + "value": "Standard_D8ds_v4" + }, + { + "name": "StandardD16DsV4", + "value": "Standard_D16ds_v4" + }, + { + "name": "StandardD32DsV4", + "value": "Standard_D32ds_v4" + }, + { + "name": "StandardD48DsV4", + "value": "Standard_D48ds_v4" + }, + { + "name": "StandardD64DsV4", + "value": "Standard_D64ds_v4" + }, + { + "name": "StandardE2V4", + "value": "Standard_E2_v4" + }, + { + "name": "StandardE4V4", + "value": "Standard_E4_v4" + }, + { + "name": "StandardE8V4", + "value": "Standard_E8_v4" + }, + { + "name": "StandardE16V4", + "value": "Standard_E16_v4" + }, + { + "name": "StandardE20V4", + "value": "Standard_E20_v4" + }, + { + "name": "StandardE32V4", + "value": "Standard_E32_v4" + }, + { + "name": "StandardE48V4", + "value": "Standard_E48_v4" + }, + { + "name": "StandardE64V4", + "value": "Standard_E64_v4" + }, + { + "name": "StandardE2SV4", + "value": "Standard_E2s_v4" + }, + { + "name": "StandardE4SV4", + "value": "Standard_E4s_v4" + }, + { + "name": "StandardE8SV4", + "value": "Standard_E8s_v4" + }, + { + "name": "StandardE16SV4", + "value": "Standard_E16s_v4" + }, + { + "name": "StandardE20SV4", + "value": "Standard_E20s_v4" + }, + { + "name": "StandardE32SV4", + "value": "Standard_E32s_v4" + }, + { + "name": "StandardE48SV4", + "value": "Standard_E48s_v4" + }, + { + "name": "StandardE64SV4", + "value": "Standard_E64s_v4" + }, + { + "name": "StandardE2DV4", + "value": "Standard_E2d_v4" + }, + { + "name": "StandardE4DV4", + "value": "Standard_E4d_v4" + }, + { + "name": "StandardE8DV4", + "value": "Standard_E8d_v4" + }, + { + "name": "StandardE16DV4", + "value": "Standard_E16d_v4" + }, + { + "name": "StandardE20DV4", + "value": "Standard_E20d_v4" + }, + { + "name": "StandardE32DV4", + "value": "Standard_E32d_v4" + }, + { + "name": "StandardE48DV4", + "value": "Standard_E48d_v4" + }, + { + "name": "StandardE64DV4", + "value": "Standard_E64d_v4" + }, + { + "name": "StandardE2DsV4", + "value": "Standard_E2ds_v4" + }, + { + "name": "StandardE4DsV4", + "value": "Standard_E4ds_v4" + }, + { + "name": "StandardE8DsV4", + "value": "Standard_E8ds_v4" + }, + { + "name": "StandardE16DsV4", + "value": "Standard_E16ds_v4" + }, + { + "name": "StandardE20DsV4", + "value": "Standard_E20ds_v4" + }, + { + "name": "StandardE32DsV4", + "value": "Standard_E32ds_v4" + }, + { + "name": "StandardE48DsV4", + "value": "Standard_E48ds_v4" + }, + { + "name": "StandardE64DsV4", + "value": "Standard_E64ds_v4" + }, + { + "name": "StandardE2AsV4", + "value": "Standard_E2as_v4" + }, + { + "name": "StandardE4AsV4", + "value": "Standard_E4as_v4" + }, + { + "name": "StandardE8AsV4", + "value": "Standard_E8as_v4" + }, + { + "name": "StandardE16AsV4", + "value": "Standard_E16as_v4" + }, + { + "name": "StandardE20AsV4", + "value": "Standard_E20as_v4" + }, + { + "name": "StandardE32AsV4", + "value": "Standard_E32as_v4" + }, + { + "name": "StandardE48AsV4", + "value": "Standard_E48as_v4" + }, + { + "name": "StandardE64AsV4", + "value": "Standard_E64as_v4" + }, + { + "name": "StandardE96AsV4", + "value": "Standard_E96as_v4" + }, + { + "name": "StandardD2AsV4", + "value": "Standard_D2as_v4" + }, + { + "name": "StandardD4AsV4", + "value": "Standard_D4as_v4" + }, + { + "name": "StandardD8AsV4", + "value": "Standard_D8as_v4" + }, + { + "name": "StandardD16AsV4", + "value": "Standard_D16as_v4" + }, + { + "name": "StandardD32AsV4", + "value": "Standard_D32as_v4" + }, + { + "name": "StandardD48AsV4", + "value": "Standard_D48as_v4" + }, + { + "name": "StandardD64AsV4", + "value": "Standard_D64as_v4" + }, + { + "name": "StandardD96AsV4", + "value": "Standard_D96as_v4" + }, + { + "name": "StandardM208MsV2", + "value": "Standard_M208ms_v2" + }, + { + "name": "StandardM208SV2", + "value": "Standard_M208s_v2" + }, + { + "name": "StandardM416MsV2", + "value": "Standard_M416ms_v2" + }, + { + "name": "StandardM416SV2", + "value": "Standard_M416s_v2" + }, + { + "name": "StandardF48SV2", + "value": "Standard_F48s_v2" + }, + { + "name": "StandardE48V3", + "value": "Standard_E48_v3" + }, + { + "name": "StandardE48SV3", + "value": "Standard_E48s_v3" + }, + { + "name": "StandardE80IsV4", + "value": "Standard_E80is_v4" + }, + { + "name": "StandardE80IdsV4", + "value": "Standard_E80ids_v4" + }, + { + "name": "StandardE2AV4", + "value": "Standard_E2a_v4" + }, + { + "name": "StandardE4AV4", + "value": "Standard_E4a_v4" + }, + { + "name": "StandardE8AV4", + "value": "Standard_E8a_v4" + }, + { + "name": "StandardE16AV4", + "value": "Standard_E16a_v4" + }, + { + "name": "StandardE20AV4", + "value": "Standard_E20a_v4" + }, + { + "name": "StandardE32AV4", + "value": "Standard_E32a_v4" + }, + { + "name": "StandardE48AV4", + "value": "Standard_E48a_v4" + }, + { + "name": "StandardE64AV4", + "value": "Standard_E64a_v4" + }, + { + "name": "StandardE96AV4", + "value": "Standard_E96a_v4" + }, + { + "name": "StandardD2AV4", + "value": "Standard_D2a_v4" + }, + { + "name": "StandardD4AV4", + "value": "Standard_D4a_v4" + }, + { + "name": "StandardD8AV4", + "value": "Standard_D8a_v4" + }, + { + "name": "StandardD16AV4", + "value": "Standard_D16a_v4" + }, + { + "name": "StandardD32AV4", + "value": "Standard_D32a_v4" + }, + { + "name": "StandardD48AV4", + "value": "Standard_D48a_v4" + }, + { + "name": "StandardD64AV4", + "value": "Standard_D64a_v4" + }, + { + "name": "StandardD96AV4", + "value": "Standard_D96a_v4" + }, + { + "name": "StandardM32MsV2", + "value": "Standard_M32ms_v2" + }, + { + "name": "StandardM64SV2", + "value": "Standard_M64s_v2" + }, + { + "name": "StandardM64MsV2", + "value": "Standard_M64ms_v2" + }, + { + "name": "StandardM128SV2", + "value": "Standard_M128s_v2" + }, + { + "name": "StandardM128MsV2", + "value": "Standard_M128ms_v2" + }, + { + "name": "StandardM192IsV2", + "value": "Standard_M192is_v2" + }, + { + "name": "StandardM192ImsV2", + "value": "Standard_M192ims_v2" + }, + { + "name": "StandardM32DmsV2", + "value": "Standard_M32dms_v2" + }, + { + "name": "StandardM64DsV2", + "value": "Standard_M64ds_v2" + }, + { + "name": "StandardM64DmsV2", + "value": "Standard_M64dms_v2" + }, + { + "name": "StandardM128DsV2", + "value": "Standard_M128ds_v2" + }, + { + "name": "StandardM128DmsV2", + "value": "Standard_M128dms_v2" + }, + { + "name": "StandardM192IdsV2", + "value": "Standard_M192ids_v2" + }, + { + "name": "StandardM192IdmsV2", + "value": "Standard_M192idms_v2" + }, + { + "name": "StandardD2V5", + "value": "Standard_D2_v5" + }, + { + "name": "StandardD4V5", + "value": "Standard_D4_v5" + }, + { + "name": "StandardD8V5", + "value": "Standard_D8_v5" + }, + { + "name": "StandardD16V5", + "value": "Standard_D16_v5" + }, + { + "name": "StandardD32V5", + "value": "Standard_D32_v5" + }, + { + "name": "StandardD48V5", + "value": "Standard_D48_v5" + }, + { + "name": "StandardD64V5", + "value": "Standard_D64_v5" + }, + { + "name": "StandardD96V5", + "value": "Standard_D96_v5" + }, + { + "name": "StandardD2SV5", + "value": "Standard_D2s_v5" + }, + { + "name": "StandardD4SV5", + "value": "Standard_D4s_v5" + }, + { + "name": "StandardD8SV5", + "value": "Standard_D8s_v5" + }, + { + "name": "StandardD16SV5", + "value": "Standard_D16s_v5" + }, + { + "name": "StandardD32SV5", + "value": "Standard_D32s_v5" + }, + { + "name": "StandardD48SV5", + "value": "Standard_D48s_v5" + }, + { + "name": "StandardD64SV5", + "value": "Standard_D64s_v5" + }, + { + "name": "StandardD96SV5", + "value": "Standard_D96s_v5" + }, + { + "name": "StandardD2DV5", + "value": "Standard_D2d_v5" + }, + { + "name": "StandardD4DV5", + "value": "Standard_D4d_v5" + }, + { + "name": "StandardD8DV5", + "value": "Standard_D8d_v5" + }, + { + "name": "StandardD16DV5", + "value": "Standard_D16d_v5" + }, + { + "name": "StandardD32DV5", + "value": "Standard_D32d_v5" + }, + { + "name": "StandardD48DV5", + "value": "Standard_D48d_v5" + }, + { + "name": "StandardD64DV5", + "value": "Standard_D64d_v5" + }, + { + "name": "StandardD96DV5", + "value": "Standard_D96d_v5" + }, + { + "name": "StandardD2DsV5", + "value": "Standard_D2ds_v5" + }, + { + "name": "StandardD4DsV5", + "value": "Standard_D4ds_v5" + }, + { + "name": "StandardD8DsV5", + "value": "Standard_D8ds_v5" + }, + { + "name": "StandardD16DsV5", + "value": "Standard_D16ds_v5" + }, + { + "name": "StandardD32DsV5", + "value": "Standard_D32ds_v5" + }, + { + "name": "StandardD48DsV5", + "value": "Standard_D48ds_v5" + }, + { + "name": "StandardD64DsV5", + "value": "Standard_D64ds_v5" + }, + { + "name": "StandardD96DsV5", + "value": "Standard_D96ds_v5" + }, + { + "name": "StandardD2AsV5", + "value": "Standard_D2as_v5" + }, + { + "name": "StandardD4AsV5", + "value": "Standard_D4as_v5" + }, + { + "name": "StandardD8AsV5", + "value": "Standard_D8as_v5" + }, + { + "name": "StandardD16AsV5", + "value": "Standard_D16as_v5" + }, + { + "name": "StandardD32AsV5", + "value": "Standard_D32as_v5" + }, + { + "name": "StandardD48AsV5", + "value": "Standard_D48as_v5" + }, + { + "name": "StandardD64AsV5", + "value": "Standard_D64as_v5" + }, + { + "name": "StandardD96AsV5", + "value": "Standard_D96as_v5" + }, + { + "name": "StandardD2AdsV5", + "value": "Standard_D2ads_v5" + }, + { + "name": "StandardD4AdsV5", + "value": "Standard_D4ads_v5" + }, + { + "name": "StandardD8AdsV5", + "value": "Standard_D8ads_v5" + }, + { + "name": "StandardD16AdsV5", + "value": "Standard_D16ads_v5" + }, + { + "name": "StandardD32AdsV5", + "value": "Standard_D32ads_v5" + }, + { + "name": "StandardD48AdsV5", + "value": "Standard_D48ads_v5" + }, + { + "name": "StandardD64AdsV5", + "value": "Standard_D64ads_v5" + }, + { + "name": "StandardD96AdsV5", + "value": "Standard_D96ads_v5" + }, + { + "name": "StandardE2V5", + "value": "Standard_E2_v5" + }, + { + "name": "StandardE4V5", + "value": "Standard_E4_v5" + }, + { + "name": "StandardE8V5", + "value": "Standard_E8_v5" + }, + { + "name": "StandardE16V5", + "value": "Standard_E16_v5" + }, + { + "name": "StandardE20V5", + "value": "Standard_E20_v5" + }, + { + "name": "StandardE32V5", + "value": "Standard_E32_v5" + }, + { + "name": "StandardE48V5", + "value": "Standard_E48_v5" + }, + { + "name": "StandardE64V5", + "value": "Standard_E64_v5" + }, + { + "name": "StandardE96V5", + "value": "Standard_E96_v5" + }, + { + "name": "StandardE104IV5", + "value": "Standard_E104i_v5" + }, + { + "name": "StandardE2SV5", + "value": "Standard_E2s_v5" + }, + { + "name": "StandardE4SV5", + "value": "Standard_E4s_v5" + }, + { + "name": "StandardE8SV5", + "value": "Standard_E8s_v5" + }, + { + "name": "StandardE16SV5", + "value": "Standard_E16s_v5" + }, + { + "name": "StandardE20SV5", + "value": "Standard_E20s_v5" + }, + { + "name": "StandardE32SV5", + "value": "Standard_E32s_v5" + }, + { + "name": "StandardE48SV5", + "value": "Standard_E48s_v5" + }, + { + "name": "StandardE64SV5", + "value": "Standard_E64s_v5" + }, + { + "name": "StandardE96SV5", + "value": "Standard_E96s_v5" + }, + { + "name": "StandardE104IsV5", + "value": "Standard_E104is_v5" + }, + { + "name": "StandardE2DV5", + "value": "Standard_E2d_v5" + }, + { + "name": "StandardE4DV5", + "value": "Standard_E4d_v5" + }, + { + "name": "StandardE8DV5", + "value": "Standard_E8d_v5" + }, + { + "name": "StandardE16DV5", + "value": "Standard_E16d_v5" + }, + { + "name": "StandardE20DV5", + "value": "Standard_E20d_v5" + }, + { + "name": "StandardE32DV5", + "value": "Standard_E32d_v5" + }, + { + "name": "StandardE48DV5", + "value": "Standard_E48d_v5" + }, + { + "name": "StandardE64DV5", + "value": "Standard_E64d_v5" + }, + { + "name": "StandardE96DV5", + "value": "Standard_E96d_v5" + }, + { + "name": "StandardE104IdV5", + "value": "Standard_E104id_v5" + }, + { + "name": "StandardE2DsV5", + "value": "Standard_E2ds_v5" + }, + { + "name": "StandardE4DsV5", + "value": "Standard_E4ds_v5" + }, + { + "name": "StandardE8DsV5", + "value": "Standard_E8ds_v5" + }, + { + "name": "StandardE16DsV5", + "value": "Standard_E16ds_v5" + }, + { + "name": "StandardE20DsV5", + "value": "Standard_E20ds_v5" + }, + { + "name": "StandardE32DsV5", + "value": "Standard_E32ds_v5" + }, + { + "name": "StandardE48DsV5", + "value": "Standard_E48ds_v5" + }, + { + "name": "StandardE64DsV5", + "value": "Standard_E64ds_v5" + }, + { + "name": "StandardE96DsV5", + "value": "Standard_E96ds_v5" + }, + { + "name": "StandardE104IdsV5", + "value": "Standard_E104ids_v5" + }, + { + "name": "StandardE2AsV5", + "value": "Standard_E2as_v5" + }, + { + "name": "StandardE4AsV5", + "value": "Standard_E4as_v5" + }, + { + "name": "StandardE8AsV5", + "value": "Standard_E8as_v5" + }, + { + "name": "StandardE16AsV5", + "value": "Standard_E16as_v5" + }, + { + "name": "StandardE20AsV5", + "value": "Standard_E20as_v5" + }, + { + "name": "StandardE32AsV5", + "value": "Standard_E32as_v5" + }, + { + "name": "StandardE48AsV5", + "value": "Standard_E48as_v5" + }, + { + "name": "StandardE64AsV5", + "value": "Standard_E64as_v5" + }, + { + "name": "StandardE96AsV5", + "value": "Standard_E96as_v5" + }, + { + "name": "StandardE2AdsV5", + "value": "Standard_E2ads_v5" + }, + { + "name": "StandardE4AdsV5", + "value": "Standard_E4ads_v5" + }, + { + "name": "StandardE8AdsV5", + "value": "Standard_E8ads_v5" + }, + { + "name": "StandardE16AdsV5", + "value": "Standard_E16ads_v5" + }, + { + "name": "StandardE20AdsV5", + "value": "Standard_E20ads_v5" + }, + { + "name": "StandardE32AdsV5", + "value": "Standard_E32ads_v5" + }, + { + "name": "StandardE48AdsV5", + "value": "Standard_E48ads_v5" + }, + { + "name": "StandardE64AdsV5", + "value": "Standard_E64ads_v5" + }, + { + "name": "StandardE96AdsV5", + "value": "Standard_E96ads_v5" + }, + { + "name": "StandardM82Ms", + "value": "Standard_M8_2ms" + }, + { + "name": "StandardM84Ms", + "value": "Standard_M8_4ms" + }, + { + "name": "StandardM164Ms", + "value": "Standard_M16_4ms" + }, + { + "name": "StandardM168Ms", + "value": "Standard_M16_8ms" + }, + { + "name": "StandardM328Ms", + "value": "Standard_M32_8ms" + }, + { + "name": "StandardM3216Ms", + "value": "Standard_M32_16ms" + }, + { + "name": "StandardM6432Ms", + "value": "Standard_M64_32ms" + }, + { + "name": "StandardM6416Ms", + "value": "Standard_M64_16ms" + }, + { + "name": "StandardM12864Ms", + "value": "Standard_M128_64ms" + }, + { + "name": "StandardM12832Ms", + "value": "Standard_M128_32ms" + }, + { + "name": "StandardE42SV3", + "value": "Standard_E4_2s_v3" + }, + { + "name": "StandardE84SV3", + "value": "Standard_E8_4s_v3" + }, + { + "name": "StandardE82SV3", + "value": "Standard_E8_2s_v3" + }, + { + "name": "StandardE168SV3", + "value": "Standard_E16_8s_v3" + }, + { + "name": "StandardE164SV3", + "value": "Standard_E16_4s_v3" + }, + { + "name": "StandardE3216SV3", + "value": "Standard_E32_16s_v3" + }, + { + "name": "StandardE328SV3", + "value": "Standard_E32_8s_v3" + }, + { + "name": "StandardE6432SV3", + "value": "Standard_E64_32s_v3" + }, + { + "name": "StandardE6416SV3", + "value": "Standard_E64_16s_v3" + }, + { + "name": "StandardE42SV4", + "value": "Standard_E4_2s_v4" + }, + { + "name": "StandardE84SV4", + "value": "Standard_E8_4s_v4" + }, + { + "name": "StandardE82SV4", + "value": "Standard_E8_2s_v4" + }, + { + "name": "StandardE168SV4", + "value": "Standard_E16_8s_v4" + }, + { + "name": "StandardE164SV4", + "value": "Standard_E16_4s_v4" + }, + { + "name": "StandardE3216SV4", + "value": "Standard_E32_16s_v4" + }, + { + "name": "StandardE328SV4", + "value": "Standard_E32_8s_v4" + }, + { + "name": "StandardE6432SV4", + "value": "Standard_E64_32s_v4" + }, + { + "name": "StandardE6416SV4", + "value": "Standard_E64_16s_v4" + }, + { + "name": "StandardE42DsV4", + "value": "Standard_E4_2ds_v4" + }, + { + "name": "StandardE84DsV4", + "value": "Standard_E8_4ds_v4" + }, + { + "name": "StandardE82DsV4", + "value": "Standard_E8_2ds_v4" + }, + { + "name": "StandardE168DsV4", + "value": "Standard_E16_8ds_v4" + }, + { + "name": "StandardE164DsV4", + "value": "Standard_E16_4ds_v4" + }, + { + "name": "StandardE3216DsV4", + "value": "Standard_E32_16ds_v4" + }, + { + "name": "StandardE328DsV4", + "value": "Standard_E32_8ds_v4" + }, + { + "name": "StandardE6432DsV4", + "value": "Standard_E64_32ds_v4" + }, + { + "name": "StandardE6416DsV4", + "value": "Standard_E64_16ds_v4" + }, + { + "name": "StandardE42AsV4", + "value": "Standard_E4_2as_v4" + }, + { + "name": "StandardE84AsV4", + "value": "Standard_E8_4as_v4" + }, + { + "name": "StandardE82AsV4", + "value": "Standard_E8_2as_v4" + }, + { + "name": "StandardE168AsV4", + "value": "Standard_E16_8as_v4" + }, + { + "name": "StandardE164AsV4", + "value": "Standard_E16_4as_v4" + }, + { + "name": "StandardE3216AsV4", + "value": "Standard_E32_16as_v4" + }, + { + "name": "StandardE328AsV4", + "value": "Standard_E32_8as_v4" + }, + { + "name": "StandardE6432AsV4", + "value": "Standard_E64_32as_v4" + }, + { + "name": "StandardE6416AsV4", + "value": "Standard_E64_16as_v4" + }, + { + "name": "StandardE9648AsV4", + "value": "Standard_E96_48as_v4" + }, + { + "name": "StandardE9624AsV4", + "value": "Standard_E96_24as_v4" + }, + { + "name": "StandardE42AdsV5", + "value": "Standard_E4_2ads_v5" + }, + { + "name": "StandardE84AdsV5", + "value": "Standard_E8_4ads_v5" + }, + { + "name": "StandardE82AdsV5", + "value": "Standard_E8_2ads_v5" + }, + { + "name": "StandardE168AdsV5", + "value": "Standard_E16_8ads_v5" + }, + { + "name": "StandardE164AdsV5", + "value": "Standard_E16_4ads_v5" + }, + { + "name": "StandardE3216AdsV5", + "value": "Standard_E32_16ads_v5" + }, + { + "name": "StandardE328AdsV5", + "value": "Standard_E32_8ads_v5" + }, + { + "name": "StandardE6432AdsV5", + "value": "Standard_E64_32ads_v5" + }, + { + "name": "StandardE6416AdsV5", + "value": "Standard_E64_16ads_v5" + }, + { + "name": "StandardE9648AdsV5", + "value": "Standard_E96_48ads_v5" + }, + { + "name": "StandardE9624AdsV5", + "value": "Standard_E96_24ads_v5" + }, + { + "name": "StandardE42SV5", + "value": "Standard_E4_2s_v5" + }, + { + "name": "StandardE84SV5", + "value": "Standard_E8_4s_v5" + }, + { + "name": "StandardE82SV5", + "value": "Standard_E8_2s_v5" + }, + { + "name": "StandardE168SV5", + "value": "Standard_E16_8s_v5" + }, + { + "name": "StandardE164SV5", + "value": "Standard_E16_4s_v5" + }, + { + "name": "StandardE3216SV5", + "value": "Standard_E32_16s_v5" + }, + { + "name": "StandardE328SV5", + "value": "Standard_E32_8s_v5" + }, + { + "name": "StandardE6432SV5", + "value": "Standard_E64_32s_v5" + }, + { + "name": "StandardE6416SV5", + "value": "Standard_E64_16s_v5" + }, + { + "name": "StandardE9648SV5", + "value": "Standard_E96_48s_v5" + }, + { + "name": "StandardE9624SV5", + "value": "Standard_E96_24s_v5" + }, + { + "name": "StandardE42DsV5", + "value": "Standard_E4_2ds_v5" + }, + { + "name": "StandardE84DsV5", + "value": "Standard_E8_4ds_v5" + }, + { + "name": "StandardE82DsV5", + "value": "Standard_E8_2ds_v5" + }, + { + "name": "StandardE168DsV5", + "value": "Standard_E16_8ds_v5" + }, + { + "name": "StandardE164DsV5", + "value": "Standard_E16_4ds_v5" + }, + { + "name": "StandardE3216DsV5", + "value": "Standard_E32_16ds_v5" + }, + { + "name": "StandardE328DsV5", + "value": "Standard_E32_8ds_v5" + }, + { + "name": "StandardE6432DsV5", + "value": "Standard_E64_32ds_v5" + }, + { + "name": "StandardE6416DsV5", + "value": "Standard_E64_16ds_v5" + }, + { + "name": "StandardE9648DsV5", + "value": "Standard_E96_48ds_v5" + }, + { + "name": "StandardE9624DsV5", + "value": "Standard_E96_24ds_v5" + }, + { + "name": "StandardE42AsV5", + "value": "Standard_E4_2as_v5" + }, + { + "name": "StandardE84AsV5", + "value": "Standard_E8_4as_v5" + }, + { + "name": "StandardE82AsV5", + "value": "Standard_E8_2as_v5" + }, + { + "name": "StandardE168AsV5", + "value": "Standard_E16_8as_v5" + }, + { + "name": "StandardE164AsV5", + "value": "Standard_E16_4as_v5" + }, + { + "name": "StandardE3216AsV5", + "value": "Standard_E32_16as_v5" + }, + { + "name": "StandardE328AsV5", + "value": "Standard_E32_8as_v5" + }, + { + "name": "StandardE6432AsV5", + "value": "Standard_E64_32as_v5" + }, + { + "name": "StandardE6416AsV5", + "value": "Standard_E64_16as_v5" + }, + { + "name": "StandardE9648AsV5", + "value": "Standard_E96_48as_v5" + }, + { + "name": "StandardE9624AsV5", + "value": "Standard_E96_24as_v5" + }, + { + "name": "StandardGS48", + "value": "Standard_GS4_8" + }, + { + "name": "StandardGS44", + "value": "Standard_GS4_4" + }, + { + "name": "StandardGS516", + "value": "Standard_GS5_16" + }, + { + "name": "StandardGS58", + "value": "Standard_GS5_8" + }, + { + "name": "StandardDS111V2", + "value": "Standard_DS11_1_v2" + }, + { + "name": "StandardDS122V2", + "value": "Standard_DS12_2_v2" + }, + { + "name": "StandardDS121V2", + "value": "Standard_DS12_1_v2" + }, + { + "name": "StandardDS134V2", + "value": "Standard_DS13_4_v2" + }, + { + "name": "StandardDS132V2", + "value": "Standard_DS13_2_v2" + }, + { + "name": "StandardDS148V2", + "value": "Standard_DS14_8_v2" + }, + { + "name": "StandardDS144V2", + "value": "Standard_DS14_4_v2" + }, + { + "name": "StandardM416208SV2", + "value": "Standard_M416_208s_v2" + }, + { + "name": "StandardM416208MsV2", + "value": "Standard_M416_208ms_v2" + }, + { + "name": "StandardE2BsV5", + "value": "Standard_E2bs_v5" + }, + { + "name": "StandardE4BsV5", + "value": "Standard_E4bs_v5" + }, + { + "name": "StandardE8BsV5", + "value": "Standard_E8bs_v5" + }, + { + "name": "StandardE16BsV5", + "value": "Standard_E16bs_v5" + }, + { + "name": "StandardE32BsV5", + "value": "Standard_E32bs_v5" + }, + { + "name": "StandardE48BsV5", + "value": "Standard_E48bs_v5" + }, + { + "name": "StandardE64BsV5", + "value": "Standard_E64bs_v5" + }, + { + "name": "StandardE2BdsV5", + "value": "Standard_E2bds_v5" + }, + { + "name": "StandardE4BdsV5", + "value": "Standard_E4bds_v5" + }, + { + "name": "StandardE8BdsV5", + "value": "Standard_E8bds_v5" + }, + { + "name": "StandardE16BdsV5", + "value": "Standard_E16bds_v5" + }, + { + "name": "StandardE32BdsV5", + "value": "Standard_E32bds_v5" + }, + { + "name": "StandardE48BdsV5", + "value": "Standard_E48bds_v5" + }, + { + "name": "StandardE64BdsV5", + "value": "Standard_E64bds_v5" + } + ] + } + }, + "AzureVmSuitabilityDetail": { + "type": "string", + "enum": [ + "None", + "RecommendedSizeHasLessNetworkAdapters", + "CannotReportComputeCost", + "CannotReportStorageCost", + "CannotReportBandwidthCosts", + "PercentageOfCoresUtilizedMissing", + "PercentageOfMemoryUtilizedMissing", + "PercentageOfCoresUtilizedOutOfRange", + "PercentageOfMemoryUtilizedOutOfRange" + ], + "x-ms-enum": { + "name": "AzureVmSuitabilityDetail", + "modelAsString": true + } + }, + "AzureVmSuitabilityExplanation": { + "type": "string", + "enum": [ + "Unknown", + "NotApplicable", + "GuestOperatingSystemArchitectureNotSupported", + "GuestOperatingSystemNotSupported", + "BootTypeNotSupported", + "MoreDisksThanSupported", + "NoSuitableVmSizeFound", + "OneOrMoreDisksNotSuitable", + "OneOrMoreAdaptersNotSuitable", + "InternalErrorOccurredDuringComputeEvaluation", + "InternalErrorOccurredDuringStorageEvaluation", + "InternalErrorOccurredDuringNetworkEvaluation", + "NoVmSizeSupportsStoragePerformance", + "NoVmSizeSupportsNetworkPerformance", + "NoVmSizeForSelectedPricingTier", + "NoVmSizeForSelectedAzureLocation", + "CheckRedHatLinuxVersion", + "CheckOpenSuseLinuxVersion", + "CheckWindowsServer2008R2Version", + "CheckCentOsVersion", + "CheckDebianLinuxVersion", + "CheckSuseLinuxVersion", + "CheckOracleLinuxVersion", + "CheckUbuntuLinuxVersion", + "CheckCoreOsLinuxVersion", + "WindowsServerVersionConditionallySupported", + "NoGuestOperatingSystemConditionallySupported", + "WindowsClientVersionsConditionallySupported", + "BootTypeUnknown", + "GuestOperatingSystemUnknown", + "WindowsServerVersionsSupportedWithCaveat", + "WindowsOSNoLongerUnderMSSupport", + "EndorsedWithConditionsLinuxDistributions", + "UnendorsedLinuxDistributions", + "NoVmSizeForStandardPricingTier", + "NoVmSizeForBasicPricingTier", + "NoVmSizeInSelectedFamilyFound", + "NoEaPriceFoundForVmSize", + "NoVmSizeFoundForOfferCurrencyReservedInstance" + ], + "x-ms-enum": { + "name": "AzureVmSuitabilityExplanation", + "modelAsString": true + } + }, + "AzureWebAppSuitabilityIssueCategory": { + "type": "string", + "enum": [ + "Unknown", + "Issue", + "Info" + ], + "x-ms-enum": { + "name": "AzureWebAppSuitabilityIssueCategory", + "modelAsString": true + } + }, + "AzureWebAppTargetType": { + "type": "string", + "enum": [ + "Unknown", + "AzureAppService", + "AzureAppServiceContainer" + ], + "x-ms-enum": { + "name": "AzureWebAppTargetType", + "modelAsString": true + } + }, + "AzureWebAppTier": { + "type": "string", + "enum": [ + "Unknown", + "Free", + "Premium_V2", + "Premium_V3", + "Isolated" + ], + "x-ms-enum": { + "name": "AzureWebAppTier", + "modelAsString": true + } + }, + "BusinessCase": { + "type": "object", + "description": "Business case resource.", + "properties": { + "properties": { + "$ref": "#/definitions/BusinessCaseProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "BusinessCaseCurrency": { + "type": "string", + "description": "Business case supported currency types.", + "enum": [ + "Unknown", + "USD", + "DKK", + "CAD", + "IDR", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SAR", + "ZAR", + "SEK", + "TRY", + "GBP", + "MXN", + "MYR", + "INR", + "HKD", + "BRL", + "TWD", + "EUR", + "CHF", + "ARS", + "AUD", + "CNY" + ], + "x-ms-enum": { + "name": "BusinessCaseCurrency", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Currency Unknown." + }, + { + "name": "USD", + "value": "USD", + "description": "Currency USD." + }, + { + "name": "DKK", + "value": "DKK", + "description": "Currency DKK." + }, + { + "name": "CAD", + "value": "CAD", + "description": "Currency CAD." + }, + { + "name": "IDR", + "value": "IDR", + "description": "Currency IDR." + }, + { + "name": "JPY", + "value": "JPY", + "description": "Currency JPY." + }, + { + "name": "KRW", + "value": "KRW", + "description": "Currency KRW." + }, + { + "name": "NZD", + "value": "NZD", + "description": "Currency NZD." + }, + { + "name": "NOK", + "value": "NOK", + "description": "Currency NOK." + }, + { + "name": "RUB", + "value": "RUB", + "description": "Currency RUB." + }, + { + "name": "SAR", + "value": "SAR", + "description": "Currency SAR." + }, + { + "name": "ZAR", + "value": "ZAR", + "description": "Currency ZAR." + }, + { + "name": "SEK", + "value": "SEK", + "description": "Currency SEK." + }, + { + "name": "TRY", + "value": "TRY", + "description": "Currency TRY." + }, + { + "name": "GBP", + "value": "GBP", + "description": "Currency GBP." + }, + { + "name": "MXN", + "value": "MXN", + "description": "Currency MXN." + }, + { + "name": "MYR", + "value": "MYR", + "description": "Currency MYR." + }, + { + "name": "INR", + "value": "INR", + "description": "Currency INR." + }, + { + "name": "HKD", + "value": "HKD", + "description": "Currency HKD." + }, + { + "name": "BRL", + "value": "BRL", + "description": "Currency BRL." + }, + { + "name": "TWD", + "value": "TWD", + "description": "Currency TWD." + }, + { + "name": "EUR", + "value": "EUR", + "description": "Currency EUR." + }, + { + "name": "CHF", + "value": "CHF", + "description": "Currency CHF." + }, + { + "name": "ARS", + "value": "ARS", + "description": "Currency ARS." + }, + { + "name": "AUD", + "value": "AUD", + "description": "Currency AUD." + }, + { + "name": "CNY", + "value": "CNY", + "description": "Currency CNY." + } + ] + } + }, + "BusinessCaseListResult": { + "type": "object", + "description": "The response of a BusinessCase list operation.", + "properties": { + "value": { + "type": "array", + "description": "The BusinessCase items on this page", + "items": { + "$ref": "#/definitions/BusinessCase" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "BusinessCaseProperties": { + "type": "object", + "description": "Property bag for an\nMicrosoft.Azure.Migrate.BusinessCaseService.Api.V20220202_preview.Resources.BusinessCase\nresource.", + "properties": { + "settings": { + "$ref": "#/definitions/Settings", + "description": "Business case settings." + }, + "state": { + "$ref": "#/definitions/BusinessCaseState", + "description": "Business case state.", + "readOnly": true + }, + "reportStatusDetails": { + "type": "array", + "description": "Gets the state of business case reports.", + "items": { + "$ref": "#/definitions/ReportDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties2" + } + ] + }, + "BusinessCaseState": { + "type": "string", + "description": "Business case supported state types.", + "enum": [ + "Unknown", + "InProgress", + "Completed", + "OutDated", + "Invalid", + "OutOfSync", + "Failed" + ], + "x-ms-enum": { + "name": "BusinessCaseState", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown State." + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "InProgress State." + }, + { + "name": "Completed", + "value": "Completed", + "description": "Completed State." + }, + { + "name": "OutDated", + "value": "OutDated", + "description": "OutDated State." + }, + { + "name": "Invalid", + "value": "Invalid", + "description": "Invalid State." + }, + { + "name": "OutOfSync", + "value": "OutOfSync", + "description": "OutOfSync State." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed State." + } + ] + } + }, + "Check": { + "type": "object", + "description": "Data model of Check or Rule for Suitability Analysis.", + "properties": { + "name": { + "type": "string", + "description": "Gets name.", + "readOnly": true + }, + "behavior": { + "$ref": "#/definitions/CheckResult", + "description": "Gets behavior or check result.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Gets description.", + "readOnly": true + }, + "cause": { + "type": "string", + "description": "Gets cause.", + "readOnly": true + }, + "recommendation": { + "type": "string", + "description": "Gets recommendation.", + "readOnly": true + }, + "moreInfo": { + "$ref": "#/definitions/MoreInfo", + "description": "Gets more information about check or rule.", + "readOnly": true + } + }, + "required": [ + "name", + "behavior", + "description", + "cause", + "recommendation", + "moreInfo" + ] + }, + "CheckResult": { + "type": "string", + "description": "Suitability Check or Rule Result.", + "enum": [ + "Unknown", + "Issue", + "Warn", + "Pass" + ], + "x-ms-enum": { + "name": "CheckResult", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Indicates missing value." + }, + { + "name": "Issue", + "value": "Issue", + "description": "Indicates Migration Issue." + }, + { + "name": "Warn", + "value": "Warn", + "description": "Indicates Migration Warning." + }, + { + "name": "Pass", + "value": "Pass", + "description": "Indicates check is passed." + } + ] + } + }, + "CloudSuitability": { + "type": "string", + "description": "Cloud Suitability for Azure.", + "enum": [ + "Unknown", + "NotSuitable", + "Suitable", + "ConditionallySuitable", + "ReadinessUnknown" + ], + "x-ms-enum": { + "name": "CloudSuitability", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown. Indicates missing data." + }, + { + "name": "NotSuitable", + "value": "NotSuitable", + "description": "Not Suitable for Azure." + }, + { + "name": "Suitable", + "value": "Suitable", + "description": "Suitable for Azure." + }, + { + "name": "ConditionallySuitable", + "value": "ConditionallySuitable", + "description": "Conditionally Suitable for Azure." + }, + { + "name": "ReadinessUnknown", + "value": "ReadinessUnknown", + "description": "Unknown Readiness for Azure." + } + ] + } + }, + "Cluster": { + "type": "object", + "description": "Data model of Cluster.", + "properties": { + "name": { + "type": "string", + "description": "Gets name.", + "readOnly": true + }, + "nodePools": { + "type": "array", + "description": "Gets list of node pools.", + "items": { + "$ref": "#/definitions/NodePool" + }, + "readOnly": true + }, + "region": { + "type": "string", + "description": "Gets region.", + "readOnly": true + }, + "userNodePoolCount": { + "type": "integer", + "format": "int32", + "description": "Gets user node pool count.", + "readOnly": true + }, + "userNodeCount": { + "type": "integer", + "format": "int32", + "description": "Gets user node count.", + "readOnly": true + }, + "systemNodePoolCount": { + "type": "integer", + "format": "int32", + "description": "Gets system node pool count.", + "readOnly": true + }, + "systemNodeCount": { + "type": "integer", + "format": "int32", + "description": "Gets system node count.", + "readOnly": true + }, + "podCount": { + "type": "integer", + "format": "int32", + "description": "Gets pod count.", + "readOnly": true + }, + "monthlyCost": { + "type": "number", + "format": "float", + "description": "Gets monthly cost.", + "readOnly": true + } + }, + "required": [ + "name", + "nodePools", + "region", + "userNodePoolCount", + "userNodeCount", + "systemNodePoolCount", + "systemNodeCount", + "podCount", + "monthlyCost" + ] + }, + "CollectorAgentPropertiesBase": { + "type": "object", + "description": "Collector agent property class.", + "properties": { + "id": { + "type": "string", + "description": "Gets the collector agent id." + }, + "version": { + "type": "string", + "description": "Gets the collector agent version." + }, + "lastHeartbeatUtc": { + "type": "string", + "format": "date-time", + "description": "Gets the collector last heartbeat time." + }, + "spnDetails": { + "$ref": "#/definitions/CollectorAgentSpnPropertiesBase", + "description": "Gets or sets the SPN details." + } + } + }, + "CollectorAgentSpnPropertiesBase": { + "type": "object", + "description": "Collector agent SPN details class.", + "properties": { + "authority": { + "type": "string", + "description": "Gets the AAD authority endpoint." + }, + "applicationId": { + "type": "string", + "description": "Gets the AAD application id." + }, + "audience": { + "type": "string", + "description": "Gets the AAD audience url." + }, + "objectId": { + "type": "string", + "description": "Gets the object id of the AAD application." + }, + "tenantId": { + "type": "string", + "description": "Gets the tenant id of the AAD application." + } + } + }, + "CollectorPropertiesBase": { + "type": "object", + "description": "Collector properties class.", + "properties": { + "discoverySiteId": { + "type": "string", + "description": "Gets the discovery site id." + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets the Timestamp when collector was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Timestamp when collector was last updated.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "CollectorPropertiesBaseWithAgent": { + "type": "object", + "description": "Collector properties class.", + "properties": { + "agentProperties": { + "$ref": "#/definitions/CollectorAgentPropertiesBase", + "description": "Gets or sets the collector agent properties." + }, + "discoverySiteId": { + "type": "string", + "description": "Gets the discovery site id." + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets the Timestamp when collector was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Timestamp when collector was last updated.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "CompareSummary": { + "type": "object", + "description": "Compare summary class.", + "properties": { + "azurePaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The azure PaaS cost.", + "readOnly": true + }, + "azureIaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The azure IaaS cost.", + "readOnly": true + }, + "azureAvsCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The AVS cost.", + "readOnly": true + }, + "onPremisesPaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "onPremisesIaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises IaaS cost.", + "readOnly": true + }, + "onPremisesAvsCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises AVS cost.", + "readOnly": true + }, + "onPremisesPaasDecommissionedCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS decommissioned cost.", + "readOnly": true + }, + "onPremisesIaasDecommissionedCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises IaaS decommissioned cost.", + "readOnly": true + }, + "onPremisesAvsDecommissionedCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises AVS decommissioned cost.", + "readOnly": true + } + } + }, + "CompatibilityLevel": { + "type": "string", + "enum": [ + "Unknown", + "CompatLevel80", + "CompatLevel90", + "CompatLevel100", + "CompatLevel110", + "CompatLevel120", + "CompatLevel130", + "CompatLevel140", + "CompatLevel150" + ], + "x-ms-enum": { + "name": "CompatibilityLevel", + "modelAsString": true + } + }, + "ComputeResource": { + "type": "object", + "description": "Data model of Cores and Memory Compute Resource.", + "properties": { + "cores": { + "type": "number", + "format": "float", + "description": "Gets cores.", + "readOnly": true + }, + "memory": { + "type": "number", + "format": "float", + "description": "Gets memory.", + "readOnly": true + } + }, + "required": [ + "cores", + "memory" + ] + }, + "ComputeSettings": { + "type": "object", + "description": "Compute settings.", + "properties": { + "hyperthreadCoreToMemoryRatio": { + "type": "number", + "format": "float", + "description": "Hyperthread core to memory ratio." + }, + "price": { + "type": "number", + "format": "float", + "description": "Compute Price." + }, + "sqlServerLicensing": { + "type": "array", + "description": "SQL Server licensing settings.", + "items": { + "$ref": "#/definitions/SqlServerLicensingSettings" + }, + "x-ms-identifiers": [] + }, + "windowsServerLicensing": { + "$ref": "#/definitions/WindowsServerLicensingSettings", + "description": "Windows Server licensing settings." + }, + "rhelLinuxServerLicensing": { + "$ref": "#/definitions/LinuxServerLicensingSettings", + "description": "Linux Rhel Server licensing settings." + }, + "suseLinuxServerLicensing": { + "$ref": "#/definitions/LinuxServerLicensingSettings", + "description": "Linux Suse Server licensing settings." + }, + "virtualizationSoftwareSettings": { + "$ref": "#/definitions/VirtualizationSoftwareSettings", + "description": "Virtualization software settings." + } + }, + "required": [ + "hyperthreadCoreToMemoryRatio", + "price", + "sqlServerLicensing", + "windowsServerLicensing", + "rhelLinuxServerLicensing", + "suseLinuxServerLicensing", + "virtualizationSoftwareSettings" + ] + }, + "ComputeTier": { + "type": "string", + "enum": [ + "Unknown", + "Automatic", + "Provisioned", + "Serverless" + ], + "x-ms-enum": { + "name": "ComputeTier", + "modelAsString": true + } + }, + "ConsolidationType": { + "type": "string", + "description": "Consolidation Type.", + "enum": [ + "Full", + "AsOnSource" + ], + "x-ms-enum": { + "name": "ConsolidationType", + "modelAsString": true, + "values": [ + { + "name": "Full", + "value": "Full", + "description": "Full Consolidation." + }, + { + "name": "AsOnSource", + "value": "AsOnSource", + "description": "As On Source or On Premises Consolidation." + } + ] + } + }, + "CostByStorageType": { + "type": "object", + "description": "The cost by storage type.", + "properties": { + "storageType": { + "type": "string", + "description": "The storage type.", + "readOnly": true + }, + "cost": { + "type": "number", + "format": "float", + "description": "Cost per storage type.", + "readOnly": true + } + } + }, + "CostComponent": { + "type": "object", + "description": "Class to represent the component of the cost.", + "properties": { + "name": { + "$ref": "#/definitions/CostComponentName", + "description": "Gets the name of the component.", + "readOnly": true + }, + "value": { + "type": "number", + "format": "float", + "description": "The value of the component." + }, + "description": { + "type": "string", + "description": "The textual description of the component." + } + } + }, + "CostComponentName": { + "type": "string", + "description": "Enum to represent component name.", + "enum": [ + "Unknown", + "MonthlyAzureHybridCostSavings", + "MonthlySecurityCost", + "MonthlyPremiumV2StorageCost", + "MonthlyLinuxAzureHybridCostSavings", + "MonthlyAvsNodeCost", + "MonthlyAvsExternalStorageCost", + "MonthlyAvsNetworkCost", + "MonthlyVcfByolCostDifference" + ], + "x-ms-enum": { + "name": "CostComponentName", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Default Cost Component name represented by Unknown." + }, + { + "name": "MonthlyAzureHybridCostSavings", + "value": "MonthlyAzureHybridCostSavings", + "description": "Cost Savings due to Windows Azure Hybrid on monthly basis." + }, + { + "name": "MonthlySecurityCost", + "value": "MonthlySecurityCost", + "description": "Monthly security cost." + }, + { + "name": "MonthlyPremiumV2StorageCost", + "value": "MonthlyPremiumV2StorageCost", + "description": "Monthly PremiumV2 Storage Cost." + }, + { + "name": "MonthlyLinuxAzureHybridCostSavings", + "value": "MonthlyLinuxAzureHybridCostSavings", + "description": "Cost Savings due to Linux Azure Hybrid on monthly basis." + }, + { + "name": "MonthlyAvsNodeCost", + "value": "MonthlyAvsNodeCost", + "description": "Monthly AVS Node cost" + }, + { + "name": "MonthlyAvsExternalStorageCost", + "value": "MonthlyAvsExternalStorageCost", + "description": "Monthly AVS External Storage cost" + }, + { + "name": "MonthlyAvsNetworkCost", + "value": "MonthlyAvsNetworkCost", + "description": "Monthly AVS Network cost" + }, + { + "name": "MonthlyVcfByolCostDifference", + "value": "MonthlyVcfByolCostDifference", + "description": "Monthly compute cost difference between VCF BYOL and non VCF BYOL SKUs" + } + ] + } + }, + "CostDetails": { + "type": "object", + "description": "The on premises PaaS cost.", + "properties": { + "storageCost": { + "type": "number", + "format": "float", + "description": "The storage cost.", + "readOnly": true + }, + "computeCost": { + "type": "number", + "format": "float", + "description": "The compute cost.", + "readOnly": true + }, + "itLaborCost": { + "type": "number", + "format": "float", + "description": "The IT labor cost.", + "readOnly": true + }, + "networkCost": { + "type": "number", + "format": "float", + "description": "The network cost.", + "readOnly": true + }, + "ahubSavings": { + "type": "number", + "format": "float", + "description": "The windows AhubSavings.", + "readOnly": true + }, + "linuxAhubSavings": { + "type": "number", + "format": "float", + "description": "The linux AhubSavings.", + "readOnly": true + }, + "securityCost": { + "type": "number", + "format": "float", + "description": "Security Cost.", + "readOnly": true + }, + "managementCostDetails": { + "$ref": "#/definitions/ManagementCostDetails", + "description": "Management Cost Details.", + "readOnly": true + }, + "esuSavings": { + "type": "number", + "format": "float", + "description": "esu savings.", + "readOnly": true + } + } + }, + "DiscoveredEntitiesSummary": { + "type": "object", + "description": "Discovered entities summary.", + "properties": { + "numberOfServers": { + "type": "integer", + "format": "int32", + "description": "Number of web servers", + "readOnly": true + }, + "numberOfWebApps": { + "type": "integer", + "format": "int32", + "description": "Number of web apps", + "readOnly": true + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Number of machines", + "readOnly": true + }, + "webServerSummary": { + "type": "object", + "description": "Web server summary data", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "webAppSummary": { + "type": "object", + "description": "Web app summary data", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + } + } + }, + "DiscoveredEntityLightSummary": { + "type": "object", + "description": "Discovered entity light summary.", + "properties": { + "numberOfServers": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of servers." + }, + "numberOfWebApps": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of web apps." + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of machines." + } + }, + "required": [ + "numberOfServers", + "numberOfWebApps", + "numberOfMachines" + ] + }, + "DiscoverySource": { + "type": "string", + "description": "Business case supported Discovery source types.", + "enum": [ + "Unknown", + "Appliance", + "Import" + ], + "x-ms-enum": { + "name": "DiscoverySource", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Discovery Source." + }, + { + "name": "Appliance", + "value": "Appliance", + "description": "Appliance Discovery Source." + }, + { + "name": "Import", + "value": "Import", + "description": "Import Discovery Source." + } + ] + } + }, + "Disk": { + "type": "object", + "description": "A disk discovered on a machine.", + "properties": { + "gigabytesAllocated": { + "type": "number", + "format": "float", + "description": "Gigabytes of storage provisioned for this disk.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "User friendly name of the disk.", + "readOnly": true + } + } + }, + "DistributionByOperatingSystem": { + "type": "object", + "description": "The distribution by operating system.", + "properties": { + "osClassificationType": { + "type": "string", + "description": "The Os classification type.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The number of machines with the OS type classification.", + "readOnly": true + } + } + }, + "DistributionByType": { + "type": "object", + "description": "Distribution by Type.", + "properties": { + "type": { + "type": "string", + "description": "Distribution Type.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Distribution Count.", + "readOnly": true + } + } + }, + "DistributionByVirtualization": { + "type": "object", + "description": "The distribution by virtualization.", + "properties": { + "virtualizationType": { + "type": "string", + "description": "The Virtualization type.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The number of machines with the Virtualization type classification.", + "readOnly": true + } + } + }, + "DownloadUrl": { + "type": "object", + "description": "Data model of Download URL for assessment report.", + "properties": { + "assessmentReportUrl": { + "type": "string", + "description": "Hyperlink to download report.", + "readOnly": true + }, + "expirationTime": { + "type": "string", + "format": "date-time", + "description": "Expiry date of download url.", + "readOnly": true + } + }, + "required": [ + "assessmentReportUrl", + "expirationTime" + ] + }, + "EntityUptime": { + "type": "object", + "description": "Entity Uptime.", + "properties": { + "daysPerMonth": { + "type": "integer", + "format": "int32", + "description": "Gets the days per month." + }, + "hoursPerDay": { + "type": "integer", + "format": "int32", + "description": "Gets the hours per day." + } + } + }, + "EnvironmentType": { + "type": "string", + "enum": [ + "Production", + "Test" + ], + "x-ms-enum": { + "name": "EnvironmentType", + "modelAsString": true + } + }, + "Error": { + "type": "object", + "description": "Error web model class.", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "Gets the error ID.", + "readOnly": true + }, + "code": { + "type": "string", + "description": "Gets the error code.", + "readOnly": true + }, + "runAsAccountId": { + "type": "string", + "description": "Gets the Run as account ID.", + "readOnly": true + }, + "applianceName": { + "type": "string", + "description": "Gets the Appliance name.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Gets the error message.", + "readOnly": true + }, + "summaryMessage": { + "type": "string", + "description": "Gets the error summary message.", + "readOnly": true + }, + "agentScenario": { + "type": "string", + "description": "Gets the agent scenario where this error occurred.", + "readOnly": true + }, + "possibleCauses": { + "type": "string", + "description": "Gets the error possible causes.", + "readOnly": true + }, + "recommendedAction": { + "type": "string", + "description": "Gets the recommended action for the error.", + "readOnly": true + }, + "severity": { + "type": "string", + "description": "Gets the error severity.", + "readOnly": true + }, + "messageParameters": { + "type": "object", + "description": "Gets the error message parameters.", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "updatedTimeStamp": { + "type": "string", + "format": "date-time", + "description": "Gets the time stamp when the error was updated.", + "readOnly": true + }, + "impactedAssessmentType": { + "type": "string", + "description": "Gets the type of assessment impacted by this error.", + "readOnly": true + } + } + }, + "ErrorSummary": { + "type": "object", + "description": "Error summary containing affected entities for each type of assessment.", + "properties": { + "assessmentType": { + "$ref": "#/definitions/AssessmentType", + "description": "Gets the assessment type.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Gets the affected entity count.", + "readOnly": true + } + } + }, + "ErrorDetail": { + "type": "object", + "description": "Error Details", + "properties": { + "code": { + "type": "string", + "description": "Error Code", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Description of the error occurred", + "readOnly": true + } + }, + "required": [ + "code", + "message" + ] + }, + "EstimatedCostByOffer": { + "type": "object", + "description": "The estimated cost by offer.", + "properties": { + "offerName": { + "type": "string", + "description": "The offer name.", + "readOnly": true + }, + "cost": { + "type": "number", + "format": "float", + "description": "Cost for the offer.", + "readOnly": true + } + } + }, + "EstimatedCostByTarget": { + "type": "object", + "description": "Shows the estimated cost by target.", + "properties": { + "azureSqlMiCost": { + "type": "number", + "format": "float", + "description": "Azure SQL MI cost.", + "readOnly": true + }, + "azureSqlDbCost": { + "type": "number", + "format": "float", + "description": "Azure SQL DB cost.", + "readOnly": true + }, + "appServiceCost": { + "type": "number", + "format": "float", + "description": "Azure App Service cost.", + "readOnly": true + }, + "appServiceContainerCost": { + "type": "number", + "format": "float", + "description": "Azure App Service Containers cost.", + "readOnly": true + }, + "azureKubernetesServiceCost": { + "type": "number", + "format": "float", + "description": "Azure Kubernetes Service cost.", + "readOnly": true + } + } + }, + "EstimatedExternalStorage": { + "type": "object", + "description": "Estimated external storage", + "properties": { + "storageType": { + "$ref": "#/definitions/ExternalStorageType", + "description": "External storage type", + "readOnly": true + }, + "totalStorageInGB": { + "type": "number", + "format": "float", + "description": "Total storage allocation in GB", + "readOnly": true + }, + "storageUtilization": { + "type": "number", + "format": "float", + "description": "Percent storage utilization", + "readOnly": true + }, + "totalStorageCost": { + "type": "number", + "format": "float", + "description": "Total storage cost", + "readOnly": true + } + } + }, + "EstimatedNetwork": { + "type": "object", + "description": "Estimated network", + "properties": { + "skuType": { + "$ref": "#/definitions/NetworkSkuType", + "description": "Network SKU type.", + "readOnly": true + }, + "cost": { + "type": "number", + "format": "float", + "description": "Network Sku type cost.", + "readOnly": true + } + } + }, + "EvaluatedAvsMachine": { + "type": "object", + "description": "Evaluated AVS machine resource.", + "properties": { + "properties": { + "$ref": "#/definitions/EvaluatedAvsMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "EvaluatedAvsMachineListResult": { + "type": "object", + "description": "The response of a EvaluatedAvsMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EvaluatedAvsMachine items on this page", + "items": { + "$ref": "#/definitions/EvaluatedAvsMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EvaluatedAvsMachineProperties": { + "type": "object", + "description": "Evaluated AVS machine properties class.", + "properties": { + "machineId": { + "type": "string", + "description": "Machine Id.", + "readOnly": true + }, + "serverName": { + "type": "string", + "description": "Server Name.", + "readOnly": true + }, + "virtualizationType": { + "type": "string", + "description": "Virtualization type.", + "readOnly": true + }, + "activityState": { + "type": "string", + "description": "Activity state.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating System (OS) name.", + "readOnly": true + }, + "recommendedAzureTarget": { + "type": "string", + "description": "Recommended Azure target.", + "readOnly": true + }, + "qualifyingOffer": { + "type": "string", + "description": "Qualifying offer.", + "readOnly": true + }, + "readyForMigration": { + "type": "string", + "description": "Is machine ready for migration.", + "readOnly": true + }, + "supportStatus": { + "$ref": "#/definitions/SupportabilityStatus", + "description": "End of Support status.", + "readOnly": true + } + } + }, + "EvaluatedMachine": { + "type": "object", + "description": "Evaluated machine resource.", + "properties": { + "properties": { + "$ref": "#/definitions/EvaluatedMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "EvaluatedMachineListResult": { + "type": "object", + "description": "The response of a EvaluatedMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EvaluatedMachine items on this page", + "items": { + "$ref": "#/definitions/EvaluatedMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EvaluatedMachineProperties": { + "type": "object", + "description": "Evaluated machine properties class.", + "properties": { + "machineId": { + "type": "string", + "description": "Machine Id.", + "readOnly": true + }, + "serverName": { + "type": "string", + "description": "Server Name.", + "readOnly": true + }, + "virtualizationType": { + "type": "string", + "description": "Virtualization type.", + "readOnly": true + }, + "activityState": { + "type": "string", + "description": "Activity state.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating System (OS) name.", + "readOnly": true + }, + "recommendedAzureTarget": { + "type": "string", + "description": "Recommended Azure target.", + "readOnly": true + }, + "qualifyingOffer": { + "type": "string", + "description": "Qualifying offer.", + "readOnly": true + }, + "readyForMigration": { + "type": "string", + "description": "Is machine ready for migration.", + "readOnly": true + }, + "supportStatus": { + "$ref": "#/definitions/SupportabilityStatus", + "description": "End of Support status.", + "readOnly": true + } + } + }, + "EvaluatedSqlEntity": { + "type": "object", + "description": "Evaluated sql entity resource.", + "properties": { + "properties": { + "$ref": "#/definitions/EvaluatedSqlEntityProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "EvaluatedSqlEntityListResult": { + "type": "object", + "description": "The response of a EvaluatedSqlEntity list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EvaluatedSqlEntity items on this page", + "items": { + "$ref": "#/definitions/EvaluatedSqlEntity" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EvaluatedSqlEntityProperties": { + "type": "object", + "description": "Evaluated sql entity properties class.", + "properties": { + "serverName": { + "type": "string", + "description": "Server name.", + "readOnly": true + }, + "activityState": { + "type": "string", + "description": "Activity state.", + "readOnly": true + }, + "sqlVersion": { + "type": "string", + "description": "SQL Server version.", + "readOnly": true + }, + "sqlEdition": { + "type": "string", + "description": "SQL Server edition.", + "readOnly": true + }, + "recommendedAzureTarget": { + "type": "string", + "description": "Recommended Azure target.", + "readOnly": true + }, + "qualifyingOffer": { + "type": "string", + "description": "Qualifying offer.", + "readOnly": true + }, + "readyForMigration": { + "type": "string", + "description": "Is SQL Instance ready for migration.", + "readOnly": true + }, + "virtualizationType": { + "type": "string", + "description": "The virtualization type.", + "readOnly": true + }, + "dbCount": { + "type": "integer", + "format": "int32", + "description": "DB count in instance.", + "readOnly": true + }, + "supportStatus": { + "$ref": "#/definitions/SupportabilityStatus", + "description": "End of Support status.", + "readOnly": true + } + } + }, + "EvaluatedWebApp": { + "type": "object", + "description": "Evaluated web app resource.", + "properties": { + "properties": { + "$ref": "#/definitions/EvaluatedWebAppProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "EvaluatedWebAppListResult": { + "type": "object", + "description": "The response of a EvaluatedWebApp list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EvaluatedWebApp items on this page", + "items": { + "$ref": "#/definitions/EvaluatedWebApp" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EvaluatedWebAppProperties": { + "type": "object", + "description": "Evaluated web app properties class.", + "properties": { + "recommendedAzureTarget": { + "type": "string", + "description": "Recommended Azure target." + }, + "recommendedAzureSkuName": { + "type": "string", + "description": "Recommended Azure SKU name." + }, + "recommendedAzureSkuSize": { + "type": "string", + "description": "Recommended Azure SKU size." + }, + "serverName": { + "type": "string", + "description": "The server name." + }, + "workload": { + "type": "string", + "description": "The workload." + }, + "activityState": { + "type": "string", + "description": "The activity state." + }, + "readyForMigration": { + "type": "string", + "description": "Is machine ready for migration." + } + } + }, + "ExternalStorageType": { + "type": "string", + "description": "Different External storage skus.", + "enum": [ + "Unknown", + "None", + "AnfStandard", + "AnfPremium", + "AnfUltra" + ], + "x-ms-enum": { + "name": "ExternalStorageType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Indicates un-supported external storage." + }, + { + "name": "None", + "value": "None", + "description": "Indicates No external storage." + }, + { + "name": "AnfStandard", + "value": "AnfStandard", + "description": "ANF external storage with Standard SKU." + }, + { + "name": "AnfPremium", + "value": "AnfPremium", + "description": "ANF external storage with Premium SKU." + }, + { + "name": "AnfUltra", + "value": "AnfUltra", + "description": "ANF external storage with Ultra SKU." + } + ] + } + }, + "AvsAssessmentScenario": { + "type": "string", + "description": "Scenarios with which Avs Assessments can be created.", + "enum": [ + "Unknown", + "NewAvsSddc", + "AvsSddcExpansion" + ], + "x-ms-enum": { + "name": "AvsAssessmentScenario", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown assessment scenario" + }, + { + "name": "NewAvsSddc", + "value": "NewAvsSddc", + "description": "Create Assessment for new Avs Sddc" + }, + { + "name": "AvsSddcExpansion", + "value": "AvsSddcExpansion", + "description": "Create Assessment for existing Avs Sddc" + } + ] + } + }, + "FacilitySettings": { + "type": "object", + "description": "Facility settings.", + "properties": { + "facilitiesCost": { + "type": "number", + "format": "float", + "description": "The facilities cost." + } + }, + "required": [ + "facilitiesCost" + ] + }, + "FttAndRaidLevel": { + "type": "string", + "description": "FTT and RAID Level.", + "enum": [ + "Unknown", + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt2Raid1", + "Ftt2Raid6", + "Ftt3Raid1" + ], + "x-ms-enum": { + "name": "FttAndRaidLevel", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown FTT and RAID Level." + }, + { + "name": "Ftt1Raid1", + "value": "Ftt1Raid1", + "description": "FTT 1 and RAID Level 1." + }, + { + "name": "Ftt1Raid5", + "value": "Ftt1Raid5", + "description": "FTT 1 and RAID Level 5." + }, + { + "name": "Ftt2Raid1", + "value": "Ftt2Raid1", + "description": "FTT 2 and RAID Level 1." + }, + { + "name": "Ftt2Raid6", + "value": "Ftt2Raid6", + "description": "FTT 2 and RAID Level 6." + }, + { + "name": "Ftt3Raid1", + "value": "Ftt3Raid1", + "description": "FTT 3 and RAID Level 1." + } + ] + } + }, + "Group": { + "type": "object", + "description": "Group resource.", + "properties": { + "properties": { + "$ref": "#/definitions/GroupProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "GroupBodyProperties": { + "type": "object", + "description": "Body properties of group update.", + "properties": { + "operationType": { + "$ref": "#/definitions/GroupUpdateOperation", + "description": "Whether to add or remove the machines." + }, + "machines": { + "type": "array", + "description": "List of machine names that are part of this group.", + "items": { + "type": "string" + } + } + } + }, + "GroupListResult": { + "type": "object", + "description": "The response of a Group list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Group items on this page", + "items": { + "$ref": "#/definitions/Group" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "GroupProperties": { + "type": "object", + "description": "Properties of group resource.", + "properties": { + "groupStatus": { + "$ref": "#/definitions/GroupStatus", + "description": "Whether the group has been created and is valid.", + "readOnly": true + }, + "machineCount": { + "type": "integer", + "format": "int32", + "description": "Number of machines part of this group.", + "readOnly": true + }, + "assessments": { + "type": "array", + "description": "List of References to Assessments created on this group.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "supportedAssessmentTypes": { + "type": "array", + "description": "List of assessment types supported on this group.", + "items": { + "$ref": "#/definitions/AssessmentType" + } + }, + "areAssessmentsRunning": { + "type": "boolean", + "description": "If the assessments are in running state.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Time when this group was created. Date-Time represented in ISO-8601 format.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Time when this group was last updated. Date-Time represented in ISO-8601 format.", + "readOnly": true + }, + "groupType": { + "$ref": "#/definitions/GroupType", + "description": "The type of group.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "GroupStatus": { + "type": "string", + "enum": [ + "Created", + "Updated", + "Running", + "Completed", + "Invalid" + ], + "x-ms-enum": { + "name": "GroupStatus", + "modelAsString": true + } + }, + "GroupType": { + "type": "string", + "enum": [ + "Default", + "Import" + ], + "x-ms-enum": { + "name": "GroupType", + "modelAsString": true + } + }, + "GroupUpdateOperation": { + "type": "string", + "enum": [ + "Add", + "Remove" + ], + "x-ms-enum": { + "name": "GroupUpdateOperation", + "modelAsString": true + } + }, + "GuestOperatingSystemArchitecture": { + "type": "string", + "enum": [ + "Unknown", + "X86", + "X64" + ], + "x-ms-enum": { + "name": "GuestOperatingSystemArchitecture", + "modelAsString": true + } + }, + "HardwareGeneration": { + "type": "string", + "enum": [ + "Unknown", + "Automatic", + "Gen5", + "Fsv2_series", + "M_series", + "DC_series" + ], + "x-ms-enum": { + "name": "HardwareGeneration", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "Automatic", + "value": "Automatic" + }, + { + "name": "Gen5", + "value": "Gen5" + }, + { + "name": "Fsv2Series", + "value": "Fsv2_series" + }, + { + "name": "MSeries", + "value": "M_series" + }, + { + "name": "DCSeries", + "value": "DC_series" + } + ] + } + }, + "HyperVLicenseType": { + "type": "string", + "description": "Business case supported HyperV License types.", + "enum": [ + "Unknown", + "Datacentre", + "Standard" + ], + "x-ms-enum": { + "name": "HyperVLicenseType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown HyperV License." + }, + { + "name": "Datacentre", + "value": "Datacentre", + "description": "Datacentre HyperV License." + }, + { + "name": "Standard", + "value": "Standard", + "description": "Standard HyperV License." + } + ] + } + }, + "HypervCollector": { + "type": "object", + "description": "Hyper-V collector resource.", + "properties": { + "properties": { + "$ref": "#/definitions/CollectorPropertiesBaseWithAgent", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "HypervCollectorListResult": { + "type": "object", + "description": "The response of a HypervCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The HypervCollector items on this page", + "items": { + "$ref": "#/definitions/HypervCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "HypervLicense": { + "type": "object", + "description": "Representation of a licence.", + "properties": { + "licenseCost": { + "type": "number", + "format": "float", + "description": "Cost of a licence." + }, + "licenseType": { + "$ref": "#/definitions/HyperVLicenseType", + "description": "HyperV licence type." + } + }, + "required": [ + "licenseCost", + "licenseType" + ] + }, + "HypervVirtualizationManagementSettings": { + "type": "object", + "description": "HyperV Virtualization Management Settings.", + "properties": { + "numberOfPhysicalCoresPerLicense": { + "type": "integer", + "format": "int32", + "description": "Number of physical cores per licence.", + "minimum": 1 + }, + "softwareAssuranceCost": { + "type": "number", + "format": "float", + "description": "Software Assurance Cost." + }, + "licenseAndSupportList": { + "type": "array", + "description": "Licence and support list.", + "items": { + "$ref": "#/definitions/HypervLicense" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "numberOfPhysicalCoresPerLicense", + "softwareAssuranceCost", + "licenseAndSupportList" + ] + }, + "IaasOsDistribution": { + "type": "object", + "description": "Shows the infrastructure as a service machine OS distribution.", + "properties": { + "windows": { + "type": "integer", + "format": "int32", + "description": "Number of Windows servers.", + "readOnly": true + }, + "linux": { + "type": "integer", + "format": "int32", + "description": "Number of Linux servers.", + "readOnly": true + }, + "other": { + "type": "integer", + "format": "int32", + "description": "Number of servers neither Windows or Linux.", + "readOnly": true + } + } + }, + "IaasOsLicensingDetails": { + "type": "object", + "description": "The Iaas OS licensing details.", + "properties": { + "osType": { + "type": "string", + "description": "The OS type.", + "readOnly": true + }, + "totalCost": { + "type": "number", + "format": "float", + "description": "The total cost.", + "readOnly": true + }, + "decomissionCost": { + "type": "number", + "format": "float", + "description": "The decommission cost.", + "readOnly": true + } + } + }, + "IaasSummary": { + "type": "object", + "description": "Iaas summary REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/IaasSummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "IaasSummaryListResult": { + "type": "object", + "description": "The response of a IaasSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IaasSummary items on this page", + "items": { + "$ref": "#/definitions/IaasSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IaasSummaryProperties": { + "type": "object", + "description": "Iaas summary properties class.", + "properties": { + "azureIaasSummary": { + "$ref": "#/definitions/AzureIaasSummary", + "description": "The Azure IaaS summary.", + "readOnly": true + }, + "onPremisesIaasSummary": { + "$ref": "#/definitions/OnPremisesIaasSummary", + "description": "The on premises IaaS summary.", + "readOnly": true + } + } + }, + "ImpactedAssessmentObject": { + "type": "object", + "description": "Class representing the impacted objects.", + "properties": { + "objectName": { + "type": "string", + "description": "Gets the object name.", + "readOnly": true + }, + "objectType": { + "type": "string", + "description": "Gets the object type.", + "readOnly": true + } + } + }, + "ImportCollector": { + "type": "object", + "description": "Import collector resource.", + "properties": { + "properties": { + "$ref": "#/definitions/CollectorPropertiesBase", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ImportCollectorListResult": { + "type": "object", + "description": "The response of a ImportCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ImportCollector items on this page", + "items": { + "$ref": "#/definitions/ImportCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "LaborSettings": { + "type": "object", + "description": "Labour settings.", + "properties": { + "physicalServersPerAdmin": { + "type": "integer", + "format": "int32", + "description": "Physical servers per administrator.", + "minimum": 1 + }, + "virtualMachinesPerAdmin": { + "type": "integer", + "format": "int32", + "description": "Virtual machines per administrator.", + "minimum": 1 + }, + "hourlyAdminCost": { + "type": "number", + "format": "float", + "description": "Hourly administrator cost." + } + }, + "required": [ + "physicalServersPerAdmin", + "virtualMachinesPerAdmin", + "hourlyAdminCost" + ] + }, + "LicenseType": { + "type": "string", + "description": "Business case supported VmWare License types.", + "enum": [ + "Unknown", + "VSphereStandard", + "VSphereEnterprisePlus" + ], + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown License." + }, + { + "name": "VSphereStandard", + "value": "VSphereStandard", + "description": "VSphereStandard License." + }, + { + "name": "VSphereEnterprisePlus", + "value": "VSphereEnterprisePlus", + "description": "VSphereEnterprisePlus License." + } + ] + } + }, + "LicensingProgram": { + "type": "string", + "description": "Licensing Program for Azure.", + "enum": [ + "Default", + "EA" + ], + "x-ms-enum": { + "name": "LicensingProgram", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "Default value. Indicates Pay As You Go." + }, + { + "name": "EA", + "value": "EA", + "description": "Enterprise Agreement." + } + ] + } + }, + "Machine": { + "type": "object", + "description": "Machine resource.", + "properties": { + "properties": { + "$ref": "#/definitions/MachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "MachineAssessmentProperties": { + "type": "object", + "description": "Properties of an assessment.", + "properties": { + "assessmentErrorSummary": { + "type": "object", + "description": "Gets or sets the assessment error summary.\n This is the number of\nmachines affected by each type of error in this assessment.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "monthlyUltraStorageCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate ultra storage cost for all machines in the\nassessment.", + "readOnly": true + }, + "costComponents": { + "type": "array", + "description": "Gets the collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "eaSubscriptionId": { + "type": "string", + "description": "Gets or sets enterprise agreement subscription id." + }, + "azurePricingTier": { + "$ref": "#/definitions/AzurePricingTier", + "description": "Gets or sets Azure Pricing Tier - Free, Basic, etc." + }, + "azureStorageRedundancy": { + "$ref": "#/definitions/AzureStorageRedundancy", + "description": "Gets or sets the Azure Storage Redundancy. Example: Locally Redundant Storage." + }, + "reservedInstance": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Gets or sets the Azure Reserved Instance - 1-Year, 3-Year." + }, + "azureHybridUseBenefit": { + "$ref": "#/definitions/AzureHybridUseBenefit", + "description": "Gets or sets the user configurable setting to display the azure hybrid use\nbenefit." + }, + "linuxAzureHybridUseBenefit": { + "$ref": "#/definitions/AzureHybridUseBenefit", + "description": "Gets or sets the user configurable setting to display the linux azure hybrid use\nbenefit." + }, + "azureDiskTypes": { + "type": "array", + "description": "Gets or sets the azure storage type. Premium, Standard etc.", + "items": { + "$ref": "#/definitions/AzureDiskType" + } + }, + "azureVmFamilies": { + "type": "array", + "description": "Gets or sets the Azure VM families.", + "items": { + "$ref": "#/definitions/AzureVmFamily" + } + }, + "distributionBySupportStatus": { + "type": "object", + "description": "Gets the distribution of sqlInstances by support status.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "distributionByServicePackInsight": { + "type": "object", + "description": "Gets the distribution distribution of sqlInstances by service pack insight.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "distributionByOsName": { + "type": "object", + "description": "Gets the distribution by os name.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate Compute Cost for all machines in the assessment.", + "readOnly": true + }, + "monthlyBandwidthCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate Bandwidth Cost for all machines in the assessment.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate Storage Cost for all machines in the assessment.", + "readOnly": true + }, + "monthlyPremiumStorageCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate premium storage cost for all machines in the\nassessment.", + "readOnly": true + }, + "monthlyStandardSsdStorageCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate standard SSD storage cost for all the machines in\nthe assessment.", + "readOnly": true + }, + "suitabilitySummary": { + "type": "object", + "description": "Gets or sets the Cloud suitability summary for all the machines in the\nassessment.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Number of machines part of the assessment.", + "readOnly": true + }, + "vmUptime": { + "$ref": "#/definitions/VmUptime", + "description": "Gets or sets the duration for which the VMs are up in the on-premises\nenvironment." + }, + "groupType": { + "$ref": "#/definitions/GroupType", + "description": "Gets the group type for the assessment.", + "readOnly": true + }, + "assessmentType": { + "$ref": "#/definitions/AssessmentType", + "description": "Assessment type of the assessment.", + "readOnly": true + }, + "azureLocation": { + "type": "string", + "description": "Azure Location or Azure region where to which the machines will be migrated." + }, + "azureOfferCode": { + "$ref": "#/definitions/AzureOfferCode", + "description": "Azure Offer Code." + }, + "currency": { + "$ref": "#/definitions/AzureCurrency", + "description": "Currency in which prices should be reported." + }, + "scalingFactor": { + "type": "number", + "format": "float", + "description": "Percentage of buffer that user wants on performance metrics when recommending\nAzure sizes." + }, + "percentile": { + "$ref": "#/definitions/Percentile", + "description": "Percentile of the utilization data values to be considered while assessing\nmachines." + }, + "timeRange": { + "$ref": "#/definitions/TimeRange", + "description": "Time Range for which the historic utilization data should be considered for\nassessment." + }, + "perfDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the start time to consider performance data for assessment." + }, + "perfDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the end time to consider performance data for assessment." + }, + "stage": { + "$ref": "#/definitions/AssessmentStage", + "description": "User configurable setting to display the Stage of Assessment.", + "readOnly": true + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Custom discount percentage." + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion." + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "pricesTimestamp": { + "type": "string", + "format": "date-time", + "description": "Last time when rates were queried.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was last updated.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/AssessmentStatus", + "description": "Whether assessment is in valid state and all machines have been assessed.", + "readOnly": true + }, + "schemaVersion": { + "type": "string", + "description": "Schema version.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "MachineBootType": { + "type": "string", + "enum": [ + "Unknown", + "EFI", + "BIOS", + "NotSpecified" + ], + "x-ms-enum": { + "name": "MachineBootType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "EFI", + "value": "EFI" + }, + { + "name": "Bios", + "value": "BIOS" + }, + { + "name": "NotSpecified", + "value": "NotSpecified" + } + ] + } + }, + "MachineListResult": { + "type": "object", + "description": "The response of a Machine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Machine items on this page", + "items": { + "$ref": "#/definitions/Machine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "MachineProperties": { + "type": "object", + "description": "Properties of a machine.", + "properties": { + "workloadSummary": { + "$ref": "#/definitions/WorkloadSummary", + "description": "Gets or sets workload summary.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "List of errors for this machine.", + "items": { + "$ref": "#/definitions/Error" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "hostProcessor": { + "$ref": "#/definitions/ProcessorInfo", + "description": "Gets Processor details of the host.", + "readOnly": true + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "discoveryMachineArmId": { + "type": "string", + "description": "Site id of machine discovered in private data center.", + "readOnly": true + }, + "datacenterManagementServerArmId": { + "type": "string", + "description": "The data center management server ARM Id for the machine.", + "readOnly": true + }, + "datacenterManagementServerName": { + "type": "string", + "description": "The data center management server name for the machine.", + "readOnly": true + }, + "bootType": { + "$ref": "#/definitions/MachineBootType", + "description": "Boot type of machine discovered in private data center.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display Name of the Machine.", + "readOnly": true + }, + "megabytesOfMemory": { + "type": "number", + "format": "float", + "description": "Megabytes of memory found allocated for the machine in private data center.", + "readOnly": true + }, + "numberOfCores": { + "type": "integer", + "format": "int32", + "description": "Number of CPU cores found on the machine.", + "readOnly": true + }, + "operatingSystemType": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemVersion": { + "type": "string", + "description": "Operating system version as reported by datacenter management solution.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description for the machine.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine first created.", + "readOnly": true + }, + "disks": { + "type": "object", + "description": "Disks attached to the machine discovered in private data center.", + "additionalProperties": { + "$ref": "#/definitions/Disk" + }, + "readOnly": true + }, + "groups": { + "type": "array", + "description": "Gets the References to the groups that this machine is member of.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "networkAdapters": { + "type": "object", + "description": "Network adapters attached to the machine discovered in private data center.", + "additionalProperties": { + "$ref": "#/definitions/NetworkAdapter" + }, + "readOnly": true + }, + "sqlInstances": { + "type": "array", + "description": "SQL instances discovered on the machine.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "webApplications": { + "type": "array", + "description": "Web applications discovered on the machine.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine last updated.", + "readOnly": true + } + } + }, + "ManagementCostComponent": { + "type": "object", + "description": "Management Cost Component.", + "properties": { + "name": { + "$ref": "#/definitions/ManagementCostComponentName", + "description": "Name of Management Cost Component." + }, + "value": { + "type": "number", + "format": "float", + "description": "Cost of Management Component." + } + }, + "required": [ + "name" + ] + }, + "ManagementCostComponentName": { + "type": "string", + "description": "Management Cost Component Names.", + "enum": [ + "Unknown", + "SystemCenterLicenseCost", + "VSphereManagementCost", + "ThirdPartyManagementCost", + "OtherMonitoringCost", + "OtherDataProtectionCost", + "OtherPatchingCost", + "AzureMonitoringCost", + "AzurePatchingCost", + "AzureDataProtectionCost" + ], + "x-ms-enum": { + "name": "ManagementCostComponentName", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Management Cost Component." + }, + { + "name": "SystemCenterLicenseCost", + "value": "SystemCenterLicenseCost", + "description": "System Center License Cost." + }, + { + "name": "VSphereManagementCost", + "value": "VSphereManagementCost", + "description": "VSphere eManagement Cost." + }, + { + "name": "ThirdPartyManagementCost", + "value": "ThirdPartyManagementCost", + "description": "Third Party Management Cost." + }, + { + "name": "OtherMonitoringCost", + "value": "OtherMonitoringCost", + "description": "Other Monitoring Cost." + }, + { + "name": "OtherDataProtectionCost", + "value": "OtherDataProtectionCost", + "description": "Other Data Protection Cost." + }, + { + "name": "OtherPatchingCost", + "value": "OtherPatchingCost", + "description": "Other Patching Cost." + }, + { + "name": "AzureMonitoringCost", + "value": "AzureMonitoringCost", + "description": "Azure Monitoring Cost." + }, + { + "name": "AzurePatchingCost", + "value": "AzurePatchingCost", + "description": "Azure Patching Cost." + }, + { + "name": "AzureDataProtectionCost", + "value": "AzureDataProtectionCost", + "description": "Azure Data Protection Cost." + } + ] + } + }, + "ManagementCostDetails": { + "type": "object", + "description": "Management Cost Details.", + "properties": { + "managementCost": { + "type": "number", + "format": "float", + "description": "Management Cost.", + "readOnly": true + }, + "managementCostComponents": { + "type": "array", + "description": "Management Cost Components.", + "items": { + "$ref": "#/definitions/ManagementCostComponent" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "ManagementSettings": { + "type": "object", + "description": "Management settings.", + "properties": { + "hypervVirtualizationManagementSettings": { + "$ref": "#/definitions/HypervVirtualizationManagementSettings", + "description": "HyperV Virtualization Management Settings." + }, + "vsphereManagementSettings": { + "$ref": "#/definitions/VsphereManagementSettings", + "description": "vSphere Management Settings." + }, + "thirdPartyManagementSettings": { + "$ref": "#/definitions/ThirdPartyManagementSettings", + "description": "Third Party Management Settings." + }, + "otherManagementCostsSettings": { + "$ref": "#/definitions/OtherManagementCostsSettings", + "description": "Other Management Costs Settings." + } + }, + "required": [ + "hypervVirtualizationManagementSettings", + "vsphereManagementSettings", + "thirdPartyManagementSettings", + "otherManagementCostsSettings" + ] + }, + "MigrationGuidelineContext": { + "type": "object", + "description": "Migration Guideline Context.", + "properties": { + "contextKey": { + "type": "string", + "description": "Gets the reasoning context key." + }, + "contextValue": { + "type": "string", + "description": "Gets the reasoning context value." + } + } + }, + "MigrationStrategy": { + "type": "string", + "description": "Business case supported migration strategy types.", + "enum": [ + "Unknown", + "OptimizeForCost", + "IaaSOnly", + "OptimizeForPaas", + "AVSOnly" + ], + "x-ms-enum": { + "name": "MigrationStrategy", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Migration Strategy." + }, + { + "name": "OptimizeForCost", + "value": "OptimizeForCost", + "description": "Optimize for cost." + }, + { + "name": "IaaSOnly", + "value": "IaaSOnly", + "description": "IaaS only." + }, + { + "name": "OptimizeForPaas", + "value": "OptimizeForPaas", + "description": "Optimize for PaaS." + }, + { + "name": "AVSOnly", + "value": "AVSOnly", + "description": "Avs only." + } + ] + } + }, + "MoreInfo": { + "type": "object", + "description": "Data model of More information about check or rule.", + "properties": { + "title": { + "type": "string", + "description": "Gets title.", + "readOnly": true + }, + "url": { + "type": "string", + "description": "Gets url.", + "readOnly": true + } + }, + "required": [ + "title", + "url" + ] + }, + "MultiSubnetIntent": { + "type": "string", + "enum": [ + "None", + "HighAvailability", + "DisasterRecovery" + ], + "x-ms-enum": { + "name": "MultiSubnetIntent", + "modelAsString": true + } + }, + "MutableArmResource": { + "type": "object", + "description": "ARM model of Assessment ARM object.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningStatus", + "description": "Gets the provisioning state.", + "readOnly": true + } + } + }, + "NetworkAdapter": { + "type": "object", + "description": "A network adapter discovered on a machine.", + "properties": { + "macAddress": { + "type": "string", + "description": "MAC Address of the network adapter.", + "readOnly": true + }, + "ipAddresses": { + "type": "array", + "description": "List of IP Addresses on the network adapter.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "User friendly name of the network adapter.", + "readOnly": true + } + } + }, + "NetworkSettings": { + "type": "object", + "description": "Network settings.", + "properties": { + "hardwareSoftwareCostPercentage": { + "type": "number", + "format": "float", + "description": "Network hardware and software cost percentage.", + "minimum": 0, + "maximum": 100 + }, + "maintenanceCostPercentage": { + "type": "number", + "format": "float", + "description": "Network maintenance cost percentage.", + "minimum": 0, + "maximum": 100 + } + }, + "required": [ + "hardwareSoftwareCostPercentage", + "maintenanceCostPercentage" + ] + }, + "NetworkSkuType": { + "type": "string", + "description": "Different network skus.", + "enum": [ + "Unknown", + "None", + "ExpressRouteUltra" + ], + "x-ms-enum": { + "name": "NetworkSkuType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Indicates un-supported network SKU." + }, + { + "name": "None", + "value": "None", + "description": "Indicates No network SKU." + }, + { + "name": "ExpressRouteUltra", + "value": "ExpressRouteUltra", + "description": "Express Route network type with Ultra SKU." + } + ] + } + }, + "NodePool": { + "type": "object", + "description": "Data model of Node Pool.", + "properties": { + "id": { + "type": "string", + "description": "Gets id.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Gets name.", + "readOnly": true + }, + "clusterName": { + "type": "string", + "description": "Gets cluster name.", + "readOnly": true + }, + "mode": { + "$ref": "#/definitions/NodePoolMode", + "description": "Gets mode.", + "readOnly": true + }, + "osType": { + "$ref": "#/definitions/OSType", + "description": "Gets os type.", + "readOnly": true + }, + "armSkuName": { + "type": "string", + "description": "Gets arm sku name.", + "readOnly": true + }, + "nodeCount": { + "type": "integer", + "format": "int32", + "description": "Gets node count.", + "readOnly": true + }, + "podCount": { + "type": "integer", + "format": "int32", + "description": "Gets pod count.", + "readOnly": true + }, + "monthlyCost": { + "type": "number", + "format": "float", + "description": "Gets monthly cost.", + "readOnly": true + }, + "podApproxMonthlyCost": { + "type": "number", + "format": "float", + "description": "Gets pod approximate monthly cost.", + "readOnly": true + } + }, + "required": [ + "id", + "name", + "clusterName", + "mode", + "osType", + "armSkuName", + "nodeCount", + "podCount", + "monthlyCost", + "podApproxMonthlyCost" + ] + }, + "NodePoolMode": { + "type": "string", + "description": "Node Pool Mode.", + "enum": [ + "User", + "System" + ], + "x-ms-enum": { + "name": "NodePoolMode", + "modelAsString": true, + "values": [ + { + "name": "User", + "value": "User", + "description": "Indicates User node pool." + }, + { + "name": "System", + "value": "System", + "description": "Indicates System node pool." + } + ] + } + }, + "OSType": { + "type": "string", + "description": "Operating System Type.", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true, + "values": [ + { + "name": "Linux", + "value": "Linux", + "description": "Linux OS Type." + }, + { + "name": "Windows", + "value": "Windows", + "description": "Windows OS Type." + } + ] + } + }, + "OnPremiseSettings": { + "type": "object", + "description": "On-premise settings.", + "properties": { + "computeSettings": { + "$ref": "#/definitions/ComputeSettings", + "description": "Compute settings." + }, + "storageSettings": { + "$ref": "#/definitions/StorageSettings", + "description": "Storage settings." + }, + "networkSettings": { + "$ref": "#/definitions/NetworkSettings", + "description": "Network settings." + }, + "facilitySettings": { + "$ref": "#/definitions/FacilitySettings", + "description": "Facility settings." + }, + "laborSettings": { + "$ref": "#/definitions/LaborSettings", + "description": "Labour settings." + }, + "securitySettings": { + "$ref": "#/definitions/SecuritySettings", + "description": "Security settings." + }, + "managementSettings": { + "$ref": "#/definitions/ManagementSettings", + "description": "Management settings." + } + }, + "required": [ + "computeSettings", + "storageSettings", + "networkSettings", + "facilitySettings", + "laborSettings", + "securitySettings" + ] + }, + "OnPremisesIaasSummary": { + "type": "object", + "description": "The on premises IAAS summary.", + "properties": { + "servers": { + "type": "integer", + "format": "int32", + "description": "The number of servers.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "The number of cores.", + "readOnly": true + }, + "memoryGb": { + "type": "number", + "format": "float", + "description": "Total memory in GB.", + "readOnly": true + }, + "cpuUtilization": { + "type": "number", + "format": "float", + "description": "The CPU utilization.", + "readOnly": true + }, + "memoryUtilization": { + "type": "number", + "format": "float", + "description": "The memory utilization.", + "readOnly": true + }, + "storageUtilization": { + "type": "number", + "format": "float", + "description": "The storage utilization.", + "readOnly": true + }, + "onPremisesIaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "onPremisesIaasCostForDecommissioned": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "osLicensingDetails": { + "type": "array", + "description": "The OS licensing details.", + "items": { + "$ref": "#/definitions/IaasOsLicensingDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByOperatingSystem": { + "type": "array", + "description": "The distribution by operating system.", + "items": { + "$ref": "#/definitions/DistributionByOperatingSystem" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "onPremisesUtilizationData": { + "$ref": "#/definitions/UtilizationData", + "description": "The SQL on premises utilization insights.", + "readOnly": true + }, + "distributionByVirtualization": { + "type": "array", + "description": "The distribution by virtualization.", + "items": { + "$ref": "#/definitions/DistributionByVirtualization" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "iaasOsSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "Iaas OS Support Status Distribution.", + "readOnly": true + }, + "iaasSqlSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "Iaas Sql Support Status Distribution.", + "readOnly": true + }, + "osServicePackInsight": { + "$ref": "#/definitions/ServicePackInsight", + "description": "OS Service Pack Insight.", + "readOnly": true + }, + "sqlServicePackInsight": { + "$ref": "#/definitions/ServicePackInsight", + "description": "Sql Service Pack Insight.", + "readOnly": true + }, + "distributionByOperatingSystemVersion": { + "type": "array", + "description": "Distribution by Operating System Version.", + "items": { + "$ref": "#/definitions/DistributionByType" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionBySqlVersion": { + "type": "array", + "description": "Distribution by Sql Version.", + "items": { + "$ref": "#/definitions/DistributionByType" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionBySqlEdition": { + "type": "array", + "description": "Distribution by Sql Edition.", + "items": { + "$ref": "#/definitions/DistributionByType" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "OnPremisesPaasLicensingCost": { + "type": "object", + "description": "The on premises paas licensing cost.", + "properties": { + "version": { + "type": "string", + "description": "The version.", + "readOnly": true + }, + "totalCost": { + "type": "number", + "format": "float", + "description": "The total cost.", + "readOnly": true + }, + "decomissionServerCost": { + "type": "number", + "format": "float", + "description": "The decommissioned server cost.", + "readOnly": true + } + } + }, + "OnPremisesPaasSummary": { + "type": "object", + "description": "Shows platform as a service (PaaS) summary.", + "properties": { + "totalServers": { + "type": "integer", + "format": "int32", + "description": "Total servers.", + "readOnly": true + }, + "cpuUtilization": { + "type": "number", + "format": "float", + "description": "CPU utilization percentage.", + "readOnly": true + }, + "memoryUtilization": { + "type": "number", + "format": "float", + "description": "Memory utilization percentage.", + "readOnly": true + }, + "totalOnPremisesPaasCost": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "onPremisesPaasCostForDecommisioned": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "onPremisesPaasLicensingCost": { + "$ref": "#/definitions/OnPremisesPaasLicensingCost", + "description": "The on premises paas licensing cost.", + "readOnly": true + }, + "onPremisesSqlSummary": { + "$ref": "#/definitions/OnPremisesSqlSummary", + "description": "The on premises SQL summary.", + "readOnly": true + }, + "onPremisesWebAppSummary": { + "$ref": "#/definitions/OnPremisesWebAppSummary", + "description": "The on premises web application summary.", + "readOnly": true + }, + "osSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "OS Support Status Distribution.", + "readOnly": true + }, + "sqlSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "Sql Support Status Distribution.", + "readOnly": true + }, + "osServicePackInsight": { + "$ref": "#/definitions/ServicePackInsight", + "description": "OS Service Pack Insight.", + "readOnly": true + }, + "sqlServicePackInsight": { + "$ref": "#/definitions/ServicePackInsight", + "description": "Sql Service Pack Insight.", + "readOnly": true + } + } + }, + "OnPremisesSqlSummary": { + "type": "object", + "description": "The on premises SQL summary.", + "properties": { + "sqlInstances": { + "type": "integer", + "format": "int32", + "description": "The number of SQL instances.", + "readOnly": true + }, + "sqlDatabases": { + "type": "integer", + "format": "int32", + "description": "The number of SQL databases.", + "readOnly": true + }, + "distributionBySqlVersion": { + "type": "array", + "description": "Distribution by SQL version.", + "items": { + "$ref": "#/definitions/SqlVersionDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sqlOnPremisesUtilizationData": { + "$ref": "#/definitions/UtilizationData", + "description": "The SQL on premises utilization insights.", + "readOnly": true + }, + "distributionBySqlEdition": { + "type": "array", + "description": "Distribution by Sql Edition.", + "items": { + "$ref": "#/definitions/DistributionByType" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "OnPremisesWebAppSummary": { + "type": "object", + "description": "The on premises web application summary.", + "properties": { + "numberOfWebServers": { + "type": "integer", + "format": "int32", + "description": "The number of web servers.", + "readOnly": true + }, + "numberOfWebApplications": { + "type": "integer", + "format": "int32", + "description": "The number of web applications.", + "readOnly": true + }, + "numberOfWebAppsPerType": { + "type": "object", + "description": "The number of web applications per web application type.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + } + } + }, + "OptimizationLogic": { + "type": "string", + "enum": [ + "MinimizeCost", + "ModernizeToPaaS", + "ModernizeToAzureSqlMi", + "ModernizeToAzureSqlDb" + ], + "x-ms-enum": { + "name": "OptimizationLogic", + "modelAsString": true + } + }, + "OptionsArmPropertiesBase": { + "type": "object", + "description": "Base ARM model of ARM properties for assessment options.", + "properties": { + "edges": { + "type": "object", + "description": "Gets the mapping of Assessment Options in graph representation.", + "additionalProperties": { + "$ref": "#/definitions/RecordOfStringArray" + }, + "readOnly": true + } + }, + "required": [ + "edges" + ] + }, + "OsLicense": { + "type": "string", + "enum": [ + "Unknown", + "Yes", + "No" + ], + "x-ms-enum": { + "name": "OsLicense", + "modelAsString": true + } + }, + "OtherManagementCostsSettings": { + "type": "object", + "description": "Other Management Costs Settings.", + "properties": { + "monitoringCostPerServerPerYear": { + "type": "number", + "format": "float", + "description": "Monitoring Cost Per Server Per Year." + }, + "patchingCostPerServerPerYear": { + "type": "number", + "format": "float", + "description": "Patching Cost Per Server Per Year." + }, + "dataProtectionCostPerServerPerYear": { + "type": "number", + "format": "float", + "description": "Data Protection Cost Per Server Per Year." + } + }, + "required": [ + "monitoringCostPerServerPerYear", + "patchingCostPerServerPerYear", + "dataProtectionCostPerServerPerYear" + ] + }, + "OverviewSummary": { + "type": "object", + "description": "Overview summary REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/OverviewSummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "OverviewSummaryListResult": { + "type": "object", + "description": "The response of a OverviewSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The OverviewSummary items on this page", + "items": { + "$ref": "#/definitions/OverviewSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "OverviewSummaryProperties": { + "type": "object", + "description": "Overview summary properties class.", + "properties": { + "totalAzureCost": { + "type": "number", + "format": "float", + "description": "The total Azure cost..", + "readOnly": true + }, + "totalAzureIaasCost": { + "type": "number", + "format": "float", + "description": "The total Azure IaaS cost.", + "readOnly": true + }, + "totalAzurePaasCost": { + "type": "number", + "format": "float", + "description": "The total Azure PaaS cost.", + "readOnly": true + }, + "totalAzureAvsCost": { + "type": "number", + "format": "float", + "description": "The total Avs cost.", + "readOnly": true + }, + "windowsAhubSavings": { + "type": "number", + "format": "float", + "description": "The windows ahub saving.", + "readOnly": true + }, + "linuxAhubSavings": { + "type": "number", + "format": "float", + "description": "The linux ahub saving.", + "readOnly": true + }, + "sqlAhubSavings": { + "type": "number", + "format": "float", + "description": "The sql ahub saving.", + "readOnly": true + }, + "totalOnPremisesCost": { + "type": "number", + "format": "float", + "description": "The total on premises cost.", + "readOnly": true + }, + "esuSavingsFor4years": { + "type": "number", + "format": "float", + "description": "ESU Savings 4 Years.", + "readOnly": true + }, + "managementCostSavings": { + "type": "number", + "format": "float", + "description": "The management cost saving.", + "readOnly": true + }, + "securityCostSavings": { + "type": "number", + "format": "float", + "description": "The security cost saving.", + "readOnly": true + }, + "yearOnYearEstimates": { + "$ref": "#/definitions/YearOnYearEstimates", + "description": "Shows the year-on-year cost overall.", + "readOnly": true + }, + "serversDiscovered": { + "$ref": "#/definitions/ServersDiscovered", + "description": "Shows the discovered servers by virtualization platform.", + "readOnly": true + }, + "utilizationData": { + "$ref": "#/definitions/UtilizationData", + "description": "The SQL on premises utilization insights.", + "readOnly": true + }, + "iaasOsDistribution": { + "$ref": "#/definitions/IaasOsDistribution", + "description": "Shows the infrastructure as a service machine OS distribution.", + "readOnly": true + }, + "osSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "OS Support Status Distribution.", + "readOnly": true + }, + "sqlSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "Sql Support Status Distribution.", + "readOnly": true + }, + "paasDistribution": { + "$ref": "#/definitions/PaasDistribution", + "description": "Shows the distribution of platforms.", + "readOnly": true + } + } + }, + "POSAzurePricingTier": { + "type": "string", + "description": "Pricing Tier for Azure.", + "enum": [ + "Unknown", + "Standard" + ], + "x-ms-enum": { + "name": "POSAzurePricingTier", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown. Indicates missing data." + }, + { + "name": "Standard", + "value": "Standard", + "description": "Standard Pricing Tier." + } + ] + } + }, + "PaasDistribution": { + "type": "object", + "description": "Shows the distribution of platforms.", + "properties": { + "sqlServers": { + "type": "integer", + "format": "int32", + "description": "Number of SQL Server machines.", + "readOnly": true + }, + "iisWebServers": { + "type": "integer", + "format": "int32", + "description": "Number of IIS Web servers.", + "readOnly": true + }, + "webAppDistribution": { + "type": "object", + "description": "Distribution of webapps for each target type.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + } + } + }, + "PaasSummary": { + "type": "object", + "description": "Paas summary REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/PaasSummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PaasSummaryListResult": { + "type": "object", + "description": "The response of a PaasSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PaasSummary items on this page", + "items": { + "$ref": "#/definitions/PaasSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PaasSummaryProperties": { + "type": "object", + "description": "Paas summary properties class.", + "properties": { + "azure": { + "$ref": "#/definitions/AzurePaasSummary", + "description": "Shows the PaaS Azure summary.", + "readOnly": true + }, + "onPremises": { + "$ref": "#/definitions/OnPremisesPaasSummary", + "description": "Shows platform as a service (PaaS) summary.", + "readOnly": true + } + } + }, + "Percentile": { + "type": "string", + "description": "Percentile for Performance Data.", + "enum": [ + "Percentile50", + "Percentile90", + "Percentile95", + "Percentile99" + ], + "x-ms-enum": { + "name": "Percentile", + "modelAsString": true, + "values": [ + { + "name": "Percentile50", + "value": "Percentile50", + "description": "Percentile 50." + }, + { + "name": "Percentile90", + "value": "Percentile90", + "description": "Percentile 90." + }, + { + "name": "Percentile95", + "value": "Percentile95", + "description": "Percentile 95." + }, + { + "name": "Percentile99", + "value": "Percentile99", + "description": "Percentile 99." + } + ] + } + }, + "PerfDataSettings": { + "type": "object", + "description": "Data model of Performance Data Settings.", + "properties": { + "timeRange": { + "$ref": "#/definitions/TimeRange", + "description": "Gets perf data time range." + }, + "perfDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets perf data start time." + }, + "perfDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets perf data end time." + }, + "percentile": { + "$ref": "#/definitions/Percentile", + "description": "Gets percentile utilization for performance data." + } + }, + "required": [ + "timeRange", + "percentile" + ] + }, + "PricingTier": { + "type": "string", + "description": "Pricing Tier for Azure.", + "enum": [ + "Standard", + "Free" + ], + "x-ms-enum": { + "name": "PricingTier", + "modelAsString": true, + "values": [ + { + "name": "Standard", + "value": "Standard", + "description": "Standard Pricing Tier." + }, + { + "name": "Free", + "value": "Free", + "description": "Free Pricing Tier." + } + ] + } + }, + "PrivateEndpointConnection": { + "type": "object", + "description": "Private endpoint connection resource.", + "properties": { + "properties": { + "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnectionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "The response of a PrivateEndpointConnection list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PrivateEndpointConnection items on this page", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PrivateLinkResource": { + "type": "object", + "description": "Private link resource.", + "properties": { + "properties": { + "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateLinkResourceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PrivateLinkResourceListResult": { + "type": "object", + "description": "The response of a PrivateLinkResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PrivateLinkResource items on this page", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ProcessorInfo": { + "type": "object", + "description": "Represents a information \\ details of a processor.", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name \\ model of a processor." + }, + "numberOfSockets": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of sockets." + }, + "numberOfCoresPerSocket": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of cores in a socket." + } + } + }, + "ProductSupportStatus": { + "type": "object", + "description": "Class to represent the Product Support Status.", + "properties": { + "currentVersion": { + "type": "string", + "description": "Gets or sets current version of ServicePack.", + "readOnly": true + }, + "servicePackStatus": { + "type": "string", + "description": "Gets or sets ServicePack of the product.", + "readOnly": true + }, + "esuStatus": { + "type": "string", + "description": "Gets or sets the Extended Security Update ESU status.", + "readOnly": true + }, + "supportStatus": { + "type": "string", + "description": "Gets or sets the support status of the product.", + "readOnly": true + }, + "eta": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the ETA.", + "readOnly": true + }, + "currentEsuYear": { + "type": "string", + "description": "Gets or sets the current ESU support year.", + "readOnly": true + }, + "mainstreamEndDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the main stream end date of the product.", + "readOnly": true + }, + "extendedSupportEndDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the extended support end date of the product.", + "readOnly": true + }, + "extendedSecurityUpdateYear1EndDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the extended security update year 1 end date of the product.", + "readOnly": true + }, + "extendedSecurityUpdateYear2EndDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the extended security update year 2 end date of the product.", + "readOnly": true + }, + "extendedSecurityUpdateYear3EndDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the extended security update year 3 end date of the product.", + "readOnly": true + } + } + }, + "ProjectProperties": { + "type": "object", + "description": "Properties of a project.", + "properties": { + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Time when this project was created. Date-Time represented in ISO-8601 format.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Time when this project was last updated. Date-Time represented in ISO-8601\nformat.", + "readOnly": true + }, + "serviceEndpoint": { + "type": "string", + "description": "Endpoint at which the collector agent can call agent REST API.", + "readOnly": true + }, + "assessmentSolutionId": { + "type": "string", + "description": "Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects." + }, + "projectStatus": { + "$ref": "#/definitions/ProjectStatus", + "description": "Assessment project status." + }, + "customerWorkspaceId": { + "type": "string", + "description": "The ARM id of service map workspace created by customer." + }, + "customerWorkspaceLocation": { + "type": "string", + "description": "Location of service map workspace created by customer." + }, + "publicNetworkAccess": { + "type": "string", + "description": "This value can be set to 'enabled' to avoid breaking changes on existing\ncustomer resources and templates. If set to 'disabled', traffic over public\ninterface is not allowed, and private endpoint connections would be the\nexclusive access method." + }, + "privateEndpointConnections": { + "type": "array", + "description": "The list of private endpoint connections to the project.", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "customerStorageAccountArmId": { + "type": "string", + "description": "The ARM id of the storage account used for interactions when public access is\ndisabled." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "ProjectStatus": { + "type": "string", + "description": "Project Status.", + "enum": [ + "Active", + "Inactive" + ], + "x-ms-enum": { + "name": "ProjectStatus", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "Active Status." + }, + { + "name": "Inactive", + "value": "Inactive", + "description": "Inactive Status." + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The status of the current operation.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Updating", + "Deleting", + "Accepted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Resource is being Provisioned." + }, + { + "name": "Updating", + "value": "Updating", + "description": "Resource is being Updated." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Resource is being Deleted." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Resource is being Accepted." + } + ] + } + }, + "ProvisioningState2": { + "type": "string", + "description": "The status of the current operation.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Updating", + "Deleting", + "Accepted" + ], + "x-ms-enum": { + "name": "ProvisioningState2", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Resource is being Provisioned." + }, + { + "name": "Updating", + "value": "Updating", + "description": "Resource is being Updated." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Resource is being Deleted." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Resource is being Accepted." + } + ] + }, + "readOnly": true + }, + "ProvisioningStatus": { + "type": "string", + "description": "Provisioning Status.", + "enum": [ + "Unknown", + "Succeeded", + "Failed", + "Canceled", + "InProgress" + ], + "x-ms-enum": { + "name": "ProvisioningStatus", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown. Indicates missing data." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "Provisioning is in Progress." + } + ] + }, + "readOnly": true + }, + "Readiness": { + "type": "string", + "description": "Readiness for Azure.", + "enum": [ + "Unknown", + "NotReady", + "ReadyWithConditions", + "Ready" + ], + "x-ms-enum": { + "name": "Readiness", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Readiness." + }, + { + "name": "NotReady", + "value": "NotReady", + "description": "Not Ready." + }, + { + "name": "ReadyWithConditions", + "value": "ReadyWithConditions", + "description": "Ready with conditions." + }, + { + "name": "Ready", + "value": "Ready", + "description": "Ready for migration." + } + ] + } + }, + "RecommendationResult": { + "type": "object", + "description": "Data model of Recommendation Result.", + "properties": { + "request": { + "$ref": "#/definitions/ComputeResource", + "description": "Gets cores and memory request.", + "readOnly": true + }, + "limit": { + "$ref": "#/definitions/ComputeResource", + "description": "Gets cores and memory limit.", + "readOnly": true + }, + "osType": { + "$ref": "#/definitions/OSType", + "description": "Gets os type.", + "readOnly": true + }, + "clusterName": { + "type": "string", + "description": "Gets cluster name.", + "readOnly": true + }, + "nodePoolId": { + "type": "string", + "description": "Gets node pool id.", + "readOnly": true + }, + "nodePoolName": { + "type": "string", + "description": "Gets node pool name.", + "readOnly": true + }, + "nodePoolArmSkuName": { + "type": "string", + "description": "Gets node pool arm sku name.", + "readOnly": true + }, + "approxMonthlyCost": { + "type": "number", + "format": "float", + "description": "Gets approximate monthly cost.", + "readOnly": true + } + }, + "required": [ + "request", + "limit", + "osType", + "clusterName", + "nodePoolId", + "nodePoolName", + "nodePoolArmSkuName", + "approxMonthlyCost" + ] + }, + "RecommendedAvsNodeTypeSummary": { + "type": "object", + "description": "Azure Avs Node summary.", + "properties": { + "avsNodeType": { + "type": "string", + "description": "AVS node type.", + "readOnly": true + }, + "numberOfNodes": { + "type": "integer", + "format": "int32", + "description": "Number of nodes.", + "readOnly": true + }, + "failuresToTolerateAndRaidLevel": { + "$ref": "#/definitions/FttAndRaidLevel", + "description": "Failures to tolerate and RAID level for the Node.", + "readOnly": true + } + } + }, + "RecommendedSuitability": { + "type": "string", + "enum": [ + "Unknown", + "SuitableForSqlDB", + "SuitableForSqlMI", + "SuitableForVM", + "PotentiallySuitableForVM", + "ReadinessUnknown", + "NotSuitable", + "SuitableForSqlVM", + "ConditionallySuitableForSqlDB", + "ConditionallySuitableForSqlMI", + "ConditionallySuitableForVM", + "ConditionallySuitableForSqlVM" + ], + "x-ms-enum": { + "name": "RecommendedSuitability", + "modelAsString": true + } + }, + "RecommendedVmFamilySummary": { + "type": "object", + "description": "The recommended VM family summary.", + "properties": { + "azureVmFamily": { + "type": "string", + "description": "The Azure VM family.", + "readOnly": true + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "The number of machines.", + "readOnly": true + } + } + }, + "RecordOfInt": { + "type": "object", + "description": "Data Model for Dictionary.", + "additionalProperties": { + "format": "int32", + "type": "integer" + } + }, + "RecordOfStringArray": { + "type": "object", + "description": "Data Model for Dictionary.", + "additionalProperties": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "ReportDetails": { + "type": "object", + "description": "Business case report details.", + "properties": { + "reportType": { + "$ref": "#/definitions/ReportType", + "description": "Report type.", + "readOnly": true + }, + "reportStatus": { + "$ref": "#/definitions/ReportStatus", + "description": "Report status.", + "readOnly": true + } + } + }, + "ReportDownloadUrl": { + "type": "object", + "description": "Download URL for assessment report.", + "properties": { + "businessCaseReportUrl": { + "type": "string", + "description": "Hyperlink to download report.", + "readOnly": true + }, + "expirationTime": { + "type": "string", + "format": "date-time", + "description": "Expiry date of download url.", + "readOnly": true + } + } + }, + "ReportStatus": { + "type": "string", + "description": "Business case supported report status types.", + "enum": [ + "Unknown", + "None", + "InProgress", + "Failed", + "Completed" + ], + "x-ms-enum": { + "name": "ReportStatus", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Report Status." + }, + { + "name": "None", + "value": "None", + "description": "None Report Status." + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "InProgress Report Status." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed Report Status." + }, + { + "name": "Completed", + "value": "Completed", + "description": "Completed Report Status." + } + ] + } + }, + "ReportType": { + "type": "string", + "description": "Business case supported report types.", + "enum": [ + "Unknown", + "Excel" + ], + "x-ms-enum": { + "name": "ReportType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Report Type." + }, + { + "name": "Excel", + "value": "Excel", + "description": "Excel Report Type." + } + ] + } + }, + "ResourceId": { + "type": "object", + "description": "ARM id for a resource.", + "properties": { + "id": { + "type": "string", + "description": "Gets the relative URL to get to this REST resource.", + "readOnly": true + } + } + }, + "SavingsOption": { + "type": "string", + "description": "Business case supported Savings Option types.", + "enum": [ + "Unknown", + "RI3Year", + "SavingsPlan3Year" + ], + "x-ms-enum": { + "name": "SavingsOption", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Savings Option." + }, + { + "name": "RI3Year", + "value": "RI3Year", + "description": "Reserved Instance 3 Year." + }, + { + "name": "SavingsPlan3Year", + "value": "SavingsPlan3Year", + "description": "Azure Savings Plan 3 Year." + } + ] + } + }, + "SavingsOptions": { + "type": "string", + "description": "Savings Options for Azure.", + "enum": [ + "None", + "OneYearSavings", + "ThreeYearsSavings", + "OneYearReserved", + "ThreeYearsReserved" + ], + "x-ms-enum": { + "name": "SavingsOptions", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "Savings Options is not applicable." + }, + { + "name": "OneYearSavings", + "value": "OneYearSavings", + "description": "One Year Savings Plan." + }, + { + "name": "ThreeYearsSavings", + "value": "ThreeYearsSavings", + "description": "Three Years Savings Plan." + }, + { + "name": "OneYearReserved", + "value": "OneYearReserved", + "description": "One Year Reserved Instances." + }, + { + "name": "ThreeYearsReserved", + "value": "ThreeYearsReserved", + "description": "Three Years Reserved Instances." + } + ] + } + }, + "SecuritySettings": { + "type": "object", + "description": "Security settings.", + "properties": { + "serverSecurityCostPerServerPerYear": { + "type": "number", + "format": "float", + "description": "Physical servers per administrator." + }, + "sqlServerSecurityCostPerServerPerYear": { + "type": "number", + "format": "float", + "description": "Virtual machines per administrator." + } + }, + "required": [ + "serverSecurityCostPerServerPerYear", + "sqlServerSecurityCostPerServerPerYear" + ] + }, + "ServerCollector": { + "type": "object", + "description": "Physical server collector resource.", + "properties": { + "properties": { + "$ref": "#/definitions/CollectorPropertiesBaseWithAgent", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ServerCollectorListResult": { + "type": "object", + "description": "The response of a ServerCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ServerCollector items on this page", + "items": { + "$ref": "#/definitions/ServerCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ServersDiscovered": { + "type": "object", + "description": "Shows the discovered servers by virtualization platform.", + "properties": { + "vmWare": { + "type": "integer", + "format": "int32", + "description": "Number of servers on VMWare.", + "readOnly": true + }, + "hyperV": { + "type": "integer", + "format": "int32", + "description": "Number of servers on HyperV.", + "readOnly": true + }, + "physical": { + "type": "integer", + "format": "int32", + "description": "Number of physical servers.", + "readOnly": true + }, + "notApplicable": { + "type": "integer", + "format": "int32", + "description": "Number of servers whose virtualization is unknown.", + "readOnly": true + } + } + }, + "ServicePackInsight": { + "type": "object", + "description": "Service Pack Insight.", + "properties": { + "unknownServicePack": { + "type": "integer", + "format": "int32", + "description": "Unknown support.", + "readOnly": true + }, + "patched": { + "type": "integer", + "format": "int32", + "description": "Patched Service Pack Insight.", + "readOnly": true + }, + "unpatched": { + "type": "integer", + "format": "int32", + "description": "Unpatched Service Pack Insight.", + "readOnly": true + } + } + }, + "Settings": { + "type": "object", + "description": "Business case settings.", + "properties": { + "azureSettings": { + "$ref": "#/definitions/AzureSettings", + "description": "Azure settings for a business case." + }, + "onPremiseSettings": { + "$ref": "#/definitions/OnPremiseSettings", + "description": "On-premise settings." + } + }, + "required": [ + "azureSettings" + ] + }, + "SharedResourcesDTO": { + "type": "object", + "description": "Shared Resources.", + "properties": { + "sharedDataDisks": { + "type": "array", + "description": "Gets the list of shared data disks.", + "items": { + "$ref": "#/definitions/AzureManagedDiskSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sharedLogDisks": { + "type": "array", + "description": "Gets the list of shared log disks.", + "items": { + "$ref": "#/definitions/AzureManagedDiskSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sharedTempDbDisks": { + "type": "array", + "description": "Gets the list of shared Temporary database disks.", + "items": { + "$ref": "#/definitions/AzureManagedDiskSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "numberOfMounts": { + "type": "integer", + "format": "int32", + "description": "Gets number of mounts of shared disks.", + "readOnly": true + }, + "quorumWitness": { + "$ref": "#/definitions/AzureQuorumWitnessDTO", + "description": "Gets quorum witness.", + "readOnly": true + } + } + }, + "SkuReplicationMode": { + "type": "string", + "enum": [ + "NotApplicable", + "ActiveGeoReplication", + "FailoverGroupInstance" + ], + "x-ms-enum": { + "name": "SkuReplicationMode", + "modelAsString": true + } + }, + "SqlAssessedNetworkAdapter": { + "type": "object", + "description": "SQL Assessed Network Adapter.", + "properties": { + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability." + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureNetworkAdapterSuitabilityDetail", + "description": "Gets the suitability detail." + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureNetworkAdapterSuitabilityExplanation", + "description": "Gets the suitability explanation." + }, + "monthlyBandwidthCosts": { + "type": "number", + "format": "float", + "description": "Gets the monthly bandwidth costs." + }, + "netGigabytesTransmittedPerMonth": { + "type": "number", + "format": "float", + "description": "Gets the net gigabytes transmitted per month." + }, + "name": { + "type": "string", + "description": "Gets the name." + }, + "displayName": { + "type": "string", + "description": "Gets the display name." + }, + "macAddress": { + "type": "string", + "description": "Gets the mac address." + }, + "ipAddresses": { + "type": "array", + "description": "Gets the ip addresses.", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "megabytesPerSecondReceived": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second received." + }, + "megabytesPerSecondTransmitted": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second transmitted." + } + } + }, + "SqlAssessmentMigrationIssue": { + "type": "object", + "description": "Class representing the SQL migration issues.", + "properties": { + "issueId": { + "type": "string", + "description": "Gets the issue id.", + "readOnly": true + }, + "issueCategory": { + "$ref": "#/definitions/SqlAssessmentMigrationIssueCategory", + "description": "Gets the issue category.", + "readOnly": true + }, + "impactedObjects": { + "type": "array", + "description": "Gets the list of impacted objects.", + "items": { + "$ref": "#/definitions/ImpactedAssessmentObject" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "SqlAssessmentMigrationIssueCategory": { + "type": "string", + "enum": [ + "Issue", + "Warning", + "Internal" + ], + "x-ms-enum": { + "name": "SqlAssessmentMigrationIssueCategory", + "modelAsString": true + } + }, + "SqlAssessmentOptions": { + "type": "object", + "description": "SQL Assessment options web model object.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlAssessmentOptionsProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlAssessmentOptionsListResult": { + "type": "object", + "description": "The response of a SqlAssessmentOptions list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlAssessmentOptions items on this page", + "items": { + "$ref": "#/definitions/SqlAssessmentOptions" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlAssessmentOptionsProperties": { + "type": "object", + "description": "SQL Assessment options properties Web model object.", + "properties": { + "vmFamilies": { + "type": "array", + "description": "Gets the list of VM families.", + "items": { + "$ref": "#/definitions/VmFamilyOptions" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "reservedInstanceVmFamilies": { + "type": "array", + "description": "Gets the Reserved Instance VM Families list.", + "items": { + "$ref": "#/definitions/AzureVmFamily" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "premiumDiskVmFamilies": { + "type": "array", + "description": "Gets the Premium disk VM Families list.", + "items": { + "$ref": "#/definitions/AzureVmFamily" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "savingsPlanVmFamilies": { + "type": "array", + "description": "Gets or sets the Premium disk VM Families list.", + "items": { + "$ref": "#/definitions/AzureVmFamily" + }, + "x-ms-identifiers": [] + }, + "savingsPlanSupportedLocations": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Saving Plans for IAAS.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "savingsPlanSupportedLocationsForPaas": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Saving Plans for PAAS.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedLocationsForIaas": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Reserved Instances for IAAS.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "savingsPlanSupportedOffers": { + "type": "array", + "description": "Gets or sets the list of Azure Offers supporting Saving Plans.", + "items": { + "$ref": "#/definitions/AzureOfferCode" + }, + "x-ms-identifiers": [] + }, + "sqlSkus": { + "type": "array", + "description": "Gets or sets the list of SQL target SKU properties for dropdowns.", + "items": { + "$ref": "#/definitions/SqlPaaSTargetOptions" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSqlTargets": { + "type": "array", + "description": "Gets or sets the Reserved Instance SQL target types.", + "items": { + "$ref": "#/definitions/TargetType" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedLocations": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedCurrencies": { + "type": "array", + "description": "Gets or sets the list of currencies supported for Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureCurrency" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedOffers": { + "type": "array", + "description": "Gets or sets the list of offers supported for Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureOfferCode" + }, + "x-ms-identifiers": [] + }, + "supportedOffers": { + "type": "array", + "description": "Gets or sets the list of offers supported for SQL assessments.", + "items": { + "$ref": "#/definitions/AzureOfferCode" + }, + "x-ms-identifiers": [] + } + } + }, + "SqlAssessmentV2": { + "type": "object", + "description": "SQL Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlAssessmentV2Properties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlAssessmentV2IaasSuitabilityData": { + "type": "object", + "description": "Class representing Azure SQL IAAS suitability details.", + "properties": { + "azureSqlSku": { + "$ref": "#/definitions/AzureSqlIaasSkuDTO", + "description": "Gets the azure SQL IAAS SKU.", + "readOnly": true + }, + "replicaAzureSqlSku": { + "type": "array", + "description": "Gets the replica azure SQL IAAS SKU.", + "items": { + "$ref": "#/definitions/AzureSqlIaasSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sharedResources": { + "$ref": "#/definitions/SharedResourcesDTO", + "description": "Gets the shared resources.", + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly compute cost.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly storage cost.", + "readOnly": true + }, + "costComponents": { + "type": "array", + "description": "Gets the collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "x-ms-identifiers": [] + }, + "securitySuitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability for Microsoft cloud defender.", + "readOnly": true + }, + "shouldProvisionReplicas": { + "type": "boolean", + "description": "Gets a value indicating whether replicas should be provisioned.", + "readOnly": true + }, + "skuReplicationMode": { + "$ref": "#/definitions/SkuReplicationMode", + "description": "Gets the replication mode.", + "readOnly": true + }, + "migrationGuidelines": { + "type": "array", + "description": "Gets the list of migration guidelines applicable to this target.", + "items": { + "$ref": "#/definitions/SqlMigrationGuideline" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "recommendationReasonings": { + "type": "array", + "description": "Gets the list of SQL recommendation Reasoning.", + "items": { + "$ref": "#/definitions/SqlRecommendationReasoning" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "migrationTargetPlatform": { + "$ref": "#/definitions/TargetType", + "description": "Gets the migration target platform.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the azure suitability.", + "readOnly": true + }, + "migrationIssues": { + "type": "array", + "description": "Gets the list of migrations issues.", + "items": { + "$ref": "#/definitions/SqlAssessmentMigrationIssue" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "SqlAssessmentV2ListResult": { + "type": "object", + "description": "The response of a SqlAssessmentV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlAssessmentV2 items on this page", + "items": { + "$ref": "#/definitions/SqlAssessmentV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlAssessmentV2PaasSuitabilityData": { + "type": "object", + "description": "Class representing Azure SQL PAAS suitability details.", + "properties": { + "azureSqlSku": { + "$ref": "#/definitions/AzureSqlPaasSkuDTO", + "description": "Gets the azure SQL PAAS SKU.", + "readOnly": true + }, + "replicaAzureSqlSku": { + "type": "array", + "description": "Gets the replica azure SQL PAAS SKU.", + "items": { + "$ref": "#/definitions/AzureSqlPaasSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sharedResources": { + "$ref": "#/definitions/SharedResourcesDTO", + "description": "Gets the shared resources.", + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly compute cost.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly storage cost.", + "readOnly": true + }, + "costComponents": { + "type": "array", + "description": "Gets the collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "x-ms-identifiers": [] + }, + "securitySuitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability for Microsoft cloud defender.", + "readOnly": true + }, + "shouldProvisionReplicas": { + "type": "boolean", + "description": "Gets a value indicating whether replicas should be provisioned.", + "readOnly": true + }, + "skuReplicationMode": { + "$ref": "#/definitions/SkuReplicationMode", + "description": "Gets the replication mode.", + "readOnly": true + }, + "migrationGuidelines": { + "type": "array", + "description": "Gets the list of migration guidelines applicable to this target.", + "items": { + "$ref": "#/definitions/SqlMigrationGuideline" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "recommendationReasonings": { + "type": "array", + "description": "Gets the list of SQL recommendation Reasoning.", + "items": { + "$ref": "#/definitions/SqlRecommendationReasoning" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "migrationTargetPlatform": { + "$ref": "#/definitions/TargetType", + "description": "Gets the migration target platform.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the azure suitability.", + "readOnly": true + }, + "migrationIssues": { + "type": "array", + "description": "Gets the list of migrations issues.", + "items": { + "$ref": "#/definitions/SqlAssessmentMigrationIssue" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "SqlAssessmentV2Properties": { + "type": "object", + "description": "SQL assessment properties class.", + "properties": { + "osLicense": { + "$ref": "#/definitions/OsLicense", + "description": "Gets or sets user configurable setting to display the azure hybrid use benefit." + }, + "environmentType": { + "$ref": "#/definitions/EnvironmentType", + "description": "Gets or sets user configurable setting to display the environment type." + }, + "entityUptime": { + "$ref": "#/definitions/EntityUptime", + "description": "Gets or sets the duration for which the entity (SQL, VMs) are up in the\non-premises environment." + }, + "optimizationLogic": { + "$ref": "#/definitions/OptimizationLogic", + "description": "Gets or sets SQL optimization logic." + }, + "reservedInstanceForVm": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Gets or sets azure reserved instance for VM." + }, + "azureOfferCodeForVm": { + "$ref": "#/definitions/AzureOfferCode", + "description": "Gets or sets Azure Offer Code for VM." + }, + "eaSubscriptionId": { + "type": "string", + "description": "Gets or sets the Enterprise agreement subscription id." + }, + "azureSqlManagedInstanceSettings": { + "$ref": "#/definitions/SqlMiSettings", + "description": "Gets or sets user configurable SQL managed instance settings." + }, + "azureSqlDatabaseSettings": { + "$ref": "#/definitions/SqlDbSettings", + "description": "Gets or sets user configurable SQL database settings." + }, + "azureSqlVmSettings": { + "$ref": "#/definitions/SqlVmSettings", + "description": "Gets or sets user configurable SQL VM settings." + }, + "multiSubnetIntent": { + "$ref": "#/definitions/MultiSubnetIntent", + "description": "Gets or sets user preference indicating intent of multi-subnet configuration." + }, + "asyncCommitModeIntent": { + "$ref": "#/definitions/AsyncCommitModeIntent", + "description": "Gets or sets user preference indicating intent of async commit mode." + }, + "isInternetAccessAvailable": { + "type": "boolean", + "description": "Gets or sets a value indicating whether internet access is available." + }, + "disasterRecoveryLocation": { + "$ref": "#/definitions/AzureLocation", + "description": "Gets or sets the Azure Location or Azure region where to which the machines\nwill be migrated." + }, + "enableHadrAssessment": { + "type": "boolean", + "description": "Gets or sets a value indicating whether HADR assessments needs to be created." + }, + "azureSecurityOfferingType": { + "$ref": "#/definitions/AzureSecurityOfferingType", + "description": "Gets or sets a value indicating azure security offering type." + }, + "reservedInstance": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Reserved instance." + }, + "sqlServerLicense": { + "$ref": "#/definitions/SqlServerLicense", + "description": "SQL server license." + }, + "groupType": { + "$ref": "#/definitions/GroupType", + "description": "Gets the group type for the assessment." + }, + "assessmentType": { + "$ref": "#/definitions/AssessmentType", + "description": "Assessment type of the assessment." + }, + "azureLocation": { + "type": "string", + "description": "Azure Location or Azure region where to which the machines will be migrated." + }, + "azureOfferCode": { + "$ref": "#/definitions/AzureOfferCode", + "description": "Azure Offer Code." + }, + "currency": { + "$ref": "#/definitions/AzureCurrency", + "description": "Currency in which prices should be reported." + }, + "scalingFactor": { + "type": "number", + "format": "float", + "description": "Percentage of buffer that user wants on performance metrics when recommending\nAzure sizes." + }, + "percentile": { + "$ref": "#/definitions/Percentile", + "description": "Percentile of the utilization data values to be considered while assessing\nmachines." + }, + "timeRange": { + "$ref": "#/definitions/TimeRange", + "description": "Time Range for which the historic utilization data should be considered for\nassessment." + }, + "perfDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the start time to consider performance data for assessment." + }, + "perfDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the end time to consider performance data for assessment." + }, + "stage": { + "$ref": "#/definitions/AssessmentStage", + "description": "User configurable setting to display the Stage of Assessment.", + "readOnly": true + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Custom discount percentage." + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion." + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage." + }, + "pricesTimestamp": { + "type": "string", + "format": "date-time", + "description": "Last time when rates were queried.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was last updated.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/AssessmentStatus", + "description": "Whether assessment is in valid state and all machines have been assessed.", + "readOnly": true + }, + "schemaVersion": { + "type": "string", + "description": "Schema version.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "SqlAssessmentV2Summary": { + "type": "object", + "description": "SQL Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlAssessmentV2SummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlAssessmentV2SummaryData": { + "type": "object", + "description": "SQL Assessment V2 summary data.", + "properties": { + "suitabilitySummary": { + "type": "object", + "description": "Sql assessment summary data", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Monthly compute cost", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Monthly storage cost", + "readOnly": true + }, + "monthlyLicenseCost": { + "type": "number", + "format": "float", + "description": "Monthly license cost", + "readOnly": true + }, + "confidenceScore": { + "type": "number", + "format": "float", + "description": "Confidence Rating", + "readOnly": true + }, + "monthlySecurityCost": { + "type": "number", + "format": "float", + "description": "Monthly security cost", + "readOnly": true + } + } + }, + "SqlAssessmentV2SummaryListResult": { + "type": "object", + "description": "The response of a SqlAssessmentV2Summary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlAssessmentV2Summary items on this page", + "items": { + "$ref": "#/definitions/SqlAssessmentV2Summary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlAssessmentV2SummaryProperties": { + "type": "object", + "description": "SQL Assessment V2 summary properties.", + "properties": { + "assessmentSummary": { + "type": "object", + "description": "Gets or sets the Assessment summary.", + "additionalProperties": { + "$ref": "#/definitions/SqlAssessmentV2SummaryData" + }, + "readOnly": true + }, + "distributionBySupportStatus": { + "type": "object", + "description": "Gets the distribution of sqlInstances by support status.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "distributionByServicePackInsight": { + "type": "object", + "description": "Gets the distribution distribution of sqlInstances by service pack insight.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "distributionBySqlVersion": { + "type": "object", + "description": "Gets the distribution of sqlInstances by sql version.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "distributionBySqlEdition": { + "type": "object", + "description": "Gets the distribution of sqlInstances by sql edition.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "instanceDistributionBySizingCriterion": { + "type": "object", + "description": "Gets the instance distribution by sizing criterion.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "databaseDistributionBySizingCriterion": { + "type": "object", + "description": "Gets the database distribution by sizing criterion.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Number of machines part of the assessment.", + "readOnly": true + }, + "numberOfSqlInstances": { + "type": "integer", + "format": "int32", + "description": "Number of sql instances part of the assessment.", + "readOnly": true + }, + "numberOfSuccessfullyDiscoveredSqlInstances": { + "type": "integer", + "format": "int32", + "description": "Number of successfully discovered sql instances part of the assessment.", + "readOnly": true + }, + "numberOfSqlDatabases": { + "type": "integer", + "format": "int32", + "description": "Number of sql databases part of the assessment.", + "readOnly": true + }, + "numberOfFciInstances": { + "type": "integer", + "format": "int32", + "description": "Number of sql failover cluster instances part of the assessment.", + "readOnly": true + }, + "numberOfSqlAvailabilityGroups": { + "type": "integer", + "format": "int32", + "description": "Number of sql availability groups part of the assessment.", + "readOnly": true + } + } + }, + "SqlAvailabilityGroupDataOverview": { + "type": "object", + "description": "Assessed Sql Availability Group Data Overview.", + "properties": { + "availabilityGroupId": { + "type": "string", + "description": "Gets the availability group id." + }, + "availabilityGroupName": { + "type": "string", + "description": "Gets the availability group name." + }, + "sqlAvailabilityGroupSdsArmId": { + "type": "string", + "description": "Gets the availability group arm id." + }, + "sqlAvailabilityGroupEntityId": { + "type": "string", + "description": "Gets the availability group entity id." + }, + "sqlAvailabilityReplicaId": { + "type": "string", + "description": "Gets the availability replica id." + } + } + }, + "SqlAvailabilityReplicaSummary": { + "type": "object", + "description": "Assessed Sql Availability Replica Summary.", + "properties": { + "numberOfSynchronousReadReplicas": { + "type": "integer", + "format": "int32", + "description": "Gets the number Of synchronous read replicas." + }, + "numberOfSynchronousNonReadReplicas": { + "type": "integer", + "format": "int32", + "description": "Gets the number Of synchronous non read replicas." + }, + "numberOfAsynchronousReadReplicas": { + "type": "integer", + "format": "int32", + "description": "Gets the number Of asynchronous read replicas." + }, + "numberOfAsynchronousNonReadReplicas": { + "type": "integer", + "format": "int32", + "description": "Gets the number Of asynchronous non read replicas." + }, + "numberOfPrimaryReplicas": { + "type": "integer", + "format": "int32", + "description": "Gets the number Of primary replicas." + } + } + }, + "SqlCollector": { + "type": "object", + "description": "The SQL collector REST object.", + "properties": { + "properties": { + "$ref": "#/definitions/CollectorPropertiesBaseWithAgent", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlCollectorListResult": { + "type": "object", + "description": "The response of a SqlCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlCollector items on this page", + "items": { + "$ref": "#/definitions/SqlCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlDbSettings": { + "type": "object", + "description": "SQL database assessment settings.", + "properties": { + "azureSqlServiceTier": { + "$ref": "#/definitions/AzureSqlServiceTier", + "description": "Gets or sets the azure SQL service tier." + }, + "azureSqlDataBaseType": { + "$ref": "#/definitions/AzureSqlDataBaseType", + "description": "Gets or sets the azure PAAS SQL instance type." + }, + "azureSqlComputeTier": { + "$ref": "#/definitions/ComputeTier", + "description": "Gets or sets the azure SQL compute tier." + }, + "azureSqlPurchaseModel": { + "$ref": "#/definitions/AzureSqlPurchaseModel", + "description": "Gets or sets the azure SQL purchase model." + } + } + }, + "SqlFCIMetadata": { + "type": "object", + "description": "Sql fci meta data.", + "properties": { + "state": { + "$ref": "#/definitions/SqlFCIMetadataState", + "description": "Gets the Sql fci meta data state." + }, + "isMultiSubnet": { + "type": "boolean", + "description": "Gets whether fci is multi subnet." + }, + "fciSharedDiskCount": { + "type": "integer", + "format": "int32", + "description": "Gets the fci shared disk count." + } + } + }, + "SqlFCIMetadataState": { + "type": "string", + "enum": [ + "Unknown", + "Inherited", + "Initializing", + "Online", + "Offline", + "Failed", + "Pending", + "OnlinePending", + "OfflinePending" + ], + "x-ms-enum": { + "name": "SqlFCIMetadataState", + "modelAsString": true + } + }, + "SqlFCIState": { + "type": "string", + "enum": [ + "Unknown", + "Active", + "Passive", + "NotApplicable" + ], + "x-ms-enum": { + "name": "SqlFCIState", + "modelAsString": true + } + }, + "SqlMiSettings": { + "type": "object", + "description": "SQL managed instance assessment settings.", + "properties": { + "azureSqlServiceTier": { + "$ref": "#/definitions/AzureSqlServiceTier", + "description": "Gets or sets the azure SQL service tier." + }, + "azureSqlInstanceType": { + "$ref": "#/definitions/AzureSqlInstanceType", + "description": "Gets or sets the azure PAAS SQL instance type." + } + } + }, + "SqlMigrationGuideline": { + "type": "object", + "description": "Sql Migration Guideline.", + "properties": { + "guidelineId": { + "type": "string", + "description": "Gets the guideline id." + }, + "migrationGuidelineCategory": { + "$ref": "#/definitions/SqlMigrationGuidelineCategory", + "description": "Gets the migration guideline category." + }, + "migrationGuidelineContext": { + "type": "array", + "description": "Gets the migration guideline context.", + "items": { + "$ref": "#/definitions/MigrationGuidelineContext" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "SqlMigrationGuidelineCategory": { + "type": "string", + "enum": [ + "Unknown", + "General", + "FailoverCluterInstanceGuideLine", + "AvailabilityGroupGuideline" + ], + "x-ms-enum": { + "name": "SqlMigrationGuidelineCategory", + "modelAsString": true + } + }, + "SqlPaaSTargetOptions": { + "type": "object", + "description": "SQL target options.", + "properties": { + "computeTier": { + "$ref": "#/definitions/ComputeTier", + "description": "Gets or sets the Azure SQL compute tier." + }, + "hardwareGeneration": { + "$ref": "#/definitions/HardwareGeneration", + "description": "Gets or sets the Azure SQL hardware generation." + }, + "targetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets or sets the Azure SQL target type." + }, + "serviceTier": { + "$ref": "#/definitions/AzureSqlServiceTier", + "description": "Gets or sets the Azure SQL service tier." + }, + "targetLocations": { + "type": "array", + "description": "Gets or sets the target location.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + } + } + }, + "SqlRecommendationReasoning": { + "type": "object", + "description": "Class representing Azure SQL Recommendation Reasoning.", + "properties": { + "reasoningId": { + "type": "string", + "description": "Gets the reasoning id." + }, + "reasoningString": { + "type": "string", + "description": "Gets the reasoning status." + }, + "reasoningCategory": { + "type": "string", + "description": "Gets the reasoning category." + }, + "contextParameters": { + "type": "array", + "description": "Gets the Sql recommended reasoning parameters.", + "items": { + "$ref": "#/definitions/SqlRecommendationReasoningContext" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "SqlRecommendationReasoningContext": { + "type": "object", + "description": "Class representing Azure SQL Recommendation Reasoning Context.", + "properties": { + "contextKey": { + "type": "string", + "description": "Gets the reasoning context key." + }, + "contextValue": { + "type": "string", + "description": "Gets the reasoning context value." + } + } + }, + "SqlServerLicense": { + "type": "string", + "enum": [ + "Unknown", + "Yes", + "No" + ], + "x-ms-enum": { + "name": "SqlServerLicense", + "modelAsString": true + } + }, + "SqlServerLicenseType": { + "type": "string", + "description": "Business case supported SQL Server License types.", + "enum": [ + "Unknown", + "Enterprise", + "Standard" + ], + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Sql Server License." + }, + { + "name": "Enterprise", + "value": "Enterprise", + "description": "Enterprise Sql Server License." + }, + { + "name": "Standard", + "value": "Standard", + "description": "Standard Sql Server License." + } + ] + } + }, + "SqlServerLicensingSettings": { + "type": "object", + "description": "SQL Server licensing settings.", + "properties": { + "version": { + "$ref": "#/definitions/SqlServerLicenseType", + "description": "SQL Server version." + }, + "licenseCost": { + "type": "number", + "format": "float", + "description": "Licence cost." + }, + "softwareAssuranceCost": { + "type": "number", + "format": "float", + "description": "Software assurance (SA) cost." + } + }, + "required": [ + "version", + "licenseCost", + "softwareAssuranceCost" + ] + }, + "SqlServiceTier": { + "type": "object", + "description": "The SQL service tier.", + "properties": { + "serviceTierName": { + "type": "string", + "description": "The service tier name.", + "readOnly": true + }, + "serviceTierNumber": { + "type": "number", + "format": "float", + "description": "The number of sql entities with this tier.", + "readOnly": true + } + } + }, + "SqlVersionDetails": { + "type": "object", + "description": "The SQL version details.", + "properties": { + "sqlVersion": { + "type": "string", + "description": "The SQL version.", + "readOnly": true + }, + "numberOfInstances": { + "type": "integer", + "format": "int32", + "description": "Number of instances with the above SQL version.", + "readOnly": true + } + } + }, + "SqlVmSettings": { + "type": "object", + "description": "SQL VM assessment settings.", + "properties": { + "instanceSeries": { + "type": "array", + "description": "Gets or sets the Azure VM families (calling instance series to keep it\nconsistent with other targets).", + "items": { + "$ref": "#/definitions/AzureVmFamily" + }, + "x-ms-identifiers": [] + } + } + }, + "StorageSettings": { + "type": "object", + "description": "Storage settings.", + "properties": { + "costPerGbPerMonth": { + "type": "number", + "format": "float", + "description": "Cost per gigabyte per month." + }, + "maintainanceCostPercentageToAcquisitionCost": { + "type": "number", + "format": "float", + "description": "Maintenance cost percentage.", + "minimum": 0, + "maximum": 100 + } + }, + "required": [ + "costPerGbPerMonth", + "maintainanceCostPercentageToAcquisitionCost" + ] + }, + "SuggestedMigrationTool": { + "type": "string", + "description": "Suggested Migration Tool for Azure.", + "enum": [ + "None", + "WebAppMigration", + "ServerMigration" + ], + "x-ms-enum": { + "name": "SuggestedMigrationTool", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "No Migration Tool is suggested." + }, + { + "name": "WebAppMigration", + "value": "WebAppMigration", + "description": "Web App Migration." + }, + { + "name": "ServerMigration", + "value": "ServerMigration", + "description": "Server Migration." + } + ] + } + }, + "Suitability": { + "type": "string", + "description": "Suitability for Azure.", + "enum": [ + "NotSuitable", + "Suitable" + ], + "x-ms-enum": { + "name": "Suitability", + "modelAsString": true, + "values": [ + { + "name": "NotSuitable", + "value": "NotSuitable", + "description": "Not Suitable for Azure." + }, + { + "name": "Suitable", + "value": "Suitable", + "description": "Suitable for Azure." + } + ] + } + }, + "SuitabilityResult": { + "type": "object", + "description": "Data model of Suitability Result.", + "properties": { + "readiness": { + "$ref": "#/definitions/Readiness", + "description": "Gets readiness.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/Suitability", + "description": "Gets suitability.", + "readOnly": true + }, + "failedChecks": { + "type": "array", + "description": "Gets list of failed Checks.", + "items": { + "$ref": "#/definitions/Check" + }, + "readOnly": true, + "x-ms-identifiers": [ + "name" + ] + }, + "suggestedMigrationTool": { + "$ref": "#/definitions/SuggestedMigrationTool", + "description": "Gets suggested migration tool.", + "readOnly": true + } + }, + "required": [ + "readiness", + "suitability", + "failedChecks", + "suggestedMigrationTool" + ] + }, + "SummaryDetails": { + "type": "object", + "description": "Data model of Summary Details.", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "Gets count.", + "readOnly": true + }, + "monthlyCost": { + "type": "number", + "format": "float", + "description": "Gets monthly cost.", + "readOnly": true + } + }, + "required": [ + "count", + "monthlyCost" + ] + }, + "SummaryPropertiesBase": { + "type": "object", + "description": "Base ARM model of Assessment Summary ARM properties.", + "properties": { + "assessmentName": { + "type": "string", + "description": "Gets the assessment name.", + "readOnly": true + }, + "summaryName": { + "type": "string", + "description": "Gets the summary name.", + "readOnly": true + }, + "suitabilityPerTarget": { + "type": "object", + "description": "Gets the cloud suitability summary for all entities in the assessment per target.", + "additionalProperties": { + "$ref": "#/definitions/RecordOfInt" + }, + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly compute cost.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly storage cost.", + "readOnly": true + }, + "confidenceScore": { + "type": "number", + "format": "float", + "description": "Gets the confidence score.", + "readOnly": true + } + }, + "required": [ + "assessmentName", + "summaryName", + "suitabilityPerTarget", + "monthlyComputeCost", + "monthlyStorageCost", + "confidenceScore" + ] + }, + "SupportStatusDistribution": { + "type": "object", + "description": "Support Status Distribution.", + "properties": { + "unknownSupport": { + "type": "integer", + "format": "int32", + "description": "Unknown support.", + "readOnly": true + }, + "mainStream": { + "type": "integer", + "format": "int32", + "description": "Mainstream support.", + "readOnly": true + }, + "extended": { + "type": "integer", + "format": "int32", + "description": "Extended support.", + "readOnly": true + }, + "outOfSupport": { + "type": "integer", + "format": "int32", + "description": "Out of support.", + "readOnly": true + } + } + }, + "SupportabilityStatus": { + "type": "string", + "description": "Supportability Status.", + "enum": [ + "Unknown", + "Mainstream", + "Extended", + "OutOfSupport" + ], + "x-ms-enum": { + "name": "SupportabilityStatus", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Supportability Status." + }, + { + "name": "Mainstream", + "value": "Mainstream", + "description": "Mainstream Supportability Status." + }, + { + "name": "Extended", + "value": "Extended", + "description": "Extended Supportability Status." + }, + { + "name": "OutOfSupport", + "value": "OutOfSupport", + "description": "OutOfSupport Supportability Status." + } + ] + } + }, + "TargetSpecificResult": { + "type": "object", + "description": "Target specific result.", + "properties": { + "assessmentResult": { + "$ref": "#/definitions/AssessmentResult", + "description": "Gets or sets the assessment result." + }, + "migrationIssues": { + "type": "array", + "description": "Gets or sets the web app migration issues.", + "items": { + "$ref": "#/definitions/WebAppMigrationIssues" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "assessmentResult", + "migrationIssues" + ] + }, + "TargetSpecificSummary": { + "type": "object", + "description": "Web app target specific summary data.", + "properties": { + "readinessSummary": { + "type": "object", + "description": "Web app readiness summary data", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "recommendationResultSkuDetails": { + "type": "object", + "description": "Web app recommendation sku details data", + "additionalProperties": { + "$ref": "#/definitions/WebAppSkuDetails" + }, + "readOnly": true + } + } + }, + "TargetType": { + "type": "string", + "enum": [ + "Unknown", + "Recommended", + "AzureSqlDatabase", + "AzureSqlManagedInstance", + "AzureSqlVirtualMachine", + "AzureVirtualMachine" + ], + "x-ms-enum": { + "name": "TargetType", + "modelAsString": true + } + }, + "ThirdPartyManagementSettings": { + "type": "object", + "description": "Third Party Management settings.", + "properties": { + "licenseCost": { + "type": "number", + "format": "float", + "description": "License Cost." + }, + "supportCost": { + "type": "number", + "format": "float", + "description": "Support Cost." + } + }, + "required": [ + "licenseCost", + "supportCost" + ] + }, + "TimeRange": { + "type": "string", + "description": "Time Range for Performance Data.", + "enum": [ + "Day", + "Week", + "Month", + "Custom" + ], + "x-ms-enum": { + "name": "TimeRange", + "modelAsString": true, + "values": [ + { + "name": "Day", + "value": "Day", + "description": "Daily." + }, + { + "name": "Week", + "value": "Week", + "description": "Weekly." + }, + { + "name": "Month", + "value": "Month", + "description": "Monthly." + }, + { + "name": "Custom", + "value": "Custom", + "description": "Custom Time Range." + } + ] + } + }, + "UltraDiskAssessmentOptions": { + "type": "object", + "description": "Assessment options for Ultra disk type.", + "properties": { + "familyName": { + "type": "string", + "description": "Family name." + }, + "targetLocations": { + "type": "array", + "description": "List of locations where ultra disk is supported for this VMfamily.", + "items": { + "type": "string" + } + } + } + }, + "UpdateGroupBody": { + "type": "object", + "description": "Properties of group update.", + "properties": { + "eTag": { + "type": "string", + "description": "For optimistic concurrency control." + }, + "properties": { + "$ref": "#/definitions/GroupBodyProperties", + "description": "Properties of the group." + } + } + }, + "UtilizationData": { + "type": "object", + "description": "The SQL on premises utilization insights.", + "properties": { + "numberOfActiveEntities": { + "type": "integer", + "format": "int32", + "description": "The number of active entities.", + "readOnly": true + }, + "numberOfInactiveEntities": { + "type": "integer", + "format": "int32", + "description": "The number of inactive entities.", + "readOnly": true + }, + "numberOfDecommisionEntities": { + "type": "integer", + "format": "int32", + "description": "The number of decommission entities.", + "readOnly": true + }, + "numberOfUnknownEntities": { + "type": "integer", + "format": "int32", + "description": "The number of unknown entities.", + "readOnly": true + } + } + }, + "VirtualizationSoftwareSettings": { + "type": "object", + "description": "Virtualization software settings.", + "properties": { + "numberOfPhysicalCoresPerLicense": { + "type": "integer", + "format": "int32", + "description": "Number of physical cores per licence.", + "minimum": 1 + }, + "softwareAssuranceCost": { + "type": "number", + "format": "float", + "description": "Software Assurance cost." + }, + "licenseAndSupportList": { + "type": "array", + "description": "Licence and support list.", + "items": { + "$ref": "#/definitions/VsphereLicense" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "numberOfPhysicalCoresPerLicense", + "softwareAssuranceCost", + "licenseAndSupportList" + ] + }, + "VmFamilyOptions": { + "type": "object", + "description": "VM family name, the list of targeted azure locations and the category of the\nfamily.", + "properties": { + "familyName": { + "type": "string", + "description": "Name of the VM family.", + "readOnly": true + }, + "targetLocations": { + "type": "array", + "description": "List of Azure regions.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "category": { + "type": "array", + "description": "Category of the VM family.", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "VmUptime": { + "type": "object", + "description": "Details on the total up-time for the VM.", + "properties": { + "daysPerMonth": { + "type": "integer", + "format": "int32", + "description": "Number of days in a month for VM uptime." + }, + "hoursPerDay": { + "type": "integer", + "format": "int32", + "description": "Number of hours per day for VM uptime." + } + } + }, + "VmwareCollector": { + "type": "object", + "description": "VMware collector resource.", + "properties": { + "properties": { + "$ref": "#/definitions/CollectorPropertiesBaseWithAgent", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "VmwareCollectorListResult": { + "type": "object", + "description": "The response of a VmwareCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VmwareCollector items on this page", + "items": { + "$ref": "#/definitions/VmwareCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VsphereLicense": { + "type": "object", + "description": "Representation of a vsphere licence.", + "properties": { + "licenseType": { + "$ref": "#/definitions/LicenseType", + "description": "VSphere licence type." + } + }, + "required": [ + "licenseType" + ], + "allOf": [ + { + "$ref": "#/definitions/VsphereLicenseBase" + } + ] + }, + "VsphereLicenseBase": { + "type": "object", + "description": "Representation of a vsphere licence base.", + "properties": { + "licenseCost": { + "type": "number", + "format": "float", + "description": "Cost of a licence." + }, + "basicSupportCost": { + "type": "number", + "format": "float", + "description": "Basic support cost." + }, + "productionSupportCost": { + "type": "number", + "format": "float", + "description": "Production support cost." + } + }, + "required": [ + "licenseCost", + "basicSupportCost", + "productionSupportCost" + ] + }, + "VsphereManagementLicense": { + "type": "object", + "description": "Representation of a vsphere management licence.", + "properties": { + "licenseType": { + "$ref": "#/definitions/VsphereManagementLicenseType", + "description": "VSphere licence type." + } + }, + "required": [ + "licenseType" + ], + "allOf": [ + { + "$ref": "#/definitions/VsphereLicenseBase" + } + ] + }, + "VsphereManagementLicenseType": { + "type": "string", + "description": "Business case supported Vsphere Management License types.", + "enum": [ + "Unknown", + "VSphereServerStandard" + ], + "x-ms-enum": { + "name": "VsphereManagementLicenseType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown License." + }, + { + "name": "VSphereServerStandard", + "value": "VSphereServerStandard", + "description": "VSphereServerStandard License." + } + ] + } + }, + "VsphereManagementSettings": { + "type": "object", + "description": "Vsphere management settings.", + "properties": { + "licenseAndSupportList": { + "type": "array", + "description": "Licence and support list.", + "items": { + "$ref": "#/definitions/VsphereManagementLicense" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "licenseAndSupportList" + ] + }, + "WebApp": { + "type": "object", + "description": "Data model of Web App.", + "properties": { + "discoveryArmId": { + "type": "string", + "description": "Gets discovery arm id.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Gets display name.", + "readOnly": true + }, + "webServerArmId": { + "type": "string", + "description": "Gets web server arm id.", + "readOnly": true + }, + "webServerDisplayName": { + "type": "string", + "description": "Gets web server display name.", + "readOnly": true + }, + "machineArmId": { + "type": "string", + "description": "Gets machine arm id.", + "readOnly": true + }, + "machineDisplayName": { + "type": "string", + "description": "Gets machine display name.", + "readOnly": true + }, + "webAppType": { + "$ref": "#/definitions/WebAppType", + "description": "Gets web app type.", + "readOnly": true + } + }, + "required": [ + "discoveryArmId", + "displayName", + "webServerArmId", + "webServerDisplayName", + "machineArmId", + "machineDisplayName", + "webAppType" + ] + }, + "WebAppAssessmentOptions": { + "type": "object", + "description": "Web app Assessment options web model object.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppAssessmentOptionsProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WebAppAssessmentOptionsListResult": { + "type": "object", + "description": "The response of a WebAppAssessmentOptions list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppAssessmentOptions items on this page", + "items": { + "$ref": "#/definitions/WebAppAssessmentOptions" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppAssessmentOptionsProperties": { + "type": "object", + "description": "Web app Assessment options properties Web model object.", + "properties": { + "webAppSkus": { + "type": "array", + "description": "Gets the list of web app target options.", + "items": { + "$ref": "#/definitions/WebAppTargetOptions" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "savingsPlanSupportedLocations": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Saving Plans for IAAS.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedLocations": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedCurrencies": { + "type": "array", + "description": "Gets or sets the list of currencies supported for Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureCurrency" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedOffers": { + "type": "array", + "description": "Gets or sets the list of offers supported for Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureOfferCode" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedWebAppTiers": { + "type": "array", + "description": "Gets or sets the list of currencies supported for Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureWebAppTier" + }, + "x-ms-identifiers": [] + }, + "savingsPlanSupportedWebAppTiers": { + "type": "array", + "description": "Gets or sets the list of Azure Offers supporting Saving Plans.", + "items": { + "$ref": "#/definitions/AzureWebAppTier" + }, + "x-ms-identifiers": [] + } + } + }, + "WebAppAssessmentV2": { + "type": "object", + "description": "Web app Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppAssessmentV2Properties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WebAppAssessmentV2ListResult": { + "type": "object", + "description": "The response of a WebAppAssessmentV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppAssessmentV2 items on this page", + "items": { + "$ref": "#/definitions/WebAppAssessmentV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppAssessmentV2Properties": { + "type": "object", + "description": "Web app assessment properties class.", + "properties": { + "environmentType": { + "$ref": "#/definitions/EnvironmentType", + "description": "Gets or sets user configurable setting to display the environment type." + }, + "entityUptime": { + "$ref": "#/definitions/EntityUptime", + "description": "Gets or sets the duration for which the entity (Web app, VMs) are up in the\non-premises environment." + }, + "eaSubscriptionId": { + "type": "string", + "description": "Gets or sets the Enterprise agreement subscription id." + }, + "appSvcNativeSettings": { + "$ref": "#/definitions/AppSvcNativeSettings", + "description": "Gets or sets user configurable app service native settings." + }, + "appSvcContainerSettings": { + "$ref": "#/definitions/AppSvcContainerSettings", + "description": "Gets or sets user configurable app service container database settings." + }, + "discoveredEntityLightSummary": { + "$ref": "#/definitions/DiscoveredEntityLightSummary", + "description": "Gets or sets user configurable discovered entity settings." + }, + "azureSecurityOfferingType": { + "$ref": "#/definitions/AzureSecurityOfferingType", + "description": "Gets or sets a value indicating azure security offering type." + }, + "reservedInstance": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Reserved instance." + }, + "groupType": { + "$ref": "#/definitions/GroupType", + "description": "Gets the group type for the assessment." + }, + "assessmentType": { + "$ref": "#/definitions/AssessmentType", + "description": "Assessment type of the assessment." + }, + "azureLocation": { + "type": "string", + "description": "Azure Location or Azure region where to which the machines will be migrated." + }, + "azureOfferCode": { + "$ref": "#/definitions/AzureOfferCode", + "description": "Azure Offer Code." + }, + "currency": { + "$ref": "#/definitions/AzureCurrency", + "description": "Currency in which prices should be reported." + }, + "scalingFactor": { + "type": "number", + "format": "float", + "description": "Percentage of buffer that user wants on performance metrics when recommending\nAzure sizes." + }, + "percentile": { + "$ref": "#/definitions/Percentile", + "description": "Percentile of the utilization data values to be considered while assessing\nmachines." + }, + "timeRange": { + "$ref": "#/definitions/TimeRange", + "description": "Time Range for which the historic utilization data should be considered for\nassessment." + }, + "perfDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the start time to consider performance data for assessment." + }, + "perfDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the end time to consider performance data for assessment." + }, + "stage": { + "$ref": "#/definitions/AssessmentStage", + "description": "User configurable setting to display the Stage of Assessment.", + "readOnly": true + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Custom discount percentage." + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion." + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage." + }, + "pricesTimestamp": { + "type": "string", + "format": "date-time", + "description": "Last time when rates were queried.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was last updated.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/AssessmentStatus", + "description": "Whether assessment is in valid state and all machines have been assessed.", + "readOnly": true + }, + "schemaVersion": { + "type": "string", + "description": "Schema version.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties2" + } + ] + }, + "WebAppAssessmentV2Summary": { + "type": "object", + "description": "Web app Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppAssessmentV2SummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WebAppAssessmentV2SummaryListResult": { + "type": "object", + "description": "The response of a WebAppAssessmentV2Summary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppAssessmentV2Summary items on this page", + "items": { + "$ref": "#/definitions/WebAppAssessmentV2Summary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppAssessmentV2SummaryProperties": { + "type": "object", + "description": "Web app Assessment V2 summary properties.", + "properties": { + "assessmentSummary": { + "type": "object", + "description": "Gets or sets the discovered entities summary.", + "additionalProperties": { + "$ref": "#/definitions/DiscoveredEntitiesSummary" + }, + "readOnly": true + }, + "targetSpecificSummary": { + "type": "object", + "description": "Gets the target specific summary.", + "additionalProperties": { + "$ref": "#/definitions/TargetSpecificSummary" + }, + "readOnly": true + } + } + }, + "WebAppCollector": { + "type": "object", + "description": "The web app collector REST object.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppCollectorPropertiesBaseWithAgent", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WebAppCollectorListResult": { + "type": "object", + "description": "The response of a WebAppCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppCollector items on this page", + "items": { + "$ref": "#/definitions/WebAppCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppCollectorPropertiesBaseWithAgent": { + "type": "object", + "description": "Collector properties class.", + "properties": { + "agentProperties": { + "$ref": "#/definitions/CollectorAgentPropertiesBase", + "description": "Gets or sets the collector agent properties." + }, + "discoverySiteId": { + "type": "string", + "description": "Gets the discovery site id." + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets the Timestamp when collector was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Timestamp when collector was last updated.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties2" + } + ] + }, + "WebAppDistribution": { + "type": "object", + "description": "The app type distribution.", + "properties": { + "webAppType": { + "$ref": "#/definitions/WebAppTypes", + "description": "WebApp type.", + "readOnly": true + }, + "numberOfWebApps": { + "type": "number", + "format": "float", + "description": "The cost details.", + "readOnly": true + } + } + }, + "WebAppMigrationIssues": { + "type": "object", + "description": "Web app migration issues.", + "properties": { + "issueId": { + "type": "string", + "description": "Gets or sets the issue Id." + }, + "issueCategory": { + "$ref": "#/definitions/AzureWebAppSuitabilityIssueCategory", + "description": "Gets or sets the issue category." + }, + "issueDescriptionList": { + "type": "array", + "description": "Gets or sets the issue description list.", + "items": { + "type": "string" + } + } + }, + "required": [ + "issueId", + "issueCategory", + "issueDescriptionList" + ] + }, + "WebAppServicePlanV2": { + "type": "object", + "description": "Assessed Web app web model class.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppServicePlanV2Properties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WebAppServicePlanV2ListResult": { + "type": "object", + "description": "The response of a WebAppServicePlanV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppServicePlanV2 items on this page", + "items": { + "$ref": "#/definitions/WebAppServicePlanV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppServicePlanV2Properties": { + "type": "object", + "description": "Assessed Web app database properties web model.", + "properties": { + "webAppType": { + "$ref": "#/definitions/WebAppType", + "description": "Gets or sets the web app type.", + "readOnly": true + }, + "webAppTargetType": { + "$ref": "#/definitions/AzureWebAppTargetType", + "description": "Gets or sets the target specific result.", + "readOnly": true + }, + "webAppServicePlanName": { + "type": "string", + "description": "Gets or sets the app service plan name.", + "readOnly": true + }, + "numberOfWebApps": { + "type": "integer", + "format": "int32", + "description": "Gets the machine name.", + "readOnly": true + }, + "monthlyCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the server ARM Id.", + "readOnly": true + }, + "storage": { + "type": "number", + "format": "double", + "description": "Gets or sets the web server name.", + "readOnly": true + }, + "scaleOutInstances": { + "type": "integer", + "format": "int32", + "description": "Gets or sets web app name.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "Gets the discovered web app ID.", + "readOnly": true + }, + "ram": { + "type": "number", + "format": "double", + "description": "Machine arm id.", + "readOnly": true + }, + "webAppSkuName": { + "type": "string", + "description": "Web app sku name.", + "readOnly": true + }, + "webAppSkuSize": { + "type": "string", + "description": "Web app sku size.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL database first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed Web app database last updated.", + "readOnly": true + }, + "costComponents": { + "type": "array", + "description": "Cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + }, + "required": [ + "webAppServicePlanName", + "numberOfWebApps" + ] + }, + "WebAppSkuDetails": { + "type": "object", + "description": "Web app sku details.", + "properties": { + "totalMonthlyCost": { + "type": "number", + "format": "float", + "description": "Total monthly cost", + "readOnly": true + }, + "monthlySecurityCost": { + "type": "number", + "format": "float", + "description": "Monthly security data", + "readOnly": true + }, + "skuName": { + "type": "string", + "description": "Sku name", + "readOnly": true + }, + "skuSize": { + "type": "string", + "description": "Sku size", + "readOnly": true + }, + "appServicePlanCount": { + "type": "integer", + "format": "int32", + "description": "App service plan count", + "readOnly": true + } + }, + "required": [ + "skuName", + "skuSize", + "appServicePlanCount" + ] + }, + "WebAppTargetOptions": { + "type": "object", + "description": "Web app target options.", + "properties": { + "webAppTier": { + "$ref": "#/definitions/AzureWebAppTier", + "description": "Gets or sets the Azure web app tier." + }, + "targetLocations": { + "type": "array", + "description": "Gets or sets the target location.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + } + } + }, + "WebAppTargetSku": { + "type": "object", + "description": "The Webapp target SKU with corresponding cost.", + "properties": { + "skuName": { + "type": "string", + "description": "The SKU name.", + "readOnly": true + }, + "cost": { + "type": "number", + "format": "float", + "description": "The cost details.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The number of service plans or node pools recommended.", + "readOnly": true + } + } + }, + "WebAppType": { + "type": "string", + "description": "Web App Type.", + "enum": [ + "Unknown", + "IIS", + "Tomcat" + ], + "x-ms-enum": { + "name": "WebAppType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown. Indicates Missing Data." + }, + { + "name": "IIS", + "value": "IIS", + "description": "ASP.NET Web App." + }, + { + "name": "Tomcat", + "value": "Tomcat", + "description": "Java Web App." + } + ] + } + }, + "WebAppTypes": { + "type": "string", + "description": "Business case supported WebApp types.", + "enum": [ + "Unknown", + "ASPNET", + "Java" + ], + "x-ms-enum": { + "name": "WebAppTypes", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown WebApp Type." + }, + { + "name": "ASPNET", + "value": "ASPNET", + "description": "ASPNET Type." + }, + { + "name": "Java", + "value": "Java", + "description": "Java Tomcat Type." + } + ] + } + }, + "WindowsServerLicensingSettings": { + "type": "object", + "description": "Windows Server licensing settings.", + "properties": { + "licenseCost": { + "type": "number", + "format": "float", + "description": "Licence Cost." + }, + "softwareAssuranceCost": { + "type": "number", + "format": "float", + "description": "Software assurance (SA) cost." + }, + "licensesPerCore": { + "type": "integer", + "format": "int32", + "description": "Licenses per core." + } + }, + "required": [ + "licenseCost", + "softwareAssuranceCost", + "licensesPerCore" + ] + }, + "LinuxServerLicensingSettings": { + "type": "object", + "description": "Linux Server licensing settings.", + "properties": { + "licenseCost": { + "type": "number", + "format": "float", + "description": "Licence Cost." + } + }, + "required": [ + "licenseCost" + ] + }, + "WorkloadSummary": { + "type": "object", + "description": "Workload summary.", + "properties": { + "oracleInstances": { + "type": "integer", + "format": "int32", + "description": "Gets or sets oracle databases." + }, + "springApps": { + "type": "integer", + "format": "int32", + "description": "Gets or sets oracle databases." + } + } + }, + "YearOnYearEstimates": { + "type": "object", + "description": "Shows the year-on-year cost overall.", + "properties": { + "onPremisesCost": { + "type": "object", + "description": "Year-on-Year on-premises cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "azureCost": { + "type": "object", + "description": "Year-on-Year Azure cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "savings": { + "type": "object", + "description": "Year-on-Year savings.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "onPremisesCapexCost": { + "type": "object", + "description": "Year-on-Year on-premises capex cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "onPremisesOpexCost": { + "type": "object", + "description": "Year-on-Year on-premises opex cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "azureCapexCost": { + "type": "object", + "description": "Year-on-Year azure capex cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "azureOpexCost": { + "type": "object", + "description": "Year-on-Year azure opex cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "paybackPeriod": { + "type": "integer", + "format": "int32", + "description": "Payback period.", + "readOnly": true + } + } + } + }, + "parameters": {} +} diff --git a/specification/migrate/resource-manager/readme.md b/specification/migrate/resource-manager/readme.md index c0c31959e15f..54876c5524c4 100644 --- a/specification/migrate/resource-manager/readme.md +++ b/specification/migrate/resource-manager/readme.md @@ -20,6 +20,22 @@ batch: - tag: package-migrateengine-2022-05 ``` +### Tag: package-preview-2023-05 + +These settings apply only when `--tag=package-preview-2023-05` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-05' +input-file: + - Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/migrate.json +suppressions: + - code: AvoidAdditionalProperties + reason: Migrate feature is widely adopted and requires additionalProperties for these swagger properties. + - code: ProvisioningStateMustBeReadOnly + reason: The current swagger version only modifies the resources which do not have Provisioning states as readOnly and not introducing any new Resources, These are incorrectly flagged for previous versions. + - code: UnSupportedPatchProperties + reason: There is no patch operation that is introduced in this swagger version where it is not readOnly. This is incorrectly flagged for previous versions. +``` + ### Tag: package-migrate-2023-04 These settings apply only when `--tag=package-migrate-2023-04` is specified on the command line. @@ -40,6 +56,7 @@ These settings apply only when `--tag=package-preview-2023-10` is specified on t input-file: - Microsoft.OffAzure/preview/2023-10-01-preview/migrate.json ``` + ### Tag: package-2023-06 These settings apply only when `--tag=package-2023-06` is specified on the command line. @@ -202,6 +219,21 @@ These settings apply only when `--tag=package-preview-2023-10` is specified on t input-file: - Microsoft.OffAzure/preview/2023-10-01-preview/migrate.json ``` +### Tag: package-preview-2023-05 + +These settings apply only when `--tag=package-preview-2023-05` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-05' +input-file: + - Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/migrate.json +suppressions: + - code: AvoidAdditionalProperties + reason: Migrate feature is widely adopted and requires additionalProperties for these swagger properties. + - code: ProvisioningStateMustBeReadOnly + reason: The current swagger version only modifies the resources which do not have Provisioning states as readOnly and not introducing any new Resources, These are incorrectly flagged for previous versions. + - code: UnSupportedPatchProperties + reason: There is no patch operation that is introduced in this swagger version where it is not readOnly. This is incorrectly flagged for previous versions. +``` ### Tag: package-migrate-2023-03 diff --git a/specification/migrate/resource-manager/suppressions.yaml b/specification/migrate/resource-manager/suppressions.yaml new file mode 100644 index 000000000000..b421d614e1d1 --- /dev/null +++ b/specification/migrate/resource-manager/suppressions.yaml @@ -0,0 +1,7 @@ +- tool: TypeSpecRequirement + path: Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/**/*.json + reason: Preview version, TypeScript will be added soon + +- tool: TagsAreNotAllowedForProxyResources + path: Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/**/*.json + reason: Adding this supression as this is a false positive alert \ No newline at end of file From 39d220aa7857182b760c33a30bf256d0bf8934e1 Mon Sep 17 00:00:00 2001 From: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Date: Fri, 27 Sep 2024 14:37:42 +0800 Subject: [PATCH 05/47] remove examples-dir from python tspconfig (#30768) --- specification/ai/DocumentIntelligence/tspconfig.yaml | 1 - specification/ai/Face/tspconfig.yaml | 1 - .../HealthInsights.RadiologyInsights/tspconfig.yaml | 1 - specification/ai/ImageAnalysis/tspconfig.yaml | 1 - specification/apicenter/ApiCenter.DataApi/tspconfig.yaml | 1 - specification/appconfiguration/AppConfiguration/tspconfig.yaml | 1 - .../ApplicationInsights.LiveMetrics/tspconfig.yaml | 1 - specification/azurefleet/AzureFleet.Management/tspconfig.yaml | 1 - specification/batch/Azure.Batch/tspconfig.yaml | 1 - specification/cognitiveservices/ContentSafety/tspconfig.yaml | 1 - .../communication/Communication.JobRouter/tspconfig.yaml | 1 - .../communication/Communication.Messages/tspconfig.yaml | 1 - .../computeschedule/ComputeSchedule.Management/tspconfig.yaml | 1 - .../confidentialledger/Microsoft.CodeTransparency/tspconfig.yaml | 1 - .../contosowidgetmanager/Contoso.Management/tspconfig.yaml | 1 - .../contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml | 1 - specification/devcenter/DevCenter/tspconfig.yaml | 1 - .../Microsoft.DevOpsInfrastructure.Management/tspconfig.yaml | 1 - specification/edgezones/EdgeZones.Management/tspconfig.yaml | 1 - .../Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml | 1 - specification/eventgrid/Azure.Messaging.EventGrid/tspconfig.yaml | 1 - specification/fabric/Microsoft.Fabric.Management/tspconfig.yaml | 1 - .../HealthDataAIServices.DeidServices/tspconfig.yaml | 1 - .../HealthDataAIServices.Management/tspconfig.yaml | 1 - .../iotoperations/IoTOperations.Management/tspconfig.yaml | 1 - .../KubernetesRuntime.Management/tspconfig.yaml | 1 - specification/loadtestservice/LoadTestService/tspconfig.yaml | 1 - .../machinelearning/Azure.AI.ChatProtocol/tspconfig.yaml | 1 - .../machinelearningservices/AzureAI.Assets/tspconfig.yaml | 1 - .../DocumentDB.MongoCluster.Management/tspconfig.yaml | 1 - .../Azure.ProgrammableConnectivity/tspconfig.yaml | 1 - .../purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml | 1 - specification/schemaregistry/SchemaRegistry/tspconfig.yaml | 1 - specification/standbypool/StandbyPool.Management/tspconfig.yaml | 1 - .../translation/Azure.AI.DocumentTranslation/tspconfig.yaml | 1 - .../translation/Azure.AI.TextTranslation/tspconfig.yaml | 1 - specification/trustedsigning/TrustedSigning/tspconfig.yaml | 1 - 37 files changed, 37 deletions(-) diff --git a/specification/ai/DocumentIntelligence/tspconfig.yaml b/specification/ai/DocumentIntelligence/tspconfig.yaml index 42384ac0413f..35640ce9b98c 100644 --- a/specification/ai/DocumentIntelligence/tspconfig.yaml +++ b/specification/ai/DocumentIntelligence/tspconfig.yaml @@ -25,7 +25,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": package-dir: "azure-ai-documentintelligence" namespace: "com.azure.ai.documentintelligence" diff --git a/specification/ai/Face/tspconfig.yaml b/specification/ai/Face/tspconfig.yaml index 69333ed57336..5096759efa37 100644 --- a/specification/ai/Face/tspconfig.yaml +++ b/specification/ai/Face/tspconfig.yaml @@ -21,7 +21,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": package-dir: "Azure.AI.Vision.Face" namespace: "{package-dir}" diff --git a/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/tspconfig.yaml b/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/tspconfig.yaml index 8c105bfcd188..ef2b0ce1efdd 100644 --- a/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/tspconfig.yaml +++ b/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/tspconfig.yaml @@ -34,7 +34,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": package-dir: "azure-health-insights-radiologyinsights" namespace: com.azure.health.insights.radiologyinsights diff --git a/specification/ai/ImageAnalysis/tspconfig.yaml b/specification/ai/ImageAnalysis/tspconfig.yaml index 968e244f118a..ec72fc3eb5af 100644 --- a/specification/ai/ImageAnalysis/tspconfig.yaml +++ b/specification/ai/ImageAnalysis/tspconfig.yaml @@ -19,7 +19,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": package-dir: "Azure.AI.Vision.ImageAnalysis" namespace: "Azure.AI.Vision.ImageAnalysis" diff --git a/specification/apicenter/ApiCenter.DataApi/tspconfig.yaml b/specification/apicenter/ApiCenter.DataApi/tspconfig.yaml index ed4d3f2e24f2..be755eb76687 100644 --- a/specification/apicenter/ApiCenter.DataApi/tspconfig.yaml +++ b/specification/apicenter/ApiCenter.DataApi/tspconfig.yaml @@ -19,7 +19,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": package-dir: "azure.ApiCenter" namespace: "{package-dir}" diff --git a/specification/appconfiguration/AppConfiguration/tspconfig.yaml b/specification/appconfiguration/AppConfiguration/tspconfig.yaml index 5d2c31b98df7..984363d3eec1 100644 --- a/specification/appconfiguration/AppConfiguration/tspconfig.yaml +++ b/specification/appconfiguration/AppConfiguration/tspconfig.yaml @@ -19,7 +19,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": package-dir: "Azure.Data.AppConfiguration" namespace: "{package-dir}" diff --git a/specification/applicationinsights/ApplicationInsights.LiveMetrics/tspconfig.yaml b/specification/applicationinsights/ApplicationInsights.LiveMetrics/tspconfig.yaml index 1cf18afadc77..0c70abc1f25b 100644 --- a/specification/applicationinsights/ApplicationInsights.LiveMetrics/tspconfig.yaml +++ b/specification/applicationinsights/ApplicationInsights.LiveMetrics/tspconfig.yaml @@ -20,7 +20,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": package-dir: "LiveMetrics" namespace: "{package-dir}" diff --git a/specification/azurefleet/AzureFleet.Management/tspconfig.yaml b/specification/azurefleet/AzureFleet.Management/tspconfig.yaml index 860e37107159..f75c6fb91687 100644 --- a/specification/azurefleet/AzureFleet.Management/tspconfig.yaml +++ b/specification/azurefleet/AzureFleet.Management/tspconfig.yaml @@ -30,7 +30,6 @@ options: package-name: "{package-dir}" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" flavor: "azure" "@azure-tools/typespec-java": package-dir: "azure-resourcemanager-computefleet" diff --git a/specification/batch/Azure.Batch/tspconfig.yaml b/specification/batch/Azure.Batch/tspconfig.yaml index 024a4b79b0dc..1c66dcb9fc9e 100644 --- a/specification/batch/Azure.Batch/tspconfig.yaml +++ b/specification/batch/Azure.Batch/tspconfig.yaml @@ -31,7 +31,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-ts": package-dir: "batch-rest" packageDetails: diff --git a/specification/cognitiveservices/ContentSafety/tspconfig.yaml b/specification/cognitiveservices/ContentSafety/tspconfig.yaml index 565abdc7cc74..e1b159922293 100644 --- a/specification/cognitiveservices/ContentSafety/tspconfig.yaml +++ b/specification/cognitiveservices/ContentSafety/tspconfig.yaml @@ -21,7 +21,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": package-dir: "Azure.AI.ContentSafety" namespace: "{package-dir}" diff --git a/specification/communication/Communication.JobRouter/tspconfig.yaml b/specification/communication/Communication.JobRouter/tspconfig.yaml index 5bbf6cf62172..eaac1149894e 100644 --- a/specification/communication/Communication.JobRouter/tspconfig.yaml +++ b/specification/communication/Communication.JobRouter/tspconfig.yaml @@ -43,7 +43,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": emitter-output-dir: "{java-sdk-folder}/sdk/{service-directory-name}/azure-communication-jobrouter" package-dir: "azure-communication-jobrouter" diff --git a/specification/communication/Communication.Messages/tspconfig.yaml b/specification/communication/Communication.Messages/tspconfig.yaml index efa014db6fba..d6f5bcff1caf 100644 --- a/specification/communication/Communication.Messages/tspconfig.yaml +++ b/specification/communication/Communication.Messages/tspconfig.yaml @@ -44,7 +44,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": package-dir: "azure-communication-messages" namespace: com.azure.communication.messages diff --git a/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml b/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml index c73e44824afb..0c5a91d3e011 100644 --- a/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml +++ b/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml @@ -14,7 +14,6 @@ options: flavor: "azure" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": package-dir: "Azure.ResourceManager.ComputeSchedule" flavor: azure diff --git a/specification/confidentialledger/Microsoft.CodeTransparency/tspconfig.yaml b/specification/confidentialledger/Microsoft.CodeTransparency/tspconfig.yaml index 3f7eb764893a..4b9dc7e146de 100644 --- a/specification/confidentialledger/Microsoft.CodeTransparency/tspconfig.yaml +++ b/specification/confidentialledger/Microsoft.CodeTransparency/tspconfig.yaml @@ -20,7 +20,6 @@ options: models-mode: none generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": flavor: azure package-dir: "Azure.Security.CodeTransparency" diff --git a/specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml b/specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml index d952a53f56e2..23b54895ca02 100644 --- a/specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml +++ b/specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml @@ -21,7 +21,6 @@ options: package-name: "{package-dir}" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" flavor: "azure" "@azure-tools/typespec-java": package-dir: "azure-resourcemanager-contoso" diff --git a/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml b/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml index 93dd9d6f2085..2633b3a76f34 100644 --- a/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml +++ b/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml @@ -21,7 +21,6 @@ options: package-name: "{package-dir}" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" flavor: azure "@azure-tools/typespec-csharp": package-dir: "Azure.Template.Contoso" diff --git a/specification/devcenter/DevCenter/tspconfig.yaml b/specification/devcenter/DevCenter/tspconfig.yaml index 476f295d6a7a..49e16784c6ee 100644 --- a/specification/devcenter/DevCenter/tspconfig.yaml +++ b/specification/devcenter/DevCenter/tspconfig.yaml @@ -26,7 +26,6 @@ options: api-version: "2023-04-01" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-ts": title: "Azure Developer DevCenter" package-dir: "developer-devcenter-rest" diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/tspconfig.yaml b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/tspconfig.yaml index a6de4688fc7d..6418c4fbe07c 100644 --- a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/tspconfig.yaml +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/tspconfig.yaml @@ -23,7 +23,6 @@ options: flavor: "azure" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": package-dir: "azure-resourcemanager-devopsinfrastructure" flavor: "azure" diff --git a/specification/edgezones/EdgeZones.Management/tspconfig.yaml b/specification/edgezones/EdgeZones.Management/tspconfig.yaml index 87cf3b8931b1..59af0f9180d3 100644 --- a/specification/edgezones/EdgeZones.Management/tspconfig.yaml +++ b/specification/edgezones/EdgeZones.Management/tspconfig.yaml @@ -20,7 +20,6 @@ options: package-name: "{package-dir}" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" flavor: "azure" "@azure-tools/typespec-java": package-dir: "azure-resourcemanager-edgezones" diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml index 970d52f81e55..89e62a45f20a 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml @@ -24,7 +24,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" # Uncomment this line and add "@azure-tools/typespec-csharp" to your package.json to generate C# code "@azure-tools/typespec-csharp": package-dir: Azure.Messaging.EventGrid.SystemEvents diff --git a/specification/eventgrid/Azure.Messaging.EventGrid/tspconfig.yaml b/specification/eventgrid/Azure.Messaging.EventGrid/tspconfig.yaml index 8477281bc07d..62693d4eb767 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid/tspconfig.yaml +++ b/specification/eventgrid/Azure.Messaging.EventGrid/tspconfig.yaml @@ -24,7 +24,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" # Uncomment this line and add "@azure-tools/typespec-csharp" to your package.json to generate C# code "@azure-tools/typespec-csharp": package-dir: Azure.Messaging.EventGridV2 diff --git a/specification/fabric/Microsoft.Fabric.Management/tspconfig.yaml b/specification/fabric/Microsoft.Fabric.Management/tspconfig.yaml index f9653224cf9d..6d8ba54dd4eb 100644 --- a/specification/fabric/Microsoft.Fabric.Management/tspconfig.yaml +++ b/specification/fabric/Microsoft.Fabric.Management/tspconfig.yaml @@ -23,7 +23,6 @@ options: package-name: "{package-dir}" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-ts": azureSdkForJs: true isModularLibrary: true diff --git a/specification/healthdataaiservices/HealthDataAIServices.DeidServices/tspconfig.yaml b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/tspconfig.yaml index 2890f991aec3..d9da9d92e438 100644 --- a/specification/healthdataaiservices/HealthDataAIServices.DeidServices/tspconfig.yaml +++ b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/tspconfig.yaml @@ -19,7 +19,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": package-dir: "Azure.Health.Deidentification" namespace: "{package-dir}" diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/tspconfig.yaml b/specification/healthdataaiservices/HealthDataAIServices.Management/tspconfig.yaml index f45ad94de92c..b007e798dedd 100644 --- a/specification/healthdataaiservices/HealthDataAIServices.Management/tspconfig.yaml +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/tspconfig.yaml @@ -21,7 +21,6 @@ options: package-name: "{package-dir}" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": package-dir: "azure-resourcemanager-healthdataaiservices" flavor: "azure" diff --git a/specification/iotoperations/IoTOperations.Management/tspconfig.yaml b/specification/iotoperations/IoTOperations.Management/tspconfig.yaml index 708bdfee191a..d28a739a8e06 100644 --- a/specification/iotoperations/IoTOperations.Management/tspconfig.yaml +++ b/specification/iotoperations/IoTOperations.Management/tspconfig.yaml @@ -15,7 +15,6 @@ options: flavor: "azure" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" linter: extends: - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/kubernetesruntime/KubernetesRuntime.Management/tspconfig.yaml b/specification/kubernetesruntime/KubernetesRuntime.Management/tspconfig.yaml index bdfdb8ce28c5..8f4556678620 100644 --- a/specification/kubernetesruntime/KubernetesRuntime.Management/tspconfig.yaml +++ b/specification/kubernetesruntime/KubernetesRuntime.Management/tspconfig.yaml @@ -20,7 +20,6 @@ options: flavor: "azure" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" linter: extends: diff --git a/specification/loadtestservice/LoadTestService/tspconfig.yaml b/specification/loadtestservice/LoadTestService/tspconfig.yaml index 9c621ebbaced..bc6f069f006f 100644 --- a/specification/loadtestservice/LoadTestService/tspconfig.yaml +++ b/specification/loadtestservice/LoadTestService/tspconfig.yaml @@ -28,7 +28,6 @@ options: package-name: "{package-dir}" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" # emitter-output-dir: "{python-sdk-folder}/sdk/{service-directory-name}/{package-name}" package-mode: azure-dataplane flavor: azure diff --git a/specification/machinelearning/Azure.AI.ChatProtocol/tspconfig.yaml b/specification/machinelearning/Azure.AI.ChatProtocol/tspconfig.yaml index 04f2db45305a..af95819fba18 100644 --- a/specification/machinelearning/Azure.AI.ChatProtocol/tspconfig.yaml +++ b/specification/machinelearning/Azure.AI.ChatProtocol/tspconfig.yaml @@ -27,7 +27,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-ts": package-dir: "ai-chat-protocol" isModularLibrary: true diff --git a/specification/machinelearningservices/AzureAI.Assets/tspconfig.yaml b/specification/machinelearningservices/AzureAI.Assets/tspconfig.yaml index 64ee3f8728e1..eba014716a1c 100644 --- a/specification/machinelearningservices/AzureAI.Assets/tspconfig.yaml +++ b/specification/machinelearningservices/AzureAI.Assets/tspconfig.yaml @@ -16,7 +16,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" linter: extends: - "@azure-tools/typespec-azure-rulesets/data-plane" diff --git a/specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml b/specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml index 963bdd54531f..db2c9f14c801 100644 --- a/specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml +++ b/specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml @@ -15,7 +15,6 @@ options: flavor: "azure" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": package-dir: "azure-resourcemanager-mongocluster" flavor: "azure" diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/tspconfig.yaml b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/tspconfig.yaml index fe41d662bb95..e56bf1a91ef3 100644 --- a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/tspconfig.yaml +++ b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/tspconfig.yaml @@ -25,7 +25,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" linter: extends: - "@azure-tools/typespec-azure-rulesets/data-plane" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml b/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml index 3742712d1b88..db2051ab2039 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml +++ b/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml @@ -20,7 +20,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": package-dir: "Azure.Analytics.Purview.DataMap" namespace: "{package-dir}" diff --git a/specification/schemaregistry/SchemaRegistry/tspconfig.yaml b/specification/schemaregistry/SchemaRegistry/tspconfig.yaml index 4ecd71e8a0ba..666346bbfdcc 100644 --- a/specification/schemaregistry/SchemaRegistry/tspconfig.yaml +++ b/specification/schemaregistry/SchemaRegistry/tspconfig.yaml @@ -23,7 +23,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": package-dir: "azure-data-schemaregistry" namespace: com.azure.data.schemaregistry diff --git a/specification/standbypool/StandbyPool.Management/tspconfig.yaml b/specification/standbypool/StandbyPool.Management/tspconfig.yaml index 09ee2ea103a3..42e761955bfb 100644 --- a/specification/standbypool/StandbyPool.Management/tspconfig.yaml +++ b/specification/standbypool/StandbyPool.Management/tspconfig.yaml @@ -46,7 +46,6 @@ options: flavor: "azure" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-go": service-dir: "sdk/resourcemanager/standbypool" package-dir: "armstandbypool" diff --git a/specification/translation/Azure.AI.DocumentTranslation/tspconfig.yaml b/specification/translation/Azure.AI.DocumentTranslation/tspconfig.yaml index 5c2fcb0cef11..fbe351d6711b 100644 --- a/specification/translation/Azure.AI.DocumentTranslation/tspconfig.yaml +++ b/specification/translation/Azure.AI.DocumentTranslation/tspconfig.yaml @@ -31,7 +31,6 @@ options: generate-sample-project: false generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": package-dir: "azure-ai-translation-document" namespace: com.azure.ai.translation.document diff --git a/specification/translation/Azure.AI.TextTranslation/tspconfig.yaml b/specification/translation/Azure.AI.TextTranslation/tspconfig.yaml index 8967858b9ba9..e1112abc09d8 100644 --- a/specification/translation/Azure.AI.TextTranslation/tspconfig.yaml +++ b/specification/translation/Azure.AI.TextTranslation/tspconfig.yaml @@ -29,7 +29,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": package-dir: "azure-ai-translation-text" namespace: com.azure.ai.translation.text diff --git a/specification/trustedsigning/TrustedSigning/tspconfig.yaml b/specification/trustedsigning/TrustedSigning/tspconfig.yaml index 25463f0e28f1..9445b6b1401c 100644 --- a/specification/trustedsigning/TrustedSigning/tspconfig.yaml +++ b/specification/trustedsigning/TrustedSigning/tspconfig.yaml @@ -19,7 +19,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": clear-output-folder: true package-dir: "Azure.Developer.TrustedSigning" From 169aed4daf6d57834509314800c0595a814c760c Mon Sep 17 00:00:00 2001 From: rishavMS <99256759+rishavMS@users.noreply.github.com> Date: Fri, 27 Sep 2024 16:46:39 +0530 Subject: [PATCH 06/47] BilingRP subscrption api swagger update for offerId for 2024-04-01 (#30721) --- .../stable/2024-04-01/billingSubscription.json | 2 +- .../examples/billingSubscriptionsListByBillingProfileEA.json | 1 + .../examples/billingSubscriptionsListByEnrollmentAccount.json | 2 ++ 3 files changed, 4 insertions(+), 1 deletion(-) diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingSubscription.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingSubscription.json index 976b7926e0e9..a0ee06a94b7a 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingSubscription.json +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingSubscription.json @@ -1544,7 +1544,7 @@ "$ref": "#/definitions/NextBillingCycleDetails" }, "offerId": { - "description": "The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts.", + "description": "The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement.", "type": "string", "readOnly": true }, diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingProfileEA.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingProfileEA.json index d84a83a85a99..429e2bb6e50a 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingProfileEA.json +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingProfileEA.json @@ -17,6 +17,7 @@ "displayName": "My Subscription", "enrollmentAccountId": "172988", "enrollmentAccountDisplayName": "billtest332211@outlook.com", + "offerId": "MS-AZR-0017P", "status": "Active", "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3" }, diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByEnrollmentAccount.json index 3c5cab3ccedd..416d3f92d781 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByEnrollmentAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByEnrollmentAccount.json @@ -19,6 +19,7 @@ "enrollmentAccountSubscriptionDetails": { "enrollmentAccountStartDate": "2023-01-04T00:00:00.0000000Z" }, + "offerId": "MS-AZR-0017P", "subscriptionId": "90000000-0000-0000-0000-000000000000" }, "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" @@ -35,6 +36,7 @@ "enrollmentAccountStartDate": "2023-01-04T00:00:00.0000000Z", "subscriptionEnrollmentAccountStatus": "Deleted" }, + "offerId": "MS-AZR-0136P", "subscriptionId": "90000000-0000-0000-0000-000000000001" }, "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" From 50b2c19226d116f200c7468dd7263f0c02d7bd01 Mon Sep 17 00:00:00 2001 From: ZiWei Chen <98569699+kazrael2119@users.noreply.github.com> Date: Fri, 27 Sep 2024 19:45:58 +0800 Subject: [PATCH 07/47] add directive for containerservice (#30772) --- .../Microsoft.ContainerService/aks/readme.typescript.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.typescript.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.typescript.md index 288ba334a779..e33bbf8ae14b 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.typescript.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.typescript.md @@ -9,4 +9,10 @@ typescript: package-name: "@azure/arm-containerservice" output-folder: "$(typescript-sdks-folder)/sdk/containerservice/arm-containerservice" generate-metadata: true + +directive: + - from: managedClusters.json + where: $.definitions.MachineIpAddress + transform: > + $.properties.family["x-ms-enum"].name = "IpFamily" ``` From 1999e40aea3fb2e42ea3650238e4e83973ec03d2 Mon Sep 17 00:00:00 2001 From: jamesvoongms <104241521+jamesvoongms@users.noreply.github.com> Date: Fri, 27 Sep 2024 09:15:59 -0700 Subject: [PATCH 08/47] DNS Resolver Release 2023-07-01-Preview with new DNS Security Policy feature (#30707) * Add new folder for 2023-07-01-preview with stable 2022-07-01 as the base * Add changes for new DNS security policy feature * Fix linting issues * Add readme changes * Fix autorest issue by changing from v2 to v5 in dnsresolver module --- .../2023-07-01-preview/dnsresolver.json | 2675 +++++++++++++++++ .../2023-07-01-preview/dnsresolverpolicy.json | 1828 +++++++++++ .../examples/DnsForwardingRuleset_Delete.json | 18 + .../examples/DnsForwardingRuleset_Get.json | 40 + ...ForwardingRuleset_ListByResourceGroup.json | 72 + ...sForwardingRuleset_ListBySubscription.json | 71 + ...orwardingRuleset_ListByVirtualNetwork.json | 25 + .../examples/DnsForwardingRuleset_Patch.json | 51 + .../examples/DnsForwardingRuleset_Put.json | 92 + .../DnsResolverDomainList_Delete.json | 17 + .../examples/DnsResolverDomainList_Get.json | 35 + ...esolverDomainList_ListByResourceGroup.json | 62 + ...ResolverDomainList_ListBySubscription.json | 61 + .../examples/DnsResolverDomainList_Patch.json | 51 + .../examples/DnsResolverDomainList_Put.json | 71 + ...solverPolicyVirtualNetworkLink_Delete.json | 18 + ...sResolverPolicyVirtualNetworkLink_Get.json | 35 + ...ResolverPolicyVirtualNetworkLink_List.json | 39 + ...esolverPolicyVirtualNetworkLink_Patch.json | 46 + ...sResolverPolicyVirtualNetworkLink_Put.json | 76 + .../examples/DnsResolverPolicy_Delete.json | 17 + .../examples/DnsResolverPolicy_Get.json | 32 + ...DnsResolverPolicy_ListByResourceGroup.json | 56 + .../DnsResolverPolicy_ListBySubscription.json | 55 + ...nsResolverPolicy_ListByVirtualNetwork.json | 20 + .../examples/DnsResolverPolicy_Patch.json | 43 + .../examples/DnsResolverPolicy_Put.json | 60 + .../examples/DnsResolver_Delete.json | 18 + .../examples/DnsResolver_Get.json | 36 + .../DnsResolver_ListByResourceGroup.json | 64 + .../DnsResolver_ListBySubscription.json | 63 + .../DnsResolver_ListByVirtualNetwork.json | 20 + .../examples/DnsResolver_Patch.json | 47 + .../examples/DnsResolver_Put.json | 73 + .../examples/DnsSecurityRule_Delete.json | 18 + .../examples/DnsSecurityRule_Get.json | 43 + .../examples/DnsSecurityRule_List.json | 77 + .../examples/DnsSecurityRule_Patch.json | 56 + .../examples/DnsSecurityRule_Put.json | 100 + .../examples/ForwardingRule_Delete.json | 13 + .../examples/ForwardingRule_Get.json | 43 + .../examples/ForwardingRule_List.json | 77 + .../examples/ForwardingRule_Patch.json | 51 + .../examples/ForwardingRule_Put.json | 94 + .../examples/InboundEndpoint_Delete.json | 19 + .../examples/InboundEndpoint_Get.json | 42 + .../examples/InboundEndpoint_List.json | 75 + .../examples/InboundEndpoint_Patch.json | 53 + .../examples/InboundEndpoint_Put.json | 95 + .../examples/OutboundEndpoint_Delete.json | 19 + .../examples/OutboundEndpoint_Get.json | 36 + .../examples/OutboundEndpoint_List.json | 63 + .../examples/OutboundEndpoint_Patch.json | 47 + .../examples/OutboundEndpoint_Put.json | 77 + .../examples/VirtualNetworkLink_Delete.json | 19 + .../examples/VirtualNetworkLink_Get.json | 34 + .../examples/VirtualNetworkLink_List.json | 38 + .../examples/VirtualNetworkLink_Patch.json | 47 + .../examples/VirtualNetworkLink_Put.json | 73 + .../dnsresolver/resource-manager/readme.md | 17 +- 60 files changed, 7310 insertions(+), 3 deletions(-) create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/dnsresolver.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/dnsresolverpolicy.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListByResourceGroup.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListBySubscription.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListByVirtualNetwork.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Put.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_ListByResourceGroup.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_ListBySubscription.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Put.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_List.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Put.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListByResourceGroup.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListBySubscription.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListByVirtualNetwork.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Put.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListByResourceGroup.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListBySubscription.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListByVirtualNetwork.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Put.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_List.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Put.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_List.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Put.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_List.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Put.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_List.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Put.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_List.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Put.json diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/dnsresolver.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/dnsresolver.json new file mode 100644 index 000000000000..51f0c433eeee --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/dnsresolver.json @@ -0,0 +1,2675 @@ +{ + "swagger": "2.0", + "info": { + "title": "DnsResolverManagementClient", + "description": "The DNS Resolver Management Client.", + "version": "2023-07-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "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.Network/dnsResolvers/{dnsResolverName}": { + "put": { + "tags": [ + "DnsResolvers" + ], + "operationId": "DnsResolvers_CreateOrUpdate", + "description": "Creates or updates a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsResolver" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The DNS resolver has been created.", + "schema": { + "$ref": "#/definitions/DnsResolver" + } + }, + "200": { + "description": "The DNS resolver has been updated.", + "schema": { + "$ref": "#/definitions/DnsResolver" + } + }, + "202": { + "description": "The operation to upsert DNS resolver has been accepted and will complete asynchronously." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upsert DNS resolver": { + "$ref": "./examples/DnsResolver_Put.json" + } + } + }, + "patch": { + "tags": [ + "DnsResolvers" + ], + "operationId": "DnsResolvers_Update", + "description": "Updates a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsResolverPatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The DNS resolver has been updated.", + "schema": { + "$ref": "#/definitions/DnsResolver" + } + }, + "202": { + "description": "The operation to update DNS resolver has been accepted and will complete asynchronously." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update DNS resolver": { + "$ref": "./examples/DnsResolver_Patch.json" + } + } + }, + "delete": { + "tags": [ + "DnsResolvers" + ], + "operationId": "DnsResolvers_Delete", + "description": "Deletes a DNS resolver. WARNING: This operation cannot be undone.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The DNS resolver has been deleted." + }, + "202": { + "description": "The operation to delete DNS resolver has been accepted and will complete asynchronously." + }, + "204": { + "description": "The DNS resolver was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete DNS resolver": { + "$ref": "./examples/DnsResolver_Delete.json" + } + } + }, + "get": { + "tags": [ + "DnsResolvers" + ], + "operationId": "DnsResolvers_Get", + "description": "Gets properties of a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The DNS resolver was found.", + "schema": { + "$ref": "#/definitions/DnsResolver" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Retrieve DNS resolver": { + "$ref": "./examples/DnsResolver_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers": { + "get": { + "tags": [ + "DnsResolvers" + ], + "operationId": "DnsResolvers_ListByResourceGroup", + "description": "Lists DNS resolvers within a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS resolvers in the resource group.", + "schema": { + "$ref": "#/definitions/DnsResolverListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS resolvers by resource group": { + "$ref": "./examples/DnsResolver_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/dnsResolvers": { + "get": { + "tags": [ + "DnsResolvers" + ], + "operationId": "DnsResolvers_List", + "description": "Lists DNS resolvers in all resource groups of a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS resolvers in the subscription.", + "schema": { + "$ref": "#/definitions/DnsResolverListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS resolvers by subscription": { + "$ref": "./examples/DnsResolver_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/inboundEndpoints/{inboundEndpointName}": { + "put": { + "tags": [ + "InboundEndpoints" + ], + "operationId": "InboundEndpoints_CreateOrUpdate", + "description": "Creates or updates an inbound endpoint for a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "#/parameters/InboundEndpointNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/InboundEndpoint" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The inbound endpoint for the DNS resolver has been created.", + "schema": { + "$ref": "#/definitions/InboundEndpoint" + } + }, + "200": { + "description": "The inbound endpoint for the DNS resolver has been updated.", + "schema": { + "$ref": "#/definitions/InboundEndpoint" + } + }, + "202": { + "description": "The operation to upsert inbound endpoint for the DNS resolver has been accepted and will complete asynchronously." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upsert inbound endpoint for DNS resolver": { + "$ref": "./examples/InboundEndpoint_Put.json" + } + } + }, + "patch": { + "tags": [ + "InboundEndpoints" + ], + "operationId": "InboundEndpoints_Update", + "description": "Updates an inbound endpoint for a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "#/parameters/InboundEndpointNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/InboundEndpointPatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The inbound endpoint for the DNS resolver has been updated.", + "schema": { + "$ref": "#/definitions/InboundEndpoint" + } + }, + "202": { + "description": "The operation to update inbound endpoint for the DNS resolver has been accepted and will complete asynchronously." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update inbound endpoint for DNS resolver": { + "$ref": "./examples/InboundEndpoint_Patch.json" + } + } + }, + "delete": { + "tags": [ + "InboundEndpoints" + ], + "operationId": "InboundEndpoints_Delete", + "description": "Deletes an inbound endpoint for a DNS resolver. WARNING: This operation cannot be undone.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "#/parameters/InboundEndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The inbound endpoint for the DNS resolver has been deleted." + }, + "202": { + "description": "The operation to delete inbound endpoint for the DNS resolver has been accepted and will complete asynchronously." + }, + "204": { + "description": "The inbound endpoint for the DNS resolver was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete inbound endpoint for DNS resolver": { + "$ref": "./examples/InboundEndpoint_Delete.json" + } + } + }, + "get": { + "tags": [ + "InboundEndpoints" + ], + "operationId": "InboundEndpoints_Get", + "description": "Gets properties of an inbound endpoint for a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "#/parameters/InboundEndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The inbound endpoint for the DNS resolver was found.", + "schema": { + "$ref": "#/definitions/InboundEndpoint" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Retrieve inbound endpoint for DNS resolver": { + "$ref": "./examples/InboundEndpoint_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/inboundEndpoints": { + "get": { + "tags": [ + "InboundEndpoints" + ], + "operationId": "InboundEndpoints_List", + "description": "Lists inbound endpoints for a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of inbound endpoints for the DNS resolver.", + "schema": { + "$ref": "#/definitions/InboundEndpointListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List inbound endpoints by DNS resolver": { + "$ref": "./examples/InboundEndpoint_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/outboundEndpoints/{outboundEndpointName}": { + "put": { + "tags": [ + "OutboundEndpoints" + ], + "operationId": "OutboundEndpoints_CreateOrUpdate", + "description": "Creates or updates an outbound endpoint for a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "#/parameters/OutboundEndpointNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OutboundEndpoint" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The outbound endpoint for the DNS resolver has been created.", + "schema": { + "$ref": "#/definitions/OutboundEndpoint" + } + }, + "200": { + "description": "The outbound endpoint for the DNS resolver has been updated.", + "schema": { + "$ref": "#/definitions/OutboundEndpoint" + } + }, + "202": { + "description": "The operation to upsert outbound endpoint for the DNS resolver has been accepted and will complete asynchronously." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upsert outbound endpoint for DNS resolver": { + "$ref": "./examples/OutboundEndpoint_Put.json" + } + } + }, + "patch": { + "tags": [ + "OutboundEndpoints" + ], + "operationId": "OutboundEndpoints_Update", + "description": "Updates an outbound endpoint for a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "#/parameters/OutboundEndpointNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OutboundEndpointPatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The outbound endpoint for the DNS resolver has been updated.", + "schema": { + "$ref": "#/definitions/OutboundEndpoint" + } + }, + "202": { + "description": "The operation to update outbound endpoint for the DNS resolver has been accepted and will complete asynchronously." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update outbound endpoint for DNS resolver": { + "$ref": "./examples/OutboundEndpoint_Patch.json" + } + } + }, + "delete": { + "tags": [ + "OutboundEndpoints" + ], + "operationId": "OutboundEndpoints_Delete", + "description": "Deletes an outbound endpoint for a DNS resolver. WARNING: This operation cannot be undone.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "#/parameters/OutboundEndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The outbound endpoint for the DNS resolver has been deleted." + }, + "202": { + "description": "The operation to delete outbound endpoint for the DNS resolver has been accepted and will complete asynchronously." + }, + "204": { + "description": "The outbound endpoint for the DNS resolver was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete outbound endpoint for DNS resolver": { + "$ref": "./examples/OutboundEndpoint_Delete.json" + } + } + }, + "get": { + "tags": [ + "OutboundEndpoints" + ], + "operationId": "OutboundEndpoints_Get", + "description": "Gets properties of an outbound endpoint for a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "#/parameters/OutboundEndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The outbound endpoint for the DNS resolver was found.", + "schema": { + "$ref": "#/definitions/OutboundEndpoint" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Retrieve outbound endpoint for DNS resolver": { + "$ref": "./examples/OutboundEndpoint_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/outboundEndpoints": { + "get": { + "tags": [ + "OutboundEndpoints" + ], + "operationId": "OutboundEndpoints_List", + "description": "Lists outbound endpoints for a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of outbound endpoints for the DNS resolver.", + "schema": { + "$ref": "#/definitions/OutboundEndpointListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List outbound endpoints by DNS resolver": { + "$ref": "./examples/OutboundEndpoint_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}": { + "put": { + "tags": [ + "DnsForwardingRulesets" + ], + "operationId": "DnsForwardingRulesets_CreateOrUpdate", + "description": "Creates or updates a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsForwardingRuleset" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The DNS forwarding ruleset has been created.", + "schema": { + "$ref": "#/definitions/DnsForwardingRuleset" + } + }, + "200": { + "description": "The DNS forwarding ruleset has been updated.", + "schema": { + "$ref": "#/definitions/DnsForwardingRuleset" + } + }, + "202": { + "description": "The operation to upsert DNS forwarding ruleset has been accepted and will complete asynchronously." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upsert DNS forwarding ruleset": { + "$ref": "./examples/DnsForwardingRuleset_Put.json" + } + } + }, + "patch": { + "tags": [ + "DnsForwardingRulesets" + ], + "operationId": "DnsForwardingRulesets_Update", + "description": "Updates a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsForwardingRulesetPatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The DNS forwarding ruleset has been updated.", + "schema": { + "$ref": "#/definitions/DnsForwardingRuleset" + } + }, + "202": { + "description": "The operation to update DNS forwarding ruleset has been accepted and will complete asynchronously." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update DNS forwarding ruleset": { + "$ref": "./examples/DnsForwardingRuleset_Patch.json" + } + } + }, + "delete": { + "tags": [ + "DnsForwardingRulesets" + ], + "operationId": "DnsForwardingRulesets_Delete", + "description": "Deletes a DNS forwarding ruleset. WARNING: This operation cannot be undone. All forwarding rules within the ruleset will be deleted.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The DNS forwarding ruleset has been deleted." + }, + "202": { + "description": "The operation to delete DNS forwarding ruleset has been accepted and will complete asynchronously." + }, + "204": { + "description": "The DNS forwarding ruleset was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete DNS forwarding ruleset": { + "$ref": "./examples/DnsForwardingRuleset_Delete.json" + } + } + }, + "get": { + "tags": [ + "DnsForwardingRulesets" + ], + "operationId": "DnsForwardingRulesets_Get", + "description": "Gets a DNS forwarding ruleset properties.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The DNS forwarding ruleset was found.", + "schema": { + "$ref": "#/definitions/DnsForwardingRuleset" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Retrieve DNS forwarding ruleset": { + "$ref": "./examples/DnsForwardingRuleset_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets": { + "get": { + "tags": [ + "DnsForwardingRulesets" + ], + "operationId": "DnsForwardingRulesets_ListByResourceGroup", + "description": "Lists DNS forwarding rulesets within a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS forwarding rulesets in the resource group.", + "schema": { + "$ref": "#/definitions/DnsForwardingRulesetListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS forwarding rulesets by resource group": { + "$ref": "./examples/DnsForwardingRuleset_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/dnsForwardingRulesets": { + "get": { + "tags": [ + "DnsForwardingRulesets" + ], + "operationId": "DnsForwardingRulesets_List", + "description": "Lists DNS forwarding rulesets in all resource groups of a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS forwarding rulesets in the subscription.", + "schema": { + "$ref": "#/definitions/DnsForwardingRulesetListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS forwarding rulesets by subscription": { + "$ref": "./examples/DnsForwardingRuleset_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/forwardingRules/{forwardingRuleName}": { + "put": { + "tags": [ + "ForwardingRules" + ], + "operationId": "ForwardingRules_CreateOrUpdate", + "description": "Creates or updates a forwarding rule in a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "#/parameters/ForwardingRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ForwardingRule" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The forwarding rule has been created.", + "schema": { + "$ref": "#/definitions/ForwardingRule" + } + }, + "200": { + "description": "The forwarding rule has been updated.", + "schema": { + "$ref": "#/definitions/ForwardingRule" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Upsert forwarding rule in a DNS forwarding ruleset": { + "$ref": "./examples/ForwardingRule_Put.json" + } + } + }, + "patch": { + "tags": [ + "ForwardingRules" + ], + "operationId": "ForwardingRules_Update", + "description": "Updates a forwarding rule in a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "#/parameters/ForwardingRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ForwardingRulePatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The forwarding rule has been updated.", + "schema": { + "$ref": "#/definitions/ForwardingRule" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update forwarding rule in a DNS forwarding ruleset": { + "$ref": "./examples/ForwardingRule_Patch.json" + } + } + }, + "delete": { + "tags": [ + "ForwardingRules" + ], + "operationId": "ForwardingRules_Delete", + "description": "Deletes a forwarding rule in a DNS forwarding ruleset. WARNING: This operation cannot be undone.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "#/parameters/ForwardingRuleNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The forwarding rule has been deleted." + }, + "204": { + "description": "The forwarding rule was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete forwarding rule in a DNS forwarding ruleset": { + "$ref": "./examples/ForwardingRule_Delete.json" + } + } + }, + "get": { + "tags": [ + "ForwardingRules" + ], + "operationId": "ForwardingRules_Get", + "description": "Gets properties of a forwarding rule in a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "#/parameters/ForwardingRuleNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The forwarding rule was found.", + "schema": { + "$ref": "#/definitions/ForwardingRule" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Retrieve forwarding rule in a DNS forwarding ruleset": { + "$ref": "./examples/ForwardingRule_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/forwardingRules": { + "get": { + "tags": [ + "ForwardingRules" + ], + "operationId": "ForwardingRules_List", + "description": "Lists forwarding rules in a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of forwarding rules in the DNS forwarding ruleset.", + "schema": { + "$ref": "#/definitions/ForwardingRuleListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List forwarding rules in a DNS forwarding ruleset": { + "$ref": "./examples/ForwardingRule_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/virtualNetworkLinks/{virtualNetworkLinkName}": { + "put": { + "tags": [ + "VirtualNetworkLinks" + ], + "operationId": "VirtualNetworkLinks_CreateOrUpdate", + "description": "Creates or updates a virtual network link to a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkLinkNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkLink" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The virtual network link to the DNS forwarding ruleset has been created.", + "schema": { + "$ref": "#/definitions/VirtualNetworkLink" + } + }, + "200": { + "description": "The virtual network link to the DNS forwarding ruleset has been updated.", + "schema": { + "$ref": "#/definitions/VirtualNetworkLink" + } + }, + "202": { + "description": "The operation to upsert virtual network link to the DNS forwarding ruleset has been accepted and will complete asynchronously." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upsert virtual network link to a DNS forwarding ruleset": { + "$ref": "./examples/VirtualNetworkLink_Put.json" + } + } + }, + "patch": { + "tags": [ + "VirtualNetworkLinks" + ], + "operationId": "VirtualNetworkLinks_Update", + "description": "Updates a virtual network link to a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkLinkNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkLinkPatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The virtual network link to the DNS forwarding ruleset has been updated.", + "schema": { + "$ref": "#/definitions/VirtualNetworkLink" + } + }, + "202": { + "description": "The operation to update virtual network link to the DNS forwarding ruleset has been accepted and will complete asynchronously." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update virtual network link to a DNS forwarding ruleset": { + "$ref": "./examples/VirtualNetworkLink_Patch.json" + } + } + }, + "delete": { + "tags": [ + "VirtualNetworkLinks" + ], + "operationId": "VirtualNetworkLinks_Delete", + "description": "Deletes a virtual network link to a DNS forwarding ruleset. WARNING: This operation cannot be undone.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkLinkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The virtual network link to the DNS forwarding ruleset has been deleted." + }, + "202": { + "description": "The operation to delete virtual network link to the DNS forwarding ruleset has been accepted and will complete asynchronously." + }, + "204": { + "description": "The virtual network link to the DNS forwarding ruleset was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete virtual network link to a DNS forwarding ruleset": { + "$ref": "./examples/VirtualNetworkLink_Delete.json" + } + } + }, + "get": { + "tags": [ + "VirtualNetworkLinks" + ], + "operationId": "VirtualNetworkLinks_Get", + "description": "Gets properties of a virtual network link to a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkLinkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The virtual network link to DNS forwarding ruleset was found.", + "schema": { + "$ref": "#/definitions/VirtualNetworkLink" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Retrieve virtual network link to a DNS forwarding ruleset": { + "$ref": "./examples/VirtualNetworkLink_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/virtualNetworkLinks": { + "get": { + "tags": [ + "VirtualNetworkLinks" + ], + "operationId": "VirtualNetworkLinks_List", + "description": "Lists virtual network links to a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of virtual network links to a DNS forwarding ruleset.", + "schema": { + "$ref": "#/definitions/VirtualNetworkLinkListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List virtual network links to a DNS forwarding ruleset": { + "$ref": "./examples/VirtualNetworkLink_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/listDnsResolvers": { + "post": { + "tags": [ + "DnsResolvers" + ], + "operationId": "DnsResolvers_ListByVirtualNetwork", + "description": "Lists DNS resolver resource IDs linked to a virtual network.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS resolver resource IDs linked to the virtual network.", + "schema": { + "$ref": "#/definitions/SubResourceListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS resolvers by virtual network": { + "$ref": "./examples/DnsResolver_ListByVirtualNetwork.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/listDnsForwardingRulesets": { + "post": { + "tags": [ + "DnsForwardingRulesets" + ], + "operationId": "DnsForwardingRulesets_ListByVirtualNetwork", + "description": "Lists DNS forwarding ruleset resource IDs attached to a virtual network.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS forwarding ruleset resource IDs and virtual network link resource IDs attached to the virtual network.", + "schema": { + "$ref": "#/definitions/VirtualNetworkDnsForwardingRulesetListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS forwarding rulesets by virtual network": { + "$ref": "./examples/DnsForwardingRuleset_ListByVirtualNetwork.json" + } + } + } + } + }, + "definitions": { + "DnsResolverProperties": { + "description": "Represents the properties of a DNS resolver.", + "type": "object", + "required": [ + "virtualNetwork" + ], + "properties": { + "virtualNetwork": { + "description": "The reference to the virtual network. This cannot be changed after creation.", + "x-ms-mutability": [ + "read", + "create" + ], + "$ref": "#/definitions/SubResource" + }, + "dnsResolverState": { + "description": "The current status of the DNS resolver. This is a read-only property and any attempt to set this value will be ignored.", + "type": "string", + "enum": [ + "Connected", + "Disconnected" + ], + "x-ms-enum": { + "name": "DnsResolverState", + "modelAsString": true + }, + "readOnly": true + }, + "provisioningState": { + "description": "The current provisioning state of the DNS resolver. This is a read-only property and any attempt to set this value will be ignored.", + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "resourceGuid": { + "description": "The resourceGuid property of the DNS resolver resource.", + "readOnly": true, + "$ref": "#/definitions/ResourceGuid" + } + } + }, + "DnsResolver": { + "description": "Describes a DNS resolver.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "etag": { + "description": "ETag of the DNS resolver.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the DNS resolver.", + "$ref": "#/definitions/DnsResolverProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "DnsResolverPatch": { + "description": "Describes a DNS resolver for PATCH operation.", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Tags for DNS Resolver." + } + } + }, + "DnsResolverListResult": { + "description": "The response to an enumeration operation on DNS resolvers.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the DNS resolvers.", + "type": "array", + "items": { + "$ref": "#/definitions/DnsResolver" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "InboundEndpointProperties": { + "description": "Represents the properties of an inbound endpoint for a DNS resolver.", + "type": "object", + "required": [ + "ipConfigurations" + ], + "properties": { + "ipConfigurations": { + "description": "IP configurations for the inbound endpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/IpConfiguration" + }, + "x-ms-identifiers": [] + }, + "provisioningState": { + "description": "The current provisioning state of the inbound endpoint. This is a read-only property and any attempt to set this value will be ignored.", + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "resourceGuid": { + "description": "The resourceGuid property of the inbound endpoint resource.", + "readOnly": true, + "$ref": "#/definitions/ResourceGuid" + } + } + }, + "InboundEndpoint": { + "description": "Describes an inbound endpoint for a DNS resolver.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "etag": { + "description": "ETag of the inbound endpoint.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the inbound endpoint.", + "$ref": "#/definitions/InboundEndpointProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "InboundEndpointPatch": { + "description": "Describes an inbound endpoint for a DNS resolver for PATCH operation.", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Tags for inbound endpoint." + } + } + }, + "InboundEndpointListResult": { + "description": "The response to an enumeration operation on inbound endpoints for a DNS resolver.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the inbound endpoints for a DNS resolver.", + "type": "array", + "items": { + "$ref": "#/definitions/InboundEndpoint" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "OutboundEndpointProperties": { + "description": "Represents the properties of an outbound endpoint for a DNS resolver.", + "type": "object", + "required": [ + "subnet" + ], + "properties": { + "subnet": { + "description": "The reference to the subnet used for the outbound endpoint.", + "$ref": "#/definitions/SubResource" + }, + "provisioningState": { + "description": "The current provisioning state of the outbound endpoint. This is a read-only property and any attempt to set this value will be ignored.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + }, + "resourceGuid": { + "description": "The resourceGuid property of the outbound endpoint resource.", + "readOnly": true, + "$ref": "#/definitions/ResourceGuid" + } + } + }, + "OutboundEndpoint": { + "description": "Describes an outbound endpoint for a DNS resolver.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "etag": { + "description": "ETag of the outbound endpoint.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the outbound endpoint.", + "$ref": "#/definitions/OutboundEndpointProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "OutboundEndpointPatch": { + "description": "Describes an outbound endpoint for a DNS resolver for PATCH operation.", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Tags for outbound endpoint." + } + } + }, + "OutboundEndpointListResult": { + "description": "The response to an enumeration operation on outbound endpoints for a DNS resolver.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the outbound endpoints for a DNS resolver.", + "type": "array", + "items": { + "$ref": "#/definitions/OutboundEndpoint" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "DnsForwardingRulesetProperties": { + "description": "Represents the properties of a DNS forwarding ruleset.", + "type": "object", + "required": [ + "dnsResolverOutboundEndpoints" + ], + "properties": { + "dnsResolverOutboundEndpoints": { + "description": "The reference to the DNS resolver outbound endpoints that are used to route DNS queries matching the forwarding rules in the ruleset to the target DNS servers.", + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + "provisioningState": { + "description": "The current provisioning state of the DNS forwarding ruleset. This is a read-only property and any attempt to set this value will be ignored.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + }, + "resourceGuid": { + "description": "The resourceGuid for the DNS forwarding ruleset.", + "type": "string", + "readOnly": true + } + } + }, + "DnsForwardingRuleset": { + "description": "Describes a DNS forwarding ruleset.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "etag": { + "description": "ETag of the DNS forwarding ruleset.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the DNS forwarding ruleset.", + "$ref": "#/definitions/DnsForwardingRulesetProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "DnsForwardingRulesetPatch": { + "description": "Describes a DNS forwarding ruleset PATCH operation.", + "type": "object", + "properties": { + "dnsResolverOutboundEndpoints": { + "description": "The reference to the DNS resolver outbound endpoints that are used to route DNS queries matching the forwarding rules in the ruleset to the target DNS servers.", + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Tags for DNS Resolver." + } + } + }, + "DnsForwardingRulesetListResult": { + "description": "The response to an enumeration operation on DNS forwarding rulesets.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the DNS forwarding rulesets.", + "type": "array", + "items": { + "$ref": "#/definitions/DnsForwardingRuleset" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ForwardingRuleProperties": { + "description": "Represents the properties of a forwarding rule within a DNS forwarding ruleset.", + "type": "object", + "required": [ + "domainName", + "targetDnsServers" + ], + "properties": { + "domainName": { + "description": "The domain name for the forwarding rule.", + "type": "string" + }, + "targetDnsServers": { + "description": "DNS servers to forward the DNS query to.", + "type": "array", + "items": { + "$ref": "#/definitions/TargetDnsServer" + }, + "x-ms-identifiers": [] + }, + "metadata": { + "description": "Metadata attached to the forwarding rule.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "forwardingRuleState": { + "type": "string", + "description": "The state of forwarding rule.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ForwardingRuleState", + "modelAsString": true + } + }, + "provisioningState": { + "description": "The current provisioning state of the forwarding rule. This is a read-only property and any attempt to set this value will be ignored.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "ForwardingRule": { + "description": "Describes a forwarding rule within a DNS forwarding ruleset.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "etag": { + "description": "ETag of the forwarding rule.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the forwarding rule.", + "$ref": "#/definitions/ForwardingRuleProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ForwardingRulePatchProperties": { + "description": "Represents the updatable properties of a forwarding rule within a DNS forwarding ruleset.", + "type": "object", + "properties": { + "targetDnsServers": { + "description": "DNS servers to forward the DNS query to.", + "type": "array", + "items": { + "$ref": "#/definitions/TargetDnsServer" + }, + "x-ms-identifiers": [] + }, + "metadata": { + "description": "Metadata attached to the forwarding rule.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "forwardingRuleState": { + "type": "string", + "description": "The state of forwarding rule.", + "enum": [ + "Enabled", + "Disabled" + ], + "default": "Enabled", + "x-ms-enum": { + "name": "ForwardingRuleState", + "modelAsString": true + } + } + } + }, + "ForwardingRulePatch": { + "description": "Describes a forwarding rule for PATCH operation.", + "type": "object", + "properties": { + "properties": { + "description": "Updatable properties of the forwarding rule.", + "$ref": "#/definitions/ForwardingRulePatchProperties", + "x-ms-client-flatten": true + } + } + }, + "ForwardingRuleListResult": { + "description": "The response to an enumeration operation on forwarding rules within a DNS forwarding ruleset.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the forwarding rules.", + "type": "array", + "items": { + "$ref": "#/definitions/ForwardingRule" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "VirtualNetworkLinkProperties": { + "description": "Represents the properties of a virtual network link.", + "type": "object", + "required": [ + "virtualNetwork" + ], + "properties": { + "virtualNetwork": { + "description": "The reference to the virtual network. This cannot be changed after creation.", + "$ref": "#/definitions/SubResource" + }, + "metadata": { + "description": "Metadata attached to the virtual network link.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "description": "The current provisioning state of the virtual network link. This is a read-only property and any attempt to set this value will be ignored.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "VirtualNetworkLink": { + "description": "Describes a virtual network link.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "etag": { + "description": "ETag of the virtual network link.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the virtual network link.", + "$ref": "#/definitions/VirtualNetworkLinkProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "VirtualNetworkLinkPatchProperties": { + "description": "Represents the updatable properties of the virtual network link.", + "type": "object", + "properties": { + "metadata": { + "description": "Metadata attached to the virtual network link.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VirtualNetworkLinkPatch": { + "description": "Describes a virtual network link for PATCH operation.", + "type": "object", + "properties": { + "properties": { + "description": "Updatable properties of the virtual network link.", + "$ref": "#/definitions/VirtualNetworkLinkPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "VirtualNetworkLinkListResult": { + "description": "The response to an enumeration operation on virtual network links.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the virtual network links.", + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkLink" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "IpConfiguration": { + "description": "IP configuration.", + "type": "object", + "required": [ + "subnet" + ], + "properties": { + "subnet": { + "description": "The reference to the subnet bound to the IP configuration.", + "$ref": "#/definitions/SubResource" + }, + "privateIpAddress": { + "description": "Private IP address of the IP configuration.", + "type": "string" + }, + "privateIpAllocationMethod": { + "description": "Private IP address allocation method.", + "type": "string", + "enum": [ + "Static", + "Dynamic" + ], + "default": "Dynamic", + "x-ms-enum": { + "name": "IpAllocationMethod", + "modelAsString": true + } + } + } + }, + "TargetDnsServer": { + "description": "Describes a server to forward the DNS queries to.", + "type": "object", + "required": [ + "ipAddress" + ], + "properties": { + "ipAddress": { + "description": "DNS server IP address.", + "type": "string" + }, + "port": { + "description": "DNS server port.", + "type": "integer", + "format": "int32", + "default": 53 + } + } + }, + "ProvisioningState": { + "description": "The current provisioning state of the resource.", + "type": "string", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "ResourceGuid": { + "type": "string", + "description": "The Guid property of the resource." + }, + "SubResourceListResult": { + "description": "The response to an enumeration operation on sub-resources.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the sub-resources.", + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SubResource": { + "description": "Reference to another ARM resource.", + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + }, + "x-ms-azure-resource": true + }, + "VirtualNetworkDnsForwardingRulesetListResult": { + "description": "The response to an enumeration operation on Virtual Network DNS Forwarding Ruleset.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the Virtual Network DNS Forwarding Ruleset.", + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkDnsForwardingRuleset" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "VirtualNetworkLinkSubResourceProperties": { + "description": "The reference to the virtual network link that associates between the DNS forwarding ruleset and virtual network.", + "type": "object", + "properties": { + "virtualNetworkLink": { + "description": "The reference to the virtual network link.", + "$ref": "#/definitions/SubResource" + } + } + }, + "VirtualNetworkDnsForwardingRuleset": { + "description": "Reference to DNS forwarding ruleset and associated virtual network link.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "DNS Forwarding Ruleset Resource ID." + }, + "properties": { + "description": "Properties of the virtual network link sub-resource reference.", + "$ref": "#/definitions/VirtualNetworkLinkSubResourceProperties", + "x-ms-client-flatten": true + } + } + }, + "CloudError": { + "description": "An error message", + "type": "object", + "properties": { + "error": { + "description": "The error message body", + "$ref": "#/definitions/CloudErrorBody" + } + }, + "x-ms-external": true + }, + "CloudErrorBody": { + "description": "The body of an error message", + "type": "object", + "properties": { + "code": { + "description": "The error code", + "type": "string" + }, + "message": { + "description": "A description of what caused the error", + "type": "string" + }, + "target": { + "description": "The target resource of the error message", + "type": "string" + }, + "details": { + "description": "Extra error information", + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "x-ms-identifiers": [] + } + }, + "x-ms-external": true + } + }, + "parameters": { + "DnsResolverNameParameter": { + "name": "dnsResolverName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DNS resolver.", + "x-ms-parameter-location": "method" + }, + "InboundEndpointNameParameter": { + "name": "inboundEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the inbound endpoint for the DNS resolver.", + "x-ms-parameter-location": "method" + }, + "VirtualNetworkNameParameter": { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network.", + "x-ms-parameter-location": "method" + }, + "OutboundEndpointNameParameter": { + "name": "outboundEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the outbound endpoint for the DNS resolver.", + "x-ms-parameter-location": "method" + }, + "DnsForwardingRulesetNameParameter": { + "name": "dnsForwardingRulesetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DNS forwarding ruleset.", + "x-ms-parameter-location": "method" + }, + "ForwardingRuleNameParameter": { + "name": "forwardingRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the forwarding rule.", + "x-ms-parameter-location": "method" + }, + "VirtualNetworkLinkNameParameter": { + "name": "virtualNetworkLinkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network link.", + "x-ms-parameter-location": "method" + }, + "TopParameter": { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of results to return. If not specified, returns up to 100 results.", + "x-ms-parameter-location": "method" + }, + "IfMatchParameter": { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.", + "x-ms-parameter-location": "method" + }, + "IfNoneMatchParameter": { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfNoneMatch", + "description": "Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/dnsresolverpolicy.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/dnsresolverpolicy.json new file mode 100644 index 000000000000..f0415f04a869 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/dnsresolverpolicy.json @@ -0,0 +1,1828 @@ +{ + "swagger": "2.0", + "info": { + "title": "DnsResolverPolicyManagementClient", + "description": "The DNS Resolver Policy Management Client.", + "version": "2023-07-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "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.Network/dnsResolverPolicies/{dnsResolverPolicyName}": { + "put": { + "tags": [ + "DnsResolverPolicies" + ], + "operationId": "DnsResolverPolicies_CreateOrUpdate", + "description": "Creates or updates a DNS resolver policy.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsResolverPolicy" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The DNS resolver policy has been created.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicy" + } + }, + "200": { + "description": "The DNS resolver policy has been updated.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicy" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upsert DNS resolver policy": { + "$ref": "./examples/DnsResolverPolicy_Put.json" + } + } + }, + "patch": { + "tags": [ + "DnsResolverPolicies" + ], + "operationId": "DnsResolverPolicies_Update", + "description": "Updates a DNS resolver policy.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsResolverPolicyPatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The DNS resolver policy has been updated.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicy" + } + }, + "202": { + "description": "The operation to update DNS resolver policy has been accepted and will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update DNS resolver policy": { + "$ref": "./examples/DnsResolverPolicy_Patch.json" + } + } + }, + "delete": { + "tags": [ + "DnsResolverPolicies" + ], + "operationId": "DnsResolverPolicies_Delete", + "description": "Deletes a DNS resolver policy. WARNING: This operation cannot be undone.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "202": { + "description": "The operation to delete DNS resolver policy has been accepted and will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "The DNS resolver policy was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete DNS resolver policy": { + "$ref": "./examples/DnsResolverPolicy_Delete.json" + } + } + }, + "get": { + "tags": [ + "DnsResolverPolicies" + ], + "operationId": "DnsResolverPolicies_Get", + "description": "Gets properties of a DNS resolver policy.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The DNS resolver policy was found.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicy" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieve DNS resolver policy": { + "$ref": "./examples/DnsResolverPolicy_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies": { + "get": { + "tags": [ + "DnsResolverPolicies" + ], + "operationId": "DnsResolverPolicies_ListByResourceGroup", + "description": "Lists DNS resolver policies within a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS resolver policies in the resource group.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicyListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS resolver policies by resource group": { + "$ref": "./examples/DnsResolverPolicy_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/dnsResolverPolicies": { + "get": { + "tags": [ + "DnsResolverPolicies" + ], + "operationId": "DnsResolverPolicies_List", + "description": "Lists DNS resolver policies in all resource groups of a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS resolver policies in the subscription.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicyListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS resolver policies by subscription": { + "$ref": "./examples/DnsResolverPolicy_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}/dnsSecurityRules/{dnsSecurityRuleName}": { + "put": { + "tags": [ + "DnsSecurityRules" + ], + "operationId": "DnsSecurityRules_CreateOrUpdate", + "description": "Creates or updates a DNS security rule for a DNS resolver policy.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "#/parameters/DnsSecurityRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsSecurityRule" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The DNS security rule has been created.", + "schema": { + "$ref": "#/definitions/DnsSecurityRule" + } + }, + "200": { + "description": "The DNS security rule has been updated.", + "schema": { + "$ref": "#/definitions/DnsSecurityRule" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upsert DNS security rule": { + "$ref": "./examples/DnsSecurityRule_Put.json" + } + } + }, + "patch": { + "tags": [ + "DnsSecurityRules" + ], + "operationId": "DnsSecurityRules_Update", + "description": "Updates a DNS security rule.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "#/parameters/DnsSecurityRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsSecurityRulePatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The DNS security rule has been updated.", + "schema": { + "$ref": "#/definitions/DnsSecurityRule" + } + }, + "202": { + "description": "The operation to update the DNS security rule has been accepted and will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update DNS security rule for DNS resolver policy": { + "$ref": "./examples/DnsSecurityRule_Patch.json" + } + } + }, + "delete": { + "tags": [ + "DnsSecurityRules" + ], + "operationId": "DnsSecurityRules_Delete", + "description": "Deletes a DNS security rule for a DNS resolver policy. WARNING: This operation cannot be undone.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "#/parameters/DnsSecurityRuleNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "202": { + "description": "The operation to delete the DNS security rule has been accepted and will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "The DNS security rule was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete DNS security rule for DNS resolver policy": { + "$ref": "./examples/DnsSecurityRule_Delete.json" + } + } + }, + "get": { + "tags": [ + "DnsSecurityRules" + ], + "operationId": "DnsSecurityRules_Get", + "description": "Gets properties of a DNS security rule for a DNS resolver policy.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "#/parameters/DnsSecurityRuleNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The DNS security rule was found.", + "schema": { + "$ref": "#/definitions/DnsSecurityRule" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieve DNS security rule for DNS resolver policy": { + "$ref": "./examples/DnsSecurityRule_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}/dnsSecurityRules": { + "get": { + "tags": [ + "DnsSecurityRules" + ], + "operationId": "DnsSecurityRules_List", + "description": "Lists DNS security rules for a DNS resolver policy.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS security rules for the DNS resolver policy.", + "schema": { + "$ref": "#/definitions/DnsSecurityRuleListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS security rules by DNS resolver policy": { + "$ref": "./examples/DnsSecurityRule_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}/virtualNetworkLinks/{dnsResolverPolicyVirtualNetworkLinkName}": { + "put": { + "tags": [ + "DnsResolverPolicyVirtualNetworkLinks" + ], + "operationId": "DnsResolverPolicyVirtualNetworkLinks_CreateOrUpdate", + "description": "Creates or updates a DNS resolver policy virtual network link.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyVirtualNetworkLinkNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsResolverPolicyVirtualNetworkLink" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The DNS resolver policy virtual network link has been created.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicyVirtualNetworkLink" + } + }, + "200": { + "description": "The DNS resolver policy virtual network link has been updated.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicyVirtualNetworkLink" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upsert DNS resolver policy virtual network link": { + "$ref": "./examples/DnsResolverPolicyVirtualNetworkLink_Put.json" + } + } + }, + "patch": { + "tags": [ + "DnsResolverPolicyVirtualNetworkLinks" + ], + "operationId": "DnsResolverPolicyVirtualNetworkLinks_Update", + "description": "Updates a DNS resolver policy virtual network link.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyVirtualNetworkLinkNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsResolverPolicyVirtualNetworkLinkPatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The DNS resolver policy virtual network link has been updated.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicyVirtualNetworkLink" + } + }, + "202": { + "description": "The operation to update DNS resolver policy virtual network link has been accepted and will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update DNS resolver policy virtual network link": { + "$ref": "./examples/DnsResolverPolicyVirtualNetworkLink_Patch.json" + } + } + }, + "delete": { + "tags": [ + "DnsResolverPolicyVirtualNetworkLinks" + ], + "operationId": "DnsResolverPolicyVirtualNetworkLinks_Delete", + "description": "Deletes a DNS resolver policy virtual network link. WARNING: This operation cannot be undone.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyVirtualNetworkLinkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "202": { + "description": "The operation to delete the DNS resolver policy virtual network link has been accepted and will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "The DNS resolver policy virtual network link was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete DNS resolver policy virtual network link": { + "$ref": "./examples/DnsResolverPolicyVirtualNetworkLink_Delete.json" + } + } + }, + "get": { + "tags": [ + "DnsResolverPolicyVirtualNetworkLinks" + ], + "operationId": "DnsResolverPolicyVirtualNetworkLinks_Get", + "description": "Gets properties of a DNS resolver policy virtual network link.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyVirtualNetworkLinkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The DNS resolver policy virtual network link was found.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicyVirtualNetworkLink" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieve DNS resolver policy virtual network link": { + "$ref": "./examples/DnsResolverPolicyVirtualNetworkLink_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}/virtualNetworkLinks": { + "get": { + "tags": [ + "DnsResolverPolicyVirtualNetworkLinks" + ], + "operationId": "DnsResolverPolicyVirtualNetworkLinks_List", + "description": "Lists DNS resolver policy virtual network links.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS resolver policy virtual network links.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicyVirtualNetworkLinkListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS resolver policy virtual network links by DNS resolver policy": { + "$ref": "./examples/DnsResolverPolicyVirtualNetworkLink_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverDomainLists/{dnsResolverDomainListName}": { + "put": { + "tags": [ + "DnsResolverDomainLists" + ], + "operationId": "DnsResolverDomainLists_CreateOrUpdate", + "description": "Creates or updates a DNS resolver domain list.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverDomainListNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsResolverDomainList" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The DNS resolver domain list has been created.", + "schema": { + "$ref": "#/definitions/DnsResolverDomainList" + } + }, + "200": { + "description": "The DNS resolver domain list has been updated.", + "schema": { + "$ref": "#/definitions/DnsResolverDomainList" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upsert DNS resolver domain list": { + "$ref": "./examples/DnsResolverDomainList_Put.json" + } + } + }, + "patch": { + "tags": [ + "DnsResolverDomainLists" + ], + "operationId": "DnsResolverDomainLists_Update", + "description": "Updates a DNS resolver domain list.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverDomainListNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsResolverDomainListPatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The DNS resolver domain list has been updated.", + "schema": { + "$ref": "#/definitions/DnsResolverDomainList" + } + }, + "202": { + "description": "The operation to update DNS resolver domain list has been accepted and will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update DNS resolver domain list": { + "$ref": "./examples/DnsResolverDomainList_Patch.json" + } + } + }, + "delete": { + "tags": [ + "DnsResolverDomainLists" + ], + "operationId": "DnsResolverDomainLists_Delete", + "description": "Deletes a DNS resolver domain list. WARNING: This operation cannot be undone.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverDomainListNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "202": { + "description": "The operation to delete DNS resolver domain list has been accepted and will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "The DNS resolver domain list was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete DNS resolver domain list": { + "$ref": "./examples/DnsResolverDomainList_Delete.json" + } + } + }, + "get": { + "tags": [ + "DnsResolverDomainLists" + ], + "operationId": "DnsResolverDomainLists_Get", + "description": "Gets properties of a DNS resolver domain list.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverDomainListNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The DNS resolver domain list was found.", + "schema": { + "$ref": "#/definitions/DnsResolverDomainList" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieve DNS resolver domain list": { + "$ref": "./examples/DnsResolverDomainList_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverDomainLists": { + "get": { + "tags": [ + "DnsResolverDomainLists" + ], + "operationId": "DnsResolverDomainLists_ListByResourceGroup", + "description": "Lists DNS resolver domain lists within a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS resolver domain lists in the resource group.", + "schema": { + "$ref": "#/definitions/DnsResolverDomainListListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS resolver domain lists by resource group": { + "$ref": "./examples/DnsResolverDomainList_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/dnsResolverDomainLists": { + "get": { + "tags": [ + "DnsResolverDomainLists" + ], + "operationId": "DnsResolverDomainLists_List", + "description": "Lists DNS resolver domain lists in all resource groups of a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS resolver domain lists in the subscription.", + "schema": { + "$ref": "#/definitions/DnsResolverDomainListListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS resolver domain lists by subscription": { + "$ref": "./examples/DnsResolverDomainList_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/listDnsResolverPolicies": { + "post": { + "tags": [ + "DnsResolverPolicies" + ], + "operationId": "DnsResolverPolicies_ListByVirtualNetwork", + "description": "Lists DNS resolver policy resource IDs linked to a virtual network.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS resolver policy resource IDs linked to the virtual network.", + "schema": { + "$ref": "#/definitions/SubResourceListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS resolver policies by virtual network": { + "$ref": "./examples/DnsResolverPolicy_ListByVirtualNetwork.json" + } + } + } + } + }, + "definitions": { + "DnsResolverPolicyProperties": { + "description": "Represents the properties of a DNS resolver policy.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The current provisioning state of the DNS resolver policy. This is a read-only property and any attempt to set this value will be ignored.", + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "resourceGuid": { + "description": "The resourceGuid property of the DNS resolver policy resource.", + "readOnly": true, + "$ref": "#/definitions/ResourceGuid" + } + } + }, + "DnsResolverPolicy": { + "description": "Describes a DNS resolver policy.", + "type": "object", + "properties": { + "etag": { + "description": "ETag of the DNS resolver policy.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the DNS resolver policy.", + "$ref": "#/definitions/DnsResolverPolicyProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "DnsResolverPolicyPatch": { + "description": "Describes a DNS resolver policy for PATCH operation.", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Tags for DNS resolver policy." + } + } + }, + "DnsResolverPolicyListResult": { + "description": "The response to an enumeration operation on DNS resolver policies.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the DNS resolver policies.", + "type": "array", + "items": { + "$ref": "#/definitions/DnsResolverPolicy" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "DnsSecurityRuleProperties": { + "description": "Represents the properties of a DNS security rule.", + "type": "object", + "required": [ + "priority", + "action", + "dnsResolverDomainLists" + ], + "properties": { + "priority": { + "description": "The priority of the DNS security rule.", + "type": "integer", + "format": "int32", + "x-ms-mutability": [ + "read", + "create", + "update" + ] + }, + "action": { + "description": "The action to take on DNS requests that match the DNS security rule.", + "$ref": "#/definitions/DnsSecurityRuleAction" + }, + "dnsResolverDomainLists": { + "description": "DNS resolver policy domains lists that the DNS security rule applies to.", + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "x-ms-identifiers": [] + }, + "dnsSecurityRuleState": { + "type": "string", + "description": "The state of DNS security rule.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "DnsSecurityRuleState", + "modelAsString": true + } + }, + "provisioningState": { + "description": "The current provisioning state of the DNS security rule. This is a read-only property and any attempt to set this value will be ignored.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "DnsSecurityRule": { + "description": "Describes a DNS security rule.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "etag": { + "description": "ETag of the DNS security rule.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the DNS security rule.", + "$ref": "#/definitions/DnsSecurityRuleProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "DnsSecurityRulePatchProperties": { + "description": "Represents the updatable properties of a DNS security rule.", + "type": "object", + "properties": { + "action": { + "description": "The action to take on DNS requests that match the DNS security rule.", + "$ref": "#/definitions/DnsSecurityRuleAction" + }, + "dnsResolverDomainLists": { + "description": "DNS resolver policy domains lists that the DNS security rule applies to.", + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "x-ms-identifiers": [] + }, + "dnsSecurityRuleState": { + "type": "string", + "description": "The state of DNS security rule.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "DnsSecurityRuleState", + "modelAsString": true + } + }, + "priority": { + "description": "The priority of the DNS security rule.", + "type": "integer", + "format": "int32", + "x-ms-mutability": [ + "read", + "create", + "update" + ] + } + } + }, + "DnsSecurityRulePatch": { + "description": "Describes a DNS security rule for PATCH operation.", + "type": "object", + "properties": { + "properties": { + "description": "Updatable properties of the DNS security rule.", + "$ref": "#/definitions/DnsSecurityRulePatchProperties", + "x-ms-client-flatten": true + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Tags for DNS security rule." + } + } + }, + "DnsSecurityRuleListResult": { + "description": "The response to an enumeration operation on DNS security rules within a DNS resolver policy.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the DNS security rules.", + "type": "array", + "items": { + "$ref": "#/definitions/DnsSecurityRule" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "DnsSecurityRuleAction": { + "description": "The action to take on DNS requests that match the DNS security rule.", + "type": "object", + "properties": { + "actionType": { + "type": "string", + "description": "The type of action to take.", + "enum": [ + "Allow", + "Alert", + "Block" + ], + "x-ms-enum": { + "name": "actionType", + "modelAsString": true + } + }, + "blockResponseCode": { + "type": "string", + "description": "The response code for block actions.", + "enum": [ + "SERVFAIL" + ], + "x-ms-enum": { + "name": "BlockResponseCode", + "modelAsString": true + } + } + } + }, + "DnsResolverPolicyVirtualNetworkLinkProperties": { + "description": "Represents the properties of a DNS resolver policy virtual network link.", + "type": "object", + "required": [ + "virtualNetwork" + ], + "properties": { + "virtualNetwork": { + "description": "The reference to the virtual network. This cannot be changed after creation.", + "x-ms-mutability": [ + "read", + "create" + ], + "$ref": "#/definitions/SubResource" + }, + "provisioningState": { + "description": "The current provisioning state of the DNS resolver policy virtual network link. This is a read-only property and any attempt to set this value will be ignored.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "DnsResolverPolicyVirtualNetworkLink": { + "description": "Describes a DNS resolver policy virtual network link.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "etag": { + "description": "ETag of the DNS resolver policy virtual network link.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the DNS resolver policy virtual network link.", + "$ref": "#/definitions/DnsResolverPolicyVirtualNetworkLinkProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "DnsResolverPolicyVirtualNetworkLinkPatch": { + "description": "Describes a DNS resolver policy virtual network link for PATCH operation.", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Tags for the DNS resolver policy virtual network link." + } + } + }, + "DnsResolverPolicyVirtualNetworkLinkListResult": { + "description": "The response to an enumeration operation on DNS resolver policy virtual network links.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the DNS resolver policy virtual network links.", + "type": "array", + "items": { + "$ref": "#/definitions/DnsResolverPolicyVirtualNetworkLink" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "DnsResolverDomainListProperties": { + "description": "Represents the properties of a DNS resolver domain list.", + "type": "object", + "required": [ + "domains" + ], + "properties": { + "domains": { + "description": "The domains in the domain list.", + "type": "array", + "items": { + "type": "string" + } + }, + "provisioningState": { + "description": "The current provisioning state of the DNS resolver domain list. This is a read-only property and any attempt to set this value will be ignored.", + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "resourceGuid": { + "description": "The resourceGuid property of the DNS resolver domain list resource.", + "readOnly": true, + "$ref": "#/definitions/ResourceGuid" + } + } + }, + "DnsResolverDomainList": { + "description": "Describes a DNS resolver domain list.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "etag": { + "description": "ETag of the DNS resolver domain list.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the DNS resolver domain list.", + "$ref": "#/definitions/DnsResolverDomainListProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "DnsResolverDomainListPatchProperties": { + "description": "Represents the updatable properties of a DNS resolver domain list.", + "type": "object", + "properties": { + "domains": { + "description": "The domains in the domain list.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DnsResolverDomainListPatch": { + "description": "Describes a DNS resolver domain list for PATCH operation.", + "type": "object", + "properties": { + "properties": { + "description": "Updatable properties of the DNS resolver policy virtual network link.", + "$ref": "#/definitions/DnsResolverDomainListPatchProperties", + "x-ms-client-flatten": true + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Tags for DNS resolver domain list." + } + } + }, + "DnsResolverDomainListListResult": { + "description": "The response to an enumeration operation on DNS resolver domain lists.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the DNS resolver domain lists.", + "type": "array", + "items": { + "$ref": "#/definitions/DnsResolverDomainList" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ProvisioningState": { + "description": "The current provisioning state of the resource.", + "type": "string", + "readOnly": true, + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "ResourceGuid": { + "type": "string", + "description": "The Guid property of the resource." + }, + "SubResourceListResult": { + "description": "The response to an enumeration operation on sub-resources.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the sub-resources.", + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SubResource": { + "description": "Reference to another ARM resource.", + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + }, + "x-ms-azure-resource": true + } + }, + "parameters": { + "DnsResolverPolicyNameParameter": { + "name": "dnsResolverPolicyName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9_\\-]*[a-zA-Z0-9])?$", + "minLength": 1, + "maxLength": 80, + "description": "The name of the DNS resolver policy.", + "x-ms-parameter-location": "method" + }, + "DnsSecurityRuleNameParameter": { + "name": "dnsSecurityRuleName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9_\\-]*[a-zA-Z0-9])?$", + "minLength": 1, + "maxLength": 80, + "description": "The name of the DNS security rule.", + "x-ms-parameter-location": "method" + }, + "DnsResolverPolicyVirtualNetworkLinkNameParameter": { + "name": "dnsResolverPolicyVirtualNetworkLinkName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9_\\-]*[a-zA-Z0-9])?$", + "minLength": 1, + "maxLength": 80, + "description": "The name of the DNS resolver policy virtual network link for the DNS resolver policy.", + "x-ms-parameter-location": "method" + }, + "DnsResolverDomainListNameParameter": { + "name": "dnsResolverDomainListName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9_\\-]*[a-zA-Z0-9])?$", + "minLength": 1, + "maxLength": 80, + "description": "The name of the DNS resolver domain list.", + "x-ms-parameter-location": "method" + }, + "VirtualNetworkNameParameter": { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^.+$", + "minLength": 1, + "description": "The name of the virtual network.", + "x-ms-parameter-location": "method" + }, + "TopParameter": { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of results to return. If not specified, returns up to 100 results.", + "x-ms-parameter-location": "method" + }, + "IfMatchParameter": { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.", + "x-ms-parameter-location": "method" + }, + "IfNoneMatchParameter": { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfNoneMatch", + "description": "Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Delete.json new file mode 100644 index 000000000000..7107b1f637dd --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "samplednsForwardingRulesetName", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Get.json new file mode 100644 index 000000000000..94c2a7a063cf --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset", + "name": "sampleDnsForwardingRuleset", + "type": "Microsoft.Network/dnsForwardingRulesets", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "dnsResolverOutboundEndpoints": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint0" + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint1" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListByResourceGroup.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListByResourceGroup.json new file mode 100644 index 000000000000..1f05389ae97c --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListByResourceGroup.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset", + "name": "sampleDnsForwardingRuleset", + "type": "Microsoft.Network/dnsForwardingRulesets", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "dnsResolverOutboundEndpoints": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint0" + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint1" + } + ], + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset1", + "name": "sampleDnsForwardingRuleset", + "type": "Microsoft.Network/dnsForwardingRulesets", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-04T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-05T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "dnsResolverOutboundEndpoints": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint2" + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint3" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "c2aed17a-708d-48d1-89c3-d6a9b648d222" + } + } + ], + "nextLink": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListBySubscription.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListBySubscription.json new file mode 100644 index 000000000000..456dc7d6fb19 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListBySubscription.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset", + "name": "sampleDnsForwardingRuleset", + "type": "Microsoft.Network/dnsForwardingRulesets", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "dnsResolverOutboundEndpoints": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint0" + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint1" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset1", + "name": "sampleDnsForwardingRuleset", + "type": "Microsoft.Network/dnsForwardingRulesets", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-04T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-05T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "dnsResolverOutboundEndpoints": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint2" + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint3" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8" + } + } + ], + "nextLink": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/providers/Microsoft.Network/dnsForwardingRulesets?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListByVirtualNetwork.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListByVirtualNetwork.json new file mode 100644 index 000000000000..e525fd69f74c --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListByVirtualNetwork.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "virtualNetworkName": "sampleVirtualNetwork", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset", + "properties": { + "virtualNetworkLink": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRuleset/sampleDnsForwardingRuleset/virtualNetworkLinks/sampleVirtualNetworkLink" + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Patch.json new file mode 100644 index 000000000000..1b9900f9de3c --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Patch.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "api-version": "2023-07-01-preview", + "parameters": { + "tags": { + "key1": "value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset", + "name": "sampleDnsForwardingRuleset", + "type": "Microsoft.Network/dnsForwardingRulesets", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "dnsResolverOutboundEndpoints": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint0" + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint1" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Put.json new file mode 100644 index 000000000000..80d0d41b1f0b --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Put.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "samplednsForwardingRuleset", + "api-version": "2023-07-01-preview", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "westus2", + "properties": { + "dnsResolverOutboundEndpoints": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint0" + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint1" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset", + "name": "sampleDnsForwardingRuleset", + "type": "Microsoft.Network/dnsForwardingRulesets", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "dnsResolverOutboundEndpoints": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint0" + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint1" + } + ], + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8", + "provisioningState": "Succeeded" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset", + "name": "sampleDnsForwardingRuleset", + "type": "Microsoft.Network/dnsForwardingRulesets", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "dnsResolverOutboundEndpoints": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint0" + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint1" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Delete.json new file mode 100644 index 000000000000..34061d8643e9 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverDomainListName": "sampleDnsResolverDomainList", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Get.json new file mode 100644 index 000000000000..e8b62627ad8d --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverDomainListName": "sampleDnsResolverDomainList", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList", + "name": "sampleDnsResolverDomainList", + "type": "Microsoft.Network/dnsResolverDomainLists", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ], + "provisioningState": "Succeeded", + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_ListByResourceGroup.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_ListByResourceGroup.json new file mode 100644 index 000000000000..711a46672b21 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_ListByResourceGroup.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList1", + "name": "sampleDnsResolverDomainList1", + "type": "Microsoft.Network/dnsResolverDomainLists", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ], + "provisioningState": "Succeeded", + "resourceGuid": "ad9c8da4-3bb2-4821-a878-c2cb07b01fb6" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList2", + "name": "sampleDnsResolverDomainList2", + "type": "Microsoft.Network/dnsResolverDomainLists", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ], + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_ListBySubscription.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_ListBySubscription.json new file mode 100644 index 000000000000..3243f2b0f3c2 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_ListBySubscription.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList1", + "name": "sampleDnsResolverDomainList1", + "type": "Microsoft.Network/dnsResolverDomainLists", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ], + "provisioningState": "Succeeded", + "resourceGuid": "ad9c8da4-3bb2-4821-a878-c2cb07b01fb6" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList2", + "name": "sampleDnsResolverDomainList2", + "type": "Microsoft.Network/dnsResolverDomainLists", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ], + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/providers/Microsoft.Network/dnsResolverDomainLists?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Patch.json new file mode 100644 index 000000000000..d307656d2f7d --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Patch.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverDomainListName": "sampleDnsResolverDomainList", + "api-version": "2023-07-01-preview", + "parameters": { + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList", + "name": "sampleDnsResolverDomainList", + "type": "Microsoft.Network/dnsResolverDomainLists", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ], + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Put.json new file mode 100644 index 000000000000..b8f9bf2ddb5c --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Put.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverDomainListName": "sampleDnsResolverDomainList", + "api-version": "2023-07-01-preview", + "parameters": { + "location": "westus2", + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ] + } + } + }, + "responses": { + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + }, + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList", + "name": "sampleDnsResolverDomainList", + "type": "Microsoft.Network/dnsResolverDomainLists", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ], + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + }, + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + }, + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList", + "name": "sampleDnsResolverDomainList", + "type": "Microsoft.Network/dnsResolverDomainLists", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ], + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Delete.json new file mode 100644 index 000000000000..a1e86cff9cc2 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "dnsResolverPolicyVirtualNetworkLinkName": "sampleVirtualNetworkLink", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Get.json new file mode 100644 index 000000000000..348e02fd2b7d --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "dnsResolverPolicyVirtualNetworkLinkName": "sampleVirtualNetworkLink", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsResolverPolicies/virtualNetworkLinks", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_List.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_List.json new file mode 100644 index 000000000000..4a8f966a8a93 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_List.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsResolverPolicies/virtualNetworkLinks", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "provisioningState": "Succeeded" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Patch.json new file mode 100644 index 000000000000..8c89c19d29dd --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Patch.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "dnsResolverPolicyVirtualNetworkLinkName": "sampleVirtualNetworkLink", + "parameters": { + "tags": { + "key1": "value1" + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsResolverPolicies/virtualNetworkLinks", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Put.json new file mode 100644 index 000000000000..909d98942841 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Put.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "dnsResolverPolicyVirtualNetworkLinkName": "sampleVirtualNetworkLink", + "parameters": { + "location": "westus2", + "tags": { + "key1": "value1" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + } + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + }, + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicy/sampleDnsResolverPolicy/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsResolverPolicies/virtualNetworkLinks", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "provisioningState": "Succeeded" + } + } + }, + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + }, + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicy/sampleDnsResolverPolicy/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsResolverPolicies/virtualNetworkLinks", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Delete.json new file mode 100644 index 000000000000..7166c3551217 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Get.json new file mode 100644 index 000000000000..9a39f19360e0 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy", + "name": "sampleDnsResolverPolicy", + "type": "Microsoft.Network/dnsResolverPolicies", + "location": "westus2", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2023-07-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2023-07-04T02:03:01.1974346Z" + }, + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListByResourceGroup.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListByResourceGroup.json new file mode 100644 index 000000000000..32c0a6a472e1 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListByResourceGroup.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy1", + "name": "sampleDnsResolverPolicy1", + "type": "Microsoft.Network/dnsResolverPolicies", + "location": "westus2", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "ad9c8da4-3bb2-4821-a878-c2cb07b01fb6" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy2", + "name": "sampleDnsResolverPolicy2", + "type": "Microsoft.Network/dnsResolverPolicies", + "location": "westus2", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListBySubscription.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListBySubscription.json new file mode 100644 index 000000000000..9b8fedadb3e2 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListBySubscription.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy1", + "name": "sampleDnsResolverPolicy1", + "type": "Microsoft.Network/dnsResolverPolicies", + "location": "westus2", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "ad9c8da4-3bb2-4821-a878-c2cb07b01fb6" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy2", + "name": "sampleDnsResolverPolicy2", + "type": "Microsoft.Network/dnsResolverPolicies", + "location": "westus2", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/providers/Microsoft.Network/dnsResolverPolicies?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListByVirtualNetwork.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListByVirtualNetwork.json new file mode 100644 index 000000000000..34220c360186 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListByVirtualNetwork.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "virtualNetworkName": "sampleVirtualNetwork", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy1" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Patch.json new file mode 100644 index 000000000000..9539b679c7c4 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Patch.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "api-version": "2023-07-01-preview", + "parameters": { + "tags": { + "key1": "value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy", + "name": "sampleDnsResolverPolicy", + "type": "Microsoft.Network/dnsResolverPolicies", + "location": "westus2", + "tags": { + "key1": "value1" + }, + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Put.json new file mode 100644 index 000000000000..e6fb7d148f45 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Put.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "api-version": "2023-07-01-preview", + "parameters": { + "location": "westus2", + "tags": { + "key1": "value1" + } + } + }, + "responses": { + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + }, + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy", + "name": "sampleDnsResolverPolicy", + "type": "Microsoft.Network/dnsResolverPolicies", + "location": "westus2", + "tags": { + "key1": "value1" + }, + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + }, + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + }, + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy", + "name": "sampleDnsResolverPolicy", + "type": "Microsoft.Network/dnsResolverPolicies", + "location": "westus2", + "tags": { + "key1": "value1" + }, + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Delete.json new file mode 100644 index 000000000000..ff36658d7bcb --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Get.json new file mode 100644 index 000000000000..a7e6b4c97012 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver", + "name": "sampleDnsResolver", + "type": "Microsoft.Network/dnsResolvers", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/cbb1387e-4b03-44f2-ad41-58d4677b9873/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "dnsResolverState": "Connected", + "provisioningState": "Succeeded", + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListByResourceGroup.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListByResourceGroup.json new file mode 100644 index 000000000000..83152bce7a58 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListByResourceGroup.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver1", + "name": "sampleDnsResolver1", + "type": "Microsoft.Network/dnsResolvers", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/cbb1387e-4b03-44f2-ad41-58d4677b9873/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork1" + }, + "dnsResolverState": "Connected", + "provisioningState": "Succeeded", + "resourceGuid": "ad9c8da4-3bb2-4821-a878-c2cb07b01fb6" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver2", + "name": "sampleDnsResolver2", + "type": "Microsoft.Network/dnsResolvers", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/cbb1387e-4b03-44f2-ad41-58d4677b9873/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork2" + }, + "dnsResolverState": "Connected", + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + ], + "nextLink": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListBySubscription.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListBySubscription.json new file mode 100644 index 000000000000..fdd09c22f0da --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListBySubscription.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver1", + "name": "sampleDnsResolver1", + "type": "Microsoft.Network/dnsResolvers", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/cbb1387e-4b03-44f2-ad41-58d4677b9873/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork1" + }, + "dnsResolverState": "Connected", + "provisioningState": "Succeeded", + "resourceGuid": "ad9c8da4-3bb2-4821-a878-c2cb07b01fb6" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver2", + "name": "sampleDnsResolver2", + "type": "Microsoft.Network/dnsResolvers", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/cbb1387e-4b03-44f2-ad41-58d4677b9873/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork2" + }, + "dnsResolverState": "Connected", + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + ], + "nextLink": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/providers/Microsoft.Network/dnsResolvers?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListByVirtualNetwork.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListByVirtualNetwork.json new file mode 100644 index 000000000000..9a2771152b70 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListByVirtualNetwork.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "virtualNetworkName": "sampleVirtualNetwork", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver1" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Patch.json new file mode 100644 index 000000000000..819a87624dbf --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Patch.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "api-version": "2023-07-01-preview", + "parameters": { + "tags": { + "key1": "value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver", + "name": "sampleDnsResolver", + "type": "Microsoft.Network/dnsResolvers", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/cbb1387e-4b03-44f2-ad41-58d4677b9873/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "dnsResolverState": "Connected", + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Put.json new file mode 100644 index 000000000000..20abcb40c39c --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Put.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "api-version": "2023-07-01-preview", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "westus2", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/cbb1387e-4b03-44f2-ad41-58d4677b9873/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver", + "name": "sampleDnsResolver", + "type": "Microsoft.Network/dnsResolvers", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/cbb1387e-4b03-44f2-ad41-58d4677b9873/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "dnsResolverState": "Connected", + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver", + "name": "sampleDnsResolver", + "type": "Microsoft.Network/dnsResolvers", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/cbb1387e-4b03-44f2-ad41-58d4677b9873/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "dnsResolverState": "Connected", + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Delete.json new file mode 100644 index 000000000000..3734714233b6 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsDnsResolverPolicy", + "dnsSecurityRuleName": "sampleDnsSecurityRule", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Get.json new file mode 100644 index 000000000000..7e9cd2ffa48c --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "dnsSecurityRuleName": "sampleDnsSecurityRule", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy/dnsSecurityRules/sampleDnsSecurityRule", + "name": "sampleDnsSecurityRule", + "type": "Microsoft.Network/dnsResolverPolicies/dnsSecurityRules", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "priority": 100, + "action": { + "actionType": "Block", + "blockResponseCode": "SERVFAIL" + }, + "dnsResolverDomainLists": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList" + } + ], + "dnsSecurityRuleState": "Enabled", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_List.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_List.json new file mode 100644 index 000000000000..448035790b96 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_List.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy/dnsSecurityRules/sampleDnsSecurityRule", + "name": "sampleDnsSecurityRule", + "type": "Microsoft.Network/dnsResolverPolicies/dnsSecurityRules", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "priority": 100, + "action": { + "actionType": "Block", + "blockResponseCode": "SERVFAIL" + }, + "dnsResolverDomainLists": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList" + } + ], + "dnsSecurityRuleState": "Enabled", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy/dnsSecurityRules/sampleDnsSecurityRule1", + "name": "sampleDnsSecurityRule1", + "type": "Microsoft.Network/dnsResolverPolicies/dnsSecurityRules", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "priority": 101, + "action": { + "actionType": "Block", + "blockResponseCode": "SERVFAIL" + }, + "dnsResolverDomainLists": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList1" + } + ], + "dnsSecurityRuleState": "Enabled", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsSecurityRules?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Patch.json new file mode 100644 index 000000000000..4b1acec7f6ca --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Patch.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "dnsSecurityRuleName": "sampleDnsSecurityRule", + "parameters": { + "properties": { + "dnsSecurityRuleState": "Disabled" + }, + "tags": { + "key1": "value1" + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy/dnsSecurityRules/sampleDnsSecurityRule", + "name": "sampleDnsSecurityRule", + "type": "Microsoft.Network/dnsResolverPolicies/dnsSecurityRules", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "priority": 100, + "action": { + "actionType": "Allow" + }, + "dnsResolverDomainLists": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList2" + } + ], + "dnsSecurityRuleState": "Disabled", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Put.json new file mode 100644 index 000000000000..afa3dc4c5de8 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Put.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "dnsSecurityRuleName": "sampleDnsSecurityRule", + "parameters": { + "location": "westus2", + "tags": { + "key1": "value1" + }, + "properties": { + "priority": 100, + "action": { + "actionType": "Block", + "blockResponseCode": "SERVFAIL" + }, + "dnsResolverDomainLists": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList" + } + ], + "dnsSecurityRuleState": "Enabled" + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + }, + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy/dnsSecurityRules/sampleDnsSecurityRule", + "name": "sampleDnsSecurityRule", + "type": "Microsoft.Network/dnsResolverPolicies/dnsSecurityRules", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "priority": 100, + "action": { + "actionType": "Block", + "blockResponseCode": "SERVFAIL" + }, + "dnsResolverDomainLists": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList" + } + ], + "dnsSecurityRuleState": "Enabled", + "provisioningState": "Succeeded" + } + } + }, + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + }, + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy/dnsSecurityRules/sampleDnsSecurityRule", + "name": "sampleDnsSecurityRule", + "type": "Microsoft.Network/dnsResolverPolicies/dnsSecurityRules", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "priority": 100, + "action": { + "actionType": "Block", + "blockResponseCode": "SERVFAIL" + }, + "dnsResolverDomainLists": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList" + } + ], + "dnsSecurityRuleState": "Enabled", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Delete.json new file mode 100644 index 000000000000..9d00277a78eb --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "forwardingRuleName": "sampleForwardingRule", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Get.json new file mode 100644 index 000000000000..475971f47cae --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "forwardingRuleName": "sampleForwardingRule", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset/forwardingRules/sampleForwardingRule", + "name": "sampleForwardingRule", + "type": "Microsoft.Network/dnsForwardingRulesets/forwardingRules", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "domainName": "contoso.com.", + "targetDnsServers": [ + { + "ipAddress": "10.0.0.1", + "port": 53 + }, + { + "ipAddress": "10.0.0.2", + "port": 53 + } + ], + "metadata": { + "additionalProp1": "value1" + }, + "forwardingRuleState": "Enabled", + "provisioningState": "Succecced" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_List.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_List.json new file mode 100644 index 000000000000..18d7ad15ec3e --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_List.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset/forwardingRules/sampleForwardingRule", + "name": "sampleForwardingRule", + "type": "Microsoft.Network/dnsForwardingRulesets/forwardingRules", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "domainName": "contoso.com.", + "targetDnsServers": [ + { + "ipAddress": "10.0.0.1", + "port": 53 + }, + { + "ipAddress": "10.0.0.2", + "port": 53 + } + ], + "metadata": { + "additionalProp1": "value1" + }, + "forwardingRuleState": "Enabled", + "provisioningState": "Succecced" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset/forwardingRules/sampleForwardingRule1", + "name": "sampleForwardingRule1", + "type": "Microsoft.Network/dnsForwardingRulesets/forwardingRules", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "domainName": "foobar.com.", + "targetDnsServers": [ + { + "ipAddress": "10.0.0.3", + "port": 53 + }, + { + "ipAddress": "10.0.0.4", + "port": 53 + } + ], + "metadata": { + "additionalProp1": "value1" + }, + "forwardingRuleState": "Enabled", + "provisioningState": "Succecced" + } + } + ], + "nextLink": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/forwardingRules?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Patch.json new file mode 100644 index 000000000000..26a2bc01e5fb --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Patch.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "forwardingRuleName": "sampleForwardingRule", + "parameters": { + "properties": { + "forwardingRuleState": "Disabled", + "metadata": { + "additionalProp2": "value2" + } + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset/forwardingRules/sampleForwardingRule", + "name": "sampleForwardingRule", + "type": "Microsoft.Network/dnsForwardingRulesets/forwardingRules", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "domainName": "contoso.com.", + "targetDnsServers": [ + { + "ipAddress": "10.0.0.1", + "port": 53 + }, + { + "ipAddress": "10.0.0.2", + "port": 53 + } + ], + "metadata": { + "additionalProp2": "value2" + }, + "forwardingRuleState": "Disabled", + "provisioningState": "Succecced" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Put.json new file mode 100644 index 000000000000..e3872ac7093d --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Put.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "forwardingRuleName": "sampleForwardingRule", + "parameters": { + "properties": { + "domainName": "contoso.com.", + "targetDnsServers": [ + { + "ipAddress": "10.0.0.1", + "port": 53 + }, + { + "ipAddress": "10.0.0.2", + "port": 53 + } + ], + "forwardingRuleState": "Enabled", + "metadata": { + "additionalProp1": "value1" + } + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset/forwardingRules/sampleForwardingRule", + "name": "sampleForwardingRule", + "type": "Microsoft.Network/dnsForwardingRulesets/forwardingRules", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "domainName": "contoso.com.", + "targetDnsServers": [ + { + "ipAddress": "10.0.0.1", + "port": 53 + }, + { + "ipAddress": "10.0.0.2", + "port": 53 + } + ], + "metadata": { + "additionalProp1": "value1" + }, + "forwardingRuleState": "Enabled", + "provisioningState": "Succecced" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset/forwardingRules/sampleForwardingRule", + "name": "sampleForwardingRule", + "type": "Microsoft.Network/dnsForwardingRulesets/forwardingRules", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "domainName": "contoso.com.", + "targetDnsServers": [ + { + "ipAddress": "10.0.0.1", + "port": 53 + }, + { + "ipAddress": "10.0.0.2", + "port": 53 + } + ], + "metadata": { + "additionalProp1": "value1" + }, + "forwardingRuleState": "Enabled", + "provisioningState": "Succecced" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Delete.json new file mode 100644 index 000000000000..ce839e23f78d --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "inboundEndpointName": "sampleInboundEndpoint", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Get.json new file mode 100644 index 000000000000..e5e6970c510b --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "inboundEndpointName": "sampleInboundEndpoint", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/inboundEndpoints/sampleInboundEndpoint", + "name": "sampleInboundEndpoint", + "type": "Microsoft.Network/dnsResolvers/inboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "ipConfigurations": [ + { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "privateIpAddress": "255.255.255.255", + "privateIpAllocationMethod": "Dynamic" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_List.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_List.json new file mode 100644 index 000000000000..24a014617a36 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_List.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/inboundEndpoints/sampleInboundEndpoint1", + "name": "sampleInboundEndpoint1", + "type": "Microsoft.Network/dnsResolvers/inboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "ipConfigurations": [ + { + "subnet": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet1" + }, + "privateIpAddress": "255.1.255.1", + "privateIpAllocationMethod": "Dynamic" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/inboundEndpoints/sampleInboundEndpoint2", + "name": "sampleInboundEndpoint2", + "type": "Microsoft.Network/dnsResolvers/inboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-02T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-03T02:03:01.1974346Z" + }, + "properties": { + "ipConfigurations": [ + { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet1" + }, + "privateIpAddress": "1.1.255.1", + "privateIpAllocationMethod": "Dynamic" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "87b3e20a-5833-4c40-8ad7-c5160bb1c5bd" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Patch.json new file mode 100644 index 000000000000..11cf34e59b76 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Patch.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "inboundEndpointName": "sampleInboundEndpoint", + "parameters": { + "tags": { + "key1": "value1" + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/inboundEndpoints/sampleInboundEndpoint", + "name": "sampleInboundEndpoint", + "type": "Microsoft.Network/dnsResolvers/inboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "ipConfigurations": [ + { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "privateIpAddress": "255.255.255.255", + "privateIpAllocationMethod": "Dynamic" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "87b3e20a-5833-4c40-8ad7-c5160bb1c5bd" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Put.json new file mode 100644 index 000000000000..8ca756400a75 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Put.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "inboundEndpointName": "sampleInboundEndpoint", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "westus2", + "properties": { + "ipConfigurations": [ + { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "privateIpAllocationMethod": "Dynamic" + } + ] + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/inboundEndpoints/sampleInboundEndpoint", + "name": "sampleInboundEndpoint", + "type": "Microsoft.Network/dnsResolvers/inboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "ipConfigurations": [ + { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "privateIpAddress": "255.255.255.255", + "privateIpAllocationMethod": "Dynamic" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/inboundEndpoints/sampleInboundEndpoint", + "name": "sampleInboundEndpoint", + "type": "Microsoft.Network/dnsResolvers/inboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "ipConfigurations": [ + { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "privateIpAddress": "255.255.255.255", + "privateIpAllocationMethod": "Dynamic" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "87b3e20a-5833-4c40-8ad7-c5160bb1c5bd" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Delete.json new file mode 100644 index 000000000000..fa4e867cc925 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "outboundEndpointName": "sampleOutboundEndpoint", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Get.json new file mode 100644 index 000000000000..7378b3bfd102 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "outboundEndpointName": "sampleOutboundEndpoint", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/outboundEndpoints/sampleOutboundEndpoint", + "name": "sampleOutboundEndpoint", + "type": "Microsoft.Network/dnsResolvers/outboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "provisioningState": "Succecced", + "resourceGuid": "b4d35f41-0c70-4ec7-bb3e-0cd9f8b7e4be" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_List.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_List.json new file mode 100644 index 000000000000..8af4a68dee0e --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_List.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/outboundEndpoints/sampleOutboundEndpoint", + "name": "sampleOutboundEndpoint", + "type": "Microsoft.Network/dnsResolvers/outboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "provisioningState": "Succeeded", + "resourceGuid": "b4d35f41-0c70-4ec7-bb3e-0cd9f8b7e4be" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/outboundEndpoints/sampleOutboundEndpoint1", + "name": "sampleOutboundEndpoint1", + "type": "Microsoft.Network/dnsResolvers/outboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet1" + }, + "provisioningState": "Succecced", + "resourceGuid": "b4d35f41-0c70-4ec7-bb3e-0cd9f8b7e4be" + } + } + ], + "nextLink": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/outboundEndpoints?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Patch.json new file mode 100644 index 000000000000..0d0f9a015690 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Patch.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "outboundEndpointName": "sampleOutboundEndpoint", + "parameters": { + "tags": { + "key1": "value1" + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/outboundEndpoints/sampleOutboundEndpoint", + "name": "sampleOutboundEndpoint", + "type": "Microsoft.Network/dnsResolvers/outboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "provisioningState": "Succecced", + "resourceGuid": "b4d35f41-0c70-4ec7-bb3e-0cd9f8b7e4be" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Put.json new file mode 100644 index 000000000000..a5c3ac17745e --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Put.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "outboundEndpointName": "sampleOutboundEndpoint", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "westus2", + "properties": { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + } + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/outboundEndpoints/sampleOutboundEndpoint", + "name": "sampleOutboundEndpoint", + "type": "Microsoft.Network/dnsResolvers/outboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "provisioningState": "Succeeded" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/outboundEndpoints/sampleOutboundEndpoint", + "name": "sampleOutboundEndpoint", + "type": "Microsoft.Network/dnsResolvers/outboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "provisioningState": "Succeeded", + "resourceGuid": "87b3e20a-5833-4c40-8ad7-c5160bb1c5bd" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Delete.json new file mode 100644 index 000000000000..d9db418ffa06 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "virtualNetworkLinkName": "sampleVirtualNetworkLink", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Get.json new file mode 100644 index 000000000000..96c759001524 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "virtualNetworkLinkName": "sampleVirtualNetworkLink", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRuleset/sampleDnsForwardingRuleset/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsForwardingRulesets/virtualNetworkLinks", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "metadata": { + "additionalProp1": "value1" + }, + "provisioningState": "Succecced" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_List.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_List.json new file mode 100644 index 000000000000..0a4a10302b09 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_List.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRuleset/sampleDnsForwardingRuleset/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsForwardingRulesets/virtualNetworkLinks", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "metadata": { + "additionalProp1": "value1" + }, + "provisioningState": "Succecced" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Patch.json new file mode 100644 index 000000000000..88473b3dbd0d --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Patch.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "virtualNetworkLinkName": "sampleVirtualNetworkLink", + "parameters": { + "properties": { + "metadata": { + "additionalProp1": "value1" + } + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRuleset/sampleDnsForwardingRuleset/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsForwardingRulesets/virtualNetworkLinks", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "metadata": { + "additionalProp1": "value1" + }, + "provisioningState": "Succecced" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Put.json new file mode 100644 index 000000000000..369f23d834ed --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Put.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "virtualNetworkLinkName": "sampleVirtualNetworkLink", + "parameters": { + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "metadata": { + "additionalProp1": "value1" + } + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRuleset/sampleDnsForwardingRuleset/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsForwardingRulesets/virtualNetworkLinks", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "metadata": { + "additionalProp1": "value1" + }, + "provisioningState": "Succecced" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRuleset/sampleDnsForwardingRuleset/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsForwardingRulesets/virtualNetworkLinks", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "metadata": { + "additionalProp1": "value1" + }, + "provisioningState": "Succecced" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/readme.md b/specification/dnsresolver/resource-manager/readme.md index 1143e778efef..b31bbb537eb1 100644 --- a/specification/dnsresolver/resource-manager/readme.md +++ b/specification/dnsresolver/resource-manager/readme.md @@ -25,8 +25,20 @@ To see additional help and options, run: These are the global settings for the DNS resolver API. ``` yaml +title: DnsResolverManagementClient +description: DNS Resolver Client openapi-type: arm -tag: package-2022-07 +tag: package-preview-2023-07 +``` + +### Tag: package-preview-2023-07 + +These settings apply only when `--tag=package-preview-2023-07` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-07' +input-file: + - Microsoft.Network/preview/2023-07-01-preview/dnsresolver.json + - Microsoft.Network/preview/2023-07-01-preview/dnsresolverpolicy.json ``` ### Tag: package-2022-07 @@ -57,7 +69,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net-track2 - - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-go - repo: azure-powershell ``` @@ -129,4 +141,3 @@ uncomment the `exclude-file` section below and add the file paths. #exclude-file: # - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json ``` - From 44a7e86977128152e8f364abd7104c26a2c20e55 Mon Sep 17 00:00:00 2001 From: gubalasu <59630928+gubalasu@users.noreply.github.com> Date: Fri, 27 Sep 2024 10:17:56 -0700 Subject: [PATCH 09/47] Add new API version 2024-09-01 for Microsoft.Cdn (#30309) * Copy 2024-02-01 version to create 2024-09-01 version * Update readme.md * Changes for the new api version * Update readme.md * Fix api versions in examples * Update description * Update cdn.json Attempting to address lintdiff * Update cdn.json * Update cdn.json * Fix validation * Update cdn.json * Update sdk-suppressions.yaml * Update sdk-suppressions.yaml * Update readme.md * Update readme.md * Update specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdn.json Co-authored-by: Chenjie Shi * Update specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdn.json Co-authored-by: Chenjie Shi --------- Co-authored-by: Yuchao Yan Co-authored-by: Chenglong Liu <48578056+ChenglongLiu@users.noreply.github.com> Co-authored-by: Chenjie Shi --- .../Microsoft.Cdn/stable/2024-09-01/afdx.json | 6310 ++++++++++++++ .../Microsoft.Cdn/stable/2024-09-01/cdn.json | 7466 +++++++++++++++++ .../2024-09-01/cdnwebapplicationfirewall.json | 977 +++ .../examples/AFDCustomDomains_Create.json | 119 + .../examples/AFDCustomDomains_Delete.json | 18 + .../examples/AFDCustomDomains_Get.json | 42 + .../AFDCustomDomains_ListByProfile.json | 45 + ...DCustomDomains_RefreshValidationToken.json | 17 + .../examples/AFDCustomDomains_Update.json | 87 + .../examples/AFDEndpoints_Create.json | 70 + .../examples/AFDEndpoints_Delete.json | 18 + .../2024-09-01/examples/AFDEndpoints_Get.json | 27 + .../examples/AFDEndpoints_ListByProfile.json | 30 + .../AFDEndpoints_ListResourceUsage.json | 27 + .../examples/AFDEndpoints_PurgeContent.json | 25 + .../examples/AFDEndpoints_Update.json | 52 + .../AFDEndpoints_ValidateCustomDomain.json | 21 + .../examples/AFDOriginGroups_Create.json | 99 + .../examples/AFDOriginGroups_Delete.json | 18 + .../examples/AFDOriginGroups_Get.json | 34 + .../AFDOriginGroups_ListByProfile.json | 37 + .../AFDOriginGroups_ListResourceUsage.json | 27 + .../examples/AFDOriginGroups_Update.json | 76 + .../examples/AFDOrigins_Create.json | 87 + .../examples/AFDOrigins_Delete.json | 19 + .../2024-09-01/examples/AFDOrigins_Get.json | 33 + .../AFDOrigins_ListByOriginGroup.json | 36 + .../examples/AFDOrigins_Update.json | 65 + ...rofiles_CheckEndpointNameAvailability.json | 23 + ...AFDProfiles_CheckHostNameAvailability.json | 20 + .../AFDProfiles_ListResourceUsage.json | 26 + .../examples/AFDProfiles_Upgrade.json | 63 + .../examples/AFDProfiles_ValidateSecret.json | 22 + .../examples/CdnProfiles_CanMigrate.json | 26 + .../examples/CdnProfiles_Migrate.json | 31 + .../CheckEndpointNameAvailability.json | 22 + .../examples/CheckNameAvailability.json | 18 + ...CheckNameAvailabilityWithSubscription.json | 19 + .../examples/CustomDomains_Create.json | 65 + .../examples/CustomDomains_Delete.json | 32 + .../CustomDomains_DisableCustomHttps.json | 45 + ...tomDomains_EnableCustomHttpsUsingBYOC.json | 60 + ...CustomHttpsUsingCDNManagedCertificate.json | 54 + .../examples/CustomDomains_Get.json | 27 + .../CustomDomains_ListByEndpoint.json | 30 + .../2024-09-01/examples/EdgeNodes_List.json | 107 + .../2024-09-01/examples/Endpoints_Create.json | 546 ++ .../2024-09-01/examples/Endpoints_Delete.json | 18 + .../2024-09-01/examples/Endpoints_Get.json | 79 + .../examples/Endpoints_ListByProfile.json | 86 + .../examples/Endpoints_ListResourceUsage.json | 29 + .../examples/Endpoints_LoadContent.json | 22 + .../examples/Endpoints_PurgeContent.json | 22 + .../2024-09-01/examples/Endpoints_Start.json | 86 + .../2024-09-01/examples/Endpoints_Stop.json | 86 + .../2024-09-01/examples/Endpoints_Update.json | 141 + .../Endpoints_ValidateCustomDomain.json | 21 + ...LogAnalytics_GetLogAnalyticsLocations.json | 60 + .../LogAnalytics_GetLogAnalyticsMetrics.json | 71 + .../LogAnalytics_GetLogAnalyticsRankings.json | 82 + ...LogAnalytics_GetLogAnalyticsResources.json | 55 + ...ogAnalytics_GetWafLogAnalyticsMetrics.json | 132 + ...gAnalytics_GetWafLogAnalyticsRankings.json | 42 + .../2024-09-01/examples/Operations_List.json | 93 + .../examples/OriginGroups_Create.json | 112 + .../examples/OriginGroups_Delete.json | 19 + .../2024-09-01/examples/OriginGroups_Get.json | 44 + .../examples/OriginGroups_ListByEndpoint.json | 41 + .../examples/OriginGroups_Update.json | 74 + .../2024-09-01/examples/Origins_Create.json | 95 + .../2024-09-01/examples/Origins_Delete.json | 19 + .../2024-09-01/examples/Origins_Get.json | 33 + .../examples/Origins_ListByEndpoint.json | 36 + .../2024-09-01/examples/Origins_Update.json | 68 + .../examples/Profiles_CanMigrate.json | 31 + .../2024-09-01/examples/Profiles_Create.json | 98 + .../2024-09-01/examples/Profiles_Delete.json | 17 + .../examples/Profiles_GenerateSsoUri.json | 15 + .../2024-09-01/examples/Profiles_Get.json | 33 + .../2024-09-01/examples/Profiles_List.json | 56 + .../Profiles_ListByResourceGroup.json | 57 + .../examples/Profiles_ListResourceUsage.json | 22 + ...ofiles_ListSupportedOptimizationTypes.json | 18 + .../2024-09-01/examples/Profiles_Migrate.json | 43 + .../examples/Profiles_MigrationAbort.json | 15 + .../examples/Profiles_MigrationCommit.json | 16 + .../2024-09-01/examples/Profiles_Update.json | 68 + .../examples/ResourceUsage_List.json | 20 + .../2024-09-01/examples/Routes_Create.json | 196 + .../2024-09-01/examples/Routes_Delete.json | 19 + .../2024-09-01/examples/Routes_Get.json | 59 + .../examples/Routes_ListByEndpoint.json | 62 + .../2024-09-01/examples/Routes_Update.json | 148 + .../2024-09-01/examples/RuleSets_Create.json | 33 + .../2024-09-01/examples/RuleSets_Delete.json | 18 + .../2024-09-01/examples/RuleSets_Get.json | 22 + .../examples/RuleSets_ListByProfile.json | 25 + .../examples/RuleSets_ListResourceUsage.json | 27 + .../2024-09-01/examples/Rules_Create.json | 158 + .../2024-09-01/examples/Rules_Delete.json | 19 + .../stable/2024-09-01/examples/Rules_Get.json | 50 + .../examples/Rules_ListByRuleSet.json | 53 + .../2024-09-01/examples/Rules_Update.json | 107 + .../2024-09-01/examples/Secrets_Create.json | 107 + .../2024-09-01/examples/Secrets_Delete.json | 18 + .../2024-09-01/examples/Secrets_Get.json | 38 + .../examples/Secrets_ListByProfile.json | 55 + .../examples/SecurityPolicies_Create.json | 135 + .../examples/SecurityPolicies_Delete.json | 18 + .../examples/SecurityPolicies_Get.json | 43 + .../SecurityPolicies_ListByProfile.json | 46 + .../examples/SecurityPolicies_Patch.json | 103 + .../2024-09-01/examples/ValidateProbe.json | 18 + .../examples/WafListManagedRuleSets.json | 53 + .../2024-09-01/examples/WafListPolicies.json | 265 + .../2024-09-01/examples/WafPatchPolicy.json | 275 + .../examples/WafPolicyCreateOrUpdate.json | 508 ++ .../2024-09-01/examples/WafPolicyDelete.json | 12 + .../2024-09-01/examples/WafPolicyGet.json | 139 + .../AFDProfiles_Upgrade_WithoutWaf.yaml | 28 + specification/cdn/resource-manager/readme.md | 16 +- .../resource-manager/sdk-suppressions.yaml | 37 + 122 files changed, 22202 insertions(+), 1 deletion(-) create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/afdx.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdn.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdnwebapplicationfirewall.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_RefreshValidationToken.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ListResourceUsage.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_PurgeContent.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ValidateCustomDomain.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_ListResourceUsage.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_ListByOriginGroup.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_CheckEndpointNameAvailability.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_CheckHostNameAvailability.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_ListResourceUsage.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_Upgrade.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_ValidateSecret.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CdnProfiles_CanMigrate.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CdnProfiles_Migrate.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckEndpointNameAvailability.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckNameAvailability.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckNameAvailabilityWithSubscription.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_DisableCustomHttps.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_ListByEndpoint.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/EdgeNodes_List.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ListResourceUsage.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_LoadContent.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_PurgeContent.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Start.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Stop.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ValidateCustomDomain.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsLocations.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsMetrics.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsRankings.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsResources.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetWafLogAnalyticsMetrics.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetWafLogAnalyticsRankings.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Operations_List.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_ListByEndpoint.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_ListByEndpoint.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_CanMigrate.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_GenerateSsoUri.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_List.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListByResourceGroup.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListResourceUsage.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListSupportedOptimizationTypes.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Migrate.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_MigrationAbort.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_MigrationCommit.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/ResourceUsage_List.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_ListByEndpoint.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_ListResourceUsage.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_ListByRuleSet.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Patch.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/ValidateProbe.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafListManagedRuleSets.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafListPolicies.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPatchPolicy.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyCreateOrUpdate.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyDelete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyGet.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/scenarios/AFDProfiles_Upgrade_WithoutWaf.yaml diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/afdx.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/afdx.json new file mode 100644 index 000000000000..0d5a749bea04 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/afdx.json @@ -0,0 +1,6310 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-09-01", + "title": "CdnManagementClient", + "description": "Use these APIs to manage Azure Front Door resources through the Azure Resource Manager. You must make sure that requests made to these resources are secure." + }, + "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.Cdn/checkEndpointNameAvailability": { + "post": { + "tags": [ + "CheckEndpointNameAvailability" + ], + "description": "Check the availability of a resource name. This is needed for resources where name is globally unique, such as a afdx endpoint.", + "operationId": "CheckEndpointNameAvailability", + "x-ms-examples": { + "CheckEndpointNameAvailability": { + "$ref": "./examples/CheckEndpointNameAvailability.json" + } + }, + "parameters": [ + { + "name": "checkEndpointNameAvailabilityInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckEndpointNameAvailabilityInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckEndpointNameAvailabilityOutput" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/checkEndpointNameAvailability": { + "post": { + "tags": [ + "AFDProfiles" + ], + "description": "Check the availability of an afdx endpoint name, and return the globally unique endpoint host name.", + "operationId": "AFDProfiles_CheckEndpointNameAvailability", + "x-ms-examples": { + "CheckEndpointNameAvailability": { + "$ref": "./examples/AFDProfiles_CheckEndpointNameAvailability.json" + } + }, + "parameters": [ + { + "name": "checkEndpointNameAvailabilityInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckEndpointNameAvailabilityInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/profileNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckEndpointNameAvailabilityOutput" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/usages": { + "post": { + "tags": [ + "AFDProfiles" + ], + "description": "Checks the quota and actual usage of endpoints under the given Azure Front Door profile.", + "operationId": "AFDProfiles_ListResourceUsage", + "x-ms-examples": { + "AFDProfiles_ListResourceUsage": { + "$ref": "./examples/AFDProfiles_ListResourceUsage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsagesListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/checkHostNameAvailability": { + "post": { + "tags": [ + "AFDProfiles" + ], + "description": "Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS.", + "operationId": "AFDProfiles_CheckHostNameAvailability", + "x-ms-examples": { + "AFDProfiles_CheckHostNameAvailability": { + "$ref": "./examples/AFDProfiles_CheckHostNameAvailability.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "checkHostNameAvailabilityInput", + "in": "body", + "description": "Custom domain to be validated.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckHostNameAvailabilityInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "./cdn.json#/definitions/CheckNameAvailabilityOutput" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/validateSecret": { + "post": { + "tags": [ + "AFDProfiles" + ], + "description": "Validate a Secret in the profile.", + "operationId": "AFDProfiles_ValidateSecret", + "x-ms-examples": { + "Validate_Secret": { + "$ref": "./examples/AFDProfiles_ValidateSecret.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/profileNameParameter" + }, + { + "name": "validateSecretInput", + "in": "body", + "description": "The Secret source.", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateSecretInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ValidateSecretOutput" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/upgrade": { + "post": { + "tags": [ + "AFDProfiles" + ], + "description": "Upgrade a profile from Standard_AzureFrontDoor to Premium_AzureFrontDoor.", + "operationId": "AFDProfiles_Upgrade", + "x-ms-examples": { + "AFDProfiles_Upgrade": { + "$ref": "./examples/AFDProfiles_Upgrade.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/profileNameParameter" + }, + { + "name": "profileUpgradeParameters", + "in": "body", + "description": "Profile upgrade input parameter.", + "required": true, + "schema": { + "$ref": "#/definitions/ProfileUpgradeParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "./cdn.json#/definitions/Profile" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "./cdn.json#/definitions/Profile" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains": { + "get": { + "tags": [ + "AFDCustomDomains" + ], + "description": "Lists existing AzureFrontDoor domains.", + "operationId": "AFDCustomDomains_ListByProfile", + "x-ms-examples": { + "AFDCustomDomains_ListByProfile": { + "$ref": "./examples/AFDCustomDomains_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDDomainListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}": { + "get": { + "tags": [ + "AFDCustomDomains" + ], + "description": "Gets an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.", + "operationId": "AFDCustomDomains_Get", + "x-ms-examples": { + "AFDCustomDomains_Get": { + "$ref": "./examples/AFDCustomDomains_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the domain under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDDomain" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "AFDCustomDomains" + ], + "description": "Creates a new domain within the specified profile.", + "operationId": "AFDCustomDomains_Create", + "x-ms-examples": { + "AFDCustomDomains_Create": { + "$ref": "./examples/AFDCustomDomains_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the domain under the profile which is unique globally", + "required": true, + "type": "string" + }, + { + "name": "customDomain", + "in": "body", + "description": "Domain properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDDomain" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDDomain" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new domain has been created.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDDomain" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/AFDDomain" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "AFDCustomDomains" + ], + "description": "Updates an existing domain within a profile.", + "operationId": "AFDCustomDomains_Update", + "x-ms-examples": { + "AFDCustomDomains_Update": { + "$ref": "./examples/AFDCustomDomains_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the domain under the profile which is unique globally", + "required": true, + "type": "string" + }, + { + "name": "customDomainUpdateProperties", + "in": "body", + "description": "Domain properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDDomainUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDDomain" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDDomain" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "AFDCustomDomains" + ], + "description": "Deletes an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.", + "operationId": "AFDCustomDomains_Delete", + "x-ms-examples": { + "AFDCustomDomains_Delete": { + "$ref": "./examples/AFDCustomDomains_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the domain under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the domain was not found." + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}/refreshValidationToken": { + "post": { + "tags": [ + "AFDCustomDomains" + ], + "description": "Updates the domain validation token.", + "operationId": "AFDCustomDomains_RefreshValidationToken", + "x-ms-examples": { + "AFDCustomDomains_Delete": { + "$ref": "./examples/AFDCustomDomains_RefreshValidationToken.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the domain under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. Please poll the targeted custom domain and check the 'validationProperties' field for the new validation token values.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints": { + "get": { + "tags": [ + "AFDEndpoints" + ], + "description": "Lists existing AzureFrontDoor endpoints.", + "operationId": "AFDEndpoints_ListByProfile", + "x-ms-examples": { + "AFDEndpoints_ListByProfile": { + "$ref": "./examples/AFDEndpoints_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDEndpointListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}": { + "get": { + "tags": [ + "AFDEndpoints" + ], + "description": "Gets an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.", + "operationId": "AFDEndpoints_Get", + "x-ms-examples": { + "AFDEndpoints_Get": { + "$ref": "./examples/AFDEndpoints_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDEndpoint" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "AFDEndpoints" + ], + "description": "Creates a new AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.", + "operationId": "AFDEndpoints_Create", + "x-ms-examples": { + "AFDEndpoints_Create": { + "$ref": "./examples/AFDEndpoints_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "endpoint", + "in": "body", + "description": "Endpoint properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDEndpoint" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDEndpoint" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new endpoint has been created.", + "schema": { + "$ref": "#/definitions/AFDEndpoint" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDEndpoint" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "AFDEndpoints" + ], + "description": "Updates an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update domains, use the Update Custom Domain operation.", + "operationId": "AFDEndpoints_Update", + "x-ms-examples": { + "AFDEndpoints_Update": { + "$ref": "./examples/AFDEndpoints_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "endpointUpdateProperties", + "in": "body", + "description": "Endpoint update properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDEndpointUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDEndpoint" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDEndpoint" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "AFDEndpoints" + ], + "description": "Deletes an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.", + "operationId": "AFDEndpoints_Delete", + "x-ms-examples": { + "AFDEndpoints_Delete": { + "$ref": "./examples/AFDEndpoints_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/purge": { + "post": { + "tags": [ + "AFDEndpoints" + ], + "description": "Removes a content from AzureFrontDoor.", + "operationId": "AFDEndpoints_PurgeContent", + "x-ms-examples": { + "AFDEndpoints_PurgeContent": { + "$ref": "./examples/AFDEndpoints_PurgeContent.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "contents", + "in": "body", + "description": "The list of paths to the content and the list of linked domains to be purged. Path can be a full URL, e.g. '/pictures/city.png' which removes a single file, or a directory with a wildcard, e.g. '/pictures/*' which removes all folders and files in the directory.", + "required": true, + "schema": { + "$ref": "#/definitions/AfdPurgeParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/usages": { + "post": { + "tags": [ + "AFDEndpoints" + ], + "description": "Checks the quota and actual usage of endpoints under the given Azure Front Door profile.", + "operationId": "AFDEndpoints_ListResourceUsage", + "x-ms-examples": { + "AFDEndpoints_ListResourceUsage": { + "$ref": "./examples/AFDEndpoints_ListResourceUsage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsagesListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/validateCustomDomain": { + "post": { + "tags": [ + "AFDEndpoints" + ], + "description": "Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS.", + "operationId": "AFDEndpoints_ValidateCustomDomain", + "x-ms-examples": { + "Endpoints_ValidateCustomDomain": { + "$ref": "./examples/AFDEndpoints_ValidateCustomDomain.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainProperties", + "in": "body", + "description": "Custom domain to be validated.", + "required": true, + "schema": { + "$ref": "./cdn.json#/definitions/ValidateCustomDomainInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "./cdn.json#/definitions/ValidateCustomDomainOutput" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups": { + "get": { + "tags": [ + "AFDOriginGroups" + ], + "description": "Lists all of the existing origin groups within a profile.", + "operationId": "AFDOriginGroups_ListByProfile", + "x-ms-examples": { + "AFDOriginGroups_ListByProfile": { + "$ref": "./examples/AFDOriginGroups_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOriginGroupListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}": { + "get": { + "tags": [ + "AFDOriginGroups" + ], + "description": "Gets an existing origin group within a profile.", + "operationId": "AFDOriginGroups_Get", + "x-ms-examples": { + "AFDOriginGroups_Get": { + "$ref": "./examples/AFDOriginGroups_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOriginGroup" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "AFDOriginGroups" + ], + "description": "Creates a new origin group within the specified profile.", + "operationId": "AFDOriginGroups_Create", + "x-ms-examples": { + "AFDOriginGroups_Create": { + "$ref": "./examples/AFDOriginGroups_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "originGroup", + "in": "body", + "description": "Origin group properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDOriginGroup" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOriginGroup" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new origin group has been created.", + "schema": { + "$ref": "#/definitions/AFDOriginGroup" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDOriginGroup" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "AFDOriginGroups" + ], + "description": "Updates an existing origin group within a profile.", + "operationId": "AFDOriginGroups_Update", + "x-ms-examples": { + "AFDOriginGroups_Update": { + "$ref": "./examples/AFDOriginGroups_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "name": "originGroupUpdateProperties", + "in": "body", + "description": "Origin group properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDOriginGroupUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOriginGroup" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDOriginGroup" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "AFDOriginGroups" + ], + "description": "Deletes an existing origin group within a profile.", + "operationId": "AFDOriginGroups_Delete", + "x-ms-examples": { + "AFDOriginGroups_Delete": { + "$ref": "./examples/AFDOriginGroups_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the origin group was not found." + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/usages": { + "post": { + "tags": [ + "AFDOriginGroups" + ], + "description": "Checks the quota and actual usage of endpoints under the given Azure Front Door profile..", + "operationId": "AFDOriginGroups_ListResourceUsage", + "x-ms-examples": { + "AFDOriginGroups_ListResourceUsage": { + "$ref": "./examples/AFDOriginGroups_ListResourceUsage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsagesListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins": { + "get": { + "tags": [ + "AFDOrigins" + ], + "description": "Lists all of the existing origins within an origin group.", + "operationId": "AFDOrigins_ListByOriginGroup", + "x-ms-examples": { + "AFDOrigins_ListByOriginGroup": { + "$ref": "./examples/AFDOrigins_ListByOriginGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOriginListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins/{originName}": { + "get": { + "tags": [ + "AFDOrigins" + ], + "description": "Gets an existing origin within an origin group.", + "operationId": "AFDOrigins_Get", + "x-ms-examples": { + "AFDOrigins_Get": { + "$ref": "./examples/AFDOrigins_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOrigin" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "AFDOrigins" + ], + "description": "Creates a new origin within the specified origin group.", + "operationId": "AFDOrigins_Create", + "x-ms-examples": { + "AFDOrigins_Create": { + "$ref": "./examples/AFDOrigins_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin that is unique within the profile.", + "required": true, + "type": "string" + }, + { + "name": "origin", + "in": "body", + "description": "Origin properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDOrigin" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOrigin" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new origin has been created.", + "schema": { + "$ref": "#/definitions/AFDOrigin" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDOrigin" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "AFDOrigins" + ], + "description": "Updates an existing origin within an origin group.", + "operationId": "AFDOrigins_Update", + "x-ms-examples": { + "AFDOrigins_Update": { + "$ref": "./examples/AFDOrigins_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "name": "originUpdateProperties", + "in": "body", + "description": "Origin properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDOriginUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOrigin" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDOrigin" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "AFDOrigins" + ], + "description": "Deletes an existing origin within an origin group.", + "operationId": "AFDOrigins_Delete", + "x-ms-examples": { + "AFDOrigins_Delete": { + "$ref": "./examples/AFDOrigins_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the origin was not found." + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes": { + "get": { + "tags": [ + "Routes" + ], + "description": "Lists all of the existing origins within a profile.", + "operationId": "Routes_ListByEndpoint", + "x-ms-examples": { + "Routes_ListByEndpoint": { + "$ref": "./examples/Routes_ListByEndpoint.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RouteListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes/{routeName}": { + "get": { + "tags": [ + "Routes" + ], + "description": "Gets an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.", + "operationId": "Routes_Get", + "x-ms-examples": { + "Routes_Get": { + "$ref": "./examples/Routes_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "routeName", + "in": "path", + "description": "Name of the routing rule.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Route" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Routes" + ], + "description": "Creates a new route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.", + "operationId": "Routes_Create", + "x-ms-examples": { + "Routes_Create": { + "$ref": "./examples/Routes_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "routeName", + "in": "path", + "description": "Name of the routing rule.", + "required": true, + "type": "string" + }, + { + "name": "route", + "in": "body", + "description": "Route properties", + "required": true, + "schema": { + "$ref": "#/definitions/Route" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Route" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new endpoint has been created.", + "schema": { + "$ref": "#/definitions/Route" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Route" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "Routes" + ], + "description": "Updates an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.", + "operationId": "Routes_Update", + "x-ms-examples": { + "Routes_Update": { + "$ref": "./examples/Routes_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "routeName", + "in": "path", + "description": "Name of the routing rule.", + "required": true, + "type": "string" + }, + { + "name": "routeUpdateProperties", + "in": "body", + "description": "Route update properties", + "required": true, + "schema": { + "$ref": "#/definitions/RouteUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Route" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Route" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Routes" + ], + "description": "Deletes an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.", + "operationId": "Routes_Delete", + "x-ms-examples": { + "Routes_Delete": { + "$ref": "./examples/Routes_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "routeName", + "in": "path", + "description": "Name of the routing rule.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets": { + "get": { + "tags": [ + "RuleSets" + ], + "description": "Lists existing AzureFrontDoor rule sets within a profile.", + "operationId": "RuleSets_ListByProfile", + "x-ms-examples": { + "RuleSets_ListByProfile": { + "$ref": "./examples/RuleSets_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RuleSetListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}": { + "get": { + "tags": [ + "RuleSets" + ], + "description": "Gets an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile.", + "operationId": "RuleSets_Get", + "x-ms-examples": { + "RuleSets_Get": { + "$ref": "./examples/RuleSets_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RuleSet" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "RuleSets" + ], + "description": "Creates a new rule set within the specified profile.", + "operationId": "RuleSets_Create", + "x-ms-examples": { + "RuleSets_Create": { + "$ref": "./examples/RuleSets_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile which is unique globally", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RuleSet" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new rule set has been created.", + "schema": { + "$ref": "#/definitions/RuleSet" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "RuleSets" + ], + "description": "Deletes an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile.", + "operationId": "RuleSets_Delete", + "x-ms-examples": { + "RuleSets_Delete": { + "$ref": "./examples/RuleSets_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the rule set was not found." + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/usages": { + "post": { + "tags": [ + "RuleSets" + ], + "description": "Checks the quota and actual usage of endpoints under the given Azure Front Door profile..", + "operationId": "RuleSets_ListResourceUsage", + "x-ms-examples": { + "RuleSets_ListResourceUsage": { + "$ref": "./examples/RuleSets_ListResourceUsage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsagesListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules": { + "get": { + "tags": [ + "Rules" + ], + "description": "Lists all of the existing delivery rules within a rule set.", + "operationId": "Rules_ListByRuleSet", + "x-ms-examples": { + "Rules_ListByRuleSet": { + "$ref": "./examples/Rules_ListByRuleSet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RuleListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules/{ruleName}": { + "get": { + "tags": [ + "Rules" + ], + "description": "Gets an existing delivery rule within a rule set.", + "operationId": "Rules_Get", + "x-ms-examples": { + "Rules_Get": { + "$ref": "./examples/Rules_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile.", + "required": true, + "type": "string" + }, + { + "name": "ruleName", + "in": "path", + "description": "Name of the delivery rule which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Rules" + ], + "description": "Creates a new delivery rule within the specified rule set.", + "operationId": "Rules_Create", + "x-ms-examples": { + "Rules_Create": { + "$ref": "./examples/Rules_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile.", + "required": true, + "type": "string" + }, + { + "name": "ruleName", + "in": "path", + "description": "Name of the delivery rule which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "rule", + "in": "body", + "description": "The delivery rule properties.", + "required": true, + "schema": { + "$ref": "#/definitions/Rule" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new delivery rule has been created.", + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "Rules" + ], + "description": "Updates an existing delivery rule within a rule set.", + "operationId": "Rules_Update", + "x-ms-examples": { + "Rules_Update": { + "$ref": "./examples/Rules_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile.", + "required": true, + "type": "string" + }, + { + "name": "ruleName", + "in": "path", + "description": "Name of the delivery rule which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "ruleUpdateProperties", + "in": "body", + "description": "Delivery rule properties", + "required": true, + "schema": { + "$ref": "#/definitions/RuleUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Rules" + ], + "description": "Deletes an existing delivery rule within a rule set.", + "operationId": "Rules_Delete", + "x-ms-examples": { + "Rules_Delete": { + "$ref": "./examples/Rules_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile.", + "required": true, + "type": "string" + }, + { + "name": "ruleName", + "in": "path", + "description": "Name of the delivery rule which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the origin was not found." + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/securityPolicies": { + "get": { + "tags": [ + "SecurityPolicies" + ], + "description": "Lists security policies associated with the profile", + "operationId": "SecurityPolicies_ListByProfile", + "x-ms-examples": { + "SecurityPolicies_ListByProfile": { + "$ref": "./examples/SecurityPolicies_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityPolicyListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/securityPolicies/{securityPolicyName}": { + "get": { + "tags": [ + "SecurityPolicies" + ], + "description": "Gets an existing security policy within a profile.", + "operationId": "SecurityPolicies_Get", + "x-ms-examples": { + "SecurityPolicies_Get": { + "$ref": "./examples/SecurityPolicies_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "securityPolicyName", + "in": "path", + "description": "Name of the security policy under the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityPolicy" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "SecurityPolicies" + ], + "description": "Creates a new security policy within the specified profile.", + "operationId": "SecurityPolicies_Create", + "x-ms-examples": { + "SecurityPolicies_Create": { + "$ref": "./examples/SecurityPolicies_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "securityPolicyName", + "in": "path", + "description": "Name of the security policy under the profile.", + "required": true, + "type": "string" + }, + { + "name": "securityPolicy", + "in": "body", + "description": "The security policy properties.", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityPolicy" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityPolicy" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new delivery rule has been created.", + "schema": { + "$ref": "#/definitions/SecurityPolicy" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/SecurityPolicy" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "SecurityPolicies" + ], + "description": "Updates an existing security policy within a profile.", + "operationId": "SecurityPolicies_Patch", + "x-ms-examples": { + "SecurityPolicies_Patch": { + "$ref": "./examples/SecurityPolicies_Patch.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "securityPolicyName", + "in": "path", + "description": "Name of the security policy under the profile.", + "required": true, + "type": "string" + }, + { + "name": "securityPolicyUpdateProperties", + "in": "body", + "description": "Security policy update properties", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityPolicyUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityPolicy" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/SecurityPolicy" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "SecurityPolicies" + ], + "description": "Deletes an existing security policy within profile.", + "operationId": "SecurityPolicies_Delete", + "x-ms-examples": { + "SecurityPolicies_Delete": { + "$ref": "./examples/SecurityPolicies_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "securityPolicyName", + "in": "path", + "description": "Name of the security policy under the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets": { + "get": { + "tags": [ + "Secrets" + ], + "description": "Lists existing AzureFrontDoor secrets.", + "operationId": "Secrets_ListByProfile", + "x-ms-examples": { + "Secrets_ListByProfile": { + "$ref": "./examples/Secrets_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecretListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets/{secretName}": { + "get": { + "tags": [ + "Secrets" + ], + "description": "Gets an existing Secret within a profile.", + "operationId": "Secrets_Get", + "x-ms-examples": { + "Secrets_Get": { + "$ref": "./examples/Secrets_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "secretName", + "in": "path", + "description": "Name of the Secret under the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Secret" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Secrets" + ], + "description": "Creates a new Secret within the specified profile.", + "operationId": "Secrets_Create", + "x-ms-examples": { + "Secrets_Create": { + "$ref": "./examples/Secrets_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "secretName", + "in": "path", + "description": "Name of the Secret under the profile.", + "required": true, + "type": "string" + }, + { + "name": "secret", + "in": "body", + "description": "The Secret properties.", + "required": true, + "schema": { + "$ref": "#/definitions/Secret" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Secret" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new delivery rule has been created.", + "schema": { + "$ref": "#/definitions/Secret" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Secret" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Secrets" + ], + "description": "Deletes an existing Secret within profile.", + "operationId": "Secrets_Delete", + "x-ms-examples": { + "Secrets_Delete": { + "$ref": "./examples/Secrets_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "secretName", + "in": "path", + "description": "Name of the Secret under the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the origin was not found." + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getLogAnalyticsMetrics": { + "get": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_GetLogAnalyticsMetrics", + "x-ms-examples": { + "LogAnalytics_GetLogAnalyticsMetrics": { + "$ref": "./examples/LogAnalytics_GetLogAnalyticsMetrics.json" + } + }, + "description": "Get log report for AFD profile", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "metrics", + "type": "array", + "required": true, + "collectionFormat": "multi", + "in": "query", + "items": { + "type": "string", + "enum": [ + "clientRequestCount", + "clientRequestTraffic", + "clientRequestBandwidth", + "originRequestTraffic", + "originRequestBandwidth", + "totalLatency" + ], + "x-ms-enum": { + "name": "LogMetric", + "modelAsString": true + } + } + }, + { + "name": "dateTimeBegin", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "dateTimeEnd", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "granularity", + "type": "string", + "in": "query", + "required": true, + "enum": [ + "PT5M", + "PT1H", + "P1D" + ], + "x-ms-enum": { + "name": "LogMetricsGranularity", + "modelAsString": true + } + }, + { + "name": "groupBy", + "in": "query", + "type": "array", + "required": false, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "httpStatusCode", + "protocol", + "cacheStatus", + "countryOrRegion", + "customDomain" + ], + "x-ms-enum": { + "name": "LogMetricsGroupBy", + "modelAsString": true + } + } + }, + { + "name": "continents", + "type": "array", + "in": "query", + "collectionFormat": "multi", + "required": false, + "items": { + "type": "string" + } + }, + { + "name": "countryOrRegions", + "type": "array", + "in": "query", + "collectionFormat": "multi", + "required": false, + "items": { + "type": "string" + } + }, + { + "name": "customDomains", + "type": "array", + "required": true, + "collectionFormat": "multi", + "in": "query", + "items": { + "type": "string" + } + }, + { + "name": "protocols", + "type": "array", + "required": true, + "collectionFormat": "multi", + "in": "query", + "items": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/MetricsResponse" + } + }, + "default": { + "description": "Azure Front Door Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getLogAnalyticsRankings": { + "get": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_GetLogAnalyticsRankings", + "x-ms-examples": { + "LogAnalytics_GetLogAnalyticsRankings": { + "$ref": "./examples/LogAnalytics_GetLogAnalyticsRankings.json" + } + }, + "description": "Get log analytics ranking report for AFD profile", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "rankings", + "type": "array", + "in": "query", + "required": true, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "url", + "referrer", + "browser", + "userAgent", + "countryOrRegion" + ], + "x-ms-enum": { + "name": "LogRanking", + "modelAsString": true + } + } + }, + { + "name": "metrics", + "type": "array", + "in": "query", + "required": true, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "clientRequestCount", + "clientRequestTraffic", + "hitCount", + "missCount", + "userErrorCount", + "errorCount" + ], + "x-ms-enum": { + "name": "LogRankingMetric", + "modelAsString": true + } + } + }, + { + "name": "maxRanking", + "in": "query", + "required": true, + "type": "integer", + "format": "int32" + }, + { + "name": "dateTimeBegin", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "dateTimeEnd", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "customDomains", + "type": "array", + "in": "query", + "required": false, + "collectionFormat": "multi", + "items": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/RankingsResponse" + } + }, + "default": { + "description": "Azure Front Door Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getLogAnalyticsLocations": { + "get": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_GetLogAnalyticsLocations", + "x-ms-examples": { + "LogAnalytics_GetLogAnalyticsLocations": { + "$ref": "./examples/LogAnalytics_GetLogAnalyticsLocations.json" + } + }, + "description": "Get all available location names for AFD log analytics report.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/ContinentsResponse" + } + }, + "default": { + "description": "Azure Front Door Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getLogAnalyticsResources": { + "get": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_GetLogAnalyticsResources", + "x-ms-examples": { + "LogAnalytics_GetLogAnalyticsResources": { + "$ref": "./examples/LogAnalytics_GetLogAnalyticsResources.json" + } + }, + "description": "Get all endpoints and custom domains available for AFD log report", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/ResourcesResponse" + } + }, + "default": { + "description": "Azure Front Door Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getWafLogAnalyticsMetrics": { + "get": { + "tags": [ + "WafLogAnalytics" + ], + "operationId": "LogAnalytics_GetWafLogAnalyticsMetrics", + "x-ms-examples": { + "LogAnalytics_GetWafLogAnalyticsMetrics": { + "$ref": "./examples/LogAnalytics_GetWafLogAnalyticsMetrics.json" + } + }, + "description": "Get Waf related log analytics report for AFD profile.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "metrics", + "type": "array", + "in": "query", + "required": true, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "clientRequestCount" + ], + "x-ms-enum": { + "name": "WafMetric", + "modelAsString": true + } + } + }, + { + "name": "dateTimeBegin", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "dateTimeEnd", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "granularity", + "type": "string", + "in": "query", + "required": true, + "enum": [ + "PT5M", + "PT1H", + "P1D" + ], + "x-ms-enum": { + "name": "WafGranularity", + "modelAsString": true + } + }, + { + "name": "actions", + "type": "array", + "in": "query", + "required": false, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "allow", + "block", + "log", + "redirect" + ], + "x-ms-enum": { + "name": "WafAction", + "modelAsString": true + } + } + }, + { + "name": "groupBy", + "in": "query", + "type": "array", + "required": false, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "httpStatusCode", + "customDomain" + ], + "x-ms-enum": { + "name": "WafRankingGroupBy", + "modelAsString": true + } + } + }, + { + "name": "ruleTypes", + "type": "array", + "in": "query", + "required": false, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "managed", + "custom", + "bot" + ], + "x-ms-enum": { + "name": "WafRuleType", + "modelAsString": true + } + } + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/WafMetricsResponse" + } + }, + "default": { + "description": "Azure Front Door Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getWafLogAnalyticsRankings": { + "get": { + "tags": [ + "WafLogAnalytics" + ], + "operationId": "LogAnalytics_GetWafLogAnalyticsRankings", + "x-ms-examples": { + "LogAnalytics_GetWafLogAnalyticsRankings": { + "$ref": "./examples/LogAnalytics_GetWafLogAnalyticsRankings.json" + } + }, + "description": "Get WAF log analytics charts for AFD profile", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "metrics", + "type": "array", + "in": "query", + "required": true, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "clientRequestCount" + ], + "x-ms-enum": { + "name": "WafMetric", + "modelAsString": true + } + } + }, + { + "name": "dateTimeBegin", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "dateTimeEnd", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "maxRanking", + "in": "query", + "required": true, + "type": "integer", + "format": "int32" + }, + { + "name": "rankings", + "type": "array", + "in": "query", + "required": true, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "action", + "ruleGroup", + "ruleId", + "userAgent", + "clientIp", + "url", + "countryOrRegion", + "ruleType" + ], + "x-ms-enum": { + "name": "WafRankingType", + "modelAsString": true + } + } + }, + { + "name": "actions", + "type": "array", + "in": "query", + "required": false, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "allow", + "block", + "log", + "redirect" + ], + "x-ms-enum": { + "name": "WafAction", + "modelAsString": true + } + } + }, + { + "name": "ruleTypes", + "type": "array", + "in": "query", + "required": false, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "managed", + "custom", + "bot" + ], + "x-ms-enum": { + "name": "WafRuleType", + "modelAsString": true + } + } + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/WafRankingsResponse" + } + }, + "default": { + "description": "Azure Front Door Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ProfileChangeSkuWafMapping": { + "type": "object", + "description": "Parameters required for profile upgrade.", + "required": [ + "securityPolicyName", + "changeToWafPolicy" + ], + "properties": { + "securityPolicyName": { + "description": "The security policy name.", + "type": "string" + }, + "changeToWafPolicy": { + "description": "The new waf resource for the security policy to use.", + "$ref": "./cdn.json#/definitions/ResourceReference" + } + } + }, + "ProfileUpgradeParameters": { + "type": "object", + "description": "Parameters required for profile upgrade.", + "required": [ + "wafMappingList" + ], + "properties": { + "wafMappingList": { + "description": "Web Application Firewall (WAF) and security policy mapping for the profile upgrade", + "type": "array", + "items": { + "description": "List of waf mappings", + "$ref": "#/definitions/ProfileChangeSkuWafMapping" + }, + "x-ms-identifiers": [] + } + } + }, + "AfdPurgeParameters": { + "type": "object", + "description": "Parameters required for content purge.", + "required": [ + "contentPaths" + ], + "properties": { + "contentPaths": { + "description": "The path to the content to be purged. Can describe a file path or a wild card directory.", + "type": "array", + "items": { + "type": "string" + } + }, + "domains": { + "description": "List of domains.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Certificate": { + "description": "Certificate used for https", + "properties": { + "type": { + "$ref": "#/definitions/SecretType" + }, + "subject": { + "description": "Subject name in the certificate.", + "type": "string", + "readOnly": true + }, + "expirationDate": { + "description": "Certificate expiration date.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedCertificate": { + "description": "Managed Certificate used for https", + "allOf": [ + { + "$ref": "#/definitions/Certificate" + } + ] + }, + "CustomerCertificate": { + "description": "Customer Certificate used for https", + "allOf": [ + { + "$ref": "#/definitions/Certificate" + } + ], + "properties": { + "secretSource": { + "description": "Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{​​​​​​​​​subscriptionId}​​​​​​​​​/resourceGroups/{​​​​​​​​​resourceGroupName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/providers/Microsoft.KeyVault/vaults/{vaultName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/secrets/{certificateName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "secretVersion": { + "description": "Certificate version.", + "type": "string" + }, + "certificateAuthority": { + "description": "Certificate issuing authority.", + "type": "string", + "readOnly": true + }, + "useLatestVersion": { + "description": "Whether to use the latest version for the certificate", + "type": "boolean" + }, + "subjectAlternativeNames": { + "description": "The list of SANs.", + "type": "array", + "items": { + "type": "string", + "readOnly": true + } + }, + "thumbprint": { + "description": "Certificate thumbprint.", + "type": "string", + "readOnly": true + } + } + }, + "AzureFirstPartyManagedCertificate": { + "description": "Azure FirstParty Managed Certificate provided by other first party resource providers to enable HTTPS.", + "allOf": [ + { + "$ref": "#/definitions/Certificate" + } + ] + }, + "ValidateSecretInput": { + "description": "Input of the secret to be validated.", + "type": "object", + "required": [ + "secretSource", + "secretType" + ], + "properties": { + "secretType": { + "description": "The secret type.", + "$ref": "#/definitions/SecretType" + }, + "secretSource": { + "description": "Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{​​​​​​​​​subscriptionId}​​​​​​​​​/resourceGroups/{​​​​​​​​​resourceGroupName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/providers/Microsoft.KeyVault/vaults/{vaultName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/secrets/{secretName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "secretVersion": { + "description": "Secret version, if customer is using a specific version.", + "type": "string" + } + } + }, + "ValidateSecretOutput": { + "description": "Output of the validated secret.", + "type": "object", + "properties": { + "status": { + "description": "The validation status.", + "enum": [ + "Valid", + "Invalid", + "AccessDenied", + "CertificateExpired" + ], + "type": "string", + "x-ms-enum": { + "name": "status", + "modelAsString": true + } + }, + "message": { + "description": "Detailed error message", + "type": "string" + } + } + }, + "AFDDomainListResult": { + "description": "Result of the request to list domains. It contains a list of domain objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AFDDomain" + }, + "description": "List of AzureFrontDoor domains within a profile." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of domain objects if there are any." + } + } + }, + "AFDDomain": { + "description": "Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDDomainProperties" + } + } + }, + "AFDDomainProperties": { + "description": "The JSON object that contains the properties of the domain to create.", + "required": [ + "hostName" + ], + "allOf": [ + { + "$ref": "#/definitions/AFDDomainUpdatePropertiesParameters" + }, + { + "$ref": "#/definitions/AFDStateProperties" + } + ], + "properties": { + "domainValidationState": { + "description": "Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation.", + "readOnly": true, + "enum": [ + "Unknown", + "Submitting", + "Pending", + "Rejected", + "TimedOut", + "PendingRevalidation", + "Approved", + "RefreshingValidationToken", + "InternalError" + ], + "type": "string", + "x-ms-enum": { + "name": "DomainValidationState", + "modelAsString": true + } + }, + "hostName": { + "description": "The host name of the domain. Must be a domain name.", + "type": "string" + }, + "extendedProperties": { + "description": "Key-Value pair representing migration properties for domains.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "validationProperties": { + "description": "Values the customer needs to validate domain ownership", + "readOnly": true, + "type": "object", + "$ref": "#/definitions/DomainValidationProperties" + } + } + }, + "AFDDomainUpdateParameters": { + "description": "The domain JSON object required for domain creation or update.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDDomainUpdatePropertiesParameters" + } + } + }, + "AFDDomainUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the domain to create.", + "properties": { + "profileName": { + "description": "The name of the profile which holds the domain.", + "type": "string", + "readOnly": true + }, + "tlsSettings": { + "description": "The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user's own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default.", + "type": "object", + "$ref": "#/definitions/AFDDomainHttpsParameters" + }, + "azureDnsZone": { + "description": "Resource reference to the Azure DNS zone", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "preValidatedCustomDomainResourceId": { + "description": "Resource reference to the Azure resource where custom domain ownership was prevalidated", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + } + } + }, + "DomainValidationProperties": { + "description": "The JSON object that contains the properties to validate a domain.", + "properties": { + "validationToken": { + "description": "Challenge used for DNS TXT record or file based validation", + "readOnly": true, + "type": "string" + }, + "expirationDate": { + "description": "The date time that the token expires", + "readOnly": true, + "type": "string" + } + } + }, + "AFDDomainHttpsParameters": { + "description": "The JSON object that contains the properties to secure a domain.", + "required": [ + "certificateType" + ], + "properties": { + "certificateType": { + "description": "Defines the source of the SSL certificate.", + "enum": [ + "CustomerCertificate", + "ManagedCertificate", + "AzureFirstPartyManagedCertificate" + ], + "type": "string", + "x-ms-enum": { + "name": "AfdCertificateType", + "modelAsString": true + } + }, + "minimumTlsVersion": { + "description": "TLS protocol version that will be used for Https", + "enum": [ + "TLS10", + "TLS12" + ], + "type": "string", + "x-ms-enum": { + "name": "AfdMinimumTlsVersion", + "modelAsString": false + } + }, + "secret": { + "description": "Resource reference to the secret. ie. subs/rg/profile/secret", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + } + } + }, + "SecurityPolicy": { + "description": "SecurityPolicy association for AzureFrontDoor profile", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecurityPolicyProperties" + } + } + }, + "SecurityPolicyProperties": { + "description": "The json object that contains properties required to create a security policy", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AFDStateProperties" + } + ], + "properties": { + "profileName": { + "description": "The name of the profile which holds the security policy.", + "type": "string", + "readOnly": true + }, + "parameters": { + "description": "object which contains security policy parameters", + "$ref": "#/definitions/SecurityPolicyPropertiesParameters" + } + } + }, + "SecurityPolicyUpdateParameters": { + "description": "The JSON object containing security policy update parameters.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecurityPolicyUpdateProperties" + } + } + }, + "SecurityPolicyUpdateProperties": { + "description": "The json object that contains properties required to update a security policy", + "type": "object", + "properties": { + "parameters": { + "description": "object which contains security policy parameters", + "$ref": "#/definitions/SecurityPolicyPropertiesParameters" + } + } + }, + "SecurityPolicyPropertiesParameters": { + "description": "The json object containing security policy parameters", + "discriminator": "type", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "description": "The type of the Security policy to create.", + "enum": [ + "WebApplicationFirewall" + ], + "type": "string", + "x-ms-enum": { + "name": "SecurityPolicyType", + "modelAsString": true + } + } + } + }, + "SecurityPolicyWebApplicationFirewallParameters": { + "description": "The json object containing security policy waf parameters", + "x-ms-discriminator-value": "WebApplicationFirewall", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecurityPolicyPropertiesParameters" + } + ], + "properties": { + "wafPolicy": { + "type": "object", + "description": "Resource ID.", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "associations": { + "description": "Waf associations", + "type": "array", + "items": { + "$ref": "#/definitions/SecurityPolicyWebApplicationFirewallAssociation" + }, + "x-ms-identifiers": [] + } + } + }, + "SecurityPolicyWebApplicationFirewallAssociation": { + "description": "settings for security policy patterns to match", + "type": "object", + "properties": { + "domains": { + "description": "List of domains.", + "type": "array", + "items": { + "$ref": "#/definitions/ActivatedResourceReference" + } + }, + "patternsToMatch": { + "description": "List of paths", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SecurityPolicyListResult": { + "description": "Result of the request to list security policies. It contains a list of security policy objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SecurityPolicy" + }, + "description": "List of Security policies within a profile" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of security policy objects if there is any." + } + } + }, + "AutoGeneratedDomainNameLabelScope": { + "description": "Indicates the endpoint name reuse scope. The default value is TenantReuse.", + "enum": [ + "TenantReuse", + "SubscriptionReuse", + "ResourceGroupReuse", + "NoReuse" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoGeneratedDomainNameLabelScope", + "modelAsString": true + } + }, + "AFDEndpoint": { + "description": "Azure Front Door endpoint is the entity within a Azure Front Door profile containing configuration information such as origin, protocol, content caching and delivery behavior. The AzureFrontDoor endpoint uses the URL format .azureedge.net.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDEndpointProperties" + } + } + }, + "AFDEndpointProperties": { + "description": "The JSON object that contains the properties required to create an endpoint.", + "allOf": [ + { + "$ref": "#/definitions/AFDEndpointPropertiesUpdateParameters" + }, + { + "$ref": "#/definitions/AFDStateProperties" + } + ], + "properties": { + "hostName": { + "description": "The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net", + "type": "string", + "readOnly": true + }, + "autoGeneratedDomainNameLabelScope": { + "description": "Indicates the endpoint name reuse scope. The default value is TenantReuse.", + "$ref": "#/definitions/AutoGeneratedDomainNameLabelScope" + } + } + }, + "AFDEndpointListResult": { + "description": "Result of the request to list endpoints. It contains a list of endpoint objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AFDEndpoint" + }, + "description": "List of AzureFrontDoor endpoints within a profile" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of endpoint objects if there is any." + } + } + }, + "AFDEndpointUpdateParameters": { + "type": "object", + "description": "Properties required to create or update an endpoint.", + "properties": { + "tags": { + "description": "Endpoint tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDEndpointPropertiesUpdateParameters" + } + }, + "x-ms-azure-resource": true + }, + "AFDEndpointPropertiesUpdateParameters": { + "description": "The JSON object containing endpoint update parameters.", + "properties": { + "profileName": { + "description": "The name of the profile which holds the endpoint.", + "type": "string", + "readOnly": true + }, + "enabledState": { + "description": "Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EnabledState", + "modelAsString": true + } + } + } + }, + "CompressionSettings": { + "description": "settings for compression.", + "type": "object", + "properties": { + "contentTypesToCompress": { + "description": "List of content types on which compression applies. The value should be a valid MIME type.", + "type": "array", + "items": { + "type": "string" + } + }, + "isCompressionEnabled": { + "description": "Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.", + "type": "boolean" + } + } + }, + "AFDEndpointProtocols": { + "description": "Supported protocols for the customer's endpoint.", + "enum": [ + "Http", + "Https" + ], + "type": "string", + "x-ms-enum": { + "name": "AFDEndpointProtocols", + "modelAsString": true + } + }, + "SecretListResult": { + "description": "Result of the request to list secrets. It contains a list of Secret objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Secret" + }, + "description": "List of AzureFrontDoor secrets within a profile." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of Secret objects if there are any." + } + } + }, + "Secret": { + "description": "Friendly Secret name mapping to the any Secret or secret related information.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecretProperties" + } + } + }, + "SecretProperties": { + "description": "The JSON object that contains the properties of the Secret to create.", + "allOf": [ + { + "$ref": "#/definitions/AFDStateProperties" + } + ], + "properties": { + "profileName": { + "description": "The name of the profile which holds the secret.", + "type": "string", + "readOnly": true + }, + "parameters": { + "description": "object which contains secret parameters", + "$ref": "#/definitions/SecretParameters" + } + } + }, + "SecretParameters": { + "description": "The json object containing secret parameters", + "discriminator": "type", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/SecretType" + } + } + }, + "SecretType": { + "description": "The type of the secret resource.", + "enum": [ + "UrlSigningKey", + "CustomerCertificate", + "ManagedCertificate", + "AzureFirstPartyManagedCertificate" + ], + "type": "string", + "x-ms-enum": { + "name": "SecretType", + "modelAsString": true + } + }, + "UrlSigningKeyParameters": { + "description": "Url signing key parameters", + "x-ms-discriminator-value": "UrlSigningKey", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretParameters" + } + ], + "required": [ + "keyId", + "secretSource" + ], + "properties": { + "keyId": { + "description": "Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash.", + "type": "string" + }, + "secretSource": { + "description": "Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{​​​​​​​​​subscriptionId}​​​​​​​​​/resourceGroups/{​​​​​​​​​resourceGroupName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/providers/Microsoft.KeyVault/vaults/{vaultName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/secrets/{secretName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "secretVersion": { + "description": "Version of the secret to be used", + "type": "string" + } + } + }, + "ManagedCertificateParameters": { + "description": "Managed Certificate used for https", + "x-ms-discriminator-value": "ManagedCertificate", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretParameters" + } + ], + "properties": { + "subject": { + "description": "Subject name in the certificate.", + "type": "string", + "readOnly": true + }, + "expirationDate": { + "description": "Certificate expiration date.", + "type": "string", + "readOnly": true + } + } + }, + "CustomerCertificateParameters": { + "description": "Customer Certificate used for https", + "x-ms-discriminator-value": "CustomerCertificate", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretParameters" + } + ], + "required": [ + "secretSource" + ], + "properties": { + "secretSource": { + "description": "Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{​​​​​​​​​subscriptionId}​​​​​​​​​/resourceGroups/{​​​​​​​​​resourceGroupName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/providers/Microsoft.KeyVault/vaults/{vaultName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/secrets/{certificateName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "secretVersion": { + "description": "Version of the secret to be used", + "type": "string" + }, + "useLatestVersion": { + "description": "Whether to use the latest version for the certificate", + "type": "boolean" + }, + "subject": { + "description": "Subject name in the certificate.", + "type": "string", + "readOnly": true + }, + "expirationDate": { + "description": "Certificate expiration date.", + "type": "string", + "readOnly": true + }, + "certificateAuthority": { + "description": "Certificate issuing authority.", + "type": "string", + "readOnly": true + }, + "subjectAlternativeNames": { + "description": "The list of SANs.", + "type": "array", + "items": { + "type": "string", + "readOnly": true + } + }, + "thumbprint": { + "description": "Certificate thumbprint.", + "type": "string", + "readOnly": true + } + } + }, + "AzureFirstPartyManagedCertificateParameters": { + "description": "Azure FirstParty Managed Certificate provided by other first party resource providers to enable HTTPS.", + "x-ms-discriminator-value": "AzureFirstPartyManagedCertificate", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretParameters" + } + ], + "properties": { + "secretSource": { + "description": "Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{​​​​​​​​​subscriptionId}​​​​​​​​​/resourceGroups/{​​​​​​​​​resourceGroupName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/providers/Microsoft.KeyVault/vaults/{vaultName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/secrets/{certificateName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference", + "readOnly": true + }, + "subject": { + "description": "Subject name in the certificate.", + "type": "string", + "readOnly": true + }, + "expirationDate": { + "description": "Certificate expiration date.", + "type": "string", + "readOnly": true + }, + "certificateAuthority": { + "description": "Certificate issuing authority.", + "type": "string", + "readOnly": true + }, + "subjectAlternativeNames": { + "description": "The list of SANs.", + "type": "array", + "items": { + "type": "string", + "readOnly": true + } + }, + "thumbprint": { + "description": "Certificate thumbprint.", + "type": "string", + "readOnly": true + } + } + }, + "RuleSetListResult": { + "description": "Result of the request to list rule sets. It contains a list of rule set objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RuleSet" + }, + "description": "List of AzureFrontDoor rule sets within a profile." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of rule set objects if there are any." + } + } + }, + "RuleSet": { + "description": "Friendly RuleSet name mapping to the any RuleSet or secret related information.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RuleSetProperties" + } + } + }, + "RuleSetProperties": { + "description": "The JSON object that contains the properties of the Rule Set to create.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AFDStateProperties" + } + ], + "properties": { + "profileName": { + "description": "The name of the profile which holds the rule set.", + "type": "string", + "readOnly": true + } + } + }, + "AFDOrigin": { + "description": "Azure Front Door origin is the source of the content being delivered via Azure Front Door. When the edge nodes represented by an endpoint do not have the requested content cached, they attempt to fetch it from one or more of the configured origins.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDOriginProperties" + } + } + }, + "AFDOriginProperties": { + "description": "The JSON object that contains the properties of the origin.", + "required": [ + "hostName" + ], + "allOf": [ + { + "$ref": "#/definitions/AFDOriginUpdatePropertiesParameters" + }, + { + "$ref": "#/definitions/AFDStateProperties" + } + ] + }, + "AFDOriginUpdateParameters": { + "type": "object", + "description": "AFDOrigin properties needed for origin update.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDOriginUpdatePropertiesParameters" + } + }, + "x-ms-azure-resource": true + }, + "AFDOriginUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the origin.", + "properties": { + "originGroupName": { + "description": "The name of the origin group which contains this origin.", + "type": "string", + "readOnly": true + }, + "azureOrigin": { + "description": "Resource reference to the Azure origin resource.", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "hostName": { + "description": "The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.", + "type": "string" + }, + "httpPort": { + "description": "The value of the HTTP port. Must be between 1 and 65535.", + "type": "integer", + "format": "int32", + "maximum": 65535, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false, + "default": 80 + }, + "httpsPort": { + "description": "The value of the HTTPS port. Must be between 1 and 65535.", + "type": "integer", + "maximum": 65535, + "format": "int32", + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false, + "default": 443 + }, + "originHostHeader": { + "description": "The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure Front Door origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint", + "type": "string" + }, + "priority": { + "description": "Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5", + "type": "integer", + "format": "int32", + "maximum": 5, + "minimum": 1 + }, + "weight": { + "description": "Weight of the origin in given origin group for load balancing. Must be between 1 and 1000", + "type": "integer", + "format": "int32", + "maximum": 1000, + "minimum": 1 + }, + "sharedPrivateLinkResource": { + "description": "The properties of the private link resource for private origin.", + "type": "object", + "$ref": "#/definitions/SharedPrivateLinkResourceProperties" + }, + "enabledState": { + "description": "Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool.", + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EnabledState", + "modelAsString": true + } + }, + "enforceCertificateNameCheck": { + "description": "Whether to enable certificate name check at origin level", + "type": "boolean", + "default": true + } + } + }, + "SharedPrivateLinkResourceProperties": { + "properties": { + "privateLink": { + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference", + "description": "The resource id of the resource the shared private link resource is for." + }, + "privateLinkLocation": { + "type": "string", + "description": "The location of the shared private link resource" + }, + "groupId": { + "type": "string", + "description": "The group id from the provider of resource the shared private link resource is for." + }, + "requestMessage": { + "type": "string", + "description": "The request message for requesting approval of the shared private link resource." + }, + "status": { + "type": "string", + "description": "Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected", + "Timeout" + ], + "x-ms-enum": { + "name": "SharedPrivateLinkResourceStatus", + "modelAsString": false + } + } + }, + "description": "Describes the properties of an existing Shared Private Link Resource to use when connecting to a private origin." + }, + "AFDOriginListResult": { + "description": "Result of the request to list origins. It contains a list of origin objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AFDOrigin" + }, + "description": "List of Azure Front Door origins within an Azure Front Door endpoint" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of origin objects if there are any." + } + } + }, + "AFDOriginGroup": { + "description": "AFDOrigin group comprising of origins is used for load balancing to origins when the content cannot be served from Azure Front Door.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDOriginGroupProperties" + } + } + }, + "AFDOriginGroupProperties": { + "description": "The JSON object that contains the properties of the origin group.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AFDOriginGroupUpdatePropertiesParameters" + }, + { + "$ref": "#/definitions/AFDStateProperties" + } + ] + }, + "AFDOriginGroupUpdateParameters": { + "type": "object", + "description": "AFDOrigin group properties needed for origin group creation or update.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDOriginGroupUpdatePropertiesParameters" + } + }, + "x-ms-azure-resource": true + }, + "AFDOriginGroupUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the origin group.", + "properties": { + "profileName": { + "description": "The name of the profile which holds the origin group.", + "type": "string", + "readOnly": true + }, + "loadBalancingSettings": { + "description": "Load balancing settings for a backend pool", + "$ref": "#/definitions/LoadBalancingSettingsParameters" + }, + "healthProbeSettings": { + "description": "Health probe settings to the origin that is used to determine the health of the origin.", + "type": "object", + "$ref": "./cdn.json#/definitions/HealthProbeParameters" + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": { + "description": "Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.", + "type": "integer", + "format": "int32", + "maximum": 50, + "minimum": 0 + }, + "sessionAffinityState": { + "description": "Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EnabledState", + "modelAsString": true + } + } + } + }, + "LoadBalancingSettingsParameters": { + "description": "Round-Robin load balancing settings for a backend pool", + "type": "object", + "properties": { + "sampleSize": { + "description": "The number of samples to consider for load balancing decisions", + "type": "integer", + "format": "int32" + }, + "successfulSamplesRequired": { + "description": "The number of samples within the sample period that must succeed", + "type": "integer", + "format": "int32" + }, + "additionalLatencyInMilliseconds": { + "description": "The additional latency in milliseconds for probes to fall into the lowest latency bucket", + "type": "integer", + "format": "int32" + } + } + }, + "AFDOriginGroupListResult": { + "description": "Result of the request to list origin groups. It contains a list of origin groups objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AFDOriginGroup" + }, + "description": "List of Azure Front Door origin groups within an Azure Front Door endpoint" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of origin objects if there are any." + } + } + }, + "RouteListResult": { + "description": "Result of the request to list routes. It contains a list of route objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Route" + }, + "description": "List of AzureFrontDoor routes within a profile." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of route objects if there are any." + } + } + }, + "Route": { + "description": "Friendly Routes name mapping to the any Routes or secret related information.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteProperties" + } + } + }, + "RouteProperties": { + "description": "The JSON object that contains the properties of the Routes to create.", + "allOf": [ + { + "$ref": "#/definitions/RouteUpdatePropertiesParameters" + }, + { + "$ref": "#/definitions/AFDStateProperties" + } + ], + "required": [ + "originGroup" + ] + }, + "RouteUpdateParameters": { + "description": "The domain JSON object required for domain creation or update.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteUpdatePropertiesParameters" + } + } + }, + "RouteUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the domain to create.", + "properties": { + "endpointName": { + "description": "The name of the endpoint which holds the route.", + "type": "string", + "readOnly": true + }, + "customDomains": { + "description": "Domains referenced by this endpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/ActivatedResourceReference" + } + }, + "originGroup": { + "description": "A reference to the origin group.", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "originPath": { + "description": "A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.", + "type": "string" + }, + "ruleSets": { + "description": "rule sets referenced by this endpoint.", + "type": "array", + "items": { + "$ref": "./cdn.json#/definitions/ResourceReference" + } + }, + "supportedProtocols": { + "description": "List of supported protocols for this route.", + "type": "array", + "items": { + "$ref": "#/definitions/AFDEndpointProtocols" + }, + "default": [ + "Http", + "Https" + ] + }, + "patternsToMatch": { + "description": "The route patterns of the rule.", + "type": "array", + "items": { + "type": "string", + "description": "A route pattern of the rule. Must not have any * except possibly after the final / at the end of the path." + } + }, + "cacheConfiguration": { + "description": "The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.", + "type": "object", + "$ref": "#/definitions/AfdRouteCacheConfiguration" + }, + "forwardingProtocol": { + "description": "Protocol this rule will use when forwarding traffic to backends.", + "type": "string", + "enum": [ + "HttpOnly", + "HttpsOnly", + "MatchRequest" + ], + "x-ms-enum": { + "name": "ForwardingProtocol", + "modelAsString": true + }, + "default": "MatchRequest" + }, + "linkToDefaultDomain": { + "description": "whether this route will be linked to the default endpoint domain.", + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "LinkToDefaultDomain", + "modelAsString": true + }, + "default": "Disabled" + }, + "httpsRedirect": { + "description": "Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "httpsRedirect", + "modelAsString": true + }, + "default": "Disabled" + }, + "enabledState": { + "description": "Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EnabledState", + "modelAsString": true + } + } + } + }, + "AfdRouteCacheConfiguration": { + "description": "Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.", + "type": "object", + "properties": { + "queryStringCachingBehavior": { + "description": "Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.", + "enum": [ + "IgnoreQueryString", + "UseQueryString", + "IgnoreSpecifiedQueryStrings", + "IncludeSpecifiedQueryStrings" + ], + "type": "string", + "x-ms-enum": { + "name": "afdQueryStringCachingBehavior", + "modelAsString": true + } + }, + "queryParameters": { + "description": "query parameters to include or exclude (comma separated).", + "type": "string" + }, + "compressionSettings": { + "description": "compression settings.", + "type": "object", + "$ref": "#/definitions/CompressionSettings" + } + } + }, + "RuleListResult": { + "description": "Result of the request to list rules. It contains a list of rule objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Rule" + }, + "description": "List of AzureFrontDoor rules within a rule set." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of rule objects if there are any." + } + } + }, + "Rule": { + "description": "Friendly Rules name mapping to the any Rules or secret related information.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RuleProperties" + } + } + }, + "RuleProperties": { + "description": "The JSON object that contains the properties of the Rules to create.", + "type": "object", + "required": [ + "order", + "actions" + ], + "allOf": [ + { + "$ref": "#/definitions/RuleUpdatePropertiesParameters" + }, + { + "$ref": "#/definitions/AFDStateProperties" + } + ] + }, + "RuleUpdateParameters": { + "description": "The domain JSON object required for domain creation or update.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RuleUpdatePropertiesParameters" + } + } + }, + "RuleUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the rule to update.", + "properties": { + "ruleSetName": { + "description": "The name of the rule set containing the rule.", + "type": "string", + "readOnly": true + }, + "order": { + "description": "The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.", + "type": "integer", + "format": "int32" + }, + "conditions": { + "description": "A list of conditions that must be matched for the actions to be executed", + "type": "array", + "items": { + "$ref": "./cdn.json#/definitions/DeliveryRuleCondition" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "actions": { + "description": "A list of actions that are executed when all the conditions of a rule are satisfied.", + "type": "array", + "items": { + "$ref": "./cdn.json#/definitions/DeliveryRuleAction" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "matchProcessingBehavior": { + "description": "If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue.", + "type": "string", + "enum": [ + "Continue", + "Stop" + ], + "x-ms-enum": { + "name": "MatchProcessingBehavior", + "modelAsString": true + }, + "default": "Continue" + } + } + }, + "CheckEndpointNameAvailabilityInput": { + "description": "Input of CheckNameAvailability API.", + "type": "object", + "required": [ + "name", + "type" + ], + "properties": { + "name": { + "description": "The resource name to validate.", + "type": "string" + }, + "type": { + "description": "The type of the resource whose name is to be validated.", + "$ref": "./cdn.json#/definitions/ResourceType" + }, + "autoGeneratedDomainNameLabelScope": { + "description": "Indicates the endpoint name reuse scope. The default value is TenantReuse.", + "$ref": "#/definitions/AutoGeneratedDomainNameLabelScope" + } + } + }, + "CheckEndpointNameAvailabilityOutput": { + "description": "Output of check name availability API.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "Indicates whether the name is available.", + "readOnly": true, + "type": "boolean" + }, + "availableHostname": { + "description": "Returns the available hostname generated based on the AutoGeneratedDomainNameLabelScope when the name is available, otherwise it returns empty string", + "readOnly": true, + "type": "string" + }, + "reason": { + "description": "The reason why the name is not available.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "The detailed error message describing why the name is not available.", + "readOnly": true, + "type": "string" + } + } + }, + "CheckHostNameAvailabilityInput": { + "description": "Input of CheckHostNameAvailability API.", + "type": "object", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name to validate.", + "type": "string" + } + } + }, + "ValidationToken": { + "description": "The validation token.", + "type": "object", + "properties": { + "token": { + "readOnly": true, + "type": "string" + } + } + }, + "AFDStateProperties": { + "description": "The tracking states for afd resources.", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "description": "Provisioning status", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Updating", + "Deleting", + "Creating" + ], + "x-ms-enum": { + "name": "AfdProvisioningState", + "modelAsString": true + } + }, + "deploymentStatus": { + "enum": [ + "NotStarted", + "InProgress", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DeploymentStatus", + "modelAsString": true + } + } + } + }, + "AfdErrorResponse": { + "title": "Error response", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "properties": { + "error": { + "description": "The error object.", + "$ref": "./cdn.json#/definitions/ErrorDetail" + } + } + }, + "MetricsResponse": { + "description": "Metrics Response", + "properties": { + "dateTimeBegin": { + "type": "string", + "format": "date-time" + }, + "dateTimeEnd": { + "type": "string", + "format": "date-time" + }, + "granularity": { + "type": "string", + "enum": [ + "PT5M", + "PT1H", + "P1D" + ], + "x-ms-enum": { + "name": "MetricsGranularity", + "modelAsString": true + } + }, + "series": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metric": { + "type": "string" + }, + "unit": { + "type": "string", + "enum": [ + "count", + "bytes", + "bitsPerSecond", + "milliSeconds" + ], + "x-ms-enum": { + "name": "MetricsSeriesUnit", + "modelAsString": true + } + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + } + } + }, + "x-ms-identifiers": [ + "name" + ] + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dateTime": { + "type": "string", + "format": "date-time" + }, + "value": { + "type": "number" + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "RankingsResponse": { + "description": "Rankings Response", + "properties": { + "dateTimeBegin": { + "type": "string", + "format": "date-time" + }, + "dateTimeEnd": { + "type": "string", + "format": "date-time" + }, + "tables": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ranking": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "metrics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metric": { + "type": "string" + }, + "value": { + "type": "integer", + "format": "int64" + }, + "percentage": { + "type": "number" + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "ContinentsResponse": { + "description": "Continents Response", + "properties": { + "continents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + } + } + }, + "countryOrRegions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "continentId": { + "type": "string" + } + } + } + } + } + }, + "ResourcesResponse": { + "description": "Resources Response", + "properties": { + "endpoints": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "history": { + "type": "boolean" + }, + "customDomains": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "endpointId": { + "type": "string" + }, + "history": { + "type": "boolean" + } + } + } + } + } + } + }, + "customDomains": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "endpointId": { + "type": "string" + }, + "history": { + "type": "boolean" + } + } + } + } + } + }, + "WafMetricsResponse": { + "description": "Waf Metrics Response", + "properties": { + "dateTimeBegin": { + "type": "string", + "format": "date-time" + }, + "dateTimeEnd": { + "type": "string", + "format": "date-time" + }, + "granularity": { + "type": "string", + "enum": [ + "PT5M", + "PT1H", + "P1D" + ], + "x-ms-enum": { + "name": "WafMetricsGranularity", + "modelAsString": true + } + }, + "series": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metric": { + "type": "string" + }, + "unit": { + "type": "string", + "enum": [ + "count" + ], + "x-ms-enum": { + "name": "WafMetricsSeriesUnit", + "modelAsString": true + } + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + } + } + }, + "x-ms-identifiers": [ + "name" + ] + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dateTime": { + "type": "string", + "format": "date-time" + }, + "value": { + "type": "number" + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "WafRankingsResponse": { + "description": "Waf Rankings Response", + "properties": { + "dateTimeBegin": { + "type": "string", + "format": "date-time" + }, + "dateTimeEnd": { + "type": "string", + "format": "date-time" + }, + "groups": { + "type": "array", + "items": { + "type": "string" + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupValues": { + "type": "array", + "items": { + "type": "string" + } + }, + "metrics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metric": { + "type": "string" + }, + "value": { + "type": "integer", + "format": "int64" + }, + "percentage": { + "type": "number", + "format": "double" + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "UsageName": { + "properties": { + "value": { + "type": "string", + "description": "A string describing the resource name." + }, + "localizedValue": { + "type": "string", + "description": "A localized string describing the resource name." + } + }, + "description": "The usage names." + }, + "Usage": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource identifier." + }, + "unit": { + "type": "string", + "description": "An enum describing the unit of measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": true + } + }, + "currentValue": { + "type": "integer", + "format": "int64", + "description": "The current value of the usage." + }, + "limit": { + "type": "integer", + "format": "int64", + "description": "The limit of usage." + }, + "name": { + "$ref": "#/definitions/UsageName", + "description": "The name of the type of usage." + } + }, + "required": [ + "unit", + "currentValue", + "limit", + "name" + ], + "description": "Describes resource usage." + }, + "UsagesListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "The list of resource usages." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "The list usages operation response." + }, + "ActivatedResourceReference": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + }, + "isActive": { + "readOnly": true, + "type": "boolean", + "description": "Whether the resource is active or inactive" + } + }, + "description": "Reference to another resource along with its state.", + "type": "object", + "x-ms-azure-resource": true + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request. Current version is 2024-09-01." + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "Name of the Resource group within the Azure subscription." + }, + "profileNameParameter": { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group." + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdn.json new file mode 100644 index 000000000000..8a76359927c1 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdn.json @@ -0,0 +1,7466 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-09-01", + "title": "CdnManagementClient", + "description": "Use these APIs to manage Azure CDN resources through the Azure Resource Manager. You must make sure that requests made to these resources are secure." + }, + "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.Cdn/profiles": { + "get": { + "tags": [ + "Profiles" + ], + "description": "Lists all of the Azure Front Door Standard, Azure Front Door Premium, and CDN profiles within an Azure subscription.", + "operationId": "Profiles_List", + "x-ms-examples": { + "Profiles_List": { + "$ref": "./examples/Profiles_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProfileListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles": { + "get": { + "tags": [ + "Profiles" + ], + "description": "Lists all of the Azure Front Door Standard, Azure Front Door Premium, and CDN profiles within a resource group.", + "operationId": "Profiles_ListByResourceGroup", + "x-ms-examples": { + "Profiles_ListByResourceGroup": { + "$ref": "./examples/Profiles_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProfileListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}": { + "get": { + "tags": [ + "Profiles" + ], + "description": "Gets an Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified profile name under the specified subscription and resource group.", + "operationId": "Profiles_Get", + "x-ms-examples": { + "Profiles_Get": { + "$ref": "./examples/Profiles_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Profiles" + ], + "description": "Creates a new Azure Front Door Standard or Azure Front Door Premium or CDN profile with a profile name under the specified subscription and resource group.", + "operationId": "Profiles_Create", + "x-ms-examples": { + "Profiles_Create": { + "$ref": "./examples/Profiles_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "description": "Profile properties needed to create a new profile.", + "in": "body", + "name": "profile", + "required": true, + "schema": { + "$ref": "#/definitions/Profile" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new profile has been created.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Profiles" + ], + "description": "Updates an existing Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified profile name under the specified subscription and resource group.", + "operationId": "Profiles_Update", + "x-ms-examples": { + "Profiles_Update": { + "$ref": "./examples/Profiles_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "profileUpdateParameters", + "in": "body", + "description": "Profile properties needed to update an existing profile.", + "required": true, + "schema": { + "$ref": "#/definitions/ProfileUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Profiles" + ], + "description": "Deletes an existing Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified parameters. Deleting a profile will result in the deletion of all of the sub-resources including endpoints, origins and custom domains.", + "operationId": "Profiles_Delete", + "x-ms-examples": { + "Profiles_Delete": { + "$ref": "./examples/Profiles_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the profile was not found." + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/canMigrate": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Checks if CDN profile can be migrated to Azure Frontdoor(Standard/Premium) profile.", + "operationId": "Profiles_CanMigrate", + "x-ms-examples": { + "Profiles_CanMigrate": { + "$ref": "./examples/Profiles_CanMigrate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "description": "Properties needed to check if cdn profile or classic frontdoor can be migrated.", + "in": "body", + "name": "canMigrateParameters", + "required": true, + "schema": { + "$ref": "#/definitions/CanMigrateParameters" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CanMigrateResult" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/migrate": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Migrate the CDN profile to Azure Frontdoor(Standard/Premium) profile. The change need to be committed after this.", + "operationId": "Profiles_Migrate", + "x-ms-examples": { + "Profiles_Migrate": { + "$ref": "./examples/Profiles_Migrate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "description": "Properties needed to migrate the profile.", + "in": "body", + "name": "migrationParameters", + "required": true, + "schema": { + "$ref": "#/definitions/MigrationParameters" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/MigrateResult" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/MigrateResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/migrationCommit": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Commit the migrated Azure Frontdoor(Standard/Premium) profile.", + "operationId": "Profiles_MigrationCommit", + "x-ms-examples": { + "Profiles_MigrationCommit": { + "$ref": "./examples/Profiles_MigrationCommit.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/generateSsoUri": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Generates a dynamic SSO URI used to sign in to the CDN supplemental portal. Supplemental portal is used to configure advanced feature capabilities that are not yet available in the Azure portal, such as core reports in a standard profile; rules engine, advanced HTTP reports, and real-time stats and alerts in a premium profile. The SSO URI changes approximately every 10 minutes.", + "operationId": "Profiles_GenerateSsoUri", + "x-ms-examples": { + "Profiles_GenerateSsoUri": { + "$ref": "./examples/Profiles_GenerateSsoUri.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/SsoUri" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getSupportedOptimizationTypes": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Gets the supported optimization types for the current profile. A user can create an endpoint with an optimization type from the listed values.", + "operationId": "Profiles_ListSupportedOptimizationTypes", + "x-ms-examples": { + "Profiles_ListSupportedOptimizationTypes": { + "$ref": "./examples/Profiles_ListSupportedOptimizationTypes.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/SupportedOptimizationTypesListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/checkResourceUsage": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Checks the quota and actual usage of endpoints under the given Azure Front Door Standard or Azure Front Door Premium or CDN profile.", + "operationId": "Profiles_ListResourceUsage", + "x-ms-examples": { + "Profiles_ListResourceUsage": { + "$ref": "./examples/Profiles_ListResourceUsage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ResourceUsageListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints": { + "get": { + "tags": [ + "Endpoints" + ], + "description": "Lists existing CDN endpoints.", + "operationId": "Endpoints_ListByProfile", + "x-ms-examples": { + "Endpoints_ListByProfile": { + "$ref": "./examples/Endpoints_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EndpointListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}": { + "get": { + "tags": [ + "Endpoints" + ], + "description": "Gets an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.", + "operationId": "Endpoints_Get", + "x-ms-examples": { + "Endpoints_Get": { + "$ref": "./examples/Endpoints_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Endpoints" + ], + "description": "Creates a new CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.", + "operationId": "Endpoints_Create", + "x-ms-examples": { + "Endpoints_Create": { + "$ref": "./examples/Endpoints_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "endpoint", + "in": "body", + "description": "Endpoint properties", + "required": true, + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new endpoint has been created.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Endpoints" + ], + "description": "Updates an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update custom domains, use the Update Custom Domain operation.", + "operationId": "Endpoints_Update", + "x-ms-examples": { + "Endpoints_Update": { + "$ref": "./examples/Endpoints_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "endpointUpdateProperties", + "in": "body", + "description": "Endpoint update properties", + "required": true, + "schema": { + "$ref": "#/definitions/EndpointUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Endpoints" + ], + "description": "Deletes an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.", + "operationId": "Endpoints_Delete", + "x-ms-examples": { + "Endpoints_Delete": { + "$ref": "./examples/Endpoints_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the endpoint was not found." + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/start": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Starts an existing CDN endpoint that is on a stopped state.", + "operationId": "Endpoints_Start", + "x-ms-examples": { + "Endpoints_Start": { + "$ref": "./examples/Endpoints_Start.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/stop": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Stops an existing running CDN endpoint.", + "operationId": "Endpoints_Stop", + "x-ms-examples": { + "Endpoints_Stop": { + "$ref": "./examples/Endpoints_Stop.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/purge": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Removes a content from CDN.", + "operationId": "Endpoints_PurgeContent", + "x-ms-examples": { + "Endpoints_PurgeContent": { + "$ref": "./examples/Endpoints_PurgeContent.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "contentFilePaths", + "in": "body", + "description": "The path to the content to be purged. Path can be a full URL, e.g. '/pictures/city.png' which removes a single file, or a directory with a wildcard, e.g. '/pictures/*' which removes all folders and files in the directory.", + "required": true, + "schema": { + "$ref": "#/definitions/PurgeParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/load": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Pre-loads a content to CDN. Available for Verizon Profiles.", + "operationId": "Endpoints_LoadContent", + "x-ms-examples": { + "Endpoints_LoadContent": { + "$ref": "./examples/Endpoints_LoadContent.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "contentFilePaths", + "in": "body", + "description": "The path to the content to be loaded. Path should be a full URL, e.g. ‘/pictures/city.png' which loads a single file ", + "required": true, + "schema": { + "$ref": "#/definitions/LoadParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/validateCustomDomain": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS.", + "operationId": "Endpoints_ValidateCustomDomain", + "x-ms-examples": { + "Endpoints_ValidateCustomDomain": { + "$ref": "./examples/Endpoints_ValidateCustomDomain.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainProperties", + "in": "body", + "description": "Custom domain to be validated.", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateCustomDomainInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ValidateCustomDomainOutput" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/checkResourceUsage": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Checks the quota and usage of geo filters and custom domains under the given endpoint.", + "operationId": "Endpoints_ListResourceUsage", + "x-ms-examples": { + "Endpoints_ListResourceUsage": { + "$ref": "./examples/Endpoints_ListResourceUsage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ResourceUsageListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins": { + "get": { + "tags": [ + "Origins" + ], + "description": "Lists all of the existing origins within an endpoint.", + "operationId": "Origins_ListByEndpoint", + "x-ms-examples": { + "Origins_ListByEndpoint": { + "$ref": "./examples/Origins_ListByEndpoint.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OriginListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}": { + "get": { + "tags": [ + "Origins" + ], + "description": "Gets an existing origin within an endpoint.", + "operationId": "Origins_Get", + "x-ms-examples": { + "Origins_Get": { + "$ref": "./examples/Origins_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Origins" + ], + "description": "Creates a new origin within the specified endpoint.", + "operationId": "Origins_Create", + "x-ms-examples": { + "Origins_Create": { + "$ref": "./examples/Origins_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin that is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "origin", + "in": "body", + "description": "Origin properties", + "required": true, + "schema": { + "$ref": "#/definitions/Origin" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new origin has been created.", + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Origins" + ], + "description": "Updates an existing origin within an endpoint.", + "operationId": "Origins_Update", + "x-ms-examples": { + "Origins_Update": { + "$ref": "./examples/Origins_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "originUpdateProperties", + "in": "body", + "description": "Origin properties", + "required": true, + "schema": { + "$ref": "#/definitions/OriginUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Origins" + ], + "description": "Deletes an existing origin within an endpoint.", + "operationId": "Origins_Delete", + "x-ms-examples": { + "Origins_Delete": { + "$ref": "./examples/Origins_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the origin was not found." + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups": { + "get": { + "tags": [ + "OriginGroups" + ], + "description": "Lists all of the existing origin groups within an endpoint.", + "operationId": "OriginGroups_ListByEndpoint", + "x-ms-examples": { + "OriginsGroups_ListByEndpoint": { + "$ref": "./examples/OriginGroups_ListByEndpoint.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OriginGroupListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups/{originGroupName}": { + "get": { + "tags": [ + "OriginGroups" + ], + "description": "Gets an existing origin group within an endpoint.", + "operationId": "OriginGroups_Get", + "x-ms-examples": { + "OriginGroups_Get": { + "$ref": "./examples/OriginGroups_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "OriginGroups" + ], + "description": "Creates a new origin group within the specified endpoint.", + "operationId": "OriginGroups_Create", + "x-ms-examples": { + "OriginGroups_Create": { + "$ref": "./examples/OriginGroups_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "originGroup", + "in": "body", + "description": "Origin group properties", + "required": true, + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new origin group has been created.", + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "OriginGroups" + ], + "description": "Updates an existing origin group within an endpoint.", + "operationId": "OriginGroups_Update", + "x-ms-examples": { + "OriginGroups_Update": { + "$ref": "./examples/OriginGroups_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "originGroupUpdateProperties", + "in": "body", + "description": "Origin group properties", + "required": true, + "schema": { + "$ref": "#/definitions/OriginGroupUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "OriginGroups" + ], + "description": "Deletes an existing origin group within an endpoint.", + "operationId": "OriginGroups_Delete", + "x-ms-examples": { + "OriginGroups_Delete": { + "$ref": "./examples/OriginGroups_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the origin was not found." + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains": { + "get": { + "tags": [ + "CustomDomains" + ], + "description": "Lists all of the existing custom domains within an endpoint.", + "operationId": "CustomDomains_ListByEndpoint", + "x-ms-examples": { + "CustomDomains_ListByEndpoint": { + "$ref": "./examples/CustomDomains_ListByEndpoint.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomDomainListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}": { + "get": { + "tags": [ + "CustomDomains" + ], + "description": "Gets an existing custom domain within an endpoint.", + "operationId": "CustomDomains_Get", + "x-ms-examples": { + "CustomDomains_Get": { + "$ref": "./examples/CustomDomains_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "CustomDomains" + ], + "description": "Creates a new custom domain within an endpoint.", + "operationId": "CustomDomains_Create", + "x-ms-examples": { + "CustomDomains_Create": { + "$ref": "./examples/CustomDomains_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint.", + "required": true, + "type": "string" + }, + { + "name": "customDomainProperties", + "in": "body", + "description": "Properties required to create a new custom domain.", + "required": true, + "schema": { + "$ref": "#/definitions/CustomDomainParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new custom domain has been created.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "CustomDomains" + ], + "description": "Deletes an existing custom domain within an endpoint.", + "operationId": "CustomDomains_Delete", + "x-ms-examples": { + "CustomDomains_Delete": { + "$ref": "./examples/CustomDomains_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "204": { + "description": "No Content. The request has been accepted but the custom domain was not found" + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/disableCustomHttps": { + "post": { + "tags": [ + "CustomDomains" + ], + "description": "Disable https delivery of the custom domain.", + "operationId": "CustomDomains_DisableCustomHttps", + "x-ms-examples": { + "CustomDomains_DisableCustomHttps": { + "$ref": "./examples/CustomDomains_DisableCustomHttps.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/enableCustomHttps": { + "post": { + "tags": [ + "CustomDomains" + ], + "description": "Enable https delivery of the custom domain.", + "operationId": "CustomDomains_EnableCustomHttps", + "x-ms-examples": { + "CustomDomains_EnableCustomHttpsUsingYourOwnCertificate": { + "$ref": "./examples/CustomDomains_EnableCustomHttpsUsingBYOC.json" + }, + "CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate": { + "$ref": "./examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint.", + "required": true, + "type": "string" + }, + { + "name": "customDomainHttpsParameters", + "in": "body", + "description": "The configuration specifying how to enable HTTPS for the custom domain - using CDN managed certificate or user's own certificate. If not specified, enabling ssl uses CDN managed certificate by default.", + "required": false, + "schema": { + "$ref": "#/definitions/CustomDomainHttpsParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.Cdn/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailability" + ], + "description": "Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.", + "operationId": "CheckNameAvailability", + "x-ms-examples": { + "CheckNameAvailability": { + "$ref": "./examples/CheckNameAvailability.json" + } + }, + "parameters": [ + { + "name": "checkNameAvailabilityInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityInput" + } + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityOutput" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailabilityWithSubscription" + ], + "description": "Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.", + "operationId": "CheckNameAvailabilityWithSubscription", + "x-ms-examples": { + "CheckNameAvailabilityWithSubscription": { + "$ref": "./examples/CheckNameAvailabilityWithSubscription.json" + } + }, + "parameters": [ + { + "name": "checkNameAvailabilityInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityOutput" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/validateProbe": { + "post": { + "tags": [ + "ValidateProbe" + ], + "description": "Check if the probe path is a valid path and the file can be accessed. Probe path is the path to a file hosted on the origin server to help accelerate the delivery of dynamic content via the CDN endpoint. This path is relative to the origin path specified in the endpoint configuration.", + "operationId": "ValidateProbe", + "x-ms-examples": { + "ValidateProbe": { + "$ref": "./examples/ValidateProbe.json" + } + }, + "parameters": [ + { + "name": "validateProbeInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateProbeInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ValidateProbeOutput" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/checkResourceUsage": { + "post": { + "tags": [ + "CheckResourceUsage" + ], + "description": "Check the quota and actual usage of the CDN profiles under the given subscription.", + "operationId": "ResourceUsage_List", + "x-ms-examples": { + "ResourceUsage_List": { + "$ref": "./examples/ResourceUsage_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ResourceUsageListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Cdn/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available CDN REST API operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationsListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Cdn/edgenodes": { + "get": { + "tags": [ + "Edgenodes" + ], + "description": "Edgenodes are the global Point of Presence (POP) locations used to deliver CDN content to end users.", + "operationId": "EdgeNodes_List", + "x-ms-examples": { + "EdgeNodes_List": { + "$ref": "./examples/EdgeNodes_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EdgenodeResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/cdnCanMigrateToAfd": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Checks if CDN profile can be migrated to Azure Frontdoor(Standard/Premium) profile.", + "operationId": "Profiles_CdnCanMigrateToAfd", + "x-ms-examples": { + "Profiles_CdnCanMigrate": { + "$ref": "./examples/CdnProfiles_CanMigrate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/profileNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CanMigrateResult" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/cdnMigrateToAfd": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Migrate the CDN profile to Azure Frontdoor(Standard/Premium) profile. This step prepares the profile for migration and will be followed by Commit to finalize the migration.", + "operationId": "Profiles_CdnMigrateToAfd", + "x-ms-examples": { + "Profiles_CdnMigrate": { + "$ref": "./examples/CdnProfiles_Migrate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/profileNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "description": "Properties needed to migrate the profile.", + "in": "body", + "name": "migrationParameters", + "required": true, + "schema": { + "$ref": "#/definitions/CdnMigrationToAfdParameters" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/MigrateResult" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/migrationAbort": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Abort the migration to Azure Frontdoor Premium/Standard.", + "operationId": "Profiles_MigrationAbort", + "x-ms-examples": { + "Profiles_CdnMigrationCommit": { + "$ref": "./examples/Profiles_MigrationAbort.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/profileNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "Profile": { + "description": "A profile is a logical grouping of endpoints that share the same settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "description": "The pricing tier (defines Azure Front Door Standard or Premium or a CDN provider, feature list and rate) of the profile.", + "$ref": "#/definitions/Sku" + }, + "kind": { + "readOnly": true, + "type": "string", + "description": "Kind of the profile. Used by portal to differentiate traditional CDN profile and new AFD profile." + }, + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities).", + "type": "object", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProfileProperties" + } + }, + "required": [ + "sku" + ] + }, + "ProfileProperties": { + "description": "The JSON object that contains the properties required to create a profile.", + "properties": { + "resourceState": { + "description": "Resource status of the profile.", + "readOnly": true, + "enum": [ + "Creating", + "Active", + "Deleting", + "Disabled", + "Migrating", + "Migrated", + "PendingMigrationCommit", + "CommittingMigration", + "AbortingMigration" + ], + "type": "string", + "x-ms-enum": { + "name": "ProfileResourceState", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "description": "Provisioning status of the profile.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Updating", + "Deleting", + "Creating" + ], + "x-ms-enum": { + "name": "ProfileProvisioningState", + "modelAsString": true + } + }, + "extendedProperties": { + "description": "Key-Value pair representing additional properties for profiles.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "frontDoorId": { + "readOnly": true, + "type": "string", + "description": "The Id of the frontdoor." + }, + "originResponseTimeoutSeconds": { + "description": "Send and receive timeout on forwarding request to the origin. When timeout is reached, the request fails and returns.", + "type": "integer", + "format": "int32", + "minimum": 16, + "exclusiveMinimum": false + }, + "logScrubbing": { + "description": "Defines rules that scrub sensitive fields in the Azure Front Door profile logs.", + "$ref": "#/definitions/ProfileLogScrubbing" + } + } + }, + "ProfileLogScrubbing": { + "description": "Defines rules that scrub sensitive fields in the Azure Front Door profile logs.", + "type": "object", + "properties": { + "state": { + "type": "string", + "description": "State of the log scrubbing config. Default value is Enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ProfileScrubbingState", + "modelAsString": true + } + }, + "scrubbingRules": { + "type": "array", + "items": { + "$ref": "#/definitions/ProfileScrubbingRules" + }, + "x-ms-identifiers": [], + "description": "List of log scrubbing rules applied to the Azure Front Door profile logs." + } + } + }, + "ProfileListResult": { + "description": "Result of the request to list profiles. It contains a list of profile objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Profile" + }, + "description": "List of CDN profiles within a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of profile objects if there are any." + } + } + }, + "ProfileUpdateParameters": { + "type": "object", + "description": "Properties required to update a profile.", + "properties": { + "tags": { + "description": "Profile tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities).", + "type": "object", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProfilePropertiesUpdateParameters" + } + }, + "x-ms-azure-resource": true + }, + "ProfilePropertiesUpdateParameters": { + "type": "object", + "description": "The JSON object containing profile update parameters.", + "properties": { + "originResponseTimeoutSeconds": { + "description": "Send and receive timeout on forwarding request to the origin. When timeout is reached, the request fails and returns.", + "type": "integer", + "format": "int32", + "minimum": 16, + "exclusiveMinimum": false + }, + "logScrubbing": { + "description": "Defines rules to scrub sensitive fields in logs", + "$ref": "#/definitions/ProfileLogScrubbing" + } + } + }, + "ProfileScrubbingRules": { + "description": "Defines the contents of the log scrubbing rules.", + "type": "object", + "required": [ + "matchVariable", + "selectorMatchOperator" + ], + "properties": { + "matchVariable": { + "type": "string", + "enum": [ + "RequestIPAddress", + "RequestUri", + "QueryStringArgNames" + ], + "description": "The variable to be scrubbed from the logs.", + "x-ms-enum": { + "name": "scrubbingRuleEntryMatchVariable", + "modelAsString": true + } + }, + "selectorMatchOperator": { + "type": "string", + "enum": [ + "EqualsAny" + ], + "description": "When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to.", + "x-ms-enum": { + "name": " scrubbingRuleEntryMatchOperator", + "modelAsString": true + } + }, + "selector": { + "type": "string", + "description": "When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to." + }, + "state": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "description": "Defines the state of a log scrubbing rule. Default value is enabled.", + "x-ms-enum": { + "name": " scrubbingRuleEntryState", + "modelAsString": true + } + } + } + }, + "CanMigrateResult": { + "type": "object", + "description": "Result for canMigrate operation.", + "properties": { + "id": { + "description": "Resource ID.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Resource type.", + "readOnly": true, + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CanMigrateProperties" + } + }, + "x-ms-azure-resource": true + }, + "CanMigrateProperties": { + "type": "object", + "properties": { + "canMigrate": { + "readOnly": true, + "description": "Flag that says if the profile can be migrated", + "type": "boolean" + }, + "defaultSku": { + "readOnly": true, + "description": "Recommended sku for the migration", + "type": "string", + "enum": [ + "Standard_AzureFrontDoor", + "Premium_AzureFrontDoor" + ], + "x-ms-enum": { + "name": "CanMigrateDefaultSku", + "modelAsString": true + } + }, + "errors": { + "items": { + "description": "List of migration errors", + "$ref": "#/definitions/MigrationErrorType" + }, + "type": "array", + "x-ms-identifiers": [] + } + } + }, + "MigrationErrorType": { + "description": "Error response indicates CDN service is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "readOnly": true, + "type": "string" + }, + "resourceName": { + "description": "Resource which has the problem.", + "readOnly": true, + "type": "string" + }, + "errorMessage": { + "description": "Error message indicating why the operation failed.", + "readOnly": true, + "type": "string" + }, + "nextSteps": { + "description": "Describes what needs to be done to fix the problem", + "readOnly": true, + "type": "string" + } + } + }, + "CanMigrateParameters": { + "type": "object", + "description": "Request body for CanMigrate operation.", + "required": [ + "classicResourceReference" + ], + "properties": { + "classicResourceReference": { + "description": "Resource reference of the classic cdn profile or classic frontdoor that need to be migrated.", + "$ref": "#/definitions/ResourceReference" + } + }, + "x-ms-azure-resource": true + }, + "MigrationParameters": { + "type": "object", + "description": "Request body for Migrate operation.", + "required": [ + "classicResourceReference", + "sku", + "profileName" + ], + "properties": { + "sku": { + "description": "Sku for the migration", + "$ref": "#/definitions/Sku" + }, + "classicResourceReference": { + "description": "Resource reference of the classic cdn profile or classic frontdoor that need to be migrated.", + "$ref": "#/definitions/ResourceReference" + }, + "profileName": { + "description": "Name of the new profile that need to be created.", + "type": "string" + }, + "migrationWebApplicationFirewallMappings": { + "description": "Waf mapping for the migrated profile", + "type": "array", + "items": { + "description": "List of waf mappings", + "$ref": "#/definitions/MigrationWebApplicationFirewallMapping" + }, + "x-ms-identifiers": [] + } + }, + "x-ms-azure-resource": true + }, + "MigrationWebApplicationFirewallMapping": { + "description": "Web Application Firewall Mapping ", + "type": "object", + "properties": { + "migratedFrom": { + "description": "Migration From Waf policy", + "$ref": "#/definitions/ResourceReference" + }, + "migratedTo": { + "description": "Migration to Waf policy", + "$ref": "#/definitions/ResourceReference" + } + } + }, + "MigrateResult": { + "type": "object", + "description": "Result for migrate operation.", + "properties": { + "id": { + "description": "Resource ID.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Resource type.", + "readOnly": true, + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/MigrateResultProperties" + } + }, + "x-ms-azure-resource": true + }, + "MigrateResultProperties": { + "type": "object", + "properties": { + "migratedProfileResourceId": { + "readOnly": true, + "description": "Arm resource id of the migrated profile", + "$ref": "#/definitions/ResourceReference" + } + } + }, + "SsoUri": { + "description": "The URI required to login to the supplemental portal from the Azure portal.", + "type": "object", + "properties": { + "ssoUriValue": { + "description": "The URI used to login to the supplemental portal.", + "readOnly": true, + "type": "string" + } + } + }, + "SupportedOptimizationTypesListResult": { + "description": "The result of the GetSupportedOptimizationTypes API", + "type": "object", + "properties": { + "supportedOptimizationTypes": { + "description": "Supported optimization types for a profile.", + "readOnly": true, + "items": { + "$ref": "#/definitions/OptimizationType" + }, + "type": "array" + } + } + }, + "DeliveryRuleConditionParameters": { + "description": "Defines the parameters for delivery rule match conditions", + "type": "object", + "discriminator": "typeName", + "required": [ + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleRemoteAddressConditionParameters", + "DeliveryRuleRequestMethodConditionParameters", + "DeliveryRuleQueryStringConditionParameters", + "DeliveryRulePostArgsConditionParameters", + "DeliveryRuleRequestUriConditionParameters", + "DeliveryRuleRequestHeaderConditionParameters", + "DeliveryRuleRequestBodyConditionParameters", + "DeliveryRuleRequestSchemeConditionParameters", + "DeliveryRuleUrlPathMatchConditionParameters", + "DeliveryRuleUrlFileExtensionMatchConditionParameters", + "DeliveryRuleUrlFilenameConditionParameters", + "DeliveryRuleHttpVersionConditionParameters", + "DeliveryRuleCookiesConditionParameters", + "DeliveryRuleIsDeviceConditionParameters", + "DeliveryRuleSocketAddrConditionParameters", + "DeliveryRuleClientPortConditionParameters", + "DeliveryRuleServerPortConditionParameters", + "DeliveryRuleHostNameConditionParameters", + "DeliveryRuleSslProtocolConditionParameters" + ], + "x-ms-enum": { + "name": "DeliveryRuleConditionParametersType", + "modelAsString": true + } + } + } + }, + "DeliveryRuleActionParameters": { + "description": "Defines the parameters for delivery rule actions", + "type": "object", + "discriminator": "typeName", + "required": [ + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleUrlRedirectActionParameters", + "DeliveryRuleUrlSigningActionParameters", + "DeliveryRuleOriginGroupOverrideActionParameters", + "DeliveryRuleUrlRewriteActionParameters", + "DeliveryRuleHeaderActionParameters", + "DeliveryRuleCacheExpirationActionParameters", + "DeliveryRuleCacheKeyQueryStringBehaviorActionParameters", + "DeliveryRuleRouteConfigurationOverrideActionParameters" + ], + "x-ms-enum": { + "name": "DeliveryRuleActionParametersType", + "modelAsString": true + } + } + } + }, + "CertificateSourceParameters": { + "description": "Defines the parameters for certificate source", + "type": "object", + "discriminator": "typeName", + "required": [ + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "CdnCertificateSourceParameters", + "KeyVaultCertificateSourceParameters" + ], + "x-ms-enum": { + "name": "CertificateSourceParametersType", + "modelAsString": true + } + } + } + }, + "Endpoint": { + "description": "CDN endpoint is the entity within a CDN profile containing configuration information such as origin, protocol, content caching and delivery behavior. The CDN endpoint uses the URL format .azureedge.net.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EndpointProperties" + } + } + }, + "EndpointProperties": { + "description": "The JSON object that contains the properties required to create an endpoint.", + "required": [ + "origins" + ], + "allOf": [ + { + "$ref": "#/definitions/EndpointPropertiesUpdateParameters" + } + ], + "properties": { + "hostName": { + "description": "The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net", + "type": "string", + "readOnly": true + }, + "origins": { + "description": "The source of the content being delivered via CDN.", + "type": "array", + "items": { + "$ref": "#/definitions/DeepCreatedOrigin" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "originGroups": { + "description": "The origin groups comprising of origins that are used for load balancing the traffic based on availability.", + "type": "array", + "items": { + "$ref": "#/definitions/DeepCreatedOriginGroup" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "customDomains": { + "description": "The custom domains under the endpoint.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/DeepCreatedCustomDomain" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "resourceState": { + "description": "Resource status of the endpoint.", + "readOnly": true, + "enum": [ + "Creating", + "Deleting", + "Running", + "Starting", + "Stopped", + "Stopping" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointResourceState", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "description": "Provisioning status of the endpoint.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Updating", + "Deleting", + "Creating" + ], + "x-ms-enum": { + "name": "EndpointProvisioningState", + "modelAsString": true + } + } + } + }, + "EndpointListResult": { + "description": "Result of the request to list endpoints. It contains a list of endpoint objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Endpoint" + }, + "description": "List of CDN endpoints within a profile" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of endpoint objects if there is any." + } + } + }, + "EndpointUpdateParameters": { + "type": "object", + "description": "Properties required to create or update an endpoint.", + "properties": { + "tags": { + "description": "Endpoint tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EndpointPropertiesUpdateParameters" + } + }, + "x-ms-azure-resource": true + }, + "EndpointPropertiesUpdateParameters": { + "description": "The JSON object containing endpoint update parameters.", + "properties": { + "originPath": { + "description": "A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.", + "type": "string" + }, + "contentTypesToCompress": { + "description": "List of content types on which compression applies. The value should be a valid MIME type.", + "type": "array", + "items": { + "type": "string" + } + }, + "originHostHeader": { + "description": "The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.", + "type": "string" + }, + "isCompressionEnabled": { + "description": "Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB.", + "type": "boolean" + }, + "isHttpAllowed": { + "description": "Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.", + "type": "boolean", + "default": true + }, + "isHttpsAllowed": { + "description": "Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.", + "type": "boolean", + "default": true + }, + "queryStringCachingBehavior": { + "description": "Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.", + "$ref": "#/definitions/QueryStringCachingBehavior", + "default": "NotSet" + }, + "optimizationType": { + "description": "Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization.", + "$ref": "#/definitions/OptimizationType" + }, + "probePath": { + "description": "Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin.", + "type": "string" + }, + "geoFilters": { + "description": "List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/", + "type": "array", + "items": { + "$ref": "#/definitions/GeoFilter" + }, + "x-ms-identifiers": [] + }, + "defaultOriginGroup": { + "description": "A reference to the origin group.", + "type": "object", + "$ref": "#/definitions/ResourceReference" + }, + "urlSigningKeys": { + "description": "List of keys used to validate the signed URL hashes.", + "type": "array", + "items": { + "$ref": "#/definitions/UrlSigningKey" + }, + "x-ms-identifiers": [ + "keyId" + ] + }, + "deliveryPolicy": { + "description": "A policy that specifies the delivery rules to be used for an endpoint.", + "type": "object", + "required": [ + "rules" + ], + "properties": { + "description": { + "description": "User-friendly description of the policy.", + "type": "string" + }, + "rules": { + "description": "A list of the delivery rules.", + "type": "array", + "items": { + "$ref": "#/definitions/DeliveryRule" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "webApplicationFirewallPolicyLink": { + "description": "Defines the Web Application Firewall policy for the endpoint (if applicable)", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + } + } + } + }, + "DeliveryRule": { + "description": "A rule that specifies a set of actions and conditions", + "type": "object", + "required": [ + "order", + "actions" + ], + "properties": { + "name": { + "description": "Name of the rule", + "type": "string" + }, + "order": { + "description": "The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.", + "type": "integer", + "format": "int32" + }, + "conditions": { + "description": "A list of conditions that must be matched for the actions to be executed", + "type": "array", + "items": { + "$ref": "#/definitions/DeliveryRuleCondition" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "actions": { + "description": "A list of actions that are executed when all the conditions of a rule are satisfied.", + "type": "array", + "items": { + "$ref": "#/definitions/DeliveryRuleAction" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "DeliveryRuleCondition": { + "description": "A condition for the delivery rule.", + "discriminator": "name", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "The name of the condition for the delivery rule.", + "type": "string", + "enum": [ + "RemoteAddress", + "RequestMethod", + "QueryString", + "PostArgs", + "RequestUri", + "RequestHeader", + "RequestBody", + "RequestScheme", + "UrlPath", + "UrlFileExtension", + "UrlFileName", + "HttpVersion", + "Cookies", + "IsDevice", + "SocketAddr", + "ClientPort", + "ServerPort", + "HostName", + "SslProtocol" + ], + "x-ms-enum": { + "name": "MatchVariable", + "modelAsString": true + } + } + } + }, + "DeliveryRuleRemoteAddressCondition": { + "description": "Defines the RemoteAddress condition for the delivery rule.", + "x-ms-discriminator-value": "RemoteAddress", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RemoteAddressMatchConditionParameters" + } + } + }, + "DeliveryRuleRequestMethodCondition": { + "description": "Defines the RequestMethod condition for the delivery rule.", + "x-ms-discriminator-value": "RequestMethod", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RequestMethodMatchConditionParameters" + } + } + }, + "DeliveryRuleQueryStringCondition": { + "description": "Defines the QueryString condition for the delivery rule.", + "x-ms-discriminator-value": "QueryString", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/QueryStringMatchConditionParameters" + } + } + }, + "DeliveryRulePostArgsCondition": { + "description": "Defines the PostArgs condition for the delivery rule.", + "x-ms-discriminator-value": "PostArgs", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/PostArgsMatchConditionParameters" + } + } + }, + "DeliveryRuleRequestUriCondition": { + "description": "Defines the RequestUri condition for the delivery rule.", + "x-ms-discriminator-value": "RequestUri", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RequestUriMatchConditionParameters" + } + } + }, + "DeliveryRuleRequestHeaderCondition": { + "description": "Defines the RequestHeader condition for the delivery rule.", + "x-ms-discriminator-value": "RequestHeader", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RequestHeaderMatchConditionParameters" + } + } + }, + "DeliveryRuleRequestBodyCondition": { + "description": "Defines the RequestBody condition for the delivery rule.", + "x-ms-discriminator-value": "RequestBody", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RequestBodyMatchConditionParameters" + } + } + }, + "DeliveryRuleRequestSchemeCondition": { + "description": "Defines the RequestScheme condition for the delivery rule.", + "x-ms-discriminator-value": "RequestScheme", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RequestSchemeMatchConditionParameters" + } + } + }, + "DeliveryRuleUrlPathCondition": { + "description": "Defines the UrlPath condition for the delivery rule.", + "x-ms-discriminator-value": "UrlPath", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/UrlPathMatchConditionParameters" + } + } + }, + "DeliveryRuleUrlFileExtensionCondition": { + "description": "Defines the UrlFileExtension condition for the delivery rule.", + "x-ms-discriminator-value": "UrlFileExtension", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/UrlFileExtensionMatchConditionParameters" + } + } + }, + "DeliveryRuleUrlFileNameCondition": { + "description": "Defines the UrlFileName condition for the delivery rule.", + "x-ms-discriminator-value": "UrlFileName", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/UrlFileNameMatchConditionParameters" + } + } + }, + "DeliveryRuleHttpVersionCondition": { + "description": "Defines the HttpVersion condition for the delivery rule.", + "x-ms-discriminator-value": "HttpVersion", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/HttpVersionMatchConditionParameters" + } + } + }, + "DeliveryRuleCookiesCondition": { + "description": "Defines the Cookies condition for the delivery rule.", + "x-ms-discriminator-value": "Cookies", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/CookiesMatchConditionParameters" + } + } + }, + "DeliveryRuleIsDeviceCondition": { + "description": "Defines the IsDevice condition for the delivery rule.", + "x-ms-discriminator-value": "IsDevice", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/IsDeviceMatchConditionParameters" + } + } + }, + "DeliveryRuleSocketAddrCondition": { + "description": "Defines the SocketAddress condition for the delivery rule.", + "type": "object", + "x-ms-discriminator-value": "SocketAddr", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/SocketAddrMatchConditionParameters" + } + } + }, + "DeliveryRuleClientPortCondition": { + "description": "Defines the ClientPort condition for the delivery rule.", + "type": "object", + "x-ms-discriminator-value": "ClientPort", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/ClientPortMatchConditionParameters" + } + } + }, + "DeliveryRuleServerPortCondition": { + "description": "Defines the ServerPort condition for the delivery rule.", + "type": "object", + "x-ms-discriminator-value": "ServerPort", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/ServerPortMatchConditionParameters" + } + } + }, + "DeliveryRuleHostNameCondition": { + "description": "Defines the HostName condition for the delivery rule.", + "type": "object", + "x-ms-discriminator-value": "HostName", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/HostNameMatchConditionParameters" + } + } + }, + "DeliveryRuleSslProtocolCondition": { + "description": "Defines the SslProtocol condition for the delivery rule.", + "type": "object", + "x-ms-discriminator-value": "SslProtocol", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/SslProtocolMatchConditionParameters" + } + } + }, + "RemoteAddressMatchConditionParameters": { + "description": "Defines the parameters for RemoteAddress match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleRemoteAddressConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "IPMatch", + "GeoMatch" + ], + "x-ms-enum": { + "name": "RemoteAddressOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "Match values to match against. The operator will apply to each value in here with OR semantics. If any of them match the variable with the given operator this match condition is considered a match.", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "RequestMethodMatchConditionParameters": { + "description": "Defines the parameters for RequestMethod match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleRequestMethodConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Equal" + ], + "x-ms-enum": { + "name": "RequestMethodOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string", + "enum": [ + "GET", + "HEAD", + "POST", + "PUT", + "DELETE", + "OPTIONS", + "TRACE" + ], + "x-ms-enum": { + "name": "RequestMethodMatchValue", + "modelAsString": true + } + } + } + } + }, + "QueryStringMatchConditionParameters": { + "description": "Defines the parameters for QueryString match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleQueryStringConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "QueryStringOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "PostArgsMatchConditionParameters": { + "description": "Defines the parameters for PostArgs match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRulePostArgsConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "selector": { + "description": "Name of PostArg to be matched", + "type": "string" + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "PostArgsOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "RequestUriMatchConditionParameters": { + "description": "Defines the parameters for RequestUri match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleRequestUriConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "RequestUriOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "RequestHeaderMatchConditionParameters": { + "description": "Defines the parameters for RequestHeader match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleRequestHeaderConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "selector": { + "description": "Name of Header to be matched", + "type": "string" + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "RequestHeaderOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "RequestBodyMatchConditionParameters": { + "description": "Defines the parameters for RequestBody match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleRequestBodyConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "RequestBodyOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "RequestSchemeMatchConditionParameters": { + "description": "Defines the parameters for RequestScheme match conditions ", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleRequestSchemeConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Equal" + ] + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string", + "enum": [ + "HTTP", + "HTTPS" + ], + "x-ms-enum": { + "name": "RequestSchemeMatchValue", + "modelAsString": true + } + } + } + } + }, + "UrlPathMatchConditionParameters": { + "description": "Defines the parameters for UrlPath match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleUrlPathMatchConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "Wildcard", + "RegEx" + ], + "x-ms-enum": { + "name": "UrlPathOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "UrlFileExtensionMatchConditionParameters": { + "description": "Defines the parameters for UrlFileExtension match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleUrlFileExtensionMatchConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "UrlFileExtensionOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "UrlFileNameMatchConditionParameters": { + "description": "Defines the parameters for UrlFilename match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleUrlFilenameConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "UrlFileNameOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "HttpVersionMatchConditionParameters": { + "description": "Defines the parameters for HttpVersion match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleHttpVersionConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Equal" + ], + "x-ms-enum": { + "name": "HttpVersionOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "CookiesMatchConditionParameters": { + "description": "Defines the parameters for Cookies match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleCookiesConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "selector": { + "description": "Name of Cookies to be matched", + "type": "string" + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "CookiesOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "IsDeviceMatchConditionParameters": { + "description": "Defines the parameters for IsDevice match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleIsDeviceConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Equal" + ], + "x-ms-enum": { + "name": "IsDeviceOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string", + "enum": [ + "Mobile", + "Desktop" + ], + "x-ms-enum": { + "name": "IsDeviceMatchValue", + "modelAsString": true + } + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "SocketAddrMatchConditionParameters": { + "description": "Defines the parameters for SocketAddress match conditions", + "type": "object", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleSocketAddrConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "IPMatch" + ], + "x-ms-enum": { + "name": "SocketAddrOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "ClientPortMatchConditionParameters": { + "description": "Defines the parameters for ClientPort match conditions", + "type": "object", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleClientPortConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "ClientPortOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "ServerPortMatchConditionParameters": { + "description": "Defines the parameters for ServerPort match conditions", + "type": "object", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleServerPortConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "ServerPortOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "HostNameMatchConditionParameters": { + "description": "Defines the parameters for HostName match conditions", + "type": "object", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleHostNameConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "HostNameOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "SslProtocolMatchConditionParameters": { + "description": "Defines the parameters for SslProtocol match conditions", + "type": "object", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleSslProtocolConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Equal" + ], + "x-ms-enum": { + "name": "SslProtocolOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "$ref": "#/definitions/SslProtocol" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "DeliveryRuleAction": { + "description": "An action for the delivery rule.", + "discriminator": "name", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "The name of the action for the delivery rule.", + "type": "string", + "enum": [ + "CacheExpiration", + "CacheKeyQueryString", + "ModifyRequestHeader", + "ModifyResponseHeader", + "UrlRedirect", + "UrlRewrite", + "UrlSigning", + "OriginGroupOverride", + "RouteConfigurationOverride" + ], + "x-ms-enum": { + "name": "DeliveryRuleActionName", + "modelAsString": true + } + } + } + }, + "UrlRedirectAction": { + "description": "Defines the url redirect action for the delivery rule.", + "x-ms-discriminator-value": "UrlRedirect", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/UrlRedirectActionParameters" + } + } + }, + "UrlRedirectActionParameters": { + "description": "Defines the parameters for the url redirect action.", + "required": [ + "redirectType" + ], + "x-ms-discriminator-value": "DeliveryRuleUrlRedirectActionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleActionParameters" + } + ], + "properties": { + "redirectType": { + "description": "The redirect type the rule will use when redirecting traffic.", + "type": "string", + "enum": [ + "Moved", + "Found", + "TemporaryRedirect", + "PermanentRedirect" + ], + "x-ms-enum": { + "name": "RedirectType", + "modelAsString": true + } + }, + "destinationProtocol": { + "description": "Protocol to use for the redirect. The default value is MatchRequest", + "type": "string", + "enum": [ + "MatchRequest", + "Http", + "Https" + ], + "x-ms-enum": { + "name": "DestinationProtocol", + "modelAsString": true + } + }, + "customPath": { + "description": "The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.", + "type": "string" + }, + "customHostname": { + "description": "Host to redirect. Leave empty to use the incoming host as the destination host.", + "type": "string" + }, + "customQueryString": { + "description": "The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in = format. ? and & will be added automatically so do not include them.", + "type": "string" + }, + "customFragment": { + "type": "string", + "description": "Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #." + } + } + }, + "UrlSigningAction": { + "description": "Defines the url signing action for the delivery rule.", + "x-ms-discriminator-value": "UrlSigning", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/UrlSigningActionParameters" + } + } + }, + "UrlSigningActionParameters": { + "description": "Defines the parameters for the Url Signing action.", + "x-ms-discriminator-value": "DeliveryRuleUrlSigningActionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleActionParameters" + } + ], + "properties": { + "algorithm": { + "description": "Algorithm to use for URL signing", + "type": "string", + "enum": [ + "SHA256" + ], + "x-ms-enum": { + "name": "algorithm", + "modelAsString": true + } + }, + "parameterNameOverride": { + "description": "Defines which query string parameters in the url to be considered for expires, key id etc. ", + "type": "array", + "items": { + "$ref": "#/definitions/UrlSigningParamIdentifier" + }, + "x-ms-identifiers": [ + "paramName" + ] + } + } + }, + "UrlSigningParamIdentifier": { + "description": "Defines how to identify a parameter for a specific purpose e.g. expires", + "required": [ + "paramIndicator", + "paramName" + ], + "properties": { + "paramIndicator": { + "description": "Indicates the purpose of the parameter", + "type": "string", + "enum": [ + "Expires", + "KeyId", + "Signature" + ], + "x-ms-enum": { + "name": "paramIndicator", + "modelAsString": true + } + }, + "paramName": { + "description": "Parameter name", + "type": "string" + } + } + }, + "OriginGroupOverrideAction": { + "description": "Defines the origin group override action for the delivery rule.", + "x-ms-discriminator-value": "OriginGroupOverride", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/OriginGroupOverrideActionParameters" + } + } + }, + "OriginGroupOverrideActionParameters": { + "description": "Defines the parameters for the origin group override action.", + "required": [ + "originGroup" + ], + "x-ms-discriminator-value": "DeliveryRuleOriginGroupOverrideActionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleActionParameters" + } + ], + "properties": { + "originGroup": { + "description": "defines the OriginGroup that would override the DefaultOriginGroup.", + "type": "object", + "$ref": "#/definitions/ResourceReference" + } + } + }, + "UrlRewriteAction": { + "description": "Defines the url rewrite action for the delivery rule.", + "x-ms-discriminator-value": "UrlRewrite", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/UrlRewriteActionParameters" + } + } + }, + "UrlRewriteActionParameters": { + "description": "Defines the parameters for the url rewrite action.", + "required": [ + "sourcePattern", + "destination" + ], + "x-ms-discriminator-value": "DeliveryRuleUrlRewriteActionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleActionParameters" + } + ], + "properties": { + "sourcePattern": { + "description": "define a request URI pattern that identifies the type of requests that may be rewritten. If value is blank, all strings are matched.", + "type": "string" + }, + "destination": { + "description": "Define the relative URL to which the above requests will be rewritten by.", + "type": "string" + }, + "preserveUnmatchedPath": { + "description": "Whether to preserve unmatched path. Default value is true.", + "type": "boolean" + } + } + }, + "DeliveryRuleRequestHeaderAction": { + "description": "Defines the request header action for the delivery rule.", + "x-ms-discriminator-value": "ModifyRequestHeader", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/HeaderActionParameters" + } + } + }, + "DeliveryRuleResponseHeaderAction": { + "description": "Defines the response header action for the delivery rule.", + "x-ms-discriminator-value": "ModifyResponseHeader", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/HeaderActionParameters" + } + } + }, + "HeaderActionParameters": { + "description": "Defines the parameters for the request header action.", + "required": [ + "headerAction", + "headerName" + ], + "x-ms-discriminator-value": "DeliveryRuleHeaderActionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleActionParameters" + } + ], + "properties": { + "headerAction": { + "description": "Action to perform", + "type": "string", + "enum": [ + "Append", + "Overwrite", + "Delete" + ], + "x-ms-enum": { + "name": "HeaderAction", + "modelAsString": true + } + }, + "headerName": { + "description": "Name of the header to modify", + "type": "string" + }, + "value": { + "description": "Value for the specified action", + "type": "string" + } + } + }, + "DeliveryRuleCacheExpirationAction": { + "description": "Defines the cache expiration action for the delivery rule.", + "x-ms-discriminator-value": "CacheExpiration", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/CacheExpirationActionParameters" + } + } + }, + "CacheExpirationActionParameters": { + "description": "Defines the parameters for the cache expiration action.", + "required": [ + "cacheBehavior", + "cacheType" + ], + "x-ms-discriminator-value": "DeliveryRuleCacheExpirationActionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleActionParameters" + } + ], + "properties": { + "cacheBehavior": { + "description": "Caching behavior for the requests", + "type": "string", + "enum": [ + "BypassCache", + "Override", + "SetIfMissing" + ], + "x-ms-enum": { + "name": "cacheBehavior", + "modelAsString": true + } + }, + "cacheType": { + "description": "The level at which the content needs to be cached.", + "type": "string", + "enum": [ + "All" + ], + "x-ms-enum": { + "name": "CacheType", + "modelAsString": true + } + }, + "cacheDuration": { + "description": "The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss", + "type": "string", + "x-nullable": true + } + } + }, + "DeliveryRuleCacheKeyQueryStringAction": { + "description": "Defines the cache-key query string action for the delivery rule.", + "x-ms-discriminator-value": "CacheKeyQueryString", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/CacheKeyQueryStringActionParameters" + } + } + }, + "CacheKeyQueryStringActionParameters": { + "description": "Defines the parameters for the cache-key query string action.", + "required": [ + "queryStringBehavior" + ], + "x-ms-discriminator-value": "DeliveryRuleCacheKeyQueryStringBehaviorActionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleActionParameters" + } + ], + "properties": { + "queryStringBehavior": { + "description": "Caching behavior for the requests", + "type": "string", + "enum": [ + "Include", + "IncludeAll", + "Exclude", + "ExcludeAll" + ], + "x-ms-enum": { + "name": "queryStringBehavior", + "modelAsString": true + } + }, + "queryParameters": { + "description": "query parameters to include or exclude (comma separated).", + "type": "string", + "x-nullable": true + } + } + }, + "DeliveryRuleRouteConfigurationOverrideAction": { + "description": "Defines the route configuration override action for the delivery rule. Only applicable to Frontdoor Standard/Premium Profiles.", + "type": "object", + "x-ms-discriminator-value": "RouteConfigurationOverride", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/RouteConfigurationOverrideActionParameters" + } + } + }, + "RouteConfigurationOverrideActionParameters": { + "description": "Defines the parameters for the route configuration override action.", + "type": "object", + "x-ms-discriminator-value": "DeliveryRuleRouteConfigurationOverrideActionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleActionParameters" + } + ], + "properties": { + "originGroupOverride": { + "description": "A reference to the origin group override configuration. Leave empty to use the default origin group on route.", + "type": "object", + "$ref": "#/definitions/OriginGroupOverride" + }, + "cacheConfiguration": { + "description": "The caching configuration associated with this rule. To disable caching, do not provide a cacheConfiguration object.", + "type": "object", + "$ref": "#/definitions/CacheConfiguration" + } + } + }, + "OriginGroupOverride": { + "description": "Defines the parameters for the origin group override configuration.", + "type": "object", + "properties": { + "originGroup": { + "description": "defines the OriginGroup that would override the DefaultOriginGroup on route.", + "type": "object", + "$ref": "#/definitions/ResourceReference" + }, + "forwardingProtocol": { + "description": "Protocol this rule will use when forwarding traffic to backends.", + "type": "string", + "enum": [ + "HttpOnly", + "HttpsOnly", + "MatchRequest" + ], + "x-ms-enum": { + "name": "ForwardingProtocol", + "modelAsString": true + } + } + } + }, + "CacheConfiguration": { + "description": "Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.", + "type": "object", + "properties": { + "queryStringCachingBehavior": { + "description": "Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.", + "enum": [ + "IgnoreQueryString", + "UseQueryString", + "IgnoreSpecifiedQueryStrings", + "IncludeSpecifiedQueryStrings" + ], + "type": "string", + "x-ms-enum": { + "name": "ruleQueryStringCachingBehavior", + "modelAsString": true + } + }, + "queryParameters": { + "description": "query parameters to include or exclude (comma separated).", + "type": "string" + }, + "isCompressionEnabled": { + "description": "Indicates whether content compression is enabled. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.", + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ruleIsCompressionEnabled", + "modelAsString": true + } + }, + "cacheBehavior": { + "description": "Caching behavior for the requests", + "type": "string", + "enum": [ + "HonorOrigin", + "OverrideAlways", + "OverrideIfOriginMissing" + ], + "x-ms-enum": { + "name": "ruleCacheBehavior", + "modelAsString": true + } + }, + "cacheDuration": { + "description": "The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss", + "type": "string" + } + } + }, + "transform": { + "description": "Describes what transforms are applied before matching", + "type": "string", + "enum": [ + "Lowercase", + "Uppercase", + "Trim", + "UrlDecode", + "UrlEncode", + "RemoveNulls" + ], + "x-ms-enum": { + "name": "transform", + "modelAsString": true + } + }, + "SslProtocol": { + "description": "The protocol of an established TLS connection.", + "type": "string", + "enum": [ + "TLSv1", + "TLSv1.1", + "TLSv1.2" + ], + "x-ms-enum": { + "name": "SslProtocol", + "modelAsString": true + } + }, + "DeepCreatedOrigin": { + "description": "The main origin of CDN content which is added when creating a CDN endpoint.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "Origin name which must be unique within the endpoint. ", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DeepCreatedOriginProperties" + } + }, + "x-ms-azure-resource": true + }, + "DeepCreatedOriginProperties": { + "description": "Properties of the origin created on the CDN endpoint.", + "type": "object", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint.", + "type": "string" + }, + "httpPort": { + "description": "The value of the HTTP port. Must be between 1 and 65535.", + "type": "integer", + "format": "int32", + "maximum": 65535, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false + }, + "httpsPort": { + "description": "The value of the HTTPS port. Must be between 1 and 65535.", + "type": "integer", + "format": "int32", + "maximum": 65535, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false + }, + "originHostHeader": { + "description": "The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.", + "type": "string" + }, + "priority": { + "description": "Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.", + "type": "integer", + "format": "int32", + "maximum": 5, + "minimum": 1 + }, + "weight": { + "description": "Weight of the origin in given origin group for load balancing. Must be between 1 and 1000", + "type": "integer", + "format": "int32", + "maximum": 1000, + "minimum": 1 + }, + "enabled": { + "description": "Origin is enabled for load balancing or not. By default, origin is always enabled.", + "type": "boolean" + }, + "privateLinkAlias": { + "description": "The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'", + "type": "string" + }, + "privateLinkResourceId": { + "description": "The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'", + "type": "string" + }, + "privateLinkLocation": { + "description": "The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated", + "type": "string" + }, + "privateLinkApprovalMessage": { + "description": "A custom message to be included in the approval request to connect to the Private Link.", + "type": "string" + }, + "privateEndpointStatus": { + "description": "The approval status for the connection to the Private Link", + "$ref": "#/definitions/PrivateEndpointStatus", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "DeepCreatedOriginGroup": { + "description": "The origin group for CDN content which is added when creating a CDN endpoint. Traffic is sent to the origins within the origin group based on origin health.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "Origin group name which must be unique within the endpoint.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DeepCreatedOriginGroupProperties" + } + }, + "x-ms-azure-resource": true + }, + "DeepCreatedOriginGroupProperties": { + "description": "Properties of the origin group created on the CDN endpoint.", + "type": "object", + "required": [ + "origins" + ], + "properties": { + "healthProbeSettings": { + "description": "Health probe settings to the origin that is used to determine the health of the origin.", + "type": "object", + "$ref": "#/definitions/HealthProbeParameters" + }, + "origins": { + "description": "The source of the content being delivered via CDN within given origin group.", + "type": "array", + "items": { + "description": "A reference to a origin.", + "$ref": "#/definitions/ResourceReference" + } + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": { + "description": "Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.", + "type": "integer", + "format": "int32", + "maximum": 50, + "minimum": 0 + }, + "responseBasedOriginErrorDetectionSettings": { + "description": "The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported.", + "type": "object", + "$ref": "#/definitions/ResponseBasedOriginErrorDetectionParameters" + } + }, + "x-ms-azure-resource": true + }, + "ResourceReference": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + }, + "description": "Reference to another resource.", + "x-ms-azure-resource": true + }, + "GeoFilter": { + "description": "Rules defining user's geo access within a CDN endpoint.", + "type": "object", + "required": [ + "relativePath", + "action", + "countryCodes" + ], + "properties": { + "relativePath": { + "description": "Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.)", + "type": "string" + }, + "action": { + "description": "Action of the geo filter, i.e. allow or block access.", + "enum": [ + "Block", + "Allow" + ], + "type": "string", + "x-ms-enum": { + "name": "GeoFilterActions", + "modelAsString": false + } + }, + "countryCodes": { + "description": "Two letter country or region codes defining user country or region access in a geo filter, e.g. AU, MX, US.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PurgeParameters": { + "type": "object", + "description": "Parameters required for content purge.", + "required": [ + "contentPaths" + ], + "properties": { + "contentPaths": { + "description": "The path to the content to be purged. Can describe a file path or a wild card directory.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "UrlSigningKey": { + "description": "Url signing key", + "required": [ + "keyId", + "keySourceParameters" + ], + "properties": { + "keyId": { + "description": "Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash.", + "type": "string" + }, + "keySourceParameters": { + "description": "Defines the parameters for using customer key vault for Url Signing Key.", + "$ref": "#/definitions/KeyVaultSigningKeyParameters" + } + } + }, + "KeyVaultSigningKeyParameters": { + "description": "Describes the parameters for using a user's KeyVault for URL Signing Key.", + "required": [ + "typeName", + "subscriptionId", + "resourceGroupName", + "vaultName", + "secretName", + "secretVersion" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "KeyVaultSigningKeyParameters" + ], + "x-ms-enum": { + "name": "KeyVaultSigningKeyParametersType", + "modelAsString": true + } + }, + "subscriptionId": { + "description": "Subscription Id of the user's Key Vault containing the secret", + "type": "string" + }, + "resourceGroupName": { + "description": "Resource group of the user's Key Vault containing the secret", + "type": "string" + }, + "vaultName": { + "description": "The name of the user's Key Vault containing the secret", + "type": "string" + }, + "secretName": { + "description": "The name of secret in Key Vault.", + "type": "string" + }, + "secretVersion": { + "description": "The version(GUID) of secret in Key Vault.", + "type": "string" + } + } + }, + "LoadParameters": { + "type": "object", + "description": "Parameters required for content load.", + "required": [ + "contentPaths" + ], + "properties": { + "contentPaths": { + "description": "The path to the content to be loaded. Path should be a relative file URL of the origin.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Origin": { + "description": "CDN origin is the source of the content being delivered via CDN. When the edge nodes represented by an endpoint do not have the requested content cached, they attempt to fetch it from one or more of the configured origins.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OriginProperties" + } + } + }, + "OriginProperties": { + "description": "The JSON object that contains the properties of the origin.", + "required": [ + "hostName" + ], + "allOf": [ + { + "$ref": "#/definitions/OriginUpdatePropertiesParameters" + } + ], + "properties": { + "resourceState": { + "description": "Resource status of the origin.", + "readOnly": true, + "enum": [ + "Creating", + "Active", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "OriginResourceState", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "description": "Provisioning status of the origin.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Updating", + "Deleting", + "Creating" + ], + "x-ms-enum": { + "name": "OriginProvisioningState", + "modelAsString": true + } + }, + "privateEndpointStatus": { + "description": "The approval status for the connection to the Private Link", + "$ref": "#/definitions/PrivateEndpointStatus", + "type": "string", + "readOnly": true + } + } + }, + "OriginUpdateParameters": { + "type": "object", + "description": "Origin properties needed for origin update.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OriginUpdatePropertiesParameters" + } + }, + "x-ms-azure-resource": true + }, + "OriginUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the origin.", + "properties": { + "hostName": { + "description": "The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.", + "type": "string" + }, + "httpPort": { + "description": "The value of the HTTP port. Must be between 1 and 65535.", + "type": "integer", + "format": "int32", + "maximum": 65535, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false + }, + "httpsPort": { + "description": "The value of the HTTPS port. Must be between 1 and 65535.", + "type": "integer", + "format": "int32", + "maximum": 65535, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false + }, + "originHostHeader": { + "description": "The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint", + "type": "string" + }, + "priority": { + "description": "Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5", + "type": "integer", + "format": "int32", + "maximum": 5, + "minimum": 1 + }, + "weight": { + "description": "Weight of the origin in given origin group for load balancing. Must be between 1 and 1000", + "type": "integer", + "format": "int32", + "maximum": 1000, + "minimum": 1 + }, + "enabled": { + "description": "Origin is enabled for load balancing or not", + "type": "boolean" + }, + "privateLinkAlias": { + "description": "The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'", + "type": "string" + }, + "privateLinkResourceId": { + "description": "The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'", + "type": "string" + }, + "privateLinkLocation": { + "description": "The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated", + "type": "string" + }, + "privateLinkApprovalMessage": { + "description": "A custom message to be included in the approval request to connect to the Private Link.", + "type": "string" + } + } + }, + "OriginListResult": { + "description": "Result of the request to list origins. It contains a list of origin objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Origin" + }, + "description": "List of CDN origins within an endpoint" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of origin objects if there are any." + } + } + }, + "OriginGroup": { + "description": "Origin group comprising of origins is used for load balancing to origins when the content cannot be served from CDN.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OriginGroupProperties" + } + } + }, + "OriginGroupProperties": { + "description": "The JSON object that contains the properties of the origin group.", + "type": "object", + "required": [ + "origins" + ], + "allOf": [ + { + "$ref": "#/definitions/OriginGroupUpdatePropertiesParameters" + } + ], + "properties": { + "resourceState": { + "description": "Resource status of the origin group.", + "readOnly": true, + "enum": [ + "Creating", + "Active", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "OriginGroupResourceState", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "description": "Provisioning status of the origin group.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Updating", + "Deleting", + "Creating" + ], + "x-ms-enum": { + "name": "OriginGroupProvisioningState", + "modelAsString": true + } + } + } + }, + "OriginGroupUpdateParameters": { + "type": "object", + "description": "Origin group properties needed for origin group creation or update.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OriginGroupUpdatePropertiesParameters" + } + }, + "x-ms-azure-resource": true + }, + "OriginGroupUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the origin group.", + "properties": { + "healthProbeSettings": { + "description": "Health probe settings to the origin that is used to determine the health of the origin.", + "type": "object", + "$ref": "#/definitions/HealthProbeParameters" + }, + "origins": { + "description": "The source of the content being delivered via CDN within given origin group.", + "type": "array", + "items": { + "description": "A reference to a origin.", + "$ref": "#/definitions/ResourceReference" + } + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": { + "description": "Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.", + "type": "integer", + "format": "int32", + "maximum": 50, + "minimum": 0 + }, + "responseBasedOriginErrorDetectionSettings": { + "description": "The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.", + "type": "object", + "$ref": "#/definitions/ResponseBasedOriginErrorDetectionParameters" + } + } + }, + "HealthProbeParameters": { + "description": "The JSON object that contains the properties to send health probes to origin.", + "properties": { + "probePath": { + "description": "The path relative to the origin that is used to determine the health of the origin.", + "type": "string" + }, + "probeRequestType": { + "description": "The type of health probe request that is made.", + "enum": [ + "NotSet", + "GET", + "HEAD" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthProbeRequestType", + "modelAsString": false + } + }, + "probeProtocol": { + "description": "Protocol to use for health probe.", + "type": "string", + "enum": [ + "NotSet", + "Http", + "Https" + ], + "x-ms-enum": { + "name": "ProbeProtocol", + "modelAsString": false + } + }, + "probeIntervalInSeconds": { + "description": "The number of seconds between health probes.Default is 240sec.", + "type": "integer", + "format": "int32", + "maximum": 255, + "minimum": 1 + } + } + }, + "ResponseBasedOriginErrorDetectionParameters": { + "description": "The JSON object that contains the properties to determine origin health using real requests/responses.", + "properties": { + "responseBasedDetectedErrorTypes": { + "description": "Type of response errors for real user requests for which origin will be deemed unhealthy", + "type": "string", + "enum": [ + "None", + "TcpErrorsOnly", + "TcpAndHttpErrors" + ], + "x-ms-enum": { + "name": "ResponseBasedDetectedErrorTypes", + "modelAsString": false + } + }, + "responseBasedFailoverThresholdPercentage": { + "description": "The percentage of failed requests in the sample where failover should trigger.", + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 0 + }, + "httpErrorRanges": { + "description": "The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.", + "type": "array", + "items": { + "$ref": "#/definitions/HttpErrorRangeParameters" + }, + "x-ms-identifiers": [] + } + } + }, + "HttpErrorRangeParameters": { + "description": "The JSON object that represents the range for http status codes", + "properties": { + "begin": { + "description": "The inclusive start of the http status code range.", + "type": "integer", + "format": "int32", + "maximum": 999, + "minimum": 100 + }, + "end": { + "description": "The inclusive end of the http status code range.", + "type": "integer", + "format": "int32", + "maximum": 999, + "minimum": 100 + } + } + }, + "OriginGroupListResult": { + "description": "Result of the request to list origin groups. It contains a list of origin groups objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OriginGroup" + }, + "description": "List of CDN origin groups within an endpoint" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of origin objects if there are any." + } + } + }, + "DeepCreatedCustomDomain": { + "description": "Custom domains created on the CDN endpoint.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "Custom domain name.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DeepCreatedCustomDomainProperties" + } + } + }, + "DeepCreatedCustomDomainProperties": { + "description": "Properties of the custom domain created on the CDN endpoint.", + "type": "object", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name of the custom domain. Must be a domain name.", + "type": "string" + }, + "validationData": { + "description": "Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.", + "type": "string" + } + } + }, + "CustomDomain": { + "description": "Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CustomDomainProperties" + } + } + }, + "CustomDomainProperties": { + "description": "The JSON object that contains the properties of the custom domain to create.", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name of the custom domain. Must be a domain name.", + "type": "string" + }, + "resourceState": { + "description": "Resource status of the custom domain.", + "readOnly": true, + "enum": [ + "Creating", + "Active", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomDomainResourceState", + "modelAsString": true + } + }, + "customHttpsProvisioningState": { + "description": "Provisioning status of the custom domain.", + "readOnly": true, + "enum": [ + "Enabling", + "Enabled", + "Disabling", + "Disabled", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomHttpsProvisioningState", + "modelAsString": true + } + }, + "customHttpsProvisioningSubstate": { + "description": "Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.", + "readOnly": true, + "enum": [ + "SubmittingDomainControlValidationRequest", + "PendingDomainControlValidationREquestApproval", + "DomainControlValidationRequestApproved", + "DomainControlValidationRequestRejected", + "DomainControlValidationRequestTimedOut", + "IssuingCertificate", + "DeployingCertificate", + "CertificateDeployed", + "DeletingCertificate", + "CertificateDeleted" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomHttpsProvisioningSubstate", + "modelAsString": true + } + }, + "customHttpsParameters": { + "description": "Certificate parameters for securing custom HTTPS", + "$ref": "#/definitions/CustomDomainHttpsParameters" + }, + "validationData": { + "description": "Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.", + "type": "string" + }, + "provisioningState": { + "description": "Provisioning status of Custom Https of the custom domain.", + "readOnly": true, + "enum": [ + "Enabling", + "Enabled", + "Disabling", + "Disabled", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomHttpsProvisioningState", + "modelAsString": true + } + } + } + }, + "CustomDomainParameters": { + "description": "The customDomain JSON object required for custom domain creation or update.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CustomDomainPropertiesParameters" + } + } + }, + "CustomDomainPropertiesParameters": { + "description": "The JSON object that contains the properties of the custom domain to create.", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name of the custom domain. Must be a domain name.", + "type": "string" + } + } + }, + "CustomDomainHttpsParameters": { + "description": "The JSON object that contains the properties to secure a custom domain.", + "discriminator": "certificateSource", + "required": [ + "certificateSource", + "protocolType" + ], + "properties": { + "certificateSource": { + "description": "Defines the source of the SSL certificate.", + "enum": [ + "AzureKeyVault", + "Cdn" + ], + "type": "string", + "x-ms-enum": { + "name": "CertificateSource", + "modelAsString": true + } + }, + "protocolType": { + "description": "Defines the TLS extension protocol that is used for secure delivery.", + "enum": [ + "ServerNameIndication", + "IPBased" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtocolType", + "modelAsString": true + } + }, + "minimumTlsVersion": { + "description": "TLS protocol version that will be used for Https", + "enum": [ + "None", + "TLS10", + "TLS12" + ], + "type": "string", + "x-ms-enum": { + "name": "MinimumTlsVersion", + "modelAsString": false + } + } + } + }, + "CdnManagedHttpsParameters": { + "description": "Defines the certificate source parameters using CDN managed certificate for enabling SSL.", + "x-ms-discriminator-value": "Cdn", + "allOf": [ + { + "$ref": "#/definitions/CustomDomainHttpsParameters" + } + ], + "required": [ + "certificateSourceParameters" + ], + "properties": { + "certificateSourceParameters": { + "description": "Defines the certificate source parameters using CDN managed certificate for enabling SSL.", + "$ref": "#/definitions/CdnCertificateSourceParameters" + } + } + }, + "CdnCertificateSourceParameters": { + "description": "Defines the parameters for using CDN managed certificate for securing custom domain.", + "required": [ + "certificateType" + ], + "x-ms-discriminator-value": "CdnCertificateSourceParameters", + "allOf": [ + { + "$ref": "#/definitions/CertificateSourceParameters" + } + ], + "properties": { + "certificateType": { + "description": "Type of certificate used", + "enum": [ + "Shared", + "Dedicated" + ], + "type": "string", + "x-ms-enum": { + "name": "CertificateType", + "modelAsString": true + } + } + } + }, + "UserManagedHttpsParameters": { + "description": "Defines the certificate source parameters using user's keyvault certificate for enabling SSL.", + "x-ms-discriminator-value": "AzureKeyVault", + "allOf": [ + { + "$ref": "#/definitions/CustomDomainHttpsParameters" + } + ], + "required": [ + "certificateSourceParameters" + ], + "properties": { + "certificateSourceParameters": { + "description": "Defines the certificate source parameters using user's keyvault certificate for enabling SSL.", + "$ref": "#/definitions/KeyVaultCertificateSourceParameters" + } + } + }, + "KeyVaultCertificateSourceParameters": { + "description": "Describes the parameters for using a user's KeyVault certificate for securing custom domain.", + "required": [ + "subscriptionId", + "resourceGroupName", + "vaultName", + "secretName", + "updateRule", + "deleteRule" + ], + "x-ms-discriminator-value": "KeyVaultCertificateSourceParameters", + "allOf": [ + { + "$ref": "#/definitions/CertificateSourceParameters" + } + ], + "properties": { + "subscriptionId": { + "description": "Subscription Id of the user's Key Vault containing the SSL certificate", + "type": "string" + }, + "resourceGroupName": { + "description": "Resource group of the user's Key Vault containing the SSL certificate", + "type": "string" + }, + "vaultName": { + "description": "The name of the user's Key Vault containing the SSL certificate", + "type": "string" + }, + "secretName": { + "description": "The name of Key Vault Secret (representing the full certificate PFX) in Key Vault.", + "type": "string" + }, + "secretVersion": { + "description": "The version(GUID) of Key Vault Secret in Key Vault.", + "type": "string" + }, + "updateRule": { + "description": "Describes the action that shall be taken when the certificate is updated in Key Vault.", + "type": "string", + "enum": [ + "NoAction" + ], + "x-ms-enum": { + "name": "UpdateRule", + "modelAsString": true + } + }, + "deleteRule": { + "description": "Describes the action that shall be taken when the certificate is removed from Key Vault.", + "type": "string", + "enum": [ + "NoAction" + ], + "x-ms-enum": { + "name": "DeleteRule", + "modelAsString": true + } + } + } + }, + "CustomDomainListResult": { + "description": "Result of the request to list custom domains. It contains a list of custom domain objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CustomDomain" + }, + "description": "List of CDN CustomDomains within an endpoint." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of custom domain objects if there are any." + } + } + }, + "ValidateCustomDomainInput": { + "description": "Input of the custom domain to be validated for DNS mapping.", + "type": "object", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name of the custom domain. Must be a domain name.", + "type": "string" + } + } + }, + "ValidateCustomDomainOutput": { + "description": "Output of custom domain validation.", + "type": "object", + "properties": { + "customDomainValidated": { + "description": "Indicates whether the custom domain is valid or not.", + "readOnly": true, + "type": "boolean" + }, + "reason": { + "description": "The reason why the custom domain is not valid.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "Error message describing why the custom domain is not valid.", + "readOnly": true, + "type": "string" + } + } + }, + "CheckNameAvailabilityInput": { + "description": "Input of CheckNameAvailability API.", + "type": "object", + "required": [ + "name", + "type" + ], + "properties": { + "name": { + "description": "The resource name to validate.", + "type": "string" + }, + "type": { + "description": "The type of the resource whose name is to be validated.", + "$ref": "#/definitions/ResourceType" + } + } + }, + "CheckNameAvailabilityOutput": { + "description": "Output of check name availability API.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "Indicates whether the name is available.", + "readOnly": true, + "type": "boolean" + }, + "reason": { + "description": "The reason why the name is not available.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "The detailed error message describing why the name is not available.", + "readOnly": true, + "type": "string" + } + } + }, + "ValidateProbeInput": { + "description": "Input of the validate probe API.", + "properties": { + "probeURL": { + "description": "The probe URL to validate.", + "type": "string" + } + }, + "required": [ + "probeURL" + ], + "type": "object" + }, + "ValidateProbeOutput": { + "description": "Output of the validate probe API.", + "properties": { + "isValid": { + "description": "Indicates whether the probe URL is accepted or not.", + "readOnly": true, + "type": "boolean" + }, + "errorCode": { + "description": "Specifies the error code when the probe url is not accepted.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "The detailed error message describing why the probe URL is not accepted.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ResourceUsageListResult": { + "description": "Output of check resource usage API.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ResourceUsage" + }, + "x-ms-identifiers": [ + "resourceType" + ], + "description": "List of resource usages." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of custom domain objects if there are any." + } + } + }, + "ResourceUsage": { + "description": "Output of check resource usage API.", + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "readOnly": true, + "description": "Resource type for which the usage is provided." + }, + "unit": { + "type": "string", + "readOnly": true, + "description": "Unit of the usage. e.g. count.", + "enum": [ + "count" + ], + "x-ms-enum": { + "name": "ResourceUsageUnit", + "modelAsString": true + } + }, + "currentValue": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Actual value of usage on the specified resource type." + }, + "limit": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Quota of the specified resource type." + } + } + }, + "ResourceType": { + "description": "Type of CDN resource used in CheckNameAvailability.", + "enum": [ + "Microsoft.Cdn/Profiles/Endpoints", + "Microsoft.Cdn/Profiles/AfdEndpoints" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceType", + "modelAsString": true + } + }, + "OperationsListResult": { + "description": "Result of the request to list CDN operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of CDN operations supported by the CDN resource provider." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "CDN REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "readOnly": true, + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft.Cdn", + "readOnly": true, + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed: Profile, endpoint, etc.", + "readOnly": true, + "type": "string" + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description of operation.", + "readOnly": true, + "type": "string" + } + } + }, + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of operations." + }, + "properties": { + "description": "Properties of operation, include metric specifications.", + "x-ms-client-flatten": true, + "x-ms-client-name": "OperationProperties", + "$ref": "#/definitions/OperationProperties" + } + } + }, + "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 log specifications.", + "type": "object", + "properties": { + "logSpecifications": { + "description": "Log specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "metricSpecifications": { + "description": "Metric specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "LogSpecification": { + "description": "Log specification of operation.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of log specification." + }, + "displayName": { + "type": "string", + "description": "Display name of log specification." + }, + "blobDuration": { + "type": "string", + "description": "Blob duration of specification." + }, + "logFilterPattern": { + "type": "string", + "description": "Pattern to filter based on name" + } + } + }, + "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": "The metric unit. Possible values include: 'Bytes', 'Count', 'Milliseconds'." + }, + "aggregationType": { + "type": "string", + "description": "The metric aggregation type. Possible values include: 'Average', 'Count', 'Total'." + }, + "availabilities": { + "description": "Retention policies of a resource metric.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricAvailability" + }, + "x-ms-identifiers": [] + }, + "supportedTimeGrainTypes": { + "type": "array", + "description": "The supported time grain types for the metrics.", + "items": { + "type": "string" + } + }, + "dimensions": { + "type": "array", + "description": "The dimensions of metric", + "items": { + "$ref": "#/definitions/DimensionProperties" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "fillGapWithZero": { + "type": "boolean", + "description": "Property to specify whether to fill gap with zero." + }, + "metricFilterPattern": { + "type": "string", + "description": "Pattern to filter based on name" + }, + "isInternal": { + "type": "boolean", + "description": "Property to specify metric is internal or not." + } + } + }, + "DimensionProperties": { + "description": "Type of operation: get, read, delete, etc.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of dimension." + }, + "displayName": { + "type": "string", + "description": "Display name of dimension." + }, + "internalName": { + "type": "string", + "description": "Internal name of dimension." + } + } + }, + "MetricAvailability": { + "description": "Retention policy of a resource metric.", + "type": "object", + "properties": { + "timeGrain": { + "type": "string" + }, + "blobDuration": { + "type": "string" + } + } + }, + "EdgenodeResult": { + "description": "Result of the request to list CDN edgenodes. It contains a list of ip address group and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/EdgeNode" + }, + "description": "Edge node of CDN service." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of edgenode list results if there are any." + } + } + }, + "EdgeNode": { + "description": "Edgenode is a global Point of Presence (POP) location used to deliver CDN content to end users.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EdgeNodeProperties" + } + } + }, + "EdgeNodeProperties": { + "description": "The JSON object that contains the properties required to create an edgenode.", + "required": [ + "ipAddressGroups" + ], + "properties": { + "ipAddressGroups": { + "description": "List of ip address groups.", + "type": "array", + "items": { + "$ref": "#/definitions/IpAddressGroup" + }, + "x-ms-identifiers": [ + "deliveryRegion" + ] + } + } + }, + "IpAddressGroup": { + "description": "CDN Ip address group", + "type": "object", + "properties": { + "deliveryRegion": { + "description": "The delivery region of the ip address group", + "type": "string" + }, + "ipv4Addresses": { + "description": "The list of ip v4 addresses.", + "type": "array", + "items": { + "$ref": "#/definitions/cidrIpAddress" + }, + "x-ms-identifiers": [ + "baseIpAddress" + ] + }, + "ipv6Addresses": { + "description": "The list of ip v6 addresses.", + "type": "array", + "items": { + "$ref": "#/definitions/cidrIpAddress" + }, + "x-ms-identifiers": [ + "baseIpAddress" + ] + } + } + }, + "cidrIpAddress": { + "description": "CIDR Ip address", + "type": "object", + "properties": { + "baseIpAddress": { + "description": "Ip address itself.", + "type": "string" + }, + "prefixLength": { + "description": "The length of the prefix of the ip address.", + "type": "integer", + "format": "int32" + } + } + }, + "Resource": { + "description": "The core properties of ARM resources", + "properties": { + "id": { + "description": "Resource ID.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Resource name.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Resource type.", + "readOnly": true, + "type": "string" + }, + "systemData": { + "$ref": "#/definitions/SystemData", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "SystemData": { + "description": "Read only system data", + "readOnly": true, + "type": "object", + "properties": { + "createdBy": { + "type": "string", + "description": "An identifier for the identity that created the resource" + }, + "createdByType": { + "$ref": "#/definitions/IdentityType", + "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": "An identifier for the identity that last modified the resource" + }, + "lastModifiedByType": { + "$ref": "#/definitions/IdentityType", + "description": "The type of identity that last modified the resource" + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)" + } + } + }, + "IdentityType": { + "description": "The type of identity that creates/modifies resources", + "type": "string", + "enum": [ + "user", + "application", + "managedIdentity", + "key" + ], + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": true + } + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + } + }, + "required": [ + "location" + ] + }, + "ProxyResource": { + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": {} + }, + "QueryStringCachingBehavior": { + "description": "Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.", + "enum": [ + "IgnoreQueryString", + "BypassCaching", + "UseQueryString", + "NotSet" + ], + "type": "string", + "x-ms-enum": { + "name": "QueryStringCachingBehavior", + "modelAsString": false + } + }, + "PrivateEndpointStatus": { + "description": "The approval status for the connection to the Private Link", + "type": "string", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected", + "Timeout" + ], + "x-ms-enum": { + "name": "PrivateEndpointStatus", + "modelAsString": true + } + }, + "Sku": { + "description": "Standard_Verizon = The SKU name for a Standard Verizon CDN profile.\nPremium_Verizon = The SKU name for a Premium Verizon CDN profile.\nCustom_Verizon = The SKU name for a Custom Verizon CDN profile.\nStandard_Akamai = The SKU name for an Akamai CDN profile.\nStandard_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using GB based billing model.\nStandard_Microsoft = The SKU name for a Standard Microsoft CDN profile.\nStandard_AzureFrontDoor = The SKU name for an Azure Front Door Standard profile.\nPremium_AzureFrontDoor = The SKU name for an Azure Front Door Premium profile.\nStandard_955BandWidth_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using 95-5 peak bandwidth billing model.\nStandard_AvgBandWidth_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using monthly average peak bandwidth billing model.\nStandardPlus_ChinaCdn = The SKU name for a China CDN profile for live-streaming using GB based billing model.\nStandardPlus_955BandWidth_ChinaCdn = The SKU name for a China CDN live-streaming profile using 95-5 peak bandwidth billing model.\nStandardPlus_AvgBandWidth_ChinaCdn = The SKU name for a China CDN live-streaming profile using monthly average peak bandwidth billing model.\n", + "properties": { + "name": { + "description": "Name of the pricing tier.", + "enum": [ + "Standard_Verizon", + "Premium_Verizon", + "Custom_Verizon", + "Standard_Akamai", + "Standard_ChinaCdn", + "Standard_Microsoft", + "Standard_AzureFrontDoor", + "Premium_AzureFrontDoor", + "Standard_955BandWidth_ChinaCdn", + "Standard_AvgBandWidth_ChinaCdn", + "StandardPlus_ChinaCdn", + "StandardPlus_955BandWidth_ChinaCdn", + "StandardPlus_AvgBandWidth_ChinaCdn" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + } + }, + "type": "object" + }, + "OptimizationType": { + "description": "Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization.", + "enum": [ + "GeneralWebDelivery", + "GeneralMediaStreaming", + "VideoOnDemandMediaStreaming", + "LargeFileDownload", + "DynamicSiteAcceleration" + ], + "type": "string", + "x-ms-enum": { + "name": "OptimizationType", + "modelAsString": true + } + }, + "ErrorResponse": { + "title": "Error response", + "description": "Error response indicates Azure Front Door Standard or Azure Front Door Premium or CDN service is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "error": { + "description": "The error object.", + "$ref": "#/definitions/ErrorDetail" + } + } + }, + "ErrorDetail": { + "description": "The error detail.", + "type": "object", + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "The error code." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "The error message." + }, + "target": { + "readOnly": true, + "type": "string", + "description": "The error target." + }, + "details": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetail" + }, + "x-ms-identifiers": [ + "message", + "target" + ], + "description": "The error details." + }, + "additionalInfo": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ErrorAdditionalInfo" + }, + "x-ms-identifiers": [], + "description": "The error additional info." + } + } + }, + "ErrorAdditionalInfo": { + "type": "object", + "properties": { + "type": { + "readOnly": true, + "type": "string", + "description": "The additional info type." + }, + "info": { + "readOnly": true, + "type": "object", + "description": "The additional info." + } + }, + "description": "The resource management error additional info." + }, + "CdnMigrationToAfdParameters": { + "type": "object", + "description": "Request body for Migrate operation.", + "required": [ + "sku" + ], + "properties": { + "sku": { + "description": "Sku for the migration", + "$ref": "#/definitions/Sku" + }, + "migrationEndpointMappings": { + "description": "A name map between classic CDN endpoints and AFD Premium/Standard endpoints.", + "type": "array", + "items": { + "description": "List of endpoint mappings", + "$ref": "#/definitions/MigrationEndpointMapping" + }, + "x-ms-identifiers": [] + } + }, + "x-ms-azure-resource": true + }, + "MigrationEndpointMapping": { + "description": "CDN Endpoint Mapping.", + "type": "object", + "properties": { + "migratedFrom": { + "description": "Name of the classic CDN profile endpoint.", + "type": "string" + }, + "migratedTo": { + "description": "Name of the newly created migrated Azure Frontdoor Standard/Premium profile endpoint. This name will replace the name of the classic CDN endpoint resource.", + "type": "string" + } + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request. Current version is 2024-09-01." + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "Name of the Resource group within the Azure subscription." + }, + "profileNameParameter": { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group." + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdnwebapplicationfirewall.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdnwebapplicationfirewall.json new file mode 100644 index 000000000000..ad37d1ab36ed --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdnwebapplicationfirewall.json @@ -0,0 +1,977 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-09-01", + "title": "Azure CDN WebApplicationFirewallManagement", + "description": "APIs to manage web application firewall rules for Azure CDN" + }, + "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.Cdn/cdnWebApplicationFirewallPolicies": { + "get": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Lists all of the protection policies within a resource group.", + "operationId": "Policies_List", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicyList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cdn.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Policies in a Resource Group": { + "$ref": "./examples/WafListPolicies.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/cdnWebApplicationFirewallPolicies/{policyName}": { + "get": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Retrieve protection policy with specified name within a resource group.", + "operationId": "Policies_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PolicyNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cdn.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Policy": { + "$ref": "./examples/WafPolicyGet.json" + } + } + }, + "put": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Create or update policy with specified rule set name within a resource group.", + "operationId": "Policies_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PolicyNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "description": "Policy to be created.", + "in": "body", + "name": "cdnWebApplicationFirewallPolicy", + "required": true, + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new protection policy has been created.", + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cdn.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Creates specific policy": { + "$ref": "./examples/WafPolicyCreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Update an existing CdnWebApplicationFirewallPolicy with the specified policy name under the specified subscription and resource group", + "operationId": "Policies_Update", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PolicyNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "description": "CdnWebApplicationFirewallPolicy parameters to be patched.", + "in": "body", + "name": "cdnWebApplicationFirewallPolicyPatchParameters", + "required": true, + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicyPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cdn.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Creates specific policy": { + "$ref": "./examples/WafPatchPolicy.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Deletes Policy", + "operationId": "Policies_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PolicyNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "204": { + "description": "No Content. The request has been accepted but the policy was not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cdn.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete protection policy": { + "$ref": "./examples/WafPolicyDelete.json" + } + }, + "x-ms-long-running-operation": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/cdnWebApplicationFirewallManagedRuleSets": { + "get": { + "tags": [ + "WebApplicationFirewallManagedRuleSets" + ], + "description": "Lists all available managed rule sets.", + "operationId": "ManagedRuleSets_List", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of all available web application firewall managed rule sets.", + "schema": { + "$ref": "#/definitions/ManagedRuleSetDefinitionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cdn.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Policies in a Resource Group": { + "$ref": "./examples/WafListManagedRuleSets.json" + } + } + } + } + }, + "definitions": { + "CdnWebApplicationFirewallPolicyList": { + "description": "Defines a list of WebApplicationFirewallPolicies for Azure CDN. It contains a list of WebApplicationFirewallPolicy objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + }, + "description": "List of Azure CDN WebApplicationFirewallPolicies within a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of WebApplicationFirewallPolicy objects if there are any." + } + } + }, + "CdnWebApplicationFirewallPolicy": { + "description": "Defines web application firewall policy for Azure CDN.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of the web application firewall policy.", + "$ref": "#/definitions/CdnWebApplicationFirewallPolicyProperties" + }, + "etag": { + "type": "string", + "description": "Gets a unique read-only string that changes whenever the resource is updated." + }, + "sku": { + "description": "The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy.", + "$ref": "./cdn.json#/definitions/Sku" + } + }, + "required": [ + "sku" + ], + "allOf": [ + { + "$ref": "./cdn.json#/definitions/TrackedResource" + } + ] + }, + "CdnWebApplicationFirewallPolicyPatchParameters": { + "type": "object", + "description": "Properties required to update a CdnWebApplicationFirewallPolicy.", + "properties": { + "tags": { + "description": "CdnWebApplicationFirewallPolicy tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-azure-resource": true + }, + "CdnWebApplicationFirewallPolicyProperties": { + "description": "Defines CDN web application firewall policy properties.", + "properties": { + "policySettings": { + "description": "Describes policySettings for policy", + "$ref": "#/definitions/policySettings" + }, + "rateLimitRules": { + "description": "Describes rate limit rules inside the policy.", + "$ref": "#/definitions/RateLimitRuleList" + }, + "customRules": { + "description": "Describes custom rules inside the policy.", + "$ref": "#/definitions/CustomRuleList" + }, + "managedRules": { + "description": "Describes managed rules inside the policy.", + "$ref": "#/definitions/ManagedRuleSetList" + }, + "endpointLinks": { + "description": "Describes Azure CDN endpoints associated with this Web Application Firewall policy.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CdnEndpoint" + } + }, + "extendedProperties": { + "description": "Key-Value pair representing additional properties for Web Application Firewall policy.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the WebApplicationFirewallPolicy.", + "enum": [ + "Creating", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "resourceState": { + "title": "Resource status of the policy.", + "readOnly": true, + "enum": [ + "Creating", + "Enabling", + "Enabled", + "Disabling", + "Disabled", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "PolicyResourceState", + "modelAsString": true + } + } + } + }, + "policySettings": { + "description": "Defines contents of a web application firewall global configuration", + "properties": { + "enabledState": { + "description": "describes if the policy is in enabled state or disabled state", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "PolicyEnabledState", + "modelAsString": true + } + }, + "mode": { + "description": "Describes if it is in detection mode or prevention mode at policy level.", + "type": "string", + "enum": [ + "Prevention", + "Detection" + ], + "x-ms-enum": { + "name": "PolicyMode", + "modelAsString": true + } + }, + "defaultRedirectUrl": { + "description": "If action type is redirect, this field represents the default redirect URL for the client.", + "type": "string" + }, + "defaultCustomBlockResponseStatusCode": { + "description": "If the action type is block, this field defines the default customer overridable http response status code.", + "type": "integer", + "format": "int32", + "enum": [ + 200, + 403, + 405, + 406, + 429 + ] + }, + "defaultCustomBlockResponseBody": { + "description": "If the action type is block, customer can override the response body. The body must be specified in base64 encoding.", + "type": "string", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + } + } + }, + "CdnEndpoint": { + "description": "Defines the ARM Resource ID for the linked endpoints", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "ARM Resource ID string." + } + } + }, + "CustomRuleList": { + "description": "Defines contents of custom rules", + "properties": { + "rules": { + "description": "List of rules", + "type": "array", + "items": { + "$ref": "#/definitions/CustomRule" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "CustomRule": { + "description": "Defines the common attributes for a custom rule that can be included in a waf policy", + "type": "object", + "required": [ + "name", + "priority", + "matchConditions", + "action" + ], + "properties": { + "name": { + "description": "Defines the name of the custom rule", + "type": "string" + }, + "enabledState": { + "description": "Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "CustomRuleEnabledState", + "modelAsString": true + } + }, + "priority": { + "description": "Defines in what order this rule be evaluated in the overall list of custom rules", + "type": "integer", + "format": "int32", + "maximum": 1000, + "exclusiveMaximum": false, + "minimum": 0, + "exclusiveMinimum": false + }, + "matchConditions": { + "description": "List of match conditions.", + "type": "array", + "items": { + "$ref": "#/definitions/MatchCondition" + }, + "x-ms-identifiers": [] + }, + "action": { + "description": "Describes what action to be applied when rule matches", + "$ref": "#/definitions/ActionType" + } + } + }, + "RateLimitRuleList": { + "description": "Defines contents of rate limit rules", + "properties": { + "rules": { + "description": "List of rules", + "type": "array", + "items": { + "$ref": "#/definitions/RateLimitRule" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "RateLimitRule": { + "description": "Defines a rate limiting rule that can be included in a waf policy", + "type": "object", + "required": [ + "rateLimitThreshold", + "rateLimitDurationInMinutes" + ], + "properties": { + "rateLimitThreshold": { + "description": "Defines rate limit threshold.", + "type": "integer", + "format": "int32", + "minimum": 0, + "exclusiveMinimum": false + }, + "rateLimitDurationInMinutes": { + "description": "Defines rate limit duration. Default is 1 minute.", + "type": "integer", + "format": "int32", + "maximum": 60, + "exclusiveMaximum": false, + "minimum": 0, + "exclusiveMinimum": false + } + }, + "allOf": [ + { + "$ref": "#/definitions/CustomRule" + } + ] + }, + "MatchCondition": { + "description": "Define match conditions", + "required": [ + "matchVariable", + "operator", + "matchValue" + ], + "properties": { + "matchVariable": { + "description": "Match variable to compare against.", + "type": "string", + "enum": [ + "RemoteAddr", + "SocketAddr", + "RequestMethod", + "RequestHeader", + "RequestUri", + "QueryString", + "RequestBody", + "Cookies", + "PostArgs" + ], + "x-ms-enum": { + "name": "WafMatchVariable", + "modelAsString": true + } + }, + "selector": { + "description": "Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs.", + "type": "string" + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "IPMatch", + "GeoMatch", + "Equal", + "Contains", + "LessThan", + "GreaterThan", + "LessThanOrEqual", + "GreaterThanOrEqual", + "BeginsWith", + "EndsWith", + "RegEx" + ], + "x-ms-enum": { + "name": "operator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if the result of this condition should be negated.", + "type": "boolean" + }, + "matchValue": { + "description": "List of possible match values.", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms.", + "type": "array", + "items": { + "$ref": "#/definitions/TransformType" + } + } + } + }, + "TransformType": { + "description": "Describes what transforms were applied before matching.", + "type": "string", + "enum": [ + "Lowercase", + "Uppercase", + "Trim", + "UrlDecode", + "UrlEncode", + "RemoveNulls" + ], + "x-ms-enum": { + "name": "TransformType", + "modelAsString": true + } + }, + "ManagedRuleSetList": { + "description": "Defines the list of managed rule sets for the policy.", + "properties": { + "managedRuleSets": { + "description": "List of rule sets.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleSet" + }, + "x-ms-identifiers": [ + "ruleSetType", + "ruleSetVersion" + ] + } + } + }, + "ManagedRuleSet": { + "type": "object", + "description": "Defines a managed rule set.", + "required": [ + "ruleSetType", + "ruleSetVersion" + ], + "properties": { + "ruleSetType": { + "description": "Defines the rule set type to use.", + "type": "string" + }, + "ruleSetVersion": { + "description": "Defines the version of the rule set to use.", + "type": "string" + }, + "anomalyScore": { + "description": "Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests.", + "type": "integer", + "format": "int32", + "maximum": 20, + "exclusiveMaximum": false, + "minimum": 0, + "exclusiveMinimum": false + }, + "ruleGroupOverrides": { + "description": "Defines the rule overrides to apply to the rule set.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleGroupOverride" + }, + "x-ms-identifiers": [ + "ruleGroupName" + ] + } + } + }, + "ManagedRuleGroupOverride": { + "description": "Defines a managed rule group override setting.", + "required": [ + "ruleGroupName" + ], + "properties": { + "ruleGroupName": { + "description": "Describes the managed rule group within the rule set to override", + "type": "string" + }, + "rules": { + "description": "List of rules that will be enabled. If none specified, all rules in the group will be disabled.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleOverride" + }, + "x-ms-identifiers": [ + "ruleId" + ] + } + } + }, + "ManagedRuleOverride": { + "description": "Defines a managed rule group override setting.", + "required": [ + "ruleId" + ], + "properties": { + "ruleId": { + "description": "Identifier for the managed rule.", + "type": "string" + }, + "enabledState": { + "description": "Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "ManagedRuleEnabledState", + "modelAsString": true + } + }, + "action": { + "description": "Describes the override action to be applied when rule matches.", + "$ref": "#/definitions/ActionType" + } + } + }, + "ManagedRuleSetDefinitionList": { + "description": "List of managed rule set definitions available for use in a policy.", + "properties": { + "value": { + "description": "List of managed rule set definitions.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleSetDefinition" + } + }, + "nextLink": { + "type": "string", + "description": "URL to retrieve next set of managed rule set definitions." + } + } + }, + "ManagedRuleSetDefinition": { + "description": "Describes a managed rule set definition.", + "properties": { + "properties": { + "description": "Describes managed rule set definition properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ManagedRuleSetDefinitionProperties" + }, + "sku": { + "description": "The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy.", + "$ref": "./cdn.json#/definitions/Sku" + } + }, + "allOf": [ + { + "$ref": "./cdn.json#/definitions/Resource" + } + ] + }, + "ManagedRuleSetDefinitionProperties": { + "description": "Properties for a managed rule set definition.", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Provisioning state of the managed rule set." + }, + "ruleSetType": { + "type": "string", + "readOnly": true, + "description": "Type of the managed rule set." + }, + "ruleSetVersion": { + "type": "string", + "readOnly": true, + "description": "Version of the managed rule set type." + }, + "ruleGroups": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ManagedRuleGroupDefinition" + }, + "x-ms-identifiers": [ + "ruleGroupName" + ], + "description": "Rule groups of the managed rule set." + } + } + }, + "ManagedRuleGroupDefinition": { + "description": "Describes a managed rule group.", + "properties": { + "ruleGroupName": { + "type": "string", + "readOnly": true, + "description": "Name of the managed rule group." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "Description of the managed rule group." + }, + "rules": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ManagedRuleDefinition" + }, + "x-ms-identifiers": [ + "ruleId" + ], + "description": "List of rules within the managed rule group." + } + } + }, + "ManagedRuleDefinition": { + "description": "Describes a managed rule definition.", + "properties": { + "ruleId": { + "description": "Identifier for the managed rule.", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Describes the functionality of the managed rule.", + "readOnly": true, + "type": "string" + } + } + }, + "ActionType": { + "description": "Defines the action to take on rule match.", + "type": "string", + "enum": [ + "Allow", + "Block", + "Log", + "Redirect" + ], + "x-ms-enum": { + "name": "ActionType", + "modelAsString": true + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request. Current version is 2024-09-01." + }, + "PolicyNameParameter": { + "name": "policyName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 128, + "x-ms-parameter-location": "method", + "description": "The name of the CdnWebApplicationFirewallPolicy." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_\\-\\(\\)\\.]*[^\\.]$", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method", + "description": "Name of the Resource group within the Azure subscription." + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Create.json new file mode 100644 index 000000000000..82f832ab5329 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Create.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "customDomainName": "domain1", + "customDomain": { + "properties": { + "hostName": "www.someDomain.net", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12" + }, + "azureDnsZone": { + "id": "" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1", + "name": "domain1", + "type": "Microsoft.Cdn/profiles/customdomains", + "properties": { + "profileName": "profile1", + "hostName": "www.contoso.com", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12", + "secret": { + "id": "" + } + }, + "azureDnsZone": { + "id": "" + }, + "preValidatedCustomDomainResourceId": { + "id": "" + }, + "validationProperties": { + "validationToken": "", + "expirationDate": "" + }, + "domainValidationState": "Submitting", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1", + "name": "domain1", + "type": "Microsoft.Cdn/profiles/customdomains", + "properties": { + "profileName": "profile1", + "hostName": "www.contoso.com", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12", + "secret": { + "id": "" + } + }, + "azureDnsZone": { + "id": "" + }, + "preValidatedCustomDomainResourceId": { + "id": "" + }, + "validationProperties": { + "validationToken": "", + "expirationDate": "" + }, + "domainValidationState": "Submitting", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1", + "name": "domain1", + "type": "Microsoft.Cdn/profiles/customdomains", + "properties": { + "profileName": "profile1", + "hostName": "www.contoso.com", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12", + "secret": { + "id": "" + } + }, + "azureDnsZone": { + "id": "" + }, + "preValidatedCustomDomainResourceId": { + "id": "" + }, + "validationProperties": { + "validationToken": "", + "expirationDate": "" + }, + "domainValidationState": "Submitting", + "provisioningState": "Creating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Delete.json new file mode 100644 index 000000000000..742bcc835345 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "customDomainName": "domain1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Get.json new file mode 100644 index 000000000000..a9346d866f3d --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "customDomainName": "domain1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1", + "name": "domain1", + "type": "Microsoft.Cdn/profiles/customdomains", + "properties": { + "profileName": "profile1", + "hostName": "www.contoso.com", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12", + "secret": { + "id": "" + } + }, + "azureDnsZone": { + "id": "" + }, + "preValidatedCustomDomainResourceId": { + "id": "" + }, + "validationProperties": { + "validationToken": "8c9912db-c615-4eeb-8465", + "expirationDate": "2009-06-15T13:45:43.0000000Z" + }, + "domainValidationState": "Pending", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_ListByProfile.json new file mode 100644 index 000000000000..cd9790671b50 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_ListByProfile.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1", + "name": "domain1", + "type": "Microsoft.Cdn/profiles/customdomains", + "properties": { + "profileName": "profile1", + "hostName": "www.contoso.com", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12", + "secret": { + "id": "" + } + }, + "azureDnsZone": { + "id": "" + }, + "preValidatedCustomDomainResourceId": { + "id": "" + }, + "validationProperties": { + "validationToken": "8c9912db-c615-4eeb-8465", + "expirationDate": "2009-06-15T13:45:43.0000000Z" + }, + "domainValidationState": "Pending", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_RefreshValidationToken.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_RefreshValidationToken.json new file mode 100644 index 000000000000..307091c09977 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_RefreshValidationToken.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "customDomainName": "domain1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Update.json new file mode 100644 index 000000000000..1ba8fae48008 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Update.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "customDomainName": "domain1", + "customDomainUpdateProperties": { + "properties": { + "tlsSettings": { + "certificateType": "CustomerCertificate", + "minimumTlsVersion": "TLS12" + }, + "azureDnsZone": { + "id": "" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1", + "name": "domain1", + "type": "Microsoft.Cdn/profiles/customdomains", + "properties": { + "profileName": "profile1", + "hostName": "www.contoso.com", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12", + "secret": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/mysecert" + } + }, + "azureDnsZone": { + "id": "" + }, + "preValidatedCustomDomainResourceId": { + "id": "" + }, + "validationProperties": { + "validationToken": "8c9912db-c615-4eeb-8465", + "expirationDate": "2009-06-15T13:45:43.0000000Z" + }, + "domainValidationState": "Approved", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1", + "name": "domain1", + "type": "Microsoft.Cdn/profiles/customdomains", + "properties": { + "profileName": "profile1", + "hostName": "www.contoso.com", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12", + "secret": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/mysecert" + } + }, + "azureDnsZone": { + "id": "" + }, + "preValidatedCustomDomainResourceId": { + "id": "" + }, + "validationProperties": { + "validationToken": "8c9912db-c615-4eeb-8465", + "expirationDate": "2009-06-15T13:45:43.0000000Z" + }, + "domainValidationState": "Approved", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Create.json new file mode 100644 index 000000000000..66c04169a74d --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Create.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "endpoint": { + "tags": {}, + "location": "global", + "properties": { + "enabledState": "Enabled", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + }, + "responses": { + "200": { + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/afdendpoints", + "tags": {}, + "location": "global", + "properties": { + "hostName": "endpoint1-abcdefghijklmnop.z01.azurefd.net", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + }, + "201": { + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/afdendpoints", + "tags": {}, + "location": "global", + "properties": { + "hostName": "endpoint1-abcdefghijklmnop.z01.azurefd.net", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/afdendpoints", + "tags": {}, + "location": "global", + "properties": { + "hostName": "endpoint1-abcdefghijklmnop.z01.azurefd.net", + "enabledState": "Enabled", + "provisioningState": "Creating", + "deploymentStatus": "NotStarted", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Delete.json new file mode 100644 index 000000000000..28895b584392 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Get.json new file mode 100644 index 000000000000..42b5693fc898 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/afdendpoints", + "tags": {}, + "location": "global", + "properties": { + "hostName": "endpoint1-abcdefghijklmnop.z01.azurefd.net", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ListByProfile.json new file mode 100644 index 000000000000..3f257645f15f --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ListByProfile.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/afdendpoints", + "tags": {}, + "location": "global", + "properties": { + "hostName": "endpoint1-abcdefghijklmnop.z01.azurefd.net", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ListResourceUsage.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ListResourceUsage.json new file mode 100644 index 000000000000..849c34cc902f --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ListResourceUsage.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 0, + "limit": 25, + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "name": { + "value": "route", + "localizedValue": "route" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_PurgeContent.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_PurgeContent.json new file mode 100644 index 000000000000..aa17f1fc7e06 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_PurgeContent.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "contents": { + "contentPaths": [ + "/folder1" + ], + "domains": [ + "endpoint1-abcdefghijklmnop.z01.azurefd.net" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Update.json new file mode 100644 index 000000000000..230fd0ec4084 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Update.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "endpointUpdateProperties": { + "tags": {}, + "properties": { + "enabledState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/afdendpoints", + "tags": {}, + "location": "global", + "properties": { + "hostName": "endpoint1-ezh7ddcmguaeajfu.z01.azureedge.net", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/afdendpoints", + "tags": {}, + "location": "global", + "properties": { + "hostName": "endpoint1-abcdefghijklmnop.z01.azurefd.net", + "enabledState": "Enabled", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ValidateCustomDomain.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ValidateCustomDomain.json new file mode 100644 index 000000000000..4f3257ee5e53 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ValidateCustomDomain.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainProperties": { + "hostName": "www.someDomain.com" + } + }, + "responses": { + "200": { + "body": { + "customDomainValidated": true, + "message": null, + "reason": null + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Create.json new file mode 100644 index 000000000000..b9251255260e --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Create.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1", + "originGroup": { + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path2", + "probeRequestType": "NotSet", + "probeProtocol": "NotSet", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1", + "type": "Microsoft.Cdn/profiles/origingroups", + "name": "origingroup1", + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path1", + "probeRequestType": "HEAD", + "probeProtocol": "Http", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1", + "type": "Microsoft.Cdn/profiles/origingroups", + "name": "origingroup1", + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path1", + "probeRequestType": "HEAD", + "probeProtocol": "Http", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1", + "type": "Microsoft.Cdn/profiles/origingroups", + "name": "origingroup1", + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path1", + "probeRequestType": "HEAD", + "probeProtocol": "Http", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5, + "provisioningState": "Creating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Delete.json new file mode 100644 index 000000000000..0e80603e9db1 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Get.json new file mode 100644 index 000000000000..70388c913207 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1", + "type": "Microsoft.Cdn/profiles/origingroups", + "name": "origingroup1", + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path1", + "probeRequestType": "HEAD", + "probeProtocol": "Http", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_ListByProfile.json new file mode 100644 index 000000000000..d3c44b339b6b --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_ListByProfile.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1", + "type": "Microsoft.Cdn/profiles/origingroups", + "name": "origingroup1", + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path1", + "probeRequestType": "HEAD", + "probeProtocol": "Http", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_ListResourceUsage.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_ListResourceUsage.json new file mode 100644 index 000000000000..238bc2a5b6cf --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_ListResourceUsage.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 0, + "limit": 25, + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "name": { + "value": "origin", + "localizedValue": "origin" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Update.json new file mode 100644 index 000000000000..89ceff41d61b --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Update.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1", + "originGroupUpdateProperties": { + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path2", + "probeRequestType": "NotSet", + "probeProtocol": "NotSet", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1", + "type": "Microsoft.Cdn/profiles/origingroups", + "name": "origingroup1", + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path1", + "probeRequestType": "HEAD", + "probeProtocol": "Http", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1", + "type": "Microsoft.Cdn/profiles/origingroups", + "name": "origingroup1", + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path1", + "probeRequestType": "HEAD", + "probeProtocol": "Http", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5, + "provisioningState": "Updating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Create.json new file mode 100644 index 000000000000..ec6e73455717 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Create.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1", + "originName": "origin1", + "origin": { + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "enabledState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "type": "Microsoft.Cdn/profiles/origingroups/origins", + "name": "origin1", + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "priority": null, + "weight": null, + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "originGroupName": "origingroup1", + "sharedPrivateLinkResource": null, + "enforceCertificateNameCheck": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "type": "Microsoft.Cdn/profiles/origingroups/origins", + "name": "origin1", + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "priority": null, + "weight": null, + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "originGroupName": "origingroup1", + "sharedPrivateLinkResource": null, + "enforceCertificateNameCheck": true + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "type": "Microsoft.Cdn/profiles/origingroups/origins", + "name": "origin1", + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "priority": null, + "weight": null, + "enabledState": "Enabled", + "provisioningState": "Creating", + "deploymentStatus": "NotStarted", + "originGroupName": "origingroup1", + "sharedPrivateLinkResource": null, + "enforceCertificateNameCheck": true + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Delete.json new file mode 100644 index 000000000000..867defe0fc66 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1", + "originName": "origin1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Get.json new file mode 100644 index 000000000000..a5aa5e870ca2 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1", + "originName": "origin1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "type": "Microsoft.Cdn/profiles/origingroups/origins", + "name": "origin1", + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "priority": null, + "weight": null, + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "originGroupName": "origingroup1", + "sharedPrivateLinkResource": null, + "enforceCertificateNameCheck": true + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_ListByOriginGroup.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_ListByOriginGroup.json new file mode 100644 index 000000000000..3ebb1f0b0c22 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_ListByOriginGroup.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "type": "Microsoft.Cdn/profiles/origingroups/origins", + "name": "origin1", + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "priority": null, + "weight": null, + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "originGroupName": "origingroup1", + "sharedPrivateLinkResource": null, + "enforceCertificateNameCheck": true + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Update.json new file mode 100644 index 000000000000..d422643c50cd --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Update.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1", + "originName": "origin1", + "originUpdateProperties": { + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "enabledState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "type": "Microsoft.Cdn/profiles/origingroups/origins", + "name": "origin1", + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "priority": null, + "weight": null, + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "originGroupName": "origingroup1", + "sharedPrivateLinkResource": null, + "enforceCertificateNameCheck": true + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "type": "Microsoft.Cdn/profiles/origingroups/origins", + "name": "origin1", + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "priority": null, + "weight": null, + "enabledState": "Enabled", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted", + "originGroupName": "origingroup1", + "sharedPrivateLinkResource": null, + "enforceCertificateNameCheck": true + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_CheckEndpointNameAvailability.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_CheckEndpointNameAvailability.json new file mode 100644 index 000000000000..aea9ba6c4f6e --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_CheckEndpointNameAvailability.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "myResourceGroup", + "profileName": "profile1", + "checkEndpointNameAvailabilityInput": { + "name": "sampleName", + "type": "Microsoft.Cdn/Profiles/AfdEndpoints", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "Name is already in use", + "message": "Name not available", + "availableHostname": "" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_CheckHostNameAvailability.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_CheckHostNameAvailability.json new file mode 100644 index 000000000000..6805739e79bd --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_CheckHostNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "checkHostNameAvailabilityInput": { + "hostName": "www.someDomain.net" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "Conflict", + "message": "The hostname 'www.someDomain.net' is already owned by another profile." + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_ListResourceUsage.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_ListResourceUsage.json new file mode 100644 index 000000000000..8dcbcc84af69 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_ListResourceUsage.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 0, + "limit": 25, + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "name": { + "value": "afdendpoint", + "localizedValue": "afdendpoint" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_Upgrade.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_Upgrade.json new file mode 100644 index 000000000000..b3abe705d2e2 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_Upgrade.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "profileUpgradeParameters": { + "wafMappingList": [ + { + "securityPolicyName": "securityPolicy1", + "changeToWafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/waf2" + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "name": "profile1", + "location": "Global", + "kind": "frontdoor", + "tags": {}, + "sku": { + "name": "Standard_AzureFrontDoor" + }, + "properties": { + "extendedProperties": {}, + "frontDoorId": "id", + "originResponseTimeoutSeconds": 60, + "provisioningState": "Succeeded", + "resourceState": "Enabled" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "name": "profile1", + "location": "Global", + "kind": "frontdoor", + "tags": {}, + "sku": { + "name": "Standard_AzureFrontDoor" + }, + "properties": { + "originResponseTimeoutSeconds": 60, + "frontDoorId": "id", + "extendedProperties": {}, + "resourceState": "Upgrading", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_ValidateSecret.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_ValidateSecret.json new file mode 100644 index 000000000000..e6a4beb9ead4 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_ValidateSecret.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "validateSecretInput": { + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/certificate/certName" + }, + "secretType": "CustomerCertificate" + } + }, + "responses": { + "200": { + "body": { + "status": "Valid", + "message": null + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CdnProfiles_CanMigrate.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CdnProfiles_CanMigrate.json new file mode 100644 index 000000000000..17cead852987 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CdnProfiles_CanMigrate.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationid/profileresults/profile1/canmigrateresults/profile1", + "type": "Microsoft.Cdn/profiles/canmigrate", + "properties": { + "canMigrate": true, + "defaultSku": "Standard_AzureFrontDoor", + "errors": null + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CdnProfiles_Migrate.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CdnProfiles_Migrate.json new file mode 100644 index 000000000000..b4373821c45d --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CdnProfiles_Migrate.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "RG", + "profileName": "profile1", + "migrationParameters": { + "sku": { + "name": "Standard_AzureFrontDoor" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/operationresults/operationid/profileresults/profile1/migrateresults/profile1", + "type": "Microsoft.Cdn/profiles/migrate", + "properties": { + "migratedProfileResourceId": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1" + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckEndpointNameAvailability.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckEndpointNameAvailability.json new file mode 100644 index 000000000000..0180d609966a --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckEndpointNameAvailability.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "myResourceGroup", + "checkEndpointNameAvailabilityInput": { + "name": "sampleName", + "type": "Microsoft.Cdn/Profiles/AfdEndpoints", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "Name is already in use", + "message": "Name not available", + "availableHostname": "" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckNameAvailability.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..12f321bebb66 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckNameAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "checkNameAvailabilityInput": { + "name": "sampleName", + "type": "Microsoft.Cdn/Profiles/Endpoints" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "Name is already in use", + "message": "Name not available" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckNameAvailabilityWithSubscription.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckNameAvailabilityWithSubscription.json new file mode 100644 index 000000000000..48e658ba4073 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckNameAvailabilityWithSubscription.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "checkNameAvailabilityInput": { + "name": "sampleName", + "type": "Microsoft.Cdn/Profiles/Endpoints" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "Name is already in use", + "message": "Name not available" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Create.json new file mode 100644 index 000000000000..b86710e2eedd --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Create.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net", + "customDomainProperties": { + "properties": { + "hostName": "www.someDomain.net" + } + } + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": null + } + } + }, + "201": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": null + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": null + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Delete.json new file mode 100644 index 000000000000..6e3aab25e3c8 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Delete.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": null + } + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_DisableCustomHttps.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_DisableCustomHttps.json new file mode 100644 index 000000000000..9a712dfeb7bc --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_DisableCustomHttps.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net" + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Disabled", + "customHttpsProvisioningSubstate": "CertificateDeleted", + "validationData": null + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": null + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json new file mode 100644 index 000000000000..0ade08219414 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net", + "customHttpsParameters": { + "MinimumTLSVersion": "TLS12", + "certificateSource": "AzureKeyVault", + "protocolType": "ServerNameIndication", + "certificateSourceParameters": { + "typeName": "KeyVaultCertificateSourceParameters", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "vaultName": "kv", + "secretName": "secret1", + "secretVersion": "00000000-0000-0000-0000-000000000000", + "updateRule": "NoAction", + "deleteRule": "NoAction" + } + } + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabled", + "customHttpsProvisioningSubstate": "CertificateDeployed", + "validationData": "validationdata" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": "validationdata" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json new file mode 100644 index 000000000000..a6271e38a778 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net", + "customHttpsParameters": { + "MinimumTLSVersion": "TLS12", + "certificateSource": "Cdn", + "protocolType": "ServerNameIndication", + "certificateSourceParameters": { + "typeName": "CdnCertificateSourceParameters", + "certificateType": "Shared" + } + } + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabled", + "customHttpsProvisioningSubstate": "CertificateDeployed", + "validationData": "validationdata" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": "validationdata" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Get.json new file mode 100644 index 000000000000..d4ce4ba35412 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net" + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Disabled", + "customHttpsProvisioningSubstate": "None", + "validationData": null + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_ListByEndpoint.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_ListByEndpoint.json new file mode 100644 index 000000000000..818b57bff626 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_ListByEndpoint.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Disabled", + "customHttpsProvisioningSubstate": "None", + "validationData": null + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/EdgeNodes_List.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/EdgeNodes_List.json new file mode 100644 index 000000000000..267a380d29d1 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/EdgeNodes_List.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Standard_Verizon", + "id": "/providers/Microsoft.Cdn/edgenodes/Standard_Verizon", + "type": "Microsoft.Cdn/edgenodes", + "properties": { + "ipAddressGroups": [ + { + "deliveryRegion": "All", + "ipv4Addresses": [ + { + "baseIpAddress": "192.229.176.0", + "prefixLength": 24 + }, + { + "baseIpAddress": "180.240.184.128", + "prefixLength": 25 + }, + { + "baseIpAddress": "152.195.27.0", + "prefixLength": 24 + } + ], + "ipv6Addresses": [ + { + "baseIpAddress": "2606:2800:60f2::", + "prefixLength": 48 + }, + { + "baseIpAddress": "2606:2800:700c::", + "prefixLength": 48 + } + ] + } + ] + } + }, + { + "name": "Premium_Verizon", + "id": "/providers/Microsoft.Cdn/edgenodes/Premium_Verizon", + "type": "Microsoft.Cdn/edgenodes", + "properties": { + "ipAddressGroups": [ + { + "deliveryRegion": "All", + "ipv4Addresses": [ + { + "baseIpAddress": "192.229.176.0", + "prefixLength": 24 + }, + { + "baseIpAddress": "152.195.27.0", + "prefixLength": 24 + } + ], + "ipv6Addresses": [ + { + "baseIpAddress": "2606:2800:60f2::", + "prefixLength": 48 + }, + { + "baseIpAddress": "2606:2800:700c::", + "prefixLength": 48 + } + ] + } + ] + } + }, + { + "name": "Custom_Verizon", + "id": "/providers/Microsoft.Cdn/edgenodes/Custom_Verizon", + "type": "Microsoft.Cdn/edgenodes", + "properties": { + "ipAddressGroups": [ + { + "deliveryRegion": "All", + "ipv4Addresses": [ + { + "baseIpAddress": "192.229.176.0", + "prefixLength": 24 + }, + { + "baseIpAddress": "2606:2800:420b::", + "prefixLength": 48 + }, + { + "baseIpAddress": "2606:2800:700c::", + "prefixLength": 48 + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Create.json new file mode 100644 index 000000000000..d8ece8311e03 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Create.json @@ -0,0 +1,546 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "endpoint": { + "location": "WestUs", + "tags": { + "key1": "value1" + }, + "properties": { + "originHostHeader": "www.bing.com", + "originPath": "/photos", + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true, + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "BypassCaching", + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + }, + "deliveryPolicy": { + "description": "Test description for a policy.", + "rules": [ + { + "name": "rule1", + "order": 1, + "conditions": [ + { + "name": "RemoteAddress", + "parameters": { + "operator": "IPMatch", + "negateCondition": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "typeName": "DeliveryRuleRemoteAddressConditionParameters" + } + } + ], + "actions": [ + { + "name": "CacheExpiration", + "parameters": { + "cacheBehavior": "Override", + "cacheDuration": "10:10:09", + "typeName": "DeliveryRuleCacheExpirationActionParameters", + "cacheType": "All" + } + }, + { + "name": "ModifyResponseHeader", + "parameters": { + "headerAction": "Overwrite", + "headerName": "Access-Control-Allow-Origin", + "value": "*", + "typeName": "DeliveryRuleHeaderActionParameters" + } + }, + { + "name": "ModifyRequestHeader", + "parameters": { + "headerAction": "Overwrite", + "headerName": "Accept-Encoding", + "value": "gzip", + "typeName": "DeliveryRuleHeaderActionParameters" + } + } + ] + } + ] + }, + "origins": [ + { + "name": "origin1", + "properties": { + "hostName": "www.someDomain1.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain1.net", + "priority": 1, + "weight": 50, + "enabled": true + } + }, + { + "name": "origin2", + "properties": { + "hostName": "www.someDomain2.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + }, + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint4899.azureedge-test.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Creating", + "resourceState": "Creating", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "BypassCaching", + "originPath": "/photos", + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + }, + "origins": [ + { + "name": "origin1", + "properties": { + "hostName": "www.someDomain1.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain1.net", + "priority": 1, + "weight": 50, + "enabled": true + } + }, + { + "name": "origin2", + "properties": { + "hostName": "www.someDomain2.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + }, + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ], + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true, + "optimizationType": null, + "probePath": null, + "geoFilters": [], + "deliveryPolicy": { + "description": "Test description for a policy.", + "rules": [ + { + "name": "rule1", + "order": 1, + "conditions": [ + { + "name": "RemoteAddress", + "parameters": { + "typeName": "DeliveryRuleRemoteAddressConditionParameters", + "operator": "IPMatch", + "negateCondition": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + } + ], + "actions": [ + { + "name": "CacheExpiration", + "parameters": { + "typeName": "DeliveryRuleCacheExpirationActionParameters", + "cacheBehavior": "Override", + "cacheDuration": "10:10:09", + "cacheType": "All" + } + }, + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Access-Control-Allow-Origin", + "value": "*" + } + }, + { + "name": "ModifyRequestHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Accept-Encoding", + "value": "gzip" + } + } + ] + } + ] + } + } + } + }, + "201": { + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint4899.azureedge-test.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Creating", + "resourceState": "Creating", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "BypassCaching", + "originPath": "/photos", + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + }, + "origins": [ + { + "name": "origin1", + "properties": { + "hostName": "www.someDomain1.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain1.net", + "priority": 1, + "weight": 50, + "enabled": true + } + }, + { + "name": "origin2", + "properties": { + "hostName": "www.someDomain2.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + }, + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ], + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true, + "optimizationType": null, + "probePath": null, + "geoFilters": [], + "deliveryPolicy": { + "description": "Test description for a policy.", + "rules": [ + { + "name": "rule1", + "order": 1, + "conditions": [ + { + "name": "RemoteAddress", + "parameters": { + "typeName": "DeliveryRuleRemoteAddressConditionParameters", + "operator": "IPMatch", + "negateCondition": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + } + ], + "actions": [ + { + "name": "CacheExpiration", + "parameters": { + "typeName": "DeliveryRuleCacheExpirationActionParameters", + "cacheBehavior": "Override", + "cacheDuration": "10:10:09", + "cacheType": "All" + } + }, + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Access-Control-Allow-Origin", + "value": "*" + } + }, + { + "name": "ModifyRequestHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Accept-Encoding", + "value": "gzip" + } + } + ] + } + ] + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint4899.azureedge-test.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Creating", + "resourceState": "Creating", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "BypassCaching", + "originPath": "/photos", + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + }, + "origins": [ + { + "name": "origin1", + "properties": { + "hostName": "www.someDomain1.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain1.net", + "priority": 1, + "weight": 50, + "enabled": true + } + }, + { + "name": "origin2", + "properties": { + "hostName": "www.someDomain2.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + }, + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ], + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true, + "optimizationType": null, + "probePath": null, + "geoFilters": [], + "deliveryPolicy": { + "description": "Test description for a policy.", + "rules": [ + { + "name": "rule1", + "order": 1, + "conditions": [ + { + "name": "RemoteAddress", + "parameters": { + "typeName": "DeliveryRuleRemoteAddressConditionParameters", + "operator": "IPMatch", + "negateCondition": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + } + ], + "actions": [ + { + "name": "CacheExpiration", + "parameters": { + "typeName": "DeliveryRuleCacheExpirationActionParameters", + "cacheBehavior": "Override", + "cacheDuration": "10:10:09", + "cacheType": "All" + } + }, + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Access-Control-Allow-Origin", + "value": "*" + } + }, + { + "name": "ModifyRequestHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Accept-Encoding", + "value": "gzip" + } + } + ] + } + ] + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Delete.json new file mode 100644 index 000000000000..28895b584392 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Get.json new file mode 100644 index 000000000000..7fd7c0fc03a3 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Get.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": {}, + "location": "CentralUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Running", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com" + } + ] + } + } + ], + "customDomains": [ + { + "name": "www-someDomain-net", + "properties": { + "hostName": "www.someDomain.Net", + "validationData": null + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [], + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ListByProfile.json new file mode 100644 index 000000000000..b8c6ccf7b7ec --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ListByProfile.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": {}, + "location": "CentralUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Running", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ], + "customDomains": [ + { + "name": "www-someDomain-net", + "properties": { + "hostName": "www.someDomain.Net", + "validationData": null + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [], + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + } + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ListResourceUsage.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ListResourceUsage.json new file mode 100644 index 000000000000..2c7150ddb144 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ListResourceUsage.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "customdomain", + "unit": "count", + "currentValue": 1, + "limit": 20 + }, + { + "resourceType": "geofilter", + "unit": "count", + "currentValue": 0, + "limit": 25 + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_LoadContent.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_LoadContent.json new file mode 100644 index 000000000000..90165c79b110 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_LoadContent.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "contentFilePaths": { + "contentPaths": [ + "/folder1" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_PurgeContent.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_PurgeContent.json new file mode 100644 index 000000000000..90165c79b110 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_PurgeContent.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "contentFilePaths": { + "contentPaths": [ + "/folder1" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Start.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Start.json new file mode 100644 index 000000000000..8502040cc9b2 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Start.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Starting", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443 + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [] + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Starting", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443 + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Stop.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Stop.json new file mode 100644 index 000000000000..d29029942ae8 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Stop.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Stopping", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443 + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [] + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Stopping", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443 + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Update.json new file mode 100644 index 000000000000..ebc284fb3f56 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Update.json @@ -0,0 +1,141 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "endpointUpdateProperties": { + "tags": { + "additionalProperties": "Tag1" + } + } + }, + "responses": { + "200": { + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "additionalProperties": "Tag1" + }, + "location": "WestCentralUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": null, + "provisioningState": "Creating", + "resourceState": "Creating", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "IgnoreQueryString", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com" + } + ] + } + } + ], + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + }, + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": null, + "probePath": null, + "geoFilters": [] + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "additionalProperties": "Tag1" + }, + "location": "WestCentralUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": null, + "provisioningState": "Creating", + "resourceState": "Creating", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "IgnoreQueryString", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com" + } + ] + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": null, + "probePath": null, + "geoFilters": [], + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ValidateCustomDomain.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ValidateCustomDomain.json new file mode 100644 index 000000000000..4f3257ee5e53 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ValidateCustomDomain.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainProperties": { + "hostName": "www.someDomain.com" + } + }, + "responses": { + "200": { + "body": { + "customDomainValidated": true, + "message": null, + "reason": null + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsLocations.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsLocations.json new file mode 100644 index 000000000000..eb045204ff85 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsLocations.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "metrics": "clientRequestCount", + "granularity": "PT5M", + "groupBy": "httpStatusCode", + "dateTimeBegin": "2020-11-04T05:00:00.000Z", + "dateTimeEnd": "2020-11-04T06:00:00.000Z" + }, + "responses": { + "200": { + "body": { + "continents": [ + { + "id": "africa" + }, + { + "id": "antarctica" + }, + { + "id": "asia" + }, + { + "id": "europe" + }, + { + "id": "northAmerica" + }, + { + "id": "oceania" + }, + { + "id": "southAmerica" + } + ], + "countryOrRegions": [ + { + "id": "dz", + "continentId": "africa" + }, + { + "id": "ao", + "continentId": "africa" + }, + { + "id": "bw", + "continentId": "africa" + }, + { + "id": "bi", + "continentId": "africa" + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsMetrics.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsMetrics.json new file mode 100644 index 000000000000..c01c624bf25e --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsMetrics.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "metrics": [ + "clientRequestCount" + ], + "granularity": "PT5M", + "groupBy": [ + "protocol" + ], + "dateTimeBegin": "2020-11-04T04:30:00.000Z", + "dateTimeEnd": "2020-11-04T05:00:00.000Z", + "customDomains": [ + "customdomain1.azurecdn.net", + "customdomain2.azurecdn.net" + ], + "protocols": [ + "https" + ] + }, + "responses": { + "200": { + "body": { + "dateTimeBegin": "2020-11-04T12:30:27.554+08:00", + "dateTimeEnd": "2020-11-04T13:00:27.554+08:00", + "granularity": "PT5M", + "series": [ + { + "metric": "clientRequestCount", + "unit": "count", + "groups": [ + { + "name": "protocol", + "value": "https" + } + ], + "data": [ + { + "dateTime": "2020-11-04T04:35:00+00:00", + "value": 4250 + }, + { + "dateTime": "2020-11-04T04:40:00+00:00", + "value": 3120 + }, + { + "dateTime": "2020-11-04T04:45:00+00:00", + "value": 2221 + }, + { + "dateTime": "2020-11-04T04:50:00+00:00", + "value": 2466 + }, + { + "dateTime": "2020-11-04T04:55:00+00:00", + "value": 2654 + }, + { + "dateTime": "2020-11-04T05:00:00+00:00", + "value": 3565 + } + ] + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsRankings.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsRankings.json new file mode 100644 index 000000000000..e6971f7109cb --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsRankings.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "rankings": [ + "url" + ], + "metrics": [ + "clientRequestCount" + ], + "maxRanking": "5", + "dateTimeBegin": "2020-11-04T06:49:27.554Z", + "dateTimeEnd": "2020-11-04T09:49:27.554Z" + }, + "responses": { + "200": { + "body": { + "dateTimeBegin": "2020-11-04T14:49:27.554+08:00", + "dateTimeEnd": "2020-11-04T17:49:27.554+08:00", + "tables": [ + { + "ranking": "url", + "data": [ + { + "name": "https://testdomain.com/favicon.png", + "metrics": [ + { + "metric": "clientRequestCount", + "value": 2336, + "percentage": 8.28133862733976 + } + ] + }, + { + "name": "https://testdomain.com/js/app.js", + "metrics": [ + { + "metric": "clientRequestCount", + "value": 2140, + "percentage": 7.586500283607488 + } + ] + }, + { + "name": "https://testdomain.com/js/lang/en.js", + "metrics": [ + { + "metric": "clientRequestCount", + "value": 1536, + "percentage": 5.445263754963131 + } + ] + }, + { + "name": "https://testdomain.com/js/lib.js", + "metrics": [ + { + "metric": "clientRequestCount", + "value": 1480, + "percentage": 5.246738513896767 + } + ] + }, + { + "name": "https://cdn.exam.net/css/lib.css", + "metrics": [ + { + "metric": "clientRequestCount", + "value": 1452, + "percentage": 5.147475893363584 + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsResources.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsResources.json new file mode 100644 index 000000000000..b6c2d332d7b3 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsResources.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "endpoints": [ + { + "id": "endpoint1", + "name": "endpoint1.azureedge.net", + "history": false, + "customDomains": [ + { + "id": "customdomain1.azurecdn.net", + "name": "customdomain1.azurecdn.net", + "endpointId": "enbdpiont1", + "history": true + }, + { + "id": "customdomain2.azurecdn.net", + "name": "customdomain2.azurecdn.net", + "endpointId": null, + "history": true + } + ] + } + ], + "customDomains": [ + { + "id": "customdomain1.azurecdn.net", + "name": "customdomain1.azurecdn.net", + "endpointId": null, + "history": true + }, + { + "id": "customdomain2.azurecdn.net", + "name": "customdomain2.azurecdn.net", + "endpointId": null, + "history": true + }, + { + "id": "customdomain3.azurecdn.net", + "name": "customdomain3.azurecdn.net", + "endpointId": null, + "history": true + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetWafLogAnalyticsMetrics.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetWafLogAnalyticsMetrics.json new file mode 100644 index 000000000000..7c0009aa9554 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetWafLogAnalyticsMetrics.json @@ -0,0 +1,132 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "metrics": [ + "clientRequestCount" + ], + "dateTimeBegin": "2020-11-04T06:49:27.554Z", + "dateTimeEnd": "2020-11-04T09:49:27.554Z", + "actions": [ + "block", + "log" + ], + "granularity": "PT5M" + }, + "responses": { + "200": { + "body": { + "dateTimeBegin": "2020-11-04T14:30:27.554+08:00", + "dateTimeEnd": "2020-11-04T17:00:27.554+08:00", + "granularity": "PT5M", + "series": [ + { + "metric": "clientRequestCount", + "unit": "count", + "groups": [], + "data": [ + { + "dateTime": "2020-11-04T07:05:00+00:00", + "value": 2 + }, + { + "dateTime": "2020-11-04T07:10:00+00:00", + "value": 32 + }, + { + "dateTime": "2020-11-04T07:15:00+00:00", + "value": 31 + }, + { + "dateTime": "2020-11-04T07:20:00+00:00", + "value": 63 + }, + { + "dateTime": "2020-11-04T07:25:00+00:00", + "value": 50 + }, + { + "dateTime": "2020-11-04T07:30:00+00:00", + "value": 12 + }, + { + "dateTime": "2020-11-04T07:35:00+00:00", + "value": 8 + }, + { + "dateTime": "2020-11-04T07:40:00+00:00", + "value": 21 + }, + { + "dateTime": "2020-11-04T07:45:00+00:00", + "value": 30 + }, + { + "dateTime": "2020-11-04T07:50:00+00:00", + "value": 18 + }, + { + "dateTime": "2020-11-04T07:55:00+00:00", + "value": 28 + }, + { + "dateTime": "2020-11-04T08:00:00+00:00", + "value": 3 + }, + { + "dateTime": "2020-11-04T08:05:00+00:00", + "value": 58 + }, + { + "dateTime": "2020-11-04T08:10:00+00:00", + "value": 42 + }, + { + "dateTime": "2020-11-04T08:15:00+00:00", + "value": 17 + }, + { + "dateTime": "2020-11-04T08:20:00+00:00", + "value": 21 + }, + { + "dateTime": "2020-11-04T08:25:00+00:00", + "value": 41 + }, + { + "dateTime": "2020-11-04T08:30:00+00:00", + "value": 8 + }, + { + "dateTime": "2020-11-04T08:35:00+00:00", + "value": 15 + }, + { + "dateTime": "2020-11-04T08:40:00+00:00", + "value": 25 + }, + { + "dateTime": "2020-11-04T08:45:00+00:00", + "value": 13 + }, + { + "dateTime": "2020-11-04T08:50:00+00:00", + "value": 17 + }, + { + "dateTime": "2020-11-04T08:55:00+00:00", + "value": 29 + }, + { + "dateTime": "2020-11-04T09:00:00+00:00", + "value": 17 + } + ] + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetWafLogAnalyticsRankings.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetWafLogAnalyticsRankings.json new file mode 100644 index 000000000000..d2639a42f3b2 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetWafLogAnalyticsRankings.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "rankings": [ + "ruleId" + ], + "metrics": [ + "clientRequestCount" + ], + "maxRanking": "5", + "dateTimeBegin": "2020-11-04T06:49:27.554Z", + "dateTimeEnd": "2020-11-04T09:49:27.554Z" + }, + "responses": { + "200": { + "body": { + "dateTimeBegin": "2020-11-04T14:49:27.554+08:00", + "dateTimeEnd": "2020-11-04T17:49:27.554+08:00", + "groups": [ + "ruleId" + ], + "data": [ + { + "groupValues": [ + "BlockRateLimit" + ], + "metrics": [ + { + "metric": "clientRequestCount", + "value": 1268, + "percentage": 0 + } + ] + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Operations_List.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Operations_List.json new file mode 100644 index 000000000000..5b6d6e7baa0e --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Operations_List.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Cdn/register/action", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Microsoft.Cdn Resource Provider", + "operation": "Registers the Microsoft.Cdn Resource Provider" + } + }, + { + "name": "Microsoft.Cdn/edgenodes/read", + "display": { + "provider": "Microsoft.Cdn", + "resource": "EdgeNode", + "operation": "read" + } + }, + { + "name": "Microsoft.Cdn/edgenodes/write", + "display": { + "provider": "Microsoft.Cdn", + "resource": "EdgeNode", + "operation": "write" + } + }, + { + "name": "Microsoft.Cdn/edgenodes/delete", + "display": { + "provider": "Microsoft.Cdn", + "resource": "EdgeNode", + "operation": "delete" + } + }, + { + "name": "Microsoft.Cdn/profiles/read", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "read" + } + }, + { + "name": "Microsoft.Cdn/profiles/write", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "write" + } + }, + { + "name": "Microsoft.Cdn/operationresults/profileresults/write", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "write" + } + }, + { + "name": "Microsoft.Cdn/operationresults/profileresults/delete", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "delete" + } + }, + { + "name": "Microsoft.Cdn/operationresults/profileresults/CheckResourceUsage/action", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "CheckResourceUsage" + } + }, + { + "name": "Microsoft.Cdn/operationresults/profileresults/GenerateSsoUri/action", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "GenerateSsoUri" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Create.json new file mode 100644 index 000000000000..e7e9180589da --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Create.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originGroupName": "origingroup1", + "originGroup": { + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "origingroup1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1", + "type": "Microsoft.Cdn/profiles/endpoints/origingroups", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + }, + "201": { + "body": { + "name": "origingroup1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1", + "type": "Microsoft.Cdn/profiles/endpoints/origingroups", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "originGroup1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1", + "type": "Microsoft.Cdn/profiles/endpoints/origingroups", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Delete.json new file mode 100644 index 000000000000..ea894397bde8 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originGroupName": "originGroup1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Get.json new file mode 100644 index 000000000000..1e8dc056db4a --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originGroupName": "originGroup1" + }, + "responses": { + "200": { + "body": { + "name": "origingroup1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1", + "type": "Microsoft.Cdn/profiles/endpoints/origingroups", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpAndHttpErrors", + "responseBasedFailoverThresholdPercentage": 10, + "httpErrorRanges": [ + { + "begin": 500, + "end": 505 + } + ] + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_ListByEndpoint.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_ListByEndpoint.json new file mode 100644 index 000000000000..068d939278fe --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_ListByEndpoint.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "origingroup1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1", + "type": "Microsoft.Cdn/profiles/endpoints/origingroups", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Update.json new file mode 100644 index 000000000000..3fde7708c5e1 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Update.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originGroupName": "originGroup1", + "originGroupUpdateProperties": { + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ] + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Create.json new file mode 100644 index 000000000000..c1bfc3f8bbce --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Create.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originName": "www-someDomain-net", + "origin": { + "properties": { + "hostName": "www.someDomain.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1", + "privateLinkLocation": "eastus", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link" + } + } + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateEndpointStatus": "Pending", + "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1", + "privateLinkLocation": "eastus", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link" + } + } + }, + "201": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateEndpointStatus": "Pending", + "privateLinkApprovalMessage": "", + "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1", + "privateLinkLocation": "eastus" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateEndpointStatus": "Pending", + "privateLinkApprovalMessage": "", + "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1", + "privateLinkLocation": "eastus" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Delete.json new file mode 100644 index 000000000000..7ad9a804522e --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originName": "origin1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Get.json new file mode 100644 index 000000000000..76fe7295bec6 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originName": "www-someDomain-net" + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": null, + "httpsPort": null, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateEndpointStatus": "Pending", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link", + "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_ListByEndpoint.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_ListByEndpoint.json new file mode 100644 index 000000000000..1d55129f21e5 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_ListByEndpoint.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": null, + "httpsPort": null, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateEndpointStatus": "Pending", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link", + "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Update.json new file mode 100644 index 000000000000..46f6f4ba9525 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Update.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originName": "www-someDomain-net", + "originUpdateProperties": { + "properties": { + "httpPort": 42, + "httpsPort": 43, + "originHostHeader": "www.someDomain2.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice" + } + } + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": 42, + "httpsPort": 43, + "originHostHeader": "www.someDomain2.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateEndpointStatus": "Pending", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link", + "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": 42, + "httpsPort": 43, + "originHostHeader": "www.someDomain2.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateEndpointStatus": "Pending", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link", + "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_CanMigrate.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_CanMigrate.json new file mode 100644 index 000000000000..e990fcf0799c --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_CanMigrate.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "canMigrateParameters": { + "classicResourceReference": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoors/frontdoorname" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/yaoshitest/providers/Microsoft.Cdn/operationresults/operationid/profileresults/DummyProfile/canmigrateresults/DummyProfile", + "type": "Microsoft.Cdn/canmigrate", + "properties": { + "canMigrate": true, + "defaultSku": "Standard_AzureFrontDoor", + "errors": null + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Create.json new file mode 100644 index 000000000000..5d71afbe2c2e --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Create.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "profile": { + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + } + } + }, + "responses": { + "200": { + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + }, + "201": { + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [ + { + "matchVariable": "RequestIPAddress", + "selectorMatchOperator": "EqualsAny", + "selector": null, + "state": "Enabled" + } + ] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [ + { + "matchVariable": "RequestIPAddress", + "selectorMatchOperator": "EqualsAny", + "selector": null, + "state": "Enabled" + } + ] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Creating", + "resourceState": "Creating" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Delete.json new file mode 100644 index 000000000000..0916458730c6 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_GenerateSsoUri.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_GenerateSsoUri.json new file mode 100644 index 000000000000..6b8bd50baefa --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_GenerateSsoUri.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "ssoUriValue": "https://someuri.com" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Get.json new file mode 100644 index 000000000000..a82a4dfd3e04 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_List.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_List.json new file mode 100644 index 000000000000..c590a49088af --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_List.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG1/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + }, + { + "name": "profile2", + "id": "/subscriptions/subid/resourcegroups/RG1/providers/Microsoft.Cdn/profiles/profile2", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListByResourceGroup.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListByResourceGroup.json new file mode 100644 index 000000000000..e2f448df16bb --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListByResourceGroup.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + }, + { + "name": "profile2", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile2", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListResourceUsage.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListResourceUsage.json new file mode 100644 index 000000000000..8697e399d591 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListResourceUsage.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "endpoint", + "unit": "count", + "currentValue": 0, + "limit": 25 + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListSupportedOptimizationTypes.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListSupportedOptimizationTypes.json new file mode 100644 index 000000000000..2b0b2c32d5a1 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListSupportedOptimizationTypes.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "supportedOptimizationTypes": [ + "GeneralWebDelivery", + "DynamicSiteAcceleration" + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Migrate.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Migrate.json new file mode 100644 index 000000000000..d9eb28c9dea8 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Migrate.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "migrationParameters": { + "sku": { + "name": "Standard_AzureFrontDoor" + }, + "classicResourceReference": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoors/frontdoorname" + }, + "profileName": "profile1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/operationresults/operationid/profileresults/profile1/migrateresults/profile1", + "type": "Microsoft.Cdn/migrate", + "properties": { + "migratedProfileResourceId": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1" + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/operationresults/operationid/profileresults/profile1/migrateresults/profile1", + "type": "Microsoft.Cdn/migrate", + "properties": { + "migratedProfileResourceId": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1" + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_MigrationAbort.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_MigrationAbort.json new file mode 100644 index 000000000000..cf5e080906d2 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_MigrationAbort.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_MigrationCommit.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_MigrationCommit.json new file mode 100644 index 000000000000..9d516c0d1760 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_MigrationCommit.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Update.json new file mode 100644 index 000000000000..24082ad92c79 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Update.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "profileUpdateParameters": { + "tags": { + "additionalProperties": "Tag1" + } + } + }, + "responses": { + "200": { + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": { + "additionalProperties": "Tag1" + }, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": { + "additionalProperties": "Tag1" + }, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Updating", + "resourceState": "Active" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/ResourceUsage_List.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/ResourceUsage_List.json new file mode 100644 index 000000000000..01ac52f3af71 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/ResourceUsage_List.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "profile", + "unit": "count", + "currentValue": 31, + "limit": 200 + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Create.json new file mode 100644 index 000000000000..741d0f6a7627 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Create.json @@ -0,0 +1,196 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "routeName": "route1", + "route": { + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreSpecifiedQueryStrings", + "queryParameters": "querystring=test" + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "type": "Microsoft.Cdn/profiles/afdendpoints/routes", + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreSpecifiedQueryStrings", + "queryParameters": "querystring=test" + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "201": { + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "type": "Microsoft.Cdn/profiles/afdendpoints/routes", + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreSpecifiedQueryStrings", + "queryParameters": "querystring=test" + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "type": "Microsoft.Cdn/profiles/afdendpoints/routes", + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreSpecifiedQueryStrings", + "queryParameters": "querystring=test" + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "provisioningState": "Creating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Delete.json new file mode 100644 index 000000000000..b9a57becda1c --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "routeName": "route1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Get.json new file mode 100644 index 000000000000..fef031e0b728 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Get.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "routeName": "route1" + }, + "responses": { + "200": { + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "type": "Microsoft.Cdn/profiles/afdendpoints/routes", + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreQueryString", + "queryParameters": null + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_ListByEndpoint.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_ListByEndpoint.json new file mode 100644 index 000000000000..0bb626dc275b --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_ListByEndpoint.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "type": "Microsoft.Cdn/profiles/afdendpoints/routes", + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreQueryString", + "queryParameters": null + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Update.json new file mode 100644 index 000000000000..47e32c75b17f --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Update.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "routeName": "route1", + "routeUpdateProperties": { + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreQueryString" + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "type": "Microsoft.Cdn/profiles/afdendpoints/routes", + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreQueryString", + "queryParameters": null + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "type": "Microsoft.Cdn/profiles/afdendpoints/routes", + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreQueryString", + "queryParameters": null + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Create.json new file mode 100644 index 000000000000..eb0b3eb03bb7 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Create.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1" + }, + "responses": { + "200": { + "body": { + "name": "ruleSet1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1", + "type": "Microsoft.Cdn/profiles/rulesets", + "properties": { + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "201": { + "body": { + "name": "ruleSet1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1", + "type": "Microsoft.Cdn/profiles/rulesets", + "properties": { + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Delete.json new file mode 100644 index 000000000000..5451157fbf6d --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Get.json new file mode 100644 index 000000000000..fb9c7c270b16 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1" + }, + "responses": { + "200": { + "body": { + "name": "ruleSet1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1", + "type": "Microsoft.Cdn/profiles/rulesets", + "properties": { + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_ListByProfile.json new file mode 100644 index 000000000000..cf8b9786c1b9 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_ListByProfile.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ruleSet1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1", + "type": "Microsoft.Cdn/profiles/rulesets", + "properties": { + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_ListResourceUsage.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_ListResourceUsage.json new file mode 100644 index 000000000000..80b4c18fdab4 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_ListResourceUsage.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 0, + "limit": 25, + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "name": { + "value": "rule", + "localizedValue": "rule" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Create.json new file mode 100644 index 000000000000..6c5ddaaf1e0a --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Create.json @@ -0,0 +1,158 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1", + "ruleName": "rule1", + "rule": { + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false, + "transforms": [] + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "201": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false, + "transforms": [] + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false, + "transforms": [] + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Creating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Delete.json new file mode 100644 index 000000000000..a509654df62a --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1", + "ruleName": "rule1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Get.json new file mode 100644 index 000000000000..a62f63befd85 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Get.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1", + "ruleName": "rule1" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false, + "transforms": [] + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_ListByRuleSet.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_ListByRuleSet.json new file mode 100644 index 000000000000..20492a4573ff --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_ListByRuleSet.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false, + "transforms": [] + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Update.json new file mode 100644 index 000000000000..96f31db989d1 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Update.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1", + "ruleName": "rule1", + "ruleUpdateProperties": { + "properties": { + "order": 1, + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false, + "transforms": [] + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false, + "transforms": [] + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Create.json new file mode 100644 index 000000000000..802db088a6d6 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Create.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "secretName": "secret1", + "secret": { + "properties": { + "parameters": { + "type": "CustomerCertificate", + "secretVersion": "abcdef1234578900abcdef1234567890", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/secrets/certificatename" + }, + "useLatestVersion": false + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "secret1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1", + "type": "Microsoft.Cdn/profiles/secrets", + "properties": { + "parameters": { + "type": "CustomerCertificate", + "subject": "*.contoso.com", + "certificateAuthority": "Symantec", + "expirationDate": "2025-01-01T00:00:00-00:00", + "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename" + }, + "secretVersion": "abcdef1234578900abcdef1234567890", + "useLatestVersion": true, + "subjectAlternativeNames": [ + "foo.contoso.com", + "www3.foo.contoso.com" + ] + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "201": { + "body": { + "name": "secret1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1", + "type": "Microsoft.Cdn/profiles/secrets", + "properties": { + "parameters": { + "type": "CustomerCertificate", + "subject": "*.contoso.com", + "certificateAuthority": "Symantec", + "expirationDate": "2025-01-01T00:00:00-00:00", + "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename" + }, + "secretVersion": "abcdef1234578900abcdef1234567890", + "useLatestVersion": true, + "subjectAlternativeNames": [ + "foo.contoso.com", + "www3.foo.contoso.com" + ] + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "secret1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1", + "type": "Microsoft.Cdn/profiles/secrets", + "properties": { + "parameters": { + "type": "CustomerCertificate", + "subject": "*.contoso.com", + "certificateAuthority": "Symantec", + "expirationDate": "2025-01-01T00:00:00-00:00", + "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename" + }, + "secretVersion": "abcdef1234578900abcdef1234567890", + "useLatestVersion": true, + "subjectAlternativeNames": [ + "foo.contoso.com", + "www3.foo.contoso.com" + ] + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Delete.json new file mode 100644 index 000000000000..77b2842a05b8 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "secretName": "secret1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Get.json new file mode 100644 index 000000000000..350516a84b04 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "secretName": "secret1" + }, + "responses": { + "200": { + "body": { + "name": "secret1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1", + "type": "Microsoft.Cdn/profiles/secrets", + "properties": { + "parameters": { + "type": "CustomerCertificate", + "subject": "*.contoso.com", + "certificateAuthority": "Symantec", + "expirationDate": "2025-01-01T00:00:00-00:00", + "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename" + }, + "secretVersion": "abcdef1234578900abcdef1234567890", + "useLatestVersion": true, + "subjectAlternativeNames": [ + "foo.contoso.com", + "www3.foo.contoso.com" + ] + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_ListByProfile.json new file mode 100644 index 000000000000..d04b5c8f79ff --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_ListByProfile.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "secret1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1", + "type": "Microsoft.Cdn/profiles/secrets", + "properties": { + "parameters": { + "type": "CustomerCertificate", + "subject": "*.contoso.com", + "certificateAuthority": "Symantec", + "expirationDate": "2025-01-01T00:00:00-00:00", + "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename" + }, + "secretVersion": "abcdef1234578900abcdef1234567890", + "useLatestVersion": true, + "subjectAlternativeNames": [ + "foo.contoso.com", + "www3.foo.contoso.com" + ] + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/autogenerated_secret_name", + "type": "Microsoft.Cdn/profiles/secrets", + "name": "69f05517-6aaf-4a1e-a96d-f8c02f66c756-test12-afdx-test-domains-azfdtest-xyz", + "properties": { + "parameters": { + "type": "ManagedCertificate", + "subject": "bar.contoso.com", + "expirationDate": "2025-01-01T00:00:00-00:00" + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Create.json new file mode 100644 index 000000000000..588c03856635 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Create.json @@ -0,0 +1,135 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "securityPolicyName": "securityPolicy1", + "securityPolicy": { + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "securityPolicy1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/securitypolicies/securityPolicy1", + "type": "Microsoft.Cdn/profiles/securitypolicies", + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + }, + "deploymentStatus": "NotStarted", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "securityPolicy1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/securitypolicies/securityPolicy1", + "type": "Microsoft.Cdn/profiles/securitypolicies", + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + }, + "deploymentStatus": "NotStarted", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "securityPolicy1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/securitypolicies/securityPolicy1", + "type": "Microsoft.Cdn/profiles/securitypolicies", + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + }, + "deploymentStatus": "NotStarted", + "provisioningState": "Creating" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Delete.json new file mode 100644 index 000000000000..50d4e6f69ec7 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "securityPolicyName": "securityPolicy1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Get.json new file mode 100644 index 000000000000..982f8795d8e3 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "securityPolicyName": "securityPolicy1" + }, + "responses": { + "200": { + "body": { + "name": "securityPolicy1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/securitypolicies/securityPolicy1", + "type": "Microsoft.Cdn/profiles/securitypolicies", + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + }, + "deploymentStatus": "NotStarted", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_ListByProfile.json new file mode 100644 index 000000000000..b0072b486db8 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_ListByProfile.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "securityPolicy1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/securitypolicies/securityPolicy1", + "type": "Microsoft.Cdn/profiles/securitypolicies", + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + }, + "deploymentStatus": "NotStarted", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Patch.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Patch.json new file mode 100644 index 000000000000..c3d5b6c395f2 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Patch.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "securityPolicyName": "securityPolicy1", + "securityPolicyUpdateProperties": { + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "securityPolicy1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/securitypolicies/securityPolicy1", + "type": "Microsoft.Cdn/profiles/securitypolicies", + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + }, + "deploymentStatus": "NotStarted", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "securityPolicy1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/securitypolicies/securityPolicy1", + "type": "Microsoft.Cdn/profiles/securitypolicies", + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + }, + "deploymentStatus": "NotStarted", + "provisioningState": "Updating" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/ValidateProbe.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/ValidateProbe.json new file mode 100644 index 000000000000..d3728e5807c3 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/ValidateProbe.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "validateProbeInput": { + "probeURL": "https://www.bing.com/image" + } + }, + "responses": { + "200": { + "body": { + "isValid": true, + "errorCode": "None", + "message": null + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafListManagedRuleSets.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafListManagedRuleSets.json new file mode 100644 index 000000000000..6fd17a80c19d --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafListManagedRuleSets.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "DefaultRuleSet_1.0", + "id": "/subscriptions/subid/providers/Microsoft.Cdn/CdnWebApplicationFirewallManagedRuleSets", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallmanagedrulesets", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "provisioningState": "Succeeded", + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroups": [ + { + "ruleGroupName": "Group1", + "description": "Description for rule group 1.", + "rules": [ + { + "ruleId": "GROUP1-0001", + "description": "Generic managed web application firewall rule." + }, + { + "ruleId": "GROUP1-0002", + "description": "Generic managed web application firewall rule." + } + ] + }, + { + "ruleGroupName": "Group2", + "description": "Description for rule group 2.", + "rules": [ + { + "ruleId": "GROUP2-0001", + "description": "Generic managed web application firewall rule." + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafListPolicies.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafListPolicies.json new file mode 100644 index 000000000000..3daa50835a0d --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafListPolicies.json @@ -0,0 +1,265 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "MicrosoftCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 429, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2" + } + ] + } + }, + { + "name": "VerizonStandardCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/VerizonStandardCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Verizon" + }, + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 429, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "ECRS", + "ruleSetVersion": "2018-11-2", + "ruleGroupOverrides": [ + { + "ruleGroupName": "XSS", + "rules": [ + { + "ruleId": "XSS-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "XSS-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint3" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPatchPolicy.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPatchPolicy.json new file mode 100644 index 000000000000..2a3c080ad91a --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPatchPolicy.json @@ -0,0 +1,275 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "MicrosoftCdnWafPolicy", + "cdnWebApplicationFirewallPolicyPatchParameters": { + "tags": { + "foo": "bar" + } + } + }, + "responses": { + "200": { + "body": { + "name": "MicrosoftCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "foo": "bar" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 403, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2" + } + ] + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "MicrosoftCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "resourceState": "Creating", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 403, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2" + } + ] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyCreateOrUpdate.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyCreateOrUpdate.json new file mode 100644 index 000000000000..abe3c83b1d08 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyCreateOrUpdate.json @@ -0,0 +1,508 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "MicrosoftCdnWafPolicy", + "cdnWebApplicationFirewallPolicy": { + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "policySettings": { + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 200, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "MicrosoftCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 200, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2" + } + ] + } + } + }, + "201": { + "body": { + "name": "MicrosoftCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 200, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2" + } + ] + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "MicrosoftCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "resourceState": "Creating", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 200, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 3, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2" + } + ] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyDelete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyDelete.json new file mode 100644 index 000000000000..19b06efe8e72 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "Policy1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyGet.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyGet.json new file mode 100644 index 000000000000..7c3f34ff1bf8 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyGet.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "MicrosoftCdnWafPolicy" + }, + "responses": { + "200": { + "body": { + "name": "MicrosoftCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 429, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2" + } + ] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/scenarios/AFDProfiles_Upgrade_WithoutWaf.yaml b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/scenarios/AFDProfiles_Upgrade_WithoutWaf.yaml new file mode 100644 index 000000000000..7259132992bd --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/scenarios/AFDProfiles_Upgrade_WithoutWaf.yaml @@ -0,0 +1,28 @@ +# yaml-language-server: $schema=https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/documentation/api-scenario/references/v1.2/schema.json +scope: ResourceGroup +variables: + afdprofileName: + type: string + prefix: afdprofile +scenarios: + - scenario: GeneratedScenario + steps: + - step: CheckNameAvailabilityWithSubscription + operationId: CheckNameAvailabilityWithSubscription + exampleFile: ../examples/CheckNameAvailabilityWithSubscription.json + - step: AFDProfiles_Create + operationId: Profiles_Create + parameters: + profileName: $(afdprofileName) + profile: + location: "global" + sku: + name: Standard_AzureFrontDoor + identity: + type: "SystemAssigned" + - step: AFDProfiles_Upgrade + operationId: AFDProfiles_Upgrade + parameters: + profileName: $(afdprofileName) + profileUpgradeParameters: + wafMappingList: [] diff --git a/specification/cdn/resource-manager/readme.md b/specification/cdn/resource-manager/readme.md index d53eb61cf0ca..443c5a4a8a57 100644 --- a/specification/cdn/resource-manager/readme.md +++ b/specification/cdn/resource-manager/readme.md @@ -29,7 +29,21 @@ These are the global settings for the Cdn API. title: CdnManagementClient description: Cdn Management Client openapi-type: arm -tag: package-2024-02 +tag: package-2024-09 +``` + +### Tag: package-2024-09 + +These settings apply only when `--tag=package-2024-09` is specified on the command line. + +```yaml $(tag) == 'package-2024-09' +input-file: + - Microsoft.Cdn/stable/2024-09-01/afdx.json + - Microsoft.Cdn/stable/2024-09-01/cdn.json + - Microsoft.Cdn/stable/2024-09-01/cdnwebapplicationfirewall.json +suppressions: + - code: MISSING_RESOURCE_ID + reason: Keeping it for legacy tooling ``` ### Tag: package-preview-2024-06 diff --git a/specification/cdn/resource-manager/sdk-suppressions.yaml b/specification/cdn/resource-manager/sdk-suppressions.yaml index 45f1cd17ed81..d9f6c6e4c768 100644 --- a/specification/cdn/resource-manager/sdk-suppressions.yaml +++ b/specification/cdn/resource-manager/sdk-suppressions.yaml @@ -106,3 +106,40 @@ suppressions: - Type of `URLRewriteActionParameters.TypeName` has been changed from `*URLRewriteActionParametersTypeName` to `*DeliveryRuleActionParametersType` - Type of `URLSigningAction.Name` has been changed from `*DeliveryRuleAction` to `*DeliveryRuleActionName` - Type of `URLSigningActionParameters.TypeName` has been changed from `*URLSigningActionParametersTypeName` to `*DeliveryRuleActionParametersType` + azure-sdk-for-python: + - package: azure-mgmt-cdn + breaking-changes: + - Deleted or renamed enum value `MatchProcessingBehavior.CONTINUE_ENUM` + - Deleted or renamed model `CacheExpirationActionParametersTypeName` + - Deleted or renamed model `CacheKeyQueryStringActionParametersTypeName` + - Deleted or renamed model `CdnCertificateSourceParametersTypeName` + - Deleted or renamed model `ClientPortMatchConditionParametersTypeName` + - Deleted or renamed model `CookiesMatchConditionParametersTypeName` + - Deleted or renamed model `HeaderActionParametersTypeName` + - Deleted or renamed model `HostNameMatchConditionParametersTypeName` + - Deleted or renamed model `HttpVersionMatchConditionParametersTypeName` + - Deleted or renamed model `IsDeviceMatchConditionParametersMatchValuesItem` + - Deleted or renamed model `IsDeviceMatchConditionParametersTypeName` + - Deleted or renamed model `KeyVaultCertificateSourceParametersTypeName` + - Deleted or renamed model `KeyVaultSigningKeyParametersTypeName` + - Deleted or renamed model `OriginGroupOverrideActionParametersTypeName` + - Deleted or renamed model `PostArgsMatchConditionParametersTypeName` + - Deleted or renamed model `QueryStringMatchConditionParametersTypeName` + - Deleted or renamed model `RemoteAddressMatchConditionParametersTypeName` + - Deleted or renamed model `RequestBodyMatchConditionParametersTypeName` + - Deleted or renamed model `RequestHeaderMatchConditionParametersTypeName` + - Deleted or renamed model `RequestMethodMatchConditionParametersMatchValuesItem` + - Deleted or renamed model `RequestMethodMatchConditionParametersTypeName` + - Deleted or renamed model `RequestSchemeMatchConditionParametersMatchValuesItem` + - Deleted or renamed model `RequestSchemeMatchConditionParametersTypeName` + - Deleted or renamed model `RequestUriMatchConditionParametersTypeName` + - Deleted or renamed model `RouteConfigurationOverrideActionParametersTypeName` + - Deleted or renamed model `ServerPortMatchConditionParametersTypeName` + - Deleted or renamed model `SocketAddrMatchConditionParametersTypeName` + - Deleted or renamed model `SslProtocolMatchConditionParametersTypeName` + - Deleted or renamed model `UrlFileExtensionMatchConditionParametersTypeName` + - Deleted or renamed model `UrlFileNameMatchConditionParametersTypeName` + - Deleted or renamed model `UrlPathMatchConditionParametersTypeName` + - Deleted or renamed model `UrlRedirectActionParametersTypeName` + - Deleted or renamed model `UrlRewriteActionParametersTypeName` + - Deleted or renamed model `UrlSigningActionParametersTypeName` From 1686039507ae0130194cb3d63bd2c840729cd06a Mon Sep 17 00:00:00 2001 From: Sean McCullough <44180881+seanmcc-msft@users.noreply.github.com> Date: Fri, 27 Sep 2024 12:40:18 -0500 Subject: [PATCH 10/47] Files Provisioned Billing V2 updates (#30752) --- .../stable/2025-01-05/file.json | 38 +++++++++++-------- 1 file changed, 22 insertions(+), 16 deletions(-) diff --git a/specification/storage/data-plane/Microsoft.FileStorage/stable/2025-01-05/file.json b/specification/storage/data-plane/Microsoft.FileStorage/stable/2025-01-05/file.json index fddbcfb61b94..904e160827cb 100644 --- a/specification/storage/data-plane/Microsoft.FileStorage/stable/2025-01-05/file.json +++ b/specification/storage/data-plane/Microsoft.FileStorage/stable/2025-01-05/file.json @@ -328,19 +328,25 @@ "x-ms-client-name": "ShareProvisionedIops", "type": "integer", "format": "int64", - "description": "The provisioned IOPS of the share. If this is not specified, compute the recommended IOPS of the share using the formula for a share in this media tier (SSD/HDD as appropriate)." + "description": "The provisioned IOPS of the share." }, "x-ms-share-provisioned-bandwidth-mibps": { "x-ms-client-name": "ShareProvisionedBandwidthMibps", "type": "integer", "format": "int64", - "description": "The provisioned throughput of the share. If this is not specified, compute the recommended throughput of the share using the formula for a share in this media tier (SSD/HDD as appropriate)." + "description": "The provisioned throughput of the share." }, "x-ms-share-included-burst-iops": { "x-ms-client-name": "ShareIncludedBurstIops", "type": "integer", "format": "int64", - "description": "ShareIncludedBurstIops" + "description": "Returns the calculated burst IOPS of the share." + }, + "x-ms-share-max-burst-credits-for-iops": { + "x-ms-client-name": "MaxBurstCreditsForIops", + "description": "Returned the calculated maximum burst credits.", + "type": "integer", + "format": "int64" } } }, @@ -444,7 +450,7 @@ "x-ms-share-provisioned-bandwidth-mibps": { "x-ms-client-name": "ProvisionedBandwidthMibps", "type": "integer", - "description": "Returns the current share provisioned bandwidth in megabits per second." + "description": "Returns the current share provisioned bandwidth in mebibytes per second." }, "x-ms-lease-duration": { "x-ms-client-name": "LeaseDuration", @@ -559,13 +565,13 @@ }, "x-ms-share-next-allowed-provisioned-iops-downgrade-time": { "x-ms-client-name": "NextAllowedProvisionedIopsDowngradeTime", - "description": "Return timestamp for provisioned IOPS following existing rules for provisioned storage GiB.", + "description": "Returns the current share next allowed provisioned iops downgrade time.", "type": "string", "format": "date-time-rfc1123" }, "x-ms-share-next-allowed-provisioned-bandwidth-downgrade-time": { "x-ms-client-name": "NextAllowedProvisionedBandwidthDowngradeTime", - "description": "Return timestamp for provisioned throughput following existing rules for provisioned storage GiB.", + "description": "Returns the current share next allowed provisioned bandwidth downgrade time.", "type": "string", "format": "date-time-rfc1123" } @@ -630,15 +636,15 @@ "format": "date-time-rfc1123", "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." }, - "x-ms-share-usage-bytes": { + "x-ms-file-share-usage-bytes": { "type": "integer", "format": "int64", - "description": "The \"live share\" portion of the data that the customer will be billed for in the soft-deleted capacity (logical storage size)." + "description": "Returned only for provisioned v2 file shares. Returns an approximate used storage size of the share, in bytes." }, - "x-ms-share-snapshot-usage-bytes": { + "x-ms-file-share-snapshot-usage-bytes": { "type": "integer", "format": "int64", - "description": "The snapshot share portion of the data that the customer will be billed for in the soft-deleted capacity (this is the delta, or \"physical storage size\")." + "description": "Returned only for provisioned v2 file shares. Returns an approximate used snapshot storage size of the share, in bytes." } } }, @@ -1638,7 +1644,7 @@ "x-ms-client-name": "ProvisionedBandwidthMibps", "type": "integer", "format": "int64", - "description": "Returns the current share provisioned bandwidth in megabits per second." + "description": "Returns the current share provisioned bandwidth in mebibytes per second." }, "x-ms-share-included-burst-iops": { "x-ms-client-name": "IncludedBurstIops", @@ -1660,13 +1666,13 @@ }, "x-ms-share-next-allowed-provisioned-iops-downgrade-time": { "x-ms-client-name": "NextAllowedProvisionedIopsDowngradeTime", - "description": "Return timestamp for provisioned IOPS following existing rules for provisioned storage GiB.", + "description": "Returns the current share next allowed provisioned iops downgrade time.", "type": "string", "format": "date-time-rfc1123" }, "x-ms-share-next-allowed-provisioned-bandwidth-downgrade-time": { "x-ms-client-name": "NextAllowedProvisionedBandwidthDowngradeTime", - "description": "Return timestamp for provisioned throughput following existing rules for provisioned storage GiB.", + "description": "Returns the current share next allowed provisioned bandwidth downgrade time.", "type": "string", "format": "date-time-rfc1123" } @@ -2137,7 +2143,7 @@ "x-ms-client-name": "ProvisionedBandwidthMibps", "type": "integer", "format": "int64", - "description": "Returns the current share provisioned bandwidth in megabits per second." + "description": "Returns the current share provisioned bandwidth in mebibytes per second." }, "x-ms-share-included-burst-iops": { "x-ms-client-name": "IncludedBurstIops", @@ -7703,7 +7709,7 @@ "name": "x-ms-share-provisioned-iops", "x-ms-client-name": "shareProvisionedIops", "in": "header", - "description": "Optional. The provisioned IOPS of the share. If this is not specified, compute the recommended IOPS of the share using the formula for a share in this media tier (SSD/HDD as appropriate). The provisioned IOPS of the share is always explicitly stored on the share object, even if the recommendation formula is used.", + "description": "Optional. Supported in version 2025-01-05 and later. Only allowed for provisioned v2 file shares. Specifies the provisioned number of input/output operations per second (IOPS) of the share. If this is not specified, the provisioned IOPS is set to value calculated based on recommendation formula.", "required": false, "type": "integer", "format": "int64", @@ -7713,7 +7719,7 @@ "name": "x-ms-share-provisioned-bandwidth-mibps", "x-ms-client-name": "shareProvisionedBandwidthMibps", "in": "header", - "description": "Optional. The provisioned throughput of the share. If this is not specified, compute the recommended throughput of the share using the formula for a share in this media tier (SSD/HDD as appropriate).", + "description": "Optional. Supported in version 2025-01-05 and later. Only allowed for provisioned v2 file shares. Specifies the provisioned bandwidth of the share, in mebibytes per second (MiBps). If this is not specified, the provisioned bandwidth is set to value calculated based on recommendation formula.", "required": false, "type": "integer", "format": "int64", From 9d047817d3b9384a0df78a27dceb93fbb25e2fc9 Mon Sep 17 00:00:00 2001 From: yijinglu-microsoft Date: Fri, 27 Sep 2024 13:15:32 -0700 Subject: [PATCH 11/47] Review request for Microsoft.Devices to add version preview/2025-02-01-preview (#30603) * Copied Content from Previous Api Version * Added MI features for IotHubs * Moved iothubs from Patch to Create * Reverted DPS Create Changes * Updated Description * Fixed Comments --- .../DPSCertificateCreateOrUpdate.json | 33 + .../examples/DPSCheckNameAvailability.json | 18 + .../examples/DPSCreate.json | 75 + ...eateOrUpdatePrivateEndpointConnection.json | 53 + .../examples/DPSDelete.json | 20 + .../examples/DPSDeleteCertificate.json | 14 + .../DPSDeletePrivateEndpointConnection.json | 51 + .../examples/DPSGenerateVerificationCode.json | 27 + .../2025-02-01-preview/examples/DPSGet.json | 47 + .../examples/DPSGetCertificate.json | 28 + .../examples/DPSGetCertificates.json | 31 + .../examples/DPSGetKey.json | 19 + .../examples/DPSGetOperationResult.json | 17 + .../DPSGetPrivateEndpointConnection.json | 28 + .../examples/DPSGetPrivateLinkResources.json | 27 + .../examples/DPSGetValidSku.json | 19 + .../examples/DPSListByResourceGroup.json | 83 + .../examples/DPSListBySubscription.json | 82 + .../examples/DPSListKeys.json | 28 + .../DPSListPrivateEndpointConnections.json | 29 + .../examples/DPSListPrivateLinkResources.json | 30 + .../examples/DPSOperations.json | 293 ++ .../2025-02-01-preview/examples/DPSPatch.json | 55 + .../examples/DPSUpdate.json | 103 + .../examples/DPSVerifyCertificate.json | 32 + .../preview/2025-02-01-preview/iotdps.json | 2602 +++++++++++++++++ .../resource-manager/readme.md | 10 +- 27 files changed, 3853 insertions(+), 1 deletion(-) create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCertificateCreateOrUpdate.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCheckNameAvailability.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCreate.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCreateOrUpdatePrivateEndpointConnection.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDelete.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDeleteCertificate.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDeletePrivateEndpointConnection.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGenerateVerificationCode.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGet.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetCertificate.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetCertificates.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetKey.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetOperationResult.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetPrivateEndpointConnection.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetPrivateLinkResources.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetValidSku.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListByResourceGroup.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListBySubscription.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListKeys.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListPrivateEndpointConnections.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListPrivateLinkResources.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSOperations.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSPatch.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSUpdate.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSVerifyCertificate.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/iotdps.json diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCertificateCreateOrUpdate.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCertificateCreateOrUpdate.json new file mode 100644 index 000000000000..d384a67892f1 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCertificateCreateOrUpdate.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "certificateDescription": { + "properties": { + "certificate": "MA==" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "subject": "CN=testdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "certificate": "MA==", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:23:50 GMT" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServives/myFirstProvisioningService/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/ProvisioningServices/Certificates", + "etag": "AAAAAAExpNs=" + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCheckNameAvailability.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCheckNameAvailability.json new file mode 100644 index 000000000000..9a2550a599d0 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCheckNameAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "arguments": { + "name": "test213123" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "Invalid", + "message": "name is valid" + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCreate.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCreate.json new file mode 100644 index 000000000000..ade2b482cfe3 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCreate.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "iotDpsDescription": { + "location": "East US", + "properties": { + "enableDataResidency": false + }, + "sku": { + "name": "S1", + "capacity": 1 + }, + "tags": {} + } + }, + "responses": { + "200": { + "body": { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "authorizationPolicies": [], + "enableDataResidency": false, + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + }, + "201": { + "body": { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "authorizationPolicies": [], + "enableDataResidency": false, + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCreateOrUpdatePrivateEndpointConnection.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCreateOrUpdatePrivateEndpointConnection.json new file mode 100644 index 000000000000..e393b70cd333 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCreateOrUpdatePrivateEndpointConnection.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "privateEndpointConnectionName": "myPrivateEndpointConnection", + "privateEndpointConnection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/ProvisioningServices/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com", + "actionsRequired": "None" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/ProvisioningServices/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDelete.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDelete.json new file mode 100644 index 000000000000..93cfb7bacbc5 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Retry-After": "15", + "Location": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15", + "Azure-AsyncOperation": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15" + } + }, + "404": {} + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDeleteCertificate.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDeleteCertificate.json new file mode 100644 index 000000000000..192680070d18 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDeleteCertificate.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "If-Match": "AAAAAAAADGk=" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDeletePrivateEndpointConnection.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..b33bd8fcda96 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDeletePrivateEndpointConnection.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "privateEndpointConnectionName": "myPrivateEndpointConnection" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/ProvisioningServices/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Disconnected", + "description": "Deleted", + "actionsRequired": "None" + } + } + } + }, + "202": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/ProvisioningServices/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Disconnected", + "description": "Deleted", + "actionsRequired": "None" + } + } + }, + "headers": { + "Retry-After": "15", + "Location": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15", + "Azure-AsyncOperation": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15" + } + }, + "204": {} + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGenerateVerificationCode.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGenerateVerificationCode.json new file mode 100644 index 000000000000..906c9f322fa7 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGenerateVerificationCode.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "If-Match": "AAAAAAAADGk=" + }, + "responses": { + "200": { + "body": { + "name": "cert", + "properties": { + "verificationCode": "##################################", + "subject": "CN=andbucdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "##############################", + "certificate": "MA==", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:26:56 GMT" + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGet.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGet.json new file mode 100644 index 000000000000..313e13101156 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "authorizationPolicies": [], + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "aa80bd74-a3f0-4f14-b9da-99c5351cf9d5", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": { + "clientId": "c38f618d-47f6-4260-8b3d-1dd8c130f323", + "principalId": "f1b0b133-10dc-4985-966f-a98a04675fe9" + } + } + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetCertificate.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetCertificate.json new file mode 100644 index 000000000000..4c79e9ed564b --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetCertificate.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert" + }, + "responses": { + "200": { + "body": { + "properties": { + "subject": "CN=testdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "certificate": "MA==", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:23:50 GMT" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/andbuc-hub/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/ProvisioningServices/Certificates", + "etag": "AAAAAAExpNs=" + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetCertificates.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetCertificates.json new file mode 100644 index 000000000000..fdd7f9e93c67 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetCertificates.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "subject": "CN=testdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:23:50 GMT", + "certificate": "MA==" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/andbuc-hub/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/ProvisioningServices/Certificates", + "etag": "AAAAAAExpNs=" + } + ] + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetKey.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetKey.json new file mode 100644 index 000000000000..3aea3230851b --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetKey.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "keyName": "testKey" + }, + "responses": { + "200": { + "body": { + "keyName": "testKey", + "primaryKey": "##################################", + "secondaryKey": "################################", + "rights": "RegistrationStatusWrite" + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetOperationResult.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetOperationResult.json new file mode 100644 index 000000000000..594c23b12226 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetOperationResult.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "operationId": "MTY5OTNmZDctODI5Yy00N2E2LTkxNDQtMDU1NGIyYzY1ZjRl", + "asyncinfo": "1508265712453" + }, + "responses": { + "200": { + "body": { + "status": "Succeeded" + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetPrivateEndpointConnection.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetPrivateEndpointConnection.json new file mode 100644 index 000000000000..54f909fa8f3e --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetPrivateEndpointConnection.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "privateEndpointConnectionName": "myPrivateEndpointConnection" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/ProvisioningServices/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my request!", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetPrivateLinkResources.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetPrivateLinkResources.json new file mode 100644 index 000000000000..9a88329068a9 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetPrivateLinkResources.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "groupId": "iotDps" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateLinkResources/iotDps", + "name": "iotDps", + "type": "Microsoft.Devices/ProvisioningServices/PrivateLinkResources", + "properties": { + "groupId": "iotDps", + "requiredMembers": [ + "iotDps" + ], + "requiredZoneNames": [ + "privatelink.azure-devices-provisioning.net" + ] + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetValidSku.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetValidSku.json new file mode 100644 index 000000000000..81468e225ea9 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetValidSku.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "S1" + } + ] + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListByResourceGroup.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListByResourceGroup.json new file mode 100644 index 000000000000..74995ef2de66 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListByResourceGroup.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "aa80bd74-a3f0-4f14-b9da-99c5351cf9d5", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": { + "clientId": "c38f618d-47f6-4260-8b3d-1dd8c130f323", + "principalId": "f1b0b133-10dc-4985-966f-a98a04675fe9" + } + } + } + }, + { + "etag": "AAAAAAAADGk=", + "name": "mySecondProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "mySecondProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/mySecondProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "01341f2b-d497-4117-b5c1-1f1d50b25444", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity2": { + "clientId": "8cd6d250-17dd-4c1b-9847-225237b94c55", + "principalId": "8785a11f-848a-4d5d-a55b-e381b9e15512" + } + } + } + } + ] + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListBySubscription.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListBySubscription.json new file mode 100644 index 000000000000..8675aa9965c4 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListBySubscription.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "aa80bd74-a3f0-4f14-b9da-99c5351cf9d5", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": { + "clientId": "c38f618d-47f6-4260-8b3d-1dd8c130f323", + "principalId": "f1b0b133-10dc-4985-966f-a98a04675fe9" + } + } + } + }, + { + "etag": "AAAAAAAADGk=", + "name": "mySecondProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/mySecondProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "01341f2b-d497-4117-b5c1-1f1d50b25444", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity2": { + "clientId": "8cd6d250-17dd-4c1b-9847-225237b94c55", + "principalId": "8785a11f-848a-4d5d-a55b-e381b9e15512" + } + } + } + } + ] + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListKeys.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListKeys.json new file mode 100644 index 000000000000..fcc4739fa765 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListKeys.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "keyName": "key1", + "primaryKey": "#####################################", + "secondaryKey": "###################################", + "rights": "ServiceConfig" + }, + { + "keyName": "key2", + "primaryKey": "#######################################", + "secondaryKey": "####################################=", + "rights": "ServiceConfig" + } + ] + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListPrivateEndpointConnections.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListPrivateEndpointConnections.json new file mode 100644 index 000000000000..24a98070ae4b --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListPrivateEndpointConnections.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": [ + { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/ProvisioningServices/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my request!", + "actionsRequired": "None" + } + } + } + ] + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListPrivateLinkResources.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListPrivateLinkResources.json new file mode 100644 index 000000000000..47b21410a6a9 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListPrivateLinkResources.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateLinkResources/iotDps", + "name": "iotDps", + "type": "Microsoft.Devices/ProvisioningServices/PrivateLinkResources", + "properties": { + "groupId": "iotDps", + "requiredMembers": [ + "iotDps" + ], + "requiredZoneNames": [ + "privatelink.azure-devices-provisioning.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSOperations.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSOperations.json new file mode 100644 index 000000000000..d5f1c5649b8b --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSOperations.json @@ -0,0 +1,293 @@ +{ + "parameters": { + "api-version": "2025-02-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Devices/register/action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Register Resource Provider" + } + }, + { + "name": "Microsoft.Devices/IotHubs/diagnosticSettings/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Diagnostic Setting" + } + }, + { + "name": "Microsoft.Devices/IotHubs/diagnosticSettings/write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Set Diagnostic Setting" + } + }, + { + "name": "Microsoft.Devices/IotHubs/metricDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read IotHub service metric definitions" + } + }, + { + "name": "Microsoft.Devices/IotHubs/logDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read IotHub service log definitions" + } + }, + { + "name": "Microsoft.Devices/operations/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get All ResourceProvider Operations" + } + }, + { + "name": "Microsoft.Devices/checkNameAvailability/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Check If IotHub name is available" + } + }, + { + "name": "Microsoft.Devices/usages/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Subscription Usages" + } + }, + { + "name": "Microsoft.Devices/iotHubs/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get IotHub(s)" + } + }, + { + "name": "Microsoft.Devices/iotHubs/Write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Create or update IotHub Resource" + } + }, + { + "name": "Microsoft.Devices/iotHubs/Delete", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Delete IotHub Resource" + } + }, + { + "name": "Microsoft.Devices/iotHubs/iotHubStats/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get IotHub Statistics" + } + }, + { + "name": "Microsoft.Devices/iotHubs/skus/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get valid IotHub Skus" + } + }, + { + "name": "Microsoft.Devices/iotHubs/listkeys/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get all IotHub Keys" + } + }, + { + "name": "Microsoft.Devices/iotHubs/iotHubKeys/listkeys/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get IotHub Key for the given name" + } + }, + { + "name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Create EventHub Consumer Group" + } + }, + { + "name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get EventHub Consumer Group(s)" + } + }, + { + "name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Delete", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Delete EventHub Consumer Group" + } + }, + { + "name": "Microsoft.Devices/iotHubs/exportDevices/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Export Devices" + } + }, + { + "name": "Microsoft.Devices/iotHubs/importDevices/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Import Devices" + } + }, + { + "name": "Microsoft.Devices/iotHubs/jobs/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get the Job(s) on IotHub" + } + }, + { + "name": "Microsoft.Devices/iotHubs/quotaMetrics/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Quota Metrics" + } + }, + { + "name": "Microsoft.Devices/iotHubs/routing/routes/$testall/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Routing Rule Test All" + } + }, + { + "name": "Microsoft.Devices/iotHubs/routing/routes/$testnew/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Routing Rule Test Route" + } + }, + { + "name": "Microsoft.Devices/iotHubs/routingEndpointsHealth/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Endpoint Health" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/diagnosticSettings/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Diagnostic Setting" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/diagnosticSettings/write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Set Diagnostic Setting" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/metricDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read DPS service metric definitions" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/logDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read DPS service log definitions" + } + }, + { + "name": "Microsoft.Devices/checkProvisioningServiceNameAvailability/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServives", + "operation": "Check If Provisioning Service name is available" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Get Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/Write", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Create Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/Delete", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Delete Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/skus/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Delete Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/listkeys/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "get security related metadata" + } + } + ] + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSPatch.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSPatch.json new file mode 100644 index 000000000000..fc501f9960dd --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSPatch.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "location": "East US", + "type": "Microsoft.Devices/ProvisioningServices", + "ProvisioningServiceTags": { + "tags": { + "foo": "bar" + } + } + }, + "responses": { + "200": { + "body": { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": { + "foo": "bar" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "aa80bd74-a3f0-4f14-b9da-99c5351cf9d5", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": { + "clientId": "c38f618d-47f6-4260-8b3d-1dd8c130f323", + "principalId": "f1b0b133-10dc-4985-966f-a98a04675fe9" + } + } + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSUpdate.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSUpdate.json new file mode 100644 index 000000000000..a3e15626d8e9 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSUpdate.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "iotDpsDescription": { + "location": "East US", + "properties": { + "enableDataResidency": false + }, + "sku": { + "name": "S1", + "capacity": 1 + }, + "tags": {}, + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "authorizationPolicies": [], + "enableDataResidency": false, + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "aa80bd74-a3f0-4f14-b9da-99c5351cf9d5", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": { + "clientId": "c38f618d-47f6-4260-8b3d-1dd8c130f323", + "principalId": "f1b0b133-10dc-4985-966f-a98a04675fe9" + } + } + } + } + }, + "201": { + "body": { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "authorizationPolicies": [], + "enableDataResidency": false, + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "aa80bd74-a3f0-4f14-b9da-99c5351cf9d5", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": { + "clientId": "c38f618d-47f6-4260-8b3d-1dd8c130f323", + "principalId": "f1b0b133-10dc-4985-966f-a98a04675fe9" + } + } + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSVerifyCertificate.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSVerifyCertificate.json new file mode 100644 index 000000000000..e8b4d390e502 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSVerifyCertificate.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "If-Match": "AAAAAAAADGk=", + "request": { + "certificate": "#####################################" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "subject": "CN=andbucdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "certificate": "MA==", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "isVerified": true, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:26:56 GMT" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/ProvisioningServices/Certificates", + "etag": "AAAAAAExpTQ=" + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/iotdps.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/iotdps.json new file mode 100644 index 000000000000..733eba185022 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/iotdps.json @@ -0,0 +1,2602 @@ +{ + "swagger": "2.0", + "info": { + "version": "2025-02-01-preview", + "x-ms-code-generation-settings": { + "host": "management.azure.com" + }, + "title": "iotDpsClient", + "description": "API for using the Azure IoT Hub Device Provisioning Service features." + }, + "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.Devices/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "DPSOperations": { + "$ref": "./examples/DPSOperations.json" + } + }, + "description": "Lists all of the available Microsoft.Devices REST API operations.", + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}": { + "get": { + "tags": [ + "DpsCertificate" + ], + "operationId": "DpsCertificate_Get", + "description": "Get the certificate from the provisioning service.", + "x-ms-examples": { + "DPSGetCertificate": { + "$ref": "./examples/DPSGetCertificate.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "certificateName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the certificate to retrieve." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the provisioning service the certificate is associated with." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the certificate." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Metadata for the specified certificate.", + "schema": { + "$ref": "#/definitions/CertificateResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "put": { + "tags": [ + "DpsCertificate" + ], + "summary": "Upload the certificate to the provisioning service.", + "description": "Add new certificate or update an existing certificate.", + "operationId": "DpsCertificate_CreateOrUpdate", + "x-ms-examples": { + "DPSCreateOrUpdateCertificate": { + "$ref": "./examples/DPSCertificateCreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group identifier.", + "required": true, + "type": "string" + }, + { + "name": "provisioningServiceName", + "in": "path", + "description": "The name of the provisioning service.", + "required": true, + "type": "string" + }, + { + "name": "certificateName", + "in": "path", + "description": "The name of the certificate create or update.", + "required": true, + "type": "string", + "maxLength": 256 + }, + { + "name": "certificateDescription", + "in": "body", + "description": "The certificate body.", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateResponse" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate." + } + ], + "responses": { + "200": { + "description": "If certificate already exist and update was successful, the operation returns HTTP status code of 201 (OK).", + "schema": { + "$ref": "#/definitions/CertificateResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "DpsCertificate" + ], + "operationId": "DpsCertificate_Delete", + "summary": "Delete the Provisioning Service Certificate.", + "description": "Deletes the specified certificate associated with the Provisioning Service", + "x-ms-examples": { + "DPSDeleteCertificate": { + "$ref": "./examples/DPSDeleteCertificate.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "ETag of the certificate" + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the provisioning service." + }, + { + "name": "certificateName", + "in": "path", + "required": true, + "type": "string", + "description": "This is a mandatory field, and is the logical name of the certificate that the provisioning service will access by." + }, + { + "name": "certificate.name", + "in": "query", + "required": false, + "type": "string", + "description": "This is optional, and it is the Common Name of the certificate." + }, + { + "name": "certificate.rawBytes", + "in": "query", + "required": false, + "type": "string", + "format": "byte", + "description": "Raw data within the certificate." + }, + { + "name": "certificate.isVerified", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates if certificate has been verified by owner of the private key." + }, + { + "name": "certificate.purpose", + "in": "query", + "required": false, + "type": "string", + "description": "A description that mentions the purpose of the certificate.", + "enum": [ + "clientAuthentication", + "serverAuthentication" + ], + "x-ms-enum": { + "name": "CertificatePurpose", + "modelAsString": true + } + }, + { + "name": "certificate.created", + "in": "query", + "description": "Time the certificate is created.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "certificate.lastUpdated", + "in": "query", + "required": false, + "type": "string", + "description": "Time the certificate is last updated.", + "format": "date-time" + }, + { + "name": "certificate.hasPrivateKey", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates if the certificate contains a private key." + }, + { + "name": "certificate.nonce", + "in": "query", + "required": false, + "type": "string", + "description": "Random number generated to indicate Proof of Possession." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}": { + "get": { + "tags": [ + "IotDpsResource" + ], + "summary": "Get the non-security related metadata of the provisioning service.", + "description": "Get the metadata of the provisioning service without SAS keys.", + "operationId": "IotDpsResource_Get", + "x-ms-examples": { + "DPSGet": { + "$ref": "./examples/DPSGet.json" + } + }, + "parameters": [ + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the provisioning service to retrieve." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Provisioning service description with no keys is included in the response.", + "schema": { + "$ref": "#/definitions/ProvisioningServiceDescription" + } + }, + "default": { + "description": "Default error response", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "put": { + "tags": [ + "IotDpsResource" + ], + "summary": "Create or update the metadata of the provisioning service.", + "description": "Create or update the metadata of the provisioning service. The usual pattern to modify a property is to retrieve the provisioning service metadata and security metadata, and then combine them with the modified values in a new body to update the provisioning service.", + "x-ms-long-running-operation": true, + "operationId": "IotDpsResource_CreateOrUpdate", + "x-ms-examples": { + "DPSCreate": { + "$ref": "./examples/DPSCreate.json" + }, + "DPSUpdate": { + "$ref": "./examples/DPSUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of provisioning service to create or update." + }, + { + "name": "iotDpsDescription", + "in": "body", + "required": true, + "description": "Description of the provisioning service to create or update.", + "schema": { + "$ref": "#/definitions/ProvisioningServiceDescription" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The body contains all the non-security properties of the provisioning service. Security-related properties are set to null.", + "schema": { + "$ref": "#/definitions/ProvisioningServiceDescription" + } + }, + "201": { + "description": "This is a long running operation. The operation returns a 201 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation. If successful, the operation returns HTTP status code of 201 (OK).", + "schema": { + "$ref": "#/definitions/ProvisioningServiceDescription" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "patch": { + "tags": [ + "IotDpsResource" + ], + "summary": "Update an existing provisioning service's tags.", + "description": "Update an existing provisioning service's tags. to update other fields use the CreateOrUpdate method", + "x-ms-long-running-operation": true, + "operationId": "IotDpsResource_Update", + "x-ms-examples": { + "DPSPatch": { + "$ref": "./examples/DPSPatch.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of provisioning service to create or update." + }, + { + "name": "ProvisioningServiceTags", + "in": "body", + "required": true, + "description": "Updated tag information to set into the provisioning service instance.", + "schema": { + "$ref": "#/definitions/TagsResource" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Provisioning Service was successfully updated", + "schema": { + "$ref": "#/definitions/ProvisioningServiceDescription" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "IotDpsResource" + ], + "summary": "Delete the Provisioning Service", + "description": "Deletes the Provisioning Service.", + "x-ms-long-running-operation": true, + "operationId": "IotDpsResource_Delete", + "x-ms-examples": { + "DPSDelete": { + "$ref": "./examples/DPSDelete.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of provisioning service to delete." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "202": { + "description": "The provisioning service resource provider always returns a 202 Accepted status code with valid Location and Retry-After headers. The resource provider also sets the Azure-AsyncOperation header with a URL that points to the operation resource for this operation. Subsequent GET attempts on the resource after a DELETE operation return a resource representation that indicates a transitional provisioning state (such as Terminating). To retrieve the status of the operation, a client can either poll the URL returned in the Location header after the Retry-After interval, get the provisioning service status directly, or query the operation resource." + }, + "200": { + "description": "This is returned as a response to the status polling request for the delete operation. The body contains the resource representation that indicates a transitional provisioning state." + }, + "204": { + "description": "Once the long running delete operation completes successfully, a 204 No Content status code is returned when the status polling request finds the provisioning service metadata in the service and the status of the delete operation is set to a completed state." + }, + "404": { + "description": "After the long running delete operation completes successfully, a 404 Not Found is returned when the status polling request no longer finds the provisioning service metadata in the service." + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates": { + "get": { + "tags": [ + "DpsCertificate" + ], + "operationId": "DpsCertificate_List", + "description": "Get all the certificates tied to the provisioning service.", + "x-ms-examples": { + "DPSGetCertificates": { + "$ref": "./examples/DPSGetCertificates.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of resource group." + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of provisioning service to retrieve certificates for." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "List of certificate descriptions in a JSON-serialized array.", + "schema": { + "$ref": "#/definitions/CertificateListDescription" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Devices/provisioningServices": { + "get": { + "tags": [ + "IotDpsResource" + ], + "summary": "Get all the provisioning services in a subscription.", + "description": "List all the provisioning services for a given subscription id.", + "operationId": "IotDpsResource_ListBySubscription", + "x-ms-examples": { + "DPSListBySubscription": { + "$ref": "./examples/DPSListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the provisioning services in the subscription.", + "schema": { + "$ref": "#/definitions/ProvisioningServiceDescriptionListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices": { + "get": { + "tags": [ + "IotDpsResource" + ], + "operationId": "IotDpsResource_ListByResourceGroup", + "description": "Get a list of all provisioning services in the given resource group.", + "x-ms-examples": { + "DPSListByResourceGroup": { + "$ref": "./examples/DPSListByResourceGroup.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "List of provisioning services in the resource group.", + "schema": { + "$ref": "#/definitions/ProvisioningServiceDescriptionListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/operationresults/{operationId}": { + "get": { + "tags": [ + "IotDpsResource" + ], + "operationId": "IotDpsResource_GetOperationResult", + "description": "Gets the status of a long running operation, such as create, update or delete a provisioning service.", + "x-ms-examples": { + "DPSGetOperationResult": { + "$ref": "./examples/DPSGetOperationResult.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "Operation id corresponding to long running operation. Use this to poll for the status." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of provisioning service that the operation is running on." + }, + { + "name": "asyncinfo", + "in": "query", + "description": "Async header used to poll on the status of the operation, obtained while creating the long running operation.", + "required": true, + "type": "string", + "default": "true" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The status of the long running operation.", + "schema": { + "$ref": "#/definitions/AsyncOperationResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/skus": { + "get": { + "tags": [ + "IotDpsResource" + ], + "summary": "Get the list of valid SKUs for a provisioning service.", + "description": "Gets the list of valid SKUs and tiers for a provisioning service.", + "operationId": "IotDpsResource_listValidSkus", + "x-ms-examples": { + "DPSGetValidSku": { + "$ref": "./examples/DPSGetValidSku.json" + } + }, + "parameters": [ + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of provisioning service." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of resource group." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the valid SKUs for this provisioning service.", + "schema": { + "$ref": "#/definitions/IotDpsSkuDefinitionListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/generateVerificationCode": { + "post": { + "tags": [ + "DpsCertificate" + ], + "operationId": "DpsCertificate_GenerateVerificationCode", + "description": "Generate verification code for Proof of Possession.", + "x-ms-examples": { + "DPSGenerateVerificationCode": { + "$ref": "./examples/DPSGenerateVerificationCode.json" + } + }, + "parameters": [ + { + "name": "certificateName", + "in": "path", + "required": true, + "type": "string", + "description": "The mandatory logical name of the certificate, that the provisioning service uses to access." + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "name of resource group." + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of provisioning service." + }, + { + "name": "certificate.name", + "in": "query", + "required": false, + "type": "string", + "description": "Common Name for the certificate." + }, + { + "name": "certificate.rawBytes", + "in": "query", + "required": false, + "type": "string", + "format": "byte", + "description": "Raw data of certificate." + }, + { + "name": "certificate.isVerified", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates if the certificate has been verified by owner of the private key." + }, + { + "name": "certificate.purpose", + "in": "query", + "required": false, + "type": "string", + "description": "Description mentioning the purpose of the certificate.", + "enum": [ + "clientAuthentication", + "serverAuthentication" + ], + "x-ms-enum": { + "name": "CertificatePurpose", + "modelAsString": true + } + }, + { + "name": "certificate.created", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "Certificate creation time." + }, + { + "name": "certificate.lastUpdated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "Certificate last updated time." + }, + { + "name": "certificate.hasPrivateKey", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates if the certificate contains private key." + }, + { + "name": "certificate.nonce", + "in": "query", + "required": false, + "type": "string", + "description": "Random number generated to indicate Proof of Possession." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Generated verification code for that certificate is returned.", + "schema": { + "$ref": "#/definitions/VerificationCodeResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/verify": { + "post": { + "tags": [ + "DpsCertificate" + ], + "operationId": "DpsCertificate_VerifyCertificate", + "summary": "Verify certificate's private key possession.", + "description": "Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.", + "x-ms-examples": { + "DPSVerifyCertificate": { + "$ref": "./examples/DPSVerifyCertificate.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "certificateName", + "in": "path", + "required": true, + "type": "string", + "description": "The mandatory logical name of the certificate, that the provisioning service uses to access." + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "ETag of the certificate." + }, + { + "name": "request", + "in": "body", + "required": true, + "description": "The name of the certificate", + "schema": { + "$ref": "#/definitions/VerificationCodeRequest" + } + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group name." + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Provisioning service name." + }, + { + "name": "certificate.name", + "in": "query", + "required": false, + "type": "string", + "description": "Common Name for the certificate." + }, + { + "name": "certificate.rawBytes", + "in": "query", + "required": false, + "type": "string", + "format": "byte", + "description": "Raw data of certificate." + }, + { + "name": "certificate.isVerified", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates if the certificate has been verified by owner of the private key." + }, + { + "name": "certificate.purpose", + "in": "query", + "required": false, + "description": "Describe the purpose of the certificate.", + "type": "string", + "enum": [ + "clientAuthentication", + "serverAuthentication" + ], + "x-ms-enum": { + "name": "CertificatePurpose", + "modelAsString": true + } + }, + { + "name": "certificate.created", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "Certificate creation time." + }, + { + "name": "certificate.lastUpdated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "Certificate last updated time." + }, + { + "name": "certificate.hasPrivateKey", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates if the certificate contains private key." + }, + { + "name": "certificate.nonce", + "in": "query", + "required": false, + "type": "string", + "description": "Random number generated to indicate Proof of Possession." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CertificateResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkProvisioningServiceNameAvailability": { + "post": { + "tags": [ + "IotDpsResource" + ], + "operationId": "IotDpsResource_CheckProvisioningServiceNameAvailability", + "x-ms-examples": { + "DPSCheckName": { + "$ref": "./examples/DPSCheckNameAvailability.json" + } + }, + "summary": "Check if a provisioning service name is available.", + "description": "Check if a provisioning service name is available. This will validate if the name is syntactically valid and if the name is usable", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "arguments", + "in": "body", + "required": true, + "description": "Set the name parameter in the OperationInputs structure to the name of the provisioning service to check.", + "schema": { + "$ref": "#/definitions/OperationInputs" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the provisioning service name is available. If the name is not available, the body contains the reason.", + "schema": { + "$ref": "#/definitions/NameAvailabilityInfo" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/listkeys": { + "post": { + "tags": [ + "IotDpsResource" + ], + "operationId": "IotDpsResource_ListKeys", + "x-ms-examples": { + "DPSListKeys": { + "$ref": "./examples/DPSListKeys.json" + } + }, + "summary": "Get the security metadata for a provisioning service.", + "description": "List the primary and secondary keys for a provisioning service.", + "parameters": [ + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The provisioning service name to get the shared access keys for." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "resource group name" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of shared access policies, including keys, that you can use to access the provisioning service endpoints.", + "schema": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRuleListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/keys/{keyName}/listkeys": { + "post": { + "tags": [ + "IotDpsResource" + ], + "operationId": "IotDpsResource_ListKeysForKeyName", + "x-ms-examples": { + "DPSGetKey": { + "$ref": "./examples/DPSGetKey.json" + } + }, + "summary": "Get a shared access policy by name from a provisioning service.", + "description": "List primary and secondary keys for a specific key name", + "parameters": [ + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the provisioning service." + }, + { + "name": "keyName", + "in": "path", + "required": true, + "type": "string", + "description": "Logical key name to get key-values for." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The name of the resource group that contains the provisioning service.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized shared access policy, including keys, that you can use to access one or more provisioning service endpoints.", + "schema": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule[AccessRightsDescription]" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "IotDpsResource" + ], + "summary": "List private link resources", + "description": "List private link resources for the given provisioning service", + "operationId": "IotDpsResource_ListPrivateLinkResources", + "x-ms-examples": { + "PrivateLinkResources_List": { + "$ref": "./examples/DPSListPrivateLinkResources.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "The body contains the list of private link resources", + "schema": { + "$ref": "#/definitions/PrivateLinkResources" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateLinkResources/{groupId}": { + "get": { + "tags": [ + "IotDpsResource" + ], + "summary": "Get the specified private link resource", + "description": "Get the specified private link resource for the given provisioning service", + "operationId": "IotDpsResource_GetPrivateLinkResources", + "x-ms-examples": { + "PrivateLinkResources_List": { + "$ref": "./examples/DPSGetPrivateLinkResources.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/groupId" + } + ], + "responses": { + "200": { + "description": "The body contains the specified of private link resource", + "schema": { + "$ref": "#/definitions/GroupIdInformation" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "IotDpsResource" + ], + "summary": "List private endpoint connections", + "description": "List private endpoint connection properties", + "operationId": "IotDpsResource_ListPrivateEndpointConnections", + "x-ms-examples": { + "PrivateEndpointConnections_List": { + "$ref": "./examples/DPSListPrivateEndpointConnections.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "The body contains the list of private endpoint connection properties", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionsList" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "IotDpsResource" + ], + "summary": "Get private endpoint connection", + "description": "Get private endpoint connection properties", + "operationId": "IotDpsResource_GetPrivateEndpointConnection", + "x-ms-examples": { + "PrivateEndpointConnection_Get": { + "$ref": "./examples/DPSGetPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/privateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "The body contains the private endpoint connection properties", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "IotDpsResource" + ], + "summary": "Create or update private endpoint connection", + "description": "Create or update the status of a private endpoint connection with the specified name", + "operationId": "IotDpsResource_CreateOrUpdatePrivateEndpointConnection", + "x-ms-examples": { + "PrivateEndpointConnection_CreateOrUpdate": { + "$ref": "./examples/DPSCreateOrUpdatePrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/privateEndpointConnectionName" + }, + { + "name": "privateEndpointConnection", + "in": "body", + "description": "The private endpoint connection with updated properties", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "201": { + "description": "This is a long running operation. The operation returns a 201 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation. If successful, the operation returns HTTP status code of 201 (OK).", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "200": { + "description": "This is returned as a response to the status polling request for the update operation.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "IotDpsResource" + ], + "summary": "Delete private endpoint connection", + "description": "Delete private endpoint connection with the specified name", + "operationId": "IotDpsResource_DeletePrivateEndpointConnection", + "x-ms-examples": { + "PrivateEndpointConnection_Delete": { + "$ref": "./examples/DPSDeletePrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/privateEndpointConnectionName" + } + ], + "responses": { + "202": { + "description": "This is a long running operation. The operation returns a 202 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "Operation Status Location URI" + }, + "Location": { + "type": "string", + "description": "Operation Status Location URI" + }, + "Retry-After": { + "description": "Retry After", + "type": "string" + } + } + }, + "200": { + "description": "This is returned as a response to the status polling request for the delete operation.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "204": { + "description": "PrivateEndpoint does not exist." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + } + }, + "definitions": { + "AsyncOperationResult": { + "type": "object", + "description": "Result of a long running operation.", + "properties": { + "status": { + "description": "current status of a long running operation.", + "type": "string" + }, + "error": { + "description": "Error message containing code, description and details", + "$ref": "#/definitions/ErrorMessage" + } + } + }, + "ErrorMessage": { + "description": "Error response containing message and code.", + "type": "object", + "properties": { + "code": { + "description": "standard error code", + "type": "string" + }, + "message": { + "description": "standard error description", + "type": "string" + }, + "details": { + "description": "detailed summary of error", + "type": "string" + } + } + }, + "CertificateListDescription": { + "description": "The JSON-serialized array of Certificate objects.", + "type": "object", + "properties": { + "value": { + "description": "The array of Certificate objects.", + "type": "array", + "items": { + "$ref": "#/definitions/CertificateResponse" + } + } + } + }, + "CertificateBodyDescription": { + "description": "The JSON-serialized X509 Certificate.", + "type": "object", + "properties": { + "certificate": { + "description": "Base-64 representation of the X509 leaf certificate .cer file or just .pem file content.", + "type": "string" + }, + "isVerified": { + "description": "True indicates that the certificate will be created in verified state and proof of possession will not be required.", + "type": "boolean" + } + } + }, + "CertificateResponse": { + "description": "The X509 Certificate.", + "type": "object", + "properties": { + "properties": { + "description": "properties of a certificate", + "$ref": "#/definitions/CertificateProperties" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "description": "The name of the certificate.", + "type": "string", + "readOnly": true + }, + "etag": { + "description": "The entity tag.", + "type": "string", + "readOnly": true + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "CertificateProperties": { + "description": "The description of an X509 CA Certificate.", + "type": "object", + "properties": { + "subject": { + "description": "The certificate's subject name.", + "type": "string", + "readOnly": true + }, + "expiry": { + "description": "The certificate's expiration date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + }, + "thumbprint": { + "description": "The certificate's thumbprint.", + "type": "string", + "readOnly": true + }, + "isVerified": { + "description": "Determines whether certificate has been verified.", + "type": "boolean" + }, + "certificate": { + "description": "base-64 representation of X509 certificate .cer file or just .pem file content.", + "type": "string", + "format": "byte" + }, + "created": { + "description": "The certificate's creation date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + }, + "updated": { + "description": "The certificate's last update date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + } + } + }, + "IotDpsSkuInfo": { + "type": "object", + "description": "List of possible provisioning service SKUs.", + "properties": { + "name": { + "description": "Sku name.", + "enum": [ + "S1" + ], + "type": "string", + "x-ms-enum": { + "name": "IotDpsSku", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "readOnly": true, + "description": "Pricing tier name of the provisioning service." + }, + "capacity": { + "format": "int64", + "type": "integer", + "description": "The number of units to provision" + } + } + }, + "ProvisioningServiceDescription": { + "description": "The description of the provisioning service.", + "type": "object", + "properties": { + "etag": { + "description": "The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.", + "type": "string" + }, + "properties": { + "description": "Service specific properties for a provisioning service", + "$ref": "#/definitions/IotDpsPropertiesDescription" + }, + "sku": { + "description": "Sku info for a provisioning Service.", + "$ref": "#/definitions/IotDpsSkuInfo" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + }, + "identity": { + "description": "The managed identities for a provisioning service.", + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "sku", + "properties" + ] + }, + "IotDpsPropertiesDescription": { + "description": "the service specific properties of a provisioning service, including keys, linked iot hubs, current state, and system generated properties such as hostname and idScope", + "type": "object", + "properties": { + "state": { + "description": "Current state of the provisioning service.", + "enum": [ + "Activating", + "Active", + "Deleting", + "Deleted", + "ActivationFailed", + "DeletionFailed", + "Transitioning", + "Suspending", + "Suspended", + "Resuming", + "FailingOver", + "FailoverFailed" + ], + "type": "string", + "x-ms-enum": { + "name": "state", + "modelAsString": true + } + }, + "publicNetworkAccess": { + "type": "string", + "description": "Whether requests from Public Network are allowed", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PublicNetworkAccess" + } + }, + "ipFilterRules": { + "description": "The IP filter rules.", + "type": "array", + "items": { + "$ref": "#/definitions/IpFilterRule" + } + }, + "privateEndpointConnections": { + "description": "Private endpoint connections created on this IotHub", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "provisioningState": { + "description": "The ARM provisioning state of the provisioning service.", + "type": "string" + }, + "iotHubs": { + "type": "array", + "description": "List of IoT hubs associated with this provisioning service.", + "items": { + "$ref": "#/definitions/IotHubDefinitionDescription" + } + }, + "allocationPolicy": { + "enum": [ + "Hashed", + "GeoLatency", + "Static" + ], + "type": "string", + "description": "Allocation policy to be used by this provisioning service.", + "x-ms-enum": { + "name": "AllocationPolicy", + "modelAsString": true + } + }, + "serviceOperationsHostName": { + "description": "Service endpoint for provisioning service.", + "type": "string", + "readOnly": true + }, + "deviceProvisioningHostName": { + "type": "string", + "description": "Device endpoint for this provisioning service.", + "readOnly": true + }, + "idScope": { + "type": "string", + "description": "Unique identifier of this provisioning service.", + "readOnly": true + }, + "authorizationPolicies": { + "description": "List of authorization keys for a provisioning service.", + "type": "array", + "items": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule[AccessRightsDescription]" + } + }, + "enableDataResidency": { + "type": "boolean", + "description": "Optional.\nIndicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery." + }, + "portalOperationsHostName": { + "type": "string", + "description": "Portal endpoint to enable CORS for this provisioning service." + } + } + }, + "IotHubDefinitionDescription": { + "type": "object", + "description": "Description of the IoT hub.", + "properties": { + "applyAllocationPolicy": { + "description": "flag for applying allocationPolicy or not for a given iot hub.", + "type": "boolean" + }, + "allocationWeight": { + "description": "weight to apply for a given iot h.", + "format": "int32", + "type": "integer" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Host name of the IoT hub." + }, + "connectionString": { + "type": "string", + "description": "Connection string of the IoT hub." + }, + "location": { + "type": "string", + "description": "ARM region of the IoT hub." + }, + "authenticationType": { + "description": "IotHub MI authentication type: KeyBased, UserAssigned, SystemAssigned.", + "enum": [ + "KeyBased", + "UserAssigned", + "SystemAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "IotHubAuthenticationType", + "modelAsString": true + } + }, + "selectedUserAssignedIdentityResourceId": { + "type": "string", + "format": "arm-id", + "description": "The selected user-assigned identity resource Id associated with IoT Hub. This is required when authenticationType is UserAssigned.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ] + } + } + }, + "required": [ + "location" + ] + }, + "IpFilterRule": { + "description": "The IP filter rules for a provisioning Service.", + "type": "object", + "properties": { + "filterName": { + "description": "The name of the IP filter rule.", + "type": "string" + }, + "action": { + "description": "The desired action for requests captured by this rule.", + "enum": [ + "Accept", + "Reject" + ], + "type": "string", + "x-ms-enum": { + "name": "IpFilterActionType", + "modelAsString": false + } + }, + "ipMask": { + "description": "A string that contains the IP address range in CIDR notation for the rule.", + "type": "string" + }, + "target": { + "description": "Target for requests captured by this rule.", + "enum": [ + "all", + "serviceApi", + "deviceApi" + ], + "type": "string", + "x-ms-enum": { + "name": "IpFilterTargetType", + "modelAsString": false + } + } + }, + "required": [ + "filterName", + "action", + "ipMask" + ] + }, + "PrivateLinkResources": { + "description": "The available private link resources for a provisioning service", + "type": "object", + "properties": { + "value": { + "description": "The list of available private link resources for a provisioning service", + "type": "array", + "items": { + "$ref": "#/definitions/GroupIdInformation" + } + } + } + }, + "GroupIdInformation": { + "description": "The group information for creating a private endpoint on a provisioning service", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name.", + "pattern": "^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "description": "The properties for a group information object", + "$ref": "#/definitions/GroupIdInformationProperties" + } + }, + "required": [ + "properties" + ] + }, + "GroupIdInformationProperties": { + "description": "The properties for a group information object", + "type": "object", + "properties": { + "groupId": { + "type": "string", + "description": "The group id" + }, + "requiredMembers": { + "description": "The required members for a specific group id", + "type": "array", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "description": "The required DNS zones for a specific group id", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PrivateEndpointConnectionsList": { + "description": "The list of private endpoint connections for a provisioning service", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "PrivateEndpointConnection": { + "description": "The private endpoint connection of a provisioning service", + "x-ms-azure-resource": true, + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name.", + "pattern": "^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "description": "The properties of a private endpoint connection", + "$ref": "#/definitions/PrivateEndpointConnectionProperties" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + }, + "required": [ + "properties" + ] + }, + "PrivateEndpointConnectionProperties": { + "description": "The properties of a private endpoint connection", + "type": "object", + "properties": { + "privateEndpoint": { + "description": "The private endpoint property of a private endpoint connection", + "$ref": "#/definitions/PrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "description": "The current state of a private endpoint connection", + "$ref": "#/definitions/PrivateLinkServiceConnectionState" + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "description": "The private endpoint property of a private endpoint connection", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The current state of a private endpoint connection", + "type": "object", + "properties": { + "status": { + "description": "The status of a private endpoint connection", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateLinkServiceConnectionStatus", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The description for the current state of a private endpoint connection" + }, + "actionsRequired": { + "type": "string", + "description": "Actions required for a private endpoint connection" + } + }, + "required": [ + "status", + "description" + ] + }, + "SharedAccessSignatureAuthorizationRule[AccessRightsDescription]": { + "type": "object", + "description": "Description of the shared access key.", + "properties": { + "keyName": { + "type": "string", + "description": "Name of the key." + }, + "primaryKey": { + "type": "string", + "description": "Primary SAS key value." + }, + "secondaryKey": { + "type": "string", + "description": "Secondary SAS key value." + }, + "rights": { + "description": "Rights that this key has.", + "enum": [ + "ServiceConfig", + "EnrollmentRead", + "EnrollmentWrite", + "DeviceConnect", + "RegistrationStatusRead", + "RegistrationStatusWrite" + ], + "type": "string", + "x-ms-enum": { + "name": "AccessRightsDescription", + "modelAsString": true + } + } + }, + "required": [ + "keyName", + "rights" + ] + }, + "Resource": { + "description": "The common properties of an Azure resource.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name.", + "pattern": "^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "location": { + "type": "string", + "description": "The resource location." + }, + "resourcegroup": { + "type": "string", + "description": "The resource group of the resource." + }, + "subscriptionid": { + "type": "string", + "description": "The subscription id of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + }, + "x-ms-azure-resource": true, + "required": [ + "location" + ] + }, + "OperationListResult": { + "description": "Result of the request to list provisioning service operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "Provisioning service operations supported by the Microsoft.Devices resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "Provisioning Service REST API operation.", + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {provider}/{resource}/{read | write | action | delete}" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "readOnly": true, + "type": "string", + "description": "Service provider: Microsoft Devices." + }, + "resource": { + "readOnly": true, + "type": "string", + "description": "Resource Type: ProvisioningServices." + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "Name of the operation." + } + } + } + } + }, + "ErrorDetails": { + "description": "Error details.", + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "format": "int32", + "type": "integer", + "readOnly": true + }, + "httpStatusCode": { + "description": "The HTTP status code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "The error details.", + "type": "string", + "readOnly": true + } + } + }, + "SharedAccessSignatureAuthorizationRuleListResult": { + "type": "object", + "description": "List of shared access keys.", + "properties": { + "value": { + "description": "The list of shared access policies.", + "type": "array", + "items": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule[AccessRightsDescription]" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "IotDpsSkuDefinitionListResult": { + "type": "object", + "description": "List of available SKUs.", + "properties": { + "value": { + "description": "The list of SKUs", + "type": "array", + "items": { + "$ref": "#/definitions/IotDpsSkuDefinition" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "IotDpsSkuDefinition": { + "type": "object", + "description": "Available SKUs of tier and units.", + "properties": { + "name": { + "description": "Sku name.", + "enum": [ + "S1" + ], + "type": "string", + "x-ms-enum": { + "name": "IotDpsSku", + "modelAsString": true + } + } + } + }, + "OperationInputs": { + "description": "Input values for operation results call.", + "type": "object", + "properties": { + "name": { + "description": "The name of the Provisioning Service to check.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "NameAvailabilityInfo": { + "type": "object", + "description": "Description of name availability.", + "properties": { + "nameAvailable": { + "description": "specifies if a name is available or not", + "type": "boolean" + }, + "reason": { + "description": "specifies the reason a name is unavailable", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "x-ms-enum": { + "name": "NameUnavailabilityReason", + "modelAsString": true + } + }, + "message": { + "description": "message containing a detailed reason name is unavailable", + "type": "string" + } + } + }, + "TagsResource": { + "properties": { + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "A container holding only the Tags for a resource, allowing the user to update the tags on a Provisioning Service instance." + }, + "ProvisioningServiceDescriptionListResult": { + "type": "object", + "description": "List of provisioning service descriptions.", + "properties": { + "value": { + "description": "List of provisioning service descriptions.", + "type": "array", + "items": { + "$ref": "#/definitions/ProvisioningServiceDescription" + } + }, + "nextLink": { + "description": "the next link", + "type": "string", + "readOnly": true + } + } + }, + "VerificationCodeResponse": { + "type": "object", + "description": "Description of the response of the verification code.", + "properties": { + "name": { + "type": "string", + "description": "Name of certificate.", + "readOnly": true + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "Request etag." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "type": "object", + "properties": { + "verificationCode": { + "type": "string", + "description": "Verification code." + }, + "subject": { + "type": "string", + "description": "Certificate subject." + }, + "expiry": { + "type": "string", + "description": "Code expiry." + }, + "thumbprint": { + "type": "string", + "description": "Certificate thumbprint." + }, + "isVerified": { + "type": "boolean", + "description": "Indicate if the certificate is verified by owner of private key." + }, + "certificate": { + "description": "base-64 representation of X509 certificate .cer file or just .pem file content.", + "type": "string", + "format": "byte" + }, + "created": { + "type": "string", + "description": "Certificate created time." + }, + "updated": { + "type": "string", + "description": "Certificate updated time." + } + } + } + }, + "x-ms-azure-resource": true + }, + "VerificationCodeRequest": { + "type": "object", + "description": "The JSON-serialized leaf certificate", + "properties": { + "certificate": { + "description": "base-64 representation of X509 certificate .cer file or just .pem file content.", + "type": "string" + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription identifier.", + "required": true, + "type": "string" + }, + "api-version": { + "name": "api-version", + "in": "query", + "description": "The version of the API.", + "required": true, + "type": "string" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "description": "The name of the resource group that contains the provisioning service.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceName": { + "name": "resourceName", + "in": "path", + "description": "The name of the provisioning service.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "groupId": { + "name": "groupId", + "in": "path", + "description": "The name of the private link resource", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "privateEndpointConnectionName": { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/readme.md b/specification/deviceprovisioningservices/resource-manager/readme.md index 2bfdcf86e814..23b469e6f14a 100644 --- a/specification/deviceprovisioningservices/resource-manager/readme.md +++ b/specification/deviceprovisioningservices/resource-manager/readme.md @@ -27,10 +27,18 @@ These are the global settings for the API. ``` yaml openapi-type: arm azure-arm: true -tag: package-preview-2023-03 +tag: package-preview-2025-02 ``` +### Tag: package-preview-2025-02 + +These settings apply only when `--tag=package-preview-2025-02` is specified on the command line. + +```yaml $(tag) == 'package-preview-2025-02' +input-file: + - Microsoft.Devices/preview/2025-02-01-preview/iotdps.json +``` ### Tag: package-preview-2023-03 These settings apply only when `--tag=package-preview-2023-03` is specified on the command line. From ea4fa55b3428bb77b0d4b1869d5cf07eb264d550 Mon Sep 17 00:00:00 2001 From: Pan Shao <97225342+pshao25@users.noreply.github.com> Date: Sun, 29 Sep 2024 10:35:02 +0800 Subject: [PATCH 12/47] update document for DPG sdk-automation (#30457) * update document for DPG sdk-automation * update --------- Co-authored-by: Pan Shao --- .../.net/README.md | 28 +++++++------------ 1 file changed, 10 insertions(+), 18 deletions(-) diff --git a/documentation/onboard-dpg-in-sdkautomation/.net/README.md b/documentation/onboard-dpg-in-sdkautomation/.net/README.md index c4d4ec97060b..3c071bd90db4 100644 --- a/documentation/onboard-dpg-in-sdkautomation/.net/README.md +++ b/documentation/onboard-dpg-in-sdkautomation/.net/README.md @@ -1,22 +1,14 @@ -# Add Autorest Configuration of .Net SDK +# Add TypeSpec Configuration of .Net SDK -## Parameter Description +Please copy the following configuration into `tspconfig.yaml` in your spec folder and replace `package-dir` and `namespace` to your own values. -- ``: The RP name, which is usually same as folder name in swagger. -- ``: Python package name. -- ``: SDK Client Name. It's optional if there is a title defined in spec readme.md file. - -## Autorest Configuration -Please copy the following configuration into spec PR comment. -~~~ -# azure-sdk-for-net-track2 ``` yaml -title: <Title> -output-folder: sdk/<ServiceName>/<NameSpace> -require: - - specification/<RPName>/data-plane/readme.md + "@azure-tools/typespec-csharp": + package-dir: "Azure.AI.Vision.Face" + flavor: azure + namespace: "{package-dir}" ``` -~~~ -- `title`: If it's already defined in spec readme.md, you don't need to define it here again. (By default, there is no `title` defined in spec readme.md in multi client scenario.) -- `output-folder`: The relative path of destination to generate SDK. -- `require`: The item of the value is the relative path of spec readme.md file. + +- `package-dir`: Name of your package directory. It should be several parts concatenated with `.` and all the paerts should be pascal case. +- `flavor`: Always `azure` for Azure SDK. +- `namespace`: Should be the same as `package-dir`. From ae78c34ab0b0f53a5fc06bb3d67a482287f79624 Mon Sep 17 00:00:00 2001 From: tsaiggo <yangcai@microsoft.com> Date: Sun, 29 Sep 2024 11:42:48 +0800 Subject: [PATCH 13/47] Fix PGSQL V2 missing auth type (#30552) * Fix PGSQL V2 missing auth type * Update sdk-suppressions.yaml --------- Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com> --- .../stable/2018-06-01/entityTypes/LinkedService.json | 8 +++++++- .../datafactory/resource-manager/sdk-suppressions.yaml | 1 + .../stable/2020-12-01/entityTypes/LinkedService.json | 7 ++++++- 3 files changed, 14 insertions(+), 2 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json index 1d953301708b..3d5f1ee81e26 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json @@ -1939,6 +1939,11 @@ "x-ms-format": "dfe-string", "description": "Database name for connection. Type: string." }, + "authenticationType": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The authentication type to use. Type: string." + }, "sslMode": { "type": "object", "x-ms-format": "dfe-int", @@ -2017,7 +2022,8 @@ "server", "username", "database", - "sslMode" + "sslMode", + "authenticationType" ] }, "SybaseLinkedService": { diff --git a/specification/datafactory/resource-manager/sdk-suppressions.yaml b/specification/datafactory/resource-manager/sdk-suppressions.yaml index b22077464b74..cbeef851b326 100644 --- a/specification/datafactory/resource-manager/sdk-suppressions.yaml +++ b/specification/datafactory/resource-manager/sdk-suppressions.yaml @@ -13,3 +13,4 @@ suppressions: - package: "@azure/arm-datafactory" breaking-changes: - Interface HDInsightOnDemandLinkedService has a new required parameter versionTypePropertiesVersion + - Interface PostgreSqlV2LinkedService has a new required parameter authenticationType diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json index 4eba34e78a99..b057e1e32b20 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json @@ -1680,6 +1680,10 @@ "type": "object", "description": "Database name for connection. Type: string." }, + "authenticationType": { + "type": "object", + "description": "The authentication type to use. Type: string." + }, "sslMode": { "type": "object", "description": "SSL mode for connection. Type: integer. 0: disable, 1:allow, 2: prefer, 3: require, 4: verify-ca, 5: verify-full. Type: integer." @@ -1745,7 +1749,8 @@ "server", "username", "database", - "sslMode" + "sslMode", + "authenticationType" ] }, "SybaseLinkedService": { From 9a1180d94248c66f57e40ca14cefb9cda51352ac Mon Sep 17 00:00:00 2001 From: t-ivrihikri <112947032+t-ivrihikri@users.noreply.github.com> Date: Sun, 29 Sep 2024 09:27:28 +0300 Subject: [PATCH 14/47] New API Version From 2024-04-01, Including Total Minutes Indexed (#30684) * First commit - deep copy * Added new field * Editting Readme * another update to readme * Last update for readme.md * Changed and compared to Mani's PR 5 months ago --- .../ViAccountCheckNameAvailabilityFree.json | 17 + .../ViAccountCheckNameAvailabilityTaken.json | 19 + .../examples/ViAccountDelete.json | 13 + .../examples/ViAccountGet.json | 46 + .../PatchAccountWithSystemAssignedMi.json | 49 + .../PatchAccountWithUserAssignedMi.json | 66 + ...ountToArmAccountUsingSystemAssignedMI.json | 72 ++ ...ccountToArmAccountUsingUserAssignedMi.json | 86 ++ ...teOrUpdateAccountWithSystemAssignedMi.json | 80 ++ ...eateOrUpdateAccountWithUserAssignedMi.json | 106 ++ .../examples/ViAccountsList.json | 49 + .../ViAccountsListByResourceGroup.json | 50 + ...GenerateAccountContributerAccessToken.json | 19 + .../ViGenerateAccountReaderAccessToken.json | 19 + ...GenerateProjectContributerAccessToken.json | 20 + .../ViGenerateProjectReaderAccessToken.json | 20 + ...ViGenerateVideoContributerAccessToken.json | 20 + .../ViGenerateVideoReaderAccessToken.json | 20 + ...ateAccountRestrictedViewerAccessToken.json | 18 + ...ateProjectRestrictedViewerAccessToken.json | 19 + ...erateVideoRestrictedViewerAccessToken.json | 19 + .../examples/ViOperationsList.json | 40 + .../preview/2024-09-23-preview/vi.json | 1076 +++++++++++++++++ specification/vi/resource-manager/readme.md | 11 + 24 files changed, 1954 insertions(+) create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountCheckNameAvailabilityFree.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountCheckNameAvailabilityTaken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountDelete.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountGet.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPatch/PatchAccountWithSystemAssignedMi.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPatch/PatchAccountWithUserAssignedMi.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingSystemAssignedMI.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingUserAssignedMi.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/CreateOrUpdateAccountWithSystemAssignedMi.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/CreateOrUpdateAccountWithUserAssignedMi.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountsList.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountsListByResourceGroup.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateAccountContributerAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateAccountReaderAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateAccountRestrictedViewerAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateProjectRestrictedViewerAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateVideoRestrictedViewerAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViOperationsList.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/vi.json diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountCheckNameAvailabilityFree.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountCheckNameAvailabilityFree.json new file mode 100644 index 000000000000..e059a4547ac0 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountCheckNameAvailabilityFree.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-09-23-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/2024-09-23-preview/examples/ViAccountCheckNameAvailabilityTaken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountCheckNameAvailabilityTaken.json new file mode 100644 index 000000000000..80885075d4d7 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountCheckNameAvailabilityTaken.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-09-23-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/2024-09-23-preview/examples/ViAccountDelete.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountDelete.json new file mode 100644 index 000000000000..0225c76e84fe --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contoso-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountGet.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountGet.json new file mode 100644 index 000000000000..68526f20ed9d --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountGet.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contoso-rg", + "api-version": "2024-09-23-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", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2" + }, + "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" + }, + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2": { + "principalId": "d2844978-40e3-4b7d-af13-cb6eeebd2726", + "clientId": "433ac7cb-6071-4052-ba31-65d9e26e21ed" + } + } + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPatch/PatchAccountWithSystemAssignedMi.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPatch/PatchAccountWithSystemAssignedMi.json new file mode 100644 index 000000000000..4945fbc30995 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPatch/PatchAccountWithSystemAssignedMi.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contoso-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "properties": { + "storageServices": {}, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms" + } + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contoso-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", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "43a83441-c17f-4e06-84a3-2eaf86668da7", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPatch/PatchAccountWithUserAssignedMi.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPatch/PatchAccountWithUserAssignedMi.json new file mode 100644 index 000000000000..935bc4354167 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPatch/PatchAccountWithUserAssignedMi.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "properties": { + "storageServices": { + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": {}, + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contoso-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", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "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" + }, + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2": { + "principalId": "d2844978-40e3-4b7d-af13-cb6eeebd2726", + "clientId": "433ac7cb-6071-4052-ba31-65d9e26e21ed" + } + } + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingSystemAssignedMI.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingSystemAssignedMI.json new file mode 100644 index 000000000000..1a7119f362c8 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingSystemAssignedMI.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "location": "NorthEurope", + "properties": { + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms" + } + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "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", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "43a83441-c17f-4e06-84a3-2eaf86668da7", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + }, + "201": { + "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", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "43a83441-c17f-4e06-84a3-2eaf86668da7", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingUserAssignedMi.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingUserAssignedMi.json new file mode 100644 index 000000000000..c8883260a9a4 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingUserAssignedMi.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "location": "NorthEurope", + "properties": { + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/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", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "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" + } + } + } + } + }, + "201": { + "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", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "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/2024-09-23-preview/examples/ViAccountPut/CreateOrUpdateAccountWithSystemAssignedMi.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/CreateOrUpdateAccountWithSystemAssignedMi.json new file mode 100644 index 000000000000..264693ebf9cc --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/CreateOrUpdateAccountWithSystemAssignedMi.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "location": "NorthEurope", + "properties": { + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms" + } + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "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", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "43a83441-c17f-4e06-84a3-2eaf86668da7", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + }, + "201": { + "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", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "43a83441-c17f-4e06-84a3-2eaf86668da7", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/CreateOrUpdateAccountWithUserAssignedMi.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/CreateOrUpdateAccountWithUserAssignedMi.json new file mode 100644 index 000000000000..4a4964b182c6 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/CreateOrUpdateAccountWithUserAssignedMi.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "location": "NorthEurope", + "properties": { + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": {}, + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2": {} + } + } + } + }, + "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", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "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" + }, + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.VideoIndexer/accounts/contoso-videoindexer", + "name": "contoso-videoindexer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contoso-videoindexer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoindexer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi2" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + }, + "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi2": { + "principalId": "d2844978-40e3-4b7d-af13-cb6eeebd2726", + "clientId": "433ac7cb-6071-4052-ba31-65d9e26e21ed" + } + } + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountsList.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountsList.json new file mode 100644 index 000000000000..7db0770aac86 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountsList.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-09-23-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", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2" + }, + "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" + }, + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2": { + "principalId": "d2844978-40e3-4b7d-af13-cb6eeebd2726", + "clientId": "433ac7cb-6071-4052-ba31-65d9e26e21ed" + } + } + } + } + ], + "nextLink": "link" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountsListByResourceGroup.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountsListByResourceGroup.json new file mode 100644 index 000000000000..0ef3f06cbd1b --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountsListByResourceGroup.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "resourceGroupName": "contoso-videoanalyzer-rg", + "api-version": "2024-09-23-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", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2" + }, + "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" + }, + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2": { + "principalId": "d2844978-40e3-4b7d-af13-cb6eeebd2726", + "clientId": "433ac7cb-6071-4052-ba31-65d9e26e21ed" + } + } + } + } + ], + "nextLink": "link" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateAccountContributerAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateAccountContributerAccessToken.json new file mode 100644 index 000000000000..fdba33d78933 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateAccountContributerAccessToken.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Contributor", + "scope": "Account" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "<jwt token of 1260 characters length>" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateAccountReaderAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateAccountReaderAccessToken.json new file mode 100644 index 000000000000..18fe4a67f055 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateAccountReaderAccessToken.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Reader", + "scope": "Account" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "<jwt token of 1260 characters length>" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken.json new file mode 100644 index 000000000000..356c1057e431 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Contributor", + "scope": "Project", + "projectId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "<jwt token of 1260 characters length>" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken.json new file mode 100644 index 000000000000..71587dfc5923 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Reader", + "scope": "Project", + "projectId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "<jwt token of 1260 characters length>" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken.json new file mode 100644 index 000000000000..142cac7282cc --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Contributor", + "scope": "Video", + "videoId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "<jwt token of 1260 characters length>" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken.json new file mode 100644 index 000000000000..0f23754ea11f --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Reader", + "scope": "Video", + "videoId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "<jwt token of 1260 characters length>" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateAccountRestrictedViewerAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateAccountRestrictedViewerAccessToken.json new file mode 100644 index 000000000000..cf6569bdac6c --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateAccountRestrictedViewerAccessToken.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "accountName": "contosto-azurevideoindexer", + "resourceGroupName": "contosto-azurevideoindexer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "scope": "Account" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "<jwt token of 1260 characters length>" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateProjectRestrictedViewerAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateProjectRestrictedViewerAccessToken.json new file mode 100644 index 000000000000..a90c27d34143 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateProjectRestrictedViewerAccessToken.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "contosto-azurevideoindexer", + "resourceGroupName": "contosto-azurevideoindexer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "scope": "Project", + "projectId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "<jwt token of 1260 characters length>" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateVideoRestrictedViewerAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateVideoRestrictedViewerAccessToken.json new file mode 100644 index 000000000000..cc9a68e6e1a7 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateVideoRestrictedViewerAccessToken.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "contosto-azurevideoindexer", + "resourceGroupName": "contosto-azurevideoindexer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "scope": "Video", + "videoId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "<jwt token of 1260 characters length>" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViOperationsList.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViOperationsList.json new file mode 100644 index 000000000000..7c3fc03a4904 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViOperationsList.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-09-23-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.VideoIndexer/accounts/read", + "display": { + "provider": "Microsoft Azure Video Indexer", + "resource": "Account", + "operation": "Read accounts", + "description": "Read accounts" + } + }, + { + "name": "Microsoft.VideoIndexer/accounts/write", + "display": { + "provider": "Microsoft Azure Video Indexer", + "resource": "Account", + "operation": "Update accounts", + "description": "Update accounts" + } + }, + { + "name": "Microsoft.VideoIndexer/accounts/delete", + "display": { + "provider": "Microsoft Azure Video Indexer", + "resource": "Account", + "operation": "Delete accounts", + "description": "Delete accounts" + } + } + ] + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/vi.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/vi.json new file mode 100644 index 000000000000..2f5048fe2f2c --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/vi.json @@ -0,0 +1,1076 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-09-23-preview", + "title": "vi", + "description": "Microsoft Azure Video Indexer" + }, + "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 Indexer 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 Indexer 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 Indexer 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 Indexer 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 Indexer 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 Indexer 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 Indexer account.", + "schema": { + "$ref": "#/definitions/AccountPatch" + } + } + ], + "responses": { + "200": { + "description": "The resource was updated successfully.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch account with system assigned Mi": { + "$ref": "./examples/ViAccountPatch/PatchAccountWithSystemAssignedMi.json" + }, + "Patch account with user assigned Mi": { + "$ref": "./examples/ViAccountPatch/PatchAccountWithUserAssignedMi.json" + } + } + }, + "put": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_CreateOrUpdate", + "description": "Creates or updates an Azure Video Indexer 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 Indexer account.", + "schema": { + "$ref": "#/definitions/Account" + } + } + ], + "responses": { + "200": { + "description": "The resource was successfully updated.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "201": { + "description": "The resource was successfully created.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update account with system assigned Mi": { + "$ref": "./examples/ViAccountPut/CreateOrUpdateAccountWithSystemAssignedMi.json" + }, + "Create or update account with user assigned Mi": { + "$ref": "./examples/ViAccountPut/CreateOrUpdateAccountWithUserAssignedMi.json" + }, + "Connect classic account to arm account using system assigned Mi": { + "$ref": "./examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingSystemAssignedMI.json" + }, + "Connect classic account to arm account using user assigned Mi": { + "$ref": "./examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingUserAssignedMi.json" + } + } + }, + "delete": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_Delete", + "description": "Delete an Azure Video Indexer 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 Indexer account was successfully deleted." + }, + "202": { + "description": "The Azure Video Indexer account will be deleted asynchronously." + }, + "204": { + "description": "The Azure Video Indexer account does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete account": { + "$ref": "./examples/ViAccountDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}/generateAccessToken": { + "post": { + "tags": [ + "AccessToken" + ], + "operationId": "Generate_AccessToken", + "description": "Generate an Azure Video Indexer access token.", + "x-ms-examples": { + "Generate accessToken for video contributor": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken.json" + }, + "Generate accessToken for video reader": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken.json" + }, + "Generate accessToken for project contributor": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken.json" + }, + "Generate accessToken for project reader": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken.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 Indexer account's access token properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/AccessToken" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}/generateRestrictedViewerAccessToken": { + "post": { + "tags": [ + "AccessToken" + ], + "operationId": "Generate_RestrictedViewerAccessToken", + "description": "Generate an Azure Video Indexer restricted viewer access token.", + "x-ms-examples": { + "Generate restricted viewer accessToken for video": { + "$ref": "./examples/ViGenerateRestrictedViewerAccessToken/ViGenerateVideoRestrictedViewerAccessToken.json" + }, + "Generate restricted viewer accessToken for project": { + "$ref": "./examples/ViGenerateRestrictedViewerAccessToken/ViGenerateProjectRestrictedViewerAccessToken.json" + }, + "Generate restricted viewer accessToken for account": { + "$ref": "./examples/ViGenerateRestrictedViewerAccessToken/ViGenerateAccountRestrictedViewerAccessToken.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 restricted viewer access token", + "schema": { + "$ref": "#/definitions/GenerateRestrictedViewerAccessTokenParameters" + } + } + ], + "responses": { + "200": { + "description": "The Azure Video Indexer account's access token properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/AccessToken" + } + }, + "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 Indexer 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 Indexer 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 Indexer 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. This can be set only when connecting an existing classic account", + "type": "string", + "default": "00000000-0000-0000-0000-000000000000", + "example": "3575690b-a569-449c-ab7b-11020f948f76" + }, + "accountName": { + "description": "The account's name", + "type": "string", + "readOnly": true, + "example": "contoso-videoAnalyzer" + }, + "storageServices": { + "description": "The storage services details", + "type": "object", + "$ref": "#/definitions/StorageServicesForPutRequest" + }, + "openAiServices": { + "description": "The openAi services details", + "type": "object", + "$ref": "#/definitions/OpenAiServicesForPutRequest" + }, + "totalSecondsIndexed": { + "description": "An integer representing the total seconds that have been indexed on the account", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "totalMinutesIndexed": { + "description": "An integer representing the total minutes that have been indexed on the account", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "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 Indexer 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" + }, + "storageServices": { + "description": "The storage services details", + "type": "object", + "$ref": "#/definitions/StorageServicesForPatchRequest" + }, + "openAiServices": { + "description": "The openAi services details", + "type": "object", + "$ref": "#/definitions/OpenAiServicesForPatchRequest" + }, + "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" + } + } + }, + "GenerateRestrictedViewerAccessTokenParameters": { + "description": "Restricted viewer access token generation request's parameters", + "type": "object", + "required": [ + "scope" + ], + "properties": { + "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" + } + } + }, + "StorageServicesForPutRequest": { + "description": "The storage services details", + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Storage/storageAccounts" + } + ] + }, + "description": "The storage services resource id", + "example": "/subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.Storage/storageAccounts/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" + } + } + }, + "OpenAiServicesForPutRequest": { + "description": "The openAi services details", + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.CognitiveServices/accounts" + } + ] + }, + "description": "The openAi services resource id", + "example": "/subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-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" + } + } + }, + "StorageServicesForPatchRequest": { + "description": "The storage 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" + } + } + }, + "OpenAiServicesForPatchRequest": { + "description": "The openAi services details", + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.CognitiveServices/accounts" + } + ] + }, + "description": "The openAi services resource id", + "example": "/subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-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" + } + } + }, + "AccessToken": { + "description": "Azure Video Indexer access token.", + "type": "object", + "properties": { + "accessToken": { + "type": "string", + "readOnly": true, + "description": "The access token.", + "x-ms-secret": true, + "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJPbmxpbmUgSldUIEJ1aWxkZXIiLCJpYXQiOjE2MjI0NDc3MzMsImV4cCI6MTY1Mzk4MzczMywiYXVkIjoid3d3LmV4YW1wbGUuY29tIiwic3ViIjoianJvY2tldEBleGFtcGxlLmNvbSIsIkdpdmVuTmFtZSI6IkpvaG5ueSIsIlN1cm5hbWUiOiJSb2NrZXQiLCJFbWFpbCI6Impyb2NrZXRAZXhhbXBsZS5jb20iLCJSb2xlIjpbIk1hbmFnZXIiLCJQcm9qZWN0IEFkbWluaXN0cmF0b3IiXX0" + } + } + }, + "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 Indexer" + }, + "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 Indexer account.", + "pattern": "^[A-Za-z0-9-]+$", + "maxLength": 50, + "minLength": 3, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/vi/resource-manager/readme.md b/specification/vi/resource-manager/readme.md index ecf5ef8d23a9..949f1d71709c 100644 --- a/specification/vi/resource-manager/readme.md +++ b/specification/vi/resource-manager/readme.md @@ -31,6 +31,7 @@ directive: - Microsoft.VideoIndexer/preview/2022-07-20-preview/vi.json - Microsoft.VideoIndexer/preview/2024-04-01-preview/vi.json - Microsoft.VideoIndexer/preview/2024-06-01-preview/vi.json + - Microsoft.VideoIndexer/preview/2024-09-23-preview/vi.json - Microsoft.VideoIndexer/stable/2022-08-01/vi.json where: @@ -53,6 +54,16 @@ openapi-subtype: rpaas tag: package-2024-01 ``` +### Tag: package-2024-09-23-preview + +These settings apply only when `--tag=2024-09-23-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2024-09-23-preview' +version-with-underscores: 2024_09_23_preview +input-file: + - Microsoft.VideoIndexer/preview/2024-09-23-preview/vi.json +``` + ### Tag: package-2024-06-01-preview These settings apply only when `--tag=2024-06-01-preview` is specified on the command line. From a7f22b7c076d6520a6900cdd044cba70032c6374 Mon Sep 17 00:00:00 2001 From: manishpatil8149 <38776869+manishpatil8149@users.noreply.github.com> Date: Mon, 30 Sep 2024 17:38:35 +0530 Subject: [PATCH 15/47] Pre GA readiness changes (#30685) * base commit * added 2024-09-30 api version * fixed tsv validation * fixed prettier failures --------- Co-authored-by: Manish Patil (from Dev Box) <mapatil@microsoft.com> --- .../CertificateProfiles_Create.json | 68 + .../CertificateProfiles_Delete.json | 23 + .../CertificateProfiles_Get.json | 42 + ...cateProfiles_ListByCodeSigningAccount.json | 45 + ...CertificateProfiles_RevokeCertificate.json | 21 + ...SigningAccounts_CheckNameAvailability.json | 18 + .../CodeSigningAccounts_Create.json | 48 + .../CodeSigningAccounts_Delete.json | 24 + .../CodeSigningAccounts_Get.json | 29 + ...deSigningAccounts_ListByResourceGroup.json | 32 + ...odeSigningAccounts_ListBySubscription.json | 31 + .../CodeSigningAccounts_Update.json | 40 + .../2024-09-30-preview/Operations_List.json | 44 + .../CodeSigning.Management/main.tsp | 2 + .../CodeSigning.Management/models.tsp | 28 +- .../codeSigningAccount.json | 1358 +++++++++++++++++ .../examples/CertificateProfiles_Create.json | 68 + .../examples/CertificateProfiles_Delete.json | 23 + .../examples/CertificateProfiles_Get.json | 42 + ...cateProfiles_ListByCodeSigningAccount.json | 45 + ...CertificateProfiles_RevokeCertificate.json | 21 + ...SigningAccounts_CheckNameAvailability.json | 18 + .../examples/CodeSigningAccounts_Create.json | 48 + .../examples/CodeSigningAccounts_Delete.json | 24 + .../examples/CodeSigningAccounts_Get.json | 29 + ...deSigningAccounts_ListByResourceGroup.json | 32 + ...odeSigningAccounts_ListBySubscription.json | 31 + .../examples/CodeSigningAccounts_Update.json | 40 + .../examples/Operations_List.json | 44 + .../codesigning/resource-manager/readme.md | 11 +- .../resource-manager/readme.python.md | 2 +- 31 files changed, 2327 insertions(+), 4 deletions(-) create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Create.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Delete.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Get.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_ListByCodeSigningAccount.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_RevokeCertificate.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_CheckNameAvailability.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Create.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Delete.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Get.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_ListByResourceGroup.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_ListBySubscription.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Update.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/Operations_List.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/codeSigningAccount.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Create.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Delete.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Get.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_ListByCodeSigningAccount.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_RevokeCertificate.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_CheckNameAvailability.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Create.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Delete.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Get.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_ListByResourceGroup.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_ListBySubscription.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Update.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/Operations_List.json diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Create.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Create.json new file mode 100644 index 000000000000..8d6b159c024a --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Create.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resource": { + "properties": { + "profileType": "PublicTrust", + "identityValidationId": "00000000-1234-5678-3333-444444444444", + "includePostalCode": true, + "includeStreetAddress": false + } + }, + "profileName": "profileA", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "profileA", + "type": "Microsoft.CodeSigning/codeSigningAccounts/certificateProfiles", + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount/certificateProfiles/profileA", + "properties": { + "certificates": [ + { + "createdDate": "3/14/2023 5:27:49 PM", + "expiryDate": "3/17/2023 5:27:49 PM", + "enhancedKeyUsage": "1.3.6.1.4.1.311.yy.xxxxxxxx.xxxxxxxx.xxxxxxxxx.xxxxxxxx", + "serialNumber": "xxxxxxxxxxxxxxxxxx", + "status": "Active", + "subjectName": "CN=Contoso Inc, O=Contoso Inc, L=New York, S=New York, C=US", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" + } + ], + "identityValidationId": "00000000-1234-5678-3333-444444444444", + "includeCity": false, + "includeCountry": false, + "includePostalCode": true, + "includeState": false, + "includeStreetAddress": false, + "profileType": "PublicTrust", + "provisioningState": "Succeeded", + "status": "Active" + } + } + }, + "201": { + "body": { + "name": "profileA", + "type": "Microsoft.CodeSigning/codeSigningAccounts/certificateProfiles", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount/certificateProfiles/profileA", + "properties": { + "certificates": [], + "identityValidationId": "00000000-1234-5678-3333-444444444444", + "includeCity": false, + "includeCountry": false, + "includePostalCode": true, + "includeState": false, + "includeStreetAddress": false, + "profileType": "PublicTrust", + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "CertificateProfiles_Create", + "title": "Create a certificate profile." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Delete.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Delete.json new file mode 100644 index 000000000000..e0a743a2cc25 --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "profileName": "profileA", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "CertificateProfiles_Delete", + "title": "Delete a certificate profile." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Get.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Get.json new file mode 100644 index 000000000000..be65a4ceddde --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "profileName": "profileA", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "profileA", + "type": "Microsoft.CodeSigning/codeSigningAccounts/certificateProfiles", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount/certificateProfiles/profileA", + "properties": { + "certificates": [ + { + "createdDate": "3/14/2023 5:27:49 PM", + "expiryDate": "3/17/2023 5:27:49 PM", + "enhancedKeyUsage": "1.3.6.1.4.1.311.yy.xxxxxxxx.xxxxxxxx.xxxxxxxxx.xxxxxxxx", + "serialNumber": "xxxxxxxxxxxxxxxxxx", + "status": "Active", + "subjectName": "CN=Contoso Inc, O=Contoso Inc, L=New York, S=New York, C=US", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" + } + ], + "identityValidationId": "123456", + "includeCity": false, + "includeCountry": false, + "includePostalCode": true, + "includeState": false, + "includeStreetAddress": false, + "profileType": "PublicTrust", + "provisioningState": "Succeeded", + "status": "Active" + } + } + } + }, + "operationId": "CertificateProfiles_Get", + "title": "Get details of a certificate profile." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_ListByCodeSigningAccount.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_ListByCodeSigningAccount.json new file mode 100644 index 000000000000..ba0db472226c --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_ListByCodeSigningAccount.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "profileA", + "type": "Microsoft.CodeSigning/codeSigningAccounts/certificateProfiles", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/profileA", + "properties": { + "certificates": [ + { + "createdDate": "3/14/2023 5:27:49 PM", + "expiryDate": "3/17/2023 5:27:49 PM", + "enhancedKeyUsage": "1.3.6.1.4.1.311.yy.xxxxxxxx.xxxxxxxx.xxxxxxxxx.xxxxxxxx", + "serialNumber": "xxxxxxxxxxxxxxxxxx", + "status": "Active", + "subjectName": "CN=Contoso Inc, O=Contoso Inc, L=New York, S=New York, C=US", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" + } + ], + "identityValidationId": "123456", + "includeCity": false, + "includeCountry": false, + "includePostalCode": true, + "includeState": false, + "includeStreetAddress": false, + "profileType": "PublicTrust", + "provisioningState": "Succeeded", + "status": "Active" + } + } + ] + } + } + }, + "operationId": "CertificateProfiles_ListByCodeSigningAccount", + "title": "List certificate profiles under a trusted signing account." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_RevokeCertificate.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_RevokeCertificate.json new file mode 100644 index 000000000000..17e9e7baa606 --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_RevokeCertificate.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "profileName": "profileA", + "resourceGroupName": "MyResourceGroup", + "body": { + "effectiveAt": "2023-11-12T23:40:25+00:00", + "reason": "KeyCompromised", + "remarks": "test", + "serialNumber": "xxxxxxxxxxxxxxxxxx", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" + }, + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "204": {} + }, + "operationId": "CertificateProfiles_RevokeCertificate", + "title": "Revoke a certificate under a certificate profile." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_CheckNameAvailability.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_CheckNameAvailability.json new file mode 100644 index 000000000000..ae1cfb811407 --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_CheckNameAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "body": { + "name": "sample-account" + }, + "api-version": "2024-09-30-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + }, + "operationId": "CodeSigningAccounts_CheckNameAvailability", + "title": "Checks that the trusted signing account name is available." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Create.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Create.json new file mode 100644 index 000000000000..214d8e3aa374 --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Create.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resource": { + "location": "westus", + "properties": { + "sku": { + "name": "Basic" + } + } + }, + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "MyAccount", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + } + } + }, + "201": { + "body": { + "name": "MyAccount", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Accepted", + "sku": { + "name": "Basic" + } + } + } + } + }, + "operationId": "CodeSigningAccounts_Create", + "title": "Create a trusted Signing Account." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Delete.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Delete.json new file mode 100644 index 000000000000..062f0fda1600 --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Delete.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status", + "location": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status", + "location": "http://azure.async.operation/status" + } + } + }, + "operationId": "CodeSigningAccounts_Delete", + "title": "Delete a trusted signing account." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Get.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Get.json new file mode 100644 index 000000000000..f5d4e090907c --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "MyAccount", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + }, + "tags": { + "key1": "value1" + } + } + } + }, + "operationId": "CodeSigningAccounts_Get", + "title": "Get a Trusted Signing Account" +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_ListByResourceGroup.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_ListByResourceGroup.json new file mode 100644 index 000000000000..50fd72f56334 --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_ListByResourceGroup.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-09-30-preview", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "alpha", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westcentralus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + }, + "tags": { + "key1": "value1" + } + } + ] + } + } + }, + "operationId": "CodeSigningAccounts_ListByResourceGroup", + "title": "Lists trusted signing accounts within a resource group." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_ListBySubscription.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_ListBySubscription.json new file mode 100644 index 000000000000..5c14b6bc07bd --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_ListBySubscription.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-30-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "alpha", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + }, + "tags": { + "key1": "value1" + } + } + ] + } + } + }, + "operationId": "CodeSigningAccounts_ListBySubscription", + "title": "Lists trusted signing accounts within a subscription." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Update.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Update.json new file mode 100644 index 000000000000..1ed4f660a665 --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Update.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "properties": { + "tags": { + "key1": "value1" + } + }, + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "MyAccount", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + }, + "tags": { + "key1": "value1" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status", + "location": "http://azure.async.operation/status" + } + } + }, + "operationId": "CodeSigningAccounts_Update", + "title": "Update a trusted signing account." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/Operations_List.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/Operations_List.json new file mode 100644 index 000000000000..e5f631eac339 --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/Operations_List.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "MyResourceGroup", + "api-version": "2024-09-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.CodeSigning/codeSigningAccounts/write", + "display": { + "provider": "Microsoft.CodeSigning", + "resource": "codeSigningAccounts", + "operation": "Create CodeSigningAccount", + "description": "Create any CodeSigningAccount" + } + }, + { + "name": "Microsoft.CodeSigning/codeSigningAccounts/read", + "display": { + "provider": "Microsoft.CodeSigning", + "resource": "codeSigningAccounts", + "operation": "Get CodeSigningAccount", + "description": "Get any CodeSigningAccount" + } + }, + { + "name": "Microsoft.CodeSigning/codeSigningAccounts/delete", + "display": { + "provider": "Microsoft.CodeSigning", + "resource": "codeSigningAccounts", + "operation": "Delete CodeSigningAccount", + "description": "Delete any CodeSigningAccount" + } + } + ] + } + } + }, + "operationId": "Operations_List", + "title": "List trusted signing account operations." +} diff --git a/specification/codesigning/CodeSigning.Management/main.tsp b/specification/codesigning/CodeSigning.Management/main.tsp index 54a7a1eed540..12a7314db219 100644 --- a/specification/codesigning/CodeSigning.Management/main.tsp +++ b/specification/codesigning/CodeSigning.Management/main.tsp @@ -28,4 +28,6 @@ enum Versions { @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) @useDependency(Azure.Core.Versions.v1_0_Preview_1) v2024_02_05_preview: "2024-02-05-preview", + + v2024_09_30_preview: "2024-09-30-preview", } diff --git a/specification/codesigning/CodeSigning.Management/models.tsp b/specification/codesigning/CodeSigning.Management/models.tsp index bb8b69ae8130..9e0a56c48d02 100644 --- a/specification/codesigning/CodeSigning.Management/models.tsp +++ b/specification/codesigning/CodeSigning.Management/models.tsp @@ -4,6 +4,7 @@ import "@azure-tools/typespec-azure-core"; import "@typespec/openapi"; import "@azure-tools/typespec-azure-resource-manager"; import "@azure-tools/typespec-client-generator-core"; +import "@typespec/versioning"; using TypeSpec.Rest; using TypeSpec.Http; @@ -11,6 +12,7 @@ using Azure.Core; using TypeSpec.OpenAPI; using Azure.ResourceManager; using Azure.ResourceManager.Foundations; +using TypeSpec.Versioning; namespace Microsoft.CodeSigning; @@ -158,7 +160,15 @@ model CodeSigningAccountPatch { @doc("Properties of the trusted signing account.") model CodeSigningAccountPatchProperties { @doc("SKU of the trusted signing account.") - sku?: AccountSku; + @typeChangedFrom(Versions.v2024_09_30_preview, AccountSku) + sku?: AccountSkuPatch; +} + +@doc("SKU of the trusted signing account.") +@added(Versions.v2024_09_30_preview) +model AccountSkuPatch { + @doc("Name of the SKU.") + name?: SkuName; } @doc("Properties of the certificate profile.") @@ -166,18 +176,22 @@ model CertificateProfileProperties { @doc("Profile type of the certificate.") profileType: ProfileType; + @removed(Versions.v2024_09_30_preview) @doc("Used as CN in the certificate subject name.") @visibility("read") commonName?: string; + @removed(Versions.v2024_09_30_preview) @doc("Used as O in the certificate subject name.") @visibility("read") organization?: string; + @removed(Versions.v2024_09_30_preview) @doc("Used as OU in the private trust certificate subject name.") @visibility("read") organizationUnit?: string; + @removed(Versions.v2024_09_30_preview) @doc("Used as STREET in the certificate subject name.") @visibility("read") streetAddress?: string; @@ -185,6 +199,7 @@ model CertificateProfileProperties { @doc("Whether to include STREET in the certificate subject name.") includeStreetAddress?: boolean = false; + @removed(Versions.v2024_09_30_preview) @doc("Used as L in the certificate subject name.") @visibility("read") city?: string; @@ -192,6 +207,7 @@ model CertificateProfileProperties { @doc("Whether to include L in the certificate subject name. Applicable only for private trust, private trust ci profile types") includeCity?: boolean = false; + @removed(Versions.v2024_09_30_preview) @doc("Used as S in the certificate subject name.") @visibility("read") state?: string; @@ -199,6 +215,7 @@ model CertificateProfileProperties { @doc("Whether to include S in the certificate subject name. Applicable only for private trust, private trust ci profile types") includeState?: boolean = false; + @removed(Versions.v2024_09_30_preview) @doc("Used as C in the certificate subject name.") @visibility("read") country?: string; @@ -206,6 +223,7 @@ model CertificateProfileProperties { @doc("Whether to include C in the certificate subject name. Applicable only for private trust, private trust ci profile types") includeCountry?: boolean = false; + @removed(Versions.v2024_09_30_preview) @doc("Used as PC in the certificate subject name.") @visibility("read") postalCode?: string; @@ -213,12 +231,14 @@ model CertificateProfileProperties { @doc("Whether to include PC in the certificate subject name.") includePostalCode?: boolean = false; + @removed(Versions.v2024_09_30_preview) @doc("Enhanced key usage of the certificate.") @visibility("read") enhancedKeyUsage?: string; @doc("Identity validation id used for the certificate subject name.") - identityValidationId?: string; + @madeRequired(Versions.v2024_09_30_preview) + identityValidationId: string; @doc("Status of the current operation on certificate profile.") @visibility("read") @@ -241,6 +261,10 @@ model Certificate { @doc("Serial number of the certificate.") serialNumber?: string; + @doc("Enhanced key usage of the certificate.") + @added(Versions.v2024_09_30_preview) + enhancedKeyUsage?: string; + @doc("Subject name of the certificate.") subjectName?: string; diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/codeSigningAccount.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/codeSigningAccount.json new file mode 100644 index 000000000000..1aa1997bdac2 --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/codeSigningAccount.json @@ -0,0 +1,1358 @@ +{ + "swagger": "2.0", + "info": { + "title": "CodeSigningManagementClient", + "version": "2024-09-30-preview", + "description": "Code Signing resource provider api.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "CodeSigningAccounts" + }, + { + "name": "CertificateProfiles" + } + ], + "paths": { + "/providers/Microsoft.CodeSigning/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List trusted signing account operations.": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CodeSigning/checkNameAvailability": { + "post": { + "operationId": "CodeSigningAccounts_CheckNameAvailability", + "tags": [ + "CodeSigningAccounts" + ], + "description": "Checks that the trusted signing account name is valid and is not already in use.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "body", + "in": "body", + "description": "The CheckAvailability request", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailability" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Checks that the trusted signing account name is available.": { + "$ref": "./examples/CodeSigningAccounts_CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CodeSigning/codeSigningAccounts": { + "get": { + "operationId": "CodeSigningAccounts_ListBySubscription", + "tags": [ + "CodeSigningAccounts" + ], + "description": "Lists trusted signing accounts within a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CodeSigningAccountListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Lists trusted signing accounts within a subscription.": { + "$ref": "./examples/CodeSigningAccounts_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CodeSigning/codeSigningAccounts": { + "get": { + "operationId": "CodeSigningAccounts_ListByResourceGroup", + "tags": [ + "CodeSigningAccounts" + ], + "description": "Lists trusted signing accounts within a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CodeSigningAccountListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Lists trusted signing accounts within a resource group.": { + "$ref": "./examples/CodeSigningAccounts_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CodeSigning/codeSigningAccounts/{accountName}": { + "get": { + "operationId": "CodeSigningAccounts_Get", + "tags": [ + "CodeSigningAccounts" + ], + "description": "Get a trusted Signing Account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Trusted Signing account name.", + "required": true, + "type": "string", + "pattern": "^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CodeSigningAccount" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a Trusted Signing Account": { + "$ref": "./examples/CodeSigningAccounts_Get.json" + } + } + }, + "put": { + "operationId": "CodeSigningAccounts_Create", + "tags": [ + "CodeSigningAccounts" + ], + "description": "Create a trusted Signing Account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Trusted Signing account name.", + "required": true, + "type": "string", + "pattern": "^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + }, + { + "name": "resource", + "in": "body", + "description": "Parameters to create the trusted signing account", + "required": true, + "schema": { + "$ref": "#/definitions/CodeSigningAccount" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CodeSigningAccount' update operation succeeded", + "schema": { + "$ref": "#/definitions/CodeSigningAccount" + } + }, + "201": { + "description": "Resource 'CodeSigningAccount' create operation succeeded", + "schema": { + "$ref": "#/definitions/CodeSigningAccount" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a trusted Signing Account.": { + "$ref": "./examples/CodeSigningAccounts_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "CodeSigningAccounts_Update", + "tags": [ + "CodeSigningAccounts" + ], + "description": "Update a trusted signing account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Trusted Signing account name.", + "required": true, + "type": "string", + "pattern": "^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + }, + { + "name": "properties", + "in": "body", + "description": "Parameters supplied to update the trusted signing account", + "required": true, + "schema": { + "$ref": "#/definitions/CodeSigningAccountPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CodeSigningAccount" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update a trusted signing account.": { + "$ref": "./examples/CodeSigningAccounts_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CodeSigningAccounts_Delete", + "tags": [ + "CodeSigningAccounts" + ], + "description": "Delete a trusted signing account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Trusted Signing account name.", + "required": true, + "type": "string", + "pattern": "^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a trusted signing account.": { + "$ref": "./examples/CodeSigningAccounts_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CodeSigning/codeSigningAccounts/{accountName}/certificateProfiles": { + "get": { + "operationId": "CertificateProfiles_ListByCodeSigningAccount", + "tags": [ + "CertificateProfiles" + ], + "description": "List certificate profiles under a trusted signing account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Trusted Signing account name.", + "required": true, + "type": "string", + "pattern": "^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateProfileListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List certificate profiles under a trusted signing account.": { + "$ref": "./examples/CertificateProfiles_ListByCodeSigningAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CodeSigning/codeSigningAccounts/{accountName}/certificateProfiles/{profileName}": { + "get": { + "operationId": "CertificateProfiles_Get", + "tags": [ + "CertificateProfiles" + ], + "description": "Get details of a certificate profile.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Trusted Signing account name.", + "required": true, + "type": "string", + "pattern": "^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + }, + { + "name": "profileName", + "in": "path", + "description": "Certificate profile name.", + "required": true, + "type": "string", + "pattern": "^(?=.{5,100}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateProfile" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get details of a certificate profile.": { + "$ref": "./examples/CertificateProfiles_Get.json" + } + } + }, + "put": { + "operationId": "CertificateProfiles_Create", + "tags": [ + "CertificateProfiles" + ], + "description": "Create a certificate profile.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Trusted Signing account name.", + "required": true, + "type": "string", + "pattern": "^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + }, + { + "name": "profileName", + "in": "path", + "description": "Certificate profile name.", + "required": true, + "type": "string", + "pattern": "^(?=.{5,100}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + }, + { + "name": "resource", + "in": "body", + "description": "Parameters to create the certificate profile", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateProfile" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CertificateProfile' update operation succeeded", + "schema": { + "$ref": "#/definitions/CertificateProfile" + } + }, + "201": { + "description": "Resource 'CertificateProfile' create operation succeeded", + "schema": { + "$ref": "#/definitions/CertificateProfile" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a certificate profile.": { + "$ref": "./examples/CertificateProfiles_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CertificateProfiles_Delete", + "tags": [ + "CertificateProfiles" + ], + "description": "Delete a certificate profile.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Trusted Signing account name.", + "required": true, + "type": "string", + "pattern": "^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + }, + { + "name": "profileName", + "in": "path", + "description": "Certificate profile name.", + "required": true, + "type": "string", + "pattern": "^(?=.{5,100}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a certificate profile.": { + "$ref": "./examples/CertificateProfiles_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CodeSigning/codeSigningAccounts/{accountName}/certificateProfiles/{profileName}/revokeCertificate": { + "post": { + "operationId": "CertificateProfiles_RevokeCertificate", + "tags": [ + "CertificateProfiles" + ], + "description": "Revoke a certificate under a certificate profile.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Trusted Signing account name.", + "required": true, + "type": "string", + "pattern": "^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + }, + { + "name": "profileName", + "in": "path", + "description": "Certificate profile name.", + "required": true, + "type": "string", + "pattern": "^(?=.{5,100}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + }, + { + "name": "body", + "in": "body", + "description": "Parameters to revoke the certificate profile", + "required": true, + "schema": { + "$ref": "#/definitions/RevokeCertificate" + } + } + ], + "responses": { + "204": { + "description": "Action completed successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Revoke a certificate under a certificate profile.": { + "$ref": "./examples/CertificateProfiles_RevokeCertificate.json" + } + } + } + } + }, + "definitions": { + "AccountSku": { + "type": "object", + "description": "SKU of the trusted signing account.", + "properties": { + "name": { + "$ref": "#/definitions/SkuName", + "description": "Name of the SKU." + } + }, + "required": [ + "name" + ] + }, + "AccountSkuPatch": { + "type": "object", + "description": "SKU of the trusted signing account.", + "properties": { + "name": { + "$ref": "#/definitions/SkuName", + "description": "Name of the SKU." + } + } + }, + "Certificate": { + "type": "object", + "description": "Properties of the certificate.", + "properties": { + "serialNumber": { + "type": "string", + "description": "Serial number of the certificate." + }, + "enhancedKeyUsage": { + "type": "string", + "description": "Enhanced key usage of the certificate." + }, + "subjectName": { + "type": "string", + "description": "Subject name of the certificate." + }, + "thumbprint": { + "type": "string", + "description": "Thumbprint of the certificate." + }, + "createdDate": { + "type": "string", + "description": "Certificate created date." + }, + "expiryDate": { + "type": "string", + "description": "Certificate expiry date." + }, + "status": { + "$ref": "#/definitions/CertificateStatus", + "description": "Status of the certificate." + }, + "revocation": { + "$ref": "#/definitions/Revocation", + "description": "Revocations history of a certificate.", + "x-ms-client-flatten": true + } + } + }, + "CertificateProfile": { + "type": "object", + "description": "Certificate profile resource.", + "properties": { + "properties": { + "$ref": "#/definitions/CertificateProfileProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "CertificateProfileListResult": { + "type": "object", + "description": "The response of a CertificateProfile list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CertificateProfile items on this page", + "items": { + "$ref": "#/definitions/CertificateProfile" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CertificateProfileProperties": { + "type": "object", + "description": "Properties of the certificate profile.", + "properties": { + "profileType": { + "$ref": "#/definitions/ProfileType", + "description": "Profile type of the certificate." + }, + "includeStreetAddress": { + "type": "boolean", + "description": "Whether to include STREET in the certificate subject name.", + "default": false + }, + "includeCity": { + "type": "boolean", + "description": "Whether to include L in the certificate subject name. Applicable only for private trust, private trust ci profile types", + "default": false + }, + "includeState": { + "type": "boolean", + "description": "Whether to include S in the certificate subject name. Applicable only for private trust, private trust ci profile types", + "default": false + }, + "includeCountry": { + "type": "boolean", + "description": "Whether to include C in the certificate subject name. Applicable only for private trust, private trust ci profile types", + "default": false + }, + "includePostalCode": { + "type": "boolean", + "description": "Whether to include PC in the certificate subject name.", + "default": false + }, + "identityValidationId": { + "type": "string", + "description": "Identity validation id used for the certificate subject name." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Status of the current operation on certificate profile.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/CertificateProfileStatus", + "description": "Status of the certificate profile.", + "readOnly": true + }, + "certificates": { + "type": "array", + "description": "List of renewed certificates.", + "items": { + "$ref": "#/definitions/Certificate" + }, + "readOnly": true, + "x-ms-client-flatten": true, + "x-ms-identifiers": [] + } + }, + "required": [ + "profileType", + "identityValidationId" + ] + }, + "CertificateProfileStatus": { + "type": "string", + "description": "Status of the certificate profiles.", + "enum": [ + "Active", + "Disabled", + "Suspended" + ], + "x-ms-enum": { + "name": "CertificateProfileStatus", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "The certificate profile is active." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The certificate profile is disabled." + }, + { + "name": "Suspended", + "value": "Suspended", + "description": "The certificate profile is suspended." + } + ] + } + }, + "CertificateStatus": { + "type": "string", + "description": "Status of the certificate", + "enum": [ + "Active", + "Expired", + "Revoked" + ], + "x-ms-enum": { + "name": "CertificateStatus", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "The certificate is active." + }, + { + "name": "Expired", + "value": "Expired", + "description": "The certificate is expired." + }, + { + "name": "Revoked", + "value": "Revoked", + "description": "The certificate is revoked." + } + ] + } + }, + "CheckNameAvailability": { + "type": "object", + "description": "The parameters used to check the availability of the trusted signing account name.", + "properties": { + "name": { + "type": "string", + "description": "Trusted signing account name." + } + }, + "required": [ + "name" + ] + }, + "CheckNameAvailabilityResult": { + "type": "object", + "description": "The CheckNameAvailability operation response.", + "properties": { + "nameAvailable": { + "type": "boolean", + "description": "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 or is invalid and cannot be used.", + "readOnly": true + }, + "reason": { + "$ref": "#/definitions/NameUnavailabilityReason", + "description": "The reason that a trusted signing account name could not be used. The Reason element is only returned if nameAvailable is false.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "An error message explaining the Reason value in more detail.", + "readOnly": true + } + } + }, + "CodeSigningAccount": { + "type": "object", + "description": "Trusted signing account resource.", + "properties": { + "properties": { + "$ref": "#/definitions/CodeSigningAccountProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CodeSigningAccountListResult": { + "type": "object", + "description": "The response of a CodeSigningAccount list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CodeSigningAccount items on this page", + "items": { + "$ref": "#/definitions/CodeSigningAccount" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CodeSigningAccountPatch": { + "type": "object", + "description": "Parameters for creating or updating a trusted signing account.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/CodeSigningAccountPatchProperties", + "description": "Properties of the trusted signing account.", + "x-ms-client-flatten": true + } + } + }, + "CodeSigningAccountPatchProperties": { + "type": "object", + "description": "Properties of the trusted signing account.", + "properties": { + "sku": { + "$ref": "#/definitions/AccountSkuPatch", + "description": "SKU of the trusted signing account." + } + } + }, + "CodeSigningAccountProperties": { + "type": "object", + "description": "Properties of the trusted signing account.", + "properties": { + "accountUri": { + "type": "string", + "description": "The URI of the trusted signing account which is used during signing files.", + "readOnly": true + }, + "sku": { + "$ref": "#/definitions/AccountSku", + "description": "SKU of the trusted signing account." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Status of the current operation on trusted signing account.", + "readOnly": true + } + } + }, + "NameUnavailabilityReason": { + "type": "string", + "description": "The reason that a trusted signing account name could not be used. The Reason element is only returned if nameAvailable is false.", + "enum": [ + "AccountNameInvalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "NameUnavailabilityReason", + "modelAsString": true, + "values": [ + { + "name": "AccountNameInvalid", + "value": "AccountNameInvalid", + "description": "Account name is invalid" + }, + { + "name": "AlreadyExists", + "value": "AlreadyExists", + "description": "Account name already exists" + } + ] + } + }, + "ProfileType": { + "type": "string", + "description": "Type of the certificate", + "enum": [ + "PublicTrust", + "PrivateTrust", + "PrivateTrustCIPolicy", + "VBSEnclave", + "PublicTrustTest" + ], + "x-ms-enum": { + "name": "ProfileType", + "modelAsString": true, + "values": [ + { + "name": "PublicTrust", + "value": "PublicTrust", + "description": "Used for signing files which are distributed publicly." + }, + { + "name": "PrivateTrust", + "value": "PrivateTrust", + "description": "Used for signing files which are distributed internally within organization or group boundary." + }, + { + "name": "PrivateTrustCIPolicy", + "value": "PrivateTrustCIPolicy", + "description": "Used for signing CI policy files." + }, + { + "name": "VBSEnclave", + "value": "VBSEnclave", + "description": "Used for signing files which are run in secure vbs enclave." + }, + { + "name": "PublicTrustTest", + "value": "PublicTrustTest", + "description": "Used for signing files for testing purpose." + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The status of the current operation.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Updating", + "Deleting", + "Accepted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Updating", + "value": "Updating", + "description": "Updating in progress." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Deletion in progress." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Resource creation started." + } + ] + }, + "readOnly": true + }, + "Revocation": { + "type": "object", + "description": "Revocation details of the certificate.", + "properties": { + "requestedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp when the revocation is requested." + }, + "effectiveAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp when the revocation is effective." + }, + "reason": { + "type": "string", + "description": "Reason for revocation." + }, + "remarks": { + "type": "string", + "description": "Remarks for the revocation." + }, + "status": { + "$ref": "#/definitions/RevocationStatus", + "description": "Status of the revocation." + }, + "failureReason": { + "type": "string", + "description": "Reason for the revocation failure." + } + } + }, + "RevocationStatus": { + "type": "string", + "description": "Revocation status of the certificate.", + "enum": [ + "Succeeded", + "InProgress", + "Failed" + ], + "x-ms-enum": { + "name": "RevocationStatus", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Certificate revocation succeeded." + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "Certificate revocation is in progress." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Certificate revocation failed." + } + ] + }, + "readOnly": true + }, + "RevokeCertificate": { + "type": "object", + "description": "Defines the certificate revocation properties.", + "properties": { + "serialNumber": { + "type": "string", + "description": "Serial number of the certificate." + }, + "thumbprint": { + "type": "string", + "description": "Thumbprint of the certificate." + }, + "effectiveAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp when the revocation is effective." + }, + "reason": { + "type": "string", + "description": "Reason for the revocation." + }, + "remarks": { + "type": "string", + "description": "Remarks for the revocation." + } + }, + "required": [ + "serialNumber", + "thumbprint", + "effectiveAt", + "reason" + ] + }, + "SkuName": { + "type": "string", + "description": "Name of the sku.", + "enum": [ + "Basic", + "Premium" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true, + "values": [ + { + "name": "Basic", + "value": "Basic", + "description": "Basic sku." + }, + { + "name": "Premium", + "value": "Premium", + "description": "Premium sku." + } + ] + } + } + }, + "parameters": {} +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Create.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Create.json new file mode 100644 index 000000000000..8d6b159c024a --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Create.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resource": { + "properties": { + "profileType": "PublicTrust", + "identityValidationId": "00000000-1234-5678-3333-444444444444", + "includePostalCode": true, + "includeStreetAddress": false + } + }, + "profileName": "profileA", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "profileA", + "type": "Microsoft.CodeSigning/codeSigningAccounts/certificateProfiles", + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount/certificateProfiles/profileA", + "properties": { + "certificates": [ + { + "createdDate": "3/14/2023 5:27:49 PM", + "expiryDate": "3/17/2023 5:27:49 PM", + "enhancedKeyUsage": "1.3.6.1.4.1.311.yy.xxxxxxxx.xxxxxxxx.xxxxxxxxx.xxxxxxxx", + "serialNumber": "xxxxxxxxxxxxxxxxxx", + "status": "Active", + "subjectName": "CN=Contoso Inc, O=Contoso Inc, L=New York, S=New York, C=US", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" + } + ], + "identityValidationId": "00000000-1234-5678-3333-444444444444", + "includeCity": false, + "includeCountry": false, + "includePostalCode": true, + "includeState": false, + "includeStreetAddress": false, + "profileType": "PublicTrust", + "provisioningState": "Succeeded", + "status": "Active" + } + } + }, + "201": { + "body": { + "name": "profileA", + "type": "Microsoft.CodeSigning/codeSigningAccounts/certificateProfiles", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount/certificateProfiles/profileA", + "properties": { + "certificates": [], + "identityValidationId": "00000000-1234-5678-3333-444444444444", + "includeCity": false, + "includeCountry": false, + "includePostalCode": true, + "includeState": false, + "includeStreetAddress": false, + "profileType": "PublicTrust", + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "CertificateProfiles_Create", + "title": "Create a certificate profile." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Delete.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Delete.json new file mode 100644 index 000000000000..e0a743a2cc25 --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "profileName": "profileA", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "CertificateProfiles_Delete", + "title": "Delete a certificate profile." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Get.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Get.json new file mode 100644 index 000000000000..be65a4ceddde --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "profileName": "profileA", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "profileA", + "type": "Microsoft.CodeSigning/codeSigningAccounts/certificateProfiles", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount/certificateProfiles/profileA", + "properties": { + "certificates": [ + { + "createdDate": "3/14/2023 5:27:49 PM", + "expiryDate": "3/17/2023 5:27:49 PM", + "enhancedKeyUsage": "1.3.6.1.4.1.311.yy.xxxxxxxx.xxxxxxxx.xxxxxxxxx.xxxxxxxx", + "serialNumber": "xxxxxxxxxxxxxxxxxx", + "status": "Active", + "subjectName": "CN=Contoso Inc, O=Contoso Inc, L=New York, S=New York, C=US", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" + } + ], + "identityValidationId": "123456", + "includeCity": false, + "includeCountry": false, + "includePostalCode": true, + "includeState": false, + "includeStreetAddress": false, + "profileType": "PublicTrust", + "provisioningState": "Succeeded", + "status": "Active" + } + } + } + }, + "operationId": "CertificateProfiles_Get", + "title": "Get details of a certificate profile." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_ListByCodeSigningAccount.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_ListByCodeSigningAccount.json new file mode 100644 index 000000000000..ba0db472226c --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_ListByCodeSigningAccount.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "profileA", + "type": "Microsoft.CodeSigning/codeSigningAccounts/certificateProfiles", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/profileA", + "properties": { + "certificates": [ + { + "createdDate": "3/14/2023 5:27:49 PM", + "expiryDate": "3/17/2023 5:27:49 PM", + "enhancedKeyUsage": "1.3.6.1.4.1.311.yy.xxxxxxxx.xxxxxxxx.xxxxxxxxx.xxxxxxxx", + "serialNumber": "xxxxxxxxxxxxxxxxxx", + "status": "Active", + "subjectName": "CN=Contoso Inc, O=Contoso Inc, L=New York, S=New York, C=US", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" + } + ], + "identityValidationId": "123456", + "includeCity": false, + "includeCountry": false, + "includePostalCode": true, + "includeState": false, + "includeStreetAddress": false, + "profileType": "PublicTrust", + "provisioningState": "Succeeded", + "status": "Active" + } + } + ] + } + } + }, + "operationId": "CertificateProfiles_ListByCodeSigningAccount", + "title": "List certificate profiles under a trusted signing account." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_RevokeCertificate.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_RevokeCertificate.json new file mode 100644 index 000000000000..17e9e7baa606 --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_RevokeCertificate.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "profileName": "profileA", + "resourceGroupName": "MyResourceGroup", + "body": { + "effectiveAt": "2023-11-12T23:40:25+00:00", + "reason": "KeyCompromised", + "remarks": "test", + "serialNumber": "xxxxxxxxxxxxxxxxxx", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" + }, + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "204": {} + }, + "operationId": "CertificateProfiles_RevokeCertificate", + "title": "Revoke a certificate under a certificate profile." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_CheckNameAvailability.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_CheckNameAvailability.json new file mode 100644 index 000000000000..ae1cfb811407 --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_CheckNameAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "body": { + "name": "sample-account" + }, + "api-version": "2024-09-30-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + }, + "operationId": "CodeSigningAccounts_CheckNameAvailability", + "title": "Checks that the trusted signing account name is available." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Create.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Create.json new file mode 100644 index 000000000000..214d8e3aa374 --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Create.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resource": { + "location": "westus", + "properties": { + "sku": { + "name": "Basic" + } + } + }, + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "MyAccount", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + } + } + }, + "201": { + "body": { + "name": "MyAccount", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Accepted", + "sku": { + "name": "Basic" + } + } + } + } + }, + "operationId": "CodeSigningAccounts_Create", + "title": "Create a trusted Signing Account." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Delete.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Delete.json new file mode 100644 index 000000000000..062f0fda1600 --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Delete.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status", + "location": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status", + "location": "http://azure.async.operation/status" + } + } + }, + "operationId": "CodeSigningAccounts_Delete", + "title": "Delete a trusted signing account." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Get.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Get.json new file mode 100644 index 000000000000..f5d4e090907c --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "MyAccount", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + }, + "tags": { + "key1": "value1" + } + } + } + }, + "operationId": "CodeSigningAccounts_Get", + "title": "Get a Trusted Signing Account" +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_ListByResourceGroup.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_ListByResourceGroup.json new file mode 100644 index 000000000000..50fd72f56334 --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_ListByResourceGroup.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-09-30-preview", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "alpha", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westcentralus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + }, + "tags": { + "key1": "value1" + } + } + ] + } + } + }, + "operationId": "CodeSigningAccounts_ListByResourceGroup", + "title": "Lists trusted signing accounts within a resource group." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_ListBySubscription.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_ListBySubscription.json new file mode 100644 index 000000000000..5c14b6bc07bd --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_ListBySubscription.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-30-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "alpha", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + }, + "tags": { + "key1": "value1" + } + } + ] + } + } + }, + "operationId": "CodeSigningAccounts_ListBySubscription", + "title": "Lists trusted signing accounts within a subscription." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Update.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Update.json new file mode 100644 index 000000000000..1ed4f660a665 --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Update.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "properties": { + "tags": { + "key1": "value1" + } + }, + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "MyAccount", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + }, + "tags": { + "key1": "value1" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status", + "location": "http://azure.async.operation/status" + } + } + }, + "operationId": "CodeSigningAccounts_Update", + "title": "Update a trusted signing account." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/Operations_List.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/Operations_List.json new file mode 100644 index 000000000000..e5f631eac339 --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/Operations_List.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "MyResourceGroup", + "api-version": "2024-09-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.CodeSigning/codeSigningAccounts/write", + "display": { + "provider": "Microsoft.CodeSigning", + "resource": "codeSigningAccounts", + "operation": "Create CodeSigningAccount", + "description": "Create any CodeSigningAccount" + } + }, + { + "name": "Microsoft.CodeSigning/codeSigningAccounts/read", + "display": { + "provider": "Microsoft.CodeSigning", + "resource": "codeSigningAccounts", + "operation": "Get CodeSigningAccount", + "description": "Get any CodeSigningAccount" + } + }, + { + "name": "Microsoft.CodeSigning/codeSigningAccounts/delete", + "display": { + "provider": "Microsoft.CodeSigning", + "resource": "codeSigningAccounts", + "operation": "Delete CodeSigningAccount", + "description": "Delete any CodeSigningAccount" + } + } + ] + } + } + }, + "operationId": "Operations_List", + "title": "List trusted signing account operations." +} diff --git a/specification/codesigning/resource-manager/readme.md b/specification/codesigning/resource-manager/readme.md index e546f51a3f5d..cf10e999a1d8 100644 --- a/specification/codesigning/resource-manager/readme.md +++ b/specification/codesigning/resource-manager/readme.md @@ -26,7 +26,16 @@ These are the global settings for the CodeSigning API. ```yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2024-02-05-preview +tag: package-2024-09-30-preview +``` + +### Tag: package-2024-09-30-preview + +These settings apply only when `--tag=package-2024-09-30-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-09-30-preview' +input-file: +- Microsoft.CodeSigning/preview/2024-09-30-preview/codeSigningAccount.json ``` ### Tag: package-2024-02-05-preview diff --git a/specification/codesigning/resource-manager/readme.python.md b/specification/codesigning/resource-manager/readme.python.md index f095e0bf7e39..7a142f8ff5c7 100644 --- a/specification/codesigning/resource-manager/readme.python.md +++ b/specification/codesigning/resource-manager/readme.python.md @@ -8,7 +8,7 @@ azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-trustedsigning namespace: azure.mgmt.trustedsigning -package-version: 1.0.0b1 +package-version: 1.0.0b2 clear-output-folder: true ``` From 19600b1734bac8ea70b36f2521fab9a05005c188 Mon Sep 17 00:00:00 2001 From: James Lim <125409279+MicroJamesLim@users.noreply.github.com> Date: Mon, 30 Sep 2024 12:54:21 -0400 Subject: [PATCH 16/47] Added Azure Container Instance API Version 2024-10-01-preview (#30569) * Copy files from stable/2023-05-01 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-10-01-preview Updated the API version from stable/2023-05-01 to preview/2024-10-01-preview. * Added tag for 2024-10-01-preview in readme file * added 2024-10-01-preview * remove additionalProperties * Copy files from stable/2023-05-01 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-10-01-preview Updated the API version from stable/2023-05-01 to preview/2024-10-01-preview. * Added tag for 2024-10-01-preview in readme file * added 2024-10-01-preview * remove additionalProperties * resolved PR comment * update from secrets to secretReferences * suppress additionalProperties * delete file * update to 'arm-id' format --------- Co-authored-by: jameszlim <limcheolhyun930421@gmail.com> --- .../2024-10-01-preview/containerInstance.json | 2610 +++++++++++++++++ .../examples/CachedImagesList.json | 27 + .../examples/CapabilitiesList.json | 39 + .../examples/ContainerAttach.json | 17 + .../examples/ContainerExec.json | 24 + .../ContainerGroupCreateConfidential.json | 182 ++ .../ContainerGroupEncryptionProperties.json | 192 ++ .../examples/ContainerGroupExtensions.json | 208 ++ .../examples/ContainerGroupUsage.json | 24 + .../ContainerGroupsCreateOrUpdate.json | 316 ++ ...erGroupsCreateOrUpdateSecretReference.json | 445 +++ .../ContainerGroupsCreatePriority.json | 120 + .../examples/ContainerGroupsDelete.json | 85 + .../examples/ContainerGroupsGetPriority.json | 87 + .../examples/ContainerGroupsGet_Failed.json | 115 + .../ContainerGroupsGet_Succeeded.json | 79 + .../examples/ContainerGroupsList.json | 90 + .../ContainerGroupsListByResourceGroup.json | 82 + .../examples/ContainerGroupsRestart.json | 11 + .../examples/ContainerGroupsStart.json | 16 + .../examples/ContainerGroupsStop.json | 11 + .../examples/ContainerGroupsUpdate.json | 100 + .../examples/ContainerListLogs.json | 17 + .../examples/OperationsList.json | 23 + .../SubnetServiceAssociationLinkDelete.json | 18 + .../resource-manager/readme.md | 17 +- 26 files changed, 4954 insertions(+), 1 deletion(-) create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/containerInstance.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/CachedImagesList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/CapabilitiesList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerAttach.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerExec.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupCreateConfidential.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupEncryptionProperties.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupExtensions.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupUsage.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreateOrUpdate.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreateOrUpdateSecretReference.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreatePriority.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsDelete.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGetPriority.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGet_Failed.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGet_Succeeded.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsListByResourceGroup.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsRestart.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsStart.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsStop.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsUpdate.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerListLogs.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/OperationsList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/SubnetServiceAssociationLinkDelete.json diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/containerInstance.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/containerInstance.json new file mode 100644 index 000000000000..d6d69d152438 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/containerInstance.json @@ -0,0 +1,2610 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-10-01-preview", + "title": "ContainerInstanceManagementClient" + }, + "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.ContainerInstance/containerGroups": { + "get": { + "operationId": "ContainerGroups_List", + "x-ms-examples": { + "ContainerGroupsList": { + "$ref": "./examples/ContainerGroupsList.json" + } + }, + "summary": "Get a list of container groups in the specified subscription.", + "description": "Get a list of container groups in the specified subscription. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups": { + "get": { + "operationId": "ContainerGroups_ListByResourceGroup", + "x-ms-examples": { + "ContainerGroupsListByResourceGroup": { + "$ref": "./examples/ContainerGroupsListByResourceGroup.json" + } + }, + "summary": "Get a list of container groups in the specified subscription and resource group.", + "description": "Get a list of container groups in a specified subscription and resource group. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}": { + "get": { + "operationId": "ContainerGroups_Get", + "x-ms-examples": { + "ContainerGroupsGet_Succeeded": { + "$ref": "./examples/ContainerGroupsGet_Succeeded.json" + }, + "ContainerGroupsGet_Failed": { + "$ref": "./examples/ContainerGroupsGet_Failed.json" + }, + "ContainerGroupsGetWithPriority": { + "$ref": "./examples/ContainerGroupsGetPriority.json" + } + }, + "summary": "Get the properties of the specified container group.", + "description": "Gets the properties of the specified container group in the specified subscription and resource group. The operation returns the properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "ContainerGroups_CreateOrUpdate", + "x-ms-examples": { + "ContainerGroupsCreateOrUpdate": { + "$ref": "./examples/ContainerGroupsCreateOrUpdate.json" + }, + "ContainerGroupsCreateOrUpdateSecretReference": { + "$ref": "./examples/ContainerGroupsCreateOrUpdateSecretReference.json" + }, + "ContainerGroupCreateWithExtensions": { + "$ref": "./examples/ContainerGroupExtensions.json" + }, + "ContainerGroupWithEncryptionProperties": { + "$ref": "./examples/ContainerGroupEncryptionProperties.json" + }, + "ConfidentialContainerGroup": { + "$ref": "./examples/ContainerGroupCreateConfidential.json" + }, + "ContainerGroupsCreateWithPriority": { + "$ref": "./examples/ContainerGroupsCreatePriority.json" + } + }, + "summary": "Create or update container groups.", + "description": "Create or update container groups with specified configurations.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerGroup", + "description": "The properties of the container group to be created or updated.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "201": { + "description": "Created - the container group is created.", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "ContainerGroups_Update", + "x-ms-examples": { + "ContainerGroupsUpdate": { + "$ref": "./examples/ContainerGroupsUpdate.json" + } + }, + "summary": "Update container groups.", + "description": "Updates container group tags with specified values.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "Resource", + "description": "The container group resource with just the tags to be updated.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/Resource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "ContainerGroups_Delete", + "x-ms-examples": { + "ContainerGroupsDelete": { + "$ref": "./examples/ContainerGroupsDelete.json" + } + }, + "summary": "Delete the specified container group.", + "description": "Delete the specified container group in the specified subscription and resource group. The operation does not delete other resources provided by the user, such as volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "202": { + "description": "Delete started." + }, + "204": { + "description": "No Content - the specified container group was not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/restart": { + "post": { + "operationId": "ContainerGroups_Restart", + "x-ms-examples": { + "ContainerRestart": { + "$ref": "./examples/ContainerGroupsRestart.json" + } + }, + "summary": "Restarts all containers in a container group.", + "description": "Restarts all containers in a container group in place. If container image has updates, new image will be downloaded.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/stop": { + "post": { + "operationId": "ContainerGroups_Stop", + "x-ms-examples": { + "ContainerStop": { + "$ref": "./examples/ContainerGroupsStop.json" + } + }, + "summary": "Stops all containers in a container group.", + "description": "Stops all containers in a container group. Compute resources will be deallocated and billing will stop.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/start": { + "post": { + "operationId": "ContainerGroups_Start", + "x-ms-examples": { + "ContainerStart": { + "$ref": "./examples/ContainerGroupsStart.json" + } + }, + "summary": "Starts all containers in a container group.", + "description": "Starts all containers in a container group. Compute resources will be allocated and billing will start.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "202": { + "description": "Started - the container group is starting." + }, + "204": { + "description": "Started - the container group is already running or starting." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.ContainerInstance/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/OperationsList.json" + } + }, + "description": "List the operations for Azure Container Instance service.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/usages": { + "get": { + "operationId": "Location_ListUsage", + "x-ms-examples": { + "ContainerUsage": { + "$ref": "./examples/ContainerGroupUsage.json" + } + }, + "description": "Get the usage for a subscription", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UsageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/logs": { + "get": { + "operationId": "Containers_ListLogs", + "x-ms-examples": { + "ContainerListLogs": { + "$ref": "./examples/ContainerListLogs.json" + } + }, + "summary": "Get the logs for a specified container instance.", + "description": "Get the logs for a specified container instance in a specified resource group and container group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerName", + "in": "path", + "description": "The name of the container instance.", + "required": true, + "type": "string" + }, + { + "name": "tail", + "in": "query", + "description": "The number of lines to show from the tail of the container instance log. If not provided, all available logs are shown up to 4mb.", + "type": "integer", + "format": "int32" + }, + { + "name": "timestamps", + "in": "query", + "description": "If true, adds a timestamp at the beginning of every line of log output. If not provided, defaults to false.", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Logs" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/exec": { + "post": { + "operationId": "Containers_ExecuteCommand", + "x-ms-examples": { + "ContainerExec": { + "$ref": "./examples/ContainerExec.json" + } + }, + "summary": "Executes a command in a specific container instance.", + "description": "Executes a command for a specific container instance in a specified resource group and container group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerName", + "in": "path", + "description": "The name of the container instance.", + "required": true, + "type": "string" + }, + { + "name": "containerExecRequest", + "in": "body", + "description": "The request for the exec command.", + "required": true, + "schema": { + "$ref": "#/definitions/ContainerExecRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerExecResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/attach": { + "post": { + "operationId": "Containers_Attach", + "x-ms-examples": { + "ContainerAttach": { + "$ref": "./examples/ContainerAttach.json" + } + }, + "summary": "Attach to the output of a specific container instance.", + "description": "Attach to the output stream of a specific container instance in a specified resource group and container group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerName", + "in": "path", + "description": "The name of the container instance.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerAttachResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/cachedImages": { + "get": { + "operationId": "Location_ListCachedImages", + "x-ms-examples": { + "CachedImages": { + "$ref": "./examples/CachedImagesList.json" + } + }, + "summary": "Get the list of cached images.", + "description": "Get the list of cached images on specific OS type for a subscription in a region.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CachedImagesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/capabilities": { + "get": { + "operationId": "Location_ListCapabilities", + "x-ms-examples": { + "GetCapabilities": { + "$ref": "./examples/CapabilitiesList.json" + } + }, + "summary": "Get the list of capabilities of the location.", + "description": "Get the list of CPU/memory/GPU capabilities of a region.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapabilitiesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/outboundNetworkDependenciesEndpoints": { + "get": { + "operationId": "ContainerGroups_GetOutboundNetworkDependenciesEndpoints", + "x-ms-examples": {}, + "summary": "Get all network dependencies for container group.", + "description": "Gets all the network dependencies for this container group to allow complete control of network setting and configuration. For container groups, this will always be an empty list.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkDependenciesResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/providers/Microsoft.ContainerInstance/serviceAssociationLinks/default": { + "delete": { + "operationId": "SubnetServiceAssociationLink_Delete", + "x-ms-examples": { + "SubnetServiceAssociationLinkDelete": { + "$ref": "./examples/SubnetServiceAssociationLinkDelete.json" + } + }, + "summary": "Delete container group virtual network association links.", + "description": "Delete container group virtual network association links. The operation does not delete other resources provided by the user.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkNameParameter" + }, + { + "$ref": "#/parameters/SubnetNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Delete started." + }, + "204": { + "description": "No Content - the specified container group was not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "SecretReference": { + "description": "A secret reference", + "type": "object", + "required": [ + "name", + "identity", + "secretReferenceUri" + ], + "properties": { + "name": { + "description": "The identifier of the secret reference", + "type": "string" + }, + "identity": { + "description": "The ARM resource id of the managed identity that has access to the secret in the key vault", + "type": "string", + "format": "arm-id" + }, + "secretReferenceUri": { + "description": "The URI to the secret in key vault", + "type": "string", + "format": "uri" + } + } + }, + "Container": { + "description": "A container instance.", + "type": "object", + "required": [ + "properties", + "name" + ], + "properties": { + "name": { + "description": "The user-provided name of the container instance.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of the container instance.", + "$ref": "#/definitions/ContainerProperties" + } + } + }, + "ContainerProperties": { + "description": "The container instance properties.", + "type": "object", + "required": [ + "image", + "resources" + ], + "properties": { + "image": { + "description": "The name of the image used to create the container instance.", + "type": "string" + }, + "command": { + "description": "The commands to execute within the container instance in exec form.", + "type": "array", + "items": { + "type": "string" + } + }, + "ports": { + "description": "The exposed ports on the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerPort" + }, + "x-ms-identifiers": [ + "port" + ] + }, + "environmentVariables": { + "description": "The environment variables to set in the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "instanceView": { + "description": "The instance view of the container instance. Only valid in response.", + "readOnly": true, + "type": "object", + "properties": { + "restartCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of times that the container instance has been restarted." + }, + "currentState": { + "readOnly": true, + "description": "Current container instance state.", + "$ref": "#/definitions/ContainerState" + }, + "previousState": { + "readOnly": true, + "description": "Previous container instance state.", + "$ref": "#/definitions/ContainerState" + }, + "events": { + "readOnly": true, + "description": "The events of the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/Event" + }, + "x-ms-identifiers": [ + "name", + "type" + ] + } + } + }, + "resources": { + "description": "The resource requirements of the container instance.", + "$ref": "#/definitions/ResourceRequirements" + }, + "volumeMounts": { + "description": "The volume mounts available to the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/VolumeMount" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "livenessProbe": { + "description": "The liveness probe.", + "$ref": "#/definitions/ContainerProbe" + }, + "readinessProbe": { + "description": "The readiness probe.", + "$ref": "#/definitions/ContainerProbe" + }, + "securityContext": { + "description": "The container security properties.", + "$ref": "#/definitions/SecurityContextDefinition" + } + } + }, + "SecurityContextDefinition": { + "description": "The security context for the container.", + "type": "object", + "properties": { + "privileged": { + "type": "boolean", + "description": "The flag to determine if the container permissions is elevated to Privileged." + }, + "allowPrivilegeEscalation": { + "type": "boolean", + "description": "A boolean value indicating whether the init process can elevate its privileges" + }, + "capabilities": { + "description": "The capabilities to add or drop from a container.", + "$ref": "#/definitions/SecurityContextCapabilitiesDefinition" + }, + "runAsGroup": { + "type": "integer", + "format": "int32", + "description": "Sets the User GID for the container." + }, + "runAsUser": { + "type": "integer", + "format": "int32", + "description": "Sets the User UID for the container." + }, + "seccompProfile": { + "type": "string", + "description": "a base64 encoded string containing the contents of the JSON in the seccomp profile" + } + } + }, + "SecurityContextCapabilitiesDefinition": { + "description": "The capabilities to add or drop from a container.", + "type": "object", + "properties": { + "add": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The capabilities to add to the container." + }, + "drop": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The capabilities to drop from the container." + } + } + }, + "ContainerState": { + "description": "The container instance state.", + "type": "object", + "readOnly": true, + "properties": { + "state": { + "type": "string", + "readOnly": true, + "description": "The state of the container instance." + }, + "startTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date-time when the container instance state started." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The container instance exit codes correspond to those from the `docker run` command." + }, + "finishTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date-time when the container instance state finished." + }, + "detailStatus": { + "type": "string", + "readOnly": true, + "description": "The human-readable status of the container instance state." + } + } + }, + "Event": { + "description": "A container group or container instance event.", + "type": "object", + "readOnly": true, + "properties": { + "count": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The count of the event." + }, + "firstTimestamp": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date-time of the earliest logged event." + }, + "lastTimestamp": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date-time of the latest logged event." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The event name." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The event message." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The event type." + } + } + }, + "ResourceRequirements": { + "description": "The resource requirements.", + "type": "object", + "required": [ + "requests" + ], + "properties": { + "requests": { + "description": "The resource requests of this container instance.", + "$ref": "#/definitions/ResourceRequests" + }, + "limits": { + "description": "The resource limits of this container instance.", + "$ref": "#/definitions/ResourceLimits" + } + } + }, + "ResourceRequests": { + "description": "The resource requests.", + "type": "object", + "required": [ + "memoryInGB", + "cpu" + ], + "properties": { + "memoryInGB": { + "description": "The memory request in GB of this container instance.", + "type": "number", + "format": "double" + }, + "cpu": { + "description": "The CPU request of this container instance.", + "type": "number", + "format": "double" + }, + "gpu": { + "description": "The GPU request of this container instance.", + "$ref": "#/definitions/GpuResource" + } + } + }, + "ResourceLimits": { + "description": "The resource limits.", + "type": "object", + "properties": { + "memoryInGB": { + "description": "The memory limit in GB of this container instance.", + "type": "number", + "format": "double" + }, + "cpu": { + "description": "The CPU limit of this container instance.", + "type": "number", + "format": "double" + }, + "gpu": { + "description": "The GPU limit of this container instance.", + "$ref": "#/definitions/GpuResource" + } + } + }, + "GpuResource": { + "description": "The GPU resource.", + "type": "object", + "required": [ + "count", + "sku" + ], + "properties": { + "count": { + "description": "The count of the GPU resource.", + "type": "integer", + "format": "int32" + }, + "sku": { + "type": "string", + "description": "The SKU of the GPU resource.", + "enum": [ + "K80", + "P100", + "V100" + ], + "x-ms-enum": { + "name": "GpuSku", + "modelAsString": true + } + } + } + }, + "AzureFileVolume": { + "description": "The properties of the Azure File volume. Azure File shares are mounted as volumes.", + "type": "object", + "required": [ + "shareName", + "storageAccountName" + ], + "properties": { + "shareName": { + "description": "The name of the Azure File share to be mounted as a volume.", + "type": "string" + }, + "readOnly": { + "description": "The flag indicating whether the Azure File shared mounted as a volume is read-only.", + "type": "boolean" + }, + "storageAccountName": { + "description": "The name of the storage account that contains the Azure File share.", + "type": "string" + }, + "storageAccountKey": { + "description": "The storage account access key used to access the Azure File share.", + "type": "string" + }, + "storageAccountKeyReference": { + "description": "The reference to the storage account access key used to access the Azure File share.", + "type": "string" + } + } + }, + "EmptyDirVolume": { + "description": "The empty directory volume.", + "type": "object", + "properties": {} + }, + "SecretVolume": { + "description": "The secret volume.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "SecretReferenceVolume": { + "description": "The secret reference volume.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "GitRepoVolume": { + "description": "Represents a volume that is populated with the contents of a git repository", + "required": [ + "repository" + ], + "properties": { + "directory": { + "description": "Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.", + "type": "string" + }, + "repository": { + "description": "Repository URL", + "type": "string" + }, + "revision": { + "description": "Commit hash for the specified revision.", + "type": "string" + } + } + }, + "Volume": { + "description": "The properties of the volume.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "The name of the volume.", + "type": "string" + }, + "azureFile": { + "description": "The Azure File volume.", + "$ref": "#/definitions/AzureFileVolume" + }, + "emptyDir": { + "description": "The empty directory volume.", + "$ref": "#/definitions/EmptyDirVolume" + }, + "secret": { + "description": "The secret volume.", + "$ref": "#/definitions/SecretVolume" + }, + "secretReference": { + "description": "The secret reference volume.", + "$ref": "#/definitions/SecretReferenceVolume" + }, + "gitRepo": { + "description": "The git repo volume.", + "$ref": "#/definitions/GitRepoVolume" + } + } + }, + "VolumeMount": { + "description": "The properties of the volume mount.", + "type": "object", + "required": [ + "name", + "mountPath" + ], + "properties": { + "name": { + "description": "The name of the volume mount.", + "type": "string" + }, + "mountPath": { + "description": "The path within the container where the volume should be mounted. Must not contain colon (:).", + "type": "string" + }, + "readOnly": { + "description": "The flag indicating whether the volume mount is read-only.", + "type": "boolean" + } + } + }, + "ContainerExec": { + "type": "object", + "description": "The container execution command, for liveness or readiness probe", + "properties": { + "command": { + "description": "The commands to execute within the container.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ContainerHttpGet": { + "type": "object", + "description": "The container Http Get settings, for liveness or readiness probe", + "properties": { + "path": { + "description": "The path to probe.", + "type": "string" + }, + "port": { + "type": "integer", + "description": "The port number to probe.", + "format": "int32" + }, + "scheme": { + "description": "The scheme.", + "type": "string", + "enum": [ + "http", + "https" + ], + "x-ms-enum": { + "name": "Scheme", + "modelAsString": true + } + }, + "httpHeaders": { + "description": "The HTTP headers.", + "type": "array", + "items": { + "$ref": "#/definitions/HttpHeader" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "required": [ + "port" + ] + }, + "ContainerProbe": { + "type": "object", + "description": "The container probe, for liveness or readiness", + "properties": { + "exec": { + "description": "The execution command to probe", + "$ref": "#/definitions/ContainerExec" + }, + "httpGet": { + "description": "The Http Get settings to probe", + "$ref": "#/definitions/ContainerHttpGet" + }, + "initialDelaySeconds": { + "description": "The initial delay seconds.", + "type": "integer", + "format": "int32" + }, + "periodSeconds": { + "description": "The period seconds.", + "type": "integer", + "format": "int32" + }, + "failureThreshold": { + "description": "The failure threshold.", + "type": "integer", + "format": "int32" + }, + "successThreshold": { + "description": "The success threshold.", + "type": "integer", + "format": "int32" + }, + "timeoutSeconds": { + "description": "The timeout seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "ContainerGroup": { + "description": "A container group.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "$ref": "#/definitions/ContainerGroupProperties" + } + ] + }, + "ContainerGroupProperties": { + "description": "The container group properties", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "identity": { + "$ref": "#/definitions/ContainerGroupIdentity", + "description": "The identity of the container group, if configured." + }, + "properties": { + "x-ms-client-flatten": true, + "type": "object", + "description": "The container group properties", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the container group. This only appears in the response." + }, + "secretReferences": { + "type": "array", + "description": "The secret references that will be referenced within the container group.", + "items": { + "$ref": "#/definitions/SecretReference" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "containers": { + "type": "array", + "description": "The containers within the container group.", + "items": { + "$ref": "#/definitions/Container" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "imageRegistryCredentials": { + "type": "array", + "description": "The image registry credentials by which the container group is created from.", + "items": { + "$ref": "#/definitions/ImageRegistryCredential" + }, + "x-ms-identifiers": [ + "username" + ] + }, + "restartPolicy": { + "type": "string", + "description": "Restart policy for all containers within the container group. \n- `Always` Always restart\n- `OnFailure` Restart on failure\n- `Never` Never restart\n", + "enum": [ + "Always", + "OnFailure", + "Never" + ], + "x-ms-enum": { + "name": "ContainerGroupRestartPolicy", + "modelAsString": true + } + }, + "ipAddress": { + "description": "The IP address type of the container group.", + "$ref": "#/definitions/IpAddress" + }, + "osType": { + "type": "string", + "description": "The operating system type required by the containers in the container group.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": true + } + }, + "volumes": { + "type": "array", + "description": "The list of volumes that can be mounted by containers in this container group.", + "items": { + "$ref": "#/definitions/Volume" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "instanceView": { + "description": "The instance view of the container group. Only valid in response.", + "readOnly": true, + "type": "object", + "properties": { + "events": { + "description": "The events of this container group.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Event" + }, + "x-ms-identifiers": [ + "name", + "type" + ] + }, + "state": { + "readOnly": true, + "type": "string", + "description": "The state of the container group. Only valid in response." + } + } + }, + "diagnostics": { + "description": "The diagnostic information for a container group.", + "$ref": "#/definitions/ContainerGroupDiagnostics" + }, + "subnetIds": { + "type": "array", + "description": "The subnet resource IDs for a container group.", + "items": { + "$ref": "#/definitions/ContainerGroupSubnetId" + } + }, + "dnsConfig": { + "description": "The DNS config information for a container group.", + "$ref": "#/definitions/DnsConfiguration" + }, + "sku": { + "description": "The SKU for a container group.", + "$ref": "#/definitions/ContainerGroupSku" + }, + "encryptionProperties": { + "description": "The encryption properties for a container group.", + "$ref": "#/definitions/EncryptionProperties" + }, + "initContainers": { + "type": "array", + "description": "The init containers for a container group.", + "items": { + "$ref": "#/definitions/InitContainerDefinition" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "extensions": { + "type": "array", + "description": "extensions used by virtual kubelet", + "items": { + "$ref": "#/definitions/DeploymentExtensionSpec" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "confidentialComputeProperties": { + "description": "The properties for confidential container group", + "$ref": "#/definitions/ConfidentialComputeProperties" + }, + "priority": { + "type": "string", + "description": "The priority of the container group.", + "enum": [ + "Regular", + "Spot" + ], + "x-ms-enum": { + "name": "ContainerGroupPriority", + "modelAsString": true + } + } + }, + "required": [ + "containers", + "osType" + ] + } + } + }, + "DeploymentExtensionSpec": { + "description": "Extension sidecars to be added to the deployment.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the extension." + }, + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "description": "Extension specific properties", + "properties": { + "extensionType": { + "type": "string", + "description": "Type of extension to be added." + }, + "version": { + "type": "string", + "description": "Version of the extension being used." + }, + "settings": { + "type": "object", + "description": "Settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "Protected settings for the extension." + } + }, + "required": [ + "extensionType", + "version" + ] + } + }, + "required": [ + "name" + ] + }, + "ContainerGroupIdentity": { + "description": "Identity for the container group.", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the container group identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the container group. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the container group. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the container group.", + "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 container group.", + "additionalProperties": { + "description": "The list of user identities associated with the container group. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "$ref": "#/definitions/UserAssignedIdentities" + } + } + } + }, + "UserAssignedIdentities": { + "type": "object", + "description": "The list of user identities associated with the container group. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "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." + } + } + }, + "ImageRegistryCredential": { + "description": "Image registry credential.", + "type": "object", + "properties": { + "server": { + "type": "string", + "description": "The Docker image registry server without a protocol such as \"http\" and \"https\"." + }, + "username": { + "type": "string", + "description": "The username for the private registry." + }, + "password": { + "type": "string", + "description": "The password for the private registry.", + "x-ms-secret": true + }, + "passwordReference": { + "type": "string", + "description": "The reference for the private registry password." + }, + "identity": { + "type": "string", + "description": "The identity for the private registry." + }, + "identityUrl": { + "type": "string", + "description": "The identity URL for the private registry." + } + }, + "required": [ + "server" + ] + }, + "ContainerGroupDiagnostics": { + "description": "Container group diagnostic information.", + "type": "object", + "properties": { + "logAnalytics": { + "description": "Container group log analytics information.", + "$ref": "#/definitions/LogAnalytics" + } + } + }, + "LogAnalytics": { + "description": "Container group log analytics information.", + "type": "object", + "properties": { + "workspaceId": { + "description": "The workspace id for log analytics", + "type": "string" + }, + "workspaceKey": { + "description": "The workspace key for log analytics", + "type": "string", + "x-ms-secret": true + }, + "logType": { + "type": "string", + "description": "The log type to be used.", + "enum": [ + "ContainerInsights", + "ContainerInstanceLogs" + ], + "x-ms-enum": { + "name": "LogAnalyticsLogType", + "modelAsString": true + } + }, + "metadata": { + "type": "object", + "description": "Metadata for log analytics.", + "additionalProperties": { + "type": "string" + } + }, + "workspaceResourceId": { + "description": "The workspace resource id for log analytics", + "type": "string", + "x-ms-secret": true + } + }, + "required": [ + "workspaceId", + "workspaceKey" + ] + }, + "ContainerGroupSubnetId": { + "description": "Container group subnet information.", + "type": "object", + "properties": { + "id": { + "description": "Resource ID of virtual network and subnet.", + "type": "string" + }, + "name": { + "description": "Friendly name for the subnet.", + "type": "string" + } + }, + "required": [ + "id" + ] + }, + "IpAddress": { + "description": "IP address for the container group.", + "type": "object", + "properties": { + "ports": { + "type": "array", + "description": "The list of ports exposed on the container group.", + "items": { + "$ref": "#/definitions/Port" + }, + "x-ms-identifiers": [ + "port" + ] + }, + "type": { + "type": "string", + "description": "Specifies if the IP is exposed to the public internet or private VNET.", + "enum": [ + "Public", + "Private" + ], + "x-ms-enum": { + "name": "ContainerGroupIpAddressType", + "modelAsString": true + } + }, + "ip": { + "type": "string", + "description": "The IP exposed to the public internet." + }, + "dnsNameLabel": { + "type": "string", + "description": "The Dns name label for the IP." + }, + "autoGeneratedDomainNameLabelScope": { + "type": "string", + "description": "The value representing the security enum. The 'Unsecure' value is the default value if not selected and means the object's domain name label is not secured against subdomain takeover. The 'TenantReuse' value is the default value if selected and means the object's domain name label can be reused within the same tenant. The 'SubscriptionReuse' value means the object's domain name label can be reused within the same subscription. The 'ResourceGroupReuse' value means the object's domain name label can be reused within the same resource group. The 'NoReuse' value means the object's domain name label cannot be reused within the same resource group, subscription, or tenant.", + "enum": [ + "Unsecure", + "TenantReuse", + "SubscriptionReuse", + "ResourceGroupReuse", + "Noreuse" + ], + "default": "Unsecure", + "x-ms-enum": { + "name": "dnsNameLabelReusePolicy", + "modelAsString": true + } + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "The FQDN for the IP." + } + }, + "required": [ + "ports", + "type" + ] + }, + "Port": { + "description": "The port exposed on the container group.", + "type": "object", + "properties": { + "protocol": { + "type": "string", + "description": "The protocol associated with the port.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "ContainerGroupNetworkProtocol", + "modelAsString": true + } + }, + "port": { + "type": "integer", + "description": "The port number.", + "format": "int32" + } + }, + "required": [ + "port" + ] + }, + "ContainerPort": { + "description": "The port exposed on the container instance.", + "type": "object", + "properties": { + "protocol": { + "type": "string", + "description": "The protocol associated with the port.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "ContainerNetworkProtocol", + "modelAsString": true + } + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port number exposed within the container group." + } + }, + "required": [ + "port" + ] + }, + "EnvironmentVariable": { + "description": "The environment variable to set within the container instance.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the environment variable." + }, + "value": { + "type": "string", + "description": "The value of the environment variable." + }, + "secureValue": { + "type": "string", + "description": "The value of the secure environment variable.", + "x-ms-secret": true + }, + "secureValueReference": { + "type": "string", + "description": "The reference of the secure environment variable." + } + }, + "required": [ + "name" + ] + }, + "OperationListResult": { + "description": "The operation list response that contains all operations for Azure Container Instance service.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of operations." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of operations." + } + } + }, + "Operation": { + "description": "An operation for Azure Container Instance service.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "display": { + "description": "The display information of the operation.", + "type": "object", + "properties": { + "provider": { + "description": "The name of the provider of the operation.", + "type": "string" + }, + "resource": { + "type": "string", + "description": "The name of the resource type of the operation." + }, + "operation": { + "description": "The friendly name of the operation.", + "type": "string" + }, + "description": { + "description": "The description of the operation.", + "type": "string" + } + } + }, + "properties": { + "type": "object", + "description": "The additional properties.", + "x-ms-client-flatten": true + }, + "origin": { + "type": "string", + "description": "The intended executor of the operation.", + "enum": [ + "User", + "System" + ], + "x-ms-enum": { + "name": "ContainerInstanceOperationsOrigin", + "modelAsString": true + } + } + }, + "required": [ + "name", + "display" + ] + }, + "UsageListResult": { + "description": "The response containing the usage data", + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "description": "The usage data.", + "items": { + "$ref": "#/definitions/Usage" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "Usage": { + "description": "A single usage result", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Id of the usage result" + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "Unit of the usage result" + }, + "currentValue": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The current usage of the resource" + }, + "limit": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The maximum permitted usage of the resource." + }, + "name": { + "readOnly": true, + "type": "object", + "description": "The name object of the resource", + "properties": { + "value": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "The localized name of the resource" + } + } + } + } + }, + "ContainerGroupListResult": { + "description": "The container group list response that contains the container group properties.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerGroup" + }, + "description": "The list of container groups." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of container groups." + } + } + }, + "Logs": { + "description": "The logs.", + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The content of the log." + } + } + }, + "ContainerExecRequest": { + "description": "The container exec request.", + "type": "object", + "properties": { + "command": { + "type": "string", + "description": "The command to be executed." + }, + "terminalSize": { + "type": "object", + "description": "The size of the terminal.", + "properties": { + "rows": { + "type": "integer", + "format": "int32", + "description": "The row size of the terminal" + }, + "cols": { + "type": "integer", + "format": "int32", + "description": "The column size of the terminal" + } + } + } + } + }, + "ContainerExecResponse": { + "description": "The information for the container exec command.", + "type": "object", + "properties": { + "webSocketUri": { + "type": "string", + "description": "The uri for the exec websocket." + }, + "password": { + "type": "string", + "description": "The password to start the exec command.", + "x-ms-secret": true + } + } + }, + "ContainerAttachResponse": { + "description": "The information for the output stream from container attach.", + "type": "object", + "properties": { + "webSocketUri": { + "type": "string", + "description": "The uri for the output stream from the attach." + }, + "password": { + "type": "string", + "description": "The password to the output stream from the attach. Send as an Authorization header value when connecting to the websocketUri.", + "x-ms-secret": true + } + } + }, + "HttpHeader": { + "description": "The HTTP header.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The header name." + }, + "value": { + "type": "string", + "description": "The header value." + } + } + }, + "DnsConfiguration": { + "description": "DNS configuration for the container group.", + "type": "object", + "required": [ + "nameServers" + ], + "properties": { + "nameServers": { + "description": "The DNS servers for the container group.", + "type": "array", + "items": { + "type": "string" + } + }, + "searchDomains": { + "description": "The DNS search domains for hostname lookup in the container group.", + "type": "string" + }, + "options": { + "description": "The DNS options for the container group.", + "type": "string" + } + } + }, + "Resource": { + "type": "object", + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource id." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "location": { + "type": "string", + "description": "The resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + }, + "zones": { + "description": "The zones for the container group.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-azure-resource": true + }, + "CachedImagesListResult": { + "description": "The response containing cached images.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/cachedImages" + }, + "x-ms-identifiers": [ + "image" + ], + "description": "The list of cached images." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of cached images." + } + } + }, + "cachedImages": { + "description": "The cached image and OS type.", + "type": "object", + "required": [ + "osType", + "image" + ], + "properties": { + "osType": { + "type": "string", + "description": "The OS type of the cached image." + }, + "image": { + "type": "string", + "description": "The cached image name." + } + } + }, + "CapabilitiesListResult": { + "description": "The response containing list of capabilities.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Capabilities" + }, + "x-ms-identifiers": [ + "resourceType", + "location" + ], + "description": "The list of capabilities." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of capabilities." + } + } + }, + "Capabilities": { + "description": "The regional capabilities.", + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "readOnly": true, + "description": "The resource type that this capability describes." + }, + "osType": { + "type": "string", + "readOnly": true, + "description": "The OS type that this capability describes." + }, + "location": { + "type": "string", + "readOnly": true, + "description": "The resource location." + }, + "ipAddressType": { + "type": "string", + "readOnly": true, + "description": "The ip address type that this capability describes." + }, + "gpu": { + "type": "string", + "readOnly": true, + "description": "The GPU sku that this capability describes." + }, + "capabilities": { + "type": "object", + "readOnly": true, + "description": "The supported capabilities.", + "properties": { + "maxMemoryInGB": { + "type": "number", + "readOnly": true, + "description": "The maximum allowed memory request in GB." + }, + "maxCpu": { + "type": "number", + "readOnly": true, + "description": "The maximum allowed CPU request in cores." + }, + "maxGpuCount": { + "type": "number", + "readOnly": true, + "description": "The maximum allowed GPU count." + } + } + } + } + }, + "ContainerGroupSku": { + "description": "The container group SKU.", + "type": "string", + "enum": [ + "Standard", + "Dedicated", + "Confidential" + ], + "x-ms-enum": { + "name": "ContainerGroupSku", + "modelAsString": true + } + }, + "EncryptionProperties": { + "description": "The container group encryption properties.", + "type": "object", + "properties": { + "vaultBaseUrl": { + "description": "The keyvault base url.", + "type": "string" + }, + "keyName": { + "description": "The encryption key name.", + "type": "string" + }, + "keyVersion": { + "description": "The encryption key version.", + "type": "string" + }, + "identity": { + "type": "string", + "description": "The keyvault managed identity." + } + }, + "required": [ + "vaultBaseUrl", + "keyName", + "keyVersion" + ] + }, + "InitContainerDefinition": { + "description": "The init container definition.", + "type": "object", + "properties": { + "name": { + "description": "The name for the init container.", + "type": "string" + }, + "properties": { + "description": "The properties for the init container.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/InitContainerPropertiesDefinition" + } + }, + "required": [ + "name", + "properties" + ] + }, + "InitContainerPropertiesDefinition": { + "description": "The init container definition properties.", + "type": "object", + "properties": { + "image": { + "description": "The image of the init container.", + "type": "string" + }, + "command": { + "description": "The command to execute within the init container in exec form.", + "type": "array", + "items": { + "type": "string" + } + }, + "environmentVariables": { + "description": "The environment variables to set in the init container.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "instanceView": { + "description": "The instance view of the init container. Only valid in response.", + "readOnly": true, + "type": "object", + "properties": { + "restartCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of times that the init container has been restarted." + }, + "currentState": { + "readOnly": true, + "description": "The current state of the init container.", + "$ref": "#/definitions/ContainerState" + }, + "previousState": { + "readOnly": true, + "description": "The previous state of the init container.", + "$ref": "#/definitions/ContainerState" + }, + "events": { + "readOnly": true, + "description": "The events of the init container.", + "type": "array", + "items": { + "$ref": "#/definitions/Event" + }, + "x-ms-identifiers": [ + "name", + "type" + ] + } + } + }, + "volumeMounts": { + "description": "The volume mounts available to the init container.", + "type": "array", + "items": { + "$ref": "#/definitions/VolumeMount" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "securityContext": { + "description": "The container security properties.", + "$ref": "#/definitions/SecurityContextDefinition" + } + } + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "description": "An error response from the Container Instance service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "x-ms-identifiers": [ + "message", + "target" + ], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Container Instance service." + }, + "NetworkDependenciesResponse": { + "description": "Response for network dependencies, always empty list.", + "type": "array", + "items": { + "type": "string" + } + }, + "ConfidentialComputeProperties": { + "description": "The properties for confidential container group", + "type": "object", + "properties": { + "ccePolicy": { + "type": "string", + "description": "The base64 encoded confidential compute enforcement policy" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "x-ms-parameter-location": "client" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The identifier for the physical azure location.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version", + "x-ms-parameter-location": "client" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ContainerGroupNameParameter": { + "name": "containerGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the container group.", + "x-ms-parameter-location": "method" + }, + "VirtualNetworkNameParameter": { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network.", + "x-ms-parameter-location": "method" + }, + "SubnetNameParameter": { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet.", + "x-ms-parameter-location": "method" + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The operation Id.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/CachedImagesList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/CachedImagesList.json new file mode 100644 index 000000000000..ed0d0d2363f5 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/CachedImagesList.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "westcentralus", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "osType": "Linux", + "image": "ubuntu:16.04" + }, + { + "osType": "Linux", + "image": "alpine:3.6" + }, + { + "osType": "Windows", + "image": "microsoft/nanoserver:10.0.14393.2485" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/CapabilitiesList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/CapabilitiesList.json new file mode 100644 index 000000000000..925e127e09db --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/CapabilitiesList.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "westus", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "containerGroups", + "osType": "Linux", + "location": "West US", + "ipAddressType": "Public", + "gpu": "K80", + "capabilities": { + "maxMemoryInGB": 14, + "maxCpu": 4, + "maxGpuCount": 4 + } + }, + { + "resourceType": "containerGroups", + "osType": "Windows", + "location": "West US", + "ipAddressType": "Public", + "gpu": "None", + "capabilities": { + "maxMemoryInGB": 14, + "maxCpu": 4, + "maxGpuCount": 0 + } + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerAttach.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerAttach.json new file mode 100644 index 000000000000..77bd776e187d --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerAttach.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerName": "container1" + }, + "responses": { + "200": { + "body": { + "webSocketUri": "wss://web-socket-uri", + "password": "password" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerExec.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerExec.json new file mode 100644 index 000000000000..06ec0926cfaf --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerExec.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerName": "container1", + "containerExecRequest": { + "command": "/bin/bash", + "terminalSize": { + "rows": 12, + "cols": 12 + } + } + }, + "responses": { + "200": { + "body": { + "webSocketUri": "wss://web-socket-uri", + "password": "password" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupCreateConfidential.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupCreateConfidential.json new file mode 100644 index 000000000000..c96ab2b7b19e --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupCreateConfidential.json @@ -0,0 +1,182 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "zones": [ + "1" + ], + "containerGroup": { + "location": "westeurope", + "properties": { + "containers": [ + { + "name": "accdemo", + "properties": { + "command": [], + "environmentVariables": [], + "image": "confiimage", + "ports": [ + { + "port": 8000 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "securityContext": { + "privileged": false, + "capabilities": { + "add": [ + "CAP_NET_ADMIN" + ] + } + } + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 8000 + } + ], + "type": "Public" + }, + "osType": "Linux", + "sku": "Confidential", + "confidentialComputeProperties": { + "ccePolicy": "eyJhbGxvd19hbGwiOiB0cnVlLCAiY29udGFpbmVycyI6IHsibGVuZ3RoIjogMCwgImVsZW1lbnRzIjogbnVsbH19" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Confidential", + "provisioningState": "Succeeded", + "containers": [ + { + "name": "accdemo", + "properties": { + "image": "confiimage", + "command": [], + "ports": [ + { + "port": 8000 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + }, + "securityContext": { + "privileged": false, + "capabilities": { + "add": [ + "CAP_NET_ADMIN" + ] + } + } + } + } + ], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 8000 + } + ], + "type": "Public" + }, + "initContainers": [], + "imageRegistryCredentials": [], + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Running" + }, + "confidentialComputeProperties": { + "ccePolicy": "eyJhbGxvd19hbGwiOiB0cnVlLCAiY29udGFpbmVycyI6IHsibGVuZ3RoIjogMCwgImVsZW1lbnRzIjogbnVsbH19" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "westeurope" + } + }, + "201": { + "body": { + "properties": { + "sku": "Confidential", + "provisioningState": "Succeeded", + "containers": [ + { + "name": "accdemo", + "properties": { + "image": "confiimage", + "command": [], + "ports": [ + { + "port": 8000 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + }, + "securityContext": { + "privileged": false, + "capabilities": { + "add": [ + "CAP_NET_ADMIN" + ] + } + } + } + } + ], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 8000 + } + ], + "type": "Public" + }, + "initContainers": [], + "imageRegistryCredentials": [], + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Running" + }, + "confidentialComputeProperties": { + "ccePolicy": "eyJhbGxvd19hbGwiOiB0cnVlLCAiY29udGFpbmVycyI6IHsibGVuZ3RoIjogMCwgImVsZW1lbnRzIjogbnVsbH19" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "westeurope" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupEncryptionProperties.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupEncryptionProperties.json new file mode 100644 index 000000000000..5fb43920d62a --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupEncryptionProperties.json @@ -0,0 +1,192 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "zones": [ + "1" + ], + "containerGroup": { + "location": "eastus2", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity": {} + } + }, + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + } + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public" + }, + "osType": "Linux", + "encryptionProperties": { + "vaultBaseUrl": "https://testkeyvault.vault.azure.net", + "keyName": "test-key", + "keyVersion": "<key version>", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Standard", + "encryptionProperties": { + "vaultBaseUrl": "https://testkeyvault.vault.azure.net/", + "keyName": "test-key", + "keyVersion": "<key version>", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity" + }, + "provisioningState": "Pending", + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public" + }, + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Pending" + } + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity": { + "principalId": "<principal id>", + "clientId": "<client id>" + } + }, + "tenantId": "<tenant id>", + "type": "UserAssigned" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus2" + } + }, + "201": { + "body": { + "properties": { + "sku": "Standard", + "encryptionProperties": { + "vaultBaseUrl": "https://testkeyvault.vault.azure.net/", + "keyName": "test-key", + "keyVersion": "key version", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity" + }, + "provisioningState": "Running", + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public" + }, + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Pending" + } + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity": { + "principalId": "<principal id>", + "clientId": "<client id>" + } + }, + "tenantId": "<tenant id>", + "type": "UserAssigned" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus2" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupExtensions.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupExtensions.json new file mode 100644 index 000000000000..4756b7442c1d --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupExtensions.json @@ -0,0 +1,208 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "zones": [ + "1" + ], + "containerGroup": { + "location": "eastus2", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + } + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Private" + }, + "osType": "Linux", + "subnetIds": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-rg-vnet/subnets/test-subnet" + } + ], + "extensions": [ + { + "name": "kube-proxy", + "properties": { + "extensionType": "kube-proxy", + "version": "1.0", + "settings": { + "clusterCidr": "10.240.0.0/16", + "kubeVersion": "v1.9.10" + }, + "protectedSettings": { + "kubeConfig": "<kubeconfig encoded string>" + } + } + }, + { + "name": "vk-realtime-metrics", + "properties": { + "extensionType": "realtime-metrics", + "version": "1.0" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Standard", + "provisioningState": "Pending", + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "extensions": [ + { + "name": "kube-proxy", + "properties": { + "extensionType": "kube-proxy", + "version": "1.0", + "settings": { + "clusterCidr": "10.240.0.0/16", + "kubeVersion": "v1.9.10" + } + } + }, + { + "name": "vk-realtime-metrics", + "properties": { + "extensionType": "realtime-metrics", + "version": "1.0" + } + } + ], + "imageRegistryCredentials": [], + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Pending" + }, + "subnetIds": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-rg-vnet/subnets/test-subnet" + } + ] + }, + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus2" + } + }, + "201": { + "body": { + "properties": { + "sku": "Standard", + "provisioningState": "Pending", + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "extensions": [ + { + "name": "kube-proxy", + "properties": { + "extensionType": "kube-proxy", + "version": "1.0", + "settings": { + "clusterCidr": "10.240.0.0/16", + "kubeVersion": "v1.9.10" + } + } + }, + { + "name": "vk-realtime-metrics", + "properties": { + "extensionType": "realtime-metrics", + "version": "1.0" + } + } + ], + "imageRegistryCredentials": [], + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Running" + }, + "subnetIds": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-rg-vnet/subnets/test-subnet" + } + ] + }, + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus2" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupUsage.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupUsage.json new file mode 100644 index 000000000000..ecb826c3e487 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupUsage.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "westcentralus", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 1, + "limit": 2000, + "name": { + "value": "ContainerGroups", + "localizedValue": "Container Groups" + } + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreateOrUpdate.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreateOrUpdate.json new file mode 100644 index 000000000000..9850e024b673 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreateOrUpdate.json @@ -0,0 +1,316 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "zones": [ + "1" + ], + "containerGroup": { + "location": "west us", + "identity": { + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name": {} + } + }, + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "diagnostics": { + "logAnalytics": { + "workspaceId": "workspaceid", + "workspaceKey": "workspaceKey", + "logType": "ContainerInsights", + "metadata": { + "test-key": "test-metadata-value" + }, + "workspaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/microsoft.operationalinsights/workspaces/workspace" + } + }, + "subnetIds": [ + { + "id": "[resourceId('Microsoft.Network/virtualNetworks/subnets', parameters('vnetName'), parameters('subnetName'))]" + } + ], + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ], + "searchDomains": "cluster.local svc.cluster.local", + "options": "ndots:2" + }, + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "autoGeneratedDomainNameLabelScope": "Unsecure" + }, + "osType": "Linux", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName", + "storageAccountKey": "accountKey" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": { + "secretKey1": "SecretValue1InBase64", + "secretKey2": "SecretValue2InBase64" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "diagnostics": { + "logAnalytics": { + "workspaceId": "workspaceid" + } + }, + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ], + "searchDomains": "cluster.local svc.cluster.local", + "options": "ndots:2" + }, + "imageRegistryCredentials": [], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "autoGeneratedDomainNameLabelScope": "Unsecure", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {} + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ] + }, + "imageRegistryCredentials": [], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "autoGeneratedDomainNameLabelScope": "Unsecure", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {} + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreateOrUpdateSecretReference.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreateOrUpdateSecretReference.json new file mode 100644 index 000000000000..c8d892255752 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreateOrUpdateSecretReference.json @@ -0,0 +1,445 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "zones": [ + "1" + ], + "containerGroup": { + "location": "west us", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name": {} + } + }, + "properties": { + "secretReferences": [ + { + "name": "envSecretRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/envSecret" + }, + { + "name": "accountKeyRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/accountKey" + }, + { + "name": "volumeSecretRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/volumeSecret" + }, + { + "name": "privateRegistryKeyRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/privateRegistryKey" + } + ], + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [ + { + "name": "envSecret", + "secureValueReference": "envSecretRef" + } + ], + "image": "privateRegistryImage", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "diagnostics": { + "logAnalytics": { + "workspaceId": "workspaceid", + "workspaceKey": "workspaceKey", + "logType": "ContainerInsights", + "metadata": { + "test-key": "test-metadata-value" + }, + "workspaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/microsoft.operationalinsights/workspaces/workspace" + } + }, + "subnetIds": [ + { + "id": "[resourceId('Microsoft.Network/virtualNetworks/subnets', parameters('vnetName'), parameters('subnetName'))]" + } + ], + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ], + "searchDomains": "cluster.local svc.cluster.local", + "options": "ndots:2" + }, + "imageRegistryCredentials": [ + { + "server": "demoregistry.azurecr.io", + "username": "registryUserName", + "passwordReference": "privateRegistryKeyRef" + } + ], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "autoGeneratedDomainNameLabelScope": "Unsecure" + }, + "osType": "Linux", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName", + "storageAccountKeyReference": "accountKeyRef" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": { + "secretKey1": "SecretValue1InBase64" + }, + "secretReference": { + "secretKey2": "volumeSecretRef" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "identity": { + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + } + }, + "tenantId": "00000000-0000-0000-0000-000000000000", + "type": "UserAssigned" + }, + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "secretReferences": [ + { + "name": "envSecretRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/envSecret" + }, + { + "name": "accountKeyRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/accountKey" + }, + { + "name": "volumeSecretRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/volumeSecret" + }, + { + "name": "privateRegistryKeyRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/privateRegistryKey" + } + ], + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [ + { + "name": "envSecret", + "secureValueReference": "envSecretRef" + } + ], + "image": "privateRegistryImage", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "diagnostics": { + "logAnalytics": { + "workspaceId": "workspaceid" + } + }, + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ], + "searchDomains": "cluster.local svc.cluster.local", + "options": "ndots:2" + }, + "imageRegistryCredentials": [ + { + "server": "demoregistry.azurecr.io", + "username": "registryUserName", + "passwordReference": "privateRegistryKeyRef" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "autoGeneratedDomainNameLabelScope": "Unsecure", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName", + "storageAccountKeyReference": "accountKeyRef" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {}, + "secretReference": { + "secretKey2": "volumeSecretRef" + } + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "identity": { + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + } + }, + "tenantId": "00000000-0000-0000-0000-000000000000", + "type": "UserAssigned" + }, + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "secretReferences": [ + { + "name": "envSecretRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/envSecret" + }, + { + "name": "accountKeyRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/accountKey" + }, + { + "name": "volumeSecretRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/volumeSecret" + }, + { + "name": "privateRegistryKeyRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/privateRegistryKey" + } + ], + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [ + { + "name": "envSecret", + "secureValueReference": "envSecretRef" + } + ], + "image": "privateRegistryImage", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ] + }, + "imageRegistryCredentials": [ + { + "server": "demoregistry.azurecr.io", + "username": "registryUserName", + "passwordReference": "privateRegistryKeyRef" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "autoGeneratedDomainNameLabelScope": "Unsecure", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName", + "storageAccountKeyReference": "accountKeyRef" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {}, + "secretReference": { + "secretKey2": "volumeSecretRef" + } + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreatePriority.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreatePriority.json new file mode 100644 index 000000000000..c131ccea87ed --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreatePriority.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerGroup": { + "properties": { + "sku": "Standard", + "containers": [ + { + "name": "test-container-001", + "properties": { + "image": "alpine:latest", + "command": [ + "/bin/sh", + "-c", + "sleep 10" + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + } + ], + "restartPolicy": "Never", + "osType": "Linux", + "priority": "Spot" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Standard", + "provisioningState": "Succeeded", + "containers": [ + { + "name": "test-container-001", + "properties": { + "image": "alpine:latest", + "command": [ + "/bin/sh", + "-c", + "sleep 10" + ], + "ports": [], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + } + ], + "initContainers": [], + "restartPolicy": "Never", + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Succeeded" + }, + "priority": "Spot" + }, + "id": "/subscriptions/subId/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus" + } + }, + "201": { + "body": { + "properties": { + "sku": "Standard", + "provisioningState": "Created", + "containers": [ + { + "name": "test-container-001", + "properties": { + "image": "alpine:latest", + "command": [ + "/bin/sh", + "-c", + "sleep 10" + ], + "ports": [], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + } + ], + "initContainers": [], + "restartPolicy": "Never", + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Created" + }, + "priority": "Spot" + }, + "id": "/subscriptions/subId/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsDelete.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsDelete.json new file mode 100644 index 000000000000..4c52d95afb11 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsDelete.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/locations/location/operations/operationId?api-version=apiVersion" + } + }, + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGetPriority.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGetPriority.json new file mode 100644 index 000000000000..beaad8bc9180 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGetPriority.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Standard", + "provisioningState": "Succeeded", + "containers": [ + { + "name": "test-container-001", + "properties": { + "image": "alpine:latest", + "command": [ + "/bin/sh", + "-c", + "sleep 10" + ], + "ports": [], + "environmentVariables": [], + "instanceView": { + "restartCount": 0, + "currentState": { + "state": "Terminated", + "startTime": "2022-11-11T19:33:44.217Z", + "exitCode": 0, + "finishTime": "2022-11-11T19:33:55.565Z", + "detailStatus": "Completed" + }, + "events": [ + { + "count": 2, + "firstTimestamp": "2022-11-11T19:28:22Z", + "lastTimestamp": "2022-11-11T19:32:09Z", + "name": "Pulling", + "message": "pulling image \"alpine@sha256:1304f174557314a7ed9eddb4eab12fed12cb0cd9809e4c28f29af86979a3c870\"", + "type": "Normal" + }, + { + "count": 2, + "firstTimestamp": "2022-11-11T19:32:08Z", + "lastTimestamp": "2022-11-11T19:32:38Z", + "name": "Pulled", + "message": "Successfully pulled image \"alpine@sha256:1304f174557314a7ed9eddb4eab12fed12cb0cd9809e4c28f29af86979a3c870\"", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2022-11-11T19:33:44Z", + "lastTimestamp": "2022-11-11T19:33:44Z", + "name": "Started", + "message": "Started container", + "type": "Normal" + } + ] + }, + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + } + ], + "initContainers": [], + "restartPolicy": "Never", + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Succeeded" + }, + "priority": "Spot" + }, + "id": "/subscriptions/subId/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGet_Failed.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGet_Failed.json new file mode 100644 index 000000000000..8c9f1d80ceb3 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGet_Failed.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "instanceView": { + "restartCount": 0, + "currentState": { + "state": "Waiting", + "startTime": "2017-08-08T00:09:10Z", + "detailStatus": "" + }, + "events": [ + { + "count": 1, + "firstTimestamp": "2017-08-08T00:09:01Z", + "lastTimestamp": "2017-08-08T00:09:01Z", + "message": "pulling image \"nginx\"", + "name": "Pulling", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2017-08-08T00:09:10Z", + "lastTimestamp": "2017-08-08T00:09:10Z", + "message": "Successfully pulled image \"nginx\"", + "name": "Pulled", + "type": "Normal" + } + ] + }, + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "instanceView": { + "events": [ + { + "count": 1, + "firstTimestamp": "2017-10-08T00:19:10Z", + "lastTimestamp": "2017-10-08T00:19:10Z", + "message": "Output: mount error(2): Permission denied", + "name": "FailedMount", + "type": "Normal" + } + ], + "state": "Pending" + }, + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Failed", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGet_Succeeded.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGet_Succeeded.json new file mode 100644 index 000000000000..4e824a241331 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGet_Succeeded.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsList.json new file mode 100644 index 000000000000..bc0ed9a5d99c --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsList.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "instanceView": { + "restartCount": 0, + "currentState": { + "state": "Running", + "startTime": "2017-10-17T17:27:21Z", + "detailStatus": "" + }, + "events": [] + }, + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsListByResourceGroup.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsListByResourceGroup.json new file mode 100644 index 000000000000..df87822690b9 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsListByResourceGroup.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsRestart.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsRestart.json new file mode 100644 index 000000000000..62b5ef24b019 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsRestart.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsStart.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsStart.json new file mode 100644 index 000000000000..c95afb0fdf8c --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsStart.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/locations/location/operations/operationId?api-version=apiVersion" + } + }, + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsStop.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsStop.json new file mode 100644 index 000000000000..62b5ef24b019 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsStop.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsUpdate.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsUpdate.json new file mode 100644 index 000000000000..dcc708e6bc8d --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsUpdate.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demoResource", + "containerGroupName": "demo1", + "Resource": { + "tags": { + "tag1key": "tag1Value", + "tag2key": "tag2Value" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demoResource/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "tags": { + "tag1key": "tag1Value", + "tag2key": "tag2Value" + }, + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {} + } + ] + } + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerListLogs.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerListLogs.json new file mode 100644 index 000000000000..85e3bb2cb061 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerListLogs.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerName": "container1", + "tail": 10 + }, + "responses": { + "200": { + "body": { + "content": "log content" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/OperationsList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/OperationsList.json new file mode 100644 index 000000000000..7dbd9db81afe --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/OperationsList.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ContainerInstance/containerGroups/read", + "display": { + "provider": "Microsoft Container Instance", + "resource": "Container Group", + "operation": "Get Container Groups", + "description": "Get all container goups." + }, + "origin": "User" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/SubnetServiceAssociationLinkDelete.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/SubnetServiceAssociationLinkDelete.json new file mode 100644 index 000000000000..fb57e873a21b --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/SubnetServiceAssociationLinkDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "virtualNetworkName": "demo2", + "subnetName": "demo3" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/locations/location/operations/operationId?api-version=apiVersion" + } + }, + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/readme.md b/specification/containerinstance/resource-manager/readme.md index 6c4d309167c1..37a58d82b8e1 100644 --- a/specification/containerinstance/resource-manager/readme.md +++ b/specification/containerinstance/resource-manager/readme.md @@ -26,7 +26,16 @@ These are the global settings for the ContainerInstance API. ``` yaml openapi-type: arm -tag: package-preview-2024-05 +tag: package-preview-2024-10 +``` + +### Tag: package-preview-2024-10 + +These settings apply only when `--tag=package-preview-2024-10` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-10' +input-file: + - Microsoft.ContainerInstance/preview/2024-10-01-preview/containerInstance.json ``` ### Tag: package-preview-2024-05 @@ -214,6 +223,12 @@ suppressions: - containerInstance.json where: - $.definitions.ConfigMap.properties.keyValuePairs + - code: AvoidAdditionalProperties + reason: additional feature addition to existing secretVolumes which is defined as a dictionary + from: + - containerInstance.json + where: + - $.definitions.SecretReferenceVolume ``` --- From 99e66c3b970842c345018b3358b8bdc98224454a Mon Sep 17 00:00:00 2001 From: Ray Chen <raychen@microsoft.com> Date: Mon, 30 Sep 2024 13:57:10 -0700 Subject: [PATCH 17/47] Updated Go sdk support owner (#30801) --- documentation/ci-fix.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/ci-fix.md b/documentation/ci-fix.md index 9ccbb91f092b..fc05ead8d05c 100644 --- a/documentation/ci-fix.md +++ b/documentation/ci-fix.md @@ -88,7 +88,7 @@ If you have an issue or with any of checks listed in the first column of the tab | Check name | Owner | |-----------------------------------|----------------| -| `SDK azure-sdk-for-go` | Ray Chen | +| `SDK azure-sdk-for-go` | Chenjie Shi | | `SDK azure-sdk-for-java` | Weidong Xu | | `SDK azure-sdk-for-js` | Qiaoqiao Zhang | | `SDK azure-sdk-for-net` | Wei Hu | From 7bcd659735dbdda44dfd534ded7a697924704341 Mon Sep 17 00:00:00 2001 From: Mike Harder <mharder@microsoft.com> Date: Mon, 30 Sep 2024 15:33:18 -0700 Subject: [PATCH 18/47] [TypeSpecValidation] Apply "all" suppressions when core files changed (#30805) - Fixes #30521 --- eng/scripts/Get-TypeSpec-Folders.ps1 | 6 +++++- eng/scripts/TypeSpec-Validation.ps1 | 4 ++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/eng/scripts/Get-TypeSpec-Folders.ps1 b/eng/scripts/Get-TypeSpec-Folders.ps1 index 1ddb8ef0fc55..e667216b0bdb 100644 --- a/eng/scripts/Get-TypeSpec-Folders.ps1 +++ b/eng/scripts/Get-TypeSpec-Folders.ps1 @@ -9,10 +9,13 @@ Set-StrictMode -Version 3 . $PSScriptRoot/ChangedFiles-Functions.ps1 $repoPath = Resolve-Path "$PSScriptRoot/../.." + $checkAllPath = ((Get-ChildItem "specification" -Directory).Name -replace '^', 'specification/') -replace '$', '/' +$checkedAll = $false if ($CheckAll) { $changedFiles = $checkAllPath + $checkedAll = $true } else { $changedFiles = @(Get-ChangedFiles -baseCommitish $BaseCommitish -targetCommitish $TargetCommitish -diffFilter "") @@ -21,6 +24,7 @@ else { if ($coreChangedFiles) { Write-Verbose "Found changes to core eng or root files so checking all specs." $changedFiles = $checkAllPath + $checkedAll = $true } else { $changedFiles = Get-ChangedFilesUnderSpecification $changedFiles @@ -49,4 +53,4 @@ foreach ($skippedTypespecFolder in $skippedTypespecFolders | Select-Object -Uniq $typespecFolders = $typespecFolders | ForEach-Object { [IO.Path]::GetRelativePath($repoPath, $_) -replace '\\', '/' } | Sort-Object -Unique -return $typespecFolders +return @($typespecFolders, $checkedAll) diff --git a/eng/scripts/TypeSpec-Validation.ps1 b/eng/scripts/TypeSpec-Validation.ps1 index 30985a681fb7..031ae7d69000 100644 --- a/eng/scripts/TypeSpec-Validation.ps1 +++ b/eng/scripts/TypeSpec-Validation.ps1 @@ -10,7 +10,7 @@ param ( . $PSScriptRoot/Logging-Functions.ps1 . $PSScriptRoot/Suppressions-Functions.ps1 -$typespecFolders = &"$PSScriptRoot/Get-TypeSpec-Folders.ps1" -BaseCommitish:$BaseCommitish -TargetCommitish:$TargetCommitish -CheckAll:$CheckAll +$typespecFolders, $checkedAll = &"$PSScriptRoot/Get-TypeSpec-Folders.ps1" -BaseCommitish:$BaseCommitish -TargetCommitish:$TargetCommitish -CheckAll:$CheckAll $typespecFoldersWithFailures = @() if ($typespecFolders) { @@ -18,7 +18,7 @@ if ($typespecFolders) { foreach ($typespecFolder in $typespecFolders) { LogGroupStart "Validating $typespecFolder" - if ($CheckAll) { + if ($checkedAll) { $suppression = Get-Suppression "TypeSpecValidationAll" $typespecFolder if ($suppression) { $reason = $suppression["reason"] ?? "<no reason specified>" From f942179943a944a981d889020dec035dcbdc7559 Mon Sep 17 00:00:00 2001 From: Sean Wells <swells@users.noreply.github.com> Date: Mon, 30 Sep 2024 15:49:24 -0700 Subject: [PATCH 19/47] feat(azurearcdata): Welcome 2024-05-01-preview (#30613) * feat(azurearcdata): Welcome 2024-05-01-preview * fix(azurearcdata): update cSpell.json 2024-05-01-preview * fix(azurearcdata): 2024-05-01 Update readme.md * Update sqlServerAvailabilityGroups.json * chore(azurearcdata): prettier * Update sqlServerAvailabilityGroups.json * chore(azurearcdata): prettier * chore(azurearcdata): prettier * chore(azurearcdata): sync from private * Update sqlServerDatabases.json --- cSpell.json | 15 + .../activeDirectoryConnectors.json | 240 ++ .../2024-05-01-preview/azurearcdata.json | 2193 +++++++++++++++++ .../preview/2024-05-01-preview/common.json | 159 ++ .../2024-05-01-preview/dataControllers.json | 253 ++ .../AddDatabasesToAvailabilityGroup.json | 120 + ...reateOrUpdateActiveDirectoryConnector.json | 134 + ...OrUpdateArcSqlServerAvailabilityGroup.json | 223 ++ .../CreateOrUpdateArcSqlServerDatabase.json | 156 ++ .../CreateOrUpdateDataController.json | 166 ++ .../examples/CreateOrUpdateFailoverGroup.json | 74 + .../CreateOrUpdatePostgresInstance.json | 172 ++ .../CreateOrUpdateSqlManagedInstance.json | 267 ++ .../CreateOrUpdateSqlServerEsuLicense.json | 83 + .../CreateOrUpdateSqlServerInstance.json | 179 ++ .../CreateOrUpdateSqlServerLicense.json | 81 + .../CreateSqlServerAvailabilityGroup.json | 187 ++ ...SqlServerDistributedAvailabilityGroup.json | 155 ++ .../DeleteActiveDirectoryConnector.json | 26 + .../DeleteArcSqlServerAvailabilityGroup.json | 21 + .../examples/DeleteArcSqlServerDatabase.json | 21 + .../examples/DeleteDataController.json | 25 + .../examples/DeleteFailoverGroup.json | 18 + .../examples/DeletePostgresInstance.json | 25 + .../examples/DeleteSqlManagedInstance.json | 25 + .../examples/DeleteSqlServerEsuLicense.json | 16 + .../examples/DeleteSqlServerInstance.json | 25 + .../examples/DeleteSqlServerLicense.json | 16 + ...FailoverArcSqlServerAvailabilityGroup.json | 183 ++ ...FailoverArcSqlServerAvailabilityGroup.json | 183 ++ .../examples/GetActiveDirectoryConnector.json | 57 + .../GetArcSqlServerAvailabilityGroup.json | 113 + .../examples/GetArcSqlServerDatabase.json | 92 + .../examples/GetDataController.json | 65 + .../examples/GetFailoverGroup.json | 38 + .../examples/GetPostgresInstance.json | 43 + .../examples/GetSqlManagedInstance.json | 99 + .../examples/GetSqlServerEsuLicense.json | 40 + .../examples/GetSqlServerInstance.json | 191 ++ .../GetSqlServerInstanceJobsStatus.json | 51 + .../GetSqlServerInstanceTelemetry.json | 154 ++ .../examples/GetSqlServerLicense.json | 39 + ...ataControllerActiveDirectoryConnector.json | 104 + .../ListByResourceGroupDataController.json | 115 + .../ListByResourceGroupPostgresInstance.json | 77 + ...ListByResourceGroupSqlManagedInstance.json | 162 ++ ...istByResourceGroupSqlServerEsuLicense.json | 71 + .../ListByResourceGroupSqlServerInstance.json | 248 ++ .../ListByResourceGroupSqlServerLicense.json | 69 + ...ListBySqlManagedInstanceFailoverGroup.json | 66 + ...tBySqlServerInstanceAvailabilityGroup.json | 215 ++ .../ListBySqlServerInstanceDatabase.json | 167 ++ .../examples/ListOperation.json | 353 +++ .../ListSubscriptionDataController.json | 119 + .../ListSubscriptionPostgresInstance.json | 76 + .../ListSubscriptionSqlManagedInstance.json | 163 ++ .../ListSubscriptionSqlServerEsuLicense.json | 70 + .../ListSubscriptionSqlServerInstance.json | 249 ++ .../ListSubscriptionSqlServerLicense.json | 68 + .../PostUpgradeSqlServerInstance.json | 77 + .../examples/PreUpgradeSqlServerInstance.json | 77 + .../RemoveDatabasesFromAvailabilityGroup.json | 118 + ...nMigrationAssessmentSqlServerInstance.json | 43 + .../UpdateArcSqlServerAvailabilityGroup.json | 123 + .../examples/UpdateDataController.json | 75 + .../examples/UpdatePostgresInstance.json | 48 + .../examples/UpdateSqlManagedInstance.json | 101 + .../examples/UpdateSqlServerDatabase.json | 102 + .../examples/UpdateSqlServerEsuLicense.json | 49 + .../examples/UpdateSqlServerInstance.json | 88 + .../examples/UpdateSqlServerLicense.json | 44 + .../ViewArcSqlServerAvailabilityGroup.json | 183 ++ .../2024-05-01-preview/failoverGroups.json | 157 ++ .../2024-05-01-preview/operations.json | 125 + .../2024-05-01-preview/postgresInstances.json | 174 ++ .../sqlManagedInstances.json | 403 +++ .../sqlServerAvailabilityGroups.json | 1573 ++++++++++++ .../sqlServerDatabases.json | 680 +++++ .../sqlServerEsuLicenses.json | 545 ++++ .../sqlServerInstances.json | 1367 ++++++++++ .../2024-05-01-preview/sqlServerLicenses.json | 259 ++ .../azurearcdata/resource-manager/readme.md | 23 +- 82 files changed, 15248 insertions(+), 1 deletion(-) create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/activeDirectoryConnectors.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/azurearcdata.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/common.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/dataControllers.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/AddDatabasesToAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateActiveDirectoryConnector.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateArcSqlServerAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateArcSqlServerDatabase.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateDataController.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateFailoverGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdatePostgresInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlManagedInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerEsuLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateSqlServerAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateSqlServerDistributedAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteActiveDirectoryConnector.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteArcSqlServerAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteArcSqlServerDatabase.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteDataController.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteFailoverGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeletePostgresInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlManagedInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerEsuLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/FailoverArcSqlServerAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ForceFailoverArcSqlServerAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetActiveDirectoryConnector.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetArcSqlServerAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetArcSqlServerDatabase.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetDataController.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetFailoverGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetPostgresInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlManagedInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerEsuLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstanceJobsStatus.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstanceTelemetry.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByDataControllerActiveDirectoryConnector.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupDataController.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupPostgresInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlManagedInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerEsuLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlManagedInstanceFailoverGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlServerInstanceAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlServerInstanceDatabase.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListOperation.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionDataController.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionPostgresInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlManagedInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerEsuLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/PostUpgradeSqlServerInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/PreUpgradeSqlServerInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/RemoveDatabasesFromAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/RunMigrationAssessmentSqlServerInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateArcSqlServerAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateDataController.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdatePostgresInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlManagedInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerDatabase.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerEsuLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ViewArcSqlServerAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/failoverGroups.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/operations.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/postgresInstances.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlManagedInstances.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerAvailabilityGroups.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerDatabases.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerEsuLicenses.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerInstances.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerLicenses.json diff --git a/cSpell.json b/cSpell.json index 29ff06a9c8f4..e7aeb6374c29 100644 --- a/cSpell.json +++ b/cSpell.json @@ -47,6 +47,21 @@ "typescript" ], "overrides": [ + { + "filename": "**/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/**/*.json", + "words": [ + "azurearcdata" + ] + }, + { + "filename": "**/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/**/*.json", + "words": [ + "SSRS", + "SSAS", + "SSIS", + "PBIRS" + ] + }, { "filename": "**/specification/batch/**/*.json", "words": [ diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/activeDirectoryConnectors.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/activeDirectoryConnectors.json new file mode 100644 index 000000000000..76600b07efcc --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/activeDirectoryConnectors.json @@ -0,0 +1,240 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "paths": {}, + "definitions": { + "ActiveDirectoryConnectorListResult": { + "description": "A list of active directory connectors", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ActiveDirectoryConnectorResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ActiveDirectoryConnectorResource": { + "type": "object", + "description": "Active directory connector resource", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ActiveDirectoryConnectorProperties", + "description": "null", + "x-ms-client-flatten": false + } + }, + "required": [ + "properties" + ] + }, + "ActiveDirectoryConnectorProperties": { + "type": "object", + "description": "The properties of an Active Directory connector resource", + "properties": { + "domainServiceAccountLoginInformation": { + "$ref": "./common.json#/definitions/BasicLoginInformation", + "description": "Username and password for domain service account authentication." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the Active Directory connector resource.", + "readOnly": true + }, + "spec": { + "$ref": "#/definitions/ActiveDirectoryConnectorSpec", + "description": "null", + "x-ms-client-flatten": false + }, + "status": { + "$ref": "#/definitions/ActiveDirectoryConnectorStatus", + "description": "null", + "x-ms-client-flatten": false + } + }, + "required": [ + "spec" + ] + }, + "ActiveDirectoryConnectorSpec": { + "description": "The specifications of the AD Kubernetes resource.", + "type": "object", + "properties": { + "activeDirectory": { + "$ref": "#/definitions/ActiveDirectoryConnectorDomainDetails", + "description": "null", + "x-ms-client-flatten": false + }, + "dns": { + "$ref": "#/definitions/ActiveDirectoryConnectorDNSDetails", + "description": "null", + "x-ms-client-flatten": false + } + }, + "required": [ + "activeDirectory", + "dns" + ] + }, + "ActiveDirectoryConnectorDomainDetails": { + "type": "object", + "description": "Active Directory domain details", + "properties": { + "realm": { + "type": "string", + "description": "Name (uppercase) of the Active Directory domain that this AD connector will be associated with." + }, + "netbiosDomainName": { + "type": "string", + "description": "NETBIOS name of the Active Directory domain." + }, + "serviceAccountProvisioning": { + "type": "string", + "enum": [ + "automatic", + "manual" + ], + "x-ms-enum": { + "name": "accountProvisioningMode", + "modelAsString": true + }, + "default": "manual", + "description": "The service account provisioning mode for this Active Directory connector." + }, + "ouDistinguishedName": { + "type": "string", + "description": "The distinguished name of the Active Directory Organizational Unit." + }, + "domainControllers": { + "$ref": "#/definitions/ActiveDirectoryDomainControllers", + "description": "null", + "x-ms-client-flatten": false + } + }, + "required": [ + "realm" + ] + }, + "ActiveDirectoryConnectorDNSDetails": { + "type": "object", + "description": "DNS server details", + "properties": { + "domainName": { + "type": "string", + "description": "DNS domain name for which DNS lookups should be forwarded to the Active Directory DNS servers." + }, + "nameserverIPAddresses": { + "type": "array", + "description": "List of Active Directory DNS server IP addresses.", + "items": { + "type": "string", + "minimum": 1 + } + }, + "replicas": { + "type": "integer", + "description": "Replica count for DNS proxy service. Default value is 1.", + "default": 1, + "format": "int64" + }, + "preferK8sDnsForPtrLookups": { + "type": "boolean", + "description": "Flag indicating whether to prefer Kubernetes DNS server response over AD DNS server response for IP address lookups.", + "default": true + } + }, + "required": [ + "nameserverIPAddresses" + ] + }, + "ActiveDirectoryDomainControllers": { + "type": "object", + "description": "Details about the Active Directory domain controllers associated with this AD connector instance", + "properties": { + "primaryDomainController": { + "$ref": "#/definitions/ActiveDirectoryDomainController", + "description": "Information about the Primary Domain Controller (PDC) in the AD domain.", + "x-ms-client-flatten": false + }, + "secondaryDomainControllers": { + "$ref": "#/definitions/ActiveDirectorySecondaryDomainControllers", + "description": "null", + "x-ms-client-flatten": false + } + } + }, + "ActiveDirectoryDomainController": { + "type": "object", + "description": "Information about a domain controller in the AD domain.", + "properties": { + "hostname": { + "type": "string", + "description": "Fully-qualified domain name of a domain controller in the AD domain." + } + }, + "required": [ + "hostname" + ] + }, + "ActiveDirectorySecondaryDomainControllers": { + "type": "array", + "description": "Information about the secondary domain controllers in the AD domain.", + "items": { + "$ref": "#/definitions/ActiveDirectoryDomainController", + "description": "List of the fully-qualified domain names of the secondary domain controllers in the AD domain.", + "x-ms-client-flatten": false + }, + "x-ms-identifiers": [ + "hostname" + ] + }, + "ActiveDirectoryConnectorStatus": { + "type": "object", + "description": "The status of the Kubernetes custom resource.", + "properties": { + "lastUpdateTime": { + "type": "string", + "description": "The time that the custom resource was last updated." + }, + "observedGeneration": { + "type": "integer", + "format": "int64", + "description": "The version of the replicaSet associated with the AD connector custom resource." + }, + "state": { + "type": "string", + "description": "The state of the AD connector custom resource." + } + }, + "additionalProperties": {} + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/azurearcdata.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/azurearcdata.json new file mode 100644 index 000000000000..5f93b34b812f --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/azurearcdata.json @@ -0,0 +1,2193 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.AzureArcData/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available Azure Data Services on Azure Arc API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved operations.", + "schema": { + "$ref": "./operations.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Lists all of the available Azure Data Services on Azure Arc API operations.": { + "$ref": "./examples/ListOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/sqlManagedInstances": { + "get": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_List", + "summary": "List sqlManagedInstance resources in the subscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 404 ResourceNotFound - The requested resource was not found.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Instance in a subscription.": { + "$ref": "./examples/ListSubscriptionSqlManagedInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlManagedInstances": { + "get": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_ListByResourceGroup", + "description": "Gets all sqlManagedInstances in a resource group.", + "summary": "List sqlManagedInstance resources in the resource group", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Instance in a resource group.": { + "$ref": "./examples/ListByResourceGroupSqlManagedInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlManagedInstances/{sqlManagedInstanceName}": { + "get": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_Get", + "description": "Retrieves a SQL Managed Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlManagedInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a SQL Instance tags.": { + "$ref": "./examples/GetSqlManagedInstance.json" + } + } + }, + "put": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_Create", + "description": "Creates or replaces a SQL Managed Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlManagedInstanceName" + }, + { + "name": "sqlManagedInstance", + "in": "body", + "description": "The SQL Managed Instance to be created or updated.", + "required": true, + "schema": { + "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstance" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstance" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a SQL Managed Instance": { + "$ref": "./examples/CreateOrUpdateSqlManagedInstance.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_Delete", + "description": "Deletes a SQL Managed Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlManagedInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the SQL Managed Instance." + }, + "202": { + "description": "Resource deletion is in progress." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified SQL Managed Instance does not exist." + } + }, + "x-ms-examples": { + "Delete a SQL Instance.": { + "$ref": "./examples/DeleteSqlManagedInstance.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_Update", + "description": "Updates a SQL Managed Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlManagedInstanceName" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL Managed Instance.", + "required": true, + "schema": { + "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstanceUpdate" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a sql Instance tags.": { + "$ref": "./examples/UpdateSqlManagedInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlManagedInstances/{sqlManagedInstanceName}/failoverGroups": { + "get": { + "tags": [ + "FailoverGroups" + ], + "operationId": "FailoverGroups_List", + "summary": "List the failover groups associated with the given sql managed instance.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlManagedInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./failoverGroups.json#/definitions/FailoverGroupListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 404 ResourceNotFound - The requested resource was not found.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all failover groups associated with a sql managed instance.": { + "$ref": "./examples/ListBySqlManagedInstanceFailoverGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlManagedInstances/{sqlManagedInstanceName}/failoverGroups/{failoverGroupName}": { + "put": { + "tags": [ + "FailoverGroups" + ], + "operationId": "FailoverGroups_Create", + "description": "Creates or replaces a failover group resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "failoverGroupResource", + "description": "desc", + "required": true, + "in": "body", + "schema": { + "$ref": "./failoverGroups.json#/definitions/FailoverGroupResource" + } + }, + { + "$ref": "#/parameters/sqlManagedInstanceName" + }, + { + "$ref": "#/parameters/failoverGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./failoverGroups.json#/definitions/FailoverGroupResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./failoverGroups.json#/definitions/FailoverGroupResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create or update a failover group instance.": { + "$ref": "./examples/CreateOrUpdateFailoverGroup.json" + } + } + }, + "delete": { + "tags": [ + "FailoverGroups" + ], + "operationId": "FailoverGroups_Delete", + "description": "Deletes a failover group resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlManagedInstanceName" + }, + { + "$ref": "#/parameters/failoverGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the failover group." + }, + "202": { + "description": "Resource deletion is in progress." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified failover group does not exist." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes a failover group instance.": { + "$ref": "./examples/DeleteFailoverGroup.json" + } + } + }, + "get": { + "tags": [ + "FailoverGroups" + ], + "operationId": "FailoverGroups_Get", + "description": "Retrieves a failover group resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlManagedInstanceName" + }, + { + "$ref": "#/parameters/failoverGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./failoverGroups.json#/definitions/FailoverGroupResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieves a failover group resource.": { + "$ref": "./examples/GetFailoverGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/sqlServerInstances": { + "get": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_List", + "summary": "List sqlServerInstance resources in the subscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 404 ResourceNotFound - The requested resource was not found.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Server Instance in a subscription.": { + "$ref": "./examples/ListSubscriptionSqlServerInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances": { + "get": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_ListByResourceGroup", + "description": "Gets all sqlServerInstances in a resource group.", + "summary": "List sqlServerInstance resources in the resource group", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Server Instance in a resource group.": { + "$ref": "./examples/ListByResourceGroupSqlServerInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}": { + "get": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_Get", + "description": "Retrieves a SQL Server Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a SQL Server Instance tags.": { + "$ref": "./examples/GetSqlServerInstance.json" + } + } + }, + "put": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_Create", + "description": "Creates or replaces a SQL Server Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "name": "sqlServerInstance", + "in": "body", + "description": "The SQL Server Instance to be created or updated.", + "required": true, + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstance" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstance" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a SQL Server Instance tags.": { + "$ref": "./examples/CreateOrUpdateSqlServerInstance.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_Delete", + "description": "Deletes a SQL Server Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the SQL Server Instance." + }, + "202": { + "description": "Resource deletion is in progress." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified SQL Server Instance does not exist." + } + }, + "x-ms-examples": { + "Delete a SQL Server Instance.": { + "$ref": "./examples/DeleteSqlServerInstance.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_Update", + "description": "Updates a SQL Server Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL Server Instance.", + "required": true, + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstanceUpdate" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstance" + } + }, + "202": { + "description": "Resource update is in progress.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a SQL Server Instance tags.": { + "$ref": "./examples/UpdateSqlServerInstance.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/getTelemetry": { + "post": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_getTelemetry", + "description": "Retrieves SQL Server instance telemetry", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "name": "sqlServerInstanceTelemetryRequest", + "in": "body", + "description": "Contains the parameters to get SQL Server instance telemetry.", + "required": true, + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstanceTelemetryRequest" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstanceTelemetryResponse" + } + }, + "202": { + "description": "Arc SQL Server telemetry retrieval is in progress.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the operation status." + } + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "operationName": "SqlServerInstances_PostInstanceTelemetry", + "itemName": "rows" + }, + "x-ms-examples": { + "Retrieves Arc SQL Server cpu utilization telemetry": { + "$ref": "./examples/GetSqlServerInstanceTelemetry.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/runMigrationAssessment": { + "post": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_runMigrationAssessment", + "description": "Runs migration assessment for SQL Server instance", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstanceRunMigrationAssessmentResponse" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Trigger migration assessment run on sql server instance": { + "$ref": "./examples/RunMigrationAssessmentSqlServerInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/getJobsStatus": { + "post": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_getJobsStatus", + "description": "Gets jobs status details for sql arc resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "name": "SqlServerInstanceJobsStatusRequest", + "in": "body", + "description": "Contains the parameters to get SQL Server instance agent jobs status.", + "required": false, + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstanceJobsStatusRequest" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstanceJobsStatusResponse" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieves Arc SQL Server instance jobs status": { + "$ref": "./examples/GetSqlServerInstanceJobsStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/preUpgrade": { + "post": { + "tags": [ + "SqlServerInstances" + ], + "description": "Request Upgrade Permission before upgrading.", + "operationId": "SqlServerInstances_preUpgrade", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully requested upgrade permission for the instance.", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Prepare SQL server instance for AUM Upgrade.": { + "$ref": "./examples/PreUpgradeSqlServerInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/postUpgrade": { + "post": { + "tags": [ + "SqlServerInstances" + ], + "description": "Clean up after upgrading.", + "operationId": "SqlServerInstances_postUpgrade", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully clean up upgrade request for the instance.", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Post AUM Upgrade to complete SQL Instance Upgrade Process": { + "$ref": "./examples/PostUpgradeSqlServerInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/sqlServerLicenses": { + "get": { + "tags": [ + "SqlServerLicenses" + ], + "operationId": "SqlServerLicenses_List", + "summary": "List sqlServerLicense resources in the subscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerLicenses.json#/definitions/SqlServerLicenseListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 404 ResourceNotFound - The requested resource was not found.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Server license in a subscription.": { + "$ref": "./examples/ListSubscriptionSqlServerLicense.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerLicenses": { + "get": { + "tags": [ + "SqlServerLicenses" + ], + "operationId": "SqlServerLicenses_ListByResourceGroup", + "description": "Gets all sqlServerLicenses in a resource group.", + "summary": "List sqlServerLicense resources in the resource group", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerLicenses.json#/definitions/SqlServerLicenseListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Server license in a resource group.": { + "$ref": "./examples/ListByResourceGroupSqlServerLicense.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerLicenses/{sqlServerLicenseName}": { + "get": { + "tags": [ + "SqlServerLicenses" + ], + "operationId": "SqlServerLicenses_Get", + "description": "Retrieves a SQL Server license resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerLicenseName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerLicenses.json#/definitions/SqlServerLicense" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets a SQL Server license tags.": { + "$ref": "./examples/GetSqlServerLicense.json" + } + } + }, + "put": { + "tags": [ + "SqlServerLicenses" + ], + "operationId": "SqlServerLicenses_Create", + "description": "Creates or replaces a SQL Server license resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerLicenseName" + }, + { + "name": "sqlServerLicense", + "in": "body", + "description": "The SQL Server license to be created or updated.", + "required": true, + "schema": { + "$ref": "./sqlServerLicenses.json#/definitions/SqlServerLicense" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerLicenses.json#/definitions/SqlServerLicense" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./sqlServerLicenses.json#/definitions/SqlServerLicense" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a SQL Server license tags.": { + "$ref": "./examples/CreateOrUpdateSqlServerLicense.json" + } + } + }, + "delete": { + "tags": [ + "SqlServerLicenses" + ], + "operationId": "SqlServerLicenses_Delete", + "description": "Deletes a SQL Server license resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerLicenseName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the SQL Server license." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified SQL Server license does not exist." + } + }, + "x-ms-examples": { + "Delete a SQL Server license.": { + "$ref": "./examples/DeleteSqlServerLicense.json" + } + } + }, + "patch": { + "tags": [ + "SqlServerLicenses" + ], + "operationId": "SqlServerLicenses_Update", + "description": "Updates a SQL Server license resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerLicenseName" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL Server license.", + "required": true, + "schema": { + "$ref": "./sqlServerLicenses.json#/definitions/SqlServerLicenseUpdate" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerLicenses.json#/definitions/SqlServerLicense" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch a SQL Server license tags.": { + "$ref": "./examples/UpdateSqlServerLicense.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/dataControllers": { + "get": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_ListInSubscription", + "summary": "List dataController resources in the subscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./dataControllers.json#/definitions/PageOfDataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all dataControllers in a subscription.": { + "$ref": "./examples/ListSubscriptionDataController.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/dataControllers": { + "get": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_ListInGroup", + "summary": "List dataController resources in the resource group", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./dataControllers.json#/definitions/PageOfDataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all dataControllers in a resource group.": { + "$ref": "./examples/ListByResourceGroupDataController.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/dataControllers/{dataControllerName}": { + "put": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_PutDataController", + "description": "Creates or replaces a dataController resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "dataControllerResource", + "description": "desc", + "required": true, + "in": "body", + "schema": { + "$ref": "./dataControllers.json#/definitions/DataControllerResource" + } + }, + { + "$ref": "#/parameters/dataControllerName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./dataControllers.json#/definitions/DataControllerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./dataControllers.json#/definitions/DataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a Data Controller.": { + "$ref": "./examples/CreateOrUpdateDataController.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_DeleteDataController", + "description": "Deletes a dataController resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/dataControllerName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the DataController." + }, + "202": { + "description": "Resource deletion is in progress." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified DataController does not exist." + } + }, + "x-ms-examples": { + "Delete a dataController.": { + "$ref": "./examples/DeleteDataController.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_GetDataController", + "description": "Retrieves a dataController resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/dataControllerName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./dataControllers.json#/definitions/DataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a data controller.": { + "$ref": "./examples/GetDataController.json" + } + } + }, + "patch": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_PatchDataController", + "description": "Updates a dataController resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/dataControllerName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "name": "dataControllerResource", + "description": "The update data controller resource", + "required": true, + "in": "body", + "schema": { + "$ref": "./dataControllers.json#/definitions/DataControllerUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./dataControllers.json#/definitions/DataControllerResource" + } + }, + "202": { + "description": "Resource update is in progress." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a dataController tags.": { + "$ref": "./examples/UpdateDataController.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/dataControllers/{dataControllerName}/activeDirectoryConnectors": { + "get": { + "tags": [ + "ActiveDirectoryConnectors" + ], + "operationId": "ActiveDirectoryConnectors_List", + "summary": "List the active directory connectors associated with the given data controller.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/dataControllerName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./activeDirectoryConnectors.json#/definitions/ActiveDirectoryConnectorListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 404 ResourceNotFound - The requested resource was not found.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all Active Directory connectors associated with a data controller.": { + "$ref": "./examples/ListByDataControllerActiveDirectoryConnector.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/dataControllers/{dataControllerName}/activeDirectoryConnectors/{activeDirectoryConnectorName}": { + "put": { + "tags": [ + "ActiveDirectoryConnectors" + ], + "operationId": "ActiveDirectoryConnectors_Create", + "description": "Creates or replaces an Active Directory connector resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "activeDirectoryConnectorResource", + "description": "desc", + "required": true, + "in": "body", + "schema": { + "$ref": "./activeDirectoryConnectors.json#/definitions/ActiveDirectoryConnectorResource" + } + }, + { + "$ref": "#/parameters/dataControllerName" + }, + { + "$ref": "#/parameters/activeDirectoryConnectorName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./activeDirectoryConnectors.json#/definitions/ActiveDirectoryConnectorResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./activeDirectoryConnectors.json#/definitions/ActiveDirectoryConnectorResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create or update an Active Directory connector instance.": { + "$ref": "./examples/CreateOrUpdateActiveDirectoryConnector.json" + } + } + }, + "delete": { + "tags": [ + "ActiveDirectoryConnectors" + ], + "operationId": "ActiveDirectoryConnectors_Delete", + "description": "Deletes an Active Directory connector resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/dataControllerName" + }, + { + "$ref": "#/parameters/activeDirectoryConnectorName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the active directory connector." + }, + "202": { + "description": "Resource deletion is in progress." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified active directory connector does not exist." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes an Active Directory connector instance.": { + "$ref": "./examples/DeleteActiveDirectoryConnector.json" + } + } + }, + "get": { + "tags": [ + "ActiveDirectoryConnectors" + ], + "operationId": "ActiveDirectoryConnectors_Get", + "description": "Retrieves an Active Directory connector resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/dataControllerName" + }, + { + "$ref": "#/parameters/activeDirectoryConnectorName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./activeDirectoryConnectors.json#/definitions/ActiveDirectoryConnectorResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieves an Active Directory connector resource.": { + "$ref": "./examples/GetActiveDirectoryConnector.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/postgresInstances": { + "get": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_List", + "summary": "List postgres Instance resources in the subscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./postgresInstances.json#/definitions/PostgresInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all Postgres Instance in a subscription.": { + "$ref": "./examples/ListSubscriptionPostgresInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/postgresInstances": { + "get": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_ListByResourceGroup", + "description": "Get a postgres Instances list by Resource group name.", + "summary": "List postgres Instance resources in the resource group", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./postgresInstances.json#/definitions/PostgresInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all postgres Instances in a resource group.": { + "$ref": "./examples/ListByResourceGroupPostgresInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/postgresInstances/{postgresInstanceName}": { + "get": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_Get", + "description": "Retrieves a postgres Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/postgresInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./postgresInstances.json#/definitions/PostgresInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets a postgres Instances.": { + "$ref": "./examples/GetPostgresInstance.json" + } + } + }, + "put": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_Create", + "description": "Creates or replaces a postgres Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/postgresInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "name": "resource", + "description": "The postgres instance", + "required": true, + "in": "body", + "schema": { + "$ref": "./postgresInstances.json#/definitions/PostgresInstance" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./postgresInstances.json#/definitions/PostgresInstance" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./postgresInstances.json#/definitions/PostgresInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a Postgres Instance.": { + "$ref": "./examples/CreateOrUpdatePostgresInstance.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_Delete", + "description": "Deletes a postgres Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/postgresInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the Postgres Instance." + }, + "202": { + "description": "Resource deletion is in progress." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified Postgres Instance does not exist." + } + }, + "x-ms-examples": { + "Deletes a PostgresInstances.": { + "$ref": "./examples/DeletePostgresInstance.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_Update", + "description": "Updates a postgres Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/postgresInstanceName" + }, + { + "name": "parameters", + "in": "body", + "description": "The Postgres Instance.", + "required": true, + "schema": { + "$ref": "./postgresInstances.json#/definitions/PostgresInstanceUpdate" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./postgresInstances.json#/definitions/PostgresInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a postgres Instances tags.": { + "$ref": "./examples/UpdatePostgresInstance.json" + } + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Azure subscription", + "x-ms-parameter-location": "client" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group", + "x-ms-parameter-location": "method" + }, + "location": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure region to use for the request", + "x-ms-parameter-location": "method" + }, + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + }, + "dataControllerName": { + "name": "dataControllerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the data controller", + "x-ms-parameter-location": "method" + }, + "activeDirectoryConnectorName": { + "name": "activeDirectoryConnectorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Active Directory connector instance", + "x-ms-parameter-location": "method" + }, + "sqlManagedInstanceName": { + "name": "sqlManagedInstanceName", + "description": "Name of SQL Managed Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "failoverGroupName": { + "name": "failoverGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Failover Group", + "x-ms-parameter-location": "method" + }, + "sqlServerInstanceName": { + "name": "sqlServerInstanceName", + "description": "Name of SQL Server Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "sqlServerLicenseName": { + "name": "sqlServerLicenseName", + "description": "Name of SQL Server License", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "x-ms-parameter-location": "method" + }, + "postgresInstanceName": { + "name": "postgresInstanceName", + "description": "Name of Postgres Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/common.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/common.json new file mode 100644 index 000000000000..165fc4a44d4a --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/common.json @@ -0,0 +1,159 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "paths": {}, + "definitions": { + "CommonSku": { + "description": "The resource model definition representing SKU for ARM resources", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU. It is typically a letter+number code" + }, + "dev": { + "type": "boolean", + "default": true, + "description": "Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose. " + }, + "size": { + "type": "string", + "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. " + }, + "family": { + "type": "string", + "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here." + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted." + } + }, + "required": [ + "name" + ] + }, + "ExtendedLocation": { + "type": "object", + "description": "The complex type of the extended location.", + "properties": { + "name": { + "type": "string", + "description": "The name of the extended location." + }, + "type": { + "$ref": "#/definitions/ExtendedLocationType", + "description": "The type of the extended location." + } + } + }, + "ExtendedLocationType": { + "type": "string", + "description": "The type of extendedLocation.", + "enum": [ + "CustomLocation" + ], + "x-ms-enum": { + "name": "ExtendedLocationTypes", + "modelAsString": true + } + }, + "BasicLoginInformation": { + "type": "object", + "description": "Username and password for basic login authentication.", + "properties": { + "username": { + "type": "string", + "description": "Login username." + }, + "password": { + "type": "string", + "description": "Login password.", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + } + }, + "ConnectionAuth": { + "type": "string", + "description": "The endpoint connection authentication type(s).", + "enum": [ + "Windows_NTLM", + "Windows_Kerberos", + "Windows_Negotiate", + "Certificate", + "Windows_NTLM_Certificate", + "Windows_Kerberos_Certificate", + "Windows_Negotiate_Certificate", + "Certificate_Windows_NTLM", + "Certificate_Windows_Kerberos", + "Certificate_Windows_Negotiate" + ], + "x-ms-enum": { + "name": "connectionAuth", + "modelAsString": true + } + }, + "EncryptionAlgorithm": { + "type": "string", + "description": "The encryption algorithm(s) used by the endpoint.", + "enum": [ + "NONE", + "RC4", + "AES", + "NONE, RC4", + "NONE, AES", + "RC4, AES", + "AES, RC4", + "NONE, RC4, AES", + "NONE, AES, RC4" + ], + "x-ms-enum": { + "name": "encryptionAlgorithm", + "modelAsString": true + } + }, + "SkuRecommendationResultsRecommendationStatus": { + "description": "The target recommendation Status for this database.", + "type": "string", + "enum": [ + "NotReady", + "Ready", + "Unknown" + ], + "x-ms-enum": { + "name": "recommendationStatus", + "modelAsString": true + } + } + }, + "parameters": { + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/dataControllers.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/dataControllers.json new file mode 100644 index 000000000000..49ddde5fc14f --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/dataControllers.json @@ -0,0 +1,253 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "paths": {}, + "definitions": { + "DataControllerResource": { + "description": "Data controller resource", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "extendedLocation": { + "$ref": "./common.json#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + }, + "properties": { + "$ref": "#/definitions/DataControllerProperties", + "description": "The data controller's properties", + "x-ms-client-flatten": false + } + }, + "required": [ + "properties" + ] + }, + "PageOfDataControllerResource": { + "type": "object", + "description": "A list of data controllers.", + "properties": { + "value": { + "items": { + "$ref": "#/definitions/DataControllerResource" + }, + "type": "array", + "description": "Array of results." + }, + "nextLink": { + "type": "string", + "description": "Link to retrieve next page of results." + } + } + }, + "DataControllerUpdate": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "properties": { + "$ref": "#/definitions/DataControllerProperties", + "description": "The data controller's properties", + "x-ms-client-flatten": false + } + }, + "description": "Used for updating a data controller resource." + }, + "DataControllerProperties": { + "description": "The data controller properties.", + "type": "object", + "properties": { + "infrastructure": { + "type": "string", + "enum": [ + "azure", + "gcp", + "aws", + "alibaba", + "onpremises", + "other" + ], + "x-ms-enum": { + "name": "infrastructure", + "modelAsString": false + }, + "default": "other", + "description": "The infrastructure the data controller is running on." + }, + "onPremiseProperty": { + "$ref": "#/definitions/OnPremiseProperty" + }, + "k8sRaw": { + "type": "object", + "description": "The raw kubernetes information" + }, + "uploadWatermark": { + "$ref": "#/definitions/UploadWatermark" + }, + "lastUploadedDate": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date from Kubernetes cluster. Defaults to current date time" + }, + "basicLoginInformation": { + "$ref": "./common.json#/definitions/BasicLoginInformation", + "description": "Deprecated. Azure Arc Data Services data controller no longer expose any endpoint. All traffic are exposed through Kubernetes native API." + }, + "metricsDashboardCredential": { + "$ref": "./common.json#/definitions/BasicLoginInformation", + "description": "Login credential for metrics dashboard on the Kubernetes cluster." + }, + "logsDashboardCredential": { + "$ref": "./common.json#/definitions/BasicLoginInformation", + "description": "Login credential for logs dashboard on the Kubernetes cluster." + }, + "logAnalyticsWorkspaceConfig": { + "$ref": "#/definitions/LogAnalyticsWorkspaceConfig" + }, + "uploadServicePrincipal": { + "$ref": "#/definitions/UploadServicePrincipal", + "description": "Deprecated. Service principal is deprecated in favor of Arc Kubernetes service extension managed identity." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the Arc Data Controller resource.", + "readOnly": true + }, + "clusterId": { + "type": "string", + "description": "If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to." + }, + "extensionId": { + "type": "string", + "description": "If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to." + } + } + }, + "UploadWatermark": { + "description": "Properties on upload watermark. Mostly timestamp for each upload data type", + "type": "object", + "properties": { + "metrics": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date for metrics from kubernetes cluster. Defaults to current date time" + }, + "logs": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date for logs from kubernetes cluster. Defaults to current date time" + }, + "usages": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date for usages from kubernetes cluster. Defaults to current date time" + } + } + }, + "OnPremiseProperty": { + "description": "Properties from the Kubernetes data controller", + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "A globally unique ID identifying the associated Kubernetes cluster" + }, + "publicSigningKey": { + "type": "string", + "description": "Certificate that contains the Kubernetes cluster public key used to verify signing" + }, + "signingCertificateThumbprint": { + "type": "string", + "description": "Unique thumbprint returned to customer to verify the certificate being uploaded" + } + }, + "required": [ + "id", + "publicSigningKey" + ] + }, + "LogAnalyticsWorkspaceConfig": { + "type": "object", + "description": "Log analytics workspace id and primary key", + "properties": { + "workspaceId": { + "type": "string", + "format": "uuid", + "description": "Azure Log Analytics workspace ID" + }, + "primaryKey": { + "type": "string", + "description": "Primary key of the workspace", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + } + }, + "UploadServicePrincipal": { + "type": "object", + "description": "Service principal for uploading billing, metrics and logs.", + "properties": { + "clientId": { + "type": "string", + "format": "uuid", + "description": "Client ID of the service principal for uploading data." + }, + "tenantId": { + "type": "string", + "format": "uuid", + "description": "Tenant ID of the service principal." + }, + "authority": { + "type": "string", + "description": "Authority for the service principal. Example: https://login.microsoftonline.com/" + }, + "clientSecret": { + "type": "string", + "description": "Secret of the service principal", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + } + } + }, + "parameters": { + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/AddDatabasesToAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/AddDatabasesToAvailabilityGroup.json new file mode 100644 index 000000000000..10d381325fed --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/AddDatabasesToAvailabilityGroup.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "availabilityGroupName": "testAG", + "databases": { + "values": [ + "db1", + "db2", + "db3" + ] + }, + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "collectionTimestamp": "2022-05-05T16:26:33.883Z", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "automatedBackupPreferenceDescription": "SECONDARY", + "version": 0, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "clusterTypeDescription": "WSFC", + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "primaryReplica": "testSqlServer\\INST1", + "primaryRecoveryHealthDescription": "ONLINE", + "secondaryRecoveryHealthDescription": null, + "synchronizationHealthDescription": "HEALTHY", + "replicationPartnerType": null + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateActiveDirectoryConnector.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateActiveDirectoryConnector.json new file mode 100644 index 000000000000..b14fcf3fda0e --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateActiveDirectoryConnector.json @@ -0,0 +1,134 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "activeDirectoryConnectorName": "testADConnector", + "api-version": "2024-05-01-preview", + "activeDirectoryConnectorResource": { + "properties": { + "spec": { + "activeDirectory": { + "realm": "CONTOSO.LOCAL", + "serviceAccountProvisioning": "manual", + "domainControllers": { + "primaryDomainController": { + "hostname": "dc1.contoso.local" + }, + "secondaryDomainControllers": [ + { + "hostname": "dc2.contoso.local" + }, + { + "hostname": "dc3.contoso.local" + } + ] + } + }, + "dns": { + "nameserverIPAddresses": [ + "11.11.111.111", + "22.22.222.222" + ], + "replicas": 1, + "preferK8sDnsForPtrLookups": false + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "spec": { + "activeDirectory": { + "realm": "CONTOSO.LOCAL", + "serviceAccountProvisioning": "manual", + "domainControllers": { + "primaryDomainController": { + "hostname": "dc1.contoso.local" + }, + "secondaryDomainControllers": [ + { + "hostname": "dc2.contoso.local" + }, + { + "hostname": "dc3.contoso.local" + } + ] + }, + "netbiosDomainName": "CONTOSO" + }, + "dns": { + "nameserverIPAddresses": [ + "11.11.111.111", + "22.22.222.222" + ], + "replicas": 1, + "preferK8sDnsForPtrLookups": false, + "domainName": "contoso.local" + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController/activeDirectoryConnectors/testADConnector", + "name": "testADConnector", + "type": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors" + } + }, + "201": { + "body": { + "properties": { + "spec": { + "activeDirectory": { + "realm": "CONTOSO.LOCAL", + "serviceAccountProvisioning": "manual", + "domainControllers": { + "primaryDomainController": { + "hostname": "dc1.contoso.local" + }, + "secondaryDomainControllers": [ + { + "hostname": "dc2.contoso.local" + }, + { + "hostname": "dc3.contoso.local" + } + ] + }, + "netbiosDomainName": "CONTOSO" + }, + "dns": { + "nameserverIPAddresses": [ + "11.11.111.111", + "22.22.222.222" + ], + "replicas": 1, + "preferK8sDnsForPtrLookups": false, + "domainName": "contoso.local" + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController/activeDirectoryConnectors/testADConnector", + "name": "testADConnector", + "type": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateArcSqlServerAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateArcSqlServerAvailabilityGroup.json new file mode 100644 index 000000000000..5a7af1d03c87 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateArcSqlServerAvailabilityGroup.json @@ -0,0 +1,223 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "availabilityGroupName": "testAG", + "api-version": "2024-05-01-preview", + "sqlServerAvailabilityGroupResource": { + "location": "southeastasia", + "tags": { + "mytag": "myval" + }, + "properties": { + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "secondaryRecoveryHealthDescription": null, + "replicationPartnerType": null + }, + "replicas": { + "value": [ + { + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "sessionTimeout": 10, + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1" + }, + { + "databaseName": "db2" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServerInstance", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + }, + "201": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServerInstance", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateArcSqlServerDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateArcSqlServerDatabase.json new file mode 100644 index 000000000000..2fc04715ef44 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateArcSqlServerDatabase.json @@ -0,0 +1,156 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServerInstance", + "databaseName": "testdb", + "api-version": "2024-05-01-preview", + "sqlServerDatabaseResource": { + "location": "southeastasia", + "tags": { + "mytag": "myval" + }, + "properties": { + "collationName": "SQL_Latin1_General_CP1_CI_AS", + "databaseCreationDate": "2022-04-05T16:26:33.883Z", + "compatibilityLevel": 150, + "state": "Online", + "isReadOnly": true, + "recoveryMode": "Full", + "sizeMB": 150.0, + "spaceAvailableMB": 100.0, + "databaseOptions": { + "isAutoCloseOn": true, + "isAutoShrinkOn": true, + "isAutoCreateStatsOn": true, + "isAutoUpdateStatsOn": true, + "isMemoryOptimizationEnabled": true, + "isRemoteDataArchiveEnabled": true, + "isEncrypted": true, + "isTrustworthyOn": true + }, + "backupInformation": { + "lastFullBackup": "2022-05-05T16:26:33.883Z", + "lastLogBackup": "2022-05-10T16:26:33.883Z" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "createMode": "PointInTimeRestore", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/MyDatabase", + "restorePointInTime": "2022-05-05T16:26:33.883Z" + } + } + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/testdb", + "name": "testdb", + "type": "Microsoft.AzureArcData/sqlServerInstances/databases", + "properties": { + "collationName": "SQL_Latin1_General_CP1_CI_AS", + "databaseCreationDate": "2022-04-05T16:26:33.883Z", + "compatibilityLevel": 150, + "state": "Online", + "isReadOnly": true, + "recoveryMode": "Full", + "sizeMB": 150.0, + "spaceAvailableMB": 100.0, + "databaseOptions": { + "isAutoCloseOn": true, + "isAutoShrinkOn": true, + "isAutoCreateStatsOn": true, + "isAutoUpdateStatsOn": true, + "isMemoryOptimizationEnabled": true, + "isRemoteDataArchiveEnabled": true, + "isEncrypted": true, + "isTrustworthyOn": true + }, + "backupInformation": { + "lastFullBackup": "2022-05-05T16:26:33.883Z", + "lastLogBackup": "2022-05-10T16:26:33.883Z" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "earliestRestoreDate": "2022-05-10T16:26:33.883Z", + "createMode": "PointInTimeRestore", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/MyDatabase", + "restorePointInTime": "2022-05-05T16:26:33.883Z" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + }, + "201": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/testdb", + "name": "testdb", + "type": "Microsoft.AzureArcData/sqlServerInstances/databases", + "properties": { + "collationName": "SQL_Latin1_General_CP1_CI_AS", + "databaseCreationDate": "2022-04-05T16:26:33.883Z", + "compatibilityLevel": 150, + "state": "Online", + "isReadOnly": true, + "recoveryMode": "Full", + "sizeMB": 150.0, + "spaceAvailableMB": 100.0, + "databaseOptions": { + "isAutoCloseOn": true, + "isAutoShrinkOn": true, + "isAutoCreateStatsOn": true, + "isAutoUpdateStatsOn": true, + "isMemoryOptimizationEnabled": true, + "isRemoteDataArchiveEnabled": true, + "isEncrypted": true, + "isTrustworthyOn": true + }, + "backupInformation": { + "lastFullBackup": "2022-05-05T16:26:33.883Z", + "lastLogBackup": "2022-05-10T16:26:33.883Z" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "earliestRestoreDate": "2022-05-10T16:26:33.883Z", + "createMode": "PointInTimeRestore", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/MyDatabase", + "restorePointInTime": "2022-05-05T16:26:33.883Z" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateDataController.json new file mode 100644 index 000000000000..0073fe4ff49d --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateDataController.json @@ -0,0 +1,166 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "api-version": "2024-05-01-preview", + "dataControllerResource": { + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey" + }, + "basicLoginInformation": { + "username": "username", + "password": "********" + }, + "metricsDashboardCredential": { + "username": "username", + "password": "********" + }, + "logsDashboardCredential": { + "username": "username", + "password": "********" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444", + "primaryKey": "********" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/", + "clientSecret": "********" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate being uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "metricsDashboardCredential": { + "username": "username" + }, + "logsDashboardCredential": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController", + "name": "testdataController", + "type": "Microsoft.AzureArcData/dataControllers" + } + }, + "201": { + "body": { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate being uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "metricsDashboardCredential": { + "username": "username" + }, + "logsDashboardCredential": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController", + "name": "testdataController", + "type": "Microsoft.AzureArcData/dataControllers" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateFailoverGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateFailoverGroup.json new file mode 100644 index 000000000000..068b2580a5ff --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateFailoverGroup.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testSqlManagedInstance", + "failoverGroupName": "testFailoverGroupName", + "api-version": "2024-05-01-preview", + "failoverGroupResource": { + "properties": { + "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/partnerMI", + "spec": { + "partnerSyncMode": "async", + "role": "primary" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/partnerMI", + "spec": { + "sharedName": "testSharedName", + "sourceMI": "sourceSQLMI", + "partnerMI": "partnerMI", + "partnerMirroringURL": "11.11.111.111:1111", + "partnerMirroringCert": "testCert", + "partnerSyncMode": "async", + "role": "primary" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testSqlManagedInstance/failoverGroups/testFailoverGroupName", + "name": "testFailoverGroupName", + "type": "Microsoft.AzureArcData/sqlManagedInstances/failoverGroups" + } + }, + "201": { + "body": { + "properties": { + "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/partnerMI", + "spec": { + "sharedName": "testSharedName", + "sourceMI": "sourceSQLMI", + "partnerMI": "partnerMI", + "partnerMirroringURL": "11.11.111.111:1111", + "partnerMirroringCert": "testCert", + "partnerSyncMode": "async", + "role": "primary" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testSqlManagedInstance/failoverGroups/testFailoverGroupName", + "name": "testFailoverGroupName", + "type": "Microsoft.AzureArcData/sqlManagedInstances/failoverGroups" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdatePostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdatePostgresInstance.json new file mode 100644 index 000000000000..e6a865dc7e08 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdatePostgresInstance.json @@ -0,0 +1,172 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "postgresInstanceName": "testpostgresInstance", + "api-version": "2024-05-01-preview", + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "resource": { + "location": "eastus", + "properties": { + "dataControllerId": "dataControllerId", + "admin": "admin", + "basicLoginInformation": { + "username": "username", + "password": "********" + }, + "k8sRaw": { + "apiVersion": "apiVersion", + "kind": "postgresql-12", + "metadata": { + "creationTimestamp": "2020-08-25T14:55:10Z", + "generation": 1, + "name": "pg1", + "namespace": "test", + "resourceVersion": "527780", + "selfLink": "/apis/arcdata.microsoft.com/v1alpha1/namespaces/test/postgresql-12s/pg1", + "uid": "1111aaaa-ffff-ffff-ffff-99999aaaaaaa" + }, + "spec": { + "backups": { + "deltaMinutes": 3, + "fullMinutes": 10, + "tiers": [ + { + "retention": { + "maximums": [ + "6", + "512MB" + ], + "minimums": [ + "3" + ] + }, + "storage": { + "volumeSize": "1Gi" + } + } + ] + }, + "engine": { + "extensions": [ + { + "name": "citus" + } + ] + }, + "scale": { + "shards": 3 + }, + "scheduling": { + "default": { + "resources": { + "requests": { + "memory": "256Mi" + } + } + } + }, + "service": { + "type": "NodePort" + }, + "storage": { + "data": { + "className": "local-storage", + "size": "5Gi" + }, + "logs": { + "className": "local-storage", + "size": "5Gi" + } + } + }, + "status": { + "externalEndpoint": null, + "readyPods": "4/4", + "state": "Ready" + } + } + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstance/testpostgresInstance", + "name": "testpostgresInstance", + "type": "Microsoft.AzureArcData/PostgresInstance" + } + }, + "201": { + "body": { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstance/testpostgresInstance", + "name": "testsqlregistration", + "type": "Microsoft.AzureArcData/PostgresInstance" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlManagedInstance.json new file mode 100644 index 000000000000..3d0384a2843c --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlManagedInstance.json @@ -0,0 +1,267 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testsqlManagedInstance", + "api-version": "2024-05-01-preview", + "sqlManagedInstance": { + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username", + "password": "********" + }, + "activeDirectoryInformation": { + "keytabInformation": { + "keytab": "********" + } + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + }, + "security": { + "adminLoginSecret": "test-sql-login-secret", + "serviceCertificateSecret": "Service Certificate Secret", + "activeDirectory": { + "connector": { + "name": "Name of connector", + "namespace": "Namespace of connector" + }, + "accountName": "Account name", + "keytabSecret": "Key tab secret of account", + "encryptionTypes": [ + "Encryption type item1, Encryption type item2,..." + ] + }, + "transparentDataEncryption": { + "mode": "SystemManaged" + } + }, + "settings": { + "network": { + "forceencryption": 0, + "tlsciphers": "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384", + "tlsprotocols": "1.2" + } + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "activeDirectoryInformation": { + "keytabInformation": {} + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + }, + "security": { + "adminLoginSecret": "test-sql-login-secret", + "serviceCertificateSecret": "Service Certificate Secret", + "activeDirectory": { + "connector": { + "name": "Name of connector", + "namespace": "Namespace of connector" + }, + "accountName": "Account name", + "keytabSecret": "Key tab secret of account", + "encryptionTypes": [ + "Encryption type item1, Encryption type item2,..." + ] + }, + "transparentDataEncryption": { + "mode": "SystemManaged" + } + }, + "settings": { + "network": { + "forceencryption": 0, + "tlsciphers": "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384", + "tlsprotocols": "1.2" + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testsqlManagedInstance", + "name": "testsqlManagedInstance", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + } + }, + "201": { + "body": { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "activeDirectoryInformation": { + "keytabInformation": {} + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + }, + "security": { + "adminLoginSecret": "test-sql-login-secret", + "serviceCertificateSecret": "Service Certificate Secret", + "activeDirectory": { + "connector": { + "name": "Name of connector", + "namespace": "Namespace of connector" + }, + "accountName": "Account name", + "keytabSecret": "Key tab secret of account", + "encryptionTypes": [ + "Encryption type item1, Encryption type item2,..." + ] + }, + "transparentDataEncryption": { + "mode": "SystemManaged" + } + }, + "settings": { + "network": { + "forceencryption": 0, + "tlsciphers": "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384", + "tlsprotocols": "1.2" + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testsqlManagedInstance", + "name": "testsqlManagedInstance", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerEsuLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerEsuLicense.json new file mode 100644 index 000000000000..5c06a00b721d --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerEsuLicense.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerEsuLicenseName": "testsqlServerEsuLicense", + "api-version": "2024-05-01-preview", + "sqlServerEsuLicense": { + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "properties": { + "billingPlan": "PAYG", + "version": "SQL Server 2012", + "physicalCores": 24, + "activationState": "Inactive", + "scopeType": "Subscription" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "billingPlan": "PAYG", + "version": "SQL Server 2012", + "uniqueId": "00000000-1111-2222-3333-444444444444", + "physicalCores": 24, + "activationState": "Inactive", + "scopeType": "Subscription", + "activatedAt": "2020-01-01T17:18:19.1234567Z", + "terminatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/sqlServerEsuLicense", + "name": "sqlServerEsuLicense", + "type": "Microsoft.AzureArcData/sqlServerEsuLicenses" + } + }, + "201": { + "body": { + "properties": { + "billingPlan": "PAYG", + "version": "SQL Server 2012", + "uniqueId": "00000000-1111-2222-3333-444444444444", + "physicalCores": 24, + "activationState": "Inactive", + "scopeType": "Subscription", + "activatedAt": "2020-01-01T17:18:19.1234567Z", + "terminatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/sqlServerEsuLicense", + "name": "sqlServerEsuLicense", + "type": "Microsoft.AzureArcData/sqlServerEsuLicenses" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerInstance.json new file mode 100644 index 000000000000..4e7749baa078 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerInstance.json @@ -0,0 +1,179 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2024-05-01-preview", + "sqlServerInstance": { + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "properties": { + "version": "SQL Server 2012", + "edition": "Developer", + "cores": "4", + "instanceName": "name of instance", + "hostType": "Physical Server", + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "monitoring": { + "enabled": false + }, + "migration": { + "assessment": { + "enabled": false + } + }, + "clientConnection": { + "enabled": false + }, + "serviceType": "Engine" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "version": "SQL Server 2012", + "edition": "Developer", + "containerResourceId": "Resource id of hosting Arc Machine", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2012", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "status": "Registered", + "azureDefenderStatus": "Protected", + "hostType": "Physical Server", + "lastInventoryUploadTime": "2023-03-29T14:13:12Z", + "lastUsageUploadTime": "2023-03-29T14:13:12Z", + "alwaysOnRole": "FailoverClusterInstance", + "failoverCluster": { + "id": "f836af7e-85ed-4ea4-91fb-67709b34e323", + "networkName": "networkNameOfSQLFCI", + "sqlInstanceIds": [ + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer1", + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer2" + ], + "hostNames": [ + "DEV-HOSTNAME1", + "DEV-HOSTNAME2" + ] + }, + "databaseMirroringEndpoint": { + "endpointName": "testMirroringEndpoint", + "role": "PARTNER", + "isEncryptionEnabled": true, + "encryptionAlgorithm": "AES", + "connectionAuth": "Certificate", + "port": 12345, + "isDynamicPort": false, + "ipAddress": "123.124.125.126", + "certificateName": "testCertificateName" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "upgradeLockedUntil": "2022-05-05T16:26:33.883Z", + "monitoring": { + "enabled": false + }, + "serviceType": "Engine" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + }, + "201": { + "body": { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "status": "Connected", + "azureDefenderStatus": "Protected", + "monitoring": { + "enabled": false + }, + "migration": { + "assessment": { + "enabled": false + } + }, + "clientConnection": { + "enabled": false + }, + "serviceType": "SSRS" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerLicense.json new file mode 100644 index 000000000000..df774923e646 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerLicense.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerLicenseName": "testsqlServerLicense", + "api-version": "2024-05-01-preview", + "sqlServerLicense": { + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "properties": { + "billingPlan": "PAYG", + "licenseCategory": "Core", + "physicalCores": 24, + "activationState": "Deactivated", + "scopeType": "Subscription" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "billingPlan": "PAYG", + "licenseCategory": "Core", + "physicalCores": 24, + "activationState": "Deactivated", + "scopeType": "Subscription", + "lastActivatedAt": "2020-01-01T17:18:19.1234567Z", + "lastDeactivatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerLicenses/sqlServerLicense", + "name": "sqlServerLicense", + "type": "Microsoft.AzureArcData/SqlServerLicenses" + } + }, + "201": { + "body": { + "properties": { + "billingPlan": "PAYG", + "licenseCategory": "Core", + "physicalCores": 24, + "activationState": "Deactivated", + "scopeType": "Subscription", + "lastActivatedAt": "2020-01-01T17:18:19.1234567Z", + "lastDeactivatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerLicenses/sqlServerLicense", + "name": "sqlServerLicense", + "type": "Microsoft.AzureArcData/SqlServerLicenses" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateSqlServerAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateSqlServerAvailabilityGroup.json new file mode 100644 index 000000000000..6387ac3dea93 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateSqlServerAvailabilityGroup.json @@ -0,0 +1,187 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "api-version": "2024-05-01-preview", + "createAgConfiguration": { + "availabilityGroupName": "myNewAg", + "replicas": [ + { + "serverInstance": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/", + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://testSqlServer_INST1.testSqlserverDomain:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityMode": "SYNCHRONOUS_COMMIT", + "failoverMode": "AUTOMATIC", + "seedingMode": "AUTOMATIC", + "backupPriority": 50, + "secondaryRoleAllowConnections": "ALL", + "secondaryRoleReadOnlyRoutingUrl": null, + "primaryRoleAllowConnections": "ALL", + "primaryRoleReadOnlyRoutingList": null, + "sessionTimeout": 10 + }, + { + "serverInstance": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST2/", + "endpointName": "inst2DBMEndpoint", + "endpointUrl": "TCP://testSqlServer_INST2.testSqlserverDomain:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityMode": "SYNCHRONOUS_COMMIT", + "failoverMode": "AUTOMATIC", + "seedingMode": "AUTOMATIC", + "backupPriority": 50, + "secondaryRoleAllowConnections": "ALL", + "secondaryRoleReadOnlyRoutingUrl": null, + "primaryRoleAllowConnections": "ALL", + "primaryRoleReadOnlyRoutingList": null, + "sessionTimeout": 10 + } + ], + "databases": [ + "database1", + "database2" + ], + "automatedBackupPreference": "SECONDARY", + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "dbFailover": "ON", + "dtcSupport": "NONE", + "requiredSynchronizedSecondariesToCommit": 0, + "clusterType": "WSFC", + "listener": { + "dnsName": "myNewAgListener", + "ipV4AddressesAndMasks": [ + { + "ipAddress": "192.1.168.5", + "mask": "255.255.255.0" + }, + { + "ipAddress": "10.1.168.5", + "mask": "255.255.255.0" + } + ], + "port": 1433 + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.AzureArcData/operationResults/id1" + } + }, + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/myNewAg", + "name": "myNewag", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\Inst1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://testSqlServer_INST1.testSqlserverDomain:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "AUTOMATIC", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "PRIMARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + }, + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\Inst2", + "configure": { + "endpointName": "ins21DBMEndpoint", + "endpointUrl": "TCP://testSqlServer_INST2.testSqlserverDomain:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "AUTOMATIC", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "database1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "database2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateSqlServerDistributedAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateSqlServerDistributedAvailabilityGroup.json new file mode 100644 index 000000000000..bd9f3fd062c7 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateSqlServerDistributedAvailabilityGroup.json @@ -0,0 +1,155 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "api-version": "2024-05-01-preview", + "createDagConfiguration": { + "availabilityGroupName": "myNewDag", + "primaryAvailabilityGroup": { + "availabilityGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG1", + "listenerUrl": "TCP://testAG1.contoso.com:5022", + "availabilityMode": "ASYNCHRONOUS_COMMIT", + "failoverMode": "MANUAL", + "seedingMode": "AUTOMATIC", + "certificateConfiguration": { + "certificateName": "myCert" + } + }, + "secondaryAvailabilityGroup": { + "availabilityGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST2/availabilityGroups/testAG2", + "listenerUrl": "TCP://testAG2.contoso.com:5022", + "availabilityMode": "ASYNCHRONOUS_COMMIT", + "failoverMode": "MANUAL", + "seedingMode": "AUTOMATIC", + "certificateConfiguration": { + "certificateName": "myCert" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.AzureArcData/operationResults/id1" + } + }, + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/myNewDag", + "name": "myNewDag", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "isDistributed": true + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\Inst1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://testSqlServer_INST1.testSqlserverDomain:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "AUTOMATIC", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "PRIMARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + }, + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\Inst2", + "configure": { + "endpointName": "ins21DBMEndpoint", + "endpointUrl": "TCP://testSqlServer_INST2.testSqlserverDomain:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "AUTOMATIC", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "database1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "database2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteActiveDirectoryConnector.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteActiveDirectoryConnector.json new file mode 100644 index 000000000000..3edead6e00e2 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteActiveDirectoryConnector.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "activeDirectoryConnectorName": "testADConnector", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteArcSqlServerAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteArcSqlServerAvailabilityGroup.json new file mode 100644 index 000000000000..666b2db57f72 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteArcSqlServerAvailabilityGroup.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlInstanceAvailabilityGroup", + "availabilityGroupName": "testAG", + "api-version": "2024-05-01-preview" + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteArcSqlServerDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteArcSqlServerDatabase.json new file mode 100644 index 000000000000..8bcd13277d4d --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteArcSqlServerDatabase.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlManagedInstance", + "databaseName": "testdb", + "api-version": "2024-05-01-preview" + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteDataController.json new file mode 100644 index 000000000000..73053e5c0e7c --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteDataController.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteFailoverGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteFailoverGroup.json new file mode 100644 index 000000000000..acaf1b6effbd --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteFailoverGroup.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testSqlManagedInstance", + "failoverGroupName": "testFailoverGroupName", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeletePostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeletePostgresInstance.json new file mode 100644 index 000000000000..f99fda21bf30 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeletePostgresInstance.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "postgresInstanceName": "testpostgresInstance", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlManagedInstance.json new file mode 100644 index 000000000000..22b0c85fa325 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlManagedInstance.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testsqlManagedInstance", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerEsuLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerEsuLicense.json new file mode 100644 index 000000000000..c204c14cfe32 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerEsuLicense.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerEsuLicenseName": "testsqlServerEsuLicense", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerInstance.json new file mode 100644 index 000000000000..a60bed533dab --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerInstance.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerLicense.json new file mode 100644 index 000000000000..f1b375d71a7d --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerLicense.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerLicenseName": "testsqlServerLicense", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/FailoverArcSqlServerAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/FailoverArcSqlServerAvailabilityGroup.json new file mode 100644 index 000000000000..a329e153da55 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/FailoverArcSqlServerAvailabilityGroup.json @@ -0,0 +1,183 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "availabilityGroupName": "testAG", + "api-version": "2024-05-01-preview", + "sqlServerAvailabilityGroupResource": { + "location": "southeastasia", + "tags": { + "mytag": "myval" + }, + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "collectionTimestamp": "2022-05-05T16:26:33.883Z", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "automatedBackupPreferenceDescription": "SECONDARY", + "version": 0, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "clusterTypeDescription": "WSFC", + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "primaryReplica": "testSqlServer\\INST1", + "primaryRecoveryHealthDescription": "ONLINE", + "secondaryRecoveryHealthDescription": null, + "synchronizationHealthDescription": "HEALTHY", + "replicationPartnerType": null + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServerInstance", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ForceFailoverArcSqlServerAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ForceFailoverArcSqlServerAvailabilityGroup.json new file mode 100644 index 000000000000..a329e153da55 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ForceFailoverArcSqlServerAvailabilityGroup.json @@ -0,0 +1,183 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "availabilityGroupName": "testAG", + "api-version": "2024-05-01-preview", + "sqlServerAvailabilityGroupResource": { + "location": "southeastasia", + "tags": { + "mytag": "myval" + }, + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "collectionTimestamp": "2022-05-05T16:26:33.883Z", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "automatedBackupPreferenceDescription": "SECONDARY", + "version": 0, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "clusterTypeDescription": "WSFC", + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "primaryReplica": "testSqlServer\\INST1", + "primaryRecoveryHealthDescription": "ONLINE", + "secondaryRecoveryHealthDescription": null, + "synchronizationHealthDescription": "HEALTHY", + "replicationPartnerType": null + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServerInstance", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetActiveDirectoryConnector.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetActiveDirectoryConnector.json new file mode 100644 index 000000000000..7a31dcc92155 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetActiveDirectoryConnector.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "activeDirectoryConnectorName": "testADConnector", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "spec": { + "activeDirectory": { + "realm": "CONTOSO.LOCAL", + "serviceAccountProvisioning": "manual", + "domainControllers": { + "primaryDomainController": { + "hostname": "dc1.contoso.local" + }, + "secondaryDomainControllers": [ + { + "hostname": "dc2.contoso.local" + }, + { + "hostname": "dc3.contoso.local" + } + ] + }, + "netbiosDomainName": "CONTOSO" + }, + "dns": { + "nameserverIPAddresses": [ + "11.11.111.111", + "22.22.222.222" + ], + "replicas": 1, + "preferK8sDnsForPtrLookups": false, + "domainName": "contoso.local" + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController/activeDirectoryConnectors/testADConnector", + "name": "testADConnector", + "type": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetArcSqlServerAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetArcSqlServerAvailabilityGroup.json new file mode 100644 index 000000000000..091e1aef1546 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetArcSqlServerAvailabilityGroup.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "availabilityGroupName": "testAG", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "collectionTimestamp": "2022-05-05T16:26:33.883Z", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "automatedBackupPreferenceDescription": "SECONDARY", + "version": 0, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "clusterTypeDescription": "WSFC", + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "primaryReplica": "testSqlServer\\INST1", + "primaryRecoveryHealthDescription": "ONLINE", + "secondaryRecoveryHealthDescription": null, + "synchronizationHealthDescription": "HEALTHY", + "replicationPartnerType": null + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetArcSqlServerDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetArcSqlServerDatabase.json new file mode 100644 index 000000000000..e524be7554ed --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetArcSqlServerDatabase.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServerInstance", + "databaseName": "testdb", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/testdb", + "name": "testdb", + "type": "Microsoft.AzureArcData/sqlServerInstances/databases", + "properties": { + "collationName": "SQL_Latin1_General_CP1_CI_AS", + "databaseCreationDate": "2022-04-05T16:26:33.883Z", + "compatibilityLevel": 150, + "state": "Online", + "isReadOnly": true, + "recoveryMode": "Full", + "sizeMB": 150.00, + "spaceAvailableMB": 100.00, + "databaseOptions": { + "isAutoCloseOn": true, + "isAutoShrinkOn": true, + "isAutoCreateStatsOn": true, + "isAutoUpdateStatsOn": true, + "isMemoryOptimizationEnabled": true, + "isRemoteDataArchiveEnabled": true, + "isEncrypted": true, + "isTrustworthyOn": true + }, + "backupInformation": { + "lastFullBackup": "2022-05-05T16:26:33.883Z", + "lastLogBackup": "2022-05-10T16:26:33.883Z" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "migration": { + "assessment": { + "assessmentUploadTime": "2024-03-15T00:14:52.0000000Z", + "databaseAssessments": [ + { + "appliesToMigrationTargetPlatform": "AzureSqlDatabase", + "featureId": "ServiceBroker", + "issueCategory": "Issue", + "moreInformation": "" + } + ], + "targetReadiness": { + "azureSqlDatabase": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + }, + "azureSqlManagedInstance": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + }, + "azureSqlVirtualMachine": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + } + } + } + }, + "earliestRestoreDate": "2022-05-10T16:26:33.883Z", + "lastDatabaseUploadTime": "2023-03-29T14:13:12Z", + "createMode": "PointInTimeRestore", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/MyDatabase", + "restorePointInTime": "2022-05-05T16:26:33.883Z" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetDataController.json new file mode 100644 index 000000000000..047dfe542b35 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetDataController.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "metricsDashboardCredential": { + "username": "username" + }, + "logsDashboardCredential": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController", + "name": "testdataController", + "type": "Microsoft.AzureArcData/dataControllers" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetFailoverGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetFailoverGroup.json new file mode 100644 index 000000000000..c6a830d76e1e --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetFailoverGroup.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testSqlManagedInstance", + "failoverGroupName": "testFailoverGroupName", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/partnerMI", + "spec": { + "sharedName": "testSharedName", + "sourceMI": "sourceSQLMI", + "partnerMI": "partnerMI", + "partnerMirroringURL": "11.11.111.111:1111", + "partnerMirroringCert": "testCert", + "partnerSyncMode": "async", + "role": "primary" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testSqlManagedInstance/failoverGroups/testFailoverGroupName", + "name": "testFailoverGroupName", + "type": "Microsoft.AzureArcData/sqlManagedInstances/failoverGroups" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetPostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetPostgresInstance.json new file mode 100644 index 000000000000..35dcf6bd7f6a --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetPostgresInstance.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "postgresInstanceName": "testpostgresInstances", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstances/testpostgresInstances", + "name": "testpostgresInstances", + "type": "Microsoft.AzureArcData/PostgresInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlManagedInstance.json new file mode 100644 index 000000000000..7014a0289953 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlManagedInstance.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testsqlManagedInstance", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "activeDirectoryInformation": { + "keytabInformation": {} + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + }, + "security": { + "adminLoginSecret": "test-sql-login-secret", + "serviceCertificateSecret": "Service Certificate Secret", + "activeDirectory": { + "connector": { + "name": "Name of connector", + "namespace": "Namespace of connector" + }, + "accountName": "Account name", + "keytabSecret": "Key tab secret of account", + "encryptionTypes": [ + "Encryption type item1, Encryption type item2,..." + ] + }, + "transparentDataEncryption": { + "mode": "SystemManaged" + } + }, + "settings": { + "network": { + "forceencryption": 0, + "tlsciphers": "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384", + "tlsprotocols": "1.2" + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testsqlManagedInstance", + "name": "testsqlManagedInstance", + "type": "Microsoft.AzureArcData/sqlManagedInstance" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerEsuLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerEsuLicense.json new file mode 100644 index 000000000000..09a4286a647f --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerEsuLicense.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerEsuLicenseName": "testsqlServerEsuLicense", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "billingPlan": "PAYG", + "version": "SQL Server 2012", + "uniqueId": "00000000-1111-2222-3333-444444444444", + "physicalCores": 24, + "activationState": "Inactive", + "scopeType": "Subscription", + "activatedAt": "2020-01-01T17:18:19.1234567Z", + "terminatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/testsqlServerEsuLicense", + "name": "testsqlServerEsuLicense", + "type": "Microsoft.AzureArcData/sqlServerEsuLicenses" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstance.json new file mode 100644 index 000000000000..877c6661c531 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstance.json @@ -0,0 +1,191 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "version": "SQL Server 2012", + "edition": "Developer", + "containerResourceId": "Resource id of hosting Arc Machine", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2012", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "status": "Registered", + "hostType": "Physical Server", + "lastInventoryUploadTime": "2023-03-29T14:13:12Z", + "lastUsageUploadTime": "2023-03-29T14:13:12Z", + "alwaysOnRole": "FailoverClusterInstance", + "failoverCluster": { + "id": "f836af7e-85ed-4ea4-91fb-67709b34e323", + "networkName": "networkNameOfSQLFCI", + "sqlInstanceIds": [ + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer1", + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer2" + ], + "hostNames": [ + "DEV-HOSTNAME1", + "DEV-HOSTNAME2" + ] + }, + "databaseMirroringEndpoint": { + "endpointName": "testMirroringEndpoint", + "role": "PARTNER", + "isEncryptionEnabled": true, + "encryptionAlgorithm": "RC4", + "connectionAuth": "Certificate", + "port": 12345, + "isDynamicPort": false, + "ipAddress": "123.124.125.126", + "certificateName": "testCertificateName" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "upgradeLockedUntil": "2022-05-05T16:26:33.883Z", + "monitoring": { + "enabled": false + }, + "migration": { + "assessment": { + "enabled": true, + "assessmentUploadTime": "2024-03-15T00:16:11.0000000Z", + "serverAssessments": [ + { + "appliesToMigrationTargetPlatform": "AzureSqlDatabase", + "featureId": "TraceFlags", + "impactedObjects": [ + { + "impactDetail": "", + "name": "8017", + "objectType": "TraceFlag" + } + ], + "issueCategory": "Warning", + "moreInformation": "Resolving Transact-SQL differences during migration to SQL Database" + }, + { + "appliesToMigrationTargetPlatform": "AzureSqlManagedInstance", + "featureId": "TraceFlags", + "impactedObjects": [ + { + "impactDetail": "", + "name": "8017", + "objectType": "TraceFlag" + } + ], + "issueCategory": "Warning", + "moreInformation": "Trace Flags" + } + ], + "skuRecommendationResults": { + "azureSqlDatabase": { + "recommendationStatus": "Ready", + "numberOfServerBlockerIssues": 0, + "targetSku": { + "category": { + "computeTier": "Provisioned", + "hardwareType": "Gen5", + "sqlPurchasingModel": "vCore", + "sqlServiceTier": "General Purpose", + "zoneRedundancyAvailable": false + } + }, + "monthlyCost": { + "computeCost": 245.13, + "storageCost": 0.18, + "totalCost": 245.31 + } + }, + "azureSqlManagedInstance": { + "recommendationStatus": "Ready", + "numberOfServerBlockerIssues": 0, + "targetSku": { + "category": { + "computeTier": "Provisioned", + "hardwareType": "Gen5", + "sqlPurchasingModel": "vCore", + "sqlServiceTier": "General Purpose", + "zoneRedundancyAvailable": false + } + }, + "monthlyCost": { + "computeCost": 490.26, + "storageCost": 0, + "totalCost": 490.26 + } + }, + "azureSqlVirtualMachine": { + "recommendationStatus": "Ready", + "numberOfServerBlockerIssues": 0, + "targetSku": { + "category": { + "availableVmSkus": [ + "Standard_D16as_v4", + "Standard_D2as_v4", + "Standard_D32as_v4", + "Standard_D48as_v4", + "Standard_D4as_v4", + "Standard_D64as_v4", + "Standard_D8as_v4", + "Standard_D96as_v4" + ], + "virtualMachineFamily": "standardDASv4Family" + } + }, + "monthlyCost": { + "computeCost": 81.98, + "storageCost": 2.4, + "totalCost": 84.38 + } + } + } + } + }, + "clientConnection": { + "enabled": false + }, + "serviceType": "Engine" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstanceJobsStatus.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstanceJobsStatus.json new file mode 100644 index 000000000000..6c842f3989d0 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstanceJobsStatus.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlserver", + "api-version": "2024-05-01-preview", + "SqlServerInstanceJobsStatusRequest": { + "featureName": "MigrationAssessment", + "jobType": "Ondemand" + } + }, + "responses": { + "200": { + "body": { + "jobsStatus": [ + { + "id": "/subscriptions/a5082b19-8a6e-4bc5-8fdd-8ef39dfebc39/resourceGroups/alzahedi-rg-easyup/providers/Microsoft.AzureArcData/sqlServerInstances/arcee-dev/jobs/235e045f:2D5237:2D38eb:2Db8fa:2Df0f549d1d7d9MigrationJobOnDemand", + "instanceName": "MSSQLSERVER", + "jobStatus": "Failed", + "jobException": "Something went wrong in collection suitability", + "backgroundJob": { + "state": "Completed", + "executionState": "Waiting", + "startTime": "2024-02-22T00:04:06.88265-08:00", + "endTime": "2024-03-15T02:04:06.88265-07:00", + "lastExecutionTime": "2024-02-22T21:18:21.6083558-08:00", + "lastExecutionStatus": "Succeeded" + }, + "sequencerActions": [ + { + "actionId": ":2Fsubscriptions:2Fa5082b19:2D8a6e:2D4bc5:2D8fdd:2D8ef39dfebc39:2FresourceGroups:2Falzahedi:2Drg:2Deasyup:2Fproviders:2FMicrosoft:2EAzureArcData:2FsqlServerInstances:2Farcee:2Ddev:2Faction:2FMicrosoft:2ESqlServer:2EManagement:2EMigrationAssessmentPlugin:2EActions:2ERunOnDemandMigrationJob", + "state": "Completed", + "result": "Failed" + }, + { + "actionId": "system.last", + "state": "Completed", + "result": "Succeeded" + }, + { + "actionId": "system.first", + "state": "Completed", + "result": "Succeeded" + } + ] + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstanceTelemetry.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstanceTelemetry.json new file mode 100644 index 000000000000..ee83800f4427 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstanceTelemetry.json @@ -0,0 +1,154 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlserver", + "api-version": "2024-05-01-preview", + "sqlServerInstanceTelemetryRequest": { + "datasetName": "sqlserver_storage_io", + "startTime": "2023-09-30T00:00:00Z" + } + }, + "responses": { + "200": { + "body": { + "columns": [ + { + "name": "row_id", + "type": "int" + }, + { + "name": "sample_time_utc", + "type": "datetime" + }, + { + "name": "database_id", + "type": "int" + }, + { + "name": "database_name", + "type": "string" + }, + { + "name": "file_id", + "type": "int" + }, + { + "name": "file_type", + "type": "string" + }, + { + "name": "file_size_mb", + "type": "double" + }, + { + "name": "file_max_size_mb", + "type": "double" + }, + { + "name": "io_stall_read_ms", + "type": "int" + }, + { + "name": "num_of_reads", + "type": "int" + }, + { + "name": "num_of_bytes_read", + "type": "int" + }, + { + "name": "io_stall_write_ms", + "type": "int" + }, + { + "name": "num_of_writes", + "type": "int" + }, + { + "name": "num_of_bytes_written", + "type": "int" + }, + { + "name": "io_stall_queued_read_ms", + "type": "int" + }, + { + "name": "io_stall_queued_write_ms", + "type": "int" + }, + { + "name": "size_on_disk_bytes", + "type": "int" + } + ], + "rows": [ + [ + "1", + "2023-09-30T00:00:00Z", + "1", + "master", + "1", + "Data", + "21.9375", + "0", + "88", + "56", + "3473408", + "2", + "3", + "24576", + "0", + "0", + "23003136" + ], + [ + "2", + "2023-09-30T00:00:00Z", + "5", + "arcDb", + "2", + "Log", + "0.625", + "0", + "12", + "11", + "208896", + "5989", + "853", + "3506176", + "0", + "0", + "4653056" + ], + [ + "3", + "2023-09-30T00:00:00Z", + "2", + "model", + "1", + "Data", + "4.4375", + "0", + "65", + "59", + "3284992", + "279", + "661", + "5922816", + "0", + "0", + "4653056" + ] + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/servers/testsqlserver/getTelemetry?api-version=2024-05-01-preview" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.AzureArcData/locations/eastus2euap/operationStatuses/5abb198d-cc4b-46bd-9e6c-e3f0ba22015d?api-version=2024-05-01-preview", + "Location": "https://management.azure.com/providers/Microsoft.AzureArcData/locations/eastus2euap/operationStatuses/5abb198d-cc4b-46bd-9e6c-e3f0ba22015d?api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerLicense.json new file mode 100644 index 000000000000..10bc31bf0341 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerLicense.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerLicenseName": "testsqlServerLicense", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "billingPlan": "PAYG", + "licenseCategory": "Core", + "physicalCores": 24, + "activationState": "Deactivated", + "scopeType": "Subscription", + "lastActivatedAt": "2020-01-01T17:18:19.1234567Z", + "lastDeactivatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerLicenses/testsqlServerLicense", + "name": "testsqlServerLicense", + "type": "Microsoft.AzureArcData/SqlServerLicenses" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByDataControllerActiveDirectoryConnector.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByDataControllerActiveDirectoryConnector.json new file mode 100644 index 000000000000..7749ce11b070 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByDataControllerActiveDirectoryConnector.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2024-05-01-preview", + "dataControllerName": "testdataController" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "spec": { + "activeDirectory": { + "realm": "CONTOSO.LOCAL", + "serviceAccountProvisioning": "manual", + "domainControllers": { + "primaryDomainController": { + "hostname": "dc1.contoso.local" + }, + "secondaryDomainControllers": [ + { + "hostname": "dc2.contoso.local" + }, + { + "hostname": "dc3.contoso.local" + } + ] + }, + "netbiosDomainName": "CONTOSO" + }, + "dns": { + "nameserverIPAddresses": [ + "11.11.111.111", + "22.22.222.222" + ], + "replicas": 1, + "preferK8sDnsForPtrLookups": false, + "domainName": "contoso.local" + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController/activeDirectoryConnectors/testADConnector1", + "name": "testADConnector1", + "type": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors" + }, + { + "properties": { + "spec": { + "activeDirectory": { + "realm": "CONTOSO.LOCAL", + "serviceAccountProvisioning": "manual", + "domainControllers": { + "primaryDomainController": { + "hostname": "dc4.contoso.local" + }, + "secondaryDomainControllers": [ + { + "hostname": "dc5.contoso.local" + }, + { + "hostname": "dc6.contoso.local" + } + ] + }, + "netbiosDomainName": "CONTOSO" + }, + "dns": { + "nameserverIPAddresses": [ + "11.11.111.111", + "22.22.222.222" + ], + "replicas": 1, + "preferK8sDnsForPtrLookups": false, + "domainName": "contoso.local" + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController/activeDirectoryConnectors/testADConnector2", + "name": "testADConnector2", + "type": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupDataController.json new file mode 100644 index 000000000000..e0c0038311ef --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupDataController.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "metricsDashboardCredential": { + "username": "username" + }, + "logsDashboardCredential": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController1", + "name": "testdataController1", + "type": "Microsoft.AzureArcData/dataControllers" + }, + { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController2", + "name": "testdataController2", + "type": "Microsoft.AzureArcData/dataControllers" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupPostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupPostgresInstance.json new file mode 100644 index 000000000000..e2459f3ecc1f --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupPostgresInstance.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstances/testpostgresInstances1", + "name": "testpostgresInstances1", + "type": "Microsoft.AzureArcData/PostgresInstances" + }, + { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstances/testpostgresInstances2", + "name": "testpostgresInstances2", + "type": "Microsoft.AzureArcData/PostgresInstances" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlManagedInstance.json new file mode 100644 index 000000000000..ffc87618e06d --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlManagedInstance.json @@ -0,0 +1,162 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "activeDirectoryInformation": { + "keytabInformation": {} + }, + "licenseType": "LicenseIncluded", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/sqlManagedInstance1", + "name": "sqlManagedInstances1", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + }, + { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "activeDirectoryInformation": { + "keytabInformation": {} + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + }, + "security": { + "adminLoginSecret": "test-sql-login-secret", + "serviceCertificateSecret": "Service Certificate Secret", + "activeDirectory": { + "connector": { + "name": "Name of connector", + "namespace": "Namespace of connector" + }, + "accountName": "Account name", + "keytabSecret": "Key tab secret of account", + "encryptionTypes": [ + "Encryption type item1, Encryption type item2,..." + ] + }, + "transparentDataEncryption": { + "mode": "SystemManaged" + } + }, + "settings": { + "network": { + "forceencryption": 0, + "tlsciphers": "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384", + "tlsprotocols": "1.2" + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/sqlManagedInstance2", + "name": "sqlManagedInstances2", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerEsuLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerEsuLicense.json new file mode 100644 index 000000000000..fe027b0ea133 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerEsuLicense.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "billingPlan": "PAYG", + "version": "SQL Server 2012", + "uniqueId": "00000000-1111-2222-3333-444444444444", + "physicalCores": 24, + "activationState": "Inactive", + "scopeType": "Subscription", + "activatedAt": "2020-01-01T17:18:19.1234567Z", + "terminatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/sqlServerEsuLicense1", + "name": "sqlServerEsuLicense1", + "type": "Microsoft.AzureArcData/sqlServerEsuLicenses" + }, + { + "properties": { + "billingPlan": "PAYG", + "version": "SQL Server 2012", + "uniqueId": "00000000-1111-2222-3333-444444444444", + "physicalCores": 24, + "activationState": "Inactive", + "scopeType": "Subscription", + "activatedAt": "2020-01-01T17:18:19.1234567Z", + "terminatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/sqlServerEsuLicense2", + "name": "sqlServerEsuLicense2", + "type": "Microsoft.AzureArcData/sqlServerEsuLicenses" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerInstance.json new file mode 100644 index 000000000000..c25935323139 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerInstance.json @@ -0,0 +1,248 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "version": "SQL Server 2012", + "edition": "Developer", + "containerResourceId": "Resource id of hosting Arc Machine", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2012", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "status": "Registered", + "hostType": "Physical Server", + "lastInventoryUploadTime": "2023-03-29T14:13:12Z", + "lastUsageUploadTime": "2023-03-29T14:13:12Z", + "alwaysOnRole": "FailoverClusterInstance", + "failoverCluster": { + "id": "f836af7e-85ed-4ea4-91fb-67709b34e323", + "networkName": "networkNameOfSQLFCI", + "sqlInstanceIds": [ + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer1", + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer2" + ], + "hostNames": [ + "DEV-HOSTNAME1", + "DEV-HOSTNAME2" + ] + }, + "databaseMirroringEndpoint": { + "endpointName": "testMirroringEndpoint", + "role": "PARTNER", + "isEncryptionEnabled": true, + "encryptionAlgorithm": "AES", + "connectionAuth": "Certificate", + "port": 12345, + "isDynamicPort": false, + "ipAddress": "123.124.125.126", + "certificateName": "testCertificateName" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "monitoring": { + "enabled": false + }, + "migration": { + "assessment": { + "enabled": true, + "assessmentUploadTime": "2024-03-15T00:16:11.0000000Z", + "serverAssessments": [ + { + "appliesToMigrationTargetPlatform": "AzureSqlDatabase", + "featureId": "TraceFlags", + "impactedObjects": [ + { + "impactDetail": "", + "name": "8017", + "objectType": "TraceFlag" + } + ], + "issueCategory": "Warning", + "moreInformation": "Resolving Transact-SQL differences during migration to SQL Database" + }, + { + "appliesToMigrationTargetPlatform": "AzureSqlManagedInstance", + "featureId": "TraceFlags", + "impactedObjects": [ + { + "impactDetail": "", + "name": "8017", + "objectType": "TraceFlag" + } + ], + "issueCategory": "Warning", + "moreInformation": "Trace Flags" + } + ], + "skuRecommendationResults": { + "azureSqlDatabase": { + "recommendationStatus": "Ready", + "numberOfServerBlockerIssues": 0, + "targetSku": { + "category": { + "computeTier": "Provisioned", + "hardwareType": "Gen5", + "sqlPurchasingModel": "vCore", + "sqlServiceTier": "General Purpose", + "zoneRedundancyAvailable": false + } + }, + "monthlyCost": { + "computeCost": 245.13, + "storageCost": 0.18, + "totalCost": 245.31 + } + }, + "azureSqlManagedInstance": { + "recommendationStatus": "Ready", + "numberOfServerBlockerIssues": 0, + "targetSku": { + "category": { + "computeTier": "Provisioned", + "hardwareType": "Gen5", + "sqlPurchasingModel": "vCore", + "sqlServiceTier": "General Purpose", + "zoneRedundancyAvailable": false + } + }, + "monthlyCost": { + "computeCost": 490.26, + "storageCost": 0, + "totalCost": 490.26 + } + }, + "azureSqlVirtualMachine": { + "recommendationStatus": "Ready", + "numberOfServerBlockerIssues": 0, + "targetSku": { + "category": { + "availableVmSkus": [ + "Standard_D16as_v4", + "Standard_D2as_v4", + "Standard_D32as_v4", + "Standard_D48as_v4", + "Standard_D4as_v4", + "Standard_D64as_v4", + "Standard_D8as_v4", + "Standard_D96as_v4" + ], + "virtualMachineFamily": "standardDASv4Family" + } + }, + "monthlyCost": { + "computeCost": 81.98, + "storageCost": 2.4, + "totalCost": 84.38 + } + } + } + } + }, + "clientConnection": { + "enabled": false + }, + "serviceType": "Engine" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServerInstance1", + "name": "sqlServerInstance1", + "type": "Microsoft.AzureArcData/SqlServerInstances" + }, + { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "status": "Connected", + "upgradeLockedUntil": "2022-05-05T16:26:33.883Z", + "monitoring": { + "enabled": false + }, + "migration": { + "assessment": { + "enabled": false + } + }, + "clientConnection": { + "enabled": false + }, + "serviceType": "SSRS" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServerInstance2", + "name": "sqlServerInstance2", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerLicense.json new file mode 100644 index 000000000000..0aec26805c32 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerLicense.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "billingPlan": "PAYG", + "licenseCategory": "Core", + "physicalCores": 24, + "activationState": "Deactivated", + "scopeType": "Subscription", + "lastActivatedAt": "2020-01-01T17:18:19.1234567Z", + "lastDeactivatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerLicenses/sqlServerLicense1", + "name": "sqlServerLicense1", + "type": "Microsoft.AzureArcData/SqlServerLicenses" + }, + { + "properties": { + "billingPlan": "PAYG", + "licenseCategory": "Core", + "physicalCores": 24, + "activationState": "Deactivated", + "scopeType": "Subscription", + "lastActivatedAt": "2020-01-01T17:18:19.1234567Z", + "lastDeactivatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerLicenses/sqlServerLicense2", + "name": "sqlServerLicense2", + "type": "Microsoft.AzureArcData/SqlServerLicenses" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlManagedInstanceFailoverGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlManagedInstanceFailoverGroup.json new file mode 100644 index 000000000000..f65fbde5de33 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlManagedInstanceFailoverGroup.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2024-05-01-preview", + "sqlManagedInstanceName": "testSqlManagedInstance" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/partnerMI", + "spec": { + "sharedName": "testSharedName", + "sourceMI": "sourceSQLMI", + "partnerMI": "partnerMI", + "partnerMirroringURL": "11.11.111.111:1111", + "partnerMirroringCert": "testCert", + "partnerSyncMode": "async", + "role": "primary" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testSqlManagedInstance/failoverGroups/testFailoverGroupName", + "name": "testFailoverGroupName", + "type": "Microsoft.AzureArcData/sqlManagedInstances/failoverGroups" + }, + { + "properties": { + "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/partnerMI", + "spec": { + "sharedName": "testSharedName", + "sourceMI": "sourceSQLMI", + "partnerMI": "partnerMI", + "partnerMirroringURL": "11.11.111.111:1111", + "partnerMirroringCert": "testCert", + "partnerSyncMode": "async", + "role": "primary" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testSqlManagedInstance/failoverGroups/testFailoverGroupName", + "name": "testFailoverGroupName", + "type": "Microsoft.AzureArcData/sqlManagedInstances/failoverGroups" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlServerInstanceAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlServerInstanceAvailabilityGroup.json new file mode 100644 index 000000000000..fe6cdaa40f73 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlServerInstanceAvailabilityGroup.json @@ -0,0 +1,215 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "collectionTimestamp": "2022-05-05T16:26:33.883Z", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "automatedBackupPreferenceDescription": "SECONDARY", + "version": 0, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "clusterTypeDescription": "WSFC", + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "primaryReplica": "testSqlServer\\INST1", + "primaryRecoveryHealthDescription": "ONLINE", + "secondaryRecoveryHealthDescription": null, + "synchronizationHealthDescription": "HEALTHY", + "replicationPartnerType": null + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + }, + { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG1", + "name": "testAG1", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "collectionTimestamp": "2022-05-05T16:26:33.883Z", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "automatedBackupPreferenceDescription": "SECONDARY", + "version": 0, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "clusterTypeDescription": "WSFC", + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "primaryReplica": "testSqlServer\\INST1", + "primaryRecoveryHealthDescription": "ONLINE", + "secondaryRecoveryHealthDescription": null, + "synchronizationHealthDescription": "HEALTHY" + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlServerInstanceDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlServerInstanceDatabase.json new file mode 100644 index 000000000000..b7d6fe6058ed --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlServerInstanceDatabase.json @@ -0,0 +1,167 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServerInstance", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/testdb", + "name": "testdb", + "type": "Microsoft.AzureArcData/sqlServerInstances/databases", + "properties": { + "collationName": "SQL_Latin1_General_CP1_CI_AS", + "databaseCreationDate": "2022-04-05T16:26:33.883Z", + "compatibilityLevel": 150, + "state": "Online", + "isReadOnly": true, + "recoveryMode": "Full", + "sizeMB": 150.00, + "spaceAvailableMB": 100.00, + "databaseOptions": { + "isAutoCloseOn": true, + "isAutoShrinkOn": true, + "isAutoCreateStatsOn": true, + "isAutoUpdateStatsOn": true, + "isMemoryOptimizationEnabled": true, + "isRemoteDataArchiveEnabled": true, + "isEncrypted": true, + "isTrustworthyOn": true + }, + "backupInformation": { + "lastFullBackup": "2022-05-05T16:26:33.883Z", + "lastLogBackup": "2022-05-10T16:26:33.883Z" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "migration": { + "assessment": { + "assessmentUploadTime": "2024-03-15T00:14:52.0000000Z", + "databaseAssessments": [ + { + "appliesToMigrationTargetPlatform": "AzureSqlDatabase", + "featureId": "ServiceBroker", + "issueCategory": "Issue", + "moreInformation": "" + } + ], + "targetReadiness": { + "azureSqlDatabase": { + "numOfBlockerIssues": 0, + "recommendationStatus": "NotReady" + }, + "azureSqlManagedInstance": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + }, + "azureSqlVirtualMachine": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + } + } + } + }, + "earliestRestoreDate": "2022-05-10T16:26:33.883Z", + "lastDatabaseUploadTime": "2023-03-29T14:13:12Z", + "createMode": "PointInTimeRestore", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/MyDatabase", + "restorePointInTime": "2022-05-05T16:26:33.883Z" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + }, + { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/testdb1", + "name": "testdb1", + "type": "Microsoft.AzureArcData/sqlServerInstances/databases", + "properties": { + "collationName": "SQL_Latin1_General_CP1_CI_AS", + "databaseCreationDate": "2022-04-05T16:26:33.883Z", + "compatibilityLevel": 150, + "state": "Online", + "isReadOnly": true, + "recoveryMode": "Full", + "sizeMB": 150.00, + "spaceAvailableMB": 100.00, + "databaseOptions": { + "isAutoCloseOn": true, + "isAutoShrinkOn": true, + "isAutoCreateStatsOn": true, + "isAutoUpdateStatsOn": true, + "isMemoryOptimizationEnabled": true, + "isRemoteDataArchiveEnabled": true, + "isEncrypted": true, + "isTrustworthyOn": true + }, + "backupInformation": { + "lastFullBackup": "2022-05-05T16:26:33.883Z", + "lastLogBackup": "2022-05-10T16:26:33.883Z" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "migration": { + "assessment": { + "assessmentUploadTime": "2024-03-15T00:14:52.0000000Z", + "databaseAssessments": [], + "targetReadiness": { + "azureSqlDatabase": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + }, + "azureSqlManagedInstance": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + }, + "azureSqlVirtualMachine": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + } + } + } + }, + "earliestRestoreDate": "2022-05-10T16:26:33.883Z", + "lastDatabaseUploadTime": "2023-03-29T14:13:12Z", + "createMode": "PointInTimeRestore", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/MyDatabase", + "restorePointInTime": "2022-05-05T16:26:33.883Z" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListOperation.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListOperation.json new file mode 100644 index 000000000000..02c537b07e1b --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListOperation.json @@ -0,0 +1,353 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AzureArcData/Locations/OperationStatuses/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "Locations/OperationStatuses", + "operation": "read_OperationStatuses", + "description": "read OperationStatuses" + } + }, + { + "name": "Microsoft.AzureArcData/Locations/OperationStatuses/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "Locations/OperationStatuses", + "operation": "write_OperationStatuses", + "description": "write OperationStatuses" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers", + "operation": "DataControllers_ListInSubscription", + "description": "read dataControllers" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers", + "operation": "DataControllers_ListInGroup", + "description": "read dataControllers" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers", + "operation": "DataControllers_GetDataController", + "description": "Retrieves a dataController resource" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers", + "operation": "DataControllers_PutDataController", + "description": "Creates or replaces a dataController resource" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers", + "operation": "DataControllers_DeleteDataController", + "description": "Deletes a dataController resource" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers", + "operation": "DataControllers_PatchDataController", + "description": "Updates a dataController resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlManagedInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlManagedInstances", + "operation": "SqlManagedInstances_List", + "description": "read sqlManagedInstances" + } + }, + { + "name": "Microsoft.AzureArcData/sqlManagedInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlManagedInstances", + "operation": "SqlManagedInstances_ListByResourceGroup", + "description": "Gets all sqlManagedInstances in a resource group." + } + }, + { + "name": "Microsoft.AzureArcData/sqlManagedInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlManagedInstances", + "operation": "SqlManagedInstances_Get", + "description": "Retrieves a SQL Managed Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlManagedInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlManagedInstances", + "operation": "SqlManagedInstances_Create", + "description": "Creates or replaces a SQL Managed Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlManagedInstances/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlManagedInstances", + "operation": "SqlManagedInstances_Delete", + "description": "Deletes a SQL Managed Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlManagedInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlManagedInstances", + "operation": "SqlManagedInstances_Update", + "description": "Updates a SQL Managed Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances", + "operation": "SqlServerInstances_List", + "description": "read sqlServerInstances" + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances", + "operation": "SqlServerInstances_ListByResourceGroup", + "description": "Gets all sqlServerInstances in a resource group." + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances", + "operation": "SqlServerInstances_Get", + "description": "Retrieves a SQL Server Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances", + "operation": "SqlServerInstances_Create", + "description": "Creates or replaces a SQL Server Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances", + "operation": "SqlServerInstances_Delete", + "description": "Deletes a SQL Server Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/databases/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances/databases", + "operation": "SqlServerDatabases_List", + "description": "List all database resources in a Sql Server Instance." + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/databases/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances/databases", + "operation": "SqlServerDatabases_Get", + "description": "Retrieves a database resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/databases/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances/databases", + "operation": "SqlServerDatabases_Create", + "description": "Creates or updates a database resource." + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/databases/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances/databases", + "operation": "SqlServerDatabases_Delete", + "description": "Deletes a database resource." + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances", + "operation": "SqlServerInstances_Update", + "description": "Updates a SQL Server Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers/activeDirectoryConnectors", + "operation": "ActiveDirectoryConnectors_List", + "description": "read activeDirectoryConnectors" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers/activeDirectoryConnectors", + "operation": "ActiveDirectoryConnectors_Get", + "description": "Retrieves an active directory connector resource" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers/activeDirectoryConnectors", + "operation": "ActiveDirectoryConnectors_Create", + "description": "Creates or replaces an active directory connector resource." + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers/activeDirectoryConnectors", + "operation": "ActiveDirectoryConnectors_Delete", + "description": "Deletes an active directory connector resource" + } + }, + { + "name": "Microsoft.AzureArcData/postgresInstances/read", + "isDataAction": false, + "display": { + "resource": "Microsoft.AzureArcData", + "provider": "Azure Arc Data Resource Provider.", + "operation": "Get Postgres Instance details.", + "description": "Retrieves details of Postgres Instances." + } + }, + { + "name": "Microsoft.AzureArcData/postgresInstances/write", + "isDataAction": false, + "display": { + "resource": "Microsoft.AzureArcData", + "provider": "Azure Arc Data Resource Provider.", + "operation": "Create new or update existing Postgres Instances.", + "description": "Create a new or change properties of existing Postgres Instances." + } + }, + { + "name": "Microsoft.AzureArcData/postgresInstances/delete", + "isDataAction": false, + "display": { + "resource": "Microsoft.AzureArcData", + "provider": "Azure Arc Data Resource Provider.", + "operation": "Delete exisiting Postgres Instances.", + "description": "Delete exisiting Postgres Instances." + } + }, + { + "name": "Microsoft.AzureArcData/register/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "Microsoft.AzureArcData", + "operation": "Register the Microsoft.AzureArcData", + "description": "Register the subscription for Microsoft.AzureArcData" + } + }, + { + "name": "Microsoft.AzureArcData/unregister/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "Microsoft.AzureArcData", + "operation": "Unregister the Microsoft.AzureArcData", + "description": "Unregister the subscription for Microsoft.AzureArcData" + } + }, + { + "name": "Microsoft.AzureArcData/Operations/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "Operations", + "operation": "read_Operations", + "description": "read Operations" + } + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionDataController.json new file mode 100644 index 000000000000..d72082c3a742 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionDataController.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "metricsDashboardCredential": { + "username": "username" + }, + "logsDashboardCredential": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController1", + "name": "testdataController1", + "type": "Microsoft.AzureArcData/dataControllers" + }, + { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "metricsDashboardCredential": { + "username": "username" + }, + "logsDashboardCredential": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension" + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController2", + "name": "testdataController2", + "type": "Microsoft.AzureArcData/dataControllers" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionPostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionPostgresInstance.json new file mode 100644 index 000000000000..fc076ad558ea --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionPostgresInstance.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstances/testpostgresInstances1", + "name": "testpostgresInstances1", + "type": "Microsoft.AzureArcData/PostgresInstances" + }, + { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstances/testpostgresInstances2", + "name": "testpostgresInstances2", + "type": "Microsoft.AzureArcData/PostgresInstances" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlManagedInstance.json new file mode 100644 index 000000000000..3f125efbd360 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlManagedInstance.json @@ -0,0 +1,163 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "activeDirectoryInformation": { + "keytabInformation": {} + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + }, + "security": { + "adminLoginSecret": "test-sql-login-secret", + "serviceCertificateSecret": "Service Certificate Secret", + "activeDirectory": { + "connector": { + "name": "Name of connector", + "namespace": "Namespace of connector" + }, + "accountName": "Account name", + "keytabSecret": "Key tab secret of account", + "encryptionTypes": [ + "Encryption type item1, Encryption type item2,..." + ] + }, + "transparentDataEncryption": { + "mode": "SystemManaged" + } + }, + "settings": { + "network": { + "forceencryption": 0, + "tlsciphers": "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384", + "tlsprotocols": "1.2" + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlManagedInstances/sqlManagedInstance1", + "name": "sqlManagedInstances1", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + }, + { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "activeDirectoryInformation": { + "keytabInformation": {} + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlManagedInstances/sqlManagedInstance2", + "name": "sqlManagedInstances2", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerEsuLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerEsuLicense.json new file mode 100644 index 000000000000..d75e8e6a340a --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerEsuLicense.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "billingPlan": "PAYG", + "version": "SQL Server 2012", + "uniqueId": "00000000-1111-2222-3333-444444444444", + "physicalCores": 24, + "activationState": "Inactive", + "scopeType": "Subscription", + "activatedAt": "2020-01-01T17:18:19.1234567Z", + "terminatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/sqlServerEsuLicense1", + "name": "sqlServerEsuLicense1", + "type": "Microsoft.AzureArcData/sqlServerEsuLicenses" + }, + { + "properties": { + "billingPlan": "PAYG", + "version": "SQL Server 2012", + "uniqueId": "00000000-1111-2222-3333-444444444444", + "physicalCores": 24, + "activationState": "Inactive", + "scopeType": "Subscription", + "activatedAt": "2020-01-01T17:18:19.1234567Z", + "terminatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/sqlServerEsuLicense2", + "name": "sqlServerEsuLicense2", + "type": "Microsoft.AzureArcData/sqlServerEsuLicenses" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerInstance.json new file mode 100644 index 000000000000..28097d806c6e --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerInstance.json @@ -0,0 +1,249 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "version": "SQL Server 2012", + "edition": "Developer", + "containerResourceId": "Resource id of hosting Arc Machine", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "status": "Registered", + "hostType": "Physical Server", + "lastInventoryUploadTime": "2023-03-29T14:13:12Z", + "lastUsageUploadTime": "2023-03-29T14:13:12Z", + "alwaysOnRole": "FailoverClusterInstance", + "failoverCluster": { + "id": "f836af7e-85ed-4ea4-91fb-67709b34e323", + "networkName": "networkNameOfSQLFCI", + "sqlInstanceIds": [ + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer1", + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer2" + ], + "hostNames": [ + "DEV-HOSTNAME1", + "DEV-HOSTNAME2" + ] + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "upgradeLockedUntil": "2022-05-05T16:26:33.883Z", + "monitoring": { + "enabled": false + }, + "migration": { + "assessment": { + "enabled": false + } + }, + "clientConnection": { + "enabled": false + }, + "serviceType": "Engine" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServerInstance1", + "name": "sqlServerInstance1", + "type": "Microsoft.AzureArcData/SqlServerInstances" + }, + { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "lastInventoryUploadTime": "2023-03-29T14:13:12Z", + "lastUsageUploadTime": "2023-03-29T14:13:12Z", + "status": "Connected", + "databaseMirroringEndpoint": { + "endpointName": "testMirroringEndpoint", + "role": "PARTNER", + "isEncryptionEnabled": true, + "encryptionAlgorithm": "AES", + "connectionAuth": "Certificate", + "port": 12345, + "isDynamicPort": false, + "ipAddress": "123.124.125.126", + "certificateName": "testCertificateName" + }, + "monitoring": { + "enabled": false + }, + "migration": { + "assessment": { + "enabled": true, + "assessmentUploadTime": "2024-03-15T00:16:11.0000000Z", + "serverAssessments": [ + { + "appliesToMigrationTargetPlatform": "AzureSqlDatabase", + "featureId": "TraceFlags", + "impactedObjects": [ + { + "impactDetail": "", + "name": "8017", + "objectType": "TraceFlag" + } + ], + "issueCategory": "Warning", + "moreInformation": "Resolving Transact-SQL differences during migration to SQL Database" + }, + { + "appliesToMigrationTargetPlatform": "AzureSqlManagedInstance", + "featureId": "TraceFlags", + "impactedObjects": [ + { + "impactDetail": "", + "name": "8017", + "objectType": "TraceFlag" + } + ], + "issueCategory": "Warning", + "moreInformation": "Trace Flags" + } + ], + "skuRecommendationResults": { + "azureSqlDatabase": { + "recommendationStatus": "Ready", + "numberOfServerBlockerIssues": 0, + "targetSku": { + "category": { + "computeTier": "Provisioned", + "hardwareType": "Gen5", + "sqlPurchasingModel": "vCore", + "sqlServiceTier": "General Purpose", + "zoneRedundancyAvailable": false + } + }, + "monthlyCost": { + "computeCost": 245.13, + "storageCost": 0.18, + "totalCost": 245.31 + } + }, + "azureSqlManagedInstance": { + "recommendationStatus": "Ready", + "numberOfServerBlockerIssues": 0, + "targetSku": { + "category": { + "computeTier": "Provisioned", + "hardwareType": "Gen5", + "sqlPurchasingModel": "vCore", + "sqlServiceTier": "General Purpose", + "zoneRedundancyAvailable": false + } + }, + "monthlyCost": { + "computeCost": 490.26, + "storageCost": 0, + "totalCost": 490.26 + } + }, + "azureSqlVirtualMachine": { + "recommendationStatus": "Ready", + "numberOfServerBlockerIssues": 0, + "targetSku": { + "category": { + "availableVmSkus": [ + "Standard_D16as_v4", + "Standard_D2as_v4", + "Standard_D32as_v4", + "Standard_D48as_v4", + "Standard_D4as_v4", + "Standard_D64as_v4", + "Standard_D8as_v4", + "Standard_D96as_v4" + ], + "virtualMachineFamily": "standardDASv4Family" + } + }, + "monthlyCost": { + "computeCost": 81.98, + "storageCost": 2.4, + "totalCost": 84.38 + } + } + } + } + }, + "clientConnection": { + "enabled": false + }, + "serviceType": "SSRS" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServerInstance2", + "name": "sqlServerInstance2", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerLicense.json new file mode 100644 index 000000000000..3628189c69cc --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerLicense.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "billingPlan": "PAYG", + "licenseCategory": "Core", + "physicalCores": 24, + "activationState": "Deactivated", + "scopeType": "Subscription", + "lastActivatedAt": "2020-01-01T17:18:19.1234567Z", + "lastDeactivatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerLicenses/sqlServerLicense1", + "name": "sqlServerLicense1", + "type": "Microsoft.AzureArcData/SqlServerLicenses" + }, + { + "properties": { + "billingPlan": "PAYG", + "licenseCategory": "Core", + "physicalCores": 24, + "activationState": "Deactivated", + "scopeType": "Subscription", + "lastActivatedAt": "2020-01-01T17:18:19.1234567Z", + "lastDeactivatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerLicenses/sqlServerLicense2", + "name": "sqlServerLicense2", + "type": "Microsoft.AzureArcData/SqlServerLicenses" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/PostUpgradeSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/PostUpgradeSqlServerInstance.json new file mode 100644 index 000000000000..1b61623f7a4d --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/PostUpgradeSqlServerInstance.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "version": "SQL Server 2012", + "edition": "Developer", + "containerResourceId": "Resource id of hosting Arc Machine", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2012", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "status": "Registered", + "hostType": "Physical Server", + "lastInventoryUploadTime": "2023-03-29T14:13:12Z", + "alwaysOnRole": "FailoverClusterInstance", + "failoverCluster": { + "id": "f836af7e-85ed-4ea4-91fb-67709b34e323", + "networkName": "networkNameOfSQLFCI", + "sqlInstanceIds": [ + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer1", + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer2" + ], + "hostNames": [ + "DEV-HOSTNAME1", + "DEV-HOSTNAME2" + ] + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "upgradeLockedUntil": "2022-05-05T16:26:33.883Z", + "serviceType": "Engine" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/PreUpgradeSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/PreUpgradeSqlServerInstance.json new file mode 100644 index 000000000000..1b61623f7a4d --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/PreUpgradeSqlServerInstance.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "version": "SQL Server 2012", + "edition": "Developer", + "containerResourceId": "Resource id of hosting Arc Machine", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2012", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "status": "Registered", + "hostType": "Physical Server", + "lastInventoryUploadTime": "2023-03-29T14:13:12Z", + "alwaysOnRole": "FailoverClusterInstance", + "failoverCluster": { + "id": "f836af7e-85ed-4ea4-91fb-67709b34e323", + "networkName": "networkNameOfSQLFCI", + "sqlInstanceIds": [ + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer1", + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer2" + ], + "hostNames": [ + "DEV-HOSTNAME1", + "DEV-HOSTNAME2" + ] + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "upgradeLockedUntil": "2022-05-05T16:26:33.883Z", + "serviceType": "Engine" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/RemoveDatabasesFromAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/RemoveDatabasesFromAvailabilityGroup.json new file mode 100644 index 000000000000..aa30961dbe28 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/RemoveDatabasesFromAvailabilityGroup.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "availabilityGroupName": "testAG", + "databases": { + "values": [ + "db1" + ] + }, + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "collectionTimestamp": "2022-05-05T16:26:33.883Z", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "automatedBackupPreferenceDescription": "SECONDARY", + "version": 0, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "clusterTypeDescription": "WSFC", + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "primaryReplica": "testSqlServer\\INST1", + "primaryRecoveryHealthDescription": "ONLINE", + "secondaryRecoveryHealthDescription": null, + "synchronizationHealthDescription": "HEALTHY", + "replicationPartnerType": null + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/RunMigrationAssessmentSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/RunMigrationAssessmentSqlServerInstance.json new file mode 100644 index 000000000000..cc3d31a05092 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/RunMigrationAssessmentSqlServerInstance.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlserver", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/a5082b19-8a6e-4bc5-8fdd-8ef39dfebc39/resourceGroups/alzahedi-rg-easyup/providers/Microsoft.AzureArcData/sqlServerInstances/arcee-dev/jobs/235e045f:2D5237:2D38eb:2Db8fa:2Df0f549d1d7d9MigrationJobOnDemand", + "instanceName": "MSSQLSERVER", + "jobStatus": "InProgress", + "jobException": null, + "backgroundJob": { + "state": "Enabled", + "executionState": "Waiting", + "startTime": "2024-02-22T00:04:06.88265-08:00", + "endTime": "2024-03-15T02:04:06.88265-07:00", + "lastExecutionTime": null, + "lastExecutionStatus": null + }, + "sequencerActions": [ + { + "actionId": ":2Fsubscriptions:2Fa5082b19:2D8a6e:2D4bc5:2D8fdd:2D8ef39dfebc39:2FresourceGroups:2Falzahedi:2Drg:2Deasyup:2Fproviders:2FMicrosoft:2EAzureArcData:2FsqlServerInstances:2Farcee:2Ddev:2Faction:2FMicrosoft:2ESqlServer:2EManagement:2EMigrationAssessmentPlugin:2EActions:2ERunOnDemandMigrationJob", + "state": "NotStarted", + "result": "NotCompleted" + }, + { + "actionId": "system.last", + "state": "NotStarted", + "result": "NotCompleted" + }, + { + "actionId": "system.first", + "state": "NotStarted", + "result": "NotCompleted" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateArcSqlServerAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateArcSqlServerAvailabilityGroup.json new file mode 100644 index 000000000000..7b832da95c86 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateArcSqlServerAvailabilityGroup.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "api-version": "2024-05-01-preview", + "availabilityGroupName": "testAG", + "sqlServerAvailabilityGroupUpdate": { + "tags": { + "mytag": "myval1" + } + } + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "collectionTimestamp": "2022-05-05T16:26:33.883Z", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "automatedBackupPreferenceDescription": "SECONDARY", + "version": 0, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "clusterTypeDescription": "WSFC", + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "primaryReplica": "testSqlServer\\INST1", + "primaryRecoveryHealthDescription": "ONLINE", + "secondaryRecoveryHealthDescription": null, + "synchronizationHealthDescription": "HEALTHY", + "replicationPartnerType": null + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval1" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.AzureArcData/operationResults/id1" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateDataController.json new file mode 100644 index 000000000000..0a9f86e48554 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateDataController.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController1", + "api-version": "2024-05-01-preview", + "dataControllerResource": { + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "metricsDashboardCredential": { + "username": "username" + }, + "logsDashboardCredential": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController1", + "name": "testdataController1", + "type": "Microsoft.AzureArcData/dataControllers" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.AzureArcData/operationResults/id1" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdatePostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdatePostgresInstance.json new file mode 100644 index 000000000000..25f2a2d65b8d --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdatePostgresInstance.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "postgresInstanceName": "testpostgresInstance", + "api-version": "2024-05-01-preview", + "parameters": { + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstance/testpostgresInstance", + "name": "testpostgresInstance", + "type": "Microsoft.AzureArcData/PostgresInstance" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlManagedInstance.json new file mode 100644 index 000000000000..480c85ef5bfc --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlManagedInstance.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testsqlManagedInstance", + "api-version": "2024-05-01-preview", + "parameters": { + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "activeDirectoryInformation": { + "keytabInformation": {} + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + }, + "security": { + "adminLoginSecret": "test-sql-login-secret", + "serviceCertificateSecret": "Service Certificate Secret", + "activeDirectory": { + "connector": { + "name": "Name of connector", + "namespace": "Namespace of connector" + }, + "accountName": "Account name", + "keytabSecret": "Key tab secret of account", + "encryptionTypes": [ + "Encryption type item1, Encryption type item2,..." + ] + }, + "transparentDataEncryption": { + "mode": "SystemManaged" + } + }, + "settings": { + "network": { + "forceencryption": 0, + "tlsciphers": "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384", + "tlsprotocols": "1.2" + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testsqlManagedInstance", + "name": "testsqlManagedInstance", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerDatabase.json new file mode 100644 index 000000000000..77de4a6e8db8 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerDatabase.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlManagedInstance", + "api-version": "2024-05-01-preview", + "databaseName": "testdb", + "sqlServerDatabaseUpdate": { + "tags": { + "mytag": "myval1" + } + } + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/testdb", + "name": "testdb", + "type": "Microsoft.AzureArcData/sqlServerInstances/databases", + "properties": { + "collationName": "SQL_Latin1_General_CP1_CI_AS", + "databaseCreationDate": "2022-04-05T16:26:33.883Z", + "compatibilityLevel": 150, + "state": "Online", + "isReadOnly": true, + "recoveryMode": "Full", + "sizeMB": 150.00, + "spaceAvailableMB": 100.00, + "databaseOptions": { + "isAutoCloseOn": true, + "isAutoShrinkOn": true, + "isAutoCreateStatsOn": true, + "isAutoUpdateStatsOn": true, + "isMemoryOptimizationEnabled": true, + "isRemoteDataArchiveEnabled": true, + "isEncrypted": true, + "isTrustworthyOn": true + }, + "backupInformation": { + "lastFullBackup": "2022-05-05T16:26:33.883Z", + "lastLogBackup": "2022-05-10T16:26:33.883Z" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "migration": { + "assessment": { + "assessmentUploadTime": "2024-03-15T00:14:52.0000000Z", + "databaseAssessments": [ + { + "appliesToMigrationTargetPlatform": "AzureSqlDatabase", + "featureId": "ServiceBroker", + "issueCategory": "Issue", + "moreInformation": "" + } + ], + "targetReadiness": { + "azureSqlDatabase": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + }, + "azureSqlManagedInstance": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + }, + "azureSqlVirtualMachine": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + } + } + } + }, + "earliestRestoreDate": "2022-05-10T16:26:33.883Z", + "createMode": "PointInTimeRestore", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/MyDatabase", + "restorePointInTime": "2022-05-05T16:26:33.883Z", + "lastDatabaseUploadTime": "2023-03-29T14:13:12Z" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval1" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.AzureArcData/operationResults/id1" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerEsuLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerEsuLicense.json new file mode 100644 index 000000000000..9c8ec40997d8 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerEsuLicense.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerEsuLicenseName": "testsqlServerEsuLicense", + "api-version": "2024-05-01-preview", + "parameters": { + "properties": { + "billingPlan": "Paid", + "physicalCores": 28, + "activationState": "Active" + }, + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "billingPlan": "Paid", + "version": "SQL Server 2012", + "physicalCores": 28, + "activationState": "Active", + "scopeType": "Subscription", + "activatedAt": "2020-01-01T17:18:19.1234567Z", + "terminatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/testsqlServerEsuLicense", + "name": "testsqlServerEsuLicense", + "type": "Microsoft.AzureArcData/sqlServerEsuLicenses" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerInstance.json new file mode 100644 index 000000000000..e51b1168d586 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerInstance.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2024-05-01-preview", + "parameters": { + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "version": "SQL Server 2012", + "edition": "Developer", + "containerResourceId": "Resource id of hosting Arc Machine", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2012", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "status": "Registered", + "hostType": "Physical Server", + "lastInventoryUploadTime": "2023-03-29T14:13:12Z", + "lastUsageUploadTime": "2023-03-29T14:13:12Z", + "alwaysOnRole": "FailoverClusterInstance", + "failoverCluster": { + "id": "f836af7e-85ed-4ea4-91fb-67709b34e323", + "networkName": "networkNameOfSQLFCI", + "sqlInstanceIds": [ + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer1", + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer2" + ], + "hostNames": [ + "DEV-HOSTNAME1", + "DEV-HOSTNAME2" + ] + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "upgradeLockedUntil": "2022-05-05T16:26:33.883Z", + "serviceType": "Engine" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.AzureArcData/operationResults/id1" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerLicense.json new file mode 100644 index 000000000000..8629697226b0 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerLicense.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerLicenseName": "testsqlServerLicense", + "api-version": "2024-05-01-preview", + "parameters": { + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "billingPlan": "PAYG", + "licenseCategory": "Core", + "physicalCores": 24, + "activationState": "Deactivated", + "scopeType": "Subscription", + "lastActivatedAt": "2020-01-01T17:18:19.1234567Z", + "lastDeactivatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerLicenses/testsqlServerLicense", + "name": "testsqlServerLicense", + "type": "Microsoft.AzureArcData/SqlServerLicenses" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ViewArcSqlServerAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ViewArcSqlServerAvailabilityGroup.json new file mode 100644 index 000000000000..a329e153da55 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ViewArcSqlServerAvailabilityGroup.json @@ -0,0 +1,183 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "availabilityGroupName": "testAG", + "api-version": "2024-05-01-preview", + "sqlServerAvailabilityGroupResource": { + "location": "southeastasia", + "tags": { + "mytag": "myval" + }, + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "collectionTimestamp": "2022-05-05T16:26:33.883Z", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "automatedBackupPreferenceDescription": "SECONDARY", + "version": 0, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "clusterTypeDescription": "WSFC", + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "primaryReplica": "testSqlServer\\INST1", + "primaryRecoveryHealthDescription": "ONLINE", + "secondaryRecoveryHealthDescription": null, + "synchronizationHealthDescription": "HEALTHY", + "replicationPartnerType": null + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServerInstance", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/failoverGroups.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/failoverGroups.json new file mode 100644 index 000000000000..396d72260627 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/failoverGroups.json @@ -0,0 +1,157 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "paths": {}, + "definitions": { + "FailoverGroupListResult": { + "description": "A list of failover groups.", + "type": "object", + "properties": { + "value": { + "description": "Array of failover group results.", + "type": "array", + "items": { + "$ref": "#/definitions/FailoverGroupResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "FailoverGroupResource": { + "type": "object", + "description": "A failover group resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/FailoverGroupProperties", + "description": "null", + "x-ms-client-flatten": false + } + }, + "required": [ + "properties" + ] + }, + "FailoverGroupProperties": { + "type": "object", + "description": "The properties of a failover group resource.", + "properties": { + "provisioningState": { + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted" + ], + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + }, + "description": "The provisioning state of the failover group resource.", + "readOnly": true + }, + "partnerManagedInstanceId": { + "type": "string", + "description": "The resource ID of the partner SQL managed instance." + }, + "spec": { + "$ref": "#/definitions/FailoverGroupSpec", + "description": "The specifications of the failover group resource.", + "x-ms-client-flatten": false + }, + "status": { + "type": "object", + "description": "The status of the failover group custom resource." + } + }, + "additionalProperties": {}, + "required": [ + "partnerManagedInstanceId", + "spec" + ] + }, + "FailoverGroupSpec": { + "description": "The specifications of the failover group resource.", + "type": "object", + "properties": { + "sharedName": { + "type": "string", + "description": "The shared name of the failover group for this SQL managed instance. Both SQL managed instance and its partner have to use the same shared name." + }, + "sourceMI": { + "type": "string", + "description": "The name of the SQL managed instance with this failover group role." + }, + "partnerMI": { + "type": "string", + "description": "The name of the partner SQL managed instance." + }, + "partnerMirroringURL": { + "type": "string", + "description": "The mirroring endpoint URL of the partner SQL managed instance." + }, + "partnerMirroringCert": { + "type": "string", + "description": "The mirroring endpoint public certificate for the partner SQL managed instance. Only PEM format is supported." + }, + "partnerSyncMode": { + "type": "string", + "enum": [ + "async", + "sync" + ], + "x-ms-enum": { + "name": "failoverGroupPartnerSyncMode", + "modelAsString": true + }, + "default": "async", + "description": "The partner sync mode of the SQL managed instance." + }, + "role": { + "type": "string", + "enum": [ + "primary", + "secondary", + "force-primary-allow-data-loss", + "force-secondary" + ], + "x-ms-enum": { + "name": "instanceFailoverGroupRole", + "modelAsString": true + }, + "default": "primary", + "description": "The role of the SQL managed instance in this failover group." + } + }, + "additionalProperties": {}, + "required": [ + "role" + ] + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/operations.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/operations.json new file mode 100644 index 000000000000..70d26a7889e9 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/operations.json @@ -0,0 +1,125 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "paths": {}, + "definitions": { + "Operation": { + "description": "Azure Data Services on Azure Arc operation definition.", + "type": "object", + "properties": { + "name": { + "description": "The name of the operation being performed on this particular object.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "The localized display information for this particular operation / action." + }, + "origin": { + "description": "The intended executor of the operation.", + "enum": [ + "user", + "system" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OperationOrigin", + "modelAsString": true + } + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "properties": { + "description": "Additional descriptions for the operation.", + "type": "object", + "additionalProperties": {}, + "readOnly": true, + "x-ms-client-flatten": false + } + }, + "required": [ + "name", + "display", + "isDataAction" + ] + }, + "OperationListResult": { + "description": "Result of the request to list Azure Data Services on Azure Arc operations.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "OperationDisplay": { + "description": "Display metadata associated with the operation.", + "type": "object", + "properties": { + "provider": { + "description": "The localized friendly form of the resource provider name.", + "type": "string" + }, + "resource": { + "description": "The localized friendly form of the resource type related to this action/operation.", + "type": "string" + }, + "operation": { + "description": "The localized friendly name for the operation.", + "type": "string" + }, + "description": { + "description": "The localized friendly description for the operation.", + "type": "string" + } + }, + "required": [ + "provider", + "resource", + "operation", + "description" + ] + } + }, + "parameters": { + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/postgresInstances.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/postgresInstances.json new file mode 100644 index 000000000000..9a494464f170 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/postgresInstances.json @@ -0,0 +1,174 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "paths": {}, + "definitions": { + "PostgresInstanceSku": { + "description": "The resource model definition representing SKU for Azure Database for PostgresSQL - Azure Arc", + "type": "object", + "properties": { + "tier": { + "type": "string", + "enum": [ + "Hyperscale" + ], + "x-ms-enum": { + "name": "PostgresInstanceSkuTier", + "modelAsString": false + }, + "default": "Hyperscale", + "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier." + } + }, + "allOf": [ + { + "$ref": "./common.json#/definitions/CommonSku" + } + ] + }, + "PostgresInstanceProperties": { + "description": "Postgres Instance properties.", + "type": "object", + "properties": { + "dataControllerId": { + "type": "string", + "description": "The data controller id" + }, + "admin": { + "type": "string", + "description": "The instance admin" + }, + "basicLoginInformation": { + "$ref": "./common.json#/definitions/BasicLoginInformation", + "description": "Username and password for basic authentication." + }, + "k8sRaw": { + "type": "object", + "description": "The raw kubernetes information" + }, + "lastUploadedDate": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date from Kubernetes cluster. Defaults to current date time" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state of the Azure Arc-enabled PostgreSQL instance." + } + } + }, + "PostgresInstance": { + "description": "A Postgres Instance.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "extendedLocation": { + "$ref": "./common.json#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + }, + "properties": { + "$ref": "#/definitions/PostgresInstanceProperties", + "x-ms-client-flatten": false, + "description": "null" + }, + "sku": { + "$ref": "#/definitions/PostgresInstanceSku", + "description": "Resource sku." + } + }, + "required": [ + "properties" + ] + }, + "PostgresInstanceUpdate": { + "description": "An update to a Postgres Instance.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/PostgresInstanceProperties", + "x-ms-client-flatten": false + } + } + }, + "PostgresInstanceListResult": { + "description": "A list of PostgresInstance.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/PostgresInstance" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Azure subscription", + "x-ms-parameter-location": "client" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group", + "x-ms-parameter-location": "method" + }, + "location": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure region to use for the request", + "x-ms-parameter-location": "method" + }, + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlManagedInstances.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlManagedInstances.json new file mode 100644 index 000000000000..86050e597106 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlManagedInstances.json @@ -0,0 +1,403 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "paths": {}, + "definitions": { + "SqlManagedInstance": { + "description": "A SqlManagedInstance.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlManagedInstanceProperties", + "description": "null", + "x-ms-client-flatten": false + }, + "extendedLocation": { + "$ref": "./common.json#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + }, + "sku": { + "$ref": "#/definitions/SqlManagedInstanceSku", + "description": "Resource sku." + } + }, + "required": [ + "properties" + ] + }, + "SqlManagedInstanceSku": { + "description": "The resource model definition representing SKU for Azure Managed Instance - Azure Arc", + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "vCore" + ], + "description": "The name of the SKU.", + "x-ms-enum": { + "name": "SqlManagedInstanceSkuName", + "modelAsString": false + } + }, + "tier": { + "type": "string", + "enum": [ + "GeneralPurpose", + "BusinessCritical" + ], + "x-ms-enum": { + "name": "SqlManagedInstanceSkuTier", + "modelAsString": false + }, + "default": "GeneralPurpose", + "description": "The pricing tier for the instance." + }, + "dev": { + "type": "boolean", + "default": true, + "description": "Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose. " + }, + "size": { + "type": "string", + "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. " + }, + "family": { + "type": "string", + "description": "The SKU family" + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "The SKU capacity" + } + }, + "required": [ + "name" + ] + }, + "SqlManagedInstanceProperties": { + "description": "Properties of sqlManagedInstance.", + "type": "object", + "properties": { + "dataControllerId": { + "type": "string", + "description": "null" + }, + "admin": { + "type": "string", + "description": "The instance admin user" + }, + "startTime": { + "type": "string", + "description": "The instance start time" + }, + "endTime": { + "type": "string", + "description": "The instance end time" + }, + "k8sRaw": { + "$ref": "#/definitions/SqlManagedInstanceK8sRaw", + "description": "The raw kubernetes information" + }, + "basicLoginInformation": { + "$ref": "./common.json#/definitions/BasicLoginInformation", + "description": "Username and password for basic authentication." + }, + "lastUploadedDate": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date from Kubernetes cluster. Defaults to current date time" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state of the Arc-enabled SQL Managed Instance resource." + }, + "activeDirectoryInformation": { + "description": "Active Directory information related to this SQL Managed Instance.", + "$ref": "#/definitions/ActiveDirectoryInformation" + }, + "licenseType": { + "type": "string", + "enum": [ + "BasePrice", + "LicenseIncluded", + "DisasterRecovery" + ], + "x-ms-enum": { + "name": "arcSqlManagedInstanceLicenseType", + "modelAsString": true + }, + "default": "BasePrice", + "description": "The license type to apply for this managed instance." + }, + "clusterId": { + "type": "string", + "description": "If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to." + }, + "extensionId": { + "type": "string", + "description": "If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to." + } + } + }, + "SqlManagedInstanceUpdate": { + "description": "An update to a SQL Managed Instance.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SqlManagedInstanceK8sRaw": { + "type": "object", + "description": "The raw kubernetes information.", + "properties": { + "spec": { + "$ref": "#/definitions/SqlManagedInstanceK8sSpec" + } + }, + "additionalProperties": {} + }, + "SqlManagedInstanceK8sSpec": { + "type": "object", + "description": "The kubernetes spec information.", + "properties": { + "scheduling": { + "$ref": "#/definitions/K8sScheduling" + }, + "replicas": { + "type": "integer", + "format": "int32", + "description": "This option specifies the number of SQL Managed Instance replicas that will be deployed in your Kubernetes cluster for high availability purposes. If sku.tier is BusinessCritical, allowed values are '2' or '3' with default of '3'. If sku.tier is GeneralPurpose, replicas must be '1'." + }, + "security": { + "$ref": "#/definitions/K8sSecurity" + }, + "settings": { + "$ref": "#/definitions/K8sSettings" + } + }, + "additionalProperties": {} + }, + "K8sScheduling": { + "type": "object", + "description": "The kubernetes scheduling information.", + "properties": { + "default": { + "$ref": "#/definitions/K8sSchedulingOptions" + } + }, + "additionalProperties": {} + }, + "K8sSchedulingOptions": { + "type": "object", + "description": "The kubernetes scheduling options. It describes restrictions used to help Kubernetes select appropriate nodes to host the database service", + "properties": { + "resources": { + "$ref": "#/definitions/K8sResourceRequirements" + } + }, + "additionalProperties": {} + }, + "K8sResourceRequirements": { + "type": "object", + "description": "The kubernetes resource limits and requests used to restrict or reserve resource usage.", + "properties": { + "requests": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Requests for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'." + }, + "limits": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Limits for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'." + } + }, + "additionalProperties": {} + }, + "K8sSecurity": { + "type": "object", + "description": "The kubernetes security information.", + "properties": { + "adminLoginSecret": { + "type": "string", + "description": "Admin login secret key" + }, + "serviceCertificateSecret": { + "type": "string", + "description": "Service certificate secret used" + }, + "activeDirectory": { + "$ref": "#/definitions/K8sActiveDirectory" + }, + "transparentDataEncryption": { + "$ref": "#/definitions/k8stransparentDataEncryption" + } + }, + "additionalProperties": {} + }, + "K8sActiveDirectory": { + "type": "object", + "description": "The kubernetes active directory information.", + "properties": { + "connector": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the connector" + }, + "namespace": { + "type": "string", + "description": "Name space of the connector" + } + } + }, + "accountName": { + "type": "string", + "description": "Account name for AAD" + }, + "keytabSecret": { + "type": "string", + "description": "Keytab secret used to authenticate with Active Directory." + }, + "encryptionTypes": { + "type": "array", + "description": "An array of encryption types", + "items": { + "type": "string" + } + } + } + }, + "k8stransparentDataEncryption": { + "type": "object", + "description": "Transparent data encryption information.", + "properties": { + "mode": { + "type": "string", + "description": "Transparent data encryption mode. Can be Service Managed, Customer managed or disabled" + }, + "protectorSecret": { + "type": "string", + "description": "Protector secret for customer managed Transparent data encryption mode" + } + } + }, + "K8sSettings": { + "type": "object", + "description": "The kubernetes settings information.", + "properties": { + "network": { + "$ref": "#/definitions/K8sNetworkSettings" + } + }, + "additionalProperties": {} + }, + "K8sNetworkSettings": { + "type": "object", + "description": "The kubernetes network settings information.", + "properties": { + "forceencryption": { + "type": "integer", + "format": "int32", + "description": "If 1, then SQL Server forces all connections to be encrypted. By default, this option is 0" + }, + "tlsciphers": { + "type": "string", + "description": "Specifies which ciphers are allowed by SQL Server for TLS" + }, + "tlsprotocols": { + "type": "string", + "description": "A comma-separated list of which TLS protocols are allowed by SQL Server" + } + } + }, + "KeytabInformation": { + "type": "object", + "description": "Keytab used for authenticate with Active Directory.", + "properties": { + "keytab": { + "type": "string", + "description": "A base64-encoded keytab.", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + } + }, + "ActiveDirectoryInformation": { + "type": "object", + "description": "Active Directory information that related to the resource.", + "properties": { + "keytabInformation": { + "description": "Keytab information that is used for the Sql Managed Instance when Active Directory authentication is used.", + "$ref": "#/definitions/KeytabInformation" + } + } + }, + "SqlManagedInstanceListResult": { + "description": "A list of SqlManagedInstance.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlManagedInstance" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerAvailabilityGroups.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerAvailabilityGroups.json new file mode 100644 index 000000000000..74120bb67ff2 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerAvailabilityGroups.json @@ -0,0 +1,1573 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups/{availabilityGroupName}": { + "put": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "operationId": "SqlServerAvailabilityGroups_Create", + "description": "Creates or replaces an Arc Sql Server Availability Group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlServerAvailabilityGroupResource", + "description": "The request body for availability group resource.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/availabilityGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Updated", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a Arc Sql Server availability group.": { + "$ref": "./examples/CreateOrUpdateArcSqlServerAvailabilityGroup.json" + } + } + }, + "delete": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "operationId": "SqlServerAvailabilityGroups_Delete", + "description": "Deletes an Arc Sql Server availability group resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/availabilityGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Resource deletion is in progress.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "The specified availability group does not exist." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deletes a availability group resource": { + "$ref": "./examples/DeleteArcSqlServerAvailabilityGroup.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "operationId": "SqlServerAvailabilityGroups_Get", + "description": "Retrieves an Arc Sql Server availability group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/availabilityGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieves an Arc Sql Server availability group resource.": { + "$ref": "./examples/GetArcSqlServerAvailabilityGroup.json" + } + } + }, + "patch": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "description": "Updates an existing Availability Group.", + "operationId": "SqlServerAvailabilityGroups_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/availabilityGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "sqlServerAvailabilityGroupUpdate", + "in": "body", + "description": "The requested server availability group resource state.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupUpdate" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the Availability Group.", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "202": { + "description": "Resource update is in progress.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update an availability group.": { + "$ref": "./examples/UpdateArcSqlServerAvailabilityGroup.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups/{availabilityGroupName}/getDetailView": { + "post": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "description": "Retrieves detailed properties of the Availability Group.", + "operationId": "SqlServerAvailabilityGroups_DetailView", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/availabilityGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the Run-time detailed properties of the Availability Group.", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "detail view for a server availability group.": { + "$ref": "./examples/ViewArcSqlServerAvailabilityGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups/{availabilityGroupName}/failover": { + "post": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "description": "Request manual failover of the availability group to this server.", + "operationId": "SqlServerAvailabilityGroups_Failover", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/availabilityGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully requested failover of the Availability Group.", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "availability group manual failover to this server.": { + "$ref": "./examples/FailoverArcSqlServerAvailabilityGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups/{availabilityGroupName}/forceFailoverAllowDataLoss": { + "post": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "description": "Request forced failover of the availability group to this server.", + "operationId": "SqlServerAvailabilityGroups_ForceFailoverAllowDataLoss", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/availabilityGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully requested forced failover of the Availability Group.", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "availability group force failover to this server.": { + "$ref": "./examples/ForceFailoverArcSqlServerAvailabilityGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/createAvailabilityGroup": { + "post": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "description": "Create a SQL Server availability group", + "operationId": "SqlServerAvailabilityGroups_CreateAvailabilityGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createAgConfiguration", + "in": "body", + "description": "The configuration for the new SQL Server availability group resource.", + "required": true, + "schema": { + "$ref": "#/definitions/AvailabilityGroupCreateUpdateConfiguration" + } + } + ], + "responses": { + "200": { + "description": "Successfully created the Availability Group.", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "202": { + "description": "Availability group creation is in progress.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create an availability group using this server for the primary replica.": { + "$ref": "./examples/CreateSqlServerAvailabilityGroup.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/createDistributedAvailabilityGroup": { + "post": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "description": "Create a SQL Server distributed availability group", + "operationId": "SqlServerAvailabilityGroups_CreateDistributedAvailabilityGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createDagConfiguration", + "in": "body", + "description": "The configuration for the new SQL Server availability group resource.", + "required": true, + "schema": { + "$ref": "#/definitions/DistributedAvailabilityGroupCreateUpdateConfiguration" + } + } + ], + "responses": { + "200": { + "description": "Successfully created the Availability Group.", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "202": { + "description": "Availability group creation is in progress.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a distributed availability group using this server for the primary replica.": { + "$ref": "./examples/CreateSqlServerDistributedAvailabilityGroup.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups/{availabilityGroupName}/addDatabases": { + "post": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "description": "Request adding database(s) to an existing availability group.", + "operationId": "SqlServerAvailabilityGroups_AddDatabases", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/availabilityGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "databases", + "in": "body", + "description": "The database names to add to the SQL Server availability group resource.", + "required": true, + "schema": { + "$ref": "#/definitions/databases" + } + } + ], + "responses": { + "200": { + "description": "Successfully requested adding databases to Availability Group.", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "add databases to this availability group.": { + "$ref": "./examples/AddDatabasesToAvailabilityGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups/{availabilityGroupName}/removeDatabases": { + "post": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "description": "Request removing database(s) from an existing availability group.", + "operationId": "SqlServerAvailabilityGroups_RemoveDatabases", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/availabilityGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "databases", + "in": "body", + "description": "The database names to remove from the SQL Server availability group resource.", + "required": true, + "schema": { + "$ref": "#/definitions/databases" + } + } + ], + "responses": { + "200": { + "description": "Successfully requested removing databases from Availability Group.", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "remove databases from this availability group.": { + "$ref": "./examples/RemoveDatabasesFromAvailabilityGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups": { + "get": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "operationId": "SqlServerAvailabilityGroups_List", + "summary": "List the availability group associated with the given Arc Sql Server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcSqlServerAvailabilityGroupListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all availability groups associated with an Arc Enabled Sql server.": { + "$ref": "./examples/ListBySqlServerInstanceAvailabilityGroup.json" + } + } + } + } + }, + "definitions": { + "AvailabilityGroupConfigure": { + "description": "The specifications of the availability group replica configuration", + "type": "object", + "properties": { + "endpointName": { + "type": "string", + "description": "Name of the mirroring endpoint URL" + }, + "endpointUrl": { + "type": "string", + "description": "Mirroring endpoint URL of availability group replica" + }, + "endpointAuthenticationMode": { + "description": "Permitted authentication modes for the mirroring endpoint.", + "$ref": "./common.json#/definitions/ConnectionAuth" + }, + "certificateName": { + "type": "string", + "description": "Name of certificate to use for authentication. Required if any CERTIFICATE authentication modes are specified." + }, + "endpointConnectLogin": { + "type": "string", + "description": "The login which will connect to the mirroring endpoint." + }, + "availabilityMode": { + "type": "string", + "description": "Property that determines whether a given availability replica can run in synchronous-commit mode", + "enum": [ + "SYNCHRONOUS_COMMIT", + "ASYNCHRONOUS_COMMIT" + ], + "x-ms-enum": { + "name": "arcSqlServerAvailabilityMode", + "modelAsString": true + } + }, + "availabilityModeDescription": { + "type": "string", + "description": "The Availability Synchronization mode of the availability group replica.", + "readOnly": true + }, + "failoverMode": { + "type": "string", + "description": "Property to set the failover mode of the availability group replica", + "enum": [ + "AUTOMATIC", + "MANUAL", + "EXTERNAL" + ], + "x-ms-enum": { + "name": "arcSqlServerFailoverMode", + "modelAsString": true + } + }, + "failoverModeDescription": { + "type": "string", + "description": "The failover mode of the availability group replica.", + "readOnly": true + }, + "sessionTimeout": { + "type": "integer", + "description": "The time-out period of availability group session replica, in seconds.", + "format": "int32" + }, + "primaryAllowConnections": { + "type": "string", + "description": "Whether the primary replica should allow all connections or only READ_WRITE connections (disallowing ReadOnly connections)", + "enum": [ + "ALL", + "READ_WRITE" + ], + "x-ms-enum": { + "name": "primaryAllowConnections", + "modelAsString": false + } + }, + "primaryRoleAllowConnectionsDescription": { + "type": "string", + "description": "Whether the availability allows all connections or only read-write connections.", + "readOnly": true + }, + "secondaryAllowConnections": { + "type": "string", + "description": "Whether the secondary replica should allow all connections, no connections, or only ReadOnly connections.", + "enum": [ + "NO", + "ALL", + "READ_ONLY" + ], + "x-ms-enum": { + "name": "secondaryAllowConnections", + "modelAsString": false + } + }, + "secondaryRoleAllowConnectionsDescription": { + "type": "string", + "description": "Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients.", + "readOnly": true + }, + "replicaCreateDate": { + "type": "string", + "description": "Date that the replica was created.", + "format": "date-time", + "readOnly": true + }, + "replicaModifyDate": { + "type": "string", + "description": "Date that the replica was modified.", + "format": "date-time", + "readOnly": true + }, + "backupPriority": { + "type": "integer", + "description": "Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group.", + "format": "int32" + }, + "readOnlyRoutingUrl": { + "type": "string", + "description": "Connectivity endpoint (URL) of the read only availability replica." + }, + "readWriteRoutingUrl": { + "type": "string", + "description": "Connectivity endpoint (URL) of the read write availability replica." + }, + "seedingMode": { + "type": "string", + "description": "Specifies how the secondary replica will be initially seeded. AUTOMATIC enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica. MANUAL specifies manual seeding (default). This method requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica.", + "enum": [ + "AUTOMATIC", + "MANUAL" + ], + "x-ms-enum": { + "name": "seedingMode", + "modelAsString": false + } + }, + "seedingModeDescription": { + "type": "string", + "description": "Describes seeding mode.", + "readOnly": true + } + } + }, + "AvailabilityGroupState": { + "description": "The specifications of the availability group state", + "type": "object", + "properties": { + "availabilityGroupReplicaRole": { + "type": "string", + "description": "Current Always On availability groups role of the availability group replica.", + "readOnly": true + }, + "operationalStateDescription": { + "type": "string", + "description": "Current operational state of the availability group replica", + "readOnly": true + }, + "recoveryHealthDescription": { + "type": "string", + "description": "Recovery health of the availability group replica.", + "readOnly": true + }, + "synchronizationHealthDescription": { + "type": "string", + "description": "Reflects a rollup of the database synchronization state (synchronization_state) of all joined availability databases (also known as replicas) and the availability mode of the replica (synchronous-commit or asynchronous-commit mode). The rollup will reflect the least healthy accumulated state the databases on the replica.", + "readOnly": true + }, + "connectedStateDescription": { + "type": "string", + "description": "Whether a secondary replica is currently connected to the primary replica.", + "readOnly": true + }, + "lastConnectErrorDescription": { + "type": "string", + "description": "Text description of the last connection error of the availability group replica.", + "readOnly": true + }, + "lastConnectErrorTimestamp": { + "type": "string", + "description": "Date and time timestamp indicating when the last connect error occurred.", + "format": "date-time", + "readOnly": true + } + } + }, + "AvailabilityGroupInfo": { + "description": "The specifications of the availability group state", + "type": "object", + "properties": { + "failureConditionLevel": { + "type": "integer", + "description": "User-defined failure condition level under which an automatic failover must be triggered.", + "format": "int32" + }, + "healthCheckTimeout": { + "type": "integer", + "description": "Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding.", + "format": "int32" + }, + "automatedBackupPreferenceDescription": { + "type": "string", + "description": "Preferred location for performing backups on the availability databases in this availability group.", + "readOnly": true + }, + "version": { + "type": "integer", + "description": "SQL Server availability group current version.", + "format": "int32", + "readOnly": true + }, + "basicFeatures": { + "type": "boolean", + "description": "Specifies whether this is a basic availability group." + }, + "dtcSupport": { + "type": "boolean", + "description": "Specifies whether DTC support has been enabled for this availability group." + }, + "dbFailover": { + "type": "boolean", + "description": "Specifies whether the availability group supports failover for database health conditions." + }, + "isDistributed": { + "type": "boolean", + "description": "Specifies whether this is a distributed availability group." + }, + "clusterTypeDescription": { + "type": "string", + "description": "SQL Server availability group cluster type description", + "readOnly": true + }, + "requiredSynchronizedSecondariesToCommit": { + "type": "integer", + "description": "The number of secondary replicas that must be in a synchronized state for a commit to complete.", + "format": "int32" + }, + "isContained": { + "type": "boolean", + "description": "SQL Server availability group contained system databases." + }, + "primaryReplica": { + "type": "string", + "description": "Name of the server instance that is hosting the current primary replica.", + "readOnly": true + }, + "primaryRecoveryHealthDescription": { + "type": "string", + "description": "Indicates the recovery health of the primary replica.", + "readOnly": true + }, + "secondaryRecoveryHealthDescription": { + "type": "string", + "description": "Indicates the recovery health of a secondary replica.", + "readOnly": true + }, + "synchronizationHealthDescription": { + "type": "string", + "description": "Reflects a roll-up of the synchronization health of all availability replicas in the availability group.", + "readOnly": true + }, + "replicationPartnerType": { + "type": "string", + "enum": [ + "SQLServer", + "AzureSQLVM", + "AzureSQLManagedInstance", + "Unknown" + ], + "x-ms-enum": { + "name": "replicationPartnerType", + "modelAsString": false + }, + "readOnly": true + }, + "listener": { + "description": "The listener for the sql server availability group", + "$ref": "#/definitions/SqlAvailabilityGroupStaticIPListenerProperties" + } + } + }, + "AvailabilityGroupCreateUpdateConfiguration": { + "description": "Options used in creating an availability group", + "type": "object", + "properties": { + "availabilityGroupName": { + "type": "string", + "description": "Name of the availability group." + }, + "replicas": { + "type": "array", + "description": "List of availability group replicas.", + "items": { + "$ref": "#/definitions/AvailabilityGroupCreateUpdateReplicaConfiguration" + }, + "x-ms-identifiers": [ + "serverInstance" + ] + }, + "databases": { + "type": "array", + "description": "List of databases to include in the availability group.", + "items": { + "type": "string" + } + }, + "automatedBackupPreference": { + "type": "string", + "description": "Preferred replica for running automated backups.", + "enum": [ + "PRIMARY", + "SECONDARY_ONLY", + "SECONDARY", + "NONE" + ], + "x-ms-enum": { + "name": "automatedBackupPreference", + "modelAsString": false + } + }, + "failureConditionLevel": { + "type": "integer", + "enum": [ + 1, + 2, + 3, + 4, + 5 + ], + "x-ms-enum": { + "name": "failureConditionLevel", + "modelAsString": false + }, + "description": "User-defined failure condition level under which an automatic failover must be triggered.", + "format": "int32" + }, + "healthCheckTimeout": { + "type": "integer", + "description": "Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding.", + "format": "int32" + }, + "dbFailover": { + "type": "string", + "description": "Specifies whether the availability group supports failover for database health conditions.", + "enum": [ + "ON", + "OFF" + ], + "x-ms-enum": { + "name": "dbFailover", + "modelAsString": false + } + }, + "dtcSupport": { + "type": "string", + "description": "Specifies whether DTC support has been enabled for this availability group.", + "enum": [ + "PER_DB", + "NONE" + ], + "x-ms-enum": { + "name": "dtcSupport", + "modelAsString": false + } + }, + "requiredSynchronizedSecondariesToCommit": { + "type": "integer", + "description": "The number of secondary replicas that must be in a synchronized state for a commit to complete.", + "format": "int32" + }, + "clusterType": { + "type": "string", + "description": "Set to WSFC when availability group is on a failover cluster instance on a Windows Server failover cluster. Set to NONE when availability group not using WSFC for cluster coordination.", + "enum": [ + "WSFC", + "NONE" + ], + "x-ms-enum": { + "name": "clusterType", + "modelAsString": false + } + }, + "listener": { + "description": "The listener for the sql server availability group", + "$ref": "#/definitions/SqlAvailabilityGroupStaticIPListenerProperties" + } + } + }, + "AvailabilityGroupCreateUpdateReplicaConfiguration": { + "description": "The specifications of the availability group replica configuration", + "type": "object", + "properties": { + "serverInstance": { + "type": "string", + "description": "the server instance hosting the replica." + }, + "endpointName": { + "type": "string", + "description": "Name of the database mirroring endpoint URL for the availability group replica" + }, + "endpointUrl": { + "type": "string", + "description": "Database mirroring endpoint URL of availability group replica" + }, + "endpointAuthenticationMode": { + "description": "Permitted authentication modes for the mirroring endpoint.", + "$ref": "./common.json#/definitions/ConnectionAuth" + }, + "certificateName": { + "type": "string", + "description": "Name of certificate to use for authentication. Required if any CERTIFICATE authentication modes are specified." + }, + "endpointConnectLogin": { + "type": "string", + "description": "The login which will connect to the mirroring endpoint" + }, + "availabilityMode": { + "type": "string", + "description": "Property that determines whether a given availability replica can run in synchronous-commit mode", + "enum": [ + "SYNCHRONOUS_COMMIT", + "ASYNCHRONOUS_COMMIT" + ], + "x-ms-enum": { + "name": "arcSqlServerAvailabilityMode", + "modelAsString": true + } + }, + "failoverMode": { + "type": "string", + "description": "Property to set the failover mode of the availability group replica", + "enum": [ + "AUTOMATIC", + "MANUAL", + "EXTERNAL" + ], + "x-ms-enum": { + "name": "arcSqlServerFailoverMode", + "modelAsString": true + } + }, + "seedingMode": { + "type": "string", + "description": "Specifies how the secondary replica will be initially seeded. AUTOMATIC enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica. MANUAL specifies manual seeding (default). This method requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica.", + "enum": [ + "AUTOMATIC", + "MANUAL" + ], + "x-ms-enum": { + "name": "seedingMode", + "modelAsString": false + } + }, + "backupPriority": { + "type": "integer", + "description": "Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group.", + "format": "int32" + }, + "secondaryRoleAllowConnections": { + "type": "string", + "description": "Whether the secondary replica should allow all connections, no connections, or only ReadOnly connections.", + "enum": [ + "NO", + "ALL", + "READ_ONLY" + ], + "x-ms-enum": { + "name": "secondaryAllowConnections", + "modelAsString": false + } + }, + "secondaryRoleReadOnlyRoutingUrl": { + "type": "string", + "description": "Connectivity endpoint (URL) of the read only availability replica." + }, + "primaryRoleAllowConnections": { + "type": "string", + "description": "Whether the primary replica should allow all connections or only READ_WRITE connections (disallowing ReadOnly connections)", + "enum": [ + "ALL", + "READ_WRITE" + ], + "x-ms-enum": { + "name": "primaryAllowConnections", + "modelAsString": false + } + }, + "primaryRoleReadOnlyRoutingList": { + "type": "array", + "description": "List of read only routing URLs.", + "items": { + "type": "string" + } + }, + "sessionTimeout": { + "type": "integer", + "description": "The time-out period of availability group session replica, in seconds.", + "format": "int32" + } + } + }, + "databases": { + "description": "List of database names.", + "type": "object", + "properties": { + "values": { + "description": "List of database names.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ArcSqlServerAvailabilityGroupListResult": { + "description": "A list of Arc Sql Server Availability Groups.", + "type": "object", + "properties": { + "value": { + "description": "Array of Arc Sql Server Availability Groups.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "DistributedAvailabilityGroupCreateUpdateConfiguration": { + "description": "Options used in creating a distributed availability group.", + "type": "object", + "properties": { + "availabilityGroupName": { + "type": "string", + "description": "Name of the availability group." + }, + "primaryAvailabilityGroup": { + "description": "The initial primary availability group for the distributed availability group.", + "$ref": "#/definitions/DistributedAvailabilityGroupCreateUpdateAvailabilityGroupConfiguration" + }, + "secondaryAvailabilityGroup": { + "description": "The initial secondary availability group for the distributed availability group.", + "$ref": "#/definitions/DistributedAvailabilityGroupCreateUpdateAvailabilityGroupConfiguration" + } + } + }, + "DistributedAvailabilityGroupCreateUpdateAvailabilityGroupConfiguration": { + "description": "The availability group configuration specification for a distributed availability group.", + "type": "object", + "properties": { + "availabilityGroup": { + "type": "string", + "format": "arm-id", + "description": "The azure resource identifier for the availability group." + }, + "listenerUrl": { + "type": "string", + "format": "uri", + "description": "The listener URL of the availability group." + }, + "availabilityMode": { + "type": "string", + "description": "The availability mode of the availability group.", + "enum": [ + "SYNCHRONOUS_COMMIT", + "ASYNCHRONOUS_COMMIT" + ], + "x-ms-enum": { + "name": "arcSqlServerAvailabilityMode", + "modelAsString": true + } + }, + "failoverMode": { + "type": "string", + "description": "The failover mode of the availability group.", + "enum": [ + "AUTOMATIC", + "MANUAL", + "EXTERNAL" + ], + "x-ms-enum": { + "name": "arcSqlServerFailoverMode", + "modelAsString": true + } + }, + "seedingMode": { + "type": "string", + "description": "The seeding mode of the availability group.", + "enum": [ + "AUTOMATIC", + "MANUAL" + ], + "x-ms-enum": { + "name": "seedingMode", + "modelAsString": false + } + }, + "certificateConfiguration": { + "description": "The certificate configuration for the availability group.", + "$ref": "#/definitions/DistributedAvailabilityGroupCreateUpdateAvailabilityGroupCertificateConfiguration" + } + } + }, + "DistributedAvailabilityGroupCreateUpdateAvailabilityGroupCertificateConfiguration": { + "description": "The availability group certificate configuration.", + "type": "object", + "properties": { + "certificateName": { + "type": "string", + "description": "Name of the certificate." + } + } + }, + "SqlServerAvailabilityGroupResource": { + "type": "object", + "description": "Arc Sql Server Availability Group", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResourceProperties", + "description": "Properties of Arc Sql Server availability group", + "x-ms-client-flatten": false + } + }, + "required": [ + "properties" + ] + }, + "SqlServerAvailabilityGroupResourceProperties": { + "type": "object", + "description": "The properties of Arc Sql Server availability group resource", + "properties": { + "availabilityGroupId": { + "type": "string", + "description": "ID GUID of the availability group.", + "pattern": "^[A-Za-z0-9]{8}-([A-Za-z0-9]{4}-){3}[A-Za-z0-9]{12}$", + "readOnly": true + }, + "serverName": { + "type": "string", + "description": "the SQL server name.", + "readOnly": true + }, + "instanceName": { + "type": "string", + "description": "the SQL Server Instance name.", + "readOnly": true + }, + "collectionTimestamp": { + "description": "Timestamp for when the data was collected from the client machine.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "info": { + "$ref": "#/definitions/AvailabilityGroupInfo", + "description": "Availability Group Info", + "x-ms-client-flatten": false + }, + "replicas": { + "description": "A list of Availability Group Replicas.", + "type": "object", + "properties": { + "value": { + "description": "Array of Availability Group Replicas.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlAvailabilityGroupReplicaResourceProperties" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "databases": { + "description": "A list of Availability Group Database Replicas.", + "type": "object", + "properties": { + "value": { + "description": "Array of Availability Group Database Replicas.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlAvailabilityGroupDatabaseReplicaResourceProperties" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the Arc-enabled SQL Server availability group resource.", + "readOnly": true + } + } + }, + "SqlServerAvailabilityGroupUpdate": { + "description": "An update to availability group resource.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResourceProperties", + "description": "The Server Availability Group's properties", + "x-ms-client-flatten": false + } + } + }, + "SqlAvailabilityGroupReplicaResourceProperties": { + "type": "object", + "description": "The properties of Arc Sql availability group replica resource", + "properties": { + "replicaId": { + "type": "string", + "description": "ID GUID of the availability group.", + "pattern": "^[A-Za-z0-9]{8}-([A-Za-z0-9]{4}-){3}[A-Za-z0-9]{12}$", + "readOnly": true + }, + "replicaName": { + "type": "string", + "description": "the replica name." + }, + "configure": { + "$ref": "#/definitions/AvailabilityGroupConfigure", + "description": "null", + "x-ms-client-flatten": false + }, + "state": { + "$ref": "#/definitions/AvailabilityGroupState", + "description": "null", + "x-ms-client-flatten": false + } + } + }, + "SqlAvailabilityGroupDatabaseReplicaResourceProperties": { + "type": "object", + "description": "The properties of Arc Sql availability group database replica resource", + "properties": { + "databaseName": { + "type": "string", + "description": "the database name." + }, + "replicaName": { + "type": "string", + "description": "the database replica name.", + "readOnly": true + }, + "isLocal": { + "type": "boolean", + "description": "Whether the availability database is local.", + "readOnly": true + }, + "isPrimaryReplica": { + "type": "boolean", + "description": "Returns 1 if the replica is primary, or 0 if it is a secondary replica.", + "readOnly": true + }, + "synchronizationStateDescription": { + "type": "string", + "description": "Description of the data-movement state.", + "readOnly": true + }, + "isCommitParticipant": { + "type": "boolean", + "description": "Whether this replica is transaction committer.", + "readOnly": true + }, + "synchronizationHealthDescription": { + "type": "string", + "description": "Description of the health of database.", + "readOnly": true + }, + "databaseStateDescription": { + "type": "string", + "description": "Description of the database state of the availability replica.", + "readOnly": true + }, + "isSuspended": { + "type": "boolean", + "description": "Whether this data movement is suspended.", + "readOnly": true + }, + "suspendReasonDescription": { + "type": "string", + "description": "Description of the database suspended state reason.", + "readOnly": true + } + } + }, + "SqlAvailabilityGroupStaticIPListenerProperties": { + "type": "object", + "description": "The properties of a static IP Arc Sql availability group listener", + "properties": { + "dnsName": { + "type": "string", + "description": "the DNS name for the listener." + }, + "ipV4AddressesAndMasks": { + "$ref": "#/definitions/SqlAvailabilityGroupIpV4AddressesAndMasksProperties", + "description": "IP V4 Addresses and masks for the listener." + }, + "ipV6Addresses": { + "type": "array", + "description": "IP V6 Addresses for the listener", + "items": { + "type": "string" + } + }, + "port": { + "type": "integer", + "description": "Network port for the listener. Default is 1433.", + "format": "int32" + } + } + }, + "SqlAvailabilityGroupIpV4AddressesAndMasksProperties": { + "type": "array", + "description": "Address and netmask information for an IPv4 AG listener.", + "items": { + "type": "object", + "properties": { + "ipAddress": { + "type": "string", + "description": "IPV4 address" + }, + "mask": { + "type": "string", + "description": "IPV4 netmask" + } + } + }, + "x-ms-identifiers": [ + "ipAddress" + ] + }, + "SqlAvailabilityGroupDhcpListenerProperties": { + "type": "object", + "description": "The properties of a DHCP Arc Sql availability group listener", + "properties": { + "dnsName": { + "type": "string", + "description": "the DNS name for the listener." + }, + "subnet": { + "type": "string", + "description": "The IPV4 subnet for the listener." + }, + "mask": { + "type": "string", + "description": "The netmask for the listener." + }, + "port": { + "type": "integer", + "description": "Network port for the listener. Default is 1433.", + "format": "int32" + } + } + } + }, + "parameters": { + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group", + "x-ms-parameter-location": "method" + }, + "sqlServerInstanceName": { + "name": "sqlServerInstanceName", + "description": "Name of SQL Server Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "availabilityGroupName": { + "name": "availabilityGroupName", + "description": "Name of SQL Availability Group", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerDatabases.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerDatabases.json new file mode 100644 index 000000000000..7da3f90ec544 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerDatabases.json @@ -0,0 +1,680 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/databases/{databaseName}": { + "put": { + "tags": [ + "SqlServerDatabases" + ], + "operationId": "SqlServerDatabases_Create", + "description": "Creates or replaces an Arc Sql Server Database.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlServerDatabaseResource", + "description": "The request body for database resource.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/SqlServerDatabaseResource" + } + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/databaseName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerDatabaseResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SqlServerDatabaseResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a Arc Sql Server database.": { + "$ref": "./examples/CreateOrUpdateArcSqlServerDatabase.json" + } + } + }, + "delete": { + "tags": [ + "SqlServerDatabases" + ], + "operationId": "SqlServerDatabases_Delete", + "description": "Deletes an Arc Sql Server database resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/databaseName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "202": { + "description": "Resource deletion is in progress.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "The specified database does not exist." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deletes a database resource": { + "$ref": "./examples/DeleteArcSqlServerDatabase.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "SqlServerDatabases" + ], + "operationId": "SqlServerDatabases_Get", + "description": "Retrieves an Arc Sql Server database.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/databaseName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerDatabaseResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieves an Arc Sql Server database resource.": { + "$ref": "./examples/GetArcSqlServerDatabase.json" + } + } + }, + "patch": { + "tags": [ + "SqlServerDatabases" + ], + "description": "Updates an existing database.", + "operationId": "SqlServerDatabases_Update", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/databaseName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "name": "sqlServerDatabaseUpdate", + "in": "body", + "description": "The requested database resource state.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlServerDatabaseUpdate" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the database.", + "schema": { + "$ref": "#/definitions/SqlServerDatabaseResource" + } + }, + "202": { + "description": "Resource update is in progress.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update a database.": { + "$ref": "./examples/UpdateSqlServerDatabase.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/databases": { + "get": { + "tags": [ + "SqlServerDatabases" + ], + "operationId": "SqlServerDatabases_List", + "summary": "List the databases associated with the given Arc Sql Server.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcSqlServerDatabaseListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all databases associated with an Arc Enabled Sql server.": { + "$ref": "./examples/ListBySqlServerInstanceDatabase.json" + } + } + } + } + }, + "definitions": { + "ArcSqlServerDatabaseListResult": { + "description": "A list of Arc Sql Server database.", + "type": "object", + "properties": { + "value": { + "description": "Array of Arc Sql Server database.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlServerDatabaseResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SqlServerDatabaseResource": { + "type": "object", + "description": "Arc Sql Server database", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlServerDatabaseResourceProperties", + "description": "Properties of Arc Sql Server database", + "x-ms-client-flatten": false + } + }, + "required": [ + "properties" + ] + }, + "SqlServerDatabaseResourceProperties": { + "type": "object", + "description": "The properties of Arc Sql Server database resource", + "properties": { + "collationName": { + "description": "Collation of the database.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "databaseCreationDate": { + "format": "date-time", + "description": "Creation date of the database.", + "type": "string" + }, + "compatibilityLevel": { + "type": "integer", + "minimum": 80, + "maximum": 200, + "format": "int32", + "description": "Compatibility level of the database" + }, + "sizeMB": { + "type": "number", + "format": "float", + "description": "Size of the database." + }, + "spaceAvailableMB": { + "type": "number", + "format": "float", + "description": "Space left of the database." + }, + "state": { + "description": "State of the database.", + "enum": [ + "Online", + "Restoring", + "Recovering", + "RecoveryPending", + "Suspect", + "Emergency", + "Offline", + "Copying", + "OfflineSecondary" + ], + "type": "string", + "x-ms-enum": { + "name": "DatabaseState", + "modelAsString": true + } + }, + "isReadOnly": { + "type": "boolean", + "description": "Whether the database is read only or not." + }, + "recoveryMode": { + "description": "Status of the database.", + "enum": [ + "Full", + "Bulk-logged", + "Simple" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryMode", + "modelAsString": true + } + }, + "databaseOptions": { + "type": "object", + "description": "List of features that are enabled for the database", + "properties": { + "isAutoCloseOn": { + "type": "boolean" + }, + "isAutoShrinkOn": { + "type": "boolean" + }, + "isAutoCreateStatsOn": { + "type": "boolean" + }, + "isAutoUpdateStatsOn": { + "type": "boolean" + }, + "isRemoteDataArchiveEnabled": { + "type": "boolean" + }, + "isMemoryOptimizationEnabled": { + "type": "boolean" + }, + "isEncrypted": { + "type": "boolean" + }, + "isTrustworthyOn": { + "type": "boolean" + } + } + }, + "backupInformation": { + "type": "object", + "properties": { + "lastFullBackup": { + "format": "date-time", + "description": "Date time of last full backup.", + "type": "string" + }, + "lastLogBackup": { + "format": "date-time", + "description": "Date time of last log backup.", + "type": "string" + } + } + }, + "backupPolicy": { + "description": "The backup profile for the SQL server.", + "$ref": "#/definitions/BackupPolicy" + }, + "earliestRestoreDate": { + "format": "date-time", + "description": "This records the earliest start date and time that restore is available for this database (ISO8601 format).", + "type": "string", + "readOnly": true + }, + "createMode": { + "description": "Database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. sourceDatabaseId and restorePointInTime must be specified.", + "enum": [ + "Default", + "PointInTimeRestore" + ], + "type": "string", + "x-ms-enum": { + "name": "DatabaseCreateMode", + "modelAsString": true + } + }, + "sourceDatabaseId": { + "description": "The name of the source database associated with create operation of this database.", + "type": "string", + "format": "arm-id" + }, + "restorePointInTime": { + "format": "date-time", + "description": "Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.", + "type": "string" + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the Arc-enabled SQL Server database resource.", + "readOnly": true + }, + "lastDatabaseUploadTime": { + "type": "string", + "format": "date-time", + "description": "The time when last successful database upload was performed.", + "readOnly": true + }, + "migration": { + "$ref": "#/definitions/DataBaseMigration" + } + } + }, + "DataBaseMigration": { + "description": "Migration related configuration.", + "type": "object", + "properties": { + "assessment": { + "description": "Migration assessments related configuration.", + "$ref": "#/definitions/DataBaseMigrationAssessment" + } + } + }, + "DataBaseMigrationAssessment": { + "description": "The migration assessment related configuration.", + "type": "object", + "properties": { + "assessmentUploadTime": { + "type": "string", + "format": "date-time", + "description": "The time when Migration Assessment Report upload was last performed.", + "readOnly": true + }, + "databaseAssessments": { + "$ref": "#/definitions/DatabaseAssessments" + }, + "targetReadiness": { + "$ref": "#/definitions/TargetReadiness" + } + } + }, + "DatabaseAssessments": { + "description": "Issues and warnings impacting the migration of Database to particular Azure Migration Target.", + "readOnly": true, + "type": "array", + "items": { + "type": "object", + "properties": { + "appliesToMigrationTargetPlatform": { + "type": "string" + }, + "featureId": { + "type": "string" + }, + "issueCategory": { + "type": "string" + }, + "moreInformation": { + "type": "string" + } + } + } + }, + "TargetReadiness": { + "description": "The target readiness for migration for this database.", + "type": "object", + "readOnly": true, + "properties": { + "azureSqlDatabase": { + "$ref": "#/definitions/SkuRecommendationSummary" + }, + "azureSqlManagedInstance": { + "$ref": "#/definitions/SkuRecommendationSummary" + }, + "azureSqlVirtualMachine": { + "$ref": "#/definitions/SkuRecommendationSummary" + } + } + }, + "SkuRecommendationSummary": { + "description": "The SKU recommendation summary.", + "type": "object", + "properties": { + "numOfBlockerIssues": { + "$ref": "#/definitions/SkuRecommendationResultsNumberOfBlockerIssues" + }, + "recommendationStatus": { + "$ref": "./common.json#/definitions/SkuRecommendationResultsRecommendationStatus" + } + } + }, + "SkuRecommendationResultsNumberOfBlockerIssues": { + "description": "Number of blocker issues to fix before migrating this database to the target platform.", + "type": "integer", + "format": "int32" + }, + "SqlServerDatabaseUpdate": { + "description": "An update to database resource.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/SqlServerDatabaseResourceProperties", + "description": "The data controller's properties", + "x-ms-client-flatten": false + } + } + }, + "BackupPolicy": { + "description": "The backup profile for the SQL server.", + "type": "object", + "properties": { + "retentionPeriodDays": { + "type": "integer", + "description": "The retention period for all the databases in this managed instance.", + "minimum": 0, + "maximum": 35, + "format": "int32" + }, + "fullBackupDays": { + "type": "integer", + "description": "The value indicating days between full backups.", + "minimum": 0, + "maximum": 7, + "format": "int32" + }, + "differentialBackupHours": { + "description": "The differential backup interval in hours.", + "enum": [ + 12, + 24 + ], + "type": "integer", + "format": "int32", + "x-ms-enum": { + "name": "differentialBackupHours", + "modelAsString": false + } + }, + "transactionLogBackupMinutes": { + "type": "integer", + "description": "The value indicating minutes between transaction log backups.", + "minimum": 0, + "maximum": 60, + "format": "int32" + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Azure subscription", + "x-ms-parameter-location": "client" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group", + "x-ms-parameter-location": "method" + }, + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + }, + "sqlServerInstanceName": { + "name": "sqlServerInstanceName", + "description": "Name of SQL Server Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "databaseName": { + "name": "databaseName", + "description": "Name of the database", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerEsuLicenses.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerEsuLicenses.json new file mode 100644 index 000000000000..61ac6e8af6e2 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerEsuLicenses.json @@ -0,0 +1,545 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/sqlServerEsuLicenses": { + "get": { + "tags": [ + "SqlServerEsuLicenses" + ], + "operationId": "SqlServerEsuLicenses_List", + "summary": "List sqlServerEsuLicense resources in the subscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerEsuLicenseListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Server ESU licenses in a subscription.": { + "$ref": "./examples/ListSubscriptionSqlServerEsuLicense.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerEsuLicenses": { + "get": { + "tags": [ + "SqlServerEsuLicenses" + ], + "operationId": "SqlServerEsuLicenses_ListByResourceGroup", + "description": "Gets all sqlServerEsuLicenses in a resource group.", + "summary": "List sqlServerEsuLicense resources in the resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerEsuLicenseListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Server ESU licenses in a resource group.": { + "$ref": "./examples/ListByResourceGroupSqlServerEsuLicense.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/{sqlServerEsuLicenseName}": { + "get": { + "tags": [ + "SqlServerEsuLicenses" + ], + "operationId": "SqlServerEsuLicenses_Get", + "description": "Retrieves a SQL Server ESU license resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/sqlServerEsuLicenseName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerEsuLicense" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets a SQL Server ESU license.": { + "$ref": "./examples/GetSqlServerEsuLicense.json" + } + } + }, + "put": { + "tags": [ + "SqlServerEsuLicenses" + ], + "operationId": "SqlServerEsuLicenses_Create", + "description": "Creates or replaces a SQL Server ESU license resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/sqlServerEsuLicenseName" + }, + { + "name": "sqlServerEsuLicense", + "in": "body", + "description": "The SQL Server ESU license to be created or updated.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlServerEsuLicense" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerEsuLicense" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SqlServerEsuLicense" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a SQL Server ESU license.": { + "$ref": "./examples/CreateOrUpdateSqlServerEsuLicense.json" + } + } + }, + "delete": { + "tags": [ + "SqlServerEsuLicenses" + ], + "operationId": "SqlServerEsuLicenses_Delete", + "description": "Deletes a SQL Server ESU license resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/sqlServerEsuLicenseName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the SQL Server ESU license." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified SQL Server ESU license does not exist." + } + }, + "x-ms-examples": { + "Delete a SQL Server ESU license.": { + "$ref": "./examples/DeleteSqlServerEsuLicense.json" + } + } + }, + "patch": { + "tags": [ + "SqlServerEsuLicenses" + ], + "operationId": "SqlServerEsuLicenses_Update", + "description": "Updates a SQL Server ESU license resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/sqlServerEsuLicenseName" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL Server ESU license.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlServerEsuLicenseUpdate" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerEsuLicense" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch a SQL Server ESU license.": { + "$ref": "./examples/UpdateSqlServerEsuLicense.json" + } + } + } + } + }, + "definitions": { + "SqlServerEsuLicense": { + "description": "Describe SQL Server ESU license resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlServerEsuLicenseProperties", + "description": "SQL Server ESU license properties", + "x-ms-client-flatten": false + } + }, + "required": [ + "properties" + ] + }, + "SqlServerEsuLicenseProperties": { + "description": "Properties of SQL Server ESU license.", + "type": "object", + "properties": { + "billingPlan": { + "type": "string", + "description": "SQL Server ESU license type.", + "enum": [ + "PAYG" + ], + "x-ms-enum": { + "name": "billingPlan", + "modelAsString": true + } + }, + "version": { + "type": "string", + "description": "The SQL Server version the license covers.", + "enum": [ + "SQL Server 2012", + "SQL Server 2014" + ], + "x-ms-enum": { + "name": "version", + "modelAsString": true + } + }, + "uniqueId": { + "type": "string", + "description": "The unique ID of this license. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "pattern": "^[A-Za-z0-9]{8}-([A-Za-z0-9]{4}-){3}[A-Za-z0-9]{12}$", + "readOnly": true + }, + "physicalCores": { + "type": "integer", + "format": "int32", + "multipleOf": 2, + "minimum": 16, + "description": "The number of total cores of the license covers." + }, + "activationState": { + "type": "string", + "description": "The activation state of the license.", + "enum": [ + "Inactive", + "Active", + "Terminated" + ], + "x-ms-enum": { + "name": "state", + "modelAsString": true + } + }, + "scopeType": { + "type": "string", + "description": "The Azure scope to which the license will apply.", + "enum": [ + "Tenant", + "Subscription", + "ResourceGroup" + ], + "x-ms-enum": { + "name": "scopeType", + "modelAsString": true + } + }, + "activatedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the activation of the SqlServerEsuLicense in ISO 8601 date-time format.", + "readOnly": true + }, + "terminatedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the termination of the SqlServerEsuLicense in ISO 8601 date-time format.", + "readOnly": true + }, + "tenantId": { + "type": "string", + "description": "The tenantId the SQL Server ESU license resource subscription resides in.", + "readOnly": true + } + }, + "required": [ + "billingPlan", + "version", + "physicalCores", + "scopeType", + "activationState" + ] + }, + "SqlServerEsuLicenseUpdateProperties": { + "description": "Properties of update SqlServerEsuLicense.", + "type": "object", + "properties": { + "billingPlan": { + "type": "string", + "description": "SQL Server ESU license type.", + "enum": [ + "PAYG" + ], + "x-ms-enum": { + "name": "billingPlan", + "modelAsString": true + } + }, + "version": { + "type": "string", + "description": "The SQL Server version the license covers.", + "enum": [ + "SQL Server 2012", + "SQL Server 2014" + ], + "x-ms-enum": { + "name": "version", + "modelAsString": true + } + }, + "uniqueId": { + "type": "string", + "description": "The unique ID of this license. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "pattern": "^[A-Za-z0-9]{8}-([A-Za-z0-9]{4}-){3}[A-Za-z0-9]{12}$", + "readOnly": true + }, + "physicalCores": { + "type": "integer", + "format": "int32", + "multipleOf": 2, + "minimum": 16, + "description": "The number of total cores of the license covers." + }, + "activationState": { + "type": "string", + "description": "The activation state of the license.", + "enum": [ + "Inactive", + "Active", + "Terminated" + ], + "x-ms-enum": { + "name": "state", + "modelAsString": true + } + }, + "scopeType": { + "type": "string", + "description": "The Azure scope to which the license will apply.", + "enum": [ + "Tenant", + "Subscription", + "ResourceGroup" + ], + "x-ms-enum": { + "name": "scopeType", + "modelAsString": true + } + }, + "activatedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the activation of the SqlServerEsuLicense in ISO 8601 date-time format.", + "readOnly": true + }, + "terminatedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the termination of the SqlServerEsuLicense in ISO 8601 date-time format.", + "readOnly": true + }, + "tenantId": { + "type": "string", + "description": "The tenantId the SQL Server ESU license resource subscription resides in.", + "readOnly": true + } + } + }, + "SqlServerEsuLicenseUpdate": { + "description": "An update to a SQL Server ESU license resource.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/SqlServerEsuLicenseUpdateProperties", + "description": "null", + "x-ms-client-flatten": false + } + } + }, + "SqlServerEsuLicenseListResult": { + "description": "A list of SQL Server ESU licenses.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlServerEsuLicense" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "sqlServerEsuLicenseName": { + "name": "sqlServerEsuLicenseName", + "description": "Name of SQL Server ESU License", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerInstances.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerInstances.json new file mode 100644 index 000000000000..07fc363b51a2 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerInstances.json @@ -0,0 +1,1367 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "paths": {}, + "definitions": { + "SqlServerInstance": { + "description": "A SqlServerInstance.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlServerInstanceProperties", + "description": "null", + "x-ms-client-flatten": false + } + } + }, + "SqlServerInstanceProperties": { + "description": "Properties of SqlServerInstance.", + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "SQL Server version.", + "enum": [ + "SQL Server 2012", + "SQL Server 2014", + "SQL Server 2016", + "SQL Server 2017", + "SQL Server 2019", + "SQL Server 2022", + "Unknown" + ], + "x-ms-enum": { + "name": "sqlVersion", + "modelAsString": true + } + }, + "edition": { + "type": "string", + "description": "SQL Server edition.", + "enum": [ + "Evaluation", + "Enterprise", + "Standard", + "Web", + "Developer", + "Express", + "Business Intelligence" + ], + "x-ms-enum": { + "name": "editionType", + "modelAsString": true + } + }, + "containerResourceId": { + "type": "string", + "description": "ARM Resource id of the container resource (Azure Arc for Servers).", + "readOnly": true + }, + "createTime": { + "type": "string", + "description": "The time when the resource was created.", + "readOnly": true + }, + "vCore": { + "type": "string", + "description": "The number of logical processors used by the SQL Server instance.", + "readOnly": true + }, + "cores": { + "type": "string", + "description": "The number of total cores of the Operating System Environment (OSE) hosting the SQL Server instance." + }, + "status": { + "type": "string", + "description": "The cloud connectivity status.", + "readOnly": true, + "enum": [ + "Connected", + "Disconnected", + "Registered", + "Unknown" + ], + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + } + }, + "patchLevel": { + "type": "string", + "description": "SQL Server update level.", + "readOnly": true + }, + "collation": { + "type": "string", + "description": "SQL Server collation.", + "readOnly": true + }, + "dbMasterKeyExists": { + "type": "boolean", + "description": "Indicates whether database master key exists in SQL Server.", + "readOnly": true + }, + "isHadrEnabled": { + "type": "boolean", + "description": "Indicates whether always On availability groups is enabled in SQL Server.", + "readOnly": true + }, + "traceFlags": { + "type": "array", + "description": "An array of integers, where each value represents the enabled trace flags in SQL Server.", + "items": { + "type": "integer", + "format": "int32" + }, + "readOnly": true + }, + "currentVersion": { + "type": "string", + "description": "SQL Server current version.", + "readOnly": true + }, + "instanceName": { + "type": "string", + "description": "SQL Server instance name." + }, + "tcpDynamicPorts": { + "type": "string", + "description": "Dynamic TCP ports used by SQL Server.", + "readOnly": true + }, + "tcpStaticPorts": { + "type": "string", + "description": "Static TCP ports used by SQL Server.", + "readOnly": true + }, + "productId": { + "type": "string", + "description": "SQL Server product ID.", + "readOnly": true + }, + "licenseType": { + "type": "string", + "description": "SQL Server license type.", + "readOnly": true, + "enum": [ + "Undefined", + "Free", + "HADR", + "ServerCAL", + "LicenseOnly", + "PAYG", + "Paid" + ], + "x-ms-enum": { + "name": "arcSqlServerLicenseType", + "modelAsString": true + } + }, + "azureDefenderStatusLastUpdated": { + "type": "string", + "format": "date-time", + "description": "Timestamp of last Azure Defender status update.", + "readOnly": true + }, + "azureDefenderStatus": { + "type": "string", + "description": "Status of Azure Defender.", + "readOnly": true, + "enum": [ + "Protected", + "Unprotected", + "Unknown" + ], + "x-ms-enum": { + "name": "defenderStatus", + "modelAsString": true + } + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the Arc-enabled SQL Server resource.", + "readOnly": true + }, + "lastInventoryUploadTime": { + "type": "string", + "format": "date-time", + "description": "The time when last successful inventory upload was performed.", + "readOnly": true + }, + "lastUsageUploadTime": { + "type": "string", + "format": "date-time", + "description": "The time when last successful usage upload was performed.", + "readOnly": true + }, + "hostType": { + "type": "string", + "description": "Type of host for Azure Arc SQL Server", + "enum": [ + "Azure Virtual Machine", + "Azure VMWare Virtual Machine", + "Azure Kubernetes Service", + "AWS VMWare Virtual Machine", + "AWS Kubernetes Service", + "GCP VMWare Virtual Machine", + "GCP Kubernetes Service", + "Container", + "Virtual Machine", + "Physical Server", + "AWS Virtual Machine", + "GCP Virtual Machine", + "Other" + ], + "x-ms-enum": { + "name": "hostType", + "modelAsString": true + } + }, + "alwaysOnRole": { + "type": "string", + "description": "The role of the SQL Server, based on availability.", + "readOnly": true, + "enum": [ + "None", + "FailoverClusterInstance", + "FailoverClusterNode", + "AvailabilityGroupReplica" + ], + "x-ms-enum": { + "name": "alwaysOnRole", + "modelAsString": true + } + }, + "databaseMirroringEndpoint": { + "description": "Database mirroring endpoint related properties.", + "$ref": "#/definitions/DBMEndpoint" + }, + "failoverCluster": { + "description": "Failover Cluster Instance properties.", + "$ref": "#/definitions/FailoverCluster" + }, + "backupPolicy": { + "description": "The backup profile for the SQL server.", + "$ref": "#/definitions/BackupPolicy" + }, + "upgradeLockedUntil": { + "description": "Upgrade Action for this resource is locked until it expires. The Expiration time indicated by this value. It is not locked when it is empty.", + "type": "string", + "format": "date-time" + }, + "monitoring": { + "description": "The monitoring configuration.", + "$ref": "#/definitions/Monitoring" + }, + "migration": { + "description": "Migration related configuration.", + "$ref": "#/definitions/Migration" + }, + "clientConnection": { + "description": "Client connection related configuration.", + "$ref": "#/definitions/ClientConnection" + }, + "serviceType": { + "description": "Indicates if the resource represents a SQL Server engine or a SQL Server component service installed on the host.", + "$ref": "#/definitions/ServiceType" + } + } + }, + "SqlServerInstanceUpdateProperties": { + "description": "Properties of update SqlServerInstance.", + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "SQL Server version.", + "enum": [ + "SQL Server 2012", + "SQL Server 2014", + "SQL Server 2016", + "SQL Server 2017", + "SQL Server 2019", + "SQL Server 2022", + "Unknown" + ], + "x-ms-enum": { + "name": "sqlVersion", + "modelAsString": true + } + }, + "edition": { + "type": "string", + "description": "SQL Server edition.", + "enum": [ + "Evaluation", + "Enterprise", + "Standard", + "Web", + "Developer", + "Express", + "Business Intelligence" + ], + "x-ms-enum": { + "name": "editionType", + "modelAsString": true + } + }, + "containerResourceId": { + "type": "string", + "description": "ARM Resource id of the container resource (Azure Arc for Servers).", + "readOnly": true + }, + "createTime": { + "type": "string", + "description": "The time when the resource was created.", + "readOnly": true + }, + "vCore": { + "type": "string", + "description": "The number of logical processors used by the SQL Server instance.", + "readOnly": true + }, + "cores": { + "type": "string", + "description": "The number of total cores of the Operating System Environment (OSE) hosting the SQL Server instance." + }, + "status": { + "type": "string", + "description": "The cloud connectivity status.", + "readOnly": true, + "enum": [ + "Connected", + "Disconnected", + "Registered", + "Unknown" + ], + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + } + }, + "patchLevel": { + "type": "string", + "description": "SQL Server update level.", + "readOnly": true + }, + "collation": { + "type": "string", + "description": "SQL Server collation.", + "readOnly": true + }, + "dbMasterKeyExists": { + "type": "boolean", + "description": "Indicates whether database master key exists in SQL Server.", + "readOnly": true + }, + "isHadrEnabled": { + "type": "boolean", + "description": "Indicates whether always On availability groups is enabled in SQL Server.", + "readOnly": true + }, + "traceFlags": { + "type": "array", + "description": "An array of integers, where each value represents the enabled trace flags in SQL Server.", + "items": { + "type": "integer", + "format": "int32" + }, + "readOnly": true + }, + "currentVersion": { + "type": "string", + "description": "SQL Server current version.", + "readOnly": true + }, + "instanceName": { + "type": "string", + "description": "SQL Server instance name." + }, + "tcpDynamicPorts": { + "type": "string", + "description": "Dynamic TCP ports used by SQL Server.", + "readOnly": true + }, + "tcpStaticPorts": { + "type": "string", + "description": "Static TCP ports used by SQL Server.", + "readOnly": true + }, + "productId": { + "type": "string", + "description": "SQL Server product ID.", + "readOnly": true + }, + "licenseType": { + "type": "string", + "description": "SQL Server license type.", + "readOnly": true, + "enum": [ + "Undefined", + "Free", + "HADR", + "ServerCAL", + "LicenseOnly", + "PAYG", + "Paid" + ], + "x-ms-enum": { + "name": "arcSqlServerLicenseType", + "modelAsString": true + } + }, + "azureDefenderStatusLastUpdated": { + "type": "string", + "format": "date-time", + "description": "Timestamp of last Azure Defender status update.", + "readOnly": true + }, + "azureDefenderStatus": { + "type": "string", + "description": "Status of Azure Defender.", + "readOnly": true, + "enum": [ + "Protected", + "Unprotected", + "Unknown" + ], + "x-ms-enum": { + "name": "defenderStatus", + "modelAsString": true + } + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the Arc-enabled SQL Server resource.", + "readOnly": true + }, + "lastInventoryUploadTime": { + "type": "string", + "format": "date-time", + "description": "The time when last successful inventory upload was performed.", + "readOnly": true + }, + "lastUsageUploadTime": { + "type": "string", + "format": "date-time", + "description": "The time when last successful usage upload was performed.", + "readOnly": true + }, + "hostType": { + "type": "string", + "description": "Type of host for Azure Arc SQL Server", + "enum": [ + "Azure Virtual Machine", + "Azure VMWare Virtual Machine", + "Azure Kubernetes Service", + "AWS VMWare Virtual Machine", + "AWS Kubernetes Service", + "GCP VMWare Virtual Machine", + "GCP Kubernetes Service", + "Container", + "Virtual Machine", + "Physical Server", + "AWS Virtual Machine", + "GCP Virtual Machine", + "Other" + ], + "x-ms-enum": { + "name": "hostType", + "modelAsString": true + } + }, + "alwaysOnRole": { + "type": "string", + "description": "The role of the SQL Server, based on availability.", + "readOnly": true, + "enum": [ + "None", + "FailoverClusterInstance", + "FailoverClusterNode", + "AvailabilityGroupReplica" + ], + "x-ms-enum": { + "name": "alwaysOnRole", + "modelAsString": true + } + }, + "failoverCluster": { + "description": "Failover Cluster Instance properties.", + "$ref": "#/definitions/FailoverCluster" + }, + "backupPolicy": { + "description": "The backup profile for the SQL server.", + "$ref": "#/definitions/BackupPolicy" + }, + "upgradeLockedUntil": { + "description": "Upgrade Action for this resource is locked until it expires. The Expiration time indicated by this value. It is not locked when it is empty.", + "type": "string", + "format": "date-time" + }, + "monitoring": { + "description": "The monitoring configuration.", + "$ref": "#/definitions/Monitoring" + }, + "migration": { + "description": "Migration related configuration.", + "$ref": "#/definitions/Migration" + }, + "clientConnection": { + "description": "Client connection related configuration.", + "$ref": "#/definitions/ClientConnection" + }, + "serviceType": { + "description": "Indicates if the resource represents a SQL Server engine or a SQL Server component service installed on the host.", + "$ref": "#/definitions/ServiceType" + } + } + }, + "DBMEndpoint": { + "type": "object", + "description": "Database mirroring endpoint related properties.", + "properties": { + "endpointName": { + "type": "string", + "description": "Name of the database mirroring endpoint.", + "readOnly": true + }, + "role": { + "type": "string", + "description": "Mirroring Role", + "readOnly": true, + "enum": [ + "NONE", + "PARTNER", + "WITNESS", + "ALL" + ], + "x-ms-enum": { + "name": "role", + "modelAsString": true + } + }, + "isEncryptionEnabled": { + "type": "boolean", + "description": "Is Encryption enabled", + "readOnly": true + }, + "encryptionAlgorithm": { + "description": "Encryption Algorithm", + "$ref": "./common.json#/definitions/EncryptionAlgorithm", + "readOnly": true + }, + "connectionAuth": { + "description": "The type of connection authentication required for connections to this endpoint", + "$ref": "./common.json#/definitions/ConnectionAuth", + "readOnly": true + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port number that the endpoint is listening on.", + "readOnly": true + }, + "isDynamicPort": { + "type": "boolean", + "description": "Is the port number dynamically assigned.", + "readOnly": true + }, + "ipAddress": { + "type": "string", + "description": "Listener IP address.", + "readOnly": true + }, + "certificateName": { + "type": "string", + "description": "Name of the certificate.", + "readOnly": true + } + } + }, + "FailoverCluster": { + "type": "object", + "description": "Failover Cluster Instance properties.", + "properties": { + "id": { + "type": "string", + "description": "The GUID of the SQL Server's underlying Failover Cluster.", + "readOnly": true + }, + "networkName": { + "type": "string", + "description": "The network name to connect to the SQL FCI.", + "readOnly": true + }, + "sqlInstanceIds": { + "type": "array", + "description": "The ARM IDs of the Arc SQL Server resources, belonging to the current server's Failover cluster.", + "readOnly": true, + "items": { + "type": "string" + } + }, + "hostNames": { + "type": "array", + "description": "The host names which are part of the SQL FCI resource group.", + "readOnly": true, + "items": { + "type": "string" + } + } + } + }, + "SqlServerInstanceUpdate": { + "description": "An update to a SQL Server Instance.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/SqlServerInstanceUpdateProperties", + "description": "null", + "x-ms-client-flatten": false + } + } + }, + "SqlServerInstanceListResult": { + "description": "A list of SqlServerInstance.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlServerInstance" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "BackupPolicy": { + "description": "The backup profile for the SQL server.", + "type": "object", + "properties": { + "retentionPeriodDays": { + "type": "integer", + "description": "The retention period for all the databases in this managed instance.", + "minimum": 0, + "maximum": 35, + "format": "int32" + }, + "fullBackupDays": { + "type": "integer", + "description": "The value indicating days between full backups.", + "minimum": 0, + "maximum": 7, + "format": "int32" + }, + "differentialBackupHours": { + "description": "The differential backup interval in hours.", + "enum": [ + 12, + 24 + ], + "type": "integer", + "format": "int32", + "x-ms-enum": { + "name": "differentialBackupHours", + "modelAsString": false + } + }, + "transactionLogBackupMinutes": { + "type": "integer", + "description": "The value indicating minutes between transaction log backups.", + "minimum": 0, + "maximum": 60, + "format": "int32" + } + } + }, + "Monitoring": { + "description": "The monitoring configuration.", + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates if monitoring is enabled for this SQL Server instance." + } + } + }, + "Migration": { + "description": "Migration related configuration.", + "type": "object", + "properties": { + "assessment": { + "description": "Migration assessments related configuration.", + "$ref": "#/definitions/MigrationAssessment" + } + } + }, + "MigrationAssessment": { + "description": "The migration assessment related configuration.", + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates if migration assessment is enabled for this SQL Server instance." + }, + "assessmentUploadTime": { + "type": "string", + "format": "date-time", + "description": "The time when Migration Assessment Report upload was last performed.", + "readOnly": true + }, + "serverAssessments": { + "$ref": "#/definitions/ServerAssessments" + }, + "skuRecommendationResults": { + "$ref": "#/definitions/SkuRecommendationResults" + } + } + }, + "ClientConnection": { + "description": "Client connection related configuration.", + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates if client connection is enabled for this SQL Server instance." + } + } + }, + "ServiceType": { + "description": "Indicates if the resource represents a SQL Server engine or a SQL Server component service installed on the host.", + "type": "string", + "enum": [ + "Engine", + "SSRS", + "SSAS", + "SSIS", + "PBIRS" + ], + "x-ms-enum": { + "name": "serviceType", + "modelAsString": true, + "values": [ + { + "value": "Engine", + "description": "SQL Server Database Services." + }, + { + "value": "SSRS", + "description": "SQL Server Reporting Services." + }, + { + "value": "SSAS", + "description": "SQL Server Analysis Services." + }, + { + "value": "SSIS", + "description": "SQL Server Integration Services." + }, + { + "value": "PBIRS", + "description": "Power BI Report Server." + } + ] + } + }, + "ServerAssessments": { + "description": "Issues and warnings impacting the migration of SQL Server instance to particular Azure Migration Target.", + "readOnly": true, + "type": "array", + "items": { + "type": "object", + "properties": { + "appliesToMigrationTargetPlatform": { + "type": "string" + }, + "featureId": { + "type": "string" + }, + "impactedObjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "impactDetail": { + "type": "string" + }, + "name": { + "type": "string" + }, + "objectType": { + "type": "string" + } + } + } + }, + "issueCategory": { + "type": "string" + }, + "moreInformation": { + "type": "string" + } + } + } + }, + "SkuRecommendationResults": { + "description": "SKU Recommendation results for Azure migration targets for SQL Server.", + "readOnly": true, + "type": "object", + "properties": { + "azureSqlDatabase": { + "$ref": "#/definitions/SkuRecommendationResultsAzureSqlDatabase" + }, + "azureSqlManagedInstance": { + "$ref": "#/definitions/SkuRecommendationResultsAzureSqlManagedInstance" + }, + "azureSqlVirtualMachine": { + "$ref": "#/definitions/SkuRecommendationResultsAzureSqlVirtualMachine" + } + } + }, + "SkuRecommendationResultsAzureSqlDatabase": { + "description": "SKU Recommendation results for Azure SQL Database.", + "type": "object", + "properties": { + "recommendationStatus": { + "$ref": "./common.json#/definitions/SkuRecommendationResultsRecommendationStatus" + }, + "numberOfServerBlockerIssues": { + "$ref": "#/definitions/SkuRecommendationResultsNumberOfServerBlockerIssues" + }, + "monthlyCost": { + "$ref": "#/definitions/SkuRecommendationResultsMonthlyCost" + }, + "targetSku": { + "type": "object", + "properties": { + "category": { + "type": "object", + "properties": { + "computeTier": { + "type": "string", + "description": "The compute tier of the target SKU." + }, + "hardwareType": { + "type": "string", + "description": "The hardware type of the target SKU." + }, + "sqlPurchasingModel": { + "type": "string", + "description": "The SQL purchasing model of the target SKU." + }, + "sqlServiceTier": { + "type": "string", + "description": "The SQL service tier of the target SKU." + }, + "zoneRedundancyAvailable": { + "type": "boolean", + "description": "Indicates if zone redundancy is available for the target SKU." + } + } + } + } + } + } + }, + "SkuRecommendationResultsAzureSqlManagedInstance": { + "description": "SKU Recommendation results for Azure SQL Managed Instance.", + "type": "object", + "properties": { + "recommendationStatus": { + "$ref": "./common.json#/definitions/SkuRecommendationResultsRecommendationStatus" + }, + "numberOfServerBlockerIssues": { + "$ref": "#/definitions/SkuRecommendationResultsNumberOfServerBlockerIssues" + }, + "monthlyCost": { + "$ref": "#/definitions/SkuRecommendationResultsMonthlyCost" + }, + "targetSku": { + "type": "object", + "properties": { + "category": { + "type": "object", + "properties": { + "computeTier": { + "type": "string", + "description": "The compute tier of the target SKU." + }, + "hardwareType": { + "type": "string", + "description": "The hardware type of the target SKU." + }, + "sqlPurchasingModel": { + "type": "string", + "description": "The SQL purchasing model of the target SKU." + }, + "sqlServiceTier": { + "type": "string", + "description": "The SQL service tier of the target SKU." + }, + "zoneRedundancyAvailable": { + "type": "boolean", + "description": "Indicates if zone redundancy is available for the target SKU." + } + } + } + } + } + } + }, + "SkuRecommendationResultsAzureSqlVirtualMachine": { + "description": "SKU Recommendation results for Azure SQL Virtual Machine.", + "type": "object", + "properties": { + "recommendationStatus": { + "$ref": "./common.json#/definitions/SkuRecommendationResultsRecommendationStatus" + }, + "numberOfServerBlockerIssues": { + "$ref": "#/definitions/SkuRecommendationResultsNumberOfServerBlockerIssues" + }, + "monthlyCost": { + "$ref": "#/definitions/SkuRecommendationResultsMonthlyCost" + }, + "targetSku": { + "type": "object", + "properties": { + "category": { + "type": "object", + "properties": { + "availableVmSkus": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Available VM SKUs for the Azure SQL Virtual Machine." + }, + "virtualMachineFamily": { + "type": "string", + "description": "The virtual machine family of the target SKU." + } + } + } + } + } + } + }, + "SkuRecommendationResultsNumberOfServerBlockerIssues": { + "description": "Number of blocker issues to fix before migrating to the target platform.", + "type": "integer", + "format": "int32" + }, + "SkuRecommendationResultsMonthlyCost": { + "description": "The Monthly cost of the particular SKU.", + "type": "object", + "properties": { + "computeCost": { + "format": "float", + "description": "Represents the Cost of Compute.", + "type": "number" + }, + "storageCost": { + "format": "float", + "description": "Represents the Cost of Storage.", + "type": "number" + }, + "totalCost": { + "format": "float", + "description": "Represents the Total Cost.", + "type": "number" + } + } + }, + "SqlServerInstanceTelemetryRequest": { + "description": "The Arc SQL Server instance telemetry retrieval request.", + "type": "object", + "properties": { + "datasetName": { + "type": "string", + "description": "The name of the telemetry dataset to retrieve." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time for the time range to fetch telemetry for. If not specified, the current time minus 1 hour is used." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time for the time range to fetch telemetry for. If not specified, the current time is used." + }, + "interval": { + "type": "string", + "format": "duration", + "description": "The time granularity to fetch telemetry for. This is an ISO8601 duration. Examples: PT15M, PT1H, P1D", + "default": "PT1H" + }, + "aggregationType": { + "type": "string", + "description": "The aggregation type to use for the numerical columns in the dataset.", + "enum": [ + "Average", + "Minimum", + "Maximum", + "Sum", + "Count" + ], + "x-ms-enum": { + "name": "aggregationType", + "modelAsString": true + }, + "default": "Average" + }, + "databaseNames": { + "type": "array", + "description": "The list of database names to return telemetry for. If not specified, telemetry for all databases will be aggregated and returned.", + "items": { + "type": "string" + } + } + }, + "required": [ + "datasetName" + ] + }, + "SqlServerInstanceTelemetryColumn": { + "description": "The telemetry column for the SQL Server instance.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the telemetry column." + }, + "type": { + "type": "string", + "description": "The type of the telemetry column.", + "enum": [ + "bool", + "datetime", + "int", + "long", + "double", + "string", + "guid", + "timespan" + ], + "x-ms-enum": { + "name": "SqlServerInstanceTelemetryColumnType", + "modelAsString": true + } + } + } + }, + "SqlServerInstanceTelemetryRow": { + "description": "An array of values representing a telemetry row for the SQL Server instance.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "SqlServerInstanceTelemetryResponse": { + "description": "A section of the telemetry response for the SQL Server instance.", + "type": "object", + "properties": { + "columns": { + "description": "The columns of the result telemetry table for the SQL Server instance.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlServerInstanceTelemetryColumn" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "rows": { + "description": "A list of rows from the result telemetry table for the SQL Server instance.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlServerInstanceTelemetryRow" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "The link to the next section of rows of the telemetry response for the SQL Server instance. Null if no more sections are available.", + "readOnly": true + } + }, + "required": [ + "columns", + "rows" + ] + }, + "SqlServerInstanceRunMigrationAssessmentResponse": { + "description": "The response for running migration assessment on the SQL Server instance.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the job." + }, + "instanceName": { + "type": "string", + "description": "The name of the SQL Server instance." + }, + "jobStatus": { + "type": "string", + "description": "The status of the job.", + "enum": [ + "NotStarted", + "InProgress", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "jobStatus", + "modelAsString": true + } + }, + "jobException": { + "type": "string", + "description": "The exception message if the job failed." + }, + "backgroundJob": { + "type": "object", + "description": "The background job details.", + "$ref": "#/definitions/BackgroundJob" + }, + "sequencerActions": { + "type": "array", + "description": "The list of sequencer actions.", + "items": { + "$ref": "#/definitions/SequencerAction" + }, + "x-ms-identifiers": [ + "actionId" + ] + } + } + }, + "SqlServerInstanceJobsStatusRequest": { + "description": "The request for the status of the jobs running on the SQL Server instance.", + "type": "object", + "properties": { + "featureName": { + "type": "string", + "description": "The name of the feature to retrieve the job status for." + }, + "jobType": { + "type": "string", + "description": "The type of the job to retrieve the status for." + } + } + }, + "SqlServerInstanceJobsStatusResponse": { + "description": "The response for the status of the jobs running on the SQL Server instance.", + "type": "object", + "properties": { + "jobsStatus": { + "type": "array", + "description": "The list of jobs status running on the SQL Server instance.", + "items": { + "$ref": "#/definitions/SqlServerInstanceJobStatus" + }, + "x-ms-identifiers": [ + "id" + ] + } + } + }, + "SqlServerInstanceJobStatus": { + "description": "The status of the job running on the SQL Server instance.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the job." + }, + "instanceName": { + "type": "string", + "description": "The name of the SQL Server instance." + }, + "jobStatus": { + "type": "string", + "description": "The status of the job.", + "enum": [ + "NotStarted", + "InProgress", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "jobStatus", + "modelAsString": true + } + }, + "jobException": { + "type": "string", + "description": "The exception message if the job failed." + }, + "backgroundJob": { + "type": "object", + "description": "The background job details.", + "$ref": "#/definitions/BackgroundJob" + }, + "sequencerActions": { + "type": "array", + "description": "The list of sequencer actions.", + "items": { + "$ref": "#/definitions/SequencerAction" + }, + "x-ms-identifiers": [ + "actionId" + ] + } + } + }, + "BackgroundJob": { + "description": "The background job details.", + "type": "object", + "properties": { + "state": { + "type": "string", + "description": "The state of the background job.", + "enum": [ + "Enabled", + "Disabled", + "Deleted", + "Completed", + "Faulted", + "Suspended" + ], + "x-ms-enum": { + "name": "state", + "modelAsString": true + } + }, + "executionState": { + "type": "string", + "description": "The execution state of the background job.", + "enum": [ + "Waiting", + "Running" + ], + "x-ms-enum": { + "name": "executionState", + "modelAsString": true + } + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the background job." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the background job." + }, + "lastExecutionStatus": { + "type": "string", + "description": "The last execution status of the background job.", + "enum": [ + "Succeeded", + "Completed", + "Failed", + "Faulted", + "Postponed", + "Rescheduled" + ], + "x-ms-enum": { + "name": "lastExecutionStatus", + "modelAsString": true + } + }, + "lastExecutionTime": { + "type": "string", + "format": "date-time", + "description": "The last execution time of the background job." + } + } + }, + "SequencerAction": { + "description": "The sequencer action details.", + "type": "object", + "properties": { + "actionId": { + "type": "string", + "description": "The unique identifier of the sequencer action." + }, + "state": { + "type": "string", + "description": "The state of the sequencer action.", + "enum": [ + "NotStarted", + "WaitingPredecessors", + "ExecutingAction", + "CreatingSuccessors", + "Completed" + ], + "x-ms-enum": { + "name": "sequencerState", + "modelAsString": true + } + }, + "result": { + "type": "string", + "description": "The result of the sequencer action.", + "enum": [ + "NotCompleted", + "Succeeded", + "Failed", + "TimedOut", + "Skipped" + ], + "x-ms-enum": { + "name": "result", + "modelAsString": true + } + } + } + } + }, + "parameters": { + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerLicenses.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerLicenses.json new file mode 100644 index 000000000000..a54c9f98d397 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerLicenses.json @@ -0,0 +1,259 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "paths": {}, + "definitions": { + "SqlServerLicense": { + "description": "Describe SQL Server license resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlServerLicenseProperties", + "description": "SQL Server license properties", + "x-ms-client-flatten": false + } + }, + "required": [ + "properties" + ] + }, + "SqlServerLicenseProperties": { + "description": "Properties of SQL Server License.", + "type": "object", + "properties": { + "billingPlan": { + "type": "string", + "description": "SQL Server license type.", + "enum": [ + "PAYG", + "Paid" + ], + "x-ms-enum": { + "name": "billingPlan", + "modelAsString": true + } + }, + "physicalCores": { + "type": "integer", + "format": "int32", + "multipleOf": 2, + "minimum": 16, + "description": "The number of total cores of the license covers." + }, + "licenseCategory": { + "type": "string", + "description": "This property represents the choice between SQL Server Core and ESU licenses.", + "enum": [ + "Core" + ], + "x-ms-enum": { + "name": "licenseCategory", + "modelAsString": true + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "activationState": { + "type": "string", + "description": "The activation state of the license.", + "enum": [ + "Activated", + "Deactivated" + ], + "x-ms-enum": { + "name": "activationState", + "modelAsString": true + } + }, + "scopeType": { + "type": "string", + "description": "The Azure scope to which the license will apply.", + "enum": [ + "Tenant", + "Subscription", + "ResourceGroup" + ], + "x-ms-enum": { + "name": "scopeType", + "modelAsString": true + } + }, + "lastActivatedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the most recent activation of the SqlServerLicense.", + "readOnly": true + }, + "lastDeactivatedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the most recent deactivation of the SqlServerLicense.", + "readOnly": true + }, + "tenantId": { + "type": "string", + "description": "The tenantId the SQL Server license resource subscription resides in.", + "readOnly": true + } + }, + "required": [ + "billingPlan", + "physicalCores", + "licenseCategory", + "scopeType", + "activationState" + ] + }, + "SqlServerLicenseUpdateProperties": { + "description": "Properties of update SqlServerLicense.", + "type": "object", + "properties": { + "billingPlan": { + "type": "string", + "description": "SQL Server license type.", + "enum": [ + "PAYG", + "Paid" + ], + "x-ms-enum": { + "name": "billingPlan", + "modelAsString": true + } + }, + "physicalCores": { + "type": "integer", + "format": "int32", + "multipleOf": 2, + "minimum": 16, + "description": "The number of total cores of the license covers." + }, + "licenseCategory": { + "type": "string", + "description": "This property represents the choice between SQL Server Core and ESU licenses.", + "enum": [ + "Core" + ], + "x-ms-enum": { + "name": "licenseCategory", + "modelAsString": true + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "activationState": { + "type": "string", + "description": "The activation state of the license.", + "enum": [ + "Activated", + "Deactivated" + ], + "x-ms-enum": { + "name": "activationState", + "modelAsString": true + } + }, + "scopeType": { + "type": "string", + "description": "The Azure scope to which the license will apply.", + "enum": [ + "Tenant", + "Subscription", + "ResourceGroup" + ], + "x-ms-enum": { + "name": "scopeType", + "modelAsString": true + } + }, + "lastActivatedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the most recent activation of the SqlServerLicense.", + "readOnly": true + }, + "lastDeactivatedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the most recent deactivation of the SqlServerLicense.", + "readOnly": true + }, + "tenantId": { + "type": "string", + "description": "The tenantId the SQL Server license resource subscription resides in.", + "readOnly": true + } + } + }, + "SqlServerLicenseUpdate": { + "description": "An update to a SQL Server license resource.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/SqlServerLicenseUpdateProperties", + "description": "null", + "x-ms-client-flatten": false + } + } + }, + "SqlServerLicenseListResult": { + "description": "A list of SQL Server licenses.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlServerLicense" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/readme.md b/specification/azurearcdata/resource-manager/readme.md index a8737cff2a94..f422b91b3609 100644 --- a/specification/azurearcdata/resource-manager/readme.md +++ b/specification/azurearcdata/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the azurearcdata. ``` yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2024-01 +tag: package-preview-2024-05 ``` ``` yaml @@ -44,6 +44,27 @@ directive: reason: No Unicode support for attribute pattern regex on sqlServerInstanceName and others. This should be fixed by tooling. ``` +### Tag: package-preview-2024-05 + +These settings apply only when `--tag=package-preview-2024-05` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-05' +input-file: + - Microsoft.AzureArcData/preview/2024-05-01-preview/activeDirectoryConnectors.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/azurearcdata.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/common.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/dataControllers.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/failoverGroups.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/operations.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/postgresInstances.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/sqlManagedInstances.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerAvailabilityGroups.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerDatabases.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerEsuLicenses.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerInstances.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerLicenses.json +``` + ### Tag: package-2024-01 These settings apply only when `--tag=package-2024-01` is specified on the command line. From 38fbce55a04e1615ce683d288cdcb5fa4ec4251f Mon Sep 17 00:00:00 2001 From: Sneha Nagendra <47864291+snehanagendra@users.noreply.github.com> Date: Mon, 30 Sep 2024 16:26:42 -0700 Subject: [PATCH 20/47] Add 2024-10-01-preview dataplane API version to the DevCenter (#30696) * Add base 2024-10-01-preview typespec changes, examples * Add SopOnNoConnect configuration for pool resource * Add LRO for capture snapshot, snapshot type enum * Add lastConnectedTime property on devbox * update comment per feedback --------- Co-authored-by: Sneha Nagendra <snnagen@microsoft.com> --- .../devcenter/DevCenter/DevBox/models.tsp | 66 + .../devcenter/DevCenter/DevBox/routes.tsp | 11 + .../DevBoxes_CaptureSnapshotDevBox.json | 25 + .../DevBoxes_CreateCustomizationGroup.json | 57 + .../DevBoxes_CreateDevBox.json | 74 + .../DevBoxes_DelayAction.json | 29 + .../DevBoxes_DelayActions.json | 51 + .../DevBoxes_DelayActionsWithError.json | 43 + .../DevBoxes_DeleteDevBox.json | 26 + .../DevBoxes_GetAction.json | 27 + .../DevBoxes_GetCustomizationGroup.json | 44 + ...Boxes_GetCustomizationTaskDefinitions.json | 36 + .../DevBoxes_GetCustomizationTaskLog.json | 18 + .../DevBoxes_GetDevBoxByUser.json | 41 + .../DevBoxes_GetImagingTaskLog.json | 15 + .../DevBoxes_GetOperation.json | 25 + .../2024-10-01-preview/DevBoxes_GetPool.json | 45 + .../DevBoxes_GetRemoteConnection.json | 18 + .../DevBoxes_GetScheduleByPool.json | 25 + .../DevBoxes_GetSnapshot.json | 21 + .../DevBoxes_ListActions.json | 42 + .../DevBoxes_ListAllDevBoxes.json | 42 + .../DevBoxes_ListAllDevBoxesByUser.json | 44 + .../DevBoxes_ListCustomizationGroups.json | 68 + ...s_ListCustomizationGroupsWithoutTasks.json | 32 + ...CustomizationTaskDefinitionsByProject.json | 53 + .../DevBoxes_ListDevBoxesByUser.json | 44 + .../DevBoxes_ListOperations.json | 42 + .../DevBoxes_ListPools.json | 79 + .../DevBoxes_ListSchedulesByPool.json | 28 + .../DevBoxes_ListSchedulesByProject.json | 27 + .../DevBoxes_ListSnapshots.json | 30 + .../DevBoxes_RepairDevBox.json | 25 + .../DevBoxes_RestartDevBox.json | 25 + .../DevBoxes_RestoreSnapshotDevBox.json | 26 + .../DevBoxes_SkipAction.json | 15 + .../DevBoxes_StartDevBox.json | 25 + .../DevBoxes_StopDevBox.json | 26 + ...oxes_ValidateCustomizationTasksAction.json | 40 + ...teCustomizationTasksActionWithFailure.json | 53 + .../DevCenter_GetProject.json | 19 + .../DevCenter_GetProjectAbilities.json | 37 + .../DevCenter_ListProjects.json | 22 + ...vironments_CreateOrReplaceEnvironment.json | 43 + .../Environments_DelayAction.json | 27 + .../Environments_DeleteEnvironment.json | 26 + .../Environments_ForceDeleteEnvironment.json | 27 + .../Environments_GetAction.json | 26 + .../Environments_GetCatalog.json | 18 + .../Environments_GetEnvironmentByUser.json | 30 + ...Environments_GetEnvironmentDefinition.json | 58 + ...ironments_GetEnvironmentTypeAbilities.json | 28 + .../Environments_GetEnvironmentTypes.json | 21 + .../Environments_GetLogsByOperation.json | 17 + .../Environments_GetOperation.json | 29 + .../Environments_GetOutputs.json | 51 + .../Environments_ListActions.json | 39 + .../Environments_ListCatalogsByProject.json | 21 + ...s_ListEnvironmentDefinitionsByCatalog.json | 69 + ...s_ListEnvironmentDefinitionsByProject.json | 68 + .../Environments_ListEnvironmentTypes.json | 24 + .../Environments_ListEnvironments.json | 32 + .../Environments_ListEnvironmentsByUser.json | 33 + .../Environments_ListOperations.json | 32 + .../Environments_PatchEnvironment.json | 32 + .../Environments_SkipAction.json | 21 + .../OperationStatuses_Get.json | 19 + specification/devcenter/DevCenter/main.tsp | 4 + .../preview/2024-10-01-preview/devcenter.json | 7219 +++++++++++++++++ .../DevBoxes_CaptureSnapshotDevBox.json | 25 + .../DevBoxes_CreateCustomizationGroup.json | 57 + .../examples/DevBoxes_CreateDevBox.json | 74 + .../examples/DevBoxes_DelayAction.json | 29 + .../examples/DevBoxes_DelayActions.json | 51 + .../examples/DevBoxes_DeleteDevBox.json | 26 + .../examples/DevBoxes_GetAction.json | 27 + .../DevBoxes_GetCustomizationGroup.json | 44 + ...Boxes_GetCustomizationTaskDefinitions.json | 36 + .../DevBoxes_GetCustomizationTaskLog.json | 18 + .../examples/DevBoxes_GetDevBoxByUser.json | 41 + .../examples/DevBoxes_GetImagingTaskLog.json | 15 + .../examples/DevBoxes_GetOperation.json | 25 + .../examples/DevBoxes_GetPool.json | 45 + .../DevBoxes_GetRemoteConnection.json | 18 + .../examples/DevBoxes_GetScheduleByPool.json | 25 + .../examples/DevBoxes_GetSnapshot.json | 21 + .../examples/DevBoxes_ListActions.json | 42 + .../examples/DevBoxes_ListAllDevBoxes.json | 42 + .../DevBoxes_ListAllDevBoxesByUser.json | 44 + .../DevBoxes_ListCustomizationGroups.json | 68 + ...CustomizationTaskDefinitionsByProject.json | 53 + .../examples/DevBoxes_ListDevBoxesByUser.json | 44 + .../examples/DevBoxes_ListOperations.json | 42 + .../examples/DevBoxes_ListPools.json | 79 + .../DevBoxes_ListSchedulesByPool.json | 28 + .../DevBoxes_ListSchedulesByProject.json | 27 + .../examples/DevBoxes_ListSnapshots.json | 30 + .../examples/DevBoxes_RepairDevBox.json | 25 + .../examples/DevBoxes_RestartDevBox.json | 25 + .../DevBoxes_RestoreSnapshotDevBox.json | 26 + .../examples/DevBoxes_SkipAction.json | 15 + .../examples/DevBoxes_StartDevBox.json | 25 + .../examples/DevBoxes_StopDevBox.json | 26 + ...oxes_ValidateCustomizationTasksAction.json | 40 + .../examples/DevCenter_GetProject.json | 19 + .../DevCenter_GetProjectAbilities.json | 37 + .../examples/DevCenter_ListProjects.json | 22 + ...vironments_CreateOrReplaceEnvironment.json | 43 + .../examples/Environments_DelayAction.json | 27 + .../Environments_DeleteEnvironment.json | 26 + .../Environments_ForceDeleteEnvironment.json | 27 + .../examples/Environments_GetAction.json | 26 + .../examples/Environments_GetCatalog.json | 18 + .../Environments_GetEnvironmentByUser.json | 30 + ...Environments_GetEnvironmentDefinition.json | 58 + ...ironments_GetEnvironmentTypeAbilities.json | 28 + .../Environments_GetEnvironmentTypes.json | 21 + .../Environments_GetLogsByOperation.json | 17 + .../examples/Environments_GetOperation.json | 29 + .../examples/Environments_GetOutputs.json | 51 + .../examples/Environments_ListActions.json | 39 + .../Environments_ListCatalogsByProject.json | 21 + ...s_ListEnvironmentDefinitionsByCatalog.json | 69 + ...s_ListEnvironmentDefinitionsByProject.json | 68 + .../Environments_ListEnvironmentTypes.json | 24 + .../Environments_ListEnvironments.json | 32 + .../Environments_ListEnvironmentsByUser.json | 33 + .../examples/Environments_ListOperations.json | 32 + .../Environments_PatchEnvironment.json | 32 + .../examples/Environments_SkipAction.json | 21 + .../examples/OperationStatuses_Get.json | 19 + specification/devcenter/data-plane/readme.md | 17 +- 132 files changed, 11698 insertions(+), 1 deletion(-) create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CaptureSnapshotDevBox.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CreateCustomizationGroup.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CreateDevBox.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayAction.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayActions.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayActionsWithError.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DeleteDevBox.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetAction.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationGroup.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationTaskDefinitions.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationTaskLog.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetDevBoxByUser.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetImagingTaskLog.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetOperation.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetPool.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetRemoteConnection.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetScheduleByPool.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetSnapshot.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListActions.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListAllDevBoxes.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListAllDevBoxesByUser.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationGroups.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationGroupsWithoutTasks.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationTaskDefinitionsByProject.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListDevBoxesByUser.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListOperations.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListPools.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSchedulesByPool.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSchedulesByProject.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSnapshots.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RepairDevBox.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestartDevBox.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestoreSnapshotDevBox.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_SkipAction.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_StartDevBox.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_StopDevBox.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ValidateCustomizationTasksAction.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ValidateCustomizationTasksActionWithFailure.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_GetProject.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_GetProjectAbilities.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_ListProjects.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_CreateOrReplaceEnvironment.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_DelayAction.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_DeleteEnvironment.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ForceDeleteEnvironment.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetAction.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetCatalog.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentByUser.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentDefinition.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentTypeAbilities.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentTypes.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetLogsByOperation.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetOperation.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetOutputs.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListActions.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListCatalogsByProject.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentDefinitionsByCatalog.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentDefinitionsByProject.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentTypes.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironments.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentsByUser.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListOperations.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_PatchEnvironment.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_SkipAction.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/OperationStatuses_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/devcenter.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CaptureSnapshotDevBox.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CreateCustomizationGroup.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CreateDevBox.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DelayAction.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DelayActions.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DeleteDevBox.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetAction.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationGroup.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationTaskDefinitions.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationTaskLog.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetDevBoxByUser.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetImagingTaskLog.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetOperation.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetPool.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetRemoteConnection.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetScheduleByPool.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetSnapshot.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListActions.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListAllDevBoxes.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListAllDevBoxesByUser.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListCustomizationGroups.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListCustomizationTaskDefinitionsByProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListDevBoxesByUser.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListOperations.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListPools.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSchedulesByPool.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSchedulesByProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSnapshots.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RepairDevBox.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestartDevBox.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestoreSnapshotDevBox.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_SkipAction.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_StartDevBox.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_StopDevBox.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ValidateCustomizationTasksAction.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_GetProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_GetProjectAbilities.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_ListProjects.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_CreateOrReplaceEnvironment.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_DelayAction.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_DeleteEnvironment.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ForceDeleteEnvironment.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetAction.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetCatalog.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentByUser.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentDefinition.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentTypeAbilities.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentTypes.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetLogsByOperation.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetOperation.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetOutputs.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListActions.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListCatalogsByProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentDefinitionsByCatalog.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentDefinitionsByProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentTypes.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironments.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentsByUser.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListOperations.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_PatchEnvironment.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_SkipAction.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/OperationStatuses_Get.json diff --git a/specification/devcenter/DevCenter/DevBox/models.tsp b/specification/devcenter/DevCenter/DevBox/models.tsp index 3300bbd0ba9e..a3f225c5ea4d 100644 --- a/specification/devcenter/DevCenter/DevBox/models.tsp +++ b/specification/devcenter/DevCenter/DevBox/models.tsp @@ -142,6 +142,18 @@ union StopOnDisconnectEnableStatus { string, } +@doc("Stop on no connect enable or disable status.") +@added(APIVersions.v2024_10_01_preview) +union StopOnNoConnectEnableStatus { + @doc("Stop on no connect is enabled on the Dev Box.") + Enabled: "Enabled", + + @doc("Stop on no connect is not enabled on the Dev Box.") + Disabled: "Disabled", + + string, +} + @doc("Pool status indicating whether a pool is available to create Dev Boxes.") union PoolHealthStatus { @doc("The pool health status is not known.") @@ -359,6 +371,10 @@ union DevBoxOperationKind { @added(APIVersions.v2024_09_01_preview) RestoreSnapshot: "RestoreSnapshot", + @doc("The operation represents a Dev Box manual snapshot creation.") + @added(APIVersions.v2024_10_01_preview) + CaptureSnapshot: "CaptureSnapshot", + string, } @@ -377,6 +393,18 @@ union DevBoxRepairOutcome { string, } +@doc("The type of snapshot.") +@added(APIVersions.v2024_10_01_preview) +union SnapshotType { + @doc("The snapshot type indicates that this is a manually taken snapshot.") + Manual: "Manual", + + @doc("The snapshot type indicates that this is an automatically taken snapshot.") + Automatic: "Automatic", + + string, +} + @doc("A pool of Dev Boxes.") @resource("pools") @parentResource(Project) @@ -420,6 +448,10 @@ model Pool { @doc("Stop on disconnect configuration settings for Dev Boxes created in this pool.") stopOnDisconnect?: StopOnDisconnectConfiguration; + @doc("Stop on no connect configuration settings for Dev Boxes created in this pool.") + @added(APIVersions.v2024_10_01_preview) + stopOnNoConnect?: StopOnNoConnectConfiguration; + @doc(""" Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes. @@ -500,6 +532,18 @@ model StopOnDisconnectConfiguration { gracePeriodMinutes?: int32; } +@doc("Stop on no connect configuration settings for Dev Boxes created in this pool.") +@added(APIVersions.v2024_10_01_preview) +model StopOnNoConnectConfiguration { + @doc(""" + Enables the feature to stop a started Dev Box when it has not been connected to, once the grace period has lapsed. + """) + status: StopOnNoConnectEnableStatus; + + @doc("The specified time in minutes to wait before stopping a Dev Box if no connection is made. This will only be present if stop on no connect is enabled.") + gracePeriodMinutes?: int32; +} + alias ScheduleListResult = Azure.Core.Page<Schedule>; @doc("A Schedule to execute action.") @@ -631,6 +675,11 @@ model DevBox { @visibility("read") createdTime?: utcDateTime; + @doc("Last time a user connected to this Dev Box, in RFC3339 format.") + @visibility("read") + @added(APIVersions.v2024_10_01_preview) + lastConnectedTime?: utcDateTime; + @doc("Indicates whether the owner of the Dev Box is a local administrator.") @visibility("read", "create") localAdministrator?: LocalAdminStatus; @@ -803,6 +852,13 @@ model DevBoxRestoreSnapshotOperation extends DevBoxOperation { kind: DevBoxOperationKind.RestoreSnapshot; } +@doc("Information about a snapshot creation operation on a Dev Box.") +@added(APIVersions.v2024_10_01_preview) +model DevBoxCaptureSnapshotOperation extends DevBoxOperation { + @doc("The kind of operation that occurred.") + kind: DevBoxOperationKind.CaptureSnapshot; +} + @doc("The Customization Task list result.") model PagedCustomizationTaskDefinition is Azure.Core.Page<CustomizationTaskDefinition>; @@ -981,4 +1037,14 @@ model DevBoxSnapshot { @doc("The datetime that the snapshot was created, in RFC3339 format.") @visibility("read") createdTime: utcDateTime; + + @doc("The datetime when the snapshot expires, will only be shown for a manual snapshot, in RFC3339 format.") + @visibility("read") + @added(APIVersions.v2024_10_01_preview) + expirationTime?: utcDateTime; + + @doc("The type of the snapshot indicates whether it is manual or automatic.") + @visibility("read") + @added(APIVersions.v2024_10_01_preview) + snapshotType: SnapshotType; } diff --git a/specification/devcenter/DevCenter/DevBox/routes.tsp b/specification/devcenter/DevCenter/DevBox/routes.tsp index d43ef877e44c..b203fcedf8b0 100644 --- a/specification/devcenter/DevCenter/DevBox/routes.tsp +++ b/specification/devcenter/DevCenter/DevBox/routes.tsp @@ -439,4 +439,15 @@ interface DevBoxes { }, OperationStatus >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Replacing Status Monitor" + @doc("Captures a manual snapshot of the Dev Box.") + @added(APIVersions.v2024_10_01_preview) + @pollingOperation(OperationStatuses.get) + @action("captureSnapshot") + captureSnapshotDevBox is DevCenterOps.LongRunningResourceAction< + DevBox, + {}, + OperationStatus + >; } diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CaptureSnapshotDevBox.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CaptureSnapshotDevBox.json new file mode 100644 index 000000000000..1306f8183682 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CaptureSnapshotDevBox.json @@ -0,0 +1,25 @@ +{ + "title": "Attempts to capture the manual snapshot for the Dev Box.", + "operationId": "DevBoxes_CaptureSnapshotDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CreateCustomizationGroup.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CreateCustomizationGroup.json new file mode 100644 index 000000000000..0ce11d294f54 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CreateCustomizationGroup.json @@ -0,0 +1,57 @@ +{ + "title": "Applies customizations to the Dev Box.", + "operationId": "DevBoxes_CreateCustomizationGroup", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "customizationGroupName": "Provisioning", + "body": { + "tasks": [ + { + "name": "catalogName/choco", + "displayName": "Install VS Code", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + } + }, + { + "name": "catalogName/write-to-file", + "runAs": "User" + } + ] + } + }, + "responses": { + "200": { + "body": { + "name": "Provisioning", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning", + "tasks": [ + { + "id": "a9202018-fb6a-4007-8b52-26d7c6d1c1fb", + "name": "catalogName/choco", + "displayName": "Install VS Code", + "status": "NotStarted", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + }, + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/a9202018-fb6a-4007-8b52-26d7c6d1c1fb" + }, + { + "id": "91835dc0-ef5a-4f58-9e3a-099aea8481f4", + "name": "catalogName/write-to-file", + "runAs": "User", + "status": "NotStarted", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/91835dc0-ef5a-4f58-9e3a-099aea8481f4" + } + ], + "status": "NotStarted" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CreateDevBox.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CreateDevBox.json new file mode 100644 index 000000000000..3b2a85f411d0 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CreateDevBox.json @@ -0,0 +1,74 @@ +{ + "title": "Creates or replaces a Dev Box.", + "operationId": "DevBoxes_CreateDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "body": { + "poolName": "LargeDevWorkStationPool" + } + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + }, + "201": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Creating", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayAction.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayAction.json new file mode 100644 index 000000000000..83f344d66d86 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayAction.json @@ -0,0 +1,29 @@ +{ + "title": "Delays the occurrence of an action.", + "operationId": "DevBoxes_DelayAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "actionName": "schedule-default", + "until": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "actionType": "Stop", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", + "suspendedUntil": "2022-09-30T17:00:00Z", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayActions.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayActions.json new file mode 100644 index 000000000000..89db45645b88 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayActions.json @@ -0,0 +1,51 @@ +{ + "title": "Delays all actions.", + "operationId": "DevBoxes_DelayActions", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "until": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "result": "Succeeded", + "action": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", + "suspendedUntil": "2022-09-30T17:00:00Z", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "result": "Succeeded", + "action": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool", + "sourceType": "Pool", + "suspendedUntil": "2022-09-30T17:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayActionsWithError.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayActionsWithError.json new file mode 100644 index 000000000000..f512eee91740 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayActionsWithError.json @@ -0,0 +1,43 @@ +{ + "title": "Delays all actions with an error.", + "operationId": "DevBoxes_DelayActionsWithError", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "until": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "result": "Failed", + "error": { + "code": "DelayOverMaxTime", + "message": "The schedule cannot be delayed more than 8 hours from the original invocation time." + } + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "result": "Succeeded", + "action": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool", + "sourceType": "Pool", + "suspendedUntil": "2022-09-30T17:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DeleteDevBox.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DeleteDevBox.json new file mode 100644 index 000000000000..f4a9c9cf9b65 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DeleteDevBox.json @@ -0,0 +1,26 @@ +{ + "title": "Deletes a Dev Box.", + "operationId": "DevBoxes_DeleteDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetAction.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetAction.json new file mode 100644 index 000000000000..2d62c465e19d --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetAction.json @@ -0,0 +1,27 @@ +{ + "title": "Gets an action.", + "operationId": "DevBoxes_GetAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "actionName": "schedule-default" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationGroup.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationGroup.json new file mode 100644 index 000000000000..df202ebc899f --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationGroup.json @@ -0,0 +1,44 @@ +{ + "title": "Gets a customization group.", + "operationId": "DevBoxes_GetCustomizationGroup", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "customizationGroupName": "Provisioning" + }, + "responses": { + "200": { + "body": { + "name": "Provisioning", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning", + "tasks": [ + { + "id": "a9202018-fb6a-4007-8b52-26d7c6d1c1fb", + "name": "catalogName/choco", + "displayName": "Install VS Code", + "status": "Succeeded", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + }, + "startTime": "2021-08-05T18:00:00.000Z", + "endTime": "2021-08-05T18:00:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/a9202018-fb6a-4007-8b52-26d7c6d1c1fb" + }, + { + "id": "91835dc0-ef5a-4f58-9e3a-099aea8481f4", + "name": "catalogName/write-to-file", + "status": "Running", + "startTime": "2021-08-05T18:00:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/91835dc0-ef5a-4f58-9e3a-099aea8481f4" + } + ], + "status": "Running", + "startTime": "2021-08-05T18:00:00.000Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationTaskDefinitions.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationTaskDefinitions.json new file mode 100644 index 000000000000..9922353497d3 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationTaskDefinitions.json @@ -0,0 +1,36 @@ +{ + "title": "Gets a customization task.", + "operationId": "DevBoxes_GetCustomizationTaskDefinitions", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "api-version": "2024-10-01-preview", + "catalogName": "myCatalog", + "taskName": "choco" + }, + "responses": { + "200": { + "body": { + "name": "myCatalog/choco", + "catalogName": "myCatalog", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/customizationtasks/choco", + "description": "Install a package via chocolatey", + "parameters": { + "package": { + "description": "The package to install", + "type": "string", + "required": true + }, + "version": { + "description": "The version of the package", + "type": "string", + "default": "latest" + }, + "retryOnFail": { + "type": "boolean" + } + } + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationTaskLog.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationTaskLog.json new file mode 100644 index 000000000000..a23db3682380 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationTaskLog.json @@ -0,0 +1,18 @@ +{ + "title": "Gets the log for a customization task.", + "operationId": "DevBoxes_GetCustomizationTaskLog", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "4863c6d0-e979-4a36-ac8d-80029debfd80", + "devBoxName": "MyDevBox", + "customizationGroupName": "Provisioning", + "customizationTaskId": "91835dc0-ef5a-4f58-9e3a-099aea8481f4" + }, + "responses": { + "200": { + "body": "WzIwMjMtMDgtMTBUMTA6MTk6NTUuODIwMTAxKzAwOjAwXSBDaG9jb2xhdGV5IHYxLjMuMVxuWzIwMjMtMDgtMTBUMTA6MTk6NTUuOTEzMjk3KzAwOjAwXSAyIHZhbGlkYXRpb25zIHBlcmZvcm1lZC4gMSBzdWNjZXNzKGVzKSwgMSB3YXJuaW5nKHMpLCBhbmQgMCBlcnJvcihzKS4=" + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetDevBoxByUser.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetDevBoxByUser.json new file mode 100644 index 000000000000..4f37e7673039 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetDevBoxByUser.json @@ -0,0 +1,41 @@ +{ + "title": "Gets a Dev Box.", + "operationId": "DevBoxes_GetDevBoxByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastConnectedTime": "2022-04-01T00:13:23.323Z", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetImagingTaskLog.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetImagingTaskLog.json new file mode 100644 index 000000000000..cc7fabcf2337 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetImagingTaskLog.json @@ -0,0 +1,15 @@ +{ + "title": "Gets the log for an imaging build task.", + "operationId": "DevBoxes_GetImagingTaskLog", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "imageBuildLogId": "91835dc0-ef5a-4f58-9e3a-099aea8481f4" + }, + "responses": { + "200": { + "body": "WzIwMjMtMDgtMTBUMTA6MTk6NTUuODIwMTAxKzAwOjAwXSBDaG9jb2xhdGV5IHYxLjMuMVxuWzIwMjMtMDgtMTBUMTA6MTk6NTUuOTEzMjk3KzAwOjAwXSAyIHZhbGlkYXRpb25zIHBlcmZvcm1lZC4gMSBzdWNjZXNzKGVzKSwgMSB3YXJuaW5nKHMpLCBhbmQgMCBlcnJvcihzKS4=" + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetOperation.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetOperation.json new file mode 100644 index 000000000000..a7f76d9d7c13 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetOperation.json @@ -0,0 +1,25 @@ +{ + "title": "Gets an operation on a Dev Box.", + "operationId": "DevBoxes_GetOperation", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/devBoxes/myDevBox/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Start", + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetPool.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetPool.json new file mode 100644 index 000000000000..06b37d499a33 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetPool.json @@ -0,0 +1,45 @@ +{ + "title": "Gets a pool.", + "operationId": "DevBoxes_GetPool", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "api-version": "2024-10-01-preview", + "poolName": "DevPool" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/LargeDevWorkStationPool", + "name": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + }, + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "healthStatus": "Healthy", + "displayName": "LargePool" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetRemoteConnection.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetRemoteConnection.json new file mode 100644 index 000000000000..8f8f9dc03d70 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetRemoteConnection.json @@ -0,0 +1,18 @@ +{ + "title": "Gets RDP Connection info.", + "operationId": "DevBoxes_GetRemoteConnection", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "200": { + "body": { + "webUrl": "https://connectionUrl" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetScheduleByPool.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetScheduleByPool.json new file mode 100644 index 000000000000..a0ed28a46bbc --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetScheduleByPool.json @@ -0,0 +1,25 @@ +{ + "title": "Gets a schedule.", + "operationId": "DevBoxes_GetScheduleByPool", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "api-version": "2024-10-01-preview", + "poolName": "DevPool", + "scheduleName": "default" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", + "name": "default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool", + "sourceType": "Pool", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetSnapshot.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetSnapshot.json new file mode 100644 index 000000000000..f62c94303145 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetSnapshot.json @@ -0,0 +1,21 @@ +{ + "title": "Gets a snapshot by snapshot id.", + "operationId": "DevBoxes_GetSnapshot", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6797" + }, + "responses": { + "200": { + "body": { + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6797", + "createdTime": "2022-09-30T15:23:00Z", + "snapshotType": "Automatic" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListActions.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListActions.json new file mode 100644 index 000000000000..c73522362510 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListActions.json @@ -0,0 +1,42 @@ +{ + "title": "Lists actions on a Dev Box.", + "operationId": "DevBoxes_ListActions", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool", + "sourceType": "Pool", + "next": { + "scheduledTime": "2022-09-30T15:23:00Z" + } + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", + "suspendedUntil": "2022-09-30T17:00:00Z", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListAllDevBoxes.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListAllDevBoxes.json new file mode 100644 index 000000000000..d191b87a886b --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListAllDevBoxes.json @@ -0,0 +1,42 @@ +{ + "title": "Lists Dev Boxes that the caller has access to in the DevCenter.", + "operationId": "DevBoxes_ListAllDevBoxes", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastConnectedTime": "2022-04-01T00:13:23.323Z", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListAllDevBoxesByUser.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListAllDevBoxesByUser.json new file mode 100644 index 000000000000..f76e593664da --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListAllDevBoxesByUser.json @@ -0,0 +1,44 @@ +{ + "title": "Lists Dev Boxes in the project for a particular user.", + "operationId": "DevBoxes_ListAllDevBoxesByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastConnectedTime": "2022-04-01T00:13:23.323Z", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationGroups.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationGroups.json new file mode 100644 index 000000000000..25efb85d3eed --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationGroups.json @@ -0,0 +1,68 @@ +{ + "title": "Lists customization groups on the Dev Box. Listed customization groups exclude task information unless specified via the include parameter.", + "operationId": "DevBoxes_ListCustomizationGroups", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "include": "tasks" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Provisioning", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning", + "tasks": [ + { + "id": "a9202018-fb6a-4007-8b52-26d7c6d1c1fb", + "name": "catalogName/choco", + "displayName": "Install VS Code", + "status": "Succeeded", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + }, + "startTime": "2021-08-05T18:00:00.000Z", + "endTime": "2021-08-05T18:00:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/a9202018-fb6a-4007-8b52-26d7c6d1c1fb" + }, + { + "id": "91835dc0-ef5a-4f58-9e3a-099aea8481f4", + "name": "catalogName/write-to-file", + "status": "Succeeded", + "startTime": "2021-08-05T18:10:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/91835dc0-ef5a-4f58-9e3a-099aea8481f4" + } + ], + "status": "Succeeded", + "startTime": "2021-08-05T18:00:00.000Z", + "endTime": "2021-08-05T18:10:00.000Z" + }, + { + "name": "Personalizations", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Personalizations", + "tasks": [ + { + "id": "d8ec7648-23c9-4e86-8883-6d42ad6c9609", + "name": "catalogName/choco", + "displayName": "Install Git", + "status": "Running", + "parameters": { + "packageName": "git" + }, + "startTime": "2021-08-05T18:10:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Personalizations/logs/d8ec7648-23c9-4e86-8883-6d42ad6c9609" + } + ], + "status": "Running", + "startTime": "2021-08-05T18:10:00.000Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationGroupsWithoutTasks.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationGroupsWithoutTasks.json new file mode 100644 index 000000000000..1f857f91d3d0 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationGroupsWithoutTasks.json @@ -0,0 +1,32 @@ +{ + "title": "Lists customization groups on the Dev Box. Listed customization groups exclude task information unless specified via the include parameter.", + "operationId": "DevBoxes_ListCustomizationGroupsWithoutTasks", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Provisioning", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning", + "status": "Succeeded", + "startTime": "2021-08-05T18:00:00.000Z", + "endTime": "2021-08-05T18:10:00.000Z" + }, + { + "name": "Personalizations", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Personalizations", + "status": "Running", + "startTime": "2021-08-05T18:10:00.000Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationTaskDefinitionsByProject.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationTaskDefinitionsByProject.json new file mode 100644 index 000000000000..6886b08fd453 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationTaskDefinitionsByProject.json @@ -0,0 +1,53 @@ +{ + "title": "Lists all customization tasks available to the project.", + "operationId": "DevBoxes_ListCustomizationTaskDefinitionsByProject", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myCatalog/choco", + "catalogName": "myCatalog", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/customizationtasks/choco", + "description": "Install a package via chocolatey", + "parameters": { + "package": { + "description": "The package to install", + "type": "string", + "required": true + }, + "version": { + "description": "The version of the package", + "type": "string", + "default": "latest" + }, + "retryOnFail": { + "type": "boolean" + } + } + }, + { + "name": "myCatalog/powershell", + "catalogName": "myCatalog", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/customizationtasks/powershell", + "description": "Runs an arbitrary Powershell command", + "parameters": { + "command": { + "type": "string", + "required": true + }, + "runAsAdmin": { + "type": "boolean" + } + } + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListDevBoxesByUser.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListDevBoxesByUser.json new file mode 100644 index 000000000000..ee0a1c013dcd --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListDevBoxesByUser.json @@ -0,0 +1,44 @@ +{ + "title": "Lists Dev Boxes in the project for a particular user.", + "operationId": "DevBoxes_ListDevBoxesByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastConnectedTime": "2022-04-01T00:13:23.323Z", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListOperations.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListOperations.json new file mode 100644 index 000000000000..fa770194c6af --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListOperations.json @@ -0,0 +1,42 @@ +{ + "title": "Lists operations on the Dev Box which have occurred within the past 90 days.", + "operationId": "DevBoxes_ListOperations", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/devBoxes/myDevBox/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Start", + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/devBoxes/myDevBox/operations/a6eb12ee-daa1-2215-9c44-63618dc2a781", + "operationId": "a6eb12ee-daa1-2215-9c44-63618dc2a781", + "status": "Succeeded", + "kind": "Repair", + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-10T19:31:20.7229492+00:00", + "endTime": "2022-09-10T19:57:41.7229492+00:00", + "result": { + "code": "ConnectivityFixApplied", + "message": "We resolved some connectivity issues with your Dev Box.", + "repairOutcome": "FixApplied" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListPools.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListPools.json new file mode 100644 index 000000000000..065f2392a615 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListPools.json @@ -0,0 +1,79 @@ +{ + "title": "Lists available pools.", + "operationId": "DevBoxes_ListPools", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/LargeDevWorkStationPool", + "name": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + }, + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "healthStatus": "Healthy", + "displayName": "LargePool" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/SQLDevelopmentMachinePool", + "name": "SQLDevelopmentMachinePool", + "location": "southcentralus", + "osType": "Windows", + "hardwareProfile": { + "vCPUs": 16, + "memoryGB": 128 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "SqlDevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + }, + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "healthStatus": "Healthy", + "displayName": "SQLPool" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSchedulesByPool.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSchedulesByPool.json new file mode 100644 index 000000000000..3139ab52c06a --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSchedulesByPool.json @@ -0,0 +1,28 @@ +{ + "title": "Lists all schedules within a pool that are configured by your project administrator.", + "operationId": "DevBoxes_ListSchedulesByPool", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "poolName": "DevPool", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", + "name": "default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool", + "sourceType": "Pool", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSchedulesByProject.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSchedulesByProject.json new file mode 100644 index 000000000000..920494b62d99 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSchedulesByProject.json @@ -0,0 +1,27 @@ +{ + "title": "Lists all schedules within a project that are configured by your project administrator.", + "operationId": "DevBoxes_ListSchedulesByProject", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", + "name": "default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool", + "sourceType": "Pool", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSnapshots.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSnapshots.json new file mode 100644 index 000000000000..6cb959b2204e --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSnapshots.json @@ -0,0 +1,30 @@ +{ + "title": "Lists snapshots for this Dev Box.", + "operationId": "DevBoxes_ListSnapshots", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6797", + "createdTime": "2022-09-30T15:23:00Z", + "snapshotType": "Automatic" + }, + { + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6798", + "createdTime": "2022-09-30T15:23:00Z", + "expirationTime": "2024-10-30T15:23:00Z", + "snapshotType": "Manual" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RepairDevBox.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RepairDevBox.json new file mode 100644 index 000000000000..ab297ebe0667 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RepairDevBox.json @@ -0,0 +1,25 @@ +{ + "title": "Attempts automated repair steps to resolve common problems on a Dev Box. The Dev Box may restart during this operation.", + "operationId": "DevBoxes_RepairDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestartDevBox.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestartDevBox.json new file mode 100644 index 000000000000..acef706175e1 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestartDevBox.json @@ -0,0 +1,25 @@ +{ + "title": "Restarts a Dev Box.", + "operationId": "DevBoxes_RestartDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestoreSnapshotDevBox.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestoreSnapshotDevBox.json new file mode 100644 index 000000000000..891948c547a0 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestoreSnapshotDevBox.json @@ -0,0 +1,26 @@ +{ + "title": "Attempts to restore the Dev Box to a selected snapshot.", + "operationId": "DevBoxes_RestoreSnapshotDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6797" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_SkipAction.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_SkipAction.json new file mode 100644 index 000000000000..bc83aa55f3c1 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_SkipAction.json @@ -0,0 +1,15 @@ +{ + "title": "Skips an occurrence of an action.", + "operationId": "DevBoxes_SkipAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "actionName": "schedule-default" + }, + "responses": { + "204": {} + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_StartDevBox.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_StartDevBox.json new file mode 100644 index 000000000000..5c34fc1c57c2 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_StartDevBox.json @@ -0,0 +1,25 @@ +{ + "title": "Starts a Dev Box.", + "operationId": "DevBoxes_StartDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_StopDevBox.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_StopDevBox.json new file mode 100644 index 000000000000..99dd05cc7c03 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_StopDevBox.json @@ -0,0 +1,26 @@ +{ + "title": "Stops a Dev Box.", + "operationId": "DevBoxes_StopDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "hibernate": "true" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ValidateCustomizationTasksAction.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ValidateCustomizationTasksAction.json new file mode 100644 index 000000000000..7fa247cff7a6 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ValidateCustomizationTasksAction.json @@ -0,0 +1,40 @@ +{ + "title": "Validates a list of customization tasks.", + "operationId": "DevBoxes_ValidateCustomizationTasksAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "body": { + "tasks": [ + { + "name": "catalogName/choco", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + } + }, + { + "name": "catalogName/write-to-disk" + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Succeeded", + "startTime": "2023-02-01T12:43:54.122Z", + "result": { + "validationResult": "Succeeded" + } + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ValidateCustomizationTasksActionWithFailure.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ValidateCustomizationTasksActionWithFailure.json new file mode 100644 index 000000000000..e6de65937cf9 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ValidateCustomizationTasksActionWithFailure.json @@ -0,0 +1,53 @@ +{ + "title": "Validates a list of customization tasks.", + "operationId": "DevBoxes_ValidateCustomizationTasksActionWithFailure", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "body": { + "tasks": [ + { + "name": "catalogName/choco", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + } + }, + { + "name": "catalogName/write-to-file" + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Succeeded", + "startTime": "2023-02-01T12:43:54.122Z", + "result": { + "validationResult": "Failed", + "errors": [ + { + "target": { + "name": "catalogName/write-to-file" + }, + "details": [ + { + "code": "TaskNotFound", + "message": "Could not find the referenced task catalogName/write-to-file." + } + ] + } + ] + } + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_GetProject.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_GetProject.json new file mode 100644 index 000000000000..44331c0613ab --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_GetProject.json @@ -0,0 +1,19 @@ +{ + "title": "Gets a project.", + "operationId": "DevCenter_GetProject", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/DevDiv", + "name": "DevDiv", + "description": "The developer division", + "displayName": "DeveloperDivision" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_GetProjectAbilities.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_GetProjectAbilities.json new file mode 100644 index 000000000000..1dd761dc9891 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_GetProjectAbilities.json @@ -0,0 +1,37 @@ +{ + "title": "Gets the signed-in user's permitted abilities in a project.", + "operationId": "DevCenter_GetProjectAbilities", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "abilitiesAsAdmin": [ + "ReadDevBoxes", + "ReadEnvironments" + ], + "abilitiesAsDeveloper": [ + "CustomizeDevBoxes", + "DeleteDevBoxes", + "DeleteEnvironments", + "ManageDevBoxActions", + "ManageEnvironmentActions", + "ReadDevBoxActions", + "ReadDevBoxes", + "ReadEnvironmentActions", + "ReadEnvironmentOutputs", + "ReadEnvironments", + "ReadRemoteConnections", + "StartDevBoxes", + "StopDevBoxes", + "WriteDevBoxes", + "WriteEnvironments" + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_ListProjects.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_ListProjects.json new file mode 100644 index 000000000000..a7d9e2e31725 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_ListProjects.json @@ -0,0 +1,22 @@ +{ + "title": "Lists all projects in a Dev Center.", + "operationId": "DevCenter_ListProjects", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject", + "name": "DevDiv", + "description": "The developer division", + "displayName": "DeveloperDivision" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_CreateOrReplaceEnvironment.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_CreateOrReplaceEnvironment.json new file mode 100644 index 000000000000..c31a9c1565a5 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_CreateOrReplaceEnvironment.json @@ -0,0 +1,43 @@ +{ + "title": "Creates or updates an environment.", + "operationId": "Environments_CreateOrReplaceEnvironment", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "environmentName": "mydevenv", + "userId": "me", + "body": { + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "expirationDate": "2023-09-10T17:00:00Z" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Creating", + "expirationDate": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_DelayAction.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_DelayAction.json new file mode 100644 index 000000000000..fedd0acb2c35 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_DelayAction.json @@ -0,0 +1,27 @@ +{ + "title": "Delays the occurrence of an action.", + "operationId": "Environments_DelayAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnv", + "actionName": "default", + "until": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/default", + "name": "default", + "actionType": "Delete", + "next": { + "scheduledTime": "2023-09-30T17:00:00Z" + }, + "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastModifiedAt": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_DeleteEnvironment.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_DeleteEnvironment.json new file mode 100644 index 000000000000..b12474e9fe84 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_DeleteEnvironment.json @@ -0,0 +1,26 @@ +{ + "title": "Deletes an environment and all its associated resources.", + "operationId": "Environments_DeleteEnvironment", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ForceDeleteEnvironment.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ForceDeleteEnvironment.json new file mode 100644 index 000000000000..3305cb49fb0b --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ForceDeleteEnvironment.json @@ -0,0 +1,27 @@ +{ + "title": "Deletes an environment and its resource group without the environment definition.", + "operationId": "Environments_DeleteEnvironment", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv", + "force": "true" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetAction.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetAction.json new file mode 100644 index 000000000000..8c5dcee14079 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetAction.json @@ -0,0 +1,26 @@ +{ + "title": "Retrieve a specific environment action.", + "operationId": "Environments_GetAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment", + "actionName": "default" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/default", + "name": "default", + "actionType": "Delete", + "next": { + "scheduledTime": "2023-09-30T17:00:00Z" + }, + "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastModifiedAt": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetCatalog.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetCatalog.json new file mode 100644 index 000000000000..d0296c59168f --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetCatalog.json @@ -0,0 +1,18 @@ +{ + "title": "Gets the specified catalog within the project.", + "operationId": "Environments_GetCatalog", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "catalogName": "foo" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/foo", + "name": "foo" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentByUser.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentByUser.json new file mode 100644 index 000000000000..fc09eaf09dec --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentByUser.json @@ -0,0 +1,30 @@ +{ + "title": "Gets an environment.", + "operationId": "Environments_GetEnvironmentByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg028321", + "expirationDate": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentDefinition.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentDefinition.json new file mode 100644 index 000000000000..6a2a39903855 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentDefinition.json @@ -0,0 +1,58 @@ +{ + "title": "Get an environment definition from a catalog.", + "operationId": "Environments_GetEnvironmentDefinition", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "catalogName": "myCatalog", + "definitionName": "foo" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "name": "foo", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true, + "default": "dotnet", + "allowed": [ + "node", + "dotnet", + "java" + ] + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true, + "default": "Standard_LRS", + "allowed": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS" + ] + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "default": "true", + "readOnly": true, + "required": true + } + ], + "parametersSchema": "{\"type\":\"object\",\"properties\":{\"functionAppRuntime\":{\"$id\":\"functionAppRuntime\",\"value\":\"dotnet\",\"displayName\":\"Function App Runtime\",\"type\":\"string\",\"enum\":[\"node\",\"dotnet\",\"java\"]},\"storageAccountType\":{\"$id\":\"storageAccountType\",\"value\":\"Standard_LRS\",\"displayName\":\"Storage Account Type\",\"type\":\"string\",\"enum\":[\"Standard_LRS\",\"Standard_GRS\",\"Standard_RAGRS\"]},\"httpsOnly\":{\"$id\":\"httpsOnly\",\"value\":true,\"displayName\":\"HTTPS only\",\"type\":\"boolean\"}},\"required\":[\"functionAppRuntime\",\"storageAccountType\"]}", + "templatePath": "azuredeploy.json" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentTypeAbilities.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentTypeAbilities.json new file mode 100644 index 000000000000..15bd60987c65 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentTypeAbilities.json @@ -0,0 +1,28 @@ +{ + "title": "Gets the signed-in user's permitted abilities in an environment type.", + "operationId": "Environments_GetEnvironmentTypeAbilities", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "environmentTypeName": "devtestenv", + "userId": "me", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "abilitiesAsAdmin": [ + "ReadEnvironments" + ], + "abilitiesAsDeveloper": [ + "DeleteEnvironments", + "ManageEnvironmentActions", + "ReadEnvironmentActions", + "ReadEnvironmentOutputs", + "ReadEnvironments", + "WriteEnvironments" + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentTypes.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentTypes.json new file mode 100644 index 000000000000..d41c0d94320e --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentTypes.json @@ -0,0 +1,21 @@ +{ + "title": "Get an environment type configured for a project.", + "operationId": "Environments_GetEnvironmentTypes", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "environmentTypeName": "devtestenv", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/environmentTypes/devtestenv", + "name": "devtestenv", + "status": "Enabled", + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "displayName": "DevTestEnvironment" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetLogsByOperation.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetLogsByOperation.json new file mode 100644 index 000000000000..5fb52d5225a3 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetLogsByOperation.json @@ -0,0 +1,17 @@ +{ + "title": "Gets the logs for an operation on an environment.", + "operationId": "Environments_GetLogsByOperation", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" + }, + "responses": { + "200": { + "body": "{file}" + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetOperation.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetOperation.json new file mode 100644 index 000000000000..6e4d5ac213af --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetOperation.json @@ -0,0 +1,29 @@ +{ + "title": "Gets an environment action result.", + "operationId": "Environments_GetOperation", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/myEnvironment/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Deploy", + "environmentParameters": { + "paramA": "valueA", + "paramB": "valueB" + }, + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetOutputs.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetOutputs.json new file mode 100644 index 000000000000..20f9755f7101 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetOutputs.json @@ -0,0 +1,51 @@ +{ + "title": "Gets Outputs from the environment.", + "operationId": "Environments_GetOutputs", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv" + }, + "responses": { + "200": { + "body": { + "outputs": { + "stringOutput": { + "type": "string", + "value": "Output1 value", + "sensitive": false + }, + "arrayOutput": { + "type": "array", + "value": [ + 1, + 2, + 3 + ], + "sensitive": false + }, + "boolOutput": { + "type": "bool", + "value": true, + "sensitive": false + }, + "intOutput": { + "type": "int", + "value": 1, + "sensitive": false + }, + "objectOutput": { + "type": "object", + "value": { + "name": "name", + "id": "id" + }, + "sensitive": false + } + } + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListActions.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListActions.json new file mode 100644 index 000000000000..fec2e7db31bb --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListActions.json @@ -0,0 +1,39 @@ +{ + "title": "Get all scheduled actions for a user within an environment.", + "operationId": "Environments_ListActions", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/default", + "name": "default", + "actionType": "Delete", + "next": { + "scheduledTime": "2023-09-30T17:00:00Z" + }, + "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastModifiedAt": "2023-09-10T17:00:00Z" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/expire", + "name": "expire", + "actionType": "Delete", + "next": { + "scheduledTime": "2023-10-30T17:00:00Z" + }, + "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastModifiedAt": "2023-09-20T17:00:00Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListCatalogsByProject.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListCatalogsByProject.json new file mode 100644 index 000000000000..d9fbc4eee5d0 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListCatalogsByProject.json @@ -0,0 +1,21 @@ +{ + "title": "Lists all of the catalogs available for a project.", + "operationId": "Environments_ListCatalogsByProject", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/foo", + "name": "foo" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentDefinitionsByCatalog.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentDefinitionsByCatalog.json new file mode 100644 index 000000000000..72928b19772c --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentDefinitionsByCatalog.json @@ -0,0 +1,69 @@ +{ + "title": "Lists all environment definitions available within a catalog.", + "operationId": "Environments_ListEnvironmentDefinitionsByCatalog", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "catalogName": "myCatalog" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "name": "foo", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true, + "default": "dotnet", + "allowed": [ + "node", + "dotnet", + "java" + ] + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true, + "default": "Standard_LRS", + "allowed": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS" + ] + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "default": "true", + "readOnly": true, + "required": true + } + ], + "parametersSchema": "{\"type\":\"object\",\"properties\":{\"functionAppRuntime\":{\"$id\":\"functionAppRuntime\",\"value\":\"dotnet\",\"displayName\":\"Function App Runtime\",\"type\":\"string\",\"enum\":[\"node\",\"dotnet\",\"java\"]},\"storageAccountType\":{\"$id\":\"storageAccountType\",\"value\":\"Standard_LRS\",\"displayName\":\"Storage Account Type\",\"type\":\"string\",\"enum\":[\"Standard_LRS\",\"Standard_GRS\",\"Standard_RAGRS\"]},\"httpsOnly\":{\"$id\":\"httpsOnly\",\"value\":true,\"displayName\":\"HTTPS only\",\"type\":\"boolean\"}},\"required\":[\"functionAppRuntime\",\"storageAccountType\"]}", + "templatePath": "azuredeploy.json" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/bar", + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/bar", + "name": "bar", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "templatePath": "azuredeploy.json" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentDefinitionsByProject.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentDefinitionsByProject.json new file mode 100644 index 000000000000..3055da215535 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentDefinitionsByProject.json @@ -0,0 +1,68 @@ +{ + "title": "Lists all environment definitions available for a project.", + "operationId": "Environments_ListEnvironmentDefinitionsByProject", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "name": "foo", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true, + "default": "dotnet", + "allowed": [ + "node", + "dotnet", + "java" + ] + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true, + "default": "Standard_LRS", + "allowed": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS" + ] + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "default": "true", + "readOnly": true, + "required": true + } + ], + "parametersSchema": "{\"type\":\"object\",\"properties\":{\"functionAppRuntime\":{\"$id\":\"functionAppRuntime\",\"value\":\"dotnet\",\"displayName\":\"Function App Runtime\",\"type\":\"string\",\"enum\":[\"node\",\"dotnet\",\"java\"]},\"storageAccountType\":{\"$id\":\"storageAccountType\",\"value\":\"Standard_LRS\",\"displayName\":\"Storage Account Type\",\"type\":\"string\",\"enum\":[\"Standard_LRS\",\"Standard_GRS\",\"Standard_RAGRS\"]},\"httpsOnly\":{\"$id\":\"httpsOnly\",\"value\":true,\"displayName\":\"HTTPS only\",\"type\":\"boolean\"}},\"required\":[\"functionAppRuntime\",\"storageAccountType\"]}", + "templatePath": "azuredeploy.json" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/bar", + "id": "/projects/myProject/catalogs/myOtherCatalog/environmentDefinitions/bar", + "name": "bar", + "catalogName": "myOtherCatalog", + "description": "This environment definition is just for example purposes.", + "templatePath": "azuredeploy.json" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentTypes.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentTypes.json new file mode 100644 index 000000000000..62e267038a17 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentTypes.json @@ -0,0 +1,24 @@ +{ + "title": "Lists all environment types configured for a project.", + "operationId": "Environments_ListEnvironmentTypes", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/environmentTypes/devtestenv", + "name": "devtestenv", + "status": "Enabled", + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "displayName": "DevTestEnvironment" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironments.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironments.json new file mode 100644 index 000000000000..037ce43b0111 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironments.json @@ -0,0 +1,32 @@ +{ + "title": "Lists all environment definitions available for a project.", + "operationId": "Environments_ListEnvironments", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg028321", + "expirationDate": "2023-09-10T17:00:00Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentsByUser.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentsByUser.json new file mode 100644 index 000000000000..a31423259000 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentsByUser.json @@ -0,0 +1,33 @@ +{ + "title": "Lists the environments for a project and user.", + "operationId": "Environments_ListEnvironmentsByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg028321", + "expirationDate": "2023-09-10T17:00:00Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListOperations.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListOperations.json new file mode 100644 index 000000000000..8386bc5476ab --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListOperations.json @@ -0,0 +1,32 @@ +{ + "title": "Lists operations on the environment which have occurred within the past 90 days.", + "operationId": "Environments_ListOperations", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/myEnvironment/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Deploy", + "environmentParameters": { + "paramA": "valueA", + "paramB": "valueB" + }, + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_PatchEnvironment.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_PatchEnvironment.json new file mode 100644 index 000000000000..c31b552d4813 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_PatchEnvironment.json @@ -0,0 +1,32 @@ +{ + "title": "Partially updates an environment.", + "operationId": "Environments_PatchEnvironment", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "environmentName": "mydevenv", + "userId": "me", + "body": { + "expirationDate": "2023-09-10T17:00:00Z" + } + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "expirationDate": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_SkipAction.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_SkipAction.json new file mode 100644 index 000000000000..d620617d53de --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_SkipAction.json @@ -0,0 +1,21 @@ +{ + "title": "Skips an occurrence of an action.", + "operationId": "Environments_SkipAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "environmentName": "myEnv", + "userId": "me", + "actionName": "default", + "body": { + "actionType": "Delete", + "next": { + "scheduledTime": "2023-09-30T17:00:00Z" + } + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/OperationStatuses_Get.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/OperationStatuses_Get.json new file mode 100644 index 000000000000..c1d48444d062 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/OperationStatuses_Get.json @@ -0,0 +1,19 @@ +{ + "title": "Get the status of an operation.", + "operationId": "OperationStatuses_Get", + "parameters": { + "api-version": "2024-10-01-preview", + "projectName": "myProject", + "operationId": "fa067167-e49d-41bd-8dd8-de719b9de3b3" + }, + "responses": { + "200": { + "body": { + "id": "/projects/myProject/operationStatuses/fa067167-e49d-41bd-8dd8-de719b9de3b3", + "name": "fa067167-e49d-41bd-8dd8-de719b9de3b3", + "status": "Running", + "startTime": "2024-01-24T21:14:58.472Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/main.tsp b/specification/devcenter/DevCenter/main.tsp index ef638853073c..fd5c466076c7 100644 --- a/specification/devcenter/DevCenter/main.tsp +++ b/specification/devcenter/DevCenter/main.tsp @@ -55,4 +55,8 @@ enum APIVersions { @doc("The 2024-09-01-preview service API version") @useDependency(Versions.v1_0_Preview_2) v2024_09_01_preview: "2024-09-01-preview", + + @doc("The 2024-10-01-preview service API version") + @useDependency(Versions.v1_0_Preview_2) + v2024_10_01_preview: "2024-10-01-preview", } diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/devcenter.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/devcenter.json new file mode 100644 index 000000000000..78fedb94d760 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/devcenter.json @@ -0,0 +1,7219 @@ +{ + "swagger": "2.0", + "info": { + "title": "DevCenter", + "version": "2024-10-01-preview", + "description": "DevCenter service", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "description": "The DevCenter-specific URI to operate on.", + "required": true, + "type": "string", + "format": "uri", + "x-ms-skip-url-encoding": true + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "OAuth2Auth": [ + "https://devcenter.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "OAuth2Auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://devcenter.azure.com/.default": "" + } + } + }, + "tags": [], + "paths": { + "/devboxes": { + "get": { + "operationId": "DevBoxes_ListAllDevBoxes", + "description": "Lists Dev Boxes that the caller has access to in the DevCenter.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDevBox" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists Dev Boxes that the caller has access to in the DevCenter.": { + "$ref": "./examples/DevBoxes_ListAllDevBoxes.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects": { + "get": { + "operationId": "DevCenter_ListProjects", + "description": "Lists all projects.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedProject" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists all projects in a Dev Center.": { + "$ref": "./examples/DevCenter_ListProjects.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}": { + "get": { + "operationId": "DevCenter_GetProject", + "description": "Gets a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets a project.": { + "$ref": "./examples/DevCenter_GetProject.json" + } + } + } + }, + "/projects/{projectName}/catalogs": { + "get": { + "operationId": "Environments_ListCatalogsByProject", + "description": "Lists all of the catalogs available for a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedCatalog" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists all of the catalogs available for a project.": { + "$ref": "./examples/Environments_ListCatalogsByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/catalogs/{catalogName}": { + "get": { + "operationId": "Environments_GetCatalog", + "description": "Gets the specified catalog within the project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of the catalog.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets the specified catalog within the project.": { + "$ref": "./examples/Environments_GetCatalog.json" + } + } + } + }, + "/projects/{projectName}/catalogs/{catalogName}/customizationTasks/{taskName}": { + "get": { + "operationId": "DevBoxes_GetCustomizationTaskDefinitions", + "description": "Gets a customization task.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of the catalog.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "taskName", + "in": "path", + "description": "Full name of the task: {catalogName}/{taskName}.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomizationTaskDefinition" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets a customization task.": { + "$ref": "./examples/DevBoxes_GetCustomizationTaskDefinitions.json" + } + } + } + }, + "/projects/{projectName}/catalogs/{catalogName}/environmentDefinitions": { + "get": { + "operationId": "Environments_ListEnvironmentDefinitionsByCatalog", + "description": "Lists all environment definitions available within a catalog.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "The name of the catalog", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedEnvironmentDefinition" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists all environment definitions available within a catalog.": { + "$ref": "./examples/Environments_ListEnvironmentDefinitionsByCatalog.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/catalogs/{catalogName}/environmentDefinitions/{definitionName}": { + "get": { + "operationId": "Environments_GetEnvironmentDefinition", + "description": "Get an environment definition from a catalog.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of the catalog.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "definitionName", + "in": "path", + "description": "Name of the environment definition.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentDefinition" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get an environment definition from a catalog.": { + "$ref": "./examples/Environments_GetEnvironmentDefinition.json" + } + } + } + }, + "/projects/{projectName}/customizationTasks": { + "get": { + "operationId": "DevBoxes_ListCustomizationTaskDefinitionsByProject", + "description": "Lists all customization tasks available to the project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedCustomizationTaskDefinition" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists all customization tasks available to the project.": { + "$ref": "./examples/DevBoxes_ListCustomizationTaskDefinitionsByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/customizationTasks:validateGroup": { + "post": { + "operationId": "DevBoxes_ValidateCustomizationTasksAction", + "description": "Validates a list of customization tasks.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Customization tasks to validate.", + "required": true, + "schema": { + "$ref": "#/definitions/CustomizationTaskList" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/CustomizationTaskListValidationOperationResult" + }, + "headers": { + "Location": { + "type": "string" + }, + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Validates a list of customization tasks.": { + "$ref": "./examples/DevBoxes_ValidateCustomizationTasksAction.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/projects/{projectName}/environmentDefinitions": { + "get": { + "operationId": "Environments_ListEnvironmentDefinitionsByProject", + "description": "Lists all environment definitions available for a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedEnvironmentDefinition" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists all environment definitions available for a project.": { + "$ref": "./examples/Environments_ListEnvironmentDefinitionsByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/environmentTypes": { + "get": { + "operationId": "Environments_ListEnvironmentTypes", + "description": "Lists all environment types configured for a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedEnvironmentType" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists all environment types configured for a project.": { + "$ref": "./examples/Environments_ListEnvironmentTypes.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/environmentTypes/{environmentTypeName}": { + "get": { + "operationId": "Environments_GetEnvironmentTypes", + "description": "Get an environment type configured for a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "environmentTypeName", + "in": "path", + "description": "Name of the environment type.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentType" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get an environment type configured for a project.": { + "$ref": "./examples/Environments_GetEnvironmentTypes.json" + } + } + } + }, + "/projects/{projectName}/environmentTypes/{environmentTypeName}/users/{userId}/abilities": { + "get": { + "operationId": "Environments_GetEnvironmentTypeAbilities", + "description": "Gets the signed-in user's permitted abilities in an environment type.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "name": "environmentTypeName", + "in": "path", + "description": "The name of the environment type", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "name": "top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: 'top=10'.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentTypeAbilities" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets the signed-in user's permitted abilities in an environment type.": { + "$ref": "./examples/Environments_GetEnvironmentTypeAbilities.json" + } + } + } + }, + "/projects/{projectName}/environments": { + "get": { + "operationId": "Environments_ListEnvironments", + "description": "Lists the environments for a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedEnvironment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists all environment definitions available for a project.": { + "$ref": "./examples/Environments_ListEnvironments.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/imageBuildLogs/{imageBuildLogId}": { + "get": { + "operationId": "DevBoxes_GetImagingTaskLog", + "description": "Gets the log for an imaging build task.", + "produces": [ + "text/plain", + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "name": "imageBuildLogId", + "in": "path", + "description": "An imaging build log id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets the log for an imaging build task.": { + "$ref": "./examples/DevBoxes_GetImagingTaskLog.json" + } + } + } + }, + "/projects/{projectName}/operationstatuses/{operationId}": { + "get": { + "operationId": "OperationStatuses_Get", + "description": "Get the status of an operation.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "operationId", + "in": "path", + "description": "The operation id name.", + "required": true, + "type": "string", + "format": "uuid", + "minLength": 36, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get the status of an operation.": { + "$ref": "./examples/OperationStatuses_Get.json" + } + } + } + }, + "/projects/{projectName}/pools": { + "get": { + "operationId": "DevBoxes_ListPools", + "description": "Lists available pools.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedPool" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists available pools.": { + "$ref": "./examples/DevBoxes_ListPools.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/pools/{poolName}": { + "get": { + "operationId": "DevBoxes_GetPool", + "description": "Gets a pool.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "poolName", + "in": "path", + "description": "Pool name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Pool" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets a pool.": { + "$ref": "./examples/DevBoxes_GetPool.json" + } + } + } + }, + "/projects/{projectName}/pools/{poolName}/schedules": { + "get": { + "operationId": "DevBoxes_ListSchedulesByPool", + "description": "Lists all schedules within a pool that are configured by your project administrator.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "name": "poolName", + "in": "path", + "description": "The name of a pool of Dev Boxes.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedSchedule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists all schedules within a pool that are configured by your project administrator.": { + "$ref": "./examples/DevBoxes_ListSchedulesByPool.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/pools/{poolName}/schedules/{scheduleName}": { + "get": { + "operationId": "DevBoxes_GetScheduleByPool", + "description": "Gets a schedule.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "poolName", + "in": "path", + "description": "Pool name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "scheduleName", + "in": "path", + "description": "Display name for the Schedule.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Schedule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets a schedule.": { + "$ref": "./examples/DevBoxes_GetScheduleByPool.json" + } + } + } + }, + "/projects/{projectName}/schedules": { + "get": { + "operationId": "DevBoxes_ListSchedulesByProject", + "description": "Lists all schedules within a project that are configured by your project administrator.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedSchedule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists all schedules within a project that are configured by your project administrator.": { + "$ref": "./examples/DevBoxes_ListSchedulesByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/abilities": { + "get": { + "operationId": "DevCenter_GetProjectAbilities", + "description": "Gets the signed-in user's permitted abilities in a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProjectAbilities" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets the signed-in user's permitted abilities in a project.": { + "$ref": "./examples/DevCenter_GetProjectAbilities.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes": { + "get": { + "operationId": "DevBoxes_ListDevBoxesByUser", + "description": "Lists Dev Boxes in the project for a particular user.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDevBox" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists Dev Boxes in the project for a particular user.": { + "$ref": "./examples/DevBoxes_ListDevBoxesByUser.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}": { + "get": { + "operationId": "DevBoxes_GetDevBoxByUser", + "description": "Gets a Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBox" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets a Dev Box.": { + "$ref": "./examples/DevBoxes_GetDevBoxByUser.json" + } + } + }, + "put": { + "operationId": "DevBoxes_CreateDevBox", + "description": "Creates or replaces a Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents the body request of a Dev Box creation. Dev Box Pool name is required. Optionally set the owner of the Dev Box as local administrator", + "required": true, + "schema": { + "$ref": "#/definitions/DevBox" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBox" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/DevBox" + }, + "headers": { + "Location": { + "type": "string", + "format": "uri", + "description": "The location of an instance of DevBox" + }, + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Creates or replaces a Dev Box.": { + "$ref": "./examples/DevBoxes_CreateDevBox.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "DevBoxes_DeleteDevBox", + "description": "Deletes a Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + }, + "headers": { + "Location": { + "type": "string" + }, + "Operation-Location": { + "type": "string" + } + } + }, + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Deletes a Dev Box.": { + "$ref": "./examples/DevBoxes_DeleteDevBox.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:start": { + "post": { + "operationId": "DevBoxes_StartDevBox", + "description": "Starts a Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Starts a Dev Box.": { + "$ref": "./examples/DevBoxes_StartDevBox.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:stop": { + "post": { + "operationId": "DevBoxes_StopDevBox", + "description": "Stops a Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "$ref": "#/parameters/HibernateQueryParameter" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Stops a Dev Box.": { + "$ref": "./examples/DevBoxes_StopDevBox.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:restart": { + "post": { + "operationId": "DevBoxes_RestartDevBox", + "description": "Restarts a Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Restarts a Dev Box.": { + "$ref": "./examples/DevBoxes_RestartDevBox.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:repair": { + "post": { + "operationId": "DevBoxes_RepairDevBox", + "description": "Attempts automated repair steps to resolve common problems on a Dev Box. The Dev Box may restart during this operation.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Attempts automated repair steps to resolve common problems on a Dev Box. The Dev Box may restart during this operation.": { + "$ref": "./examples/DevBoxes_RepairDevBox.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:restoreSnapshot": { + "post": { + "operationId": "DevBoxes_RestoreSnapshotDevBox", + "description": "Restores a Dev Box to a specified snapshot.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "$ref": "#/parameters/SnapshotIdQueryParameter" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Attempts to restore the Dev Box to a selected snapshot.": { + "$ref": "./examples/DevBoxes_RestoreSnapshotDevBox.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:captureSnapshot": { + "post": { + "operationId": "DevBoxes_CaptureSnapshotDevBox", + "description": "Captures a manual snapshot of the Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Attempts to capture the manual snapshot for the Dev Box.": { + "$ref": "./examples/DevBoxes_CaptureSnapshotDevBox.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions": { + "get": { + "operationId": "DevBoxes_ListActions", + "description": "Lists actions on a Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDevBoxAction" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists actions on a Dev Box.": { + "$ref": "./examples/DevBoxes_ListActions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions/{actionName}": { + "get": { + "operationId": "DevBoxes_GetAction", + "description": "Gets an action.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "actionName", + "in": "path", + "description": "The name of the action.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxAction" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets an action.": { + "$ref": "./examples/DevBoxes_GetAction.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions/{actionName}:skip": { + "post": { + "operationId": "DevBoxes_SkipAction", + "description": "Skips an occurrence of an action.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "actionName", + "in": "path", + "description": "The name of the action.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Skips an occurrence of an action.": { + "$ref": "./examples/DevBoxes_SkipAction.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions/{actionName}:delay": { + "post": { + "operationId": "DevBoxes_DelayAction", + "description": "Delays the occurrence of an action.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "actionName", + "in": "path", + "description": "The name of the action.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "$ref": "#/parameters/DelayUntilQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxAction" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Delays the occurrence of an action.": { + "$ref": "./examples/DevBoxes_DelayAction.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions:delay": { + "post": { + "operationId": "DevBoxes_DelayActions", + "description": "Delays all actions.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "$ref": "#/parameters/DelayUntilQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDevBoxActionDelayResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Delays all actions.": { + "$ref": "./examples/DevBoxes_DelayActions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/customizationGroups": { + "get": { + "operationId": "DevBoxes_ListCustomizationGroups", + "description": " Lists customization groups on the Dev Box. Listed customization groups exclude \n task information unless specified via the include parameter.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "include", + "in": "query", + "description": "Optional query parameter to specify what properties should be included in the response.", + "required": false, + "type": "string", + "enum": [ + "tasks" + ], + "x-ms-enum": { + "name": "ListCustomizationGroupsIncludeProperty", + "modelAsString": true, + "values": [ + { + "name": "tasks", + "value": "tasks", + "description": "Include list of tasks in the response." + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedCustomizationGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists customization groups on the Dev Box. Listed customization groups exclude task information unless specified via the include parameter.": { + "$ref": "./examples/DevBoxes_ListCustomizationGroups.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/customizationGroups/{customizationGroupName}": { + "get": { + "operationId": "DevBoxes_GetCustomizationGroup", + "description": " Gets a customization group.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "customizationGroupName", + "in": "path", + "description": "Name of the customization group.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomizationGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets a customization group.": { + "$ref": "./examples/DevBoxes_GetCustomizationGroup.json" + } + } + }, + "put": { + "operationId": "DevBoxes_CreateCustomizationGroup", + "description": "Applies customizations to the Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + }, + { + "name": "customizationGroupName", + "in": "path", + "description": "A customization group name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "body", + "in": "body", + "description": "Represents the body request of a Dev Box creation. Dev Box Pool name is required. Optionally set the owner of the Dev Box as local administrator", + "required": true, + "schema": { + "$ref": "#/definitions/CustomizationGroup" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomizationGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Applies customizations to the Dev Box.": { + "$ref": "./examples/DevBoxes_CreateCustomizationGroup.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/customizationGroups/{customizationGroupName}/logs/{customizationTaskId}": { + "get": { + "operationId": "DevBoxes_GetCustomizationTaskLog", + "description": "Gets the log for a customization task.", + "produces": [ + "text/plain", + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + }, + { + "name": "customizationGroupName", + "in": "path", + "description": "A customization group name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "customizationTaskId", + "in": "path", + "description": "A customization task ID.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets the log for a customization task.": { + "$ref": "./examples/DevBoxes_GetCustomizationTaskLog.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/operations": { + "get": { + "operationId": "DevBoxes_ListOperations", + "description": "Lists operations on the Dev Box which have occurred within the past 90 days.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDevBoxOperation" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists operations on the Dev Box which have occurred within the past 90 days.": { + "$ref": "./examples/DevBoxes_ListOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/operations/{operationId}": { + "get": { + "operationId": "DevBoxes_GetOperation", + "description": "Gets an operation on a Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "operationId", + "in": "path", + "description": "Unique identifier for the Dev Box operation.", + "required": true, + "type": "string", + "format": "uuid", + "minLength": 36, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxOperation" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets an operation on a Dev Box.": { + "$ref": "./examples/DevBoxes_GetOperation.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/remoteConnection": { + "get": { + "operationId": "DevBoxes_GetRemoteConnection", + "description": "Gets RDP Connection info.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/RemoteConnection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets RDP Connection info.": { + "$ref": "./examples/DevBoxes_GetRemoteConnection.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/snapshots": { + "get": { + "operationId": "DevBoxes_ListSnapshots", + "description": "Lists snapshots for this Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDevBoxSnapshot" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists snapshots for this Dev Box.": { + "$ref": "./examples/DevBoxes_ListSnapshots.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/snapshots/{snapshotId}": { + "get": { + "operationId": "DevBoxes_GetSnapshot", + "description": "Gets a snapshot by snapshot id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "snapshotId", + "in": "path", + "description": "The id of the snapshot. Should be treated as opaque string.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxSnapshot" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets a snapshot by snapshot id.": { + "$ref": "./examples/DevBoxes_GetSnapshot.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/environments": { + "get": { + "operationId": "Environments_ListEnvironmentsByUser", + "description": "Lists the environments for a project and user.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedEnvironment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists the environments for a project and user.": { + "$ref": "./examples/Environments_ListEnvironmentsByUser.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}": { + "get": { + "operationId": "Environments_GetEnvironmentByUser", + "description": "Gets an environment.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "environmentName", + "in": "path", + "description": "Environment name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Environment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets an environment.": { + "$ref": "./examples/Environments_GetEnvironmentByUser.json" + } + } + }, + "put": { + "operationId": "Environments_CreateOrReplaceEnvironment", + "description": "Creates or updates an environment.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents an environment.", + "required": true, + "schema": { + "$ref": "#/definitions/Environment" + } + } + ], + "responses": { + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/Environment" + }, + "headers": { + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Creates or updates an environment.": { + "$ref": "./examples/Environments_CreateOrReplaceEnvironment.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Environments_PatchEnvironment", + "description": "Partially updates an environment.", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents an environment.", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentUpdate" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Environment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Partially updates an environment.": { + "$ref": "./examples/Environments_PatchEnvironment.json" + } + } + }, + "delete": { + "operationId": "Environments_DeleteEnvironment", + "description": "Deletes an environment and all its associated resources", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/ForceDeleteEnvironmentQueryParameter" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + }, + "headers": { + "Location": { + "type": "string" + }, + "Operation-Location": { + "type": "string" + } + } + }, + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Deletes an environment and all its associated resources.": { + "$ref": "./examples/Environments_DeleteEnvironment.json" + }, + "Deletes an environment and its resource group without the environment definition.": { + "$ref": "./examples/Environments_ForceDeleteEnvironment.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/actions": { + "get": { + "operationId": "Environments_ListActions", + "description": "Get all scheduled actions for a user within an environment.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "environmentName", + "in": "path", + "description": "Environment name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedEnvironmentAction" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get all scheduled actions for a user within an environment.": { + "$ref": "./examples/Environments_ListActions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/actions/{actionName}": { + "get": { + "operationId": "Environments_GetAction", + "description": "Retrieve a specific environment action.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "environmentName", + "in": "path", + "description": "Environment name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "actionName", + "in": "path", + "description": "Uniquely identifies the action.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentAction" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Retrieve a specific environment action.": { + "$ref": "./examples/Environments_GetAction.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/actions/{actionName}:skip": { + "post": { + "operationId": "Environments_SkipAction", + "description": "Skips an occurrence of an action.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "environmentName", + "in": "path", + "description": "Environment name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "actionName", + "in": "path", + "description": "Uniquely identifies the action.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Skips an occurrence of an action.": { + "$ref": "./examples/Environments_SkipAction.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/actions/{actionName}:delay": { + "post": { + "operationId": "Environments_DelayAction", + "description": "Delays the occurrence of an action.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "environmentName", + "in": "path", + "description": "Environment name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "actionName", + "in": "path", + "description": "Uniquely identifies the action.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "until", + "in": "query", + "description": "The time to delay the Environment action until, in RFC3339 format.", + "required": true, + "type": "string", + "format": "date-time" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentAction" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Delays the occurrence of an action.": { + "$ref": "./examples/Environments_DelayAction.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/operations": { + "get": { + "operationId": "Environments_ListOperations", + "description": "Lists operations on the environment which have occurred within the past 90 days", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "environmentName", + "in": "path", + "description": "Environment name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedEnvironmentOperation" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists operations on the environment which have occurred within the past 90 days.": { + "$ref": "./examples/Environments_ListOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationId}": { + "get": { + "operationId": "Environments_GetOperation", + "description": "Gets an environment action result.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "environmentName", + "in": "path", + "description": "Environment name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "operationId", + "in": "path", + "description": "Unique identifier for the environment operation.", + "required": true, + "type": "string", + "format": "uuid", + "minLength": 36, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentOperation" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets an environment action result.": { + "$ref": "./examples/Environments_GetOperation.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationId}/logs": { + "get": { + "operationId": "Environments_GetLogsByOperation", + "description": "Gets the logs for an operation on an environment.", + "produces": [ + "text/plain", + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "name": "operationId", + "in": "path", + "description": "The id of the operation on an environment.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets the logs for an operation on an environment.": { + "$ref": "./examples/Environments_GetLogsByOperation.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/outputs": { + "get": { + "operationId": "Environments_GetOutputs", + "description": "Gets Outputs from the environment.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentOutputs" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets Outputs from the environment.": { + "$ref": "./examples/Environments_GetOutputs.json" + } + } + } + }, + "/users/{userId}/devboxes": { + "get": { + "operationId": "DevBoxes_ListAllDevBoxesByUser", + "description": "Lists Dev Boxes in the Dev Center for a particular user.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDevBox" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists Dev Boxes in the project for a particular user.": { + "$ref": "./examples/DevBoxes_ListAllDevBoxesByUser.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Azure.Core.Foundations.Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "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/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "Azure.Core.Foundations.ErrorResponse": { + "type": "object", + "description": "A response containing error details.", + "properties": { + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "Azure.Core.Foundations.InnerError": { + "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.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "Inner error." + } + } + }, + "Azure.Core.Foundations.OperationState": { + "type": "string", + "description": "Enum describing allowed operation states.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "OperationState", + "modelAsString": true, + "values": [ + { + "name": "NotStarted", + "value": "NotStarted", + "description": "The operation has not started." + }, + { + "name": "Running", + "value": "Running", + "description": "The operation is in progress." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The operation has completed successfully." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The operation has failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "The operation has been canceled by the user." + } + ] + } + }, + "Azure.Core.azureLocation": { + "type": "string", + "description": "Represents an Azure geography region where supported resource providers live." + }, + "Azure.Core.uuid": { + "type": "string", + "format": "uuid", + "description": "Universally Unique Identifier" + }, + "Catalog": { + "type": "object", + "description": "A catalog.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the catalog." + }, + "name": { + "type": "string", + "description": "Name of the catalog.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + } + }, + "required": [ + "uri", + "name" + ] + }, + "CustomizationGroup": { + "type": "object", + "description": "Represents a list of tasks to apply to a Dev Box.", + "properties": { + "tasks": { + "type": "array", + "description": "Tasks to apply. Note by default tasks are excluded from the response when\nlisting customization groups. To include them, use the `include=tasks` query\nparameter.", + "items": { + "$ref": "#/definitions/CustomizationTask" + } + }, + "uri": { + "type": "string", + "description": "The unique URI of the customization group.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Name of the customization group.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/CustomizationGroupStatus", + "description": "Status of the customization group.", + "readOnly": true + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Start time of the customization group, in RFC3339 format.", + "readOnly": true + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "End time of the customization group, in RFC3339 format.", + "readOnly": true + } + }, + "required": [ + "name" + ] + }, + "CustomizationGroupStatus": { + "type": "string", + "description": "Status of a customization group.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed", + "ValidationFailed" + ], + "x-ms-enum": { + "name": "CustomizationGroupStatus", + "modelAsString": true, + "values": [ + { + "name": "NotStarted", + "value": "NotStarted", + "description": "The customization group has not yet started." + }, + { + "name": "Running", + "value": "Running", + "description": "The customization group is currently executing." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "All tasks in the customization group successfully executed." + }, + { + "name": "Failed", + "value": "Failed", + "description": "At least one task in the customization group failed." + }, + { + "name": "ValidationFailed", + "value": "ValidationFailed", + "description": "At least one task in the customization group failed validation." + } + ] + } + }, + "CustomizationTask": { + "type": "object", + "description": "A customization task to run on a Dev Box.", + "properties": { + "name": { + "type": "string", + "description": "Name of the task.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "parameters": { + "type": "object", + "description": "Parameters for the task.", + "additionalProperties": { + "type": "string" + } + }, + "displayName": { + "type": "string", + "description": "Display name to help differentiate multiple instances of the same task." + }, + "timeoutInSeconds": { + "type": "integer", + "format": "int32", + "description": "Timeout, in seconds. Overrides any timeout provided on the task definition." + }, + "runAs": { + "$ref": "#/definitions/CustomizationTaskExecutionAccount", + "description": "What account to run the task as." + }, + "id": { + "type": "string", + "description": "ID of the task instance.", + "readOnly": true + }, + "logUri": { + "type": "string", + "description": "The unique URI for retrieving the task logs.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/CustomizationTaskStatus", + "description": "Status of the task.", + "readOnly": true + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Start time of the task, in RFC3339 format.", + "readOnly": true + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "End time of the task, in RFC3339 format.", + "readOnly": true + } + }, + "required": [ + "name" + ] + }, + "CustomizationTaskDefinition": { + "type": "object", + "description": "Represents a task to be used in customizing a Dev Box.", + "properties": { + "name": { + "type": "string", + "description": "Full name of the task: {catalogName}/{taskName}.", + "readOnly": true + }, + "catalogName": { + "type": "string", + "description": "Name of the catalog that the task belongs to.", + "readOnly": true + }, + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the customization task.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of the task." + }, + "parameters": { + "type": "object", + "description": "Parameters for the task.", + "additionalProperties": { + "$ref": "#/definitions/CustomizationTaskDefinitionParameter" + } + } + }, + "required": [ + "name", + "catalogName" + ] + }, + "CustomizationTaskDefinitionParameter": { + "type": "object", + "description": "Parameters for a customization task.", + "properties": { + "description": { + "type": "string", + "description": "Description of the parameter." + }, + "type": { + "$ref": "#/definitions/CustomizationTaskDefinitionParameterType", + "description": "Type of the parameter." + }, + "required": { + "type": "boolean", + "description": "Whether or not the parameter is required.", + "readOnly": true + }, + "default": { + "type": "string", + "description": "Default value for the parameter." + }, + "allowed": { + "type": "array", + "description": "Allowed values for the parameter.", + "items": { + "type": "string" + } + } + }, + "required": [ + "type" + ] + }, + "CustomizationTaskDefinitionParameterType": { + "type": "string", + "description": "Type of the parameter.", + "enum": [ + "string", + "number", + "boolean" + ], + "x-ms-enum": { + "name": "CustomizationTaskDefinitionParameterType", + "modelAsString": true, + "values": [ + { + "name": "string", + "value": "string", + "description": "The parameter accepts a string value." + }, + { + "name": "number", + "value": "number", + "description": "The parameter accepts a number value." + }, + { + "name": "boolean", + "value": "boolean", + "description": "The parameter accepts a boolean value." + } + ] + } + }, + "CustomizationTaskExecutionAccount": { + "type": "string", + "description": "What account to run the task as.", + "enum": [ + "System", + "User" + ], + "x-ms-enum": { + "name": "CustomizationTaskExecutionAccount", + "modelAsString": true, + "values": [ + { + "name": "System", + "value": "System", + "description": "The SYSTEM account." + }, + { + "name": "User", + "value": "User", + "description": "The account of the signed in user." + } + ] + } + }, + "CustomizationTaskList": { + "type": "object", + "description": "Represents a list of tasks to apply to a Dev Box", + "properties": { + "tasks": { + "type": "array", + "description": "Tasks to apply.", + "items": { + "$ref": "#/definitions/CustomizationTask" + } + } + } + }, + "CustomizationTaskListValidationError": { + "type": "object", + "description": "All of the validation errors for a customization task.", + "properties": { + "target": { + "$ref": "#/definitions/CustomizationTask", + "description": "The customization task that the error is about." + }, + "details": { + "type": "array", + "description": "List of validation errors for the task.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "target", + "details" + ] + }, + "CustomizationTaskListValidationOperationResult": { + "type": "object", + "description": "The operation result of validating a list of customization tasks.", + "properties": { + "id": { + "type": "string", + "description": "Fully qualified ID for the operation status.", + "readOnly": true + }, + "name": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The operation id name.", + "minLength": 36, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Azure.Core.Foundations.OperationState", + "description": "Provisioning state of the resource." + }, + "resourceId": { + "type": "string", + "description": "The id of the resource." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the operation, in RFC3339 format." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the operation, in RFC3339 format." + }, + "percentComplete": { + "type": "number", + "format": "double", + "description": "Percent of the operation that is complete.", + "minimum": 0, + "maximum": 100 + }, + "properties": { + "description": "Custom operation properties, populated only for a successful operation." + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Operation Error message." + }, + "result": { + "$ref": "#/definitions/CustomizationTaskListValidationResult", + "description": "Outcome of validation." + } + }, + "required": [ + "id", + "name", + "status" + ] + }, + "CustomizationTaskListValidationResult": { + "type": "object", + "description": "The result of validating a list of customization tasks.", + "properties": { + "validationResult": { + "$ref": "#/definitions/CustomizationTaskListValidationStatus", + "description": "Outcome of validation." + }, + "errors": { + "type": "array", + "description": "List of validation errors. Absent if no errors.", + "items": { + "$ref": "#/definitions/CustomizationTaskListValidationError" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "validationResult" + ] + }, + "CustomizationTaskListValidationStatus": { + "type": "string", + "description": "Status of validating a list of customization tasks.", + "enum": [ + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "CustomizationTaskListValidationStatus", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Validation succeeded." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Validation failed." + } + ] + } + }, + "CustomizationTaskStatus": { + "type": "string", + "description": "Status of a customization task.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "FailedValidation", + "Skipped", + "TimedOut", + "Failed", + "WaitingForUserInputUac", + "WaitingForUserSession" + ], + "x-ms-enum": { + "name": "CustomizationTaskStatus", + "modelAsString": true, + "values": [ + { + "name": "NotStarted", + "value": "NotStarted", + "description": "The task has not yet started." + }, + { + "name": "Running", + "value": "Running", + "description": "The task is currently executing." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The task successfully executed." + }, + { + "name": "FailedValidation", + "value": "FailedValidation", + "description": "The task reference is not valid." + }, + { + "name": "Skipped", + "value": "Skipped", + "description": "he task was skipped." + }, + { + "name": "TimedOut", + "value": "TimedOut", + "description": "The task timed out." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The task failed to execute." + }, + { + "name": "WaitingForUserInputUac", + "value": "WaitingForUserInputUac", + "description": "The task is awaiting the User Account Control (UAC) prompt to be approved. (See more at: https://learn.microsoft.com/windows/security/application-security/application-control/user-account-control/)" + }, + { + "name": "WaitingForUserSession", + "value": "WaitingForUserSession", + "description": "The task is awaiting the user to connect to the Dev Box to execute." + } + ] + } + }, + "DevBox": { + "type": "object", + "description": "A Dev Box.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the dev box.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Display name for the Dev Box.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "projectName": { + "type": "string", + "description": "Name of the project this Dev Box belongs to.", + "readOnly": true + }, + "poolName": { + "type": "string", + "description": "The name of the Dev Box pool this machine belongs to.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "hibernateSupport": { + "$ref": "#/definitions/HibernateSupport", + "description": "Indicates whether hibernate is enabled/disabled or unknown.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/DevBoxProvisioningState", + "description": "The current provisioning state of the Dev Box.", + "readOnly": true + }, + "actionState": { + "type": "string", + "description": "The current action state of the Dev Box. This is state is based on previous\naction performed by user.", + "readOnly": true + }, + "powerState": { + "$ref": "#/definitions/PowerState", + "description": "The current power state of the Dev Box.", + "readOnly": true + }, + "uniqueId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "A unique identifier for the Dev Box. This is a GUID-formatted string (e.g.\n00000000-0000-0000-0000-000000000000).", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Provisioning or action error details. Populated only for error states.", + "readOnly": true + }, + "location": { + "$ref": "#/definitions/Azure.Core.azureLocation", + "description": "Azure region where this Dev Box is located. This will be the same region as the\nVirtual Network it is attached to.", + "readOnly": true + }, + "osType": { + "$ref": "#/definitions/OsType", + "description": "The operating system type of this Dev Box.", + "readOnly": true + }, + "user": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The AAD object id of the user this Dev Box is assigned to.", + "readOnly": true + }, + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfile", + "description": "Information about the Dev Box's hardware resources.", + "readOnly": true + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "Storage settings for this Dev Box.", + "readOnly": true + }, + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Information about the image used for this Dev Box.", + "readOnly": true + }, + "createdTime": { + "type": "string", + "format": "date-time", + "description": "Creation time of this Dev Box, in RFC3339 format.", + "readOnly": true + }, + "lastConnectedTime": { + "type": "string", + "format": "date-time", + "description": "Last time a user connected to this Dev Box, in RFC3339 format.", + "readOnly": true + }, + "localAdministrator": { + "$ref": "#/definitions/LocalAdminStatus", + "description": "Indicates whether the owner of the Dev Box is a local administrator.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "uri", + "name", + "poolName" + ] + }, + "DevBoxAction": { + "type": "object", + "description": "An action which will take place on a Dev Box.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI for the Dev Box action." + }, + "name": { + "type": "string", + "description": "The name of the action.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "actionType": { + "$ref": "#/definitions/DevBoxActionType", + "description": "The action that will be taken." + }, + "sourceId": { + "type": "string", + "description": "The id of the resource which triggered this action." + }, + "sourceUri": { + "type": "string", + "format": "uri", + "description": "The URI of the resource which triggered this action." + }, + "sourceType": { + "$ref": "#/definitions/DevBoxActionSourceType", + "description": "The type of the resource which triggered this action." + }, + "suspendedUntil": { + "type": "string", + "format": "date-time", + "description": "The earliest time that the action could occur (UTC), in RFC3339 format." + }, + "next": { + "$ref": "#/definitions/DevBoxNextAction", + "description": "Details about the next run of this action." + } + }, + "required": [ + "uri", + "name", + "actionType", + "sourceId", + "sourceUri", + "sourceType" + ] + }, + "DevBoxActionDelayResult": { + "type": "object", + "description": "The action delay result.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the action." + }, + "name": { + "type": "string", + "description": "The name of the action." + }, + "result": { + "$ref": "#/definitions/DevBoxActionDelayResultStatus", + "description": "The result of the delay operation on this action." + }, + "action": { + "$ref": "#/definitions/DevBoxAction", + "description": "The delayed action." + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Information about the error that occurred. Only populated on error." + } + }, + "required": [ + "uri", + "name", + "result" + ] + }, + "DevBoxActionDelayResultStatus": { + "type": "string", + "description": "The result of the delay operation on this action.", + "enum": [ + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "DevBoxActionDelayResultStatus", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The delay operation succeeded." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The delay operation failed." + } + ] + } + }, + "DevBoxActionSourceType": { + "type": "string", + "description": "The type of the resource which triggered the action.", + "enum": [ + "Pool", + "Schedule" + ], + "x-ms-enum": { + "name": "DevBoxActionSourceType", + "modelAsString": true, + "values": [ + { + "name": "Pool", + "value": "Pool", + "description": "The action was triggered by a Dev Box pool." + }, + { + "name": "Schedule", + "value": "Schedule", + "description": "The action was triggered by a Dev Box schedule." + } + ] + } + }, + "DevBoxActionType": { + "type": "string", + "description": "The type of action which will take place on a Dev Box.", + "enum": [ + "Stop" + ], + "x-ms-enum": { + "name": "DevBoxActionType", + "modelAsString": true, + "values": [ + { + "name": "Stop", + "value": "Stop", + "description": "The action will stop the Dev Box." + } + ] + } + }, + "DevBoxCaptureSnapshotOperation": { + "type": "object", + "description": "Information about a snapshot creation operation on a Dev Box.", + "allOf": [ + { + "$ref": "#/definitions/DevBoxOperation" + } + ], + "x-ms-discriminator-value": "CaptureSnapshot" + }, + "DevBoxNextAction": { + "type": "object", + "description": "Details about the next run of an action.", + "properties": { + "scheduledTime": { + "type": "string", + "format": "date-time", + "description": "The time the action will be triggered (UTC), in RFC3339 format." + } + }, + "required": [ + "scheduledTime" + ] + }, + "DevBoxOperation": { + "type": "object", + "description": "Information about an operation on a Dev Box.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI for the Dev Box operation." + }, + "operationId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "Unique identifier for the Dev Box operation.", + "minLength": 36, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$", + "readOnly": true + }, + "kind": { + "$ref": "#/definitions/DevBoxOperationKind", + "description": "The kind of operation that occurred." + }, + "status": { + "$ref": "#/definitions/Azure.Core.Foundations.OperationState", + "description": "The operation status." + }, + "createdByObjectId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The object ID of the actor which initiated the operation." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "he time the operation started, in RFC3339 format." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The time the operation finished, in RFC3339 format." + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Provisioning or operation error details. Populated only for error states." + } + }, + "discriminator": "kind", + "required": [ + "uri", + "operationId", + "kind", + "status" + ] + }, + "DevBoxOperationKind": { + "type": "string", + "description": "The type of Dev Box operation.", + "enum": [ + "Start", + "Stop", + "Restart", + "Repair", + "RestoreSnapshot", + "CaptureSnapshot" + ], + "x-ms-enum": { + "name": "DevBoxOperationKind", + "modelAsString": true, + "values": [ + { + "name": "Start", + "value": "Start", + "description": "The operation represents a Dev Box start." + }, + { + "name": "Stop", + "value": "Stop", + "description": "The operation represents a Dev Box stop." + }, + { + "name": "Restart", + "value": "Restart", + "description": "The operation represents a Dev Box restart." + }, + { + "name": "Repair", + "value": "Repair", + "description": "The operation represents a Dev Box repair." + }, + { + "name": "RestoreSnapshot", + "value": "RestoreSnapshot", + "description": "The operation represents a Dev Box restore from snapshot." + }, + { + "name": "CaptureSnapshot", + "value": "CaptureSnapshot", + "description": "The operation represents a Dev Box manual snapshot creation." + } + ] + } + }, + "DevBoxProvisioningState": { + "type": "string", + "description": "Indicates the provisioning state of the Dev Box.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Deleting", + "Updating", + "Starting", + "Stopping", + "Provisioning", + "ProvisionedWithWarning", + "InGracePeriod", + "NotProvisioned" + ], + "x-ms-enum": { + "name": "DevBoxProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Dev Box was successfully provisioned." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Dev Box failed to provision." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Dev Box provision was canceled." + }, + { + "name": "Creating", + "value": "Creating", + "description": "Dev Box is being created." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Dev Box is being deleted." + }, + { + "name": "Updating", + "value": "Updating", + "description": "Dev Box is updating." + }, + { + "name": "Starting", + "value": "Starting", + "description": "Dev Box is starting." + }, + { + "name": "Stopping", + "value": "Stopping", + "description": "Dev Box is stopping." + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Dev Box is provisioning." + }, + { + "name": "ProvisionedWithWarning", + "value": "ProvisionedWithWarning", + "description": "Dev Box was provisioned with warning." + }, + { + "name": "InGracePeriod", + "value": "InGracePeriod", + "description": "Dev Box is in grace period." + }, + { + "name": "NotProvisioned", + "value": "NotProvisioned", + "description": "Dev Box is not provisioned." + } + ] + } + }, + "DevBoxRepairOperation": { + "type": "object", + "description": "Information about a start operation on a Dev Box.", + "properties": { + "result": { + "$ref": "#/definitions/DevBoxRepairOperationResult", + "description": "The result of the repair operation." + } + }, + "allOf": [ + { + "$ref": "#/definitions/DevBoxOperation" + } + ], + "x-ms-discriminator-value": "Repair" + }, + "DevBoxRepairOperationResult": { + "type": "object", + "description": "Information about the result of a repair operation on a Dev Box.", + "properties": { + "repairOutcome": { + "$ref": "#/definitions/DevBoxRepairOutcome", + "description": "The outcome of the repair operation." + }, + "code": { + "type": "string", + "description": "The result code associated with the repair operation." + }, + "message": { + "type": "string", + "description": "The result message associated with the repair operation." + } + } + }, + "DevBoxRepairOutcome": { + "type": "string", + "description": "The action taken during a repair operation.", + "enum": [ + "FixApplied", + "IssuesDetected", + "NoIssuesDetected" + ], + "x-ms-enum": { + "name": "DevBoxRepairOutcome", + "modelAsString": true, + "values": [ + { + "name": "FixApplied", + "value": "FixApplied", + "description": "A fix for an issue was automatically applied to the Dev Box." + }, + { + "name": "IssuesDetected", + "value": "IssuesDetected", + "description": "One or more issues was detected on the Dev Box, but they could not be fixed automatically." + }, + { + "name": "NoIssuesDetected", + "value": "NoIssuesDetected", + "description": "The service did not identify any issues on the Dev Box." + } + ] + } + }, + "DevBoxRestartOperation": { + "type": "object", + "description": "Information about a restart operation on a Dev Box.", + "allOf": [ + { + "$ref": "#/definitions/DevBoxOperation" + } + ], + "x-ms-discriminator-value": "Restart" + }, + "DevBoxRestoreSnapshotOperation": { + "type": "object", + "description": "Information about a restore from snapshot operation on a Dev Box.", + "properties": { + "snapshotId": { + "type": "string", + "description": "Specifies the snapshot id that was used for the restore operation." + } + }, + "required": [ + "snapshotId" + ], + "allOf": [ + { + "$ref": "#/definitions/DevBoxOperation" + } + ], + "x-ms-discriminator-value": "RestoreSnapshot" + }, + "DevBoxSnapshot": { + "type": "object", + "description": "A DevBox snapshot", + "properties": { + "snapshotId": { + "type": "string", + "description": "The id of the snapshot. Should be treated as opaque string.", + "readOnly": true + }, + "createdTime": { + "type": "string", + "format": "date-time", + "description": "The datetime that the snapshot was created, in RFC3339 format.", + "readOnly": true + }, + "expirationTime": { + "type": "string", + "format": "date-time", + "description": "The datetime when the snapshot expires, will only be shown for a manual snapshot, in RFC3339 format.", + "readOnly": true + }, + "snapshotType": { + "$ref": "#/definitions/SnapshotType", + "description": "The type of the snapshot indicates whether it is manual or automatic.", + "readOnly": true + } + }, + "required": [ + "snapshotId", + "createdTime", + "snapshotType" + ] + }, + "DevBoxStartOperation": { + "type": "object", + "description": "Information about a start operation on a Dev Box.", + "allOf": [ + { + "$ref": "#/definitions/DevBoxOperation" + } + ], + "x-ms-discriminator-value": "Start" + }, + "DevBoxStopOperation": { + "type": "object", + "description": "Information about a stop operation on a Dev Box.", + "allOf": [ + { + "$ref": "#/definitions/DevBoxOperation" + } + ], + "x-ms-discriminator-value": "Stop" + }, + "Environment": { + "type": "object", + "description": "Properties of an environment.", + "properties": { + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "The time the expiration date will be triggered (UTC), after which the\nenvironment and associated resources will be deleted." + }, + "parameters": { + "type": "object", + "description": "Parameters object for the environment.", + "additionalProperties": {} + }, + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the environment.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Environment name.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "environmentType": { + "type": "string", + "description": "Environment type.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "user": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The AAD object id of the owner of this Environment.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/EnvironmentProvisioningState", + "description": "The provisioning state of the environment.", + "readOnly": true + }, + "resourceGroupId": { + "type": "string", + "description": "The identifier of the resource group containing the environment's resources.", + "readOnly": true + }, + "catalogName": { + "type": "string", + "description": "Name of the catalog.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "environmentDefinitionName": { + "type": "string", + "description": "Name of the environment definition.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Provisioning error details. Populated only for error states.", + "readOnly": true + } + }, + "required": [ + "uri", + "name", + "environmentType", + "catalogName", + "environmentDefinitionName" + ] + }, + "EnvironmentAction": { + "type": "object", + "description": "An upcoming Environment Action.", + "properties": { + "name": { + "type": "string", + "description": "Uniquely identifies the action.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "uri": { + "type": "string", + "format": "uri", + "description": "Uri of the action resource.", + "readOnly": true + }, + "actionType": { + "$ref": "#/definitions/EnvironmentActionType", + "description": "The action that will be taken." + }, + "next": { + "$ref": "#/definitions/EnvironmentNextAction", + "description": "Details about the next run of this action." + }, + "lastModifiedBy": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "Object Id of the user who last modified the action.", + "readOnly": true + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "Time the object was last modified, in RFC3339 format." + } + }, + "required": [ + "name", + "uri", + "actionType" + ] + }, + "EnvironmentActionType": { + "type": "string", + "description": "The scheduled action types.", + "enum": [ + "Delete" + ], + "x-ms-enum": { + "name": "EnvironmentActionType", + "modelAsString": true, + "values": [ + { + "name": "Delete", + "value": "Delete", + "description": "The action will delete the environment and associated resources." + } + ] + } + }, + "EnvironmentDefinition": { + "type": "object", + "description": "An environment definition.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the environment definition." + }, + "id": { + "type": "string", + "description": "The ID of the environment definition." + }, + "name": { + "type": "string", + "description": "Name of the environment definition.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "catalogName": { + "type": "string", + "description": "Name of the catalog." + }, + "description": { + "type": "string", + "description": "A short description of the environment definition." + }, + "parameters": { + "type": "array", + "description": "Input parameters passed to an environment.", + "items": { + "$ref": "#/definitions/EnvironmentDefinitionParameter" + } + }, + "parametersSchema": { + "type": "string", + "description": "JSON schema defining the parameters object passed to an environment." + }, + "templatePath": { + "type": "string", + "description": "Path to the Environment Definition entrypoint file." + } + }, + "required": [ + "uri", + "id", + "name", + "catalogName" + ] + }, + "EnvironmentDefinitionParameter": { + "type": "object", + "description": "Properties of an Environment Definition parameter", + "properties": { + "id": { + "type": "string", + "description": "Unique ID of the parameter." + }, + "name": { + "type": "string", + "description": "Display name of the parameter." + }, + "description": { + "type": "string", + "description": "Description of the parameter." + }, + "default": { + "type": "string", + "description": "Default value of the parameter." + }, + "type": { + "$ref": "#/definitions/ParameterType", + "description": "A string of one of the basic JSON types (number, integer, array, object,\nboolean, string)." + }, + "readOnly": { + "type": "boolean", + "description": "Whether or not this parameter is read-only. If true, default should have a\nvalue." + }, + "required": { + "type": "boolean", + "description": "Whether or not this parameter is required." + }, + "allowed": { + "type": "array", + "description": "An array of allowed values.", + "minItems": 1, + "items": { + "type": "string" + } + } + }, + "required": [ + "id", + "type", + "required" + ] + }, + "EnvironmentDeleteOperation": { + "type": "object", + "description": "Information about a delete operation on an environment.", + "allOf": [ + { + "$ref": "#/definitions/EnvironmentOperation" + } + ], + "x-ms-discriminator-value": "Delete" + }, + "EnvironmentDeployOperation": { + "type": "object", + "description": "Information about a deploy operation on an environment.", + "allOf": [ + { + "$ref": "#/definitions/EnvironmentOperation" + } + ], + "x-ms-discriminator-value": "Deploy" + }, + "EnvironmentNextAction": { + "type": "object", + "description": "Details about the next run of an action.", + "properties": { + "scheduledTime": { + "type": "string", + "format": "date-time", + "description": "The time the action will be triggered (UTC), in RFC3339 format." + } + } + }, + "EnvironmentOperation": { + "type": "object", + "description": "Information about an operation on an environment.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI for the environment operation." + }, + "operationId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "Unique identifier for the environment operation.", + "minLength": 36, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$", + "readOnly": true + }, + "kind": { + "$ref": "#/definitions/EnvironmentOperationKind", + "description": "The kind of operation that occurred." + }, + "status": { + "$ref": "#/definitions/Azure.Core.Foundations.OperationState", + "description": "The operation status." + }, + "createdByObjectId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The object ID of the actor which initiated the operation." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The time the operation started, in RFC3339 format." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The time the operation finished, in RFC3339 format." + }, + "environmentParameters": { + "type": "object", + "description": "Parameters object for the environment at the time of the operation.", + "additionalProperties": {} + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Provisioning or operation error details. Populated only for error states." + } + }, + "discriminator": "kind", + "required": [ + "uri", + "operationId", + "kind", + "status" + ] + }, + "EnvironmentOperationKind": { + "type": "string", + "description": "The type of environment operation.", + "enum": [ + "Deploy", + "Delete" + ], + "x-ms-enum": { + "name": "EnvironmentOperationKind", + "modelAsString": true, + "values": [ + { + "name": "Deploy", + "value": "Deploy", + "description": "The operation represents a deployment." + }, + { + "name": "Delete", + "value": "Delete", + "description": "The operation represents a delete." + } + ] + } + }, + "EnvironmentOutput": { + "type": "object", + "description": "Output from environment deployment.", + "properties": { + "type": { + "$ref": "#/definitions/EnvironmentOutputType", + "description": "Type of the output value." + }, + "value": { + "description": "The output value." + }, + "sensitive": { + "type": "boolean", + "description": "Indicates if the value is sensitive." + } + } + }, + "EnvironmentOutputType": { + "type": "string", + "description": "Type of the output value.", + "enum": [ + "array", + "boolean", + "number", + "object", + "string" + ], + "x-ms-enum": { + "name": "EnvironmentOutputType", + "modelAsString": true, + "values": [ + { + "name": "array", + "value": "array", + "description": "The output is an array of values." + }, + { + "name": "boolean", + "value": "boolean", + "description": "The output is a boolean value." + }, + { + "name": "number", + "value": "number", + "description": "The output is a number value." + }, + { + "name": "object", + "value": "object", + "description": "The output is an object value." + }, + { + "name": "string", + "value": "string", + "description": "The output is a string value." + } + ] + } + }, + "EnvironmentOutputs": { + "type": "object", + "description": "Outputs from environment deployment.", + "properties": { + "outputs": { + "type": "object", + "description": "The outputs Names and Values.", + "additionalProperties": { + "$ref": "#/definitions/EnvironmentOutput" + } + } + } + }, + "EnvironmentProvisioningState": { + "type": "string", + "description": "The provisioning state of the environment.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Accepted", + "Deleting", + "Updating", + "Preparing", + "Running", + "Syncing", + "MovingResources", + "TransientFailure", + "StorageProvisioningFailed" + ], + "x-ms-enum": { + "name": "EnvironmentProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The environment was successfully provisioned." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The environment failed to provision." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "The environment provisioning was canceled." + }, + { + "name": "Creating", + "value": "Creating", + "description": "The environment is creating." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The environment was accepted." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The environment is deleting." + }, + { + "name": "Updating", + "value": "Updating", + "description": "The environment is updating." + }, + { + "name": "Preparing", + "value": "Preparing", + "description": "The environment is preparing." + }, + { + "name": "Running", + "value": "Running", + "description": "The environment is running." + }, + { + "name": "Syncing", + "value": "Syncing", + "description": "The environment is Syncing." + }, + { + "name": "MovingResources", + "value": "MovingResources", + "description": "The environment is moving resources." + }, + { + "name": "TransientFailure", + "value": "TransientFailure", + "description": "The environment has a transient failure." + }, + { + "name": "StorageProvisioningFailed", + "value": "StorageProvisioningFailed", + "description": "The environment storage provisioning failed." + } + ] + } + }, + "EnvironmentType": { + "type": "object", + "description": "Properties of an environment type.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the environment type." + }, + "name": { + "type": "string", + "description": "Name of the environment type.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "deploymentTargetId": { + "type": "string", + "description": "Id of a subscription or management group that the environment type will be\nmapped to. The environment's resources will be deployed into this subscription\nor management group." + }, + "status": { + "$ref": "#/definitions/EnvironmentTypeEnableStatus", + "description": "Indicates whether this environment type is enabled for use in this project." + }, + "displayName": { + "type": "string", + "description": "Display name of the environment type." + } + }, + "required": [ + "uri", + "name", + "deploymentTargetId", + "status" + ] + }, + "EnvironmentTypeAbilities": { + "type": "object", + "description": "Abilities a user has on an environment type.", + "properties": { + "abilitiesAsAdmin": { + "type": "array", + "description": "The abilities the user has to perform actions on the environment type as an admin.", + "items": { + "$ref": "#/definitions/EnvironmentTypeAbilityAsAdmin" + } + }, + "abilitiesAsDeveloper": { + "type": "array", + "description": "The abilities the user has to perform actions on the environment type as a developer.", + "items": { + "$ref": "#/definitions/EnvironmentTypeAbilityAsDeveloper" + } + } + }, + "required": [ + "abilitiesAsAdmin", + "abilitiesAsDeveloper" + ] + }, + "EnvironmentTypeAbilityAsAdmin": { + "type": "string", + "description": "An ability the user has to perform an action on the environment type as an admin.", + "enum": [ + "DeleteEnvironments", + "ManageEnvironmentActions", + "ReadEnvironmentActions", + "ReadEnvironmentOutputs", + "ReadEnvironments", + "WriteEnvironments" + ], + "x-ms-enum": { + "name": "EnvironmentTypeAbilityAsAdmin", + "modelAsString": true, + "values": [ + { + "name": "DeleteEnvironments", + "value": "DeleteEnvironments", + "description": "User can delete environments." + }, + { + "name": "ManageEnvironmentActions", + "value": "ManageEnvironmentActions", + "description": "User can delay and skip actions on environments." + }, + { + "name": "ReadEnvironmentActions", + "value": "ReadEnvironmentActions", + "description": "User can read actions on environments." + }, + { + "name": "ReadEnvironmentOutputs", + "value": "ReadEnvironmentOutputs", + "description": "User can read outputs on environments." + }, + { + "name": "ReadEnvironments", + "value": "ReadEnvironments", + "description": "User can read environments." + }, + { + "name": "WriteEnvironments", + "value": "WriteEnvironments", + "description": "User can create new environments or replace and update existing ones." + } + ] + } + }, + "EnvironmentTypeAbilityAsDeveloper": { + "type": "string", + "description": "An ability the user has to perform an action on the environment type as a developer.", + "enum": [ + "DeleteEnvironments", + "ManageEnvironmentActions", + "ReadEnvironmentActions", + "ReadEnvironmentOutputs", + "ReadEnvironments", + "WriteEnvironments" + ], + "x-ms-enum": { + "name": "EnvironmentTypeAbilityAsDeveloper", + "modelAsString": true, + "values": [ + { + "name": "DeleteEnvironments", + "value": "DeleteEnvironments", + "description": "User can delete environments." + }, + { + "name": "ManageEnvironmentActions", + "value": "ManageEnvironmentActions", + "description": "User can delay and skip actions on environments." + }, + { + "name": "ReadEnvironmentActions", + "value": "ReadEnvironmentActions", + "description": "User can read actions on environments." + }, + { + "name": "ReadEnvironmentOutputs", + "value": "ReadEnvironmentOutputs", + "description": "User can read outputs on environments." + }, + { + "name": "ReadEnvironments", + "value": "ReadEnvironments", + "description": "User can read environments." + }, + { + "name": "WriteEnvironments", + "value": "WriteEnvironments", + "description": "User can create new environments or replace and update existing ones." + } + ] + } + }, + "EnvironmentTypeEnableStatus": { + "type": "string", + "description": "Indicates whether an environment type is enabled for use in a project.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EnvironmentTypeEnableStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "The environment type is enabled for use in the project." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The environment type is not enabled for use in the project." + } + ] + } + }, + "EnvironmentUpdate": { + "type": "object", + "description": "Properties of an environment.", + "properties": { + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "The time the expiration date will be triggered (UTC), after which the\nenvironment and associated resources will be deleted." + }, + "parameters": { + "type": "object", + "description": "Parameters object for the environment.", + "additionalProperties": {} + } + } + }, + "HardwareProfile": { + "type": "object", + "description": "Hardware specifications for the Dev Box.", + "properties": { + "skuName": { + "$ref": "#/definitions/SkuName", + "description": "The name of the SKU.", + "readOnly": true + }, + "vCPUs": { + "type": "integer", + "format": "int32", + "description": "The number of vCPUs available for the Dev Box.", + "readOnly": true + }, + "memoryGB": { + "type": "integer", + "format": "int32", + "description": "The amount of memory available for the Dev Box.", + "readOnly": true + } + } + }, + "HibernateSupport": { + "type": "string", + "description": "Indicates whether hibernate is supported and enabled, disabled, or unsupported by the operating system. Unknown hibernate support is represented as null.", + "enum": [ + "Enabled", + "Disabled", + "OsUnsupported" + ], + "x-ms-enum": { + "name": "HibernateSupport", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Hibernate is enabled." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Hibernate is not enabled." + }, + { + "name": "OsUnsupported", + "value": "OsUnsupported", + "description": "Hibernate is not supported by the operating system." + } + ] + } + }, + "ImageReference": { + "type": "object", + "description": "Specifies information about the image used.", + "properties": { + "name": { + "type": "string", + "description": "The name of the image used.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "The version of the image.", + "readOnly": true + }, + "operatingSystem": { + "type": "string", + "description": "The operating system of the image.", + "readOnly": true + }, + "osBuildNumber": { + "type": "string", + "description": "The operating system build number of the image.", + "readOnly": true + }, + "publishedDate": { + "type": "string", + "format": "date-time", + "description": "The datetime that the backing image version was published, in RFC3339 format.", + "readOnly": true + } + } + }, + "LocalAdminStatus": { + "type": "string", + "description": "Indicates whether owners of Dev Boxes in a pool are local administrators on the Dev Boxes.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "LocalAdminStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Owners of Dev Boxes in the pool are local administrators on the Dev Boxes." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Owners of Dev Boxes in the pool are not local administrators on the Dev Boxes." + } + ] + } + }, + "OperationStatus": { + "type": "object", + "description": "The current status of an async operation.", + "properties": { + "id": { + "type": "string", + "description": "Fully qualified ID for the operation status.", + "readOnly": true + }, + "name": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The operation id name.", + "minLength": 36, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Azure.Core.Foundations.OperationState", + "description": "Provisioning state of the resource." + }, + "resourceId": { + "type": "string", + "description": "The id of the resource." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the operation, in RFC3339 format." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the operation, in RFC3339 format." + }, + "percentComplete": { + "type": "number", + "format": "double", + "description": "Percent of the operation that is complete.", + "minimum": 0, + "maximum": 100 + }, + "properties": { + "description": "Custom operation properties, populated only for a successful operation." + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Operation Error message." + } + }, + "required": [ + "id", + "name", + "status" + ] + }, + "OsDisk": { + "type": "object", + "description": "Settings for the operating system disk.", + "properties": { + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "The size of the OS Disk in gigabytes.", + "readOnly": true + } + } + }, + "OsType": { + "type": "string", + "description": "The operating system type.", + "enum": [ + "Windows" + ], + "x-ms-enum": { + "name": "OsType", + "modelAsString": true, + "values": [ + { + "name": "Windows", + "value": "Windows", + "description": "The Windows operating system." + } + ] + } + }, + "PagedCatalog": { + "type": "object", + "description": "Paged collection of Catalog items", + "properties": { + "value": { + "type": "array", + "description": "The Catalog items on this page", + "items": { + "$ref": "#/definitions/Catalog" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedCustomizationGroup": { + "type": "object", + "description": "Paged collection of CustomizationGroup items", + "properties": { + "value": { + "type": "array", + "description": "The CustomizationGroup items on this page", + "items": { + "$ref": "#/definitions/CustomizationGroup" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedCustomizationTaskDefinition": { + "type": "object", + "description": "The Customization Task list result.", + "properties": { + "value": { + "type": "array", + "description": "The CustomizationTaskDefinition items on this page", + "items": { + "$ref": "#/definitions/CustomizationTaskDefinition" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedDevBox": { + "type": "object", + "description": "Paged collection of DevBox items", + "properties": { + "value": { + "type": "array", + "description": "The DevBox items on this page", + "items": { + "$ref": "#/definitions/DevBox" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedDevBoxAction": { + "type": "object", + "description": "Paged collection of DevBoxAction items", + "properties": { + "value": { + "type": "array", + "description": "The DevBoxAction items on this page", + "items": { + "$ref": "#/definitions/DevBoxAction" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedDevBoxActionDelayResult": { + "type": "object", + "description": "Paged collection of DevBoxActionDelayResult items", + "properties": { + "value": { + "type": "array", + "description": "The DevBoxActionDelayResult items on this page", + "items": { + "$ref": "#/definitions/DevBoxActionDelayResult" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedDevBoxOperation": { + "type": "object", + "description": "Paged collection of DevBoxOperation items", + "properties": { + "value": { + "type": "array", + "description": "The DevBoxOperation items on this page", + "items": { + "$ref": "#/definitions/DevBoxOperation" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedDevBoxSnapshot": { + "type": "object", + "description": "Paged collection of DevBoxSnapshot items", + "properties": { + "value": { + "type": "array", + "description": "The DevBoxSnapshot items on this page", + "items": { + "$ref": "#/definitions/DevBoxSnapshot" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedEnvironment": { + "type": "object", + "description": "Paged collection of Environment items", + "properties": { + "value": { + "type": "array", + "description": "The Environment items on this page", + "items": { + "$ref": "#/definitions/Environment" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedEnvironmentAction": { + "type": "object", + "description": "Paged collection of EnvironmentAction items", + "properties": { + "value": { + "type": "array", + "description": "The EnvironmentAction items on this page", + "items": { + "$ref": "#/definitions/EnvironmentAction" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedEnvironmentDefinition": { + "type": "object", + "description": "Paged collection of EnvironmentDefinition items", + "properties": { + "value": { + "type": "array", + "description": "The EnvironmentDefinition items on this page", + "items": { + "$ref": "#/definitions/EnvironmentDefinition" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedEnvironmentOperation": { + "type": "object", + "description": "Paged collection of EnvironmentOperation items", + "properties": { + "value": { + "type": "array", + "description": "The EnvironmentOperation items on this page", + "items": { + "$ref": "#/definitions/EnvironmentOperation" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedEnvironmentType": { + "type": "object", + "description": "Paged collection of EnvironmentType items", + "properties": { + "value": { + "type": "array", + "description": "The EnvironmentType items on this page", + "items": { + "$ref": "#/definitions/EnvironmentType" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedPool": { + "type": "object", + "description": "Paged collection of Pool items", + "properties": { + "value": { + "type": "array", + "description": "The Pool items on this page", + "items": { + "$ref": "#/definitions/Pool" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedProject": { + "type": "object", + "description": "Paged collection of Project items", + "properties": { + "value": { + "type": "array", + "description": "The Project items on this page", + "items": { + "$ref": "#/definitions/Project" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedSchedule": { + "type": "object", + "description": "Paged collection of Schedule items", + "properties": { + "value": { + "type": "array", + "description": "The Schedule items on this page", + "items": { + "$ref": "#/definitions/Schedule" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ParameterType": { + "type": "string", + "description": "The type of data a parameter accepts.", + "enum": [ + "array", + "boolean", + "integer", + "number", + "object", + "string" + ], + "x-ms-enum": { + "name": "ParameterType", + "modelAsString": true, + "values": [ + { + "name": "array", + "value": "array", + "description": "The parameter accepts an array of values." + }, + { + "name": "boolean", + "value": "boolean", + "description": "The parameter accepts a boolean value." + }, + { + "name": "integer", + "value": "integer", + "description": "The parameter accepts an integer value." + }, + { + "name": "number", + "value": "number", + "description": "The parameter accepts a number value." + }, + { + "name": "object", + "value": "object", + "description": "The parameter accepts an object value." + }, + { + "name": "string", + "value": "string", + "description": "The parameter accepts a string value." + } + ] + } + }, + "Pool": { + "type": "object", + "description": "A pool of Dev Boxes.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the pool." + }, + "name": { + "type": "string", + "description": "Pool name.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "location": { + "$ref": "#/definitions/Azure.Core.azureLocation", + "description": "Azure region where Dev Boxes in the pool are located." + }, + "osType": { + "$ref": "#/definitions/OsType", + "description": "The operating system type of Dev Boxes in this pool." + }, + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfile", + "description": "Hardware settings for the Dev Boxes created in this pool." + }, + "hibernateSupport": { + "$ref": "#/definitions/HibernateSupport", + "description": "Indicates whether hibernate is enabled/disabled or unknown." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "Storage settings for Dev Box created in this pool." + }, + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Image settings for Dev Boxes create in this pool." + }, + "localAdministrator": { + "$ref": "#/definitions/LocalAdminStatus", + "description": "Indicates whether owners of Dev Boxes in this pool are local administrators on\nthe Dev Boxes." + }, + "stopOnDisconnect": { + "$ref": "#/definitions/StopOnDisconnectConfiguration", + "description": "Stop on disconnect configuration settings for Dev Boxes created in this pool." + }, + "stopOnNoConnect": { + "$ref": "#/definitions/StopOnNoConnectConfiguration", + "description": "Stop on no connect configuration settings for Dev Boxes created in this pool." + }, + "healthStatus": { + "$ref": "#/definitions/PoolHealthStatus", + "description": "Overall health status of the Pool. Indicates whether or not the Pool is\navailable to create Dev Boxes." + }, + "displayName": { + "type": "string", + "description": "Display name of the pool." + } + }, + "required": [ + "uri", + "name", + "location", + "healthStatus" + ] + }, + "PoolHealthStatus": { + "type": "string", + "description": "Pool status indicating whether a pool is available to create Dev Boxes.", + "enum": [ + "Unknown", + "Pending", + "Healthy", + "Warning", + "Unhealthy" + ], + "x-ms-enum": { + "name": "PoolHealthStatus", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "The pool health status is not known." + }, + { + "name": "Pending", + "value": "Pending", + "description": "The pool health status waiting for health checks to run." + }, + { + "name": "Healthy", + "value": "Healthy", + "description": "The pool health status is healthy." + }, + { + "name": "Warning", + "value": "Warning", + "description": "The pool health status has one or more warnings." + }, + { + "name": "Unhealthy", + "value": "Unhealthy", + "description": "The pool health status is not healthy." + } + ] + } + }, + "PowerState": { + "type": "string", + "description": "The power states of a Dev Box.", + "enum": [ + "Unknown", + "Running", + "Deallocated", + "PoweredOff", + "Hibernated" + ], + "x-ms-enum": { + "name": "PowerState", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "The Dev Box power state is not known." + }, + { + "name": "Running", + "value": "Running", + "description": "The Dev Box is running." + }, + { + "name": "Deallocated", + "value": "Deallocated", + "description": "The Dev Box is deallocated." + }, + { + "name": "PoweredOff", + "value": "PoweredOff", + "description": "The Dev Box is powered off." + }, + { + "name": "Hibernated", + "value": "Hibernated", + "description": "The Dev Box is hibernated." + } + ] + } + }, + "Project": { + "type": "object", + "description": "Project details.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the project." + }, + "name": { + "type": "string", + "description": "Name of the project.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of the project." + }, + "maxDevBoxesPerUser": { + "type": "integer", + "format": "int32", + "description": "When specified, indicates the maximum number of Dev Boxes a single user can\ncreate across all pools in the project.", + "minimum": 0 + }, + "displayName": { + "type": "string", + "description": "Display name of the pool." + } + }, + "required": [ + "uri", + "name" + ] + }, + "ProjectAbilities": { + "type": "object", + "description": "Abilities a user has on a project.", + "properties": { + "abilitiesAsAdmin": { + "type": "array", + "description": "The abilities the user has to perform actions on the project as an admin.", + "items": { + "$ref": "#/definitions/ProjectAbilityAsAdmin" + } + }, + "abilitiesAsDeveloper": { + "type": "array", + "description": "The abilities the user has to perform actions on the project as a developer.", + "items": { + "$ref": "#/definitions/ProjectAbilityAsDeveloper" + } + } + }, + "required": [ + "abilitiesAsAdmin", + "abilitiesAsDeveloper" + ] + }, + "ProjectAbilityAsAdmin": { + "type": "string", + "description": "An ability the user has to perform an action on the project as an admin.", + "enum": [ + "DeleteDevBoxes", + "DeleteEnvironments", + "ManageEnvironmentActions", + "ReadDevBoxes", + "ReadEnvironmentActions", + "ReadEnvironmentOutputs", + "ReadEnvironments", + "StartDevBoxes", + "StopDevBoxes", + "WriteDevBoxes", + "WriteEnvironments" + ], + "x-ms-enum": { + "name": "ProjectAbilityAsAdmin", + "modelAsString": true, + "values": [ + { + "name": "DeleteDevBoxes", + "value": "DeleteDevBoxes", + "description": "User can delete dev boxes." + }, + { + "name": "DeleteEnvironments", + "value": "DeleteEnvironments", + "description": "User can delete environments." + }, + { + "name": "ManageEnvironmentActions", + "value": "ManageEnvironmentActions", + "description": "User can delay and skip actions on environments." + }, + { + "name": "ReadDevBoxes", + "value": "ReadDevBoxes", + "description": "User can read dev boxes." + }, + { + "name": "ReadEnvironmentActions", + "value": "ReadEnvironmentActions", + "description": "User can read actions on environments." + }, + { + "name": "ReadEnvironmentOutputs", + "value": "ReadEnvironmentOutputs", + "description": "User can read outputs on environments." + }, + { + "name": "ReadEnvironments", + "value": "ReadEnvironments", + "description": "User can read environments." + }, + { + "name": "StartDevBoxes", + "value": "StartDevBoxes", + "description": "User can start dev boxes." + }, + { + "name": "StopDevBoxes", + "value": "StopDevBoxes", + "description": "User can stop dev boxes." + }, + { + "name": "WriteDevBoxes", + "value": "WriteDevBoxes", + "description": "User can create dev boxes." + }, + { + "name": "WriteEnvironments", + "value": "WriteEnvironments", + "description": "User can create new environments or replace and update existing ones." + } + ] + } + }, + "ProjectAbilityAsDeveloper": { + "type": "string", + "description": "An ability the user has to perform an action on the project as a developer.", + "enum": [ + "CustomizeDevBoxes", + "DeleteDevBoxes", + "DeleteEnvironments", + "ManageDevBoxActions", + "ManageEnvironmentActions", + "ReadDevBoxActions", + "ReadDevBoxes", + "ReadEnvironmentActions", + "ReadEnvironmentOutputs", + "ReadEnvironments", + "ReadRemoteConnections", + "StartDevBoxes", + "StopDevBoxes", + "WriteDevBoxes", + "WriteEnvironments" + ], + "x-ms-enum": { + "name": "ProjectAbilityAsDeveloper", + "modelAsString": true, + "values": [ + { + "name": "CustomizeDevBoxes", + "value": "CustomizeDevBoxes", + "description": "User can customize their own dev boxes." + }, + { + "name": "DeleteDevBoxes", + "value": "DeleteDevBoxes", + "description": "User can delete their own dev boxes." + }, + { + "name": "DeleteEnvironments", + "value": "DeleteEnvironments", + "description": "User can delete environments." + }, + { + "name": "ManageDevBoxActions", + "value": "ManageDevBoxActions", + "description": "User can delay and skip actions on their own dev boxes." + }, + { + "name": "ManageEnvironmentActions", + "value": "ManageEnvironmentActions", + "description": "User can delay and skip actions on environments." + }, + { + "name": "ReadDevBoxActions", + "value": "ReadDevBoxActions", + "description": "User can read actions on their own dev boxes." + }, + { + "name": "ReadDevBoxes", + "value": "ReadDevBoxes", + "description": "User can read their own dev boxes." + }, + { + "name": "ReadEnvironmentActions", + "value": "ReadEnvironmentActions", + "description": "User can read actions on environments." + }, + { + "name": "ReadEnvironmentOutputs", + "value": "ReadEnvironmentOutputs", + "description": "User can read outputs on environments." + }, + { + "name": "ReadEnvironments", + "value": "ReadEnvironments", + "description": "User can read environments." + }, + { + "name": "ReadRemoteConnections", + "value": "ReadRemoteConnections", + "description": "User can read remote connections on their own dev boxes." + }, + { + "name": "StartDevBoxes", + "value": "StartDevBoxes", + "description": "User can start their own dev boxes." + }, + { + "name": "StopDevBoxes", + "value": "StopDevBoxes", + "description": "User can stop their own dev boxes." + }, + { + "name": "WriteDevBoxes", + "value": "WriteDevBoxes", + "description": "User can create dev boxes." + }, + { + "name": "WriteEnvironments", + "value": "WriteEnvironments", + "description": "User can create new environments or replace and update existing ones." + } + ] + } + }, + "RemoteConnection": { + "type": "object", + "description": "Provides remote connection information for a Dev Box.", + "properties": { + "webUrl": { + "type": "string", + "format": "uri", + "description": "URL to open a browser based RDP session." + }, + "rdpConnectionUrl": { + "type": "string", + "format": "uri", + "description": "Link to open a Remote Desktop session." + }, + "cloudPcConnectionUrl": { + "type": "string", + "format": "uri", + "description": "Link to open a remote desktop session via a dev box's underlying Cloud PC (This will default to Windows App)." + } + } + }, + "Schedule": { + "type": "object", + "description": "A Schedule to execute action.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the schedule." + }, + "name": { + "type": "string", + "description": "Display name for the Schedule.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "sourceUri": { + "type": "string", + "format": "uri", + "description": "The URI of the resource that this schedule belongs to." + }, + "sourceType": { + "$ref": "#/definitions/ScheduleSourceType", + "description": "The type of the resource that this schedule belongs to." + }, + "type": { + "$ref": "#/definitions/ScheduledType", + "description": "Supported type this scheduled task represents." + }, + "frequency": { + "$ref": "#/definitions/ScheduledFrequency", + "description": "The frequency of this scheduled task." + }, + "time": { + "type": "string", + "description": "The target time to trigger the action. The format is HH:MM." + }, + "timeZone": { + "type": "string", + "description": "The IANA timezone id at which the schedule should execute." + } + }, + "required": [ + "uri", + "name", + "sourceUri", + "sourceType", + "type", + "frequency", + "time", + "timeZone" + ] + }, + "ScheduleSourceType": { + "type": "string", + "description": "The type of the resource that this schedule belongs to.", + "enum": [ + "Pool" + ], + "x-ms-enum": { + "name": "ScheduleSourceType", + "modelAsString": true, + "values": [ + { + "name": "Pool", + "value": "Pool", + "description": "The schedule source is a Dev Box pool." + } + ] + } + }, + "ScheduledFrequency": { + "type": "string", + "description": "The frequency of task execution.", + "enum": [ + "Daily" + ], + "x-ms-enum": { + "name": "ScheduledFrequency", + "modelAsString": true, + "values": [ + { + "name": "Daily", + "value": "Daily", + "description": "The scheduled task will run every day." + } + ] + } + }, + "ScheduledType": { + "type": "string", + "description": "The supported types for a scheduled task.", + "enum": [ + "StopDevBox" + ], + "x-ms-enum": { + "name": "ScheduledType", + "modelAsString": true, + "values": [ + { + "name": "StopDevBox", + "value": "StopDevBox", + "description": "The scheduled task will stop impacted Dev Boxes." + } + ] + } + }, + "SkuName": { + "type": "string", + "description": "Indicates the Dev Box compute.", + "enum": [ + "general_i_8c32gb256ssd_v2", + "general_i_8c32gb512ssd_v2", + "general_i_8c32gb1024ssd_v2", + "general_i_8c32gb2048ssd_v2", + "general_i_16c64gb256ssd_v2", + "general_i_16c64gb512ssd_v2", + "general_i_16c64gb1024ssd_v2", + "general_i_16c64gb2048ssd_v2", + "general_i_32c128gb512ssd_v2", + "general_i_32c128gb1024ssd_v2", + "general_i_32c128gb2048ssd_v2", + "general_a_8c32gb256ssd_v2", + "general_a_8c32gb512ssd_v2", + "general_a_8c32gb1024ssd_v2", + "general_a_8c32gb2048ssd_v2", + "general_a_16c64gb256ssd_v2", + "general_a_16c64gb512ssd_v2", + "general_a_16c64gb1024ssd_v2", + "general_a_16c64gb2048ssd_v2", + "general_a_32c128gb512ssd_v2", + "general_a_32c128gb1024ssd_v2", + "general_a_32c128gb2048ssd_v2" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true, + "values": [ + { + "name": "general_i_8c32gb256ssd_v2", + "value": "general_i_8c32gb256ssd_v2", + "description": "Intel, 8 vCPU, 32 GB RAM, 256 GB Storage." + }, + { + "name": "general_i_8c32gb512ssd_v2", + "value": "general_i_8c32gb512ssd_v2", + "description": "Intel, 8 vCPU, 32 GB RAM, 512 GB Storage." + }, + { + "name": "general_i_8c32gb1024ssd_v2", + "value": "general_i_8c32gb1024ssd_v2", + "description": "Intel, 8 vCPU, 32 GB RAM, 1024 GB Storage." + }, + { + "name": "general_i_8c32gb2048ssd_v2", + "value": "general_i_8c32gb2048ssd_v2", + "description": "Intel, 8 vCPU, 32 GB RAM, 2048 GB Storage." + }, + { + "name": "general_i_16c64gb256ssd_v2", + "value": "general_i_16c64gb256ssd_v2", + "description": "Intel, 16 vCPU, 64 GB RAM, 256 GB Storage." + }, + { + "name": "general_i_16c64gb512ssd_v2", + "value": "general_i_16c64gb512ssd_v2", + "description": "Intel, 16 vCPU, 64 GB RAM, 512 GB Storage." + }, + { + "name": "general_i_16c64gb1024ssd_v2", + "value": "general_i_16c64gb1024ssd_v2", + "description": "Intel, 16 vCPU, 64 GB RAM, 1024 GB Storage." + }, + { + "name": "general_i_16c64gb2048ssd_v2", + "value": "general_i_16c64gb2048ssd_v2", + "description": "Intel, 16 vCPU, 64 GB RAM, 2048 GB Storage." + }, + { + "name": "general_i_32c128gb512ssd_v2", + "value": "general_i_32c128gb512ssd_v2", + "description": "Intel, 32 vCPU, 128 GB RAM, 512 GB Storage." + }, + { + "name": "general_i_32c128gb1024ssd_v2", + "value": "general_i_32c128gb1024ssd_v2", + "description": "Intel, 32 vCPU, 128 GB RAM, 1024 GB Storage." + }, + { + "name": "general_i_32c128gb2048ssd_v2", + "value": "general_i_32c128gb2048ssd_v2", + "description": "Intel, 32 vCPU, 128 GB RAM, 2048 GB Storage." + }, + { + "name": "general_a_8c32gb256ssd_v2", + "value": "general_a_8c32gb256ssd_v2", + "description": "AMD, 8 vCPU, 32 GB RAM, 256 GB Storage." + }, + { + "name": "general_a_8c32gb512ssd_v2", + "value": "general_a_8c32gb512ssd_v2", + "description": "AMD, 8 vCPU, 32 GB RAM, 512 GB Storage." + }, + { + "name": "general_a_8c32gb1024ssd_v2", + "value": "general_a_8c32gb1024ssd_v2", + "description": "AMD, 8 vCPU, 32 GB RAM, 1024 GB Storage." + }, + { + "name": "general_a_8c32gb2048ssd_v2", + "value": "general_a_8c32gb2048ssd_v2", + "description": "AMD, 8 vCPU, 32 GB RAM, 2048 GB Storage." + }, + { + "name": "general_a_16c64gb256ssd_v2", + "value": "general_a_16c64gb256ssd_v2", + "description": "AMD, 16 vCPU, 64 GB RAM, 256 GB Storage." + }, + { + "name": "general_a_16c64gb512ssd_v2", + "value": "general_a_16c64gb512ssd_v2", + "description": "AMD, 16 vCPU, 64 GB RAM, 512 GB Storage." + }, + { + "name": "general_a_16c64gb1024ssd_v2", + "value": "general_a_16c64gb1024ssd_v2", + "description": "AMD, 16 vCPU, 64 GB RAM, 1024 GB Storage." + }, + { + "name": "general_a_16c64gb2048ssd_v2", + "value": "general_a_16c64gb2048ssd_v2", + "description": "AMD, 16 vCPU, 64 GB RAM, 2048 GB Storage." + }, + { + "name": "general_a_32c128gb512ssd_v2", + "value": "general_a_32c128gb512ssd_v2", + "description": "AMD, 32 vCPU, 128 GB RAM, 512 GB Storage." + }, + { + "name": "general_a_32c128gb1024ssd_v2", + "value": "general_a_32c128gb1024ssd_v2", + "description": "AMD, 32 vCPU, 128 GB RAM, 1024 GB Storage." + }, + { + "name": "general_a_32c128gb2048ssd_v2", + "value": "general_a_32c128gb2048ssd_v2", + "description": "AMD, 32 vCPU, 128 GB RAM, 2048 GB Storage." + } + ] + } + }, + "SnapshotType": { + "type": "string", + "description": "The type of snapshot.", + "enum": [ + "Manual", + "Automatic" + ], + "x-ms-enum": { + "name": "SnapshotType", + "modelAsString": true, + "values": [ + { + "name": "Manual", + "value": "Manual", + "description": "The snapshot type indicates that this is a manually taken snapshot." + }, + { + "name": "Automatic", + "value": "Automatic", + "description": "The snapshot type indicates that this is an automatically taken snapshot." + } + ] + } + }, + "StopOnDisconnectConfiguration": { + "type": "object", + "description": "Stop on disconnect configuration settings for Dev Boxes created in this pool.", + "properties": { + "status": { + "$ref": "#/definitions/StopOnDisconnectEnableStatus", + "description": "Indicates whether the feature to stop the devbox on disconnect once the grace\nperiod has lapsed is enabled." + }, + "gracePeriodMinutes": { + "type": "integer", + "format": "int32", + "description": "The specified time in minutes to wait before stopping a Dev Box once disconnect\nis detected." + } + }, + "required": [ + "status" + ] + }, + "StopOnDisconnectEnableStatus": { + "type": "string", + "description": "Indicates whether the feature to stop the devbox on disconnect once the grace period has lapsed is enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "StopOnDisconnectEnableStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Stop on disconnect is enabled on the Dev Box." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Stop on disconnect is not enabled on the Dev Box." + } + ] + } + }, + "StopOnNoConnectConfiguration": { + "type": "object", + "description": "Stop on no connect configuration settings for Dev Boxes created in this pool.", + "properties": { + "status": { + "$ref": "#/definitions/StopOnNoConnectEnableStatus", + "description": "Enables the feature to stop a started Dev Box when it has not been connected to, once the grace period has lapsed." + }, + "gracePeriodMinutes": { + "type": "integer", + "format": "int32", + "description": "The specified time in minutes to wait before stopping a Dev Box if no connection is made. This will only be present if stop on no connect is enabled." + } + }, + "required": [ + "status" + ] + }, + "StopOnNoConnectEnableStatus": { + "type": "string", + "description": "Stop on no connect enable or disable status.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "StopOnNoConnectEnableStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Stop on no connect is enabled on the Dev Box." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Stop on no connect is not enabled on the Dev Box." + } + ] + } + }, + "StorageProfile": { + "type": "object", + "description": "Storage settings for the Dev Box's disks.", + "properties": { + "osDisk": { + "$ref": "#/definitions/OsDisk", + "description": "Settings for the operating system disk." + } + } + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + }, + "DelayUntilQueryParameter": { + "name": "until", + "in": "query", + "description": "The time to delay the Dev Box action or actions until, in RFC3339 format.", + "required": true, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method", + "x-ms-client-name": "delayUntil" + }, + "DevBoxNameParameter": { + "name": "devBoxName", + "in": "path", + "description": "The name of a Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "x-ms-parameter-location": "method" + }, + "EnvironmentNameParameter": { + "name": "environmentName", + "in": "path", + "description": "The name of the environment.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "x-ms-parameter-location": "method" + }, + "ForceDeleteEnvironmentQueryParameter": { + "name": "force", + "in": "query", + "description": "The query option to force environment deletion even if the environment definition does not exist. This is a best-effort delete, and anything custom that forces resource creation beyond the associated resource group may not be deleted.", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "HibernateQueryParameter": { + "name": "hibernate", + "in": "query", + "description": "Optional parameter to hibernate the dev box.", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "ProjectNameParameter": { + "name": "projectName", + "in": "path", + "description": "The DevCenter Project upon which to execute operations.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "x-ms-parameter-location": "method" + }, + "SnapshotIdQueryParameter": { + "name": "snapshotId", + "in": "query", + "description": "Required parameter that specifies the snapshot id to use for the restore operation.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "UserIdParameter": { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CaptureSnapshotDevBox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CaptureSnapshotDevBox.json new file mode 100644 index 000000000000..1306f8183682 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CaptureSnapshotDevBox.json @@ -0,0 +1,25 @@ +{ + "title": "Attempts to capture the manual snapshot for the Dev Box.", + "operationId": "DevBoxes_CaptureSnapshotDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CreateCustomizationGroup.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CreateCustomizationGroup.json new file mode 100644 index 000000000000..0ce11d294f54 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CreateCustomizationGroup.json @@ -0,0 +1,57 @@ +{ + "title": "Applies customizations to the Dev Box.", + "operationId": "DevBoxes_CreateCustomizationGroup", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "customizationGroupName": "Provisioning", + "body": { + "tasks": [ + { + "name": "catalogName/choco", + "displayName": "Install VS Code", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + } + }, + { + "name": "catalogName/write-to-file", + "runAs": "User" + } + ] + } + }, + "responses": { + "200": { + "body": { + "name": "Provisioning", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning", + "tasks": [ + { + "id": "a9202018-fb6a-4007-8b52-26d7c6d1c1fb", + "name": "catalogName/choco", + "displayName": "Install VS Code", + "status": "NotStarted", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + }, + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/a9202018-fb6a-4007-8b52-26d7c6d1c1fb" + }, + { + "id": "91835dc0-ef5a-4f58-9e3a-099aea8481f4", + "name": "catalogName/write-to-file", + "runAs": "User", + "status": "NotStarted", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/91835dc0-ef5a-4f58-9e3a-099aea8481f4" + } + ], + "status": "NotStarted" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CreateDevBox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CreateDevBox.json new file mode 100644 index 000000000000..3b2a85f411d0 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CreateDevBox.json @@ -0,0 +1,74 @@ +{ + "title": "Creates or replaces a Dev Box.", + "operationId": "DevBoxes_CreateDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "body": { + "poolName": "LargeDevWorkStationPool" + } + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + }, + "201": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Creating", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DelayAction.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DelayAction.json new file mode 100644 index 000000000000..83f344d66d86 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DelayAction.json @@ -0,0 +1,29 @@ +{ + "title": "Delays the occurrence of an action.", + "operationId": "DevBoxes_DelayAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "actionName": "schedule-default", + "until": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "actionType": "Stop", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", + "suspendedUntil": "2022-09-30T17:00:00Z", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DelayActions.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DelayActions.json new file mode 100644 index 000000000000..89db45645b88 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DelayActions.json @@ -0,0 +1,51 @@ +{ + "title": "Delays all actions.", + "operationId": "DevBoxes_DelayActions", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "until": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "result": "Succeeded", + "action": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", + "suspendedUntil": "2022-09-30T17:00:00Z", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "result": "Succeeded", + "action": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool", + "sourceType": "Pool", + "suspendedUntil": "2022-09-30T17:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DeleteDevBox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DeleteDevBox.json new file mode 100644 index 000000000000..f4a9c9cf9b65 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DeleteDevBox.json @@ -0,0 +1,26 @@ +{ + "title": "Deletes a Dev Box.", + "operationId": "DevBoxes_DeleteDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetAction.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetAction.json new file mode 100644 index 000000000000..2d62c465e19d --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetAction.json @@ -0,0 +1,27 @@ +{ + "title": "Gets an action.", + "operationId": "DevBoxes_GetAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "actionName": "schedule-default" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationGroup.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationGroup.json new file mode 100644 index 000000000000..df202ebc899f --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationGroup.json @@ -0,0 +1,44 @@ +{ + "title": "Gets a customization group.", + "operationId": "DevBoxes_GetCustomizationGroup", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "customizationGroupName": "Provisioning" + }, + "responses": { + "200": { + "body": { + "name": "Provisioning", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning", + "tasks": [ + { + "id": "a9202018-fb6a-4007-8b52-26d7c6d1c1fb", + "name": "catalogName/choco", + "displayName": "Install VS Code", + "status": "Succeeded", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + }, + "startTime": "2021-08-05T18:00:00.000Z", + "endTime": "2021-08-05T18:00:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/a9202018-fb6a-4007-8b52-26d7c6d1c1fb" + }, + { + "id": "91835dc0-ef5a-4f58-9e3a-099aea8481f4", + "name": "catalogName/write-to-file", + "status": "Running", + "startTime": "2021-08-05T18:00:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/91835dc0-ef5a-4f58-9e3a-099aea8481f4" + } + ], + "status": "Running", + "startTime": "2021-08-05T18:00:00.000Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationTaskDefinitions.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationTaskDefinitions.json new file mode 100644 index 000000000000..9922353497d3 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationTaskDefinitions.json @@ -0,0 +1,36 @@ +{ + "title": "Gets a customization task.", + "operationId": "DevBoxes_GetCustomizationTaskDefinitions", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "api-version": "2024-10-01-preview", + "catalogName": "myCatalog", + "taskName": "choco" + }, + "responses": { + "200": { + "body": { + "name": "myCatalog/choco", + "catalogName": "myCatalog", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/customizationtasks/choco", + "description": "Install a package via chocolatey", + "parameters": { + "package": { + "description": "The package to install", + "type": "string", + "required": true + }, + "version": { + "description": "The version of the package", + "type": "string", + "default": "latest" + }, + "retryOnFail": { + "type": "boolean" + } + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationTaskLog.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationTaskLog.json new file mode 100644 index 000000000000..a23db3682380 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationTaskLog.json @@ -0,0 +1,18 @@ +{ + "title": "Gets the log for a customization task.", + "operationId": "DevBoxes_GetCustomizationTaskLog", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "4863c6d0-e979-4a36-ac8d-80029debfd80", + "devBoxName": "MyDevBox", + "customizationGroupName": "Provisioning", + "customizationTaskId": "91835dc0-ef5a-4f58-9e3a-099aea8481f4" + }, + "responses": { + "200": { + "body": "WzIwMjMtMDgtMTBUMTA6MTk6NTUuODIwMTAxKzAwOjAwXSBDaG9jb2xhdGV5IHYxLjMuMVxuWzIwMjMtMDgtMTBUMTA6MTk6NTUuOTEzMjk3KzAwOjAwXSAyIHZhbGlkYXRpb25zIHBlcmZvcm1lZC4gMSBzdWNjZXNzKGVzKSwgMSB3YXJuaW5nKHMpLCBhbmQgMCBlcnJvcihzKS4=" + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetDevBoxByUser.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetDevBoxByUser.json new file mode 100644 index 000000000000..4f37e7673039 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetDevBoxByUser.json @@ -0,0 +1,41 @@ +{ + "title": "Gets a Dev Box.", + "operationId": "DevBoxes_GetDevBoxByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastConnectedTime": "2022-04-01T00:13:23.323Z", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetImagingTaskLog.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetImagingTaskLog.json new file mode 100644 index 000000000000..cc7fabcf2337 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetImagingTaskLog.json @@ -0,0 +1,15 @@ +{ + "title": "Gets the log for an imaging build task.", + "operationId": "DevBoxes_GetImagingTaskLog", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "imageBuildLogId": "91835dc0-ef5a-4f58-9e3a-099aea8481f4" + }, + "responses": { + "200": { + "body": "WzIwMjMtMDgtMTBUMTA6MTk6NTUuODIwMTAxKzAwOjAwXSBDaG9jb2xhdGV5IHYxLjMuMVxuWzIwMjMtMDgtMTBUMTA6MTk6NTUuOTEzMjk3KzAwOjAwXSAyIHZhbGlkYXRpb25zIHBlcmZvcm1lZC4gMSBzdWNjZXNzKGVzKSwgMSB3YXJuaW5nKHMpLCBhbmQgMCBlcnJvcihzKS4=" + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetOperation.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetOperation.json new file mode 100644 index 000000000000..a7f76d9d7c13 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetOperation.json @@ -0,0 +1,25 @@ +{ + "title": "Gets an operation on a Dev Box.", + "operationId": "DevBoxes_GetOperation", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/devBoxes/myDevBox/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Start", + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetPool.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetPool.json new file mode 100644 index 000000000000..06b37d499a33 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetPool.json @@ -0,0 +1,45 @@ +{ + "title": "Gets a pool.", + "operationId": "DevBoxes_GetPool", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "api-version": "2024-10-01-preview", + "poolName": "DevPool" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/LargeDevWorkStationPool", + "name": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + }, + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "healthStatus": "Healthy", + "displayName": "LargePool" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetRemoteConnection.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetRemoteConnection.json new file mode 100644 index 000000000000..8f8f9dc03d70 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetRemoteConnection.json @@ -0,0 +1,18 @@ +{ + "title": "Gets RDP Connection info.", + "operationId": "DevBoxes_GetRemoteConnection", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "200": { + "body": { + "webUrl": "https://connectionUrl" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetScheduleByPool.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetScheduleByPool.json new file mode 100644 index 000000000000..a0ed28a46bbc --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetScheduleByPool.json @@ -0,0 +1,25 @@ +{ + "title": "Gets a schedule.", + "operationId": "DevBoxes_GetScheduleByPool", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "api-version": "2024-10-01-preview", + "poolName": "DevPool", + "scheduleName": "default" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", + "name": "default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool", + "sourceType": "Pool", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetSnapshot.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetSnapshot.json new file mode 100644 index 000000000000..f62c94303145 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetSnapshot.json @@ -0,0 +1,21 @@ +{ + "title": "Gets a snapshot by snapshot id.", + "operationId": "DevBoxes_GetSnapshot", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6797" + }, + "responses": { + "200": { + "body": { + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6797", + "createdTime": "2022-09-30T15:23:00Z", + "snapshotType": "Automatic" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListActions.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListActions.json new file mode 100644 index 000000000000..c73522362510 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListActions.json @@ -0,0 +1,42 @@ +{ + "title": "Lists actions on a Dev Box.", + "operationId": "DevBoxes_ListActions", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool", + "sourceType": "Pool", + "next": { + "scheduledTime": "2022-09-30T15:23:00Z" + } + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", + "suspendedUntil": "2022-09-30T17:00:00Z", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListAllDevBoxes.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListAllDevBoxes.json new file mode 100644 index 000000000000..d191b87a886b --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListAllDevBoxes.json @@ -0,0 +1,42 @@ +{ + "title": "Lists Dev Boxes that the caller has access to in the DevCenter.", + "operationId": "DevBoxes_ListAllDevBoxes", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastConnectedTime": "2022-04-01T00:13:23.323Z", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListAllDevBoxesByUser.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListAllDevBoxesByUser.json new file mode 100644 index 000000000000..f76e593664da --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListAllDevBoxesByUser.json @@ -0,0 +1,44 @@ +{ + "title": "Lists Dev Boxes in the project for a particular user.", + "operationId": "DevBoxes_ListAllDevBoxesByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastConnectedTime": "2022-04-01T00:13:23.323Z", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListCustomizationGroups.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListCustomizationGroups.json new file mode 100644 index 000000000000..25efb85d3eed --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListCustomizationGroups.json @@ -0,0 +1,68 @@ +{ + "title": "Lists customization groups on the Dev Box. Listed customization groups exclude task information unless specified via the include parameter.", + "operationId": "DevBoxes_ListCustomizationGroups", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "include": "tasks" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Provisioning", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning", + "tasks": [ + { + "id": "a9202018-fb6a-4007-8b52-26d7c6d1c1fb", + "name": "catalogName/choco", + "displayName": "Install VS Code", + "status": "Succeeded", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + }, + "startTime": "2021-08-05T18:00:00.000Z", + "endTime": "2021-08-05T18:00:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/a9202018-fb6a-4007-8b52-26d7c6d1c1fb" + }, + { + "id": "91835dc0-ef5a-4f58-9e3a-099aea8481f4", + "name": "catalogName/write-to-file", + "status": "Succeeded", + "startTime": "2021-08-05T18:10:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/91835dc0-ef5a-4f58-9e3a-099aea8481f4" + } + ], + "status": "Succeeded", + "startTime": "2021-08-05T18:00:00.000Z", + "endTime": "2021-08-05T18:10:00.000Z" + }, + { + "name": "Personalizations", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Personalizations", + "tasks": [ + { + "id": "d8ec7648-23c9-4e86-8883-6d42ad6c9609", + "name": "catalogName/choco", + "displayName": "Install Git", + "status": "Running", + "parameters": { + "packageName": "git" + }, + "startTime": "2021-08-05T18:10:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Personalizations/logs/d8ec7648-23c9-4e86-8883-6d42ad6c9609" + } + ], + "status": "Running", + "startTime": "2021-08-05T18:10:00.000Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListCustomizationTaskDefinitionsByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListCustomizationTaskDefinitionsByProject.json new file mode 100644 index 000000000000..6886b08fd453 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListCustomizationTaskDefinitionsByProject.json @@ -0,0 +1,53 @@ +{ + "title": "Lists all customization tasks available to the project.", + "operationId": "DevBoxes_ListCustomizationTaskDefinitionsByProject", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myCatalog/choco", + "catalogName": "myCatalog", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/customizationtasks/choco", + "description": "Install a package via chocolatey", + "parameters": { + "package": { + "description": "The package to install", + "type": "string", + "required": true + }, + "version": { + "description": "The version of the package", + "type": "string", + "default": "latest" + }, + "retryOnFail": { + "type": "boolean" + } + } + }, + { + "name": "myCatalog/powershell", + "catalogName": "myCatalog", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/customizationtasks/powershell", + "description": "Runs an arbitrary Powershell command", + "parameters": { + "command": { + "type": "string", + "required": true + }, + "runAsAdmin": { + "type": "boolean" + } + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListDevBoxesByUser.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListDevBoxesByUser.json new file mode 100644 index 000000000000..ee0a1c013dcd --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListDevBoxesByUser.json @@ -0,0 +1,44 @@ +{ + "title": "Lists Dev Boxes in the project for a particular user.", + "operationId": "DevBoxes_ListDevBoxesByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastConnectedTime": "2022-04-01T00:13:23.323Z", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListOperations.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListOperations.json new file mode 100644 index 000000000000..fa770194c6af --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListOperations.json @@ -0,0 +1,42 @@ +{ + "title": "Lists operations on the Dev Box which have occurred within the past 90 days.", + "operationId": "DevBoxes_ListOperations", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/devBoxes/myDevBox/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Start", + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/devBoxes/myDevBox/operations/a6eb12ee-daa1-2215-9c44-63618dc2a781", + "operationId": "a6eb12ee-daa1-2215-9c44-63618dc2a781", + "status": "Succeeded", + "kind": "Repair", + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-10T19:31:20.7229492+00:00", + "endTime": "2022-09-10T19:57:41.7229492+00:00", + "result": { + "code": "ConnectivityFixApplied", + "message": "We resolved some connectivity issues with your Dev Box.", + "repairOutcome": "FixApplied" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListPools.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListPools.json new file mode 100644 index 000000000000..065f2392a615 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListPools.json @@ -0,0 +1,79 @@ +{ + "title": "Lists available pools.", + "operationId": "DevBoxes_ListPools", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/LargeDevWorkStationPool", + "name": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + }, + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "healthStatus": "Healthy", + "displayName": "LargePool" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/SQLDevelopmentMachinePool", + "name": "SQLDevelopmentMachinePool", + "location": "southcentralus", + "osType": "Windows", + "hardwareProfile": { + "vCPUs": 16, + "memoryGB": 128 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "SqlDevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + }, + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "healthStatus": "Healthy", + "displayName": "SQLPool" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSchedulesByPool.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSchedulesByPool.json new file mode 100644 index 000000000000..3139ab52c06a --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSchedulesByPool.json @@ -0,0 +1,28 @@ +{ + "title": "Lists all schedules within a pool that are configured by your project administrator.", + "operationId": "DevBoxes_ListSchedulesByPool", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "poolName": "DevPool", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", + "name": "default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool", + "sourceType": "Pool", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSchedulesByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSchedulesByProject.json new file mode 100644 index 000000000000..920494b62d99 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSchedulesByProject.json @@ -0,0 +1,27 @@ +{ + "title": "Lists all schedules within a project that are configured by your project administrator.", + "operationId": "DevBoxes_ListSchedulesByProject", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", + "name": "default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool", + "sourceType": "Pool", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSnapshots.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSnapshots.json new file mode 100644 index 000000000000..6cb959b2204e --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSnapshots.json @@ -0,0 +1,30 @@ +{ + "title": "Lists snapshots for this Dev Box.", + "operationId": "DevBoxes_ListSnapshots", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6797", + "createdTime": "2022-09-30T15:23:00Z", + "snapshotType": "Automatic" + }, + { + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6798", + "createdTime": "2022-09-30T15:23:00Z", + "expirationTime": "2024-10-30T15:23:00Z", + "snapshotType": "Manual" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RepairDevBox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RepairDevBox.json new file mode 100644 index 000000000000..ab297ebe0667 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RepairDevBox.json @@ -0,0 +1,25 @@ +{ + "title": "Attempts automated repair steps to resolve common problems on a Dev Box. The Dev Box may restart during this operation.", + "operationId": "DevBoxes_RepairDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestartDevBox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestartDevBox.json new file mode 100644 index 000000000000..acef706175e1 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestartDevBox.json @@ -0,0 +1,25 @@ +{ + "title": "Restarts a Dev Box.", + "operationId": "DevBoxes_RestartDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestoreSnapshotDevBox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestoreSnapshotDevBox.json new file mode 100644 index 000000000000..891948c547a0 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestoreSnapshotDevBox.json @@ -0,0 +1,26 @@ +{ + "title": "Attempts to restore the Dev Box to a selected snapshot.", + "operationId": "DevBoxes_RestoreSnapshotDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6797" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_SkipAction.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_SkipAction.json new file mode 100644 index 000000000000..bc83aa55f3c1 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_SkipAction.json @@ -0,0 +1,15 @@ +{ + "title": "Skips an occurrence of an action.", + "operationId": "DevBoxes_SkipAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "actionName": "schedule-default" + }, + "responses": { + "204": {} + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_StartDevBox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_StartDevBox.json new file mode 100644 index 000000000000..5c34fc1c57c2 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_StartDevBox.json @@ -0,0 +1,25 @@ +{ + "title": "Starts a Dev Box.", + "operationId": "DevBoxes_StartDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_StopDevBox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_StopDevBox.json new file mode 100644 index 000000000000..99dd05cc7c03 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_StopDevBox.json @@ -0,0 +1,26 @@ +{ + "title": "Stops a Dev Box.", + "operationId": "DevBoxes_StopDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "hibernate": "true" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ValidateCustomizationTasksAction.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ValidateCustomizationTasksAction.json new file mode 100644 index 000000000000..7fa247cff7a6 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ValidateCustomizationTasksAction.json @@ -0,0 +1,40 @@ +{ + "title": "Validates a list of customization tasks.", + "operationId": "DevBoxes_ValidateCustomizationTasksAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "body": { + "tasks": [ + { + "name": "catalogName/choco", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + } + }, + { + "name": "catalogName/write-to-disk" + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Succeeded", + "startTime": "2023-02-01T12:43:54.122Z", + "result": { + "validationResult": "Succeeded" + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_GetProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_GetProject.json new file mode 100644 index 000000000000..44331c0613ab --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_GetProject.json @@ -0,0 +1,19 @@ +{ + "title": "Gets a project.", + "operationId": "DevCenter_GetProject", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/DevDiv", + "name": "DevDiv", + "description": "The developer division", + "displayName": "DeveloperDivision" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_GetProjectAbilities.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_GetProjectAbilities.json new file mode 100644 index 000000000000..1dd761dc9891 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_GetProjectAbilities.json @@ -0,0 +1,37 @@ +{ + "title": "Gets the signed-in user's permitted abilities in a project.", + "operationId": "DevCenter_GetProjectAbilities", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "abilitiesAsAdmin": [ + "ReadDevBoxes", + "ReadEnvironments" + ], + "abilitiesAsDeveloper": [ + "CustomizeDevBoxes", + "DeleteDevBoxes", + "DeleteEnvironments", + "ManageDevBoxActions", + "ManageEnvironmentActions", + "ReadDevBoxActions", + "ReadDevBoxes", + "ReadEnvironmentActions", + "ReadEnvironmentOutputs", + "ReadEnvironments", + "ReadRemoteConnections", + "StartDevBoxes", + "StopDevBoxes", + "WriteDevBoxes", + "WriteEnvironments" + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_ListProjects.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_ListProjects.json new file mode 100644 index 000000000000..a7d9e2e31725 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_ListProjects.json @@ -0,0 +1,22 @@ +{ + "title": "Lists all projects in a Dev Center.", + "operationId": "DevCenter_ListProjects", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject", + "name": "DevDiv", + "description": "The developer division", + "displayName": "DeveloperDivision" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_CreateOrReplaceEnvironment.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_CreateOrReplaceEnvironment.json new file mode 100644 index 000000000000..c31a9c1565a5 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_CreateOrReplaceEnvironment.json @@ -0,0 +1,43 @@ +{ + "title": "Creates or updates an environment.", + "operationId": "Environments_CreateOrReplaceEnvironment", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "environmentName": "mydevenv", + "userId": "me", + "body": { + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "expirationDate": "2023-09-10T17:00:00Z" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Creating", + "expirationDate": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_DelayAction.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_DelayAction.json new file mode 100644 index 000000000000..fedd0acb2c35 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_DelayAction.json @@ -0,0 +1,27 @@ +{ + "title": "Delays the occurrence of an action.", + "operationId": "Environments_DelayAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnv", + "actionName": "default", + "until": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/default", + "name": "default", + "actionType": "Delete", + "next": { + "scheduledTime": "2023-09-30T17:00:00Z" + }, + "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastModifiedAt": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_DeleteEnvironment.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_DeleteEnvironment.json new file mode 100644 index 000000000000..b12474e9fe84 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_DeleteEnvironment.json @@ -0,0 +1,26 @@ +{ + "title": "Deletes an environment and all its associated resources.", + "operationId": "Environments_DeleteEnvironment", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ForceDeleteEnvironment.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ForceDeleteEnvironment.json new file mode 100644 index 000000000000..3305cb49fb0b --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ForceDeleteEnvironment.json @@ -0,0 +1,27 @@ +{ + "title": "Deletes an environment and its resource group without the environment definition.", + "operationId": "Environments_DeleteEnvironment", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv", + "force": "true" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetAction.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetAction.json new file mode 100644 index 000000000000..8c5dcee14079 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetAction.json @@ -0,0 +1,26 @@ +{ + "title": "Retrieve a specific environment action.", + "operationId": "Environments_GetAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment", + "actionName": "default" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/default", + "name": "default", + "actionType": "Delete", + "next": { + "scheduledTime": "2023-09-30T17:00:00Z" + }, + "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastModifiedAt": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetCatalog.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetCatalog.json new file mode 100644 index 000000000000..d0296c59168f --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetCatalog.json @@ -0,0 +1,18 @@ +{ + "title": "Gets the specified catalog within the project.", + "operationId": "Environments_GetCatalog", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "catalogName": "foo" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/foo", + "name": "foo" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentByUser.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentByUser.json new file mode 100644 index 000000000000..fc09eaf09dec --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentByUser.json @@ -0,0 +1,30 @@ +{ + "title": "Gets an environment.", + "operationId": "Environments_GetEnvironmentByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg028321", + "expirationDate": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentDefinition.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentDefinition.json new file mode 100644 index 000000000000..6a2a39903855 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentDefinition.json @@ -0,0 +1,58 @@ +{ + "title": "Get an environment definition from a catalog.", + "operationId": "Environments_GetEnvironmentDefinition", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "catalogName": "myCatalog", + "definitionName": "foo" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "name": "foo", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true, + "default": "dotnet", + "allowed": [ + "node", + "dotnet", + "java" + ] + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true, + "default": "Standard_LRS", + "allowed": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS" + ] + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "default": "true", + "readOnly": true, + "required": true + } + ], + "parametersSchema": "{\"type\":\"object\",\"properties\":{\"functionAppRuntime\":{\"$id\":\"functionAppRuntime\",\"value\":\"dotnet\",\"displayName\":\"Function App Runtime\",\"type\":\"string\",\"enum\":[\"node\",\"dotnet\",\"java\"]},\"storageAccountType\":{\"$id\":\"storageAccountType\",\"value\":\"Standard_LRS\",\"displayName\":\"Storage Account Type\",\"type\":\"string\",\"enum\":[\"Standard_LRS\",\"Standard_GRS\",\"Standard_RAGRS\"]},\"httpsOnly\":{\"$id\":\"httpsOnly\",\"value\":true,\"displayName\":\"HTTPS only\",\"type\":\"boolean\"}},\"required\":[\"functionAppRuntime\",\"storageAccountType\"]}", + "templatePath": "azuredeploy.json" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentTypeAbilities.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentTypeAbilities.json new file mode 100644 index 000000000000..15bd60987c65 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentTypeAbilities.json @@ -0,0 +1,28 @@ +{ + "title": "Gets the signed-in user's permitted abilities in an environment type.", + "operationId": "Environments_GetEnvironmentTypeAbilities", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "environmentTypeName": "devtestenv", + "userId": "me", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "abilitiesAsAdmin": [ + "ReadEnvironments" + ], + "abilitiesAsDeveloper": [ + "DeleteEnvironments", + "ManageEnvironmentActions", + "ReadEnvironmentActions", + "ReadEnvironmentOutputs", + "ReadEnvironments", + "WriteEnvironments" + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentTypes.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentTypes.json new file mode 100644 index 000000000000..d41c0d94320e --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentTypes.json @@ -0,0 +1,21 @@ +{ + "title": "Get an environment type configured for a project.", + "operationId": "Environments_GetEnvironmentTypes", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "environmentTypeName": "devtestenv", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/environmentTypes/devtestenv", + "name": "devtestenv", + "status": "Enabled", + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "displayName": "DevTestEnvironment" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetLogsByOperation.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetLogsByOperation.json new file mode 100644 index 000000000000..5fb52d5225a3 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetLogsByOperation.json @@ -0,0 +1,17 @@ +{ + "title": "Gets the logs for an operation on an environment.", + "operationId": "Environments_GetLogsByOperation", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" + }, + "responses": { + "200": { + "body": "{file}" + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetOperation.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetOperation.json new file mode 100644 index 000000000000..6e4d5ac213af --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetOperation.json @@ -0,0 +1,29 @@ +{ + "title": "Gets an environment action result.", + "operationId": "Environments_GetOperation", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/myEnvironment/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Deploy", + "environmentParameters": { + "paramA": "valueA", + "paramB": "valueB" + }, + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetOutputs.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetOutputs.json new file mode 100644 index 000000000000..20f9755f7101 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetOutputs.json @@ -0,0 +1,51 @@ +{ + "title": "Gets Outputs from the environment.", + "operationId": "Environments_GetOutputs", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv" + }, + "responses": { + "200": { + "body": { + "outputs": { + "stringOutput": { + "type": "string", + "value": "Output1 value", + "sensitive": false + }, + "arrayOutput": { + "type": "array", + "value": [ + 1, + 2, + 3 + ], + "sensitive": false + }, + "boolOutput": { + "type": "bool", + "value": true, + "sensitive": false + }, + "intOutput": { + "type": "int", + "value": 1, + "sensitive": false + }, + "objectOutput": { + "type": "object", + "value": { + "name": "name", + "id": "id" + }, + "sensitive": false + } + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListActions.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListActions.json new file mode 100644 index 000000000000..fec2e7db31bb --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListActions.json @@ -0,0 +1,39 @@ +{ + "title": "Get all scheduled actions for a user within an environment.", + "operationId": "Environments_ListActions", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/default", + "name": "default", + "actionType": "Delete", + "next": { + "scheduledTime": "2023-09-30T17:00:00Z" + }, + "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastModifiedAt": "2023-09-10T17:00:00Z" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/expire", + "name": "expire", + "actionType": "Delete", + "next": { + "scheduledTime": "2023-10-30T17:00:00Z" + }, + "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastModifiedAt": "2023-09-20T17:00:00Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListCatalogsByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListCatalogsByProject.json new file mode 100644 index 000000000000..d9fbc4eee5d0 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListCatalogsByProject.json @@ -0,0 +1,21 @@ +{ + "title": "Lists all of the catalogs available for a project.", + "operationId": "Environments_ListCatalogsByProject", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/foo", + "name": "foo" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentDefinitionsByCatalog.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentDefinitionsByCatalog.json new file mode 100644 index 000000000000..72928b19772c --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentDefinitionsByCatalog.json @@ -0,0 +1,69 @@ +{ + "title": "Lists all environment definitions available within a catalog.", + "operationId": "Environments_ListEnvironmentDefinitionsByCatalog", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "catalogName": "myCatalog" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "name": "foo", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true, + "default": "dotnet", + "allowed": [ + "node", + "dotnet", + "java" + ] + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true, + "default": "Standard_LRS", + "allowed": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS" + ] + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "default": "true", + "readOnly": true, + "required": true + } + ], + "parametersSchema": "{\"type\":\"object\",\"properties\":{\"functionAppRuntime\":{\"$id\":\"functionAppRuntime\",\"value\":\"dotnet\",\"displayName\":\"Function App Runtime\",\"type\":\"string\",\"enum\":[\"node\",\"dotnet\",\"java\"]},\"storageAccountType\":{\"$id\":\"storageAccountType\",\"value\":\"Standard_LRS\",\"displayName\":\"Storage Account Type\",\"type\":\"string\",\"enum\":[\"Standard_LRS\",\"Standard_GRS\",\"Standard_RAGRS\"]},\"httpsOnly\":{\"$id\":\"httpsOnly\",\"value\":true,\"displayName\":\"HTTPS only\",\"type\":\"boolean\"}},\"required\":[\"functionAppRuntime\",\"storageAccountType\"]}", + "templatePath": "azuredeploy.json" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/bar", + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/bar", + "name": "bar", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "templatePath": "azuredeploy.json" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentDefinitionsByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentDefinitionsByProject.json new file mode 100644 index 000000000000..3055da215535 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentDefinitionsByProject.json @@ -0,0 +1,68 @@ +{ + "title": "Lists all environment definitions available for a project.", + "operationId": "Environments_ListEnvironmentDefinitionsByProject", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "name": "foo", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true, + "default": "dotnet", + "allowed": [ + "node", + "dotnet", + "java" + ] + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true, + "default": "Standard_LRS", + "allowed": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS" + ] + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "default": "true", + "readOnly": true, + "required": true + } + ], + "parametersSchema": "{\"type\":\"object\",\"properties\":{\"functionAppRuntime\":{\"$id\":\"functionAppRuntime\",\"value\":\"dotnet\",\"displayName\":\"Function App Runtime\",\"type\":\"string\",\"enum\":[\"node\",\"dotnet\",\"java\"]},\"storageAccountType\":{\"$id\":\"storageAccountType\",\"value\":\"Standard_LRS\",\"displayName\":\"Storage Account Type\",\"type\":\"string\",\"enum\":[\"Standard_LRS\",\"Standard_GRS\",\"Standard_RAGRS\"]},\"httpsOnly\":{\"$id\":\"httpsOnly\",\"value\":true,\"displayName\":\"HTTPS only\",\"type\":\"boolean\"}},\"required\":[\"functionAppRuntime\",\"storageAccountType\"]}", + "templatePath": "azuredeploy.json" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/bar", + "id": "/projects/myProject/catalogs/myOtherCatalog/environmentDefinitions/bar", + "name": "bar", + "catalogName": "myOtherCatalog", + "description": "This environment definition is just for example purposes.", + "templatePath": "azuredeploy.json" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentTypes.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentTypes.json new file mode 100644 index 000000000000..62e267038a17 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentTypes.json @@ -0,0 +1,24 @@ +{ + "title": "Lists all environment types configured for a project.", + "operationId": "Environments_ListEnvironmentTypes", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/environmentTypes/devtestenv", + "name": "devtestenv", + "status": "Enabled", + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "displayName": "DevTestEnvironment" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironments.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironments.json new file mode 100644 index 000000000000..037ce43b0111 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironments.json @@ -0,0 +1,32 @@ +{ + "title": "Lists all environment definitions available for a project.", + "operationId": "Environments_ListEnvironments", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg028321", + "expirationDate": "2023-09-10T17:00:00Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentsByUser.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentsByUser.json new file mode 100644 index 000000000000..a31423259000 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentsByUser.json @@ -0,0 +1,33 @@ +{ + "title": "Lists the environments for a project and user.", + "operationId": "Environments_ListEnvironmentsByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg028321", + "expirationDate": "2023-09-10T17:00:00Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListOperations.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListOperations.json new file mode 100644 index 000000000000..8386bc5476ab --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListOperations.json @@ -0,0 +1,32 @@ +{ + "title": "Lists operations on the environment which have occurred within the past 90 days.", + "operationId": "Environments_ListOperations", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/myEnvironment/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Deploy", + "environmentParameters": { + "paramA": "valueA", + "paramB": "valueB" + }, + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_PatchEnvironment.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_PatchEnvironment.json new file mode 100644 index 000000000000..c31b552d4813 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_PatchEnvironment.json @@ -0,0 +1,32 @@ +{ + "title": "Partially updates an environment.", + "operationId": "Environments_PatchEnvironment", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "environmentName": "mydevenv", + "userId": "me", + "body": { + "expirationDate": "2023-09-10T17:00:00Z" + } + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "expirationDate": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_SkipAction.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_SkipAction.json new file mode 100644 index 000000000000..d620617d53de --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_SkipAction.json @@ -0,0 +1,21 @@ +{ + "title": "Skips an occurrence of an action.", + "operationId": "Environments_SkipAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "environmentName": "myEnv", + "userId": "me", + "actionName": "default", + "body": { + "actionType": "Delete", + "next": { + "scheduledTime": "2023-09-30T17:00:00Z" + } + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/OperationStatuses_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/OperationStatuses_Get.json new file mode 100644 index 000000000000..c1d48444d062 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/OperationStatuses_Get.json @@ -0,0 +1,19 @@ +{ + "title": "Get the status of an operation.", + "operationId": "OperationStatuses_Get", + "parameters": { + "api-version": "2024-10-01-preview", + "projectName": "myProject", + "operationId": "fa067167-e49d-41bd-8dd8-de719b9de3b3" + }, + "responses": { + "200": { + "body": { + "id": "/projects/myProject/operationStatuses/fa067167-e49d-41bd-8dd8-de719b9de3b3", + "name": "fa067167-e49d-41bd-8dd8-de719b9de3b3", + "status": "Running", + "startTime": "2024-01-24T21:14:58.472Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/readme.md b/specification/devcenter/data-plane/readme.md index 4adfb0eb98b6..d1cdb23e358a 100644 --- a/specification/devcenter/data-plane/readme.md +++ b/specification/devcenter/data-plane/readme.md @@ -27,7 +27,22 @@ These are the global settings for the devcenter. ``` yaml openapi-type: data-plane azure-arm: false -tag: package-2024-09-01-preview +tag: package-2024-10-01-preview +``` + +### Tag: package-2024-10-01-preview + +These settings apply only when `--tag=package-2024-10-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2024-10-01-preview' +input-file: + - Microsoft.DevCenter/preview/2024-10-01-preview/devcenter.json + +directive: + - suppress: HostParametersValidation + reason: Requires URL format for endpoint params, which violates R2003 and causes problems with codegen. + - suppress: OperationIdNounVerb + reason: DevBoxes and Environments are operations with multiple models. ``` ### Tag: package-2024-09-01-preview From 4ff23edc72f9a49139d1e71698dd5b1ec4d5f9d2 Mon Sep 17 00:00:00 2001 From: reutgross <104348031+reutgross@users.noreply.github.com> Date: Tue, 1 Oct 2024 20:32:45 +0300 Subject: [PATCH 21/47] [Health Insights] New preview version 2024-08-01-preview (#30675) * add new version --- .../model.oncophenotype.tsp | 87 - .../route.oncophenotype.tsp | 36 - .../SuccessfulRadiologyInsightsRequest.json | 134 + .../SuccessfulRadiologyInsightsResponse.json | 33454 ++++++++++++++++ .../SuccessfulTrialMatcherRequest.json | 3009 ++ .../SuccessfulTrialMatcherResponse.json | 116 + .../HealthInsights.OpenAPI/main.tsp | 4 +- .../HealthInsights.OpenAPI/service.tsp | 3 + .../model.patienttimeline.tsp | 73 - .../route.patienttimeline.tsp | 36 - .../model.trialmatcher.tsp | 18 +- .../route.trialmatcher.tsp | 16 +- .../SuccessfulRadiologyInsightsRequest.json | 134 + .../SuccessfulRadiologyInsightsResponse.json | 33454 ++++++++++++++++ .../SuccessfulTrialMatcherRequest.json | 3009 ++ .../SuccessfulTrialMatcherResponse.json | 116 + .../preview/2024-08-01-preview/openapi.json | 4082 ++ .../ai/data-plane/HealthInsights/readme.md | 19 +- 18 files changed, 77548 insertions(+), 252 deletions(-) delete mode 100644 specification/ai/HealthInsights/HealthInsights.OncoPhenotype/model.oncophenotype.tsp delete mode 100644 specification/ai/HealthInsights/HealthInsights.OncoPhenotype/route.oncophenotype.tsp create mode 100644 specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulRadiologyInsightsRequest.json create mode 100644 specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulRadiologyInsightsResponse.json create mode 100644 specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulTrialMatcherRequest.json create mode 100644 specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulTrialMatcherResponse.json delete mode 100644 specification/ai/HealthInsights/HealthInsights.PatientTimeline/model.patienttimeline.tsp delete mode 100644 specification/ai/HealthInsights/HealthInsights.PatientTimeline/route.patienttimeline.tsp create mode 100644 specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulRadiologyInsightsRequest.json create mode 100644 specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulRadiologyInsightsResponse.json create mode 100644 specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulTrialMatcherRequest.json create mode 100644 specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulTrialMatcherResponse.json create mode 100644 specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/openapi.json diff --git a/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/model.oncophenotype.tsp b/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/model.oncophenotype.tsp deleted file mode 100644 index 4523bb0b3283..000000000000 --- a/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/model.oncophenotype.tsp +++ /dev/null @@ -1,87 +0,0 @@ -import "../HealthInsights.Common/model.common.request.tsp"; -import "../HealthInsights.Common/model.common.response.tsp"; -import "../HealthInsights.Common/model.common.shared.tsp"; -import "../HealthInsights.Common/model.common.fhir.elements.tsp"; - -using TypeSpec.Rest; - -namespace AzureHealthInsights; - -@doc("The body of the Onco Phenotype request.") -model OncoPhenotypeData { - ...Request; - - @doc("Configuration affecting the Onco Phenotype model's inference.") - configuration?: OncoPhenotypeModelConfiguration; -} - -@doc("The response for the Onco Phenotype request.") -@resource("onco-phenotype/jobs") -model OncoPhenotypeResult - is HealthInsightsOperationStatus<OncoPhenotypeInferenceResult>; - -@doc("The inference results for the Onco Phenotype request.") -model OncoPhenotypeInferenceResult { - @doc("Results for the patients given in the request.") - patientResults: OncoPhenotypePatientResult[]; - - @doc("The version of the model used for inference, expressed as the model date.") - modelVersion: ModelVersion; -} - -@doc("The results of the model's work for a single patient.") -model OncoPhenotypePatientResult { - @doc("The identifier given for the patient in the request.") - patientId: string; - - @doc("The model's inferences for the given patient.") - inferences: Array<OncoPhenotypeInference>; -} - -@doc("An inference made by the Onco Phenotype model regarding a patient.") -model OncoPhenotypeInference { - @doc("The type of the Onco Phenotype inference") - type: OncoPhenotypeInferenceType; - - ...Inference; - - @doc("The evidence corresponding to the inference value.") - evidence?: InferenceEvidence[]; - - @doc(""" - An identifier for a clinical case, if there are multiple clinical cases regarding the same patient. - """) - caseId?: string; -} - -@doc("Configuration affecting the Onco Phenotype model's inference.") -model OncoPhenotypeModelConfiguration { - ...ModelConfiguration; - - @doc(""" - A list of inference types to be inferred for the current request. - This could be used if only part of the Onco Phenotype inferences are required. - If this list is omitted or empty, the model will return all the inference types. - """) - inferenceTypes?: OncoPhenotypeInferenceType[]; - - @doc(""" - An indication whether to perform a preliminary step on the patient's documents to determine whether they relate to a Cancer case. - """) - checkForCancerCase?: boolean = false; -} - -#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update" -@doc("The type of the Onco Phenotype inference.") -union OncoPhenotypeInferenceType { - string, - TumorSite: "tumorSite", - Histology: "histology", - ClinicalStageT: "clinicalStageT", - ClinicalStageN: "clinicalStageN", - ClinicalStageM: "clinicalStageM", - PathologicStageT: "pathologicStageT", - PathologicStageN: "pathologicStageN", - PathologicStageM: "pathologicStageM", - DiagnosisDate: "diagnosisDate", -} diff --git a/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/route.oncophenotype.tsp b/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/route.oncophenotype.tsp deleted file mode 100644 index 3bcfdf2454b3..000000000000 --- a/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/route.oncophenotype.tsp +++ /dev/null @@ -1,36 +0,0 @@ -import "@azure-tools/typespec-azure-core"; -import "@typespec/rest"; -import "@typespec/http"; - -import "./model.oncophenotype.tsp"; -import "../HealthInsights.Common/primitives.tsp"; - -using Azure.Core; -using TypeSpec.Rest; -using TypeSpec.Http; - -namespace AzureHealthInsights; - -@TypeSpec.Versioning.removed(AzureHealthInsights.ApiVersion.v2024_04_01) -interface OncoPhenotype { - #suppress "@azure-tools/typespec-azure-core/no-rpc-path-params" "Service uses a jobId in the path" - @summary("Get Onco Phenotype job details") - @tag("OncoPhenotype") - @doc("Gets the status and details of the Onco Phenotype job.") - @get - @route("/onco-phenotype/jobs/{id}") - getJob is HealthInsightsLongRunningPollOperation<BodyParameter<OncoPhenotypeResult>>; - - #suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" "Polling through operation-location" - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "There is no long-running RPC template in Azure.Core" - @summary("Create Onco Phenotype job") - @tag("OncoPhenotype") - @doc("Creates an Onco Phenotype job with the given request body.") - @pollingOperation(OncoPhenotype.getJob) - @route("/onco-phenotype/jobs") - createJob is HealthInsightsLongRunningRpcOperation< - OncoPhenotypeData, - OncoPhenotypeResult, - OncoPhenotypeInferenceResult - >; -} diff --git a/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulRadiologyInsightsRequest.json b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulRadiologyInsightsRequest.json new file mode 100644 index 000000000000..0217e4d6a9ab --- /dev/null +++ b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulRadiologyInsightsRequest.json @@ -0,0 +1,134 @@ +{ + "operationId": "RadiologyInsights_CreateJob", + "title": "Creates a Radiology Insights job with the given request body.", + "parameters": { + "endpoint": "{endpoint}/health-insights/radiology-insights/jobs/{id}?api-version={api-version}", + "api-version": "2024-08-01-preview", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12", + "resource": { + "jobData": { + "configuration": { + "inferenceOptions": { + "followupRecommendationOptions": { + "includeRecommendationsWithNoSpecifiedModality": false, + "includeRecommendationsInReferences": false, + "provideFocusedSentenceEvidence": false + }, + "findingOptions": { + "provideFocusedSentenceEvidence": false + } + }, + "inferenceTypes": [ + "finding", + "ageMismatch", + "lateralityDiscrepancy", + "sexMismatch", + "completeOrderDiscrepancy", + "limitedOrderDiscrepancy", + "criticalResult", + "criticalRecommendation", + "followupRecommendation", + "followupCommunication", + "radiologyProcedure" + ], + "locale": "en-US", + "verbose": false, + "includeEvidence": true + }, + "patients": [ + { + "id": "sample id 1", + "details": { + "sex": "male", + "clinicalInfo": [ + { + "resourceType": "Observation", + "status": "unknown", + "code": { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0018802", + "display": "MalignantNeoplasms" + } + ] + }, + "valueBoolean": "true" + } + ] + }, + "encounters": [ + { + "id": "encounterid1", + "period": { + "start": "2023-12-21T00:00:00", + "end": "2023-12-21T00:00:00" + }, + "class": "inpatient" + } + ], + "patientDocuments": [ + { + "type": "note", + "clinicalType": "radiologyReport", + "id": "docid1", + "language": "en", + "authors": [ + { + "id": "authorid1", + "fullName": "authorname1" + } + ], + "specialtyType": "radiology", + "createdAt": "2023-12-21T00:00:00", + "administrativeMetadata": { + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "system": "Http://hl7.org/fhir/ValueSet/cpt-all", + "code": "111111", + "display": "CT ABD/PELVIS" + } + ] + }, + "description": "CT ABD/PELVIS" + } + ], + "encounterId": "encounterid1" + }, + "content": { + "sourceType": "inline", + "value": "[**2143-4-13**] 5:04 PM\r\nCT ABD W&W/O C; CT CHEST W&W/O C Clip # [**Clip Number (Radiology) 38350**]\r\nCT PELVIS W&W/O C\r\nReason: ? PE, evidence of pneumonia\r\nAdmitting Diagnosis: SEPSIS\r\nField of view: 38 Contrast: OPTIRAY Amt: 130\r\n______________________________________________________________________________\r\n[**Hospital 4**] MEDICAL CONDITION:\r\n52 year old man with urosepsis, s/p nephrostogram on [**4-12**], today with acute\r\nSOB, fever, rigors.\r\nREASON FOR THIS EXAMINATION:\r\n? PE, evidence of pneumonia\r\nNo contraindications for IV contrast\r\n______________________________________________________________________________\r\nFINAL REPORT\r\nINDICATION: History of urosepsis status post nephrostogram on [**4-12**], today\r\nwith acute shortness of breath, fevers, and rigors. Also reported hematocrit\r\ndrop. Evaluate for pulmonary embolism or hematoma.\r\nCOMPARISON: Non-contrast CT of the abdomen and pelvis dated [**2143-4-11**].\r\nTECHNIQUE: MDCT acquired images of the chest, abdomen, and pelvis were\r\nobtained before and after the administration of IV contrast. A true CT\r\nangiogram could not be performed due to lack of appropriate intravenous\r\naccess.\r\nCT OF THE CHEST WITHOUT AND WITH IV CONTRAST: Evaluation of the pulmonary\r\narteries is limited with no large central pulmonary embolism seen. Evaluation\r\nof the segmental and subsegmental branches is limited. There is a central\r\nvenous catheter that terminates in the right atrium. There are numerous small\r\nmesenteric and axillary lymph nodes that do not meet CT criteria for\r\npathologic enlargement. There are coronary artery calcifications. There are\r\nbilateral small layering pleural effusions with associated compressive\r\natelectasis. The images of the lungs are limited due to motion. There\r\nappears to be a patchy, predominantly ground-glass opacity in both lower\r\nlobes, left worse than right. The aorta appears intact. There is debris in\r\nthe trachea.\r\nCT OF THE ABDOMEN WITHOUT AND WITH IV CONTRAST: There is high-density\r\nmaterial tracking along the course of a dilated left ureter consistent with\r\nhemorrhage that is new compared to the previous study. New stranding in the\r\nleft retroperitoneum is also present consistent with retroperitoneal\r\nhemorrhage. Perinephric stranding is present, as was seen on the previous\r\nstudy. The degree of dilatation of the left ureter is unchanged. Several\r\nfoci of air outside of the collecting system are present, presumably\r\npostprocedural in nature. Contrast-enhanced images show abnormal perfusion of\r\nthe left kidney with a striated appearance, most severe at the upper pole with\r\nperipheral wedge-shaped hypoenhancing areas also present on top of the areas\r\nof reduced perfusion. No active extravasation of contrast is seen. The right\r\nkidney is normal. The liver, spleen, and adrenal glands are unremarkable.\r\nPancreas is unremarkable with slightly prominent distal common bile duct\r\nmeasuring up to 8-9 mm. There is a small cystic lesion measuring 5 mm at the\r\nhead of the pancreas (series 10, image 143). Small and large bowel are\r\n(Over)\r\n[**2143-4-13**] 5:04 PM\r\nCT ABD W&W/O C; CT CHEST W&W/O C Clip # [**Clip Number (Radiology) 38350**]\r\nCT PELVIS W&W/O C\r\nReason: ? PE, evidence of pneumonia\r\nAdmitting Diagnosis: SEPSIS\r\nField of view: 38 Contrast: OPTIRAY Amt: 130\r\n______________________________________________________________________________\r\nFINAL REPORT\r\n(Cont)\r\ngrossly unremarkable. The aorta, celiac artery, superior mesenteric artery,\r\ninferior mesenteric artery, and renal arteries appear patent.\r\nCT OF THE PELVIS WITHOUT AND WITH IV CONTRAST: The prostate gland is\r\nenlarged. Thickening of the bladder wall is again demonstrated. Several foci\r\nof air within the bladder are presumably secondary to the Foley catheter. The\r\nrectum and sigmoid colon are unremarkable.\r\nBONE WINDOWS: There are degenerative changes with no suspicious lytic or\r\nsclerotic lesions.\r\nIMPRESSION:\r\n1. New high-density material surrounding the left ureter and tracking within\r\nthe retroperitoneum consistent with hemorrhage.\r\n2. Abnormal perfusion of the left kidney, most severe at the upper pole.\r\nFindings are consistent with pyelonephritis. Edema and abnormal perfusion at\r\nthe upper pole and interpolar region medially with multiple peripheral\r\nhypoenhancing wedge- shaped regions likely represent ischemia and a component\r\nof infarction.\r\n3. Limited examination for pulmonary embolism due to suboptimal contrast\r\nbolus with no large central embolus seen. Evaluation of distal segmental and\r\nsubsegmental branches is limited.\r\n4. Small bilateral layering pleural effusions with associated compressive\r\natelectasis. Patchy predominantly ground-glass opacities in both lower lobes,\r\nleft worse than right could represent pneumonia or pneumonitis.\r\n5. 5mm cystic lesion in the head of the pancreas. Recommend 1 year follow up.\r\nThe above was discussed with Dr. [**First Name8 (NamePattern2) 951**] [**Last Name (NamePattern1) 1238**] at approximately 6:30 p.m. on\r\n[**2143-4-13**].\r\n" + } + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "c7e9a8d7-6b5f-4e3d-9a2c-1f8b0e2c3f4a", + "Operation-Location": "{endpoint}/health-insights/radiology-insights/jobs/{id}?api-version=2024-04-01" + }, + "body": { + "status": "notStarted", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12" + } + }, + "201": { + "headers": { + "x-ms-request-id": "c7e9a8d7-6b5f-4e3d-9a2c-1f8b0e2c3f4a", + "Operation-Location": "{endpoint}/health-insights/radiology-insights/jobs/{id}?api-version=2024-04-01" + }, + "body": { + "status": "notStarted", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12" + } + } + } +} diff --git a/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulRadiologyInsightsResponse.json b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulRadiologyInsightsResponse.json new file mode 100644 index 000000000000..abbdff32da9a --- /dev/null +++ b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulRadiologyInsightsResponse.json @@ -0,0 +1,33454 @@ +{ + "operationId": "RadiologyInsights_GetJob", + "title": "Gets the status and details of the Radiology Insights job.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-08-01-preview", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "c7e9a8d7-6b5f-4e3d-9a2c-1f8b0e2c3f4a" + }, + "body": { + "result": { + "patientResults": [ + { + "patientId": "sample id 1", + "inferences": [ + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6839", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246501002", + "display": "TECHNIQUE (ATTRIBUTE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4466 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4508 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6840", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246501002", + "display": "TECHNIQUE (ATTRIBUTE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4572 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4586 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4621 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4633 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6856", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for encounter" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6857", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 178 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 178 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 178 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for encounter" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6858", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 210 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 210 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91302008", + "display": "SEPSIS (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 210 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "46241-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "HOSPITAL ADMISSION DIAGNOSIS - REPORTED" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6859", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 402 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 402 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64572001", + "display": "DISEASE (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 457 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246452003", + "display": "CHRONICITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "255363002", + "display": "SUDDEN (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 402 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 457 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "11329-0" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "History" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6860", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for exam" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6861", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 533 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 533 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 533 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for exam" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6862", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 700 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 700 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64572001", + "display": "DISEASE (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 700 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6863", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 867 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 867 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 867 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6864", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 879 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 879 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "35566002", + "display": "HEMATOMA (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 879 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6865", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1325 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1325 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "81040000", + "display": "PULMONARY ARTERY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID974", + "display": "PULMONARY ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28586", + "display": "SET OF PULMONARY ARTERIES" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1301 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1307 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "large;;central" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1301 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1307 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1325 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6866", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1691 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1691 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "41699000", + "display": "EFFUSION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "3120008", + "display": "PLEURAL MEMBRANE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1362", + "display": "PLEURA" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1658 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1658 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "51440002", + "display": "RIGHT AND LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "135650694", + "display": "CAUSES OF HARM (QUALIFIER VALUE)" + } + ] + }, + "valueString": "compressive;;atelectasis" + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1668 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "27123005", + "display": "BILIARY SLUDGE (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1658 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1668 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1691 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6867", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46621007", + "display": "ATELECTASIS (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "71173004", + "display": "COMPRESSION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "3120008", + "display": "PLEURAL MEMBRANE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1362", + "display": "PLEURA" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6868", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + }, + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + }, + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "36692007", + "display": "KNOWN (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2117 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2117 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2117 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6869", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6870", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for encounter" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6871", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3293 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3293 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3293 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for encounter" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6872", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3325 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3325 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91302008", + "display": "SEPSIS (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3325 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "46241-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "HOSPITAL ADMISSION DIAGNOSIS - REPORTED" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6874", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4237 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4237 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "23583003", + "display": "INFLAMMATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4237 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6875", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4412 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4412 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "52674009", + "display": "ISCHEMIA (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4324 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4412 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6876", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4441 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4441 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55641003", + "display": "INFARCT (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4324 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4441 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6877", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4492 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4492 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4529 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "135650694", + "display": "CAUSES OF HARM (QUALIFIER VALUE)" + } + ] + }, + "valueString": "bolus" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4492 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4529 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6878", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4680 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4663 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4680 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "41699000", + "display": "EFFUSION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "3120008", + "display": "PLEURAL MEMBRANE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1362", + "display": "PLEURA" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4653 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4653 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "51440002", + "display": "RIGHT AND LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "135650694", + "display": "CAUSES OF HARM (QUALIFIER VALUE)" + } + ] + }, + "valueString": "compressive;;atelectasis" + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4647 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4663 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "27123005", + "display": "BILIARY SLUDGE (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4647 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4653 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4663 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4680 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6879", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46621007", + "display": "ATELECTASIS (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "71173004", + "display": "COMPRESSION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "3120008", + "display": "PLEURAL MEMBRANE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1362", + "display": "PLEURA" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6882", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 464 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 464 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "390870001", + "display": "SHORT OF BREATH DRESSING/UNDRESSING (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 464 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "11329-0" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "History" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6883", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 469 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 469 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "386661006", + "display": "FEVER (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 469 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "11329-0" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "History" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6884", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "43724002", + "display": "CHILL (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "16046003", + "display": "MUSCLE RIGIDITY (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "11329-0" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "History" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6885", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 779 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 782 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 779 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 782 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "390870001", + "display": "SHORT OF BREATH DRESSING/UNDRESSING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 779 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 782 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64572001", + "display": "DISEASE (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246452003", + "display": "CHRONICITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "255363002", + "display": "SUDDEN (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 779 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 782 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6886", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 790 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 790 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "386661006", + "display": "FEVER (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246452003", + "display": "CHRONICITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "255363002", + "display": "SUDDEN (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 790 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6887", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "43724002", + "display": "CHILL (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "16046003", + "display": "MUSCLE RIGIDITY (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246452003", + "display": "CHRONICITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "255363002", + "display": "SUDDEN (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6889", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1630 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1630 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "18115005", + "display": "PATHOLOGIC CALCIFICATION, CALCIFIED STRUCTURE (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "41801008", + "display": "CORONARY ARTERY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28727", + "display": "SET OF CORONARY ARTERIES" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID35862", + "display": "CORONARY ARTERY" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1630 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6890", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1841 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1854 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1841 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1854 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "128305008", + "display": "ABNORMALLY OPAQUE STRUCTURE (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1865 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1865 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "51440002", + "display": "RIGHT AND LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1819 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "patchy" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1819 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1841 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1854 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1865 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6891", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1943 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1943 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "257159000", + "display": "DEBRIS (SUBSTANCE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "955009", + "display": "BRONCHIAL STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1247", + "display": "TRACHEA" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1943 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6892", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2026 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2040 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2026 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "127558001", + "display": "DENSITY FINDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2026 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2040 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6893", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2080 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2080 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "25322007", + "display": "DILATATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2080 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6894", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7147002", + "display": "NEW (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2177 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2177 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "118247008", + "display": "RADIOLOGIC FINDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2177 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6895", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2290 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2290 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "118247008", + "display": "RADIOLOGIC FINDING (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2278 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2290 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6896", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "36692007", + "display": "KNOWN (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2363 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2363 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "25322007", + "display": "DILATATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2396 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "288533004", + "display": "CHANGE VALUES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "58158008", + "display": "STABLE (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2363 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2396 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6897", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2417 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2422 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2425 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2425 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15158005", + "display": "AIR (SUBSTANCE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID223", + "display": "RENAL COLLECTING SYSTEM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2429 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "outside" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2417 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2422 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2425 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2429 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6898", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID29663", + "display": "LEFT KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2616 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "272141005", + "display": "SEVERITIES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24484000", + "display": "SEVERE (SEVERITY MODIFIER) (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2647 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2658 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "peripheral;;wedge-shaped" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2616 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2630 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2636 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2647 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2658 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2671 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2675 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2685 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6899", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2736 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2728 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260400001", + "display": "REDUCED (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2728 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "reduced" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2728 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2736 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6900", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2758 + }, + { + "url": "length", + "valueInteger": 13 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2772 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2775 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2758 + }, + { + "url": "length", + "valueInteger": 13 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "76676007", + "display": "EXTRAVASATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2751 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "active" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2751 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2758 + }, + { + "url": "length", + "valueInteger": 13 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2772 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2775 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6901", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2997 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2997 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "367643001", + "display": "CYST (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2997 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "52988006", + "display": "LESION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15776009", + "display": "PANCREATIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID171", + "display": "HEAD OF PANCREAS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2991 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "small" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3021 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3023 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://radlex.org", + "code": "246115007", + "display": "SIZE (ATTRIBUTE)" + } + ] + }, + "valueQuantity": { + "value": 5.0, + "unit": "MILLIMETER" + }, + "interpretation": [ + { + "coding": [ + { + "code": "15240007", + "display": "CURRENT" + } + ] + } + ] + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2991 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2997 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3021 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3023 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6902", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3704 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3715 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3718 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3704 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "89977008", + "display": "INCREASED THICKNESS (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "89837001", + "display": "URINARY BLADDER STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30135", + "display": "WALL OF URINARY BLADDER" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3704 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3715 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3718 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6903", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3776 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3776 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15158005", + "display": "AIR (SUBSTANCE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "89837001", + "display": "URINARY BLADDER STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID237", + "display": "URINARY BLADDER" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3776 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6904", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3922 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3935 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3922 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3935 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362975008", + "display": "DEGENERATIVE DISORDER (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "272673000", + "display": "BONE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28569", + "display": "SET OF BONE ORGANS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13197", + "display": "BONE ORGAN" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3922 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3935 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6905", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3972 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3982 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3972 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "43846000", + "display": "SCLEROSIS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3972 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3982 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3982 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "52988006", + "display": "LESION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "272673000", + "display": "BONE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28569", + "display": "SET OF BONE ORGANS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13197", + "display": "BONE ORGAN" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3951 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3962 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "suspicious;;lytic" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3951 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3962 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3972 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3982 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6907", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4254 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4254 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "267038008", + "display": "EDEMA (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45851105", + "display": "REGION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45851105", + "display": "REGION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4254 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4317 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4324 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6908", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4347 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "peripheral" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4324 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4347 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4359 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4363 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4373 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4378 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4380 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4387 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6909", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4557 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4557 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4543 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4549 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "large;;central" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4543 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4549 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4557 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6910", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4753 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4766 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4753 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4766 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "128305008", + "display": "ABNORMALLY OPAQUE STRUCTURE (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4779 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4779 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "51440002", + "display": "RIGHT AND LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4732 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "Patchy" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4732 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4753 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4766 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4779 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6911", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4871 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4871 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "367643001", + "display": "CYST (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4871 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "52988006", + "display": "LESION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15776009", + "display": "PANCREATIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID171", + "display": "HEAD OF PANCREAS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4867 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4868 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://radlex.org", + "code": "246115007", + "display": "SIZE (ATTRIBUTE)" + } + ] + }, + "valueQuantity": { + "value": 5.0, + "unit": "MILLIMETER" + }, + "interpretation": [ + { + "coding": [ + { + "code": "15240007", + "display": "CURRENT" + } + ] + } + ] + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4867 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4868 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4871 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6912", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1787 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1787 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "164836004", + "display": "MUSCULOSKELETAL MOVEMENT (OBSERVABLE ENTITY)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1787 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6913", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID223", + "display": "RENAL COLLECTING SYSTEM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2487 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "postprocedural" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2487 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6914", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID29663", + "display": "LEFT KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2590 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2599 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6915", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2920 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2920 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "4657009", + "display": "PROMINENT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "28273000", + "display": "BILE DUCT STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID199", + "display": "COMMON BILE DUCT" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2911 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2920 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "4657009", + "display": "PROMINENT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2965 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2971 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2975 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://radlex.org", + "code": "246115007", + "display": "SIZE (ATTRIBUTE)" + } + ] + }, + "valueQuantity": { + "comparator": "<=" + }, + "interpretation": [ + { + "coding": [ + { + "code": "15240007", + "display": "CURRENT" + } + ] + } + ] + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2911 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2920 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2930 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2965 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2971 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2975 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6916", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3689 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3693 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260376009", + "display": "ENLARGED (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "41216001", + "display": "PROSTATIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID343", + "display": "PROSTATE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3693 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "288533004", + "display": "CHANGE VALUES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "35105006", + "display": "INCREASED (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3689 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3693 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6917", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3767 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3773 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3767 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3773 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "397685007", + "display": "FINDING RELATED TO FOCUSING (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3767 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3773 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6921", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "281157001", + "display": "SYSTEMIC VASCULAR STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID480", + "display": "AORTA" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6922", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID29662", + "display": "RIGHT KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6923", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "23451007", + "display": "ADRENAL STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "10200004", + "display": "LIVER STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "78961009", + "display": "SPLENIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28752", + "display": "SET OF ADRENAL GLANDS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID88", + "display": "ADRENAL GLAND" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID58", + "display": "LIVER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID86", + "display": "SPLEEN" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6924", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15776009", + "display": "PANCREATIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID170", + "display": "PANCREAS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6925", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "281471001", + "display": "STRUCTURE OF ABDOMINAL BLOOD VESSEL (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "244261004", + "display": "ABDOMINAL VISCERAL ARTERY (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "56400007", + "display": "STRUCTURE OF RENAL VEIN (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "281157001", + "display": "SYSTEMIC VASCULAR STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID906", + "display": "CELIAC ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3530 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3530 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID927", + "display": "SUPERIOR MESENTERIC ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3556 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3559 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3556 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3559 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID939", + "display": "INFERIOR MESENTERIC ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID936", + "display": "RENAL ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID49729", + "display": "SET OF RENAL ARTERIES" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID480", + "display": "AORTA" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID50393", + "display": "SET OF ABDOMINAL ARTERIES" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3530 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3556 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3559 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "final assessment" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6926", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "71854001", + "display": "COLON STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "34402009", + "display": "RECTUM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID162", + "display": "SIGMOID COLON" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID163", + "display": "RECTUM" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6930", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6933", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6936", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "36692007", + "display": "KNOWN (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "30746006", + "display": "LYMPHADENOPATHY (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15425007", + "display": "PERITONEUM (SEROUS MEMBRANE) STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID33180", + "display": "MESENTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "288533004", + "display": "CHANGE VALUES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "35105006", + "display": "INCREASED (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1502 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "small;;pathologic" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1502 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6938", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "36692007", + "display": "KNOWN (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "30746006", + "display": "LYMPHADENOPATHY (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "47109002", + "display": "STRUCTURE OF LYMPH NODE OF THORAX (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28849", + "display": "AXILLARY LYMPH NODE GROUP" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1517", + "display": "AXILLARY LYMPH NODE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "288533004", + "display": "CHANGE VALUES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "35105006", + "display": "INCREASED (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1502 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "small;;pathologic" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1502 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6940", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7147002", + "display": "NEW (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4026 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "127558001", + "display": "DENSITY FINDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4026 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6943", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7147002", + "display": "NEW (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4026 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "127558001", + "display": "DENSITY FINDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4026 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6946", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6948", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6950", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "23583003", + "display": "INFLAMMATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6952", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "23583003", + "display": "INFLAMMATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "followupCommunication", + "communicatedAt": [ + "2023-12-21T18:30:00" + ], + "recipient": [ + "doctor" + ], + "wasAcknowledged": true, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4957 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4972 + }, + { + "url": "length", + "valueInteger": 76 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 5066 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 5080 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ] + }, + { + "kind": "criticalResult", + "result": { + "description": "RETROPERITONEAL HEMORRHAGE", + "finding": { + "resourceType": "Observation", + "id": "6869", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + } + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ] + }, + { + "kind": "criticalResult", + "result": { + "description": "RETROPERITONEAL HEMORRHAGE", + "finding": { + "resourceType": "Observation", + "id": "6933", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + } + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ] + }, + { + "kind": "criticalResult", + "result": { + "description": "PNEUMONIA", + "finding": { + "resourceType": "Observation", + "id": "6948", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + } + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ] + }, + { + "procedureCodes": [ + { + "coding": [ + { + "system": "http://loinc.org", + "code": "44115-4", + "display": "CT ABDOMEN AND PELVIS" + } + ] + } + ], + "imagingProcedures": [ + { + "modality": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "77477000", + "display": "COMPUTERIZED AXIAL TOMOGRAPHY (PROCEDURE)" + } + ] + }, + "anatomy": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "113345001", + "display": "ABDOMINAL STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "modality": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "77477000", + "display": "COMPUTERIZED AXIAL TOMOGRAPHY (PROCEDURE)" + } + ] + }, + "anatomy": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "12921003", + "display": "PELVIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + } + ], + "orderedProcedure": { + "code": { + "coding": [ + { + "code": "111111" + } + ] + }, + "description": "CT ABD/PELVIS." + }, + "kind": "radiologyProcedure" + } + ] + } + ], + "modelVersion": "2024-01-19-preview" + }, + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12", + "createdAt": "2024-01-29T19:50:52Z", + "expiresAt": "2024-01-30T19:50:52Z", + "updatedAt": "2024-01-29T19:51:12Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulTrialMatcherRequest.json b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulTrialMatcherRequest.json new file mode 100644 index 000000000000..7dba7841e236 --- /dev/null +++ b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulTrialMatcherRequest.json @@ -0,0 +1,3009 @@ +{ + "operationId": "TrialMatcher_CreateJob", + "title": "Creates a Trial Matcher job with the given request body.", + "parameters": { + "endpoint": "{endpoint}/health-insights/trial-matcher/jobs/{id}?api-version={api-version}", + "api-version": "2024-08-01-preview", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d11", + "resource": { + "jobData": { + "patients": [ + { + "id": "Patient ID Example 2", + "details": { + "sex": "female", + "birthDate": "1976-09-10", + "clinicalInfo": [ + { + "resourceType": "Condition", + "code": { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0041296", + "display": "Tuberculosis" + } + ] + } + }, + { + "code": { + "coding": [ + { + "code": "C0006826", + "display": "MalignantNeoplasms", + "system": "http://www.nlm.nih.gov/research/umls" + } + ] + }, + "resourceType": "Observation", + "status": "unknown", + "valueBoolean": true + }, + { + "code": { + "coding": [ + { + "code": "C0018802", + "display": "MalignantNeoplasms", + "system": "http://www.nlm.nih.gov/research/umls" + } + ] + }, + "resourceType": "Observation", + "status": "unknown", + "valueBoolean": true + } + ] + } + } + ], + "configuration": { + "verbose": true, + "includeEvidence": true, + "clinicalTrials": { + "customTrials": [ + { + "resourceType": "ResearchStudy", + "contained": [ + { + "resourceType": "PlanDefinition", + "id": "1b5bc5d5-9413-43f7-9da6-70db2606b7cd", + "name": "Rilpivirine", + "title": "Rilpivirine", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Rilpivirine", + "description": "Patients will receive rilpivirine tablet 25 milligram or adjusted dose orally once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "30f45f8a-a0f5-4eed-a5e1-4819137c10b2", + "name": "Zidovudine", + "title": "Zidovudine", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Zidovudine", + "description": "Type=exact, form= appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "8958e19c-17db-4152-874d-cf68c3918769", + "name": "Abacavir", + "title": "Abacavir", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Abacavir", + "description": "Type=exact, form=appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "bef1c7b6-1e1a-4fb4-8bcd-b9d965dd09e6", + "name": "Tenofovir disoproxil fumarate", + "title": "Tenofovir disoproxil fumarate", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Tenofovir disoproxil fumarate", + "description": "Type=exact, form=appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "ec554338-0167-4034-98dd-ee1cd5860430", + "name": "Lamivudine", + "title": "Lamivudine", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Lamivudine", + "description": "Type=exact, form=appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "8ddc695e-efab-441e-bd49-c1decfdb80bf", + "name": "Emtricitabine", + "title": "Emtricitabine", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Emtricitabine", + "description": "Type=exact, form=appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "Group", + "id": "73e459c6-9b92-479d-b122-0712d18a9131", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "TreatmentName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0723712", + "display": "therapeutic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "220281", + "display": "therapeutic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000046327", + "display": "therapeutic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "7381", + "display": "therapeutic" + } + ], + "text": "therapeutic" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "47519-4", + "display": "History of Procedures" + } + ], + "text": "History of Procedures" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "TreatmentName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0086413", + "display": "HIV vaccine" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C1325", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "347399", + "display": "HIV vaccine" + }, + { + "system": "http://hl7.org/fhir/sid/cvx", + "code": "61", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hl7v2.5", + "code": "61", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hl7v3.0", + "code": "61", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D016915", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000015914", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "3059-5000", + "display": "HIV vaccine" + }, + { + "system": "http://loinc.org", + "code": "LP183501-8", + "display": "HIV vaccine" + } + ], + "text": "HIV vaccine" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "47519-4", + "display": "History of Procedures" + } + ], + "text": "History of Procedures" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "127161fc-b30f-4efc-ae14-2d064dc6084b", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#73e459c6-9b92-479d-b122-0712d18a9131", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationClass" + } + ], + "text": "HIV drug", + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "somecode", + "display": "somecode" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "c26ff014-3da3-419b-9338-6e4b4d49031e", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "one-or-more", + "display": "One Or More" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0132326", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D019829", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB00238", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000712787", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "99DK7FVK1H", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "99DK7FVK1H", + "display": "nevirapine" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4020991", + "display": "nevirapine" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C29277", + "display": "nevirapine" + }, + { + "system": "http://snomed.info/sctv", + "code": "108704001", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "75157", + "display": "nevirapine" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AG01", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "006062", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "eiK..", + "display": "nevirapine" + }, + { + "system": "http://loinc.org", + "code": "LP21317-0", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "175112", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh2010013984", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000016392", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "2030", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "4007-0088", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "53654", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m56485", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000656", + "display": "nevirapine" + } + ], + "text": "nevirapine" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0043474", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000040121", + "display": "zidovudine" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C947", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D015215", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "2109-4800", + "display": "zidovudine" + }, + { + "system": "http://snomed.info/sctv", + "code": "387151007", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "05223", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "41905", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB00495", + "display": "zidovudine" + }, + { + "system": "http://snomed.info/sct", + "code": "C-55B60", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "ei5..", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000013273", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000044478", + "display": "zidovudine" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4019502", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "11413", + "display": "zidovudine" + }, + { + "system": "http://loinc.org", + "code": "LP16744-2", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_dtp", + "code": "NSC0602670", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m89510", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "4B9XT59T7S", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "2650", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_ctrp", + "code": "C947", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "4B9XT59T7S", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "d00034", + "display": "zidovudine" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AF01", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000671", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "003019", + "display": "zidovudine" + } + ], + "text": "zidovudine" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "9ab418f5-9bf1-4bb7-a55f-0eed1244addb", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#c26ff014-3da3-419b-9338-6e4b4d49031e", + "type": "Group" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "SymptomOrSign" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0282474", + "display": "mother-to-child transmission" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D018445", + "display": "mother-to-child transmission" + } + ], + "text": "mother-to-child transmission" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "c31f130b-c0e7-411a-a32b-57f07ea62559", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#127161fc-b30f-4efc-ae14-2d064dc6084b", + "type": "Group" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#9ab418f5-9bf1-4bb7-a55f-0eed1244addb", + "type": "Group" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "1d943af4-3b3e-4363-9e82-bc0e59b8c3e1", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "one-or-more", + "display": "One Or More" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0132326", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D019829", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB00238", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000712787", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "99DK7FVK1H", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "99DK7FVK1H", + "display": "NVP" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4020991", + "display": "NVP" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C29277", + "display": "NVP" + }, + { + "system": "http://snomed.info/sctv", + "code": "108704001", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "75157", + "display": "NVP" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AG01", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "006062", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "eiK..", + "display": "NVP" + }, + { + "system": "http://loinc.org", + "code": "LP21317-0", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "175112", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh2010013984", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000016392", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "2030", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "4007-0088", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "53654", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m56485", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000656", + "display": "NVP" + } + ], + "text": "NVP" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0043474", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000040121", + "display": "AZT" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C947", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D015215", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "2109-4800", + "display": "AZT" + }, + { + "system": "http://snomed.info/sctv", + "code": "387151007", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "05223", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "41905", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB00495", + "display": "AZT" + }, + { + "system": "http://snomed.info/sct", + "code": "C-55B60", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "ei5..", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000013273", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000044478", + "display": "AZT" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4019502", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "11413", + "display": "AZT" + }, + { + "system": "http://loinc.org", + "code": "LP16744-2", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_dtp", + "code": "NSC0602670", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m89510", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "4B9XT59T7S", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "2650", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_ctrp", + "code": "C947", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "4B9XT59T7S", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "d00034", + "display": "AZT" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AF01", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000671", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "003019", + "display": "AZT" + } + ], + "text": "AZT" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "8eddc9da-cdfc-43d9-a9fc-5306d66362f3", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#1d943af4-3b3e-4363-9e82-bc0e59b8c3e1", + "type": "Group" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "SymptomOrSign" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0282474", + "display": "mother-to-child transmission" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D018445", + "display": "mother-to-child transmission" + } + ], + "text": "mother-to-child transmission" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "4ee79ae8-bf19-4474-a72e-3616ac0a9fdf", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationClass" + } + ], + "text": "ARVs" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#8eddc9da-cdfc-43d9-a9fc-5306d66362f3", + "type": "Group" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "583a9867-c95e-4225-bd19-47c324e26c0f", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "ExaminationName" + } + ], + "text": "Plasma viral load" + }, + "valueQuantity": { + "value": 100000, + "comparator": ">" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "35d36257-564c-48e0-9c65-b2551870b0bb", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0132326", + "display": "with NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D005838", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "20920", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000005452", + "display": "genotypic" + }, + { + "system": "http://loinc.org", + "code": "LP345004-8", + "display": "genotypic" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C16631", + "display": "genotypic" + }, + { + "system": "http://snomed.info/sctv", + "code": "145681002", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000660739", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000002877", + "display": "genotypic" + }, + { + "system": "http://snomed.info/sct", + "code": "F-E0280", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1258-5784", + "display": "genotypic" + } + ], + "text": "genotypic" + }, + "valueCodeableConcept": { + "text": "value:" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "SymptomOrSign" + } + ], + "text": "non-nucleoside reverse transcriptase inhibitor resistance" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "bdcbe31b-c0f7-4205-9b75-34a8418cfdb2", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "one-or-more", + "display": "One Or More" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "Diagnosis" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0041296", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medlineplus", + "code": "41", + "display": "tuberculosis" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C3423", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "31051", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000012630", + "display": "tuberculosis" + }, + { + "system": "http://snomed.info/sctv", + "code": "56717001", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "A1...", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D014376", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/cst", + "code": "INFECT", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000513048", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU076452", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10021870", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/who", + "code": "0923", + "display": "tuberculosis" + }, + { + "system": "http://snomed.info/sct", + "code": "DE-14800", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "A15-A19", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/bi", + "code": "BI00198", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/dxp", + "code": "U004166", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C3423", + "display": "tuberculosis" + }, + { + "system": "http://loinc.org", + "code": "LA10513-2", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh85138408", + "display": "tuberculosis" + }, + { + "system": "http://snomed.info/sct", + "code": "D-0188", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch", + "code": "U004809", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "A70012", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "A15-A19.9", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "A15-A19.9", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccs", + "code": "1", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccs_10", + "code": "1", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_cptac", + "code": "C3423", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "0368-2498", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000004838", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "010-018.99", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc2eeng", + "code": "A70", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "754", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1018255", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "54410", + "display": "tuberculosis" + } + ], + "text": "tuberculosis" + }, + "valueCodeableConcept": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "ConditionQualifier" + } + ], + "text": "active" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "TreatmentName" + } + ], + "text": "treated for tuberculosis" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "47519-4", + "display": "History of Procedures" + } + ], + "text": "History of Procedures" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "2a43edc4-0000-0000-0000-000000000000", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "Diagnosis" + } + ], + "text": "human immuno deficiency virus infection" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "ExaminationName" + } + ], + "text": "HIV-1 plasma viral load" + }, + "valueQuantity": { + "value": 500, + "unit": "HIV-1" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#c31f130b-c0e7-411a-a32b-57f07ea62559", + "type": "Group" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#4ee79ae8-bf19-4474-a72e-3616ac0a9fdf", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#583a9867-c95e-4225-bd19-47c324e26c0f", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#35d36257-564c-48e0-9c65-b2551870b0bb", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "TreatmentName" + } + ], + "text": "disallowed concomitant therapy" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "47519-4", + "display": "History of Procedures" + } + ], + "text": "History of Procedures" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "Diagnosis" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0001175", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "B20", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ram", + "code": "DX272", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/qmr", + "code": "R0121441", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "A788z", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://snomed.info/sctv", + "code": "186715004", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "1684", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000000649", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc", + "code": "B90", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10000563", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "31779", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "00595", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C2851", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D000163", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000023174", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C2851", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/cst", + "code": "HIV SYND", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "B90001", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc2eeng", + "code": "B90", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_cptac", + "code": "C2851", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medlineplus", + "code": "1", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/bi", + "code": "BI00716", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://snomed.info/sct", + "code": "DE-36310", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/who", + "code": "1233", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU080583", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000044365", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1560-6271", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "042", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "023", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://loinc.org", + "code": "LA10430-9", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1014998", + "display": "Acquired Immunodeficiency Syndrome" + } + ], + "text": "Acquired Immunodeficiency Syndrome" + }, + "valueCodeableConcept": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "ConditionQualifier" + } + ], + "text": "currently active" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#bdcbe31b-c0f7-4205-9b75-34a8418cfdb2", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "coding": [ + { + "system": "http://loinc.org", + "code": "63900-5", + "display": "age" + } + ], + "text": "age" + }, + "valueRange": { + "low": { + "value": 6, + "unit": "years", + "system": "http://unitsofmeasure.org", + "code": "a" + }, + "high": { + "value": 17, + "unit": "years", + "system": "http://unitsofmeasure.org", + "code": "a" + } + }, + "exclude": false + } + ] + } + ], + "identifier": [ + { + "use": "official", + "value": "CR002677", + "assigner": { + "display": "Janssen Sciences Ireland UC" + } + }, + { + "use": "usual", + "value": "NCTtesttest", + "assigner": { + "display": "ClinicalTrials.gov" + } + }, + { + "use": "secondary", + "value": "TMC278-TiDP38-C213" + }, + { + "use": "secondary", + "value": "2008-001696-30" + } + ], + "title": "A Study to Evaluate the Pharmacokinetics, Safety, Tolerability, and Antiviral Efficacy of Rilpivirine (TMC278) in Human Immunodeficiency Virus Infected Adolescents and Children Aged Greater Than or Equal to 6 Years", + "protocol": [ + { + "reference": "#1b5bc5d5-9413-43f7-9da6-70db2606b7cd", + "type": "PlanDefinition", + "display": "Rilpivirine" + }, + { + "reference": "#30f45f8a-a0f5-4eed-a5e1-4819137c10b2", + "type": "PlanDefinition", + "display": "Zidovudine" + }, + { + "reference": "#8958e19c-17db-4152-874d-cf68c3918769", + "type": "PlanDefinition", + "display": "Abacavir" + }, + { + "reference": "#bef1c7b6-1e1a-4fb4-8bcd-b9d965dd09e6", + "type": "PlanDefinition", + "display": "Tenofovir disoproxil fumarate" + }, + { + "reference": "#ec554338-0167-4034-98dd-ee1cd5860430", + "type": "PlanDefinition", + "display": "Lamivudine" + }, + { + "reference": "#8ddc695e-efab-441e-bd49-c1decfdb80bf", + "type": "PlanDefinition", + "display": "Emtricitabine" + } + ], + "status": "active", + "primaryPurposeType": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/research-study-prim-purp-type", + "version": "4.0.0", + "code": "treatment", + "display": "Treatment" + } + ], + "text": "Treatment" + }, + "phase": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/research-study-phase", + "version": "4.0.0", + "code": "phase-2", + "display": "Phase 2" + } + ], + "text": "Phase 2" + }, + "category": [ + { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/research-study-prim-purp-type", + "version": "4.0.0", + "code": "treatment", + "display": "Treatment" + } + ], + "text": "Treatment" + }, + { + "coding": [ + { + "system": "http://clinicaltrials.gov", + "code": "Interventional", + "display": "Interventional" + } + ], + "text": "Interventional" + }, + { + "coding": [ + { + "system": "http://clinicaltrials.gov", + "code": "Single Group Assignment", + "display": "Single Group Assignment" + } + ], + "text": "Single Group Assignment" + }, + { + "coding": [ + { + "system": "http://clinicaltrials.gov", + "code": "None (Open Label)", + "display": "None (Open Label)" + } + ], + "text": "None (Open Label)" + }, + { + "coding": [ + { + "system": "http://clinicaltrials.gov", + "code": "NoneRetained", + "display": "NoneRetained" + } + ], + "text": "NoneRetained" + } + ], + "focus": [ + { + "text": "Drug" + } + ], + "condition": [ + { + "text": "Human Immuno Deficiency (HIV) Infection" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0021051", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sctv", + "code": "234532001", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "39922", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000045724", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "D-4600", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1560-5885", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10021460", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000006602", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C3131", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hpo", + "code": "HP:0002721", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/omim", + "code": "MTHU032911", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "234532001", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "B99011", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "2156", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D007153", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C39725", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "279.3", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "X20GZ", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "F-C0450", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "U000355", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://loinc.org", + "code": "MTHU054768", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nanda-i", + "code": "02515", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh85064574", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1007151", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU037620", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000004832", + "display": "Immunologic Deficiency Syndromes" + } + ], + "text": "Immunologic Deficiency Syndromes" + } + ], + "contact": [ + { + "name": "Use link at the bottom of the page to see if you qualify for an enrolling site (see list). If you still have questions:", + "telecom": [ + { + "system": "email", + "value": "JNJ.CT@sylogent.com", + "use": "work" + } + ] + }, + { + "name": "StudyDirector Janssen Sciences Ireland UC Clinical Trial" + } + ], + "keyword": [ + { + "text": "HIV Infection" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0599685", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D044966", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "250564", + "display": "Antiretroviral" + }, + { + "system": "http://snomed.info/sctv", + "code": "713540004", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "0715-4905", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh2003006231", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000042059", + "display": "Antiretroviral" + } + ], + "text": "Antiretroviral" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0019704", + "display": "HIV-1" + }, + { + "system": "http://snomed.info/sctv", + "code": "243598007", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_cdisc", + "code": "C14220", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_ctrp", + "code": "C14220", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "X73kd", + "display": "HIV-1" + }, + { + "system": "http://loinc.org", + "code": "MTHU009425", + "display": "HIV-1" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C14220", + "display": "HIV-1" + }, + { + "system": "http://snomed.info/sct", + "code": "L-35211", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10020455", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "3130-7357", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D015497", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ncbi", + "code": "11676", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000006190", + "display": "HIV-1" + } + ], + "text": "HIV-1" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0001175", + "display": "AIDS" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "B20", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ram", + "code": "DX272", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/qmr", + "code": "R0121441", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "A788z", + "display": "AIDS" + }, + { + "system": "http://snomed.info/sctv", + "code": "186715004", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "1684", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000000649", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc", + "code": "B90", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10000563", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "31779", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "00595", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C2851", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D000163", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000023174", + "display": "AIDS" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C2851", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/cst", + "code": "HIV SYND", + "display": "AIDS" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "B90001", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc2eeng", + "code": "B90", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_cptac", + "code": "C2851", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medlineplus", + "code": "1", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/bi", + "code": "BI00716", + "display": "AIDS" + }, + { + "system": "http://snomed.info/sct", + "code": "DE-36310", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/who", + "code": "1233", + "display": "AIDS" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU080583", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000044365", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1560-6271", + "display": "AIDS" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "042", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "023", + "display": "AIDS" + }, + { + "system": "http://loinc.org", + "code": "LA10430-9", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1014998", + "display": "AIDS" + } + ], + "text": "AIDS" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0008059", + "display": "Children" + }, + { + "system": "http://snomed.info/sct", + "code": "S-10170", + "display": "Children" + }, + { + "system": "http://snomed.info/sctv", + "code": "67822003", + "display": "Children" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C16423", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh85023418", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000007008", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D002648", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000002765", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "0060058", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "0635-1343", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch", + "code": "U005340", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hl7v3.0", + "code": "CHD", + "display": "Children" + }, + { + "system": "http://loinc.org", + "code": "LA9949-4", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C16423", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/dxp", + "code": "U000730", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "C16423", + "display": "Children" + } + ], + "text": "Children" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C1566826", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "309423", + "display": "Rilpivirine" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AG05", + "display": "Rilpivirine" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C76929", + "display": "Rilpivirine" + }, + { + "system": "http://snomed.info/sctv", + "code": "703777002", + "display": "Rilpivirine" + }, + { + "system": "http://loinc.org", + "code": "MTHU042155", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB08864", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "d07776", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "FI96A8X663", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "FI96A8X663", + "display": "Rilpivirine" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4030730", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "1102270", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "4688", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m7163", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D000068696", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU002683", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "013795", + "display": "Rilpivirine" + } + ], + "text": "Rilpivirine (TMC278)" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C1521725", + "display": "Pediatric" + }, + { + "system": "http://loinc.org", + "code": "LP100615-6", + "display": "Pediatric" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C39299", + "display": "Pediatric" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000046245", + "display": "Pediatric" + } + ], + "text": "Pediatric" + }, + { + "text": "Human Immuno Deficiency (HIV) Infection" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0021051", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sctv", + "code": "234532001", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "39922", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000045724", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "D-4600", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1560-5885", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10021460", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000006602", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C3131", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hpo", + "code": "HP:0002721", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/omim", + "code": "MTHU032911", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "234532001", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "B99011", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "2156", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D007153", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C39725", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "279.3", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "X20GZ", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "F-C0450", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "U000355", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://loinc.org", + "code": "MTHU054768", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nanda-i", + "code": "02515", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh85064574", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1007151", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU037620", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000004832", + "display": "Immunologic Deficiency Syndromes" + } + ], + "text": "Immunologic Deficiency Syndromes" + }, + { + "coding": [ + { + "system": "http://hl7.org/fhir/administrative-gender", + "code": "Unknown", + "display": "Unknown" + } + ], + "text": "Unknown" + }, + { + "coding": [ + { + "system": "http://decades-value-set.ctm.microsoft.org", + "code": "0", + "display": "Age keyword for indexing - 0" + } + ], + "text": "Age keyword for indexing - 0" + }, + { + "coding": [ + { + "system": "http://decades-value-set.ctm.microsoft.org", + "code": "10", + "display": "Age keyword for indexing - 10" + } + ], + "text": "Age keyword for indexing - 10" + } + ], + "description": "This is a Phase II, open-label (all people involved know the identity of the assigned drug)\r\n and single arm study. The study will consist of a screening period of maximum 8 weeks, an\r\n initial treatment period of 48 weeks, a post week 48 treatment extension period of 4 years,\r\n and a 4 week follow-up period. A follow-up period will take place regardless of the presence\r\n of serious adverse events (SAEs) if patients withdraw early (ie, before Week 48) or if\r\n patients do not participate in the extension after Week 48; after Week 48, a 4-week follow-up\r\n visit is only required in case of ongoing (S)AEs at the final on treatment visit. The initial\r\n 48-week treatment period will be structured into 2 age Cohorts; Cohort 1 (Aged greater than\r\n or equal to [>=] 12 to less than [<] 18 years) and Cohort 2 (Children Aged >= 6 to < 12\r\n years) and each Cohort will have 2 parts. The first part of the trial (Part 1) is designed to\r\n evaluate the steady-state pharmacokinetic (PK) profile and the short-term safety and\r\n antiviral activity of rilpivirine 25 mg or adjusted dose once daily when administered in\r\n combination with 2 NRTIs. At Week 2/4, intensive PK will be done and an analysis together\r\n with short-term safety and antiviral activity will be reviewed by a data monitoring committee\r\n (DMC). For adolescents (Cohort 1) if the mean steady-state exposure in this first group of\r\n patients is comparable to that of the adult population (ie, is within 80-125 percentage of\r\n the mean exposure of the 25 mg once daily dose group in study, TMC278-C204), and the Week 2/4\r\n safety and antiviral activity results have been reviewed and deemed satisfactory by the DMC,\r\n the second part of the trial will start. The second part of the trial will evaluate long-term\r\n (48 weeks and 240 weeks) safety, efficacy, and pharmacokinetics of rilpivirine in combination\r\n with the background regimen of 2 NRTIs with a primary analysis time point at 24 weeks. For\r\n patients aged greater than or equal to (>=) 6 to less than (<) 12 years (Cohort 2), after\r\n being treated for at least 4 weeks and the Week 2 intensive PK and Week 4 safety and\r\n antiviral activity have been reviewed and results are satisfactory, recruitment in Part 1\r\n will resume and additional subjects will be enrolled to have at least 10 subjects in Part 1.\r\n Once an appropriate RPV dose has been selected, Part 1 of Cohort 2 will be considered\r\n complete and Part 2 will start. All patients from Part 1 will roll over in Part 2 and\r\n additional patients will be recruited in Part 2 to have at least 25 subjects (including those\r\n from Part 1) overall. In both cohorts of the trial, the ART will consist of rilpivirine 25 mg\r\n or adjusted dose once daily and an investigator-selected background regimen containing 2\r\n NRTIs. Patients safety will be monitored throughout the study and during the follow up\r\n visits.", + "enrollment": [ + { + "reference": "#2a43edc4-0000-0000-0000-000000000000", + "type": "Group" + } + ], + "period": { + "start": "2011-01", + "end": "2027-08" + }, + "arm": [ + { + "name": "Rilpivirine (TMC278)", + "type": { + "text": "Experimental" + }, + "description": "The patients will receive rilpivirine with 2 nucleoside/nucleotide reverse transcriptase inhibitors (NRTIs) as a background regimen in Cohort 1 [Aged greater than or equal to (> =) 12 to less than (<) 18 years] and Cohort 2 (children aged > = 6 to < 12 years). The NRTIs includes zidovudine, abacavir, or tenofovir disoproxil fumarate in combination with lamivudine or emtricitabine." + } + ] + } + ], + "registryFilters": [ + { + "studyTypes": [ + "interventional", + "observational" + ], + "recruitmentStatuses": [ + "recruiting", + "enrollingByInvitation" + ], + "phases": [ + "phase2", + "phase3" + ], + "purposes": [ + "diagnostic", + "prevention", + "basicScience" + ], + "sources": [ + "clinicaltrials.gov" + ], + "facilityLocations": [ + { + "city": "Basel", + "countryOrRegion": "Switzerland" + }, + { + "city": "Allschwil", + "countryOrRegion": "Switzerland" + } + ] + }, + { + "sponsors": [ + "Janssen" + ], + "sources": [ + "clinicaltrials.gov" + ], + "facilityAreas": [ + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + 7.588576, + 47.559601 + ] + }, + "properties": { + "subType": "Circle", + "radius": 80000 + } + } + ] + }, + { + "ids": [ + "NCT04006015", + "NCT04545788", + "NCT04773711" + ], + "sources": [ + "clinicaltrials.gov" + ] + } + ] + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "c7e9a8d7-6b5f-4e3d-9a2c-1f8b0e2c3f4a", + "Operation-Location": "{endpoint}/health-insights/trial-matcher/jobs/{id}?api-version=2024-08-01-preview" + }, + "body": { + "status": "notStarted", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12" + } + }, + "201": { + "headers": { + "x-ms-request-id": "c7e9a8d7-6b5f-4e3d-9a2c-1f8b0e2c3f4a", + "Operation-Location": "{endpoint}/health-insights/trial-matcher/jobs/{id}?api-version=2024-08-01-preview" + }, + "body": { + "status": "notStarted", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12" + } + } + } +} diff --git a/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulTrialMatcherResponse.json b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulTrialMatcherResponse.json new file mode 100644 index 000000000000..5f4be4dcee12 --- /dev/null +++ b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulTrialMatcherResponse.json @@ -0,0 +1,116 @@ +{ + "operationId": "TrialMatcher_GetJob", + "title": "Gets the status and details of the Trial Matcher job.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-08-01-preview", + "id": "a4d3d73e-2be3-4ca1-bd4f-66a5bdd19754" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "c7e9a8d7-6b5f-4e3d-9a2c-1f8b0e2c3f4a" + }, + "body": { + "id": "a4d3d73e-2be3-4ca1-bd4f-66a5bdd19754", + "createdAt": "2021-11-28T09:13:11.046Z", + "expiresAt": "2021-11-28T09:13:11.046Z", + "updatedAt": "2021-11-28T09:13:11.046Z", + "status": "succeeded", + "result": { + "patientResults": [ + { + "patientId": "Patient ID Example 2", + "inferences": [ + { + "type": "trialEligibility", + "value": "Eligible", + "description": "SwEaTB - Diagnosing of Acute Tuberculosis", + "confidenceScore": 1, + "evidence": [ + { + "eligibilityCriteriaEvidence": "In-patients with acute tuberculosis", + "patientInfoEvidence": { + "system": "UMLS", + "code": "C0019046", + "name": "tuberculosis" + }, + "importance": 1 + } + ], + "clinicalTrialId": "NCT03667742", + "source": "clinicaltrials.gov", + "metadata": { + "phases": [ + "phase3" + ], + "studyType": "observational", + "recruitmentStatus": "recruiting", + "conditions": [ + "Tuberculosis" + ], + "sponsors": [ + "University Hospital, Basel, Switzerland" + ], + "contacts": [ + { + "name": "John Doe, PD Dr. Med", + "email": "John@contoso.com", + "phone": "+55-555-5555-55" + } + ], + "facilities": [ + { + "name": "University Hospital, Basel", + "city": "Basel", + "countryOrRegion": "Switzerland" + } + ] + } + }, + { + "type": "trialEligibility", + "value": "Ineligible", + "description": "Design of an Integrative Algorithm for Staging Tuberculosis (STAGE-TB)", + "confidenceScore": 1, + "evidence": [ + { + "eligibilityCriteriaEvidence": "negative for Quantiferon- TB Gold Plus Test or ELISpot", + "patientInfoEvidence": { + "system": "UMLS", + "code": "C0920508", + "name": "Enzyme-Linked Immunospot Assay", + "value": "30,000 PBMC cells per 10ul" + }, + "importance": 1 + } + ], + "clinicalTrialId": "NCT03691883", + "source": "clinicaltrials.gov" + } + ], + "neededClinicalInfo": [ + { + "system": "UMLS", + "code": "C4317078", + "name": "Mycobacterium Tuberculosis Measurement ", + "semanticType": "Laboratory Procedure", + "category": "EXAMINATION_NAME" + }, + { + "system": "UMLS", + "code": "C0008031", + "name": "Chest Pain", + "semanticType": "Sign or Symptom", + "category": "SYMPTOM_OR_SIGN" + } + ] + } + ], + "modelVersion": "2021-10-28", + "knowledgeGraphLastUpdateDate": "2021-11-26" + } + } + } + } +} diff --git a/specification/ai/HealthInsights/HealthInsights.OpenAPI/main.tsp b/specification/ai/HealthInsights/HealthInsights.OpenAPI/main.tsp index afc5036bef99..ec68311f831b 100644 --- a/specification/ai/HealthInsights/HealthInsights.OpenAPI/main.tsp +++ b/specification/ai/HealthInsights/HealthInsights.OpenAPI/main.tsp @@ -1,6 +1,3 @@ -// import "../HealthInsights.TrialMatcher/route.trialmatcher.tsp"; -// import "../HealthInsights.OncoPhenotype/route.oncophenotype.tsp"; -// import "../HealthInsights.PatientTimeline/route.patienttimeline.tsp"; import "@azure-tools/typespec-azure-core"; import "@typespec/rest"; import "@typespec/http"; @@ -8,6 +5,7 @@ import "@typespec/versioning"; import "./service.tsp"; import "../HealthInsights.RadiologyInsights/route.radiologyinsights.tsp"; +import "../HealthInsights.TrialMatcher/route.trialmatcher.tsp"; // FIXME: This is a workaround. Tracking issue: https://github.com/microsoft/typespec/issues/2826 alias _ForceOrderOfReslutionExtension_ = Fhir.R4.Extension; diff --git a/specification/ai/HealthInsights/HealthInsights.OpenAPI/service.tsp b/specification/ai/HealthInsights/HealthInsights.OpenAPI/service.tsp index 69e543791ba8..cb2674da20b8 100644 --- a/specification/ai/HealthInsights/HealthInsights.OpenAPI/service.tsp +++ b/specification/ai/HealthInsights/HealthInsights.OpenAPI/service.tsp @@ -31,4 +31,7 @@ model EntraIdToken enum ApiVersion { @useDependency(Azure.Core.Versions.v1_0_Preview_2) v2024_04_01: "2024-04-01", + + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + v2024_08_01_preview: "2024-08-01-preview", } diff --git a/specification/ai/HealthInsights/HealthInsights.PatientTimeline/model.patienttimeline.tsp b/specification/ai/HealthInsights/HealthInsights.PatientTimeline/model.patienttimeline.tsp deleted file mode 100644 index 6e7f0bdfe3d2..000000000000 --- a/specification/ai/HealthInsights/HealthInsights.PatientTimeline/model.patienttimeline.tsp +++ /dev/null @@ -1,73 +0,0 @@ -import "../HealthInsights.Common/model.common.request.tsp"; -import "../HealthInsights.Common/model.common.response.tsp"; -import "../HealthInsights.Common/model.common.shared.tsp"; -import "../HealthInsights.Common/model.common.fhir.elements.tsp"; -import "../HealthInsights.Common/model.common.fhir.resources.tsp"; - -using TypeSpec.Rest; - -namespace AzureHealthInsights; - -@doc("The body of the Patient Timeline request.") -model PatientTimelineData { - ...Request; - - @doc("Configuration affecting the Patient Timeline model's inference.") - configuration?: PatientTimelineModelConfiguration; -} - -@doc("Configuration affecting the Patient Timeline model's inference.") -model PatientTimelineModelConfiguration { - ...ModelConfiguration; -} - -@resource("patient-timeline/jobs") -@doc("The response for the Patient Timeline request.") -model PatientTimelineResult - is HealthInsightsOperationStatus<PatientTimelineInferenceResult>; - -@doc("The inference results for the Patient Timeline request.") -model PatientTimelineInferenceResult { - @doc("Results for the patients given in the request.") - patientResults: PatientTimelinePatientResult[]; - - @doc("The version of the model used for inference, expressed as the model date.") - modelVersion: ModelVersion; -} - -@doc("The results of the model's work for a single patient.") -model PatientTimelinePatientResult { - @doc("The identifier given for the patient in the request.") - patientId: string; - - @doc("The model's inferences for the given patient.") - inferences: Array<PatientTimelineInference>; -} - -@doc("An inference made by the Patient Timeline model regarding a patient.") -model PatientTimelineInference is Fhir.R4.Extendible { - @doc("The type of the Patient Timeline inference.") - type: PatientTimelineInferenceType; - - #suppress "@azure-tools/typespec-azure-core/bad-record-type" "model should have additionalProperties" - @doc(""" - FHIR 4.0 representation of the piece of clinical info. - additional dependent resources maybe contained (e.g. MedicationStatement may contain Medication) - -- In the SDK we will have custom mapping to map this type to JsonObject - """) - resource?: Fhir.R4.DomainResource; - - @doc("Time range relevant to this Timeline inference.") - period?: TimePeriod; -} - -@doc("The type of the Patient Timeline inference.") -union PatientTimelineInferenceType { - string, - - @doc("The inference is a timeline event.") - TimelineEvent: "timelineEvent", - - @doc("The inference is a summary item.") - SummaryItem: "summaryItem", -} diff --git a/specification/ai/HealthInsights/HealthInsights.PatientTimeline/route.patienttimeline.tsp b/specification/ai/HealthInsights/HealthInsights.PatientTimeline/route.patienttimeline.tsp deleted file mode 100644 index bbb9c165dd4e..000000000000 --- a/specification/ai/HealthInsights/HealthInsights.PatientTimeline/route.patienttimeline.tsp +++ /dev/null @@ -1,36 +0,0 @@ -import "@azure-tools/typespec-azure-core"; -import "@typespec/rest"; -import "@typespec/http"; - -import "./model.patienttimeline.tsp"; -import "../HealthInsights.Common/primitives.tsp"; - -using Azure.Core; -using TypeSpec.Rest; -using TypeSpec.Http; - -namespace AzureHealthInsights; - -@TypeSpec.Versioning.removed(AzureHealthInsights.ApiVersion.v2024_04_01) -interface PatientTimeline { - #suppress "@azure-tools/typespec-azure-core/no-rpc-path-params" "Service uses a jobId in the path" - @summary("Get Patient Timeline job details") - @tag("PatientTimeline") - @doc("Gets the status and details of the Patient Timeline job.") - @get - @route("/patient-timeline/jobs/{id}") - getJob is HealthInsightsLongRunningPollOperation<BodyParameter<PatientTimelineResult>>; - - #suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" "Polling through operation-location" - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "There is no long-running RPC template in Azure.Core" - @summary("Create Patient Timeline job") - @tag("PatientTimeline") - @doc("Creates a Patient Timeline job with the given request body.") - @pollingOperation(PatientTimeline.getJob) - @route("/patient-timeline/jobs") - createJob is HealthInsightsLongRunningRpcOperation< - PatientTimelineData, - PatientTimelineResult, - PatientTimelineInferenceResult - >; -} diff --git a/specification/ai/HealthInsights/HealthInsights.TrialMatcher/model.trialmatcher.tsp b/specification/ai/HealthInsights/HealthInsights.TrialMatcher/model.trialmatcher.tsp index 058ea91474e2..439947c432b6 100644 --- a/specification/ai/HealthInsights/HealthInsights.TrialMatcher/model.trialmatcher.tsp +++ b/specification/ai/HealthInsights/HealthInsights.TrialMatcher/model.trialmatcher.tsp @@ -5,6 +5,8 @@ import "../HealthInsights.Common/model.common.fhir.elements.tsp"; using TypeSpec.Rest; +using TypeSpec.Versioning; + namespace AzureHealthInsights; @doc("The body of the Trial Matcher request.") @@ -28,10 +30,20 @@ model TrialMatcherModelConfiguration { clinicalTrials: ClinicalTrials; } +@added(ApiVersion.v2024_08_01_preview) +@doc("Response for the Trial Matcher request.") @resource("trial-matcher/jobs") -@doc("The response for the Trial Matcher request.") -model TrialMatcherResult - is HealthInsightsOperationStatus<TrialMatcherInferenceResult>; +model TrialMatcherJob { + @doc("The request data for the operation.") + @visibility("read", "create") + jobData?: TrialMatcherData; + + @doc("The result of the operation.") + @visibility("read") + result?: TrialMatcherInferenceResult; + + ...HealthInsightsJobBase; +} @doc("The inference results for the Trial Matcher request.") model TrialMatcherInferenceResult { diff --git a/specification/ai/HealthInsights/HealthInsights.TrialMatcher/route.trialmatcher.tsp b/specification/ai/HealthInsights/HealthInsights.TrialMatcher/route.trialmatcher.tsp index 4e627e65e67c..206c1c06f6f7 100644 --- a/specification/ai/HealthInsights/HealthInsights.TrialMatcher/route.trialmatcher.tsp +++ b/specification/ai/HealthInsights/HealthInsights.TrialMatcher/route.trialmatcher.tsp @@ -7,29 +7,21 @@ import "../HealthInsights.Common/primitives.tsp"; using Azure.Core; using TypeSpec.Rest; using TypeSpec.Http; +using TypeSpec.Versioning; namespace AzureHealthInsights; -@TypeSpec.Versioning.removed(AzureHealthInsights.ApiVersion.v2024_04_01) +@TypeSpec.Versioning.added(AzureHealthInsights.ApiVersion.v2024_08_01_preview) interface TrialMatcher { - #suppress "@azure-tools/typespec-azure-core/no-rpc-path-params" "Service uses a jobId in the path" @summary("Get Trial Matcher job details") @tag("TrialMatcher") @doc("Gets the status and details of the Trial Matcher job.") @get - @route("/trial-matcher/jobs/{id}") - getJob is HealthInsightsLongRunningPollOperation<BodyParameter<TrialMatcherResult>>; + getJob is HealthInsightsOperations.ResourceRead<TrialMatcherJob>; - #suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" "Polling through operation-location" - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "There is no long-running RPC template in Azure.Core" @summary("Create Trial Matcher job") @tag("TrialMatcher") @doc("Creates a Trial Matcher job with the given request body.") @pollingOperation(TrialMatcher.getJob) - @route("/trial-matcher/jobs") - createJob is HealthInsightsLongRunningRpcOperation< - TrialMatcherData, - TrialMatcherResult, - TrialMatcherInferenceResult - >; + createJob is HealthInsightsOperations.LongRunningResourceCreateOrReplace<TrialMatcherJob>; } diff --git a/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulRadiologyInsightsRequest.json b/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulRadiologyInsightsRequest.json new file mode 100644 index 000000000000..0217e4d6a9ab --- /dev/null +++ b/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulRadiologyInsightsRequest.json @@ -0,0 +1,134 @@ +{ + "operationId": "RadiologyInsights_CreateJob", + "title": "Creates a Radiology Insights job with the given request body.", + "parameters": { + "endpoint": "{endpoint}/health-insights/radiology-insights/jobs/{id}?api-version={api-version}", + "api-version": "2024-08-01-preview", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12", + "resource": { + "jobData": { + "configuration": { + "inferenceOptions": { + "followupRecommendationOptions": { + "includeRecommendationsWithNoSpecifiedModality": false, + "includeRecommendationsInReferences": false, + "provideFocusedSentenceEvidence": false + }, + "findingOptions": { + "provideFocusedSentenceEvidence": false + } + }, + "inferenceTypes": [ + "finding", + "ageMismatch", + "lateralityDiscrepancy", + "sexMismatch", + "completeOrderDiscrepancy", + "limitedOrderDiscrepancy", + "criticalResult", + "criticalRecommendation", + "followupRecommendation", + "followupCommunication", + "radiologyProcedure" + ], + "locale": "en-US", + "verbose": false, + "includeEvidence": true + }, + "patients": [ + { + "id": "sample id 1", + "details": { + "sex": "male", + "clinicalInfo": [ + { + "resourceType": "Observation", + "status": "unknown", + "code": { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0018802", + "display": "MalignantNeoplasms" + } + ] + }, + "valueBoolean": "true" + } + ] + }, + "encounters": [ + { + "id": "encounterid1", + "period": { + "start": "2023-12-21T00:00:00", + "end": "2023-12-21T00:00:00" + }, + "class": "inpatient" + } + ], + "patientDocuments": [ + { + "type": "note", + "clinicalType": "radiologyReport", + "id": "docid1", + "language": "en", + "authors": [ + { + "id": "authorid1", + "fullName": "authorname1" + } + ], + "specialtyType": "radiology", + "createdAt": "2023-12-21T00:00:00", + "administrativeMetadata": { + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "system": "Http://hl7.org/fhir/ValueSet/cpt-all", + "code": "111111", + "display": "CT ABD/PELVIS" + } + ] + }, + "description": "CT ABD/PELVIS" + } + ], + "encounterId": "encounterid1" + }, + "content": { + "sourceType": "inline", + "value": "[**2143-4-13**] 5:04 PM\r\nCT ABD W&W/O C; CT CHEST W&W/O C Clip # [**Clip Number (Radiology) 38350**]\r\nCT PELVIS W&W/O C\r\nReason: ? PE, evidence of pneumonia\r\nAdmitting Diagnosis: SEPSIS\r\nField of view: 38 Contrast: OPTIRAY Amt: 130\r\n______________________________________________________________________________\r\n[**Hospital 4**] MEDICAL CONDITION:\r\n52 year old man with urosepsis, s/p nephrostogram on [**4-12**], today with acute\r\nSOB, fever, rigors.\r\nREASON FOR THIS EXAMINATION:\r\n? PE, evidence of pneumonia\r\nNo contraindications for IV contrast\r\n______________________________________________________________________________\r\nFINAL REPORT\r\nINDICATION: History of urosepsis status post nephrostogram on [**4-12**], today\r\nwith acute shortness of breath, fevers, and rigors. Also reported hematocrit\r\ndrop. Evaluate for pulmonary embolism or hematoma.\r\nCOMPARISON: Non-contrast CT of the abdomen and pelvis dated [**2143-4-11**].\r\nTECHNIQUE: MDCT acquired images of the chest, abdomen, and pelvis were\r\nobtained before and after the administration of IV contrast. A true CT\r\nangiogram could not be performed due to lack of appropriate intravenous\r\naccess.\r\nCT OF THE CHEST WITHOUT AND WITH IV CONTRAST: Evaluation of the pulmonary\r\narteries is limited with no large central pulmonary embolism seen. Evaluation\r\nof the segmental and subsegmental branches is limited. There is a central\r\nvenous catheter that terminates in the right atrium. There are numerous small\r\nmesenteric and axillary lymph nodes that do not meet CT criteria for\r\npathologic enlargement. There are coronary artery calcifications. There are\r\nbilateral small layering pleural effusions with associated compressive\r\natelectasis. The images of the lungs are limited due to motion. There\r\nappears to be a patchy, predominantly ground-glass opacity in both lower\r\nlobes, left worse than right. The aorta appears intact. There is debris in\r\nthe trachea.\r\nCT OF THE ABDOMEN WITHOUT AND WITH IV CONTRAST: There is high-density\r\nmaterial tracking along the course of a dilated left ureter consistent with\r\nhemorrhage that is new compared to the previous study. New stranding in the\r\nleft retroperitoneum is also present consistent with retroperitoneal\r\nhemorrhage. Perinephric stranding is present, as was seen on the previous\r\nstudy. The degree of dilatation of the left ureter is unchanged. Several\r\nfoci of air outside of the collecting system are present, presumably\r\npostprocedural in nature. Contrast-enhanced images show abnormal perfusion of\r\nthe left kidney with a striated appearance, most severe at the upper pole with\r\nperipheral wedge-shaped hypoenhancing areas also present on top of the areas\r\nof reduced perfusion. No active extravasation of contrast is seen. The right\r\nkidney is normal. The liver, spleen, and adrenal glands are unremarkable.\r\nPancreas is unremarkable with slightly prominent distal common bile duct\r\nmeasuring up to 8-9 mm. There is a small cystic lesion measuring 5 mm at the\r\nhead of the pancreas (series 10, image 143). Small and large bowel are\r\n(Over)\r\n[**2143-4-13**] 5:04 PM\r\nCT ABD W&W/O C; CT CHEST W&W/O C Clip # [**Clip Number (Radiology) 38350**]\r\nCT PELVIS W&W/O C\r\nReason: ? PE, evidence of pneumonia\r\nAdmitting Diagnosis: SEPSIS\r\nField of view: 38 Contrast: OPTIRAY Amt: 130\r\n______________________________________________________________________________\r\nFINAL REPORT\r\n(Cont)\r\ngrossly unremarkable. The aorta, celiac artery, superior mesenteric artery,\r\ninferior mesenteric artery, and renal arteries appear patent.\r\nCT OF THE PELVIS WITHOUT AND WITH IV CONTRAST: The prostate gland is\r\nenlarged. Thickening of the bladder wall is again demonstrated. Several foci\r\nof air within the bladder are presumably secondary to the Foley catheter. The\r\nrectum and sigmoid colon are unremarkable.\r\nBONE WINDOWS: There are degenerative changes with no suspicious lytic or\r\nsclerotic lesions.\r\nIMPRESSION:\r\n1. New high-density material surrounding the left ureter and tracking within\r\nthe retroperitoneum consistent with hemorrhage.\r\n2. Abnormal perfusion of the left kidney, most severe at the upper pole.\r\nFindings are consistent with pyelonephritis. Edema and abnormal perfusion at\r\nthe upper pole and interpolar region medially with multiple peripheral\r\nhypoenhancing wedge- shaped regions likely represent ischemia and a component\r\nof infarction.\r\n3. Limited examination for pulmonary embolism due to suboptimal contrast\r\nbolus with no large central embolus seen. Evaluation of distal segmental and\r\nsubsegmental branches is limited.\r\n4. Small bilateral layering pleural effusions with associated compressive\r\natelectasis. Patchy predominantly ground-glass opacities in both lower lobes,\r\nleft worse than right could represent pneumonia or pneumonitis.\r\n5. 5mm cystic lesion in the head of the pancreas. Recommend 1 year follow up.\r\nThe above was discussed with Dr. [**First Name8 (NamePattern2) 951**] [**Last Name (NamePattern1) 1238**] at approximately 6:30 p.m. on\r\n[**2143-4-13**].\r\n" + } + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "c7e9a8d7-6b5f-4e3d-9a2c-1f8b0e2c3f4a", + "Operation-Location": "{endpoint}/health-insights/radiology-insights/jobs/{id}?api-version=2024-04-01" + }, + "body": { + "status": "notStarted", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12" + } + }, + "201": { + "headers": { + "x-ms-request-id": "c7e9a8d7-6b5f-4e3d-9a2c-1f8b0e2c3f4a", + "Operation-Location": "{endpoint}/health-insights/radiology-insights/jobs/{id}?api-version=2024-04-01" + }, + "body": { + "status": "notStarted", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12" + } + } + } +} diff --git a/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulRadiologyInsightsResponse.json b/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulRadiologyInsightsResponse.json new file mode 100644 index 000000000000..abbdff32da9a --- /dev/null +++ b/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulRadiologyInsightsResponse.json @@ -0,0 +1,33454 @@ +{ + "operationId": "RadiologyInsights_GetJob", + "title": "Gets the status and details of the Radiology Insights job.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-08-01-preview", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "c7e9a8d7-6b5f-4e3d-9a2c-1f8b0e2c3f4a" + }, + "body": { + "result": { + "patientResults": [ + { + "patientId": "sample id 1", + "inferences": [ + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6839", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246501002", + "display": "TECHNIQUE (ATTRIBUTE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4466 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4508 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6840", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246501002", + "display": "TECHNIQUE (ATTRIBUTE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4572 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4586 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4621 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4633 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6856", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for encounter" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6857", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 178 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 178 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 178 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for encounter" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6858", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 210 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 210 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91302008", + "display": "SEPSIS (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 210 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "46241-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "HOSPITAL ADMISSION DIAGNOSIS - REPORTED" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6859", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 402 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 402 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64572001", + "display": "DISEASE (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 457 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246452003", + "display": "CHRONICITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "255363002", + "display": "SUDDEN (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 402 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 457 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "11329-0" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "History" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6860", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for exam" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6861", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 533 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 533 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 533 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for exam" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6862", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 700 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 700 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64572001", + "display": "DISEASE (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 700 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6863", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 867 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 867 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 867 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6864", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 879 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 879 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "35566002", + "display": "HEMATOMA (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 879 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6865", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1325 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1325 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "81040000", + "display": "PULMONARY ARTERY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID974", + "display": "PULMONARY ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28586", + "display": "SET OF PULMONARY ARTERIES" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1301 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1307 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "large;;central" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1301 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1307 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1325 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6866", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1691 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1691 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "41699000", + "display": "EFFUSION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "3120008", + "display": "PLEURAL MEMBRANE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1362", + "display": "PLEURA" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1658 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1658 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "51440002", + "display": "RIGHT AND LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "135650694", + "display": "CAUSES OF HARM (QUALIFIER VALUE)" + } + ] + }, + "valueString": "compressive;;atelectasis" + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1668 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "27123005", + "display": "BILIARY SLUDGE (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1658 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1668 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1691 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6867", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46621007", + "display": "ATELECTASIS (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "71173004", + "display": "COMPRESSION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "3120008", + "display": "PLEURAL MEMBRANE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1362", + "display": "PLEURA" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6868", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + }, + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + }, + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "36692007", + "display": "KNOWN (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2117 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2117 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2117 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6869", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6870", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for encounter" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6871", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3293 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3293 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3293 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for encounter" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6872", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3325 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3325 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91302008", + "display": "SEPSIS (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3325 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "46241-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "HOSPITAL ADMISSION DIAGNOSIS - REPORTED" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6874", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4237 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4237 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "23583003", + "display": "INFLAMMATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4237 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6875", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4412 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4412 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "52674009", + "display": "ISCHEMIA (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4324 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4412 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6876", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4441 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4441 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55641003", + "display": "INFARCT (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4324 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4441 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6877", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4492 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4492 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4529 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "135650694", + "display": "CAUSES OF HARM (QUALIFIER VALUE)" + } + ] + }, + "valueString": "bolus" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4492 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4529 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6878", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4680 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4663 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4680 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "41699000", + "display": "EFFUSION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "3120008", + "display": "PLEURAL MEMBRANE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1362", + "display": "PLEURA" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4653 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4653 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "51440002", + "display": "RIGHT AND LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "135650694", + "display": "CAUSES OF HARM (QUALIFIER VALUE)" + } + ] + }, + "valueString": "compressive;;atelectasis" + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4647 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4663 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "27123005", + "display": "BILIARY SLUDGE (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4647 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4653 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4663 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4680 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6879", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46621007", + "display": "ATELECTASIS (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "71173004", + "display": "COMPRESSION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "3120008", + "display": "PLEURAL MEMBRANE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1362", + "display": "PLEURA" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6882", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 464 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 464 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "390870001", + "display": "SHORT OF BREATH DRESSING/UNDRESSING (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 464 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "11329-0" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "History" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6883", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 469 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 469 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "386661006", + "display": "FEVER (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 469 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "11329-0" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "History" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6884", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "43724002", + "display": "CHILL (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "16046003", + "display": "MUSCLE RIGIDITY (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "11329-0" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "History" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6885", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 779 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 782 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 779 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 782 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "390870001", + "display": "SHORT OF BREATH DRESSING/UNDRESSING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 779 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 782 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64572001", + "display": "DISEASE (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246452003", + "display": "CHRONICITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "255363002", + "display": "SUDDEN (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 779 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 782 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6886", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 790 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 790 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "386661006", + "display": "FEVER (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246452003", + "display": "CHRONICITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "255363002", + "display": "SUDDEN (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 790 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6887", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "43724002", + "display": "CHILL (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "16046003", + "display": "MUSCLE RIGIDITY (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246452003", + "display": "CHRONICITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "255363002", + "display": "SUDDEN (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6889", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1630 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1630 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "18115005", + "display": "PATHOLOGIC CALCIFICATION, CALCIFIED STRUCTURE (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "41801008", + "display": "CORONARY ARTERY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28727", + "display": "SET OF CORONARY ARTERIES" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID35862", + "display": "CORONARY ARTERY" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1630 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6890", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1841 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1854 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1841 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1854 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "128305008", + "display": "ABNORMALLY OPAQUE STRUCTURE (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1865 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1865 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "51440002", + "display": "RIGHT AND LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1819 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "patchy" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1819 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1841 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1854 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1865 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6891", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1943 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1943 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "257159000", + "display": "DEBRIS (SUBSTANCE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "955009", + "display": "BRONCHIAL STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1247", + "display": "TRACHEA" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1943 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6892", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2026 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2040 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2026 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "127558001", + "display": "DENSITY FINDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2026 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2040 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6893", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2080 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2080 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "25322007", + "display": "DILATATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2080 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6894", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7147002", + "display": "NEW (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2177 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2177 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "118247008", + "display": "RADIOLOGIC FINDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2177 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6895", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2290 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2290 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "118247008", + "display": "RADIOLOGIC FINDING (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2278 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2290 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6896", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "36692007", + "display": "KNOWN (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2363 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2363 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "25322007", + "display": "DILATATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2396 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "288533004", + "display": "CHANGE VALUES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "58158008", + "display": "STABLE (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2363 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2396 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6897", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2417 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2422 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2425 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2425 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15158005", + "display": "AIR (SUBSTANCE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID223", + "display": "RENAL COLLECTING SYSTEM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2429 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "outside" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2417 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2422 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2425 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2429 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6898", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID29663", + "display": "LEFT KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2616 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "272141005", + "display": "SEVERITIES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24484000", + "display": "SEVERE (SEVERITY MODIFIER) (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2647 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2658 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "peripheral;;wedge-shaped" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2616 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2630 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2636 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2647 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2658 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2671 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2675 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2685 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6899", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2736 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2728 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260400001", + "display": "REDUCED (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2728 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "reduced" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2728 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2736 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6900", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2758 + }, + { + "url": "length", + "valueInteger": 13 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2772 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2775 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2758 + }, + { + "url": "length", + "valueInteger": 13 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "76676007", + "display": "EXTRAVASATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2751 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "active" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2751 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2758 + }, + { + "url": "length", + "valueInteger": 13 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2772 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2775 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6901", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2997 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2997 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "367643001", + "display": "CYST (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2997 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "52988006", + "display": "LESION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15776009", + "display": "PANCREATIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID171", + "display": "HEAD OF PANCREAS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2991 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "small" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3021 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3023 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://radlex.org", + "code": "246115007", + "display": "SIZE (ATTRIBUTE)" + } + ] + }, + "valueQuantity": { + "value": 5.0, + "unit": "MILLIMETER" + }, + "interpretation": [ + { + "coding": [ + { + "code": "15240007", + "display": "CURRENT" + } + ] + } + ] + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2991 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2997 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3021 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3023 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6902", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3704 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3715 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3718 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3704 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "89977008", + "display": "INCREASED THICKNESS (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "89837001", + "display": "URINARY BLADDER STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30135", + "display": "WALL OF URINARY BLADDER" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3704 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3715 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3718 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6903", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3776 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3776 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15158005", + "display": "AIR (SUBSTANCE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "89837001", + "display": "URINARY BLADDER STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID237", + "display": "URINARY BLADDER" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3776 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6904", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3922 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3935 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3922 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3935 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362975008", + "display": "DEGENERATIVE DISORDER (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "272673000", + "display": "BONE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28569", + "display": "SET OF BONE ORGANS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13197", + "display": "BONE ORGAN" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3922 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3935 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6905", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3972 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3982 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3972 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "43846000", + "display": "SCLEROSIS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3972 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3982 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3982 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "52988006", + "display": "LESION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "272673000", + "display": "BONE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28569", + "display": "SET OF BONE ORGANS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13197", + "display": "BONE ORGAN" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3951 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3962 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "suspicious;;lytic" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3951 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3962 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3972 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3982 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6907", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4254 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4254 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "267038008", + "display": "EDEMA (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45851105", + "display": "REGION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45851105", + "display": "REGION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4254 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4317 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4324 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6908", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4347 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "peripheral" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4324 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4347 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4359 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4363 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4373 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4378 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4380 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4387 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6909", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4557 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4557 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4543 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4549 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "large;;central" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4543 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4549 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4557 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6910", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4753 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4766 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4753 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4766 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "128305008", + "display": "ABNORMALLY OPAQUE STRUCTURE (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4779 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4779 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "51440002", + "display": "RIGHT AND LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4732 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "Patchy" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4732 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4753 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4766 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4779 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6911", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4871 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4871 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "367643001", + "display": "CYST (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4871 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "52988006", + "display": "LESION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15776009", + "display": "PANCREATIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID171", + "display": "HEAD OF PANCREAS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4867 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4868 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://radlex.org", + "code": "246115007", + "display": "SIZE (ATTRIBUTE)" + } + ] + }, + "valueQuantity": { + "value": 5.0, + "unit": "MILLIMETER" + }, + "interpretation": [ + { + "coding": [ + { + "code": "15240007", + "display": "CURRENT" + } + ] + } + ] + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4867 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4868 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4871 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6912", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1787 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1787 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "164836004", + "display": "MUSCULOSKELETAL MOVEMENT (OBSERVABLE ENTITY)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1787 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6913", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID223", + "display": "RENAL COLLECTING SYSTEM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2487 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "postprocedural" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2487 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6914", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID29663", + "display": "LEFT KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2590 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2599 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6915", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2920 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2920 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "4657009", + "display": "PROMINENT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "28273000", + "display": "BILE DUCT STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID199", + "display": "COMMON BILE DUCT" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2911 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2920 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "4657009", + "display": "PROMINENT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2965 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2971 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2975 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://radlex.org", + "code": "246115007", + "display": "SIZE (ATTRIBUTE)" + } + ] + }, + "valueQuantity": { + "comparator": "<=" + }, + "interpretation": [ + { + "coding": [ + { + "code": "15240007", + "display": "CURRENT" + } + ] + } + ] + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2911 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2920 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2930 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2965 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2971 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2975 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6916", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3689 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3693 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260376009", + "display": "ENLARGED (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "41216001", + "display": "PROSTATIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID343", + "display": "PROSTATE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3693 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "288533004", + "display": "CHANGE VALUES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "35105006", + "display": "INCREASED (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3689 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3693 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6917", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3767 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3773 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3767 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3773 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "397685007", + "display": "FINDING RELATED TO FOCUSING (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3767 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3773 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6921", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "281157001", + "display": "SYSTEMIC VASCULAR STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID480", + "display": "AORTA" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6922", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID29662", + "display": "RIGHT KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6923", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "23451007", + "display": "ADRENAL STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "10200004", + "display": "LIVER STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "78961009", + "display": "SPLENIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28752", + "display": "SET OF ADRENAL GLANDS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID88", + "display": "ADRENAL GLAND" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID58", + "display": "LIVER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID86", + "display": "SPLEEN" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6924", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15776009", + "display": "PANCREATIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID170", + "display": "PANCREAS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6925", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "281471001", + "display": "STRUCTURE OF ABDOMINAL BLOOD VESSEL (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "244261004", + "display": "ABDOMINAL VISCERAL ARTERY (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "56400007", + "display": "STRUCTURE OF RENAL VEIN (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "281157001", + "display": "SYSTEMIC VASCULAR STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID906", + "display": "CELIAC ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3530 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3530 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID927", + "display": "SUPERIOR MESENTERIC ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3556 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3559 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3556 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3559 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID939", + "display": "INFERIOR MESENTERIC ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID936", + "display": "RENAL ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID49729", + "display": "SET OF RENAL ARTERIES" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID480", + "display": "AORTA" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID50393", + "display": "SET OF ABDOMINAL ARTERIES" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3530 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3556 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3559 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "final assessment" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6926", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "71854001", + "display": "COLON STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "34402009", + "display": "RECTUM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID162", + "display": "SIGMOID COLON" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID163", + "display": "RECTUM" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6930", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6933", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6936", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "36692007", + "display": "KNOWN (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "30746006", + "display": "LYMPHADENOPATHY (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15425007", + "display": "PERITONEUM (SEROUS MEMBRANE) STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID33180", + "display": "MESENTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "288533004", + "display": "CHANGE VALUES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "35105006", + "display": "INCREASED (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1502 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "small;;pathologic" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1502 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6938", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "36692007", + "display": "KNOWN (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "30746006", + "display": "LYMPHADENOPATHY (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "47109002", + "display": "STRUCTURE OF LYMPH NODE OF THORAX (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28849", + "display": "AXILLARY LYMPH NODE GROUP" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1517", + "display": "AXILLARY LYMPH NODE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "288533004", + "display": "CHANGE VALUES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "35105006", + "display": "INCREASED (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1502 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "small;;pathologic" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1502 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6940", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7147002", + "display": "NEW (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4026 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "127558001", + "display": "DENSITY FINDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4026 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6943", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7147002", + "display": "NEW (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4026 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "127558001", + "display": "DENSITY FINDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4026 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6946", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6948", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6950", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "23583003", + "display": "INFLAMMATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6952", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "23583003", + "display": "INFLAMMATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "followupCommunication", + "communicatedAt": [ + "2023-12-21T18:30:00" + ], + "recipient": [ + "doctor" + ], + "wasAcknowledged": true, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4957 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4972 + }, + { + "url": "length", + "valueInteger": 76 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 5066 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 5080 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ] + }, + { + "kind": "criticalResult", + "result": { + "description": "RETROPERITONEAL HEMORRHAGE", + "finding": { + "resourceType": "Observation", + "id": "6869", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + } + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ] + }, + { + "kind": "criticalResult", + "result": { + "description": "RETROPERITONEAL HEMORRHAGE", + "finding": { + "resourceType": "Observation", + "id": "6933", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + } + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ] + }, + { + "kind": "criticalResult", + "result": { + "description": "PNEUMONIA", + "finding": { + "resourceType": "Observation", + "id": "6948", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + } + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ] + }, + { + "procedureCodes": [ + { + "coding": [ + { + "system": "http://loinc.org", + "code": "44115-4", + "display": "CT ABDOMEN AND PELVIS" + } + ] + } + ], + "imagingProcedures": [ + { + "modality": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "77477000", + "display": "COMPUTERIZED AXIAL TOMOGRAPHY (PROCEDURE)" + } + ] + }, + "anatomy": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "113345001", + "display": "ABDOMINAL STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "modality": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "77477000", + "display": "COMPUTERIZED AXIAL TOMOGRAPHY (PROCEDURE)" + } + ] + }, + "anatomy": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "12921003", + "display": "PELVIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + } + ], + "orderedProcedure": { + "code": { + "coding": [ + { + "code": "111111" + } + ] + }, + "description": "CT ABD/PELVIS." + }, + "kind": "radiologyProcedure" + } + ] + } + ], + "modelVersion": "2024-01-19-preview" + }, + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12", + "createdAt": "2024-01-29T19:50:52Z", + "expiresAt": "2024-01-30T19:50:52Z", + "updatedAt": "2024-01-29T19:51:12Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulTrialMatcherRequest.json b/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulTrialMatcherRequest.json new file mode 100644 index 000000000000..7dba7841e236 --- /dev/null +++ b/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulTrialMatcherRequest.json @@ -0,0 +1,3009 @@ +{ + "operationId": "TrialMatcher_CreateJob", + "title": "Creates a Trial Matcher job with the given request body.", + "parameters": { + "endpoint": "{endpoint}/health-insights/trial-matcher/jobs/{id}?api-version={api-version}", + "api-version": "2024-08-01-preview", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d11", + "resource": { + "jobData": { + "patients": [ + { + "id": "Patient ID Example 2", + "details": { + "sex": "female", + "birthDate": "1976-09-10", + "clinicalInfo": [ + { + "resourceType": "Condition", + "code": { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0041296", + "display": "Tuberculosis" + } + ] + } + }, + { + "code": { + "coding": [ + { + "code": "C0006826", + "display": "MalignantNeoplasms", + "system": "http://www.nlm.nih.gov/research/umls" + } + ] + }, + "resourceType": "Observation", + "status": "unknown", + "valueBoolean": true + }, + { + "code": { + "coding": [ + { + "code": "C0018802", + "display": "MalignantNeoplasms", + "system": "http://www.nlm.nih.gov/research/umls" + } + ] + }, + "resourceType": "Observation", + "status": "unknown", + "valueBoolean": true + } + ] + } + } + ], + "configuration": { + "verbose": true, + "includeEvidence": true, + "clinicalTrials": { + "customTrials": [ + { + "resourceType": "ResearchStudy", + "contained": [ + { + "resourceType": "PlanDefinition", + "id": "1b5bc5d5-9413-43f7-9da6-70db2606b7cd", + "name": "Rilpivirine", + "title": "Rilpivirine", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Rilpivirine", + "description": "Patients will receive rilpivirine tablet 25 milligram or adjusted dose orally once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "30f45f8a-a0f5-4eed-a5e1-4819137c10b2", + "name": "Zidovudine", + "title": "Zidovudine", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Zidovudine", + "description": "Type=exact, form= appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "8958e19c-17db-4152-874d-cf68c3918769", + "name": "Abacavir", + "title": "Abacavir", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Abacavir", + "description": "Type=exact, form=appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "bef1c7b6-1e1a-4fb4-8bcd-b9d965dd09e6", + "name": "Tenofovir disoproxil fumarate", + "title": "Tenofovir disoproxil fumarate", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Tenofovir disoproxil fumarate", + "description": "Type=exact, form=appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "ec554338-0167-4034-98dd-ee1cd5860430", + "name": "Lamivudine", + "title": "Lamivudine", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Lamivudine", + "description": "Type=exact, form=appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "8ddc695e-efab-441e-bd49-c1decfdb80bf", + "name": "Emtricitabine", + "title": "Emtricitabine", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Emtricitabine", + "description": "Type=exact, form=appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "Group", + "id": "73e459c6-9b92-479d-b122-0712d18a9131", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "TreatmentName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0723712", + "display": "therapeutic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "220281", + "display": "therapeutic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000046327", + "display": "therapeutic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "7381", + "display": "therapeutic" + } + ], + "text": "therapeutic" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "47519-4", + "display": "History of Procedures" + } + ], + "text": "History of Procedures" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "TreatmentName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0086413", + "display": "HIV vaccine" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C1325", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "347399", + "display": "HIV vaccine" + }, + { + "system": "http://hl7.org/fhir/sid/cvx", + "code": "61", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hl7v2.5", + "code": "61", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hl7v3.0", + "code": "61", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D016915", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000015914", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "3059-5000", + "display": "HIV vaccine" + }, + { + "system": "http://loinc.org", + "code": "LP183501-8", + "display": "HIV vaccine" + } + ], + "text": "HIV vaccine" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "47519-4", + "display": "History of Procedures" + } + ], + "text": "History of Procedures" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "127161fc-b30f-4efc-ae14-2d064dc6084b", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#73e459c6-9b92-479d-b122-0712d18a9131", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationClass" + } + ], + "text": "HIV drug", + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "somecode", + "display": "somecode" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "c26ff014-3da3-419b-9338-6e4b4d49031e", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "one-or-more", + "display": "One Or More" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0132326", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D019829", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB00238", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000712787", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "99DK7FVK1H", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "99DK7FVK1H", + "display": "nevirapine" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4020991", + "display": "nevirapine" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C29277", + "display": "nevirapine" + }, + { + "system": "http://snomed.info/sctv", + "code": "108704001", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "75157", + "display": "nevirapine" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AG01", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "006062", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "eiK..", + "display": "nevirapine" + }, + { + "system": "http://loinc.org", + "code": "LP21317-0", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "175112", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh2010013984", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000016392", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "2030", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "4007-0088", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "53654", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m56485", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000656", + "display": "nevirapine" + } + ], + "text": "nevirapine" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0043474", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000040121", + "display": "zidovudine" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C947", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D015215", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "2109-4800", + "display": "zidovudine" + }, + { + "system": "http://snomed.info/sctv", + "code": "387151007", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "05223", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "41905", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB00495", + "display": "zidovudine" + }, + { + "system": "http://snomed.info/sct", + "code": "C-55B60", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "ei5..", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000013273", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000044478", + "display": "zidovudine" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4019502", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "11413", + "display": "zidovudine" + }, + { + "system": "http://loinc.org", + "code": "LP16744-2", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_dtp", + "code": "NSC0602670", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m89510", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "4B9XT59T7S", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "2650", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_ctrp", + "code": "C947", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "4B9XT59T7S", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "d00034", + "display": "zidovudine" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AF01", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000671", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "003019", + "display": "zidovudine" + } + ], + "text": "zidovudine" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "9ab418f5-9bf1-4bb7-a55f-0eed1244addb", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#c26ff014-3da3-419b-9338-6e4b4d49031e", + "type": "Group" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "SymptomOrSign" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0282474", + "display": "mother-to-child transmission" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D018445", + "display": "mother-to-child transmission" + } + ], + "text": "mother-to-child transmission" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "c31f130b-c0e7-411a-a32b-57f07ea62559", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#127161fc-b30f-4efc-ae14-2d064dc6084b", + "type": "Group" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#9ab418f5-9bf1-4bb7-a55f-0eed1244addb", + "type": "Group" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "1d943af4-3b3e-4363-9e82-bc0e59b8c3e1", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "one-or-more", + "display": "One Or More" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0132326", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D019829", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB00238", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000712787", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "99DK7FVK1H", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "99DK7FVK1H", + "display": "NVP" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4020991", + "display": "NVP" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C29277", + "display": "NVP" + }, + { + "system": "http://snomed.info/sctv", + "code": "108704001", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "75157", + "display": "NVP" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AG01", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "006062", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "eiK..", + "display": "NVP" + }, + { + "system": "http://loinc.org", + "code": "LP21317-0", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "175112", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh2010013984", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000016392", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "2030", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "4007-0088", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "53654", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m56485", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000656", + "display": "NVP" + } + ], + "text": "NVP" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0043474", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000040121", + "display": "AZT" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C947", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D015215", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "2109-4800", + "display": "AZT" + }, + { + "system": "http://snomed.info/sctv", + "code": "387151007", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "05223", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "41905", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB00495", + "display": "AZT" + }, + { + "system": "http://snomed.info/sct", + "code": "C-55B60", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "ei5..", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000013273", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000044478", + "display": "AZT" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4019502", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "11413", + "display": "AZT" + }, + { + "system": "http://loinc.org", + "code": "LP16744-2", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_dtp", + "code": "NSC0602670", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m89510", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "4B9XT59T7S", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "2650", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_ctrp", + "code": "C947", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "4B9XT59T7S", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "d00034", + "display": "AZT" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AF01", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000671", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "003019", + "display": "AZT" + } + ], + "text": "AZT" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "8eddc9da-cdfc-43d9-a9fc-5306d66362f3", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#1d943af4-3b3e-4363-9e82-bc0e59b8c3e1", + "type": "Group" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "SymptomOrSign" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0282474", + "display": "mother-to-child transmission" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D018445", + "display": "mother-to-child transmission" + } + ], + "text": "mother-to-child transmission" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "4ee79ae8-bf19-4474-a72e-3616ac0a9fdf", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationClass" + } + ], + "text": "ARVs" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#8eddc9da-cdfc-43d9-a9fc-5306d66362f3", + "type": "Group" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "583a9867-c95e-4225-bd19-47c324e26c0f", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "ExaminationName" + } + ], + "text": "Plasma viral load" + }, + "valueQuantity": { + "value": 100000, + "comparator": ">" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "35d36257-564c-48e0-9c65-b2551870b0bb", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0132326", + "display": "with NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D005838", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "20920", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000005452", + "display": "genotypic" + }, + { + "system": "http://loinc.org", + "code": "LP345004-8", + "display": "genotypic" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C16631", + "display": "genotypic" + }, + { + "system": "http://snomed.info/sctv", + "code": "145681002", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000660739", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000002877", + "display": "genotypic" + }, + { + "system": "http://snomed.info/sct", + "code": "F-E0280", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1258-5784", + "display": "genotypic" + } + ], + "text": "genotypic" + }, + "valueCodeableConcept": { + "text": "value:" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "SymptomOrSign" + } + ], + "text": "non-nucleoside reverse transcriptase inhibitor resistance" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "bdcbe31b-c0f7-4205-9b75-34a8418cfdb2", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "one-or-more", + "display": "One Or More" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "Diagnosis" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0041296", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medlineplus", + "code": "41", + "display": "tuberculosis" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C3423", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "31051", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000012630", + "display": "tuberculosis" + }, + { + "system": "http://snomed.info/sctv", + "code": "56717001", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "A1...", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D014376", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/cst", + "code": "INFECT", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000513048", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU076452", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10021870", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/who", + "code": "0923", + "display": "tuberculosis" + }, + { + "system": "http://snomed.info/sct", + "code": "DE-14800", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "A15-A19", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/bi", + "code": "BI00198", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/dxp", + "code": "U004166", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C3423", + "display": "tuberculosis" + }, + { + "system": "http://loinc.org", + "code": "LA10513-2", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh85138408", + "display": "tuberculosis" + }, + { + "system": "http://snomed.info/sct", + "code": "D-0188", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch", + "code": "U004809", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "A70012", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "A15-A19.9", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "A15-A19.9", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccs", + "code": "1", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccs_10", + "code": "1", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_cptac", + "code": "C3423", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "0368-2498", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000004838", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "010-018.99", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc2eeng", + "code": "A70", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "754", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1018255", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "54410", + "display": "tuberculosis" + } + ], + "text": "tuberculosis" + }, + "valueCodeableConcept": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "ConditionQualifier" + } + ], + "text": "active" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "TreatmentName" + } + ], + "text": "treated for tuberculosis" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "47519-4", + "display": "History of Procedures" + } + ], + "text": "History of Procedures" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "2a43edc4-0000-0000-0000-000000000000", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "Diagnosis" + } + ], + "text": "human immuno deficiency virus infection" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "ExaminationName" + } + ], + "text": "HIV-1 plasma viral load" + }, + "valueQuantity": { + "value": 500, + "unit": "HIV-1" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#c31f130b-c0e7-411a-a32b-57f07ea62559", + "type": "Group" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#4ee79ae8-bf19-4474-a72e-3616ac0a9fdf", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#583a9867-c95e-4225-bd19-47c324e26c0f", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#35d36257-564c-48e0-9c65-b2551870b0bb", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "TreatmentName" + } + ], + "text": "disallowed concomitant therapy" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "47519-4", + "display": "History of Procedures" + } + ], + "text": "History of Procedures" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "Diagnosis" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0001175", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "B20", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ram", + "code": "DX272", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/qmr", + "code": "R0121441", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "A788z", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://snomed.info/sctv", + "code": "186715004", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "1684", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000000649", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc", + "code": "B90", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10000563", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "31779", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "00595", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C2851", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D000163", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000023174", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C2851", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/cst", + "code": "HIV SYND", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "B90001", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc2eeng", + "code": "B90", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_cptac", + "code": "C2851", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medlineplus", + "code": "1", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/bi", + "code": "BI00716", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://snomed.info/sct", + "code": "DE-36310", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/who", + "code": "1233", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU080583", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000044365", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1560-6271", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "042", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "023", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://loinc.org", + "code": "LA10430-9", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1014998", + "display": "Acquired Immunodeficiency Syndrome" + } + ], + "text": "Acquired Immunodeficiency Syndrome" + }, + "valueCodeableConcept": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "ConditionQualifier" + } + ], + "text": "currently active" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#bdcbe31b-c0f7-4205-9b75-34a8418cfdb2", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "coding": [ + { + "system": "http://loinc.org", + "code": "63900-5", + "display": "age" + } + ], + "text": "age" + }, + "valueRange": { + "low": { + "value": 6, + "unit": "years", + "system": "http://unitsofmeasure.org", + "code": "a" + }, + "high": { + "value": 17, + "unit": "years", + "system": "http://unitsofmeasure.org", + "code": "a" + } + }, + "exclude": false + } + ] + } + ], + "identifier": [ + { + "use": "official", + "value": "CR002677", + "assigner": { + "display": "Janssen Sciences Ireland UC" + } + }, + { + "use": "usual", + "value": "NCTtesttest", + "assigner": { + "display": "ClinicalTrials.gov" + } + }, + { + "use": "secondary", + "value": "TMC278-TiDP38-C213" + }, + { + "use": "secondary", + "value": "2008-001696-30" + } + ], + "title": "A Study to Evaluate the Pharmacokinetics, Safety, Tolerability, and Antiviral Efficacy of Rilpivirine (TMC278) in Human Immunodeficiency Virus Infected Adolescents and Children Aged Greater Than or Equal to 6 Years", + "protocol": [ + { + "reference": "#1b5bc5d5-9413-43f7-9da6-70db2606b7cd", + "type": "PlanDefinition", + "display": "Rilpivirine" + }, + { + "reference": "#30f45f8a-a0f5-4eed-a5e1-4819137c10b2", + "type": "PlanDefinition", + "display": "Zidovudine" + }, + { + "reference": "#8958e19c-17db-4152-874d-cf68c3918769", + "type": "PlanDefinition", + "display": "Abacavir" + }, + { + "reference": "#bef1c7b6-1e1a-4fb4-8bcd-b9d965dd09e6", + "type": "PlanDefinition", + "display": "Tenofovir disoproxil fumarate" + }, + { + "reference": "#ec554338-0167-4034-98dd-ee1cd5860430", + "type": "PlanDefinition", + "display": "Lamivudine" + }, + { + "reference": "#8ddc695e-efab-441e-bd49-c1decfdb80bf", + "type": "PlanDefinition", + "display": "Emtricitabine" + } + ], + "status": "active", + "primaryPurposeType": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/research-study-prim-purp-type", + "version": "4.0.0", + "code": "treatment", + "display": "Treatment" + } + ], + "text": "Treatment" + }, + "phase": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/research-study-phase", + "version": "4.0.0", + "code": "phase-2", + "display": "Phase 2" + } + ], + "text": "Phase 2" + }, + "category": [ + { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/research-study-prim-purp-type", + "version": "4.0.0", + "code": "treatment", + "display": "Treatment" + } + ], + "text": "Treatment" + }, + { + "coding": [ + { + "system": "http://clinicaltrials.gov", + "code": "Interventional", + "display": "Interventional" + } + ], + "text": "Interventional" + }, + { + "coding": [ + { + "system": "http://clinicaltrials.gov", + "code": "Single Group Assignment", + "display": "Single Group Assignment" + } + ], + "text": "Single Group Assignment" + }, + { + "coding": [ + { + "system": "http://clinicaltrials.gov", + "code": "None (Open Label)", + "display": "None (Open Label)" + } + ], + "text": "None (Open Label)" + }, + { + "coding": [ + { + "system": "http://clinicaltrials.gov", + "code": "NoneRetained", + "display": "NoneRetained" + } + ], + "text": "NoneRetained" + } + ], + "focus": [ + { + "text": "Drug" + } + ], + "condition": [ + { + "text": "Human Immuno Deficiency (HIV) Infection" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0021051", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sctv", + "code": "234532001", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "39922", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000045724", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "D-4600", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1560-5885", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10021460", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000006602", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C3131", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hpo", + "code": "HP:0002721", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/omim", + "code": "MTHU032911", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "234532001", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "B99011", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "2156", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D007153", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C39725", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "279.3", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "X20GZ", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "F-C0450", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "U000355", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://loinc.org", + "code": "MTHU054768", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nanda-i", + "code": "02515", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh85064574", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1007151", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU037620", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000004832", + "display": "Immunologic Deficiency Syndromes" + } + ], + "text": "Immunologic Deficiency Syndromes" + } + ], + "contact": [ + { + "name": "Use link at the bottom of the page to see if you qualify for an enrolling site (see list). If you still have questions:", + "telecom": [ + { + "system": "email", + "value": "JNJ.CT@sylogent.com", + "use": "work" + } + ] + }, + { + "name": "StudyDirector Janssen Sciences Ireland UC Clinical Trial" + } + ], + "keyword": [ + { + "text": "HIV Infection" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0599685", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D044966", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "250564", + "display": "Antiretroviral" + }, + { + "system": "http://snomed.info/sctv", + "code": "713540004", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "0715-4905", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh2003006231", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000042059", + "display": "Antiretroviral" + } + ], + "text": "Antiretroviral" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0019704", + "display": "HIV-1" + }, + { + "system": "http://snomed.info/sctv", + "code": "243598007", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_cdisc", + "code": "C14220", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_ctrp", + "code": "C14220", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "X73kd", + "display": "HIV-1" + }, + { + "system": "http://loinc.org", + "code": "MTHU009425", + "display": "HIV-1" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C14220", + "display": "HIV-1" + }, + { + "system": "http://snomed.info/sct", + "code": "L-35211", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10020455", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "3130-7357", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D015497", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ncbi", + "code": "11676", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000006190", + "display": "HIV-1" + } + ], + "text": "HIV-1" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0001175", + "display": "AIDS" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "B20", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ram", + "code": "DX272", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/qmr", + "code": "R0121441", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "A788z", + "display": "AIDS" + }, + { + "system": "http://snomed.info/sctv", + "code": "186715004", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "1684", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000000649", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc", + "code": "B90", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10000563", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "31779", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "00595", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C2851", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D000163", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000023174", + "display": "AIDS" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C2851", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/cst", + "code": "HIV SYND", + "display": "AIDS" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "B90001", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc2eeng", + "code": "B90", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_cptac", + "code": "C2851", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medlineplus", + "code": "1", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/bi", + "code": "BI00716", + "display": "AIDS" + }, + { + "system": "http://snomed.info/sct", + "code": "DE-36310", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/who", + "code": "1233", + "display": "AIDS" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU080583", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000044365", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1560-6271", + "display": "AIDS" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "042", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "023", + "display": "AIDS" + }, + { + "system": "http://loinc.org", + "code": "LA10430-9", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1014998", + "display": "AIDS" + } + ], + "text": "AIDS" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0008059", + "display": "Children" + }, + { + "system": "http://snomed.info/sct", + "code": "S-10170", + "display": "Children" + }, + { + "system": "http://snomed.info/sctv", + "code": "67822003", + "display": "Children" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C16423", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh85023418", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000007008", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D002648", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000002765", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "0060058", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "0635-1343", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch", + "code": "U005340", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hl7v3.0", + "code": "CHD", + "display": "Children" + }, + { + "system": "http://loinc.org", + "code": "LA9949-4", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C16423", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/dxp", + "code": "U000730", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "C16423", + "display": "Children" + } + ], + "text": "Children" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C1566826", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "309423", + "display": "Rilpivirine" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AG05", + "display": "Rilpivirine" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C76929", + "display": "Rilpivirine" + }, + { + "system": "http://snomed.info/sctv", + "code": "703777002", + "display": "Rilpivirine" + }, + { + "system": "http://loinc.org", + "code": "MTHU042155", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB08864", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "d07776", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "FI96A8X663", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "FI96A8X663", + "display": "Rilpivirine" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4030730", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "1102270", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "4688", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m7163", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D000068696", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU002683", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "013795", + "display": "Rilpivirine" + } + ], + "text": "Rilpivirine (TMC278)" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C1521725", + "display": "Pediatric" + }, + { + "system": "http://loinc.org", + "code": "LP100615-6", + "display": "Pediatric" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C39299", + "display": "Pediatric" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000046245", + "display": "Pediatric" + } + ], + "text": "Pediatric" + }, + { + "text": "Human Immuno Deficiency (HIV) Infection" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0021051", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sctv", + "code": "234532001", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "39922", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000045724", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "D-4600", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1560-5885", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10021460", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000006602", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C3131", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hpo", + "code": "HP:0002721", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/omim", + "code": "MTHU032911", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "234532001", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "B99011", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "2156", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D007153", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C39725", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "279.3", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "X20GZ", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "F-C0450", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "U000355", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://loinc.org", + "code": "MTHU054768", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nanda-i", + "code": "02515", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh85064574", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1007151", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU037620", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000004832", + "display": "Immunologic Deficiency Syndromes" + } + ], + "text": "Immunologic Deficiency Syndromes" + }, + { + "coding": [ + { + "system": "http://hl7.org/fhir/administrative-gender", + "code": "Unknown", + "display": "Unknown" + } + ], + "text": "Unknown" + }, + { + "coding": [ + { + "system": "http://decades-value-set.ctm.microsoft.org", + "code": "0", + "display": "Age keyword for indexing - 0" + } + ], + "text": "Age keyword for indexing - 0" + }, + { + "coding": [ + { + "system": "http://decades-value-set.ctm.microsoft.org", + "code": "10", + "display": "Age keyword for indexing - 10" + } + ], + "text": "Age keyword for indexing - 10" + } + ], + "description": "This is a Phase II, open-label (all people involved know the identity of the assigned drug)\r\n and single arm study. The study will consist of a screening period of maximum 8 weeks, an\r\n initial treatment period of 48 weeks, a post week 48 treatment extension period of 4 years,\r\n and a 4 week follow-up period. A follow-up period will take place regardless of the presence\r\n of serious adverse events (SAEs) if patients withdraw early (ie, before Week 48) or if\r\n patients do not participate in the extension after Week 48; after Week 48, a 4-week follow-up\r\n visit is only required in case of ongoing (S)AEs at the final on treatment visit. The initial\r\n 48-week treatment period will be structured into 2 age Cohorts; Cohort 1 (Aged greater than\r\n or equal to [>=] 12 to less than [<] 18 years) and Cohort 2 (Children Aged >= 6 to < 12\r\n years) and each Cohort will have 2 parts. The first part of the trial (Part 1) is designed to\r\n evaluate the steady-state pharmacokinetic (PK) profile and the short-term safety and\r\n antiviral activity of rilpivirine 25 mg or adjusted dose once daily when administered in\r\n combination with 2 NRTIs. At Week 2/4, intensive PK will be done and an analysis together\r\n with short-term safety and antiviral activity will be reviewed by a data monitoring committee\r\n (DMC). For adolescents (Cohort 1) if the mean steady-state exposure in this first group of\r\n patients is comparable to that of the adult population (ie, is within 80-125 percentage of\r\n the mean exposure of the 25 mg once daily dose group in study, TMC278-C204), and the Week 2/4\r\n safety and antiviral activity results have been reviewed and deemed satisfactory by the DMC,\r\n the second part of the trial will start. The second part of the trial will evaluate long-term\r\n (48 weeks and 240 weeks) safety, efficacy, and pharmacokinetics of rilpivirine in combination\r\n with the background regimen of 2 NRTIs with a primary analysis time point at 24 weeks. For\r\n patients aged greater than or equal to (>=) 6 to less than (<) 12 years (Cohort 2), after\r\n being treated for at least 4 weeks and the Week 2 intensive PK and Week 4 safety and\r\n antiviral activity have been reviewed and results are satisfactory, recruitment in Part 1\r\n will resume and additional subjects will be enrolled to have at least 10 subjects in Part 1.\r\n Once an appropriate RPV dose has been selected, Part 1 of Cohort 2 will be considered\r\n complete and Part 2 will start. All patients from Part 1 will roll over in Part 2 and\r\n additional patients will be recruited in Part 2 to have at least 25 subjects (including those\r\n from Part 1) overall. In both cohorts of the trial, the ART will consist of rilpivirine 25 mg\r\n or adjusted dose once daily and an investigator-selected background regimen containing 2\r\n NRTIs. Patients safety will be monitored throughout the study and during the follow up\r\n visits.", + "enrollment": [ + { + "reference": "#2a43edc4-0000-0000-0000-000000000000", + "type": "Group" + } + ], + "period": { + "start": "2011-01", + "end": "2027-08" + }, + "arm": [ + { + "name": "Rilpivirine (TMC278)", + "type": { + "text": "Experimental" + }, + "description": "The patients will receive rilpivirine with 2 nucleoside/nucleotide reverse transcriptase inhibitors (NRTIs) as a background regimen in Cohort 1 [Aged greater than or equal to (> =) 12 to less than (<) 18 years] and Cohort 2 (children aged > = 6 to < 12 years). The NRTIs includes zidovudine, abacavir, or tenofovir disoproxil fumarate in combination with lamivudine or emtricitabine." + } + ] + } + ], + "registryFilters": [ + { + "studyTypes": [ + "interventional", + "observational" + ], + "recruitmentStatuses": [ + "recruiting", + "enrollingByInvitation" + ], + "phases": [ + "phase2", + "phase3" + ], + "purposes": [ + "diagnostic", + "prevention", + "basicScience" + ], + "sources": [ + "clinicaltrials.gov" + ], + "facilityLocations": [ + { + "city": "Basel", + "countryOrRegion": "Switzerland" + }, + { + "city": "Allschwil", + "countryOrRegion": "Switzerland" + } + ] + }, + { + "sponsors": [ + "Janssen" + ], + "sources": [ + "clinicaltrials.gov" + ], + "facilityAreas": [ + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + 7.588576, + 47.559601 + ] + }, + "properties": { + "subType": "Circle", + "radius": 80000 + } + } + ] + }, + { + "ids": [ + "NCT04006015", + "NCT04545788", + "NCT04773711" + ], + "sources": [ + "clinicaltrials.gov" + ] + } + ] + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "c7e9a8d7-6b5f-4e3d-9a2c-1f8b0e2c3f4a", + "Operation-Location": "{endpoint}/health-insights/trial-matcher/jobs/{id}?api-version=2024-08-01-preview" + }, + "body": { + "status": "notStarted", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12" + } + }, + "201": { + "headers": { + "x-ms-request-id": "c7e9a8d7-6b5f-4e3d-9a2c-1f8b0e2c3f4a", + "Operation-Location": "{endpoint}/health-insights/trial-matcher/jobs/{id}?api-version=2024-08-01-preview" + }, + "body": { + "status": "notStarted", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12" + } + } + } +} diff --git a/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulTrialMatcherResponse.json b/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulTrialMatcherResponse.json new file mode 100644 index 000000000000..5f4be4dcee12 --- /dev/null +++ b/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulTrialMatcherResponse.json @@ -0,0 +1,116 @@ +{ + "operationId": "TrialMatcher_GetJob", + "title": "Gets the status and details of the Trial Matcher job.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-08-01-preview", + "id": "a4d3d73e-2be3-4ca1-bd4f-66a5bdd19754" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "c7e9a8d7-6b5f-4e3d-9a2c-1f8b0e2c3f4a" + }, + "body": { + "id": "a4d3d73e-2be3-4ca1-bd4f-66a5bdd19754", + "createdAt": "2021-11-28T09:13:11.046Z", + "expiresAt": "2021-11-28T09:13:11.046Z", + "updatedAt": "2021-11-28T09:13:11.046Z", + "status": "succeeded", + "result": { + "patientResults": [ + { + "patientId": "Patient ID Example 2", + "inferences": [ + { + "type": "trialEligibility", + "value": "Eligible", + "description": "SwEaTB - Diagnosing of Acute Tuberculosis", + "confidenceScore": 1, + "evidence": [ + { + "eligibilityCriteriaEvidence": "In-patients with acute tuberculosis", + "patientInfoEvidence": { + "system": "UMLS", + "code": "C0019046", + "name": "tuberculosis" + }, + "importance": 1 + } + ], + "clinicalTrialId": "NCT03667742", + "source": "clinicaltrials.gov", + "metadata": { + "phases": [ + "phase3" + ], + "studyType": "observational", + "recruitmentStatus": "recruiting", + "conditions": [ + "Tuberculosis" + ], + "sponsors": [ + "University Hospital, Basel, Switzerland" + ], + "contacts": [ + { + "name": "John Doe, PD Dr. Med", + "email": "John@contoso.com", + "phone": "+55-555-5555-55" + } + ], + "facilities": [ + { + "name": "University Hospital, Basel", + "city": "Basel", + "countryOrRegion": "Switzerland" + } + ] + } + }, + { + "type": "trialEligibility", + "value": "Ineligible", + "description": "Design of an Integrative Algorithm for Staging Tuberculosis (STAGE-TB)", + "confidenceScore": 1, + "evidence": [ + { + "eligibilityCriteriaEvidence": "negative for Quantiferon- TB Gold Plus Test or ELISpot", + "patientInfoEvidence": { + "system": "UMLS", + "code": "C0920508", + "name": "Enzyme-Linked Immunospot Assay", + "value": "30,000 PBMC cells per 10ul" + }, + "importance": 1 + } + ], + "clinicalTrialId": "NCT03691883", + "source": "clinicaltrials.gov" + } + ], + "neededClinicalInfo": [ + { + "system": "UMLS", + "code": "C4317078", + "name": "Mycobacterium Tuberculosis Measurement ", + "semanticType": "Laboratory Procedure", + "category": "EXAMINATION_NAME" + }, + { + "system": "UMLS", + "code": "C0008031", + "name": "Chest Pain", + "semanticType": "Sign or Symptom", + "category": "SYMPTOM_OR_SIGN" + } + ] + } + ], + "modelVersion": "2021-10-28", + "knowledgeGraphLastUpdateDate": "2021-11-26" + } + } + } + } +} diff --git a/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/openapi.json b/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/openapi.json new file mode 100644 index 000000000000..a991c447368a --- /dev/null +++ b/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/openapi.json @@ -0,0 +1,4082 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure AI Health Insights", + "version": "2024-08-01-preview", + "description": "Azure AI Health Insights provides an API that serves insight models, specific for Health & Life Sciences, that perform analysis and provide inferences to be used by a human.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/health-insights", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com).", + "required": true, + "type": "string", + "format": "uri", + "x-ms-skip-url-encoding": true + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "AzureKey": [] + }, + { + "EntraIdToken": [ + "https://cognitiveservices.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "AzureKey": { + "type": "apiKey", + "description": "The secret key for your Azure Cognitive Services subscription.", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + }, + "EntraIdToken": { + "type": "oauth2", + "description": "The Microsoft Entra Id Flow", + "flow": "accessCode", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://cognitiveservices.azure.com/.default": "" + }, + "tokenUrl": "https://login.microsoftonline.com/common/oauth2/token" + } + }, + "tags": [ + { + "name": "RadiologyInsights" + }, + { + "name": "TrialMatcher" + } + ], + "paths": { + "/radiology-insights/jobs/{id}": { + "get": { + "operationId": "RadiologyInsights_GetJob", + "tags": [ + "RadiologyInsights" + ], + "summary": "Get Radiology Insights job details", + "description": "Gets the status and details of the Radiology Insights job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "id", + "in": "path", + "description": "The unique ID of the job.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]+[a-zA-Z0-9]$" + }, + { + "$ref": "#/parameters/Azure.Core.ExpandQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/RadiologyInsightsJob" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/HealthInsightsErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + } + }, + "x-ms-examples": { + "Gets the status and details of the Radiology Insights job.": { + "$ref": "./examples/SuccessfulRadiologyInsightsResponse.json" + } + } + }, + "put": { + "operationId": "RadiologyInsights_CreateJob", + "tags": [ + "RadiologyInsights" + ], + "summary": "Create Radiology Insights job", + "description": "Creates a Radiology Insights job with the given request body.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "id", + "in": "path", + "description": "The unique ID of the job.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]+[a-zA-Z0-9]$" + }, + { + "$ref": "#/parameters/Azure.Core.ExpandQueryParameter" + }, + { + "name": "resource", + "in": "body", + "description": "The resource instance.", + "required": true, + "schema": { + "$ref": "#/definitions/RadiologyInsightsJob" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/RadiologyInsightsJob" + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/RadiologyInsightsJob" + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/HealthInsightsErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + } + }, + "x-ms-examples": { + "Creates a Radiology Insights job with the given request body.": { + "$ref": "./examples/SuccessfulRadiologyInsightsRequest.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/trial-matcher/jobs/{id}": { + "get": { + "operationId": "TrialMatcher_GetJob", + "tags": [ + "TrialMatcher" + ], + "summary": "Get Trial Matcher job details", + "description": "Gets the status and details of the Trial Matcher job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "id", + "in": "path", + "description": "The unique ID of the job.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]+[a-zA-Z0-9]$" + }, + { + "$ref": "#/parameters/Azure.Core.ExpandQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TrialMatcherJob" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/HealthInsightsErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + } + }, + "x-ms-examples": { + "Gets the status and details of the Trial Matcher job.": { + "$ref": "./examples/SuccessfulTrialMatcherResponse.json" + } + } + }, + "put": { + "operationId": "TrialMatcher_CreateJob", + "tags": [ + "TrialMatcher" + ], + "summary": "Create Trial Matcher job", + "description": "Creates a Trial Matcher job with the given request body.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "id", + "in": "path", + "description": "The unique ID of the job.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]+[a-zA-Z0-9]$" + }, + { + "$ref": "#/parameters/Azure.Core.ExpandQueryParameter" + }, + { + "name": "resource", + "in": "body", + "description": "The resource instance.", + "required": true, + "schema": { + "$ref": "#/definitions/TrialMatcherJob" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TrialMatcherJob" + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/TrialMatcherJob" + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/HealthInsightsErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + } + }, + "x-ms-examples": { + "Creates a Trial Matcher job with the given request body.": { + "$ref": "./examples/SuccessfulTrialMatcherRequest.json" + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AgeMismatchInference": { + "type": "object", + "description": "A notification for age mismatch is displayed when the age mentioned in a document for a specific patient does not match the age specified in the patient information.", + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "ageMismatch" + }, + "AreaGeometry": { + "type": "object", + "description": "`GeoJSON` geometry, representing the area circle's center.", + "properties": { + "type": { + "$ref": "#/definitions/GeoJsonGeometryType", + "description": "`GeoJSON` geometry type." + }, + "coordinates": { + "type": "array", + "description": "Coordinates of the area circle's center, represented according to the `GeoJSON` standard.\nThis is an array of 2 decimal numbers, longitude and latitude (precisely in this order).", + "minItems": 2, + "maxItems": 2, + "items": { + "type": "number", + "format": "float" + } + } + }, + "required": [ + "type", + "coordinates" + ] + }, + "AreaProperties": { + "type": "object", + "description": "`GeoJSON` object properties.", + "properties": { + "subType": { + "$ref": "#/definitions/GeoJsonPropertiesSubType", + "description": "`GeoJSON` object sub-type." + }, + "radius": { + "type": "number", + "format": "double", + "description": "The radius of the area's circle, in meters." + } + }, + "required": [ + "subType", + "radius" + ] + }, + "Azure.Core.Foundations.Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "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/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "Azure.Core.Foundations.InnerError": { + "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.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "Inner error." + } + } + }, + "ClinicalCodedElement": { + "type": "object", + "description": "A piece of clinical information, expressed as a code in a clinical coding system.", + "properties": { + "system": { + "type": "string", + "description": "The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS." + }, + "code": { + "type": "string", + "description": "The code within the given clinical coding system." + }, + "name": { + "type": "string", + "description": "The name of this coded concept in the coding system." + }, + "value": { + "type": "string", + "description": "A value associated with the code within the given clinical coding system." + } + }, + "required": [ + "system", + "code" + ] + }, + "ClinicalDocumentType": { + "type": "string", + "description": "The type of the clinical document.", + "enum": [ + "consultation", + "dischargeSummary", + "historyAndPhysical", + "radiologyReport", + "procedure", + "progress", + "laboratory", + "pathologyReport" + ], + "x-ms-enum": { + "name": "ClinicalDocumentType", + "modelAsString": true, + "values": [ + { + "name": "Consultation", + "value": "consultation" + }, + { + "name": "DischargeSummary", + "value": "dischargeSummary" + }, + { + "name": "HistoryAndPhysical", + "value": "historyAndPhysical" + }, + { + "name": "RadiologyReport", + "value": "radiologyReport" + }, + { + "name": "Procedure", + "value": "procedure" + }, + { + "name": "Progress", + "value": "progress" + }, + { + "name": "Laboratory", + "value": "laboratory" + }, + { + "name": "PathologyReport", + "value": "pathologyReport" + } + ] + } + }, + "ClinicalNoteEvidence": { + "type": "object", + "description": "A piece of evidence from a clinical note (text document).", + "properties": { + "id": { + "type": "string", + "description": "The identifier of the document containing the evidence." + }, + "text": { + "type": "string", + "description": "The actual text span which is evidence for the inference." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The start index of the evidence text span in the document (0 based).", + "minimum": 0 + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the evidence text span.", + "minimum": 1 + } + }, + "required": [ + "id", + "offset", + "length" + ] + }, + "ClinicalTrialMetadata": { + "type": "object", + "description": "Trial data which is of interest to the potential participant.", + "properties": { + "phases": { + "type": "array", + "description": "Phases which are relevant for the clinical trial.\nEach clinical trial can be in a certain phase or in multiple phases.", + "items": { + "$ref": "#/definitions/ClinicalTrialPhase" + } + }, + "studyType": { + "$ref": "#/definitions/ClinicalTrialStudyType", + "description": "Possible study types of a clinical trial." + }, + "recruitmentStatus": { + "$ref": "#/definitions/ClinicalTrialRecruitmentStatus", + "description": "Possible recruitment status of a clinical trial." + }, + "conditions": { + "type": "array", + "description": "Medical conditions and their synonyms which are relevant for the clinical trial, given as strings.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "sponsors": { + "type": "array", + "description": "Sponsors/collaborators involved with the trial.", + "items": { + "type": "string" + } + }, + "contacts": { + "type": "array", + "description": "Contact details of the trial administrators, for patients that want to participate in the trial.", + "items": { + "$ref": "#/definitions/ContactDetails" + }, + "x-ms-identifiers": [] + }, + "facilities": { + "type": "array", + "description": "Research facilities where the clinical trial is conducted.", + "items": { + "$ref": "#/definitions/ClinicalTrialResearchFacility" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "conditions" + ] + }, + "ClinicalTrialPhase": { + "type": "string", + "description": "Possible phases of a clinical trial.", + "enum": [ + "notApplicable", + "earlyPhase1", + "phase1", + "phase2", + "phase3", + "phase4" + ], + "x-ms-enum": { + "name": "ClinicalTrialPhase", + "modelAsString": true, + "values": [ + { + "name": "NotApplicable", + "value": "notApplicable" + }, + { + "name": "EarlyPhase1", + "value": "earlyPhase1" + }, + { + "name": "Phase1", + "value": "phase1" + }, + { + "name": "Phase2", + "value": "phase2" + }, + { + "name": "Phase3", + "value": "phase3" + }, + { + "name": "Phase4", + "value": "phase4" + } + ] + } + }, + "ClinicalTrialPurpose": { + "type": "string", + "description": "Possible purposes of a clinical trial.", + "enum": [ + "notApplicable", + "screening", + "diagnostic", + "prevention", + "healthServicesResearch", + "treatment", + "deviceFeasibility", + "supportiveCare", + "basicScience", + "other" + ], + "x-ms-enum": { + "name": "ClinicalTrialPurpose", + "modelAsString": true, + "values": [ + { + "name": "NotApplicable", + "value": "notApplicable" + }, + { + "name": "Screening", + "value": "screening" + }, + { + "name": "Diagnostic", + "value": "diagnostic" + }, + { + "name": "Prevention", + "value": "prevention" + }, + { + "name": "HealthServicesResearch", + "value": "healthServicesResearch" + }, + { + "name": "Treatment", + "value": "treatment" + }, + { + "name": "DeviceFeasibility", + "value": "deviceFeasibility" + }, + { + "name": "SupportiveCare", + "value": "supportiveCare" + }, + { + "name": "BasicScience", + "value": "basicScience" + }, + { + "name": "Other", + "value": "other" + } + ] + } + }, + "ClinicalTrialRecruitmentStatus": { + "type": "string", + "description": "Possible recruitment status of a clinical trial.", + "enum": [ + "unknownStatus", + "notYetRecruiting", + "recruiting", + "enrollingByInvitation" + ], + "x-ms-enum": { + "name": "ClinicalTrialRecruitmentStatus", + "modelAsString": true, + "values": [ + { + "name": "UnknownStatus", + "value": "unknownStatus" + }, + { + "name": "NotYetRecruiting", + "value": "notYetRecruiting" + }, + { + "name": "Recruiting", + "value": "recruiting" + }, + { + "name": "EnrollingByInvitation", + "value": "enrollingByInvitation" + } + ] + } + }, + "ClinicalTrialRegistryFilter": { + "type": "object", + "description": "A filter defining a subset of clinical trials from a given clinical trial registry (e.g. clinicaltrials.gov).", + "properties": { + "conditions": { + "type": "array", + "description": "Trials with any of the given medical conditions will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the medical conditions.", + "items": { + "type": "string" + } + }, + "studyTypes": { + "type": "array", + "description": "Trials with any of the given study types will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the study types.", + "items": { + "$ref": "#/definitions/ClinicalTrialStudyType" + } + }, + "recruitmentStatuses": { + "type": "array", + "description": "Trials with any of the given recruitment statuses will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the recruitment statuses.", + "items": { + "$ref": "#/definitions/ClinicalTrialRecruitmentStatus" + } + }, + "sponsors": { + "type": "array", + "description": "Trials with any of the given sponsors will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the sponsors.", + "items": { + "type": "string" + } + }, + "phases": { + "type": "array", + "description": "Trials with any of the given phases will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the phases.", + "items": { + "$ref": "#/definitions/ClinicalTrialPhase" + } + }, + "purposes": { + "type": "array", + "description": "Trials with any of the given purposes will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the purposes.", + "items": { + "$ref": "#/definitions/ClinicalTrialPurpose" + } + }, + "ids": { + "type": "array", + "description": "Trials with any of the given identifiers will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the trial identifiers.", + "items": { + "type": "string" + } + }, + "sources": { + "type": "array", + "description": "Trials with any of the given sources will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the sources.", + "items": { + "$ref": "#/definitions/ClinicalTrialSource" + } + }, + "facilityNames": { + "type": "array", + "description": "Trials with any of the given facility names will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the trial facility names.", + "items": { + "type": "string" + } + }, + "facilityLocations": { + "type": "array", + "description": "Trials with any of the given facility locations will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the trial facility locations.", + "items": { + "$ref": "#/definitions/GeographicLocation" + }, + "x-ms-identifiers": [] + }, + "facilityAreas": { + "type": "array", + "description": "Trials with any of the given facility area boundaries will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the trial facility area boundaries.", + "items": { + "$ref": "#/definitions/GeographicArea" + }, + "x-ms-identifiers": [] + } + } + }, + "ClinicalTrialResearchFacility": { + "type": "object", + "description": "Details of a research facility where a clinical trial is conducted.", + "properties": { + "name": { + "type": "string", + "description": "The facility's name." + }, + "city": { + "type": "string", + "description": "City name." + }, + "state": { + "type": "string", + "description": "State name." + }, + "countryOrRegion": { + "type": "string", + "description": "Country/region name." + } + }, + "required": [ + "name", + "countryOrRegion" + ] + }, + "ClinicalTrialSource": { + "type": "string", + "description": "Possible sources of a clinical trial.", + "enum": [ + "custom", + "clinicaltrials.gov" + ], + "x-ms-enum": { + "name": "ClinicalTrialSource", + "modelAsString": true, + "values": [ + { + "name": "Custom", + "value": "custom" + }, + { + "name": "ClinicaltrialsGov", + "value": "clinicaltrials.gov" + } + ] + } + }, + "ClinicalTrialStudyType": { + "type": "string", + "description": "Possible study types of a clinical trial.", + "enum": [ + "interventional", + "observational", + "expandedAccess", + "patientRegistries" + ], + "x-ms-enum": { + "name": "ClinicalTrialStudyType", + "modelAsString": true, + "values": [ + { + "name": "Interventional", + "value": "interventional" + }, + { + "name": "Observational", + "value": "observational" + }, + { + "name": "ExpandedAccess", + "value": "expandedAccess" + }, + { + "name": "PatientRegistries", + "value": "patientRegistries" + } + ] + } + }, + "ClinicalTrials": { + "type": "object", + "description": "The clinical trials that the patient(s) should be matched to.\nThe trial selection can be given as a list of custom clinical trials and/or a list of filters to known clinical trial registries.\nIn case both are given, the resulting trial set is a union of the two sets.", + "properties": { + "customTrials": { + "type": "array", + "description": "A list of clinical trials.", + "minItems": 1, + "items": { + "$ref": "#/definitions/Fhir.R4.ResearchStudy" + } + }, + "registryFilters": { + "type": "array", + "description": "A list of filters, each one creating a selection of trials from a given\nclinical trial registry.", + "minItems": 1, + "items": { + "$ref": "#/definitions/ClinicalTrialRegistryFilter" + }, + "x-ms-identifiers": [] + } + } + }, + "CompleteOrderDiscrepancyInference": { + "type": "object", + "description": "A complete order discrepancy is shown when one or more body parts and/or measurements that should be in the document (because there is a complete order) are not present.", + "properties": { + "orderType": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Order type : CPT ultrasound complete code for abdomen, retroperitoneal, pelvis or breast." + }, + "missingBodyParts": { + "type": "array", + "description": "List of missing body parts required by a complete order : SNOMED CT codes.", + "minItems": 1, + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "missingBodyPartMeasurements": { + "type": "array", + "description": "List of missing body parts that require measurement by a complete order : SNOMED CT codes.", + "minItems": 1, + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + } + }, + "required": [ + "orderType" + ], + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "completeOrderDiscrepancy" + }, + "ContactDetails": { + "type": "object", + "description": "A person's contact details.", + "properties": { + "name": { + "type": "string", + "description": "The person's name." + }, + "email": { + "type": "string", + "description": "The person's email." + }, + "phone": { + "type": "string", + "description": "A person's phone number." + } + } + }, + "CriticalResult": { + "type": "object", + "description": "Critical Result consists of two properties.", + "properties": { + "description": { + "type": "string", + "description": "Description : medical problem." + }, + "finding": { + "$ref": "#/definitions/Fhir.R4.Observation", + "description": "Finding linked to the critical result." + } + }, + "required": [ + "description" + ] + }, + "CriticalResultInference": { + "type": "object", + "description": "Critical results refer to findings of utmost importance that may require timely attention due to their potential impact on patient care.", + "properties": { + "result": { + "$ref": "#/definitions/CriticalResult", + "description": "The complete Critical Result, as outlined below, will be reused for the recommendation." + } + }, + "required": [ + "result" + ], + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "criticalResult" + }, + "DocumentAdministrativeMetadata": { + "type": "object", + "description": "Document administrative metadata", + "properties": { + "orderedProcedures": { + "type": "array", + "description": "List of procedure information associated with the document.", + "minItems": 1, + "items": { + "$ref": "#/definitions/OrderedProcedure" + }, + "x-ms-identifiers": [] + }, + "encounterId": { + "type": "string", + "description": "Reference to the encounter associated with the document." + } + } + }, + "DocumentAuthor": { + "type": "object", + "description": "Document author", + "properties": { + "id": { + "type": "string", + "description": "author id" + }, + "fullName": { + "type": "string", + "description": "Text representation of the full name" + } + } + }, + "DocumentContent": { + "type": "object", + "description": "The content of the patient document.", + "properties": { + "sourceType": { + "$ref": "#/definitions/DocumentContentSourceType", + "description": "The type of the content's source.\nIn case the source type is 'inline', the content is given as a string (for instance, text).\nIn case the source type is 'reference', the content is given as a URI." + }, + "value": { + "type": "string", + "description": "The content of the document, given either inline (as a string) or as a reference (URI)." + } + }, + "required": [ + "sourceType", + "value" + ] + }, + "DocumentContentSourceType": { + "type": "string", + "description": "The type of the content's source.\nIn case the source type is 'inline', the content is given as a string (for instance, text).\nIn case the source type is 'reference', the content is given as a URI.", + "enum": [ + "inline", + "reference" + ], + "x-ms-enum": { + "name": "DocumentContentSourceType", + "modelAsString": true, + "values": [ + { + "name": "Inline", + "value": "inline", + "description": "The content is given as a string (for instance, text)." + }, + { + "name": "Reference", + "value": "reference", + "description": "The content is given as a URI." + } + ] + } + }, + "DocumentType": { + "type": "string", + "description": "The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON document).", + "enum": [ + "note", + "fhirBundle", + "dicom", + "genomicSequencing" + ], + "x-ms-enum": { + "name": "DocumentType", + "modelAsString": true, + "values": [ + { + "name": "Note", + "value": "note" + }, + { + "name": "FhirBundle", + "value": "fhirBundle" + }, + { + "name": "Dicom", + "value": "dicom" + }, + { + "name": "GenomicSequencing", + "value": "genomicSequencing" + } + ] + } + }, + "EncounterClass": { + "type": "string", + "description": "Known values codes that can be used to indicate the class of encounter (TODO://Based on FHIR value set--http://....).", + "enum": [ + "inpatient", + "ambulatory", + "observation", + "emergency", + "virtual", + "healthHome" + ], + "x-ms-enum": { + "name": "EncounterClass", + "modelAsString": true, + "values": [ + { + "name": "InPatient", + "value": "inpatient", + "description": "A patient encounter where a patient is admitted by a hospital or equivalent facility, assigned to a location where patients generally stay at least overnight and provided with room, board, and continuous nursing service." + }, + { + "name": "Ambulatory", + "value": "ambulatory", + "description": "The term ambulatory usually implies that the patient has come to the location and is not assigned to a bed. Sometimes referred to as an outpatient encounter." + }, + { + "name": "Observation", + "value": "observation", + "description": "An encounter where the patient usually will start in different encounter, such as one in the emergency department but then transition to this type of encounter because they require a significant period of treatment and monitoring to determine whether or not their condition warrants an inpatient admission or discharge." + }, + { + "name": "Emergency", + "value": "emergency", + "description": "A patient encounter that takes place at a dedicated healthcare service delivery location where the patient receives immediate evaluation and treatment, provided until the patient can be discharged or responsibility for the patient's care is transferred elsewhere (for example, the patient could be admitted as an inpatient or transferred to another facility." + }, + { + "name": "Virtual", + "value": "virtual", + "description": "A patient encounter where the patient is not physically present for the encounter, such as in a telehealth encounter, phone call, or electronic communication." + }, + { + "name": "HealthHome", + "value": "healthHome", + "description": "Healthcare encounter that takes place in the residence of the patient or a designee" + } + ] + } + }, + "ExtendedClinicalCodedElement": { + "type": "object", + "description": "A piece of clinical information, expressed as a code in a clinical coding system, extended by semantic information.", + "properties": { + "system": { + "type": "string", + "description": "The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS." + }, + "code": { + "type": "string", + "description": "The code within the given clinical coding system." + }, + "name": { + "type": "string", + "description": "The name of this coded concept in the coding system." + }, + "value": { + "type": "string", + "description": "A value associated with the code within the given clinical coding system." + }, + "semanticType": { + "type": "string", + "description": "The [UMLS semantic type](https://www.nlm.nih.gov/research/umls/META3_current_semantic_types.html) associated with the coded concept." + }, + "category": { + "type": "string", + "description": "The bio-medical category related to the coded concept, e.g. Diagnosis, Symptom, Medication, Examination." + } + }, + "required": [ + "system", + "code" + ] + }, + "Fhir.R4.Annotation": { + "type": "object", + "description": "A text note which also contains information about who made the statement and when\nBased on [FHIR Annotation](https://www.hl7.org/fhir/R4/datatypes.html#Annotation)", + "properties": { + "authorString": { + "type": "string", + "description": "Individual responsible for the annotation" + }, + "time": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "When the annotation was made" + }, + "text": { + "type": "string", + "description": "The annotation - text content (as markdown)" + } + }, + "required": [ + "text" + ], + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.CodeableConcept": { + "type": "object", + "description": "Concept - reference to a terminology or just text\nBased on [FHIR CodeableConcept](https://www.hl7.org/fhir/R4/datatypes.html#CodeableConcept)", + "properties": { + "coding": { + "type": "array", + "description": "Code defined by a terminology system", + "items": { + "$ref": "#/definitions/Fhir.R4.Coding" + } + }, + "text": { + "type": "string", + "description": "Plain text representation of the concept" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.Coding": { + "type": "object", + "description": "A Coding is a representation of a defined concept using a symbol from a defined \"code system\".\nBased on [FHIR Coding](https://www.hl7.org/fhir/R4/datatypes.html#Coding)", + "properties": { + "system": { + "$ref": "#/definitions/Fhir.R4.fhirUri", + "description": "Identity of the terminology system" + }, + "version": { + "type": "string", + "description": "Version of the system - if relevant" + }, + "code": { + "type": "string", + "description": "Symbol in syntax defined by the system" + }, + "display": { + "type": "string", + "description": "Representation defined by the system" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.Condition": { + "type": "object", + "description": "Detailed information about conditions, problems or diagnoses\nBased on [FHIR Condition](https://www.hl7.org/fhir/R4/condition.html)", + "properties": { + "identifier": { + "type": "array", + "description": "External Ids for this condition", + "items": { + "$ref": "#/definitions/Fhir.R4.Identifier" + } + }, + "clinicalStatus": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "active | recurrence | relapse | inactive | remission | resolved" + }, + "verificationStatus": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error" + }, + "category": { + "type": "array", + "description": "problem-list-item | encounter-diagnosis", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "severity": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Subjective severity of condition" + }, + "code": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Identification of the condition, problem or diagnosis" + }, + "bodySite": { + "type": "array", + "description": "Anatomical location, if relevant", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "encounter": { + "$ref": "#/definitions/Fhir.R4.Reference", + "description": "Encounter created as part of" + }, + "onsetDateTime": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "Estimated or actual date, date-time, or age" + }, + "onsetAge": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "Estimated or actual date, date-time, or age" + }, + "onsetPeriod": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "Estimated or actual date, date-time, or age" + }, + "onsetRange": { + "$ref": "#/definitions/Fhir.R4.Range", + "description": "Estimated or actual date, date-time, or age" + }, + "onsetString": { + "type": "string", + "description": "Estimated or actual date, date-time, or age" + }, + "abatementDateTime": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "When in resolution/remission" + }, + "abatementAge": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "When in resolution/remission" + }, + "abatementPeriod": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "When in resolution/remission" + }, + "abatementRange": { + "$ref": "#/definitions/Fhir.R4.Range", + "description": "When in resolution/remission" + }, + "abatementString": { + "type": "string", + "description": "When in resolution/remission" + }, + "recordedDate": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "Date record was first recorded" + }, + "stage": { + "type": "array", + "description": "stge/grade, usually assessed formally", + "items": { + "$ref": "#/definitions/Fhir.R4.ConditionStage" + }, + "x-ms-identifiers": [] + }, + "note": { + "type": "array", + "description": "Additional information about the Condition", + "items": { + "$ref": "#/definitions/Fhir.R4.Annotation" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.DomainResource" + } + ], + "x-ms-discriminator-value": "Condition" + }, + "Fhir.R4.ConditionStage": { + "type": "object", + "description": "Stage/grade, usually assessed formally\nBased on [FHIR Condition.Stage](https://www.hl7.org/fhir/R4/condition.html)", + "properties": { + "summary": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Simple summary (disease specific)" + }, + "type": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Kind of staging" + } + } + }, + "Fhir.R4.ContactDetail": { + "type": "object", + "description": "Contact details (See: https://www.hl7.org/fhir/R4/metadatatypes.html#ContactDetail)", + "properties": { + "name": { + "type": "string", + "description": "Name of an individual to contact" + }, + "telecom": { + "type": "array", + "description": "Contact details for individual or organization", + "items": { + "$ref": "#/definitions/Fhir.R4.ContactPoint" + }, + "x-ms-identifiers": [] + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.ContactPoint": { + "type": "object", + "description": "Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.\nSee https://www.hl7.org/fhir/R4/datatypes.html#ContactPoint", + "properties": { + "system": { + "$ref": "#/definitions/Fhir.R4.ContactPointSystem", + "description": "phone | fax | email | pager | url | sms | other" + }, + "value": { + "type": "string", + "description": "The actual contact point details" + }, + "use": { + "$ref": "#/definitions/Fhir.R4.ContactPointUse", + "description": "home | work | temp | old | mobile - purpose of this contact point" + }, + "rank": { + "type": "integer", + "format": "int32", + "description": "Specify preferred order of use (1 = highest)" + }, + "period": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "Time period when the contact point was/is in use" + } + } + }, + "Fhir.R4.ContactPointSystem": { + "type": "string", + "description": "Contact Point System\nsee https://www.hl7.org/fhir/R4/valueset-contact-point-system.html", + "enum": [ + "phone", + "fax", + "email", + "pager", + "url", + "sms", + "other" + ], + "x-ms-enum": { + "name": "ContactPointSystem", + "modelAsString": true, + "values": [ + { + "name": "Phone", + "value": "phone", + "description": "Phone" + }, + { + "name": "Fax", + "value": "fax", + "description": "Fax" + }, + { + "name": "Email", + "value": "email", + "description": "Email" + }, + { + "name": "Pager", + "value": "pager", + "description": "Pager" + }, + { + "name": "Url", + "value": "url", + "description": "Url" + }, + { + "name": "Sms", + "value": "sms", + "description": "Sms" + }, + { + "name": "Other", + "value": "other", + "description": "Other" + } + ] + } + }, + "Fhir.R4.ContactPointUse": { + "type": "string", + "description": "Contact Point Use\nSee: \thttp://hl7.org/fhir/ValueSet/contact-point-use", + "enum": [ + "home", + "work", + "temp", + "old", + "mobile" + ], + "x-ms-enum": { + "name": "ContactPointUse", + "modelAsString": true, + "values": [ + { + "name": "Home", + "value": "home", + "description": "Home" + }, + { + "name": "Work", + "value": "work", + "description": "Work" + }, + { + "name": "Temp", + "value": "temp", + "description": "Temp" + }, + { + "name": "Old", + "value": "old", + "description": "Old" + }, + { + "name": "Mobile", + "value": "mobile", + "description": "Mobile" + } + ] + } + }, + "Fhir.R4.DomainResource": { + "type": "object", + "description": "A resource with narrative, extensions, and contained resources\nBased on [FHIR DomainResource](https://www.hl7.org/fhir/domainresource.html)", + "properties": { + "resourceType": { + "type": "string", + "description": "Discriminator property for DomainResource." + }, + "text": { + "$ref": "#/definitions/Fhir.R4.Narrative", + "description": "Text summary of the resource, for human interpretation" + }, + "contained": { + "type": "array", + "description": "Contained, inline Resources", + "items": { + "$ref": "#/definitions/Fhir.R4.Resource" + } + }, + "extension": { + "type": "array", + "description": "Additional Content defined by implementations", + "items": { + "$ref": "#/definitions/Fhir.R4.Extension" + } + }, + "modifierExtension": { + "type": "array", + "description": "Extensions that cannot be ignored", + "items": { + "$ref": "#/definitions/Fhir.R4.Extension" + } + } + }, + "discriminator": "resourceType", + "required": [ + "resourceType" + ], + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Resource" + } + ] + }, + "Fhir.R4.Element": { + "type": "object", + "description": "The base definition for all elements contained inside a resource.\nBased on [FHIR Element](https://www.hl7.org/fhir/R4/element.html)", + "properties": { + "id": { + "type": "string", + "description": "Unique id for inter-element referencing" + }, + "extension": { + "type": "array", + "description": "Additional Content defined by implementations", + "items": { + "$ref": "#/definitions/Fhir.R4.Extension" + } + } + } + }, + "Fhir.R4.Extension": { + "type": "object", + "description": "Base for all elements\nBased on [FHIR Element](https://www.hl7.org/fhir/R4/element.html)", + "properties": { + "url": { + "$ref": "#/definitions/Fhir.R4.fhirUri", + "description": "Source of the definition for the extension code - a logical name or a URL." + }, + "valueQuantity": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "Value as Quantity" + }, + "valueCodeableConcept": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Value as CodeableConcept" + }, + "valueString": { + "type": "string", + "description": "Value as string" + }, + "valueBoolean": { + "type": "boolean", + "description": "Value as boolean" + }, + "valueInteger": { + "type": "integer", + "format": "int32", + "description": "Value as integer" + }, + "valueRange": { + "$ref": "#/definitions/Fhir.R4.Range", + "description": "Value as Range." + }, + "valueRatio": { + "$ref": "#/definitions/Fhir.R4.Ratio", + "description": "Value as Ratio." + }, + "valueSampledData": { + "$ref": "#/definitions/Fhir.R4.SampledData", + "description": "Value as SampledData." + }, + "valueTime": { + "type": "string", + "format": "time", + "description": "Value as time (hh:mm:ss)" + }, + "valueDateTime": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "Value as dateTime." + }, + "valuePeriod": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "Value as Period." + }, + "valueReference": { + "$ref": "#/definitions/Fhir.R4.Reference", + "description": "Value as reference." + } + }, + "required": [ + "url" + ], + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.Identifier": { + "type": "object", + "description": "An identifier intended for computation\nBased on [FHIR Identifier](https://www.hl7.org/fhir/R4/identifier.html)", + "properties": { + "use": { + "type": "string", + "description": "usual | official | temp | secondary | old (If known)" + }, + "type": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Description of identifier" + }, + "system": { + "$ref": "#/definitions/Fhir.R4.fhirUri", + "description": "The namespace for the identifier value" + }, + "value": { + "type": "string", + "description": "The value that is unique" + }, + "period": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "Time period when id is/was valid for use" + }, + "assigner": { + "$ref": "#/definitions/Fhir.R4.Reference", + "description": "Organization that issued id (may be just text)" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.Meta": { + "type": "object", + "description": "Metadata about a resource\nBased on [FHIR Meta](https://www.hl7.org/fhir/R4/resource.html#Meta)", + "properties": { + "versionId": { + "type": "string", + "description": "The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted." + }, + "lastUpdated": { + "$ref": "#/definitions/Fhir.R4.fhirInstant", + "description": "When the resource last changed - e.g. when the version changed." + }, + "source": { + "$ref": "#/definitions/Fhir.R4.fhirUri", + "description": "A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc." + }, + "profile": { + "type": "array", + "description": "A list of profiles (references to [StructureDefinition](https://www.hl7.org/fhir/structuredefinition.html) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](https://www.hl7.org/fhir/structuredefinition-definitions.html#StructureDefinition.url).", + "items": { + "$ref": "#/definitions/Fhir.R4.fhirUri" + } + }, + "security": { + "type": "array", + "description": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.", + "items": { + "$ref": "#/definitions/Fhir.R4.Coding" + } + }, + "tag": { + "type": "array", + "description": "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.", + "items": { + "$ref": "#/definitions/Fhir.R4.Coding" + } + } + } + }, + "Fhir.R4.Narrative": { + "type": "object", + "description": "Any resource that is a [DomainResource](https://www.hl7.org/fhir/domainresource.html) may include a human-readable narrative that contains a summary of the resource and may be used to represent the content of the resource to a human.\nBased on [FHIR Narrative](https://www.hl7.org/fhir/R4/narrative.html#Narrative)", + "properties": { + "status": { + "type": "string", + "description": "generated, extensions, additional, empty" + }, + "div": { + "type": "string", + "description": "xhtml" + } + }, + "required": [ + "status", + "div" + ], + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.Observation": { + "type": "object", + "description": "Detailed information about observations\nBased on [FHIR Observation](https://www.hl7.org/fhir/R4/observation.html)", + "properties": { + "identifier": { + "type": "array", + "description": "Business Identifier for observation", + "items": { + "$ref": "#/definitions/Fhir.R4.Identifier" + } + }, + "status": { + "$ref": "#/definitions/Fhir.R4.ObservationStatusCodeType", + "description": "registered | preliminary | final | amended +" + }, + "category": { + "type": "array", + "description": "Classification of type of observation", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "code": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Type of observation (code / type)" + }, + "subject": { + "$ref": "#/definitions/Fhir.R4.Reference", + "description": "Who and/or what the observation is about" + }, + "encounter": { + "$ref": "#/definitions/Fhir.R4.Reference", + "description": "Healthcare event during which this observation is made" + }, + "effectiveDateTime": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "Clinically relevant time/time-period for observation" + }, + "effectivePeriod": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "Clinically relevant time/time-period for observation" + }, + "effectiveInstant": { + "$ref": "#/definitions/Fhir.R4.fhirInstant", + "description": "Clinically relevant time/time-period for observation" + }, + "issued": { + "$ref": "#/definitions/Fhir.R4.fhirInstant", + "description": "Date/Time this version was made available" + }, + "valueQuantity": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "Actual result" + }, + "valueCodeableConcept": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Actual result" + }, + "valueString": { + "type": "string", + "description": "Actual result" + }, + "valueBoolean": { + "type": "boolean", + "description": "Actual result" + }, + "valueInteger": { + "type": "integer", + "format": "int32", + "description": "Actual result" + }, + "valueRange": { + "$ref": "#/definitions/Fhir.R4.Range", + "description": "Actual result" + }, + "valueRatio": { + "$ref": "#/definitions/Fhir.R4.Ratio", + "description": "Actual result" + }, + "valueSampledData": { + "$ref": "#/definitions/Fhir.R4.SampledData", + "description": "Actual result" + }, + "valueTime": { + "type": "string", + "format": "time", + "description": "Actual result" + }, + "valueDateTime": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "Actual result" + }, + "valuePeriod": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "Actual result" + }, + "dataAbsentReason": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Why the result is missing" + }, + "interpretation": { + "type": "array", + "description": "High, low, normal, etc.", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "note": { + "type": "array", + "description": "Comments about the observation", + "items": { + "$ref": "#/definitions/Fhir.R4.Annotation" + } + }, + "bodySite": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Observed body part" + }, + "method": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "How it was done" + }, + "referenceRange": { + "type": "array", + "description": "Provides guide for interpretation", + "items": { + "$ref": "#/definitions/Fhir.R4.ObservationReferenceRange" + }, + "x-ms-identifiers": [] + }, + "hasMember": { + "type": "array", + "description": "Related resource that belongs to the Observation group", + "items": { + "$ref": "#/definitions/Fhir.R4.Reference" + } + }, + "derivedFrom": { + "type": "array", + "description": "Related measurements the observation is made from", + "items": { + "$ref": "#/definitions/Fhir.R4.Reference" + } + }, + "component": { + "type": "array", + "description": "Component results", + "items": { + "$ref": "#/definitions/Fhir.R4.ObservationComponent" + } + } + }, + "required": [ + "status", + "code" + ], + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.DomainResource" + } + ], + "x-ms-discriminator-value": "Observation" + }, + "Fhir.R4.ObservationComponent": { + "type": "object", + "description": "Component results\nBased on [FHIR Observation.component](https://www.hl7.org/fhir/R4/observation.html)", + "properties": { + "code": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Type of component observation (code / type)" + }, + "valueQuantity": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "Value as Quantity" + }, + "valueCodeableConcept": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Value as CodeableConcept" + }, + "valueString": { + "type": "string", + "description": "Value as string" + }, + "valueBoolean": { + "type": "boolean", + "description": "Value as boolean" + }, + "valueInteger": { + "type": "integer", + "format": "int32", + "description": "Value as integer" + }, + "valueRange": { + "$ref": "#/definitions/Fhir.R4.Range", + "description": "Value as Range." + }, + "valueRatio": { + "$ref": "#/definitions/Fhir.R4.Ratio", + "description": "Value as Ratio." + }, + "valueSampledData": { + "$ref": "#/definitions/Fhir.R4.SampledData", + "description": "Value as SampledData." + }, + "valueTime": { + "type": "string", + "format": "time", + "description": "Value as time (hh:mm:ss)" + }, + "valueDateTime": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "Value as dateTime." + }, + "valuePeriod": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "Value as Period." + }, + "valueReference": { + "$ref": "#/definitions/Fhir.R4.Reference", + "description": "Value as reference." + }, + "dataAbsentReason": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Why the component result is missing" + }, + "interpretation": { + "type": "array", + "description": "High, low, normal, etc.", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "referenceRange": { + "type": "array", + "description": "Provides guide for interpretation of component result", + "items": { + "$ref": "#/definitions/Fhir.R4.ObservationReferenceRange" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "code" + ], + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.ObservationReferenceRange": { + "type": "object", + "description": "Provides guide for interpretation of component result\nBased on [FHIR Observation.referenceRange](https://www.hl7.org/fhir/R4/observation.html)", + "properties": { + "low": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "Low Range, if relevant" + }, + "high": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "High Range, if relevant" + }, + "type": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Reference range qualifier" + }, + "appliesTo": { + "type": "array", + "description": "Reference range population", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "age": { + "$ref": "#/definitions/Fhir.R4.Range", + "description": "Applicable age range, if relevant" + }, + "text": { + "type": "string", + "description": "Text based reference range in an observation" + } + } + }, + "Fhir.R4.ObservationStatusCodeType": { + "type": "string", + "description": "Observation Status\nBased on [FHIR ObservationStatus](https://www.hl7.org/fhir/R4/valueset-observation-status.html)", + "enum": [ + "registered", + "preliminary", + "final", + "amended", + "corrected", + "cancelled", + "entered-in-error", + "unknown" + ], + "x-ms-enum": { + "name": "ObservationStatusCodeType", + "modelAsString": true, + "values": [ + { + "name": "Registered", + "value": "registered", + "description": "The existence of the observation is registered, but there is no result yet available." + }, + { + "name": "Preliminary", + "value": "preliminary", + "description": "This is an initial or interim observation: data may be incomplete or unverified." + }, + { + "name": "Final", + "value": "final", + "description": "The observation is complete and verified by an authorized person." + }, + { + "name": "Amended", + "value": "amended", + "description": "Subsequent to being Final, the observation has been modified subsequent. This includes updates/new information and corrections." + }, + { + "name": "Corrected", + "value": "corrected", + "description": "Subsequent to being Final, the observation has been modified to correct an error in the test result." + }, + { + "name": "Cancelled", + "value": "cancelled", + "description": "The observation is unavailable because the measurement was not started or not completed (also sometimes called \"aborted\")." + }, + { + "name": "EnteredInError", + "value": "entered-in-error", + "description": "The observation has been withdrawn following previous final release." + }, + { + "name": "Unknown", + "value": "unknown", + "description": "The observation status is unknown. Note that \"unknown\" is a value of last resort and every attempt should be made to provide a meaningful value other than \"unknown\"." + } + ] + } + }, + "Fhir.R4.Period": { + "type": "object", + "description": "A time period defined by a start and end date and optionally time\nBased on [FHIR Period](https://www.hl7.org/fhir/R4/datatypes.html#Period)", + "properties": { + "start": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "Starting time with inclusive boundary" + }, + "end": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "End time with inclusive boundary, if not ongoing" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.Quantity": { + "type": "object", + "description": "A measured or measurable amount\nBased on [FHIR Quantity](https://www.hl7.org/fhir/R4/datatypes.html#Quantity)", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "Numerical value (with implicit precision)" + }, + "comparator": { + "type": "string", + "description": "< | <= | >= | > - how to understand the value" + }, + "unit": { + "type": "string", + "description": "Unit representation" + }, + "system": { + "$ref": "#/definitions/Fhir.R4.fhirUri", + "description": "System that defines coded unit form" + }, + "code": { + "type": "string", + "description": "Coded form of the unit" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.Range": { + "type": "object", + "description": "A set of ordered Quantities defined by a low and high limit\nBased on [FHIR Range](https://www.hl7.org/fhir/R4/datatypes.html#Range)", + "properties": { + "low": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "Low limit" + }, + "high": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "High limit" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.Ratio": { + "type": "object", + "description": "A ratio of two Quantity values - a numerator and a denominator\nBased on [FHIR Ratio](https://www.hl7.org/fhir/R4/datatypes.html#Ratio)", + "properties": { + "numerator": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "Numerator value" + }, + "denominator": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "Denominator value" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.Reference": { + "type": "object", + "description": "A reference from one resource to another\nBased on [FHIR Reference](https://www.hl7.org/fhir/R4/references.html)", + "properties": { + "reference": { + "type": "string", + "description": "Literal reference, Relative, internal or absolute URL" + }, + "type": { + "$ref": "#/definitions/Fhir.R4.fhirUri", + "description": "Type the reference refers to (e.g. \"Patient\")" + }, + "identifier": { + "$ref": "#/definitions/Fhir.R4.Identifier", + "description": "Logical reference, when literal reference is not known" + }, + "display": { + "type": "string", + "description": "Text alternative for the resource" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.ResearchStudy": { + "type": "object", + "description": "Detailed information about Research Study\nBased on [FHIR ResearchStudy](https://www.hl7.org/fhir/R4/researchstudy.html)", + "properties": { + "identifier": { + "type": "array", + "description": "Business Identifier for study", + "items": { + "$ref": "#/definitions/Fhir.R4.Identifier" + } + }, + "title": { + "type": "string", + "description": "Name for this study" + }, + "protocol": { + "type": "array", + "description": "Steps followed in executing study", + "items": { + "$ref": "#/definitions/Fhir.R4.Reference" + } + }, + "partOf": { + "type": "array", + "description": "Part of larger study", + "items": { + "$ref": "#/definitions/Fhir.R4.Reference" + } + }, + "status": { + "$ref": "#/definitions/Fhir.R4.ResearchStudyStatusCodeType", + "description": "active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn" + }, + "primaryPurposeType": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility" + }, + "phase": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4" + }, + "category": { + "type": "array", + "description": "Classifications for the study", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "focus": { + "type": "array", + "description": "Drugs, devices, etc. under study", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "condition": { + "type": "array", + "description": "Condition being studied", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "contact": { + "type": "array", + "description": "Contact details for the study", + "items": { + "$ref": "#/definitions/Fhir.R4.ContactDetail" + } + }, + "keyword": { + "type": "array", + "description": "Used to search for the study", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "location": { + "type": "array", + "description": "Geographic region(s) for study", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "description": { + "type": "string", + "description": "What this is study doing" + }, + "enrollment": { + "type": "array", + "description": "Inclusion & exclusion criteria", + "items": { + "$ref": "#/definitions/Fhir.R4.Reference" + } + }, + "period": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "When the study began and ended" + }, + "sponsor": { + "$ref": "#/definitions/Fhir.R4.Reference", + "description": "Organization that initiates and is legally responsible for the study" + }, + "principalInvestigator": { + "$ref": "#/definitions/Fhir.R4.Reference", + "description": "Researcher who oversees multiple aspects of the study" + }, + "site": { + "type": "array", + "description": "Facility where study activities are conducted", + "items": { + "$ref": "#/definitions/Fhir.R4.Reference" + } + }, + "reasonStopped": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design" + }, + "note": { + "type": "array", + "description": "Comments made about the study", + "items": { + "$ref": "#/definitions/Fhir.R4.Annotation" + } + }, + "arm": { + "type": "array", + "description": "Defined path through the study for a subject", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Label for study arm" + }, + "type": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Categorization of study arm" + }, + "description": { + "type": "string", + "description": "Short explanation of study path" + } + }, + "required": [ + "name" + ] + }, + "x-ms-identifiers": [] + }, + "objective": { + "type": "array", + "description": "A goal for the study", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Label for the objective" + }, + "type": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "primary | secondary | exploratory" + } + }, + "required": [ + "name" + ] + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "status" + ], + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.DomainResource" + } + ], + "x-ms-discriminator-value": "ResearchStudy" + }, + "Fhir.R4.ResearchStudyStatusCodeType": { + "type": "string", + "description": "https://www.hl7.org/fhir/R4/codesystem-research-study-status.html", + "enum": [ + "active", + "administratively-completed", + "approved", + "closed-to-accrual", + "closed-to-accrual-and-intervention", + "completed", + "disapproved", + "in-review", + "temporarily-closed-to-accrual", + "temporarily-closed-to-accrual-and-intervention", + "withdrawn" + ], + "x-ms-enum": { + "name": "ResearchStudyStatusCodeType", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "active", + "description": "The study is open for accrual." + }, + { + "name": "AdministrativelyCompleted", + "value": "administratively-completed", + "description": "Study is completed prematurely and will not resume; patients are no longer examined nor treated." + }, + { + "name": "Approved", + "value": "approved", + "description": "Protocol is approved by the review board." + }, + { + "name": "ClosedToAccrual", + "value": "closed-to-accrual", + "description": "Study is closed for accrual; patients can be examined and treated." + }, + { + "name": "ClosedToAccrualAndIntervention", + "value": "closed-to-accrual-and-intervention", + "description": "The study is closed to accrual and intervention, i.e. the study is closed to enrollment, all study subjects have completed treatment or intervention but are still being followed according to the primary objective of the study." + }, + { + "name": "Completed", + "value": "completed", + "description": "Study is closed to accrual and intervention, i.e. the study is closed to enrollment, all study subjects have completed treatment or intervention but are still being followed according to the primary objective of the study." + }, + { + "name": "Disapproved", + "value": "disapproved", + "description": "Protocol was disapproved by the review board." + }, + { + "name": "InReview", + "value": "in-review", + "description": "Protocol is submitted to the review board for approval." + }, + { + "name": "TemporarilyClosedToAccrual", + "value": "temporarily-closed-to-accrual", + "description": "The study is temporarily closed to accrual; a pause in accrual while study is reviewed, but is expected to resume." + }, + { + "name": "TemporarilyClosedToAccrualAndIntervention", + "value": "temporarily-closed-to-accrual-and-intervention", + "description": "Study is temporarily closed for accrual; can be potentially resumed in the future" + }, + { + "name": "Withdrawn", + "value": "withdrawn", + "description": "Protocol was withdrawn by the lead organization." + } + ] + } + }, + "Fhir.R4.Resource": { + "type": "object", + "description": "Resource is the ancestor of DomainResource from which most resources are derived. Bundle, Parameters, and Binary extend Resource directly.\nBased on [FHIR Resource](https://www.hl7.org/fhir/r4/resource.html", + "properties": { + "resourceType": { + "type": "string", + "description": "The type of resource" + }, + "id": { + "type": "string", + "description": "Resource Id" + }, + "meta": { + "$ref": "#/definitions/Fhir.R4.Meta", + "description": "Metadata about the resource" + }, + "implicitRules": { + "$ref": "#/definitions/Fhir.R4.fhirUri", + "description": "A set of rules under which this content was created" + }, + "language": { + "type": "string", + "description": "Language of the resource content" + } + }, + "required": [ + "resourceType" + ], + "additionalProperties": {} + }, + "Fhir.R4.SampledData": { + "type": "object", + "description": "A series of measurements taken by a device\nBased on [FHIR SampledData](https://www.hl7.org/fhir/R4/datatypes.html#SampledData)", + "properties": { + "origin": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "Zero value and units" + }, + "period": { + "type": "number", + "format": "double", + "description": "Number of milliseconds between samples" + }, + "factor": { + "type": "number", + "format": "double", + "description": "Multiply data by this before adding to origin" + }, + "lowerLimit": { + "type": "number", + "format": "double", + "description": "Lower limit of detection" + }, + "upperLimit": { + "type": "number", + "format": "double", + "description": "Upper limit of detection" + }, + "dimensions": { + "type": "integer", + "format": "int32", + "description": "Number of sample points at each time point", + "minimum": 1 + }, + "data": { + "type": "string", + "description": "Decimal values with spaces, or \"E\" | \"U\" | \"L\"" + } + }, + "required": [ + "origin", + "period", + "dimensions" + ], + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.fhirDateTime": { + "type": "string", + "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?" + }, + "Fhir.R4.fhirInstant": { + "type": "string", + "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))" + }, + "Fhir.R4.fhirUri": { + "type": "string" + }, + "FindingInference": { + "type": "object", + "description": "Findings in a radiology report typically describe abnormalities, lesions, or other notable observations related to the anatomy or pathology of the imaged area.", + "properties": { + "finding": { + "$ref": "#/definitions/Fhir.R4.Observation", + "description": "Finding data : contains extensions, fields and components linked with the finding." + } + }, + "required": [ + "finding" + ], + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "finding" + }, + "FindingOptions": { + "type": "object", + "description": "Finding options.", + "properties": { + "provideFocusedSentenceEvidence": { + "type": "boolean", + "description": "If this is true, provide the sentence that contains the first token of the finding's clinical indicator (i.e. the medical problem), if there is one. This sentence is provided as an extension with url 'ci_sentence', next to the token evidence. Default is false." + } + } + }, + "FollowupCommunicationInference": { + "type": "object", + "description": "Follow-up communication involves the exchange of important information, recommendations, or updates between radiologists and other healthcare professionals involved in a patient's care.", + "properties": { + "communicatedAt": { + "type": "array", + "description": "Communication date and time.", + "minItems": 1, + "items": { + "type": "string", + "format": "date-time" + } + }, + "recipient": { + "type": "array", + "description": "Recipient of the communication.", + "minItems": 1, + "items": { + "$ref": "#/definitions/MedicalProfessionalType" + } + }, + "wasAcknowledged": { + "type": "boolean", + "description": "Communication was acknowledged." + } + }, + "required": [ + "wasAcknowledged" + ], + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "followupCommunication" + }, + "FollowupRecommendationInference": { + "type": "object", + "description": "Follow-up recommendations offer guidance to healthcare providers on managing and monitoring patients based on the findings of imaging studies.", + "properties": { + "effectiveAt": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "Date and time are displayed when the procedure is recommended to be done at a specific point in time." + }, + "effectivePeriod": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "The period is shown if a specific period is mentioned, with a start and end date-time." + }, + "findings": { + "type": "array", + "description": "Findings related to the recommendation.", + "minItems": 1, + "items": { + "$ref": "#/definitions/RecommendationFinding" + }, + "x-ms-identifiers": [] + }, + "isConditional": { + "type": "boolean", + "description": "The conditional value indicates whether or not the sentence containing the recommendation includes a conditional statement. Keywords for conditional statements include 'if', 'when', 'unless', and so on." + }, + "isOption": { + "type": "boolean", + "description": "The option value indicates whether or not the sentence containing the recommendation includes an optional statement. Keywords for optional statements include 'recommend', 'consider', and so on." + }, + "isGuideline": { + "type": "boolean", + "description": "The guideline value indicates whether or not the recommendation is part of a guideline section that compiles all recommendations applicable to various findings." + }, + "isHedging": { + "type": "boolean", + "description": "Hedging refers to ambiguous, vague or imprecise language within the sentence of the recommendation. Keywords for hedging are 'can be','may be',and so on." + }, + "recommendedProcedure": { + "$ref": "#/definitions/ProcedureRecommendation", + "description": "The procedure recommendation can be a generic procedure or an imaging procedure." + } + }, + "required": [ + "isConditional", + "isOption", + "isGuideline", + "isHedging", + "recommendedProcedure" + ], + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "followupRecommendation" + }, + "FollowupRecommendationOptions": { + "type": "object", + "description": "Follow-up recommendation options.", + "properties": { + "includeRecommendationsWithNoSpecifiedModality": { + "type": "boolean", + "description": "Include/Exclude follow-up recommendations without a specific radiology procedure. Default is false." + }, + "includeRecommendationsInReferences": { + "type": "boolean", + "description": "Include/Exclude follow-up recommendations in references to a guideline or article. Default is false." + }, + "provideFocusedSentenceEvidence": { + "type": "boolean", + "description": "If this is true, provide one or more sentences as evidence for the recommendation, next to the token evidence. The start and end positions of these sentences will be put in an extension with url 'modality_sentences'. Default is false." + } + } + }, + "GenericProcedureRecommendation": { + "type": "object", + "description": "Generic procedure information.", + "properties": { + "code": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Procedure modality : SNOMED CT code." + }, + "description": { + "type": "string", + "description": "Procedure description : MANAGEMENT PROCEDURE (PROCEDURE) or CONSULTATION (PROCEDURE) based on SNOMED CT." + } + }, + "required": [ + "code" + ], + "allOf": [ + { + "$ref": "#/definitions/ProcedureRecommendation" + } + ], + "x-ms-discriminator-value": "genericProcedureRecommendation" + }, + "GeoJsonGeometryType": { + "type": "string", + "description": "`GeoJSON` geometry type.", + "enum": [ + "Point" + ], + "x-ms-enum": { + "name": "GeoJsonGeometryType", + "modelAsString": true, + "values": [ + { + "name": "Point", + "value": "Point" + } + ] + } + }, + "GeoJsonPropertiesSubType": { + "type": "string", + "description": "`GeoJSON` object sub-type.", + "enum": [ + "Circle" + ], + "x-ms-enum": { + "name": "GeoJsonPropertiesSubType", + "modelAsString": true, + "values": [ + { + "name": "Circle", + "value": "Circle" + } + ] + } + }, + "GeoJsonType": { + "type": "string", + "description": "`GeoJSON` type.", + "enum": [ + "Feature" + ], + "x-ms-enum": { + "name": "GeoJsonType", + "modelAsString": true, + "values": [ + { + "name": "Feature", + "value": "Feature" + } + ] + } + }, + "GeographicArea": { + "type": "object", + "description": "A geographic area, expressed as a `Circle` geometry represented using a `GeoJSON Feature` (see [GeoJSON spec](https://tools.ietf.org/html/rfc7946)).", + "properties": { + "type": { + "$ref": "#/definitions/GeoJsonType", + "description": "`GeoJSON` type." + }, + "geometry": { + "$ref": "#/definitions/AreaGeometry", + "description": "`GeoJSON` geometry, representing the area circle's center." + }, + "properties": { + "$ref": "#/definitions/AreaProperties", + "description": "`GeoJSON` object properties." + } + }, + "required": [ + "type", + "geometry", + "properties" + ] + }, + "GeographicLocation": { + "type": "object", + "description": "A location given as a combination of city, state and country/region. It could specify a city, a state or a country/region.\nIn case a city is specified, either state +country/region or country/region (for countries/regions where there are no states) should be added.\nIn case a state is specified (without a city), country/region should be added.", + "properties": { + "city": { + "type": "string", + "description": "City name." + }, + "state": { + "type": "string", + "description": "State name." + }, + "countryOrRegion": { + "type": "string", + "description": "Country/region name." + } + }, + "required": [ + "countryOrRegion" + ] + }, + "HealthInsightsErrorResponse": { + "type": "object", + "description": "A response containing error details.", + "properties": { + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "ImagingProcedure": { + "type": "object", + "description": "Imaging procedure.", + "properties": { + "modality": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Modality : SNOMED CT code." + }, + "anatomy": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Anatomy : SNOMED CT code." + }, + "laterality": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Laterality : SNOMED CT code." + }, + "contrast": { + "$ref": "#/definitions/RadiologyCodeWithTypes", + "description": "Contrast : see RadiologyCodeWithTypes (below)." + }, + "view": { + "$ref": "#/definitions/RadiologyCodeWithTypes", + "description": "View : see RadiologyCodeWithTypes (below)." + } + }, + "required": [ + "modality", + "anatomy" + ] + }, + "ImagingProcedureRecommendation": { + "type": "object", + "description": "Imaging procedures.", + "properties": { + "procedureCodes": { + "type": "array", + "description": "LOINC codes for the procedure.", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "imagingProcedures": { + "type": "array", + "description": "Imaging procedures.", + "minItems": 1, + "items": { + "$ref": "#/definitions/ImagingProcedure" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "imagingProcedures" + ], + "allOf": [ + { + "$ref": "#/definitions/ProcedureRecommendation" + } + ], + "x-ms-discriminator-value": "imagingProcedureRecommendation" + }, + "JobStatus": { + "type": "string", + "description": "The status of the processing job.", + "enum": [ + "notStarted", + "running", + "succeeded", + "failed", + "canceled" + ], + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true, + "values": [ + { + "name": "NotStarted", + "value": "notStarted" + }, + { + "name": "Running", + "value": "running" + }, + { + "name": "Succeeded", + "value": "succeeded" + }, + { + "name": "Failed", + "value": "failed" + }, + { + "name": "Canceled", + "value": "canceled" + } + ] + } + }, + "LateralityDiscrepancyInference": { + "type": "object", + "description": "A laterality mismatch occurs when there is a discrepancy between the clinical documentation and the ordered procedure (orderLateralityMismatch), a contradiction within the clinical document (textLateralityContradiction), or when no laterality is mentioned (textLateralityMissing).", + "properties": { + "lateralityIndication": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Laterality indication : SNOMED CT code for laterality qualifier value." + }, + "discrepancyType": { + "$ref": "#/definitions/LateralityDiscrepancyType", + "description": "Mismatch type : orderLateralityMismatch, textLateralityContradiction, textLateralityMissing." + } + }, + "required": [ + "discrepancyType" + ], + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "lateralityDiscrepancy" + }, + "LateralityDiscrepancyType": { + "type": "string", + "description": "Laterality discrepancy type", + "enum": [ + "orderLateralityMismatch", + "textLateralityContradiction", + "textLateralityMissing" + ], + "x-ms-enum": { + "name": "LateralityDiscrepancyType", + "modelAsString": true, + "values": [ + { + "name": "OrderLateralityMismatch", + "value": "orderLateralityMismatch", + "description": "Mismatch between order and text" + }, + { + "name": "TextLateralityContradiction", + "value": "textLateralityContradiction", + "description": "Contradiction in text" + }, + { + "name": "TextLateralityMissing", + "value": "textLateralityMissing", + "description": "Missing laterality in text" + } + ] + } + }, + "LimitedOrderDiscrepancyInference": { + "type": "object", + "description": "A limited order discrepancy occurs when there is a limited order, but all body parts and measurements that are needed for a complete order are present in the document.", + "properties": { + "orderType": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Order type : CPT ultrasound complete code for abdomen, retroperitoneal, pelvis or breast." + }, + "presentBodyParts": { + "type": "array", + "description": "List of body parts found in the document : SNOMED CT codes.", + "minItems": 1, + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "presentBodyPartMeasurements": { + "type": "array", + "description": "List of body parts that are measured according to the document : SNOMED CT codes.", + "minItems": 1, + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + } + }, + "required": [ + "orderType" + ], + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "limitedOrderDiscrepancy" + }, + "MedicalProfessionalType": { + "type": "string", + "description": "Medical Professional Type", + "enum": [ + "unknown", + "doctor", + "nurse", + "midwife", + "physicianAssistant" + ], + "x-ms-enum": { + "name": "MedicalProfessionalType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "unknown", + "description": "Unknown medical professional type" + }, + { + "name": "Doctor", + "value": "doctor", + "description": "Doctor medical professional type" + }, + { + "name": "Nurse", + "value": "nurse", + "description": "Nurse medical professional type" + }, + { + "name": "Midwife", + "value": "midwife", + "description": "Technician medical professional type" + }, + { + "name": "PhysicianAssistant", + "value": "physicianAssistant", + "description": "Technician medical professional type" + } + ] + } + }, + "ModelVersion": { + "type": "string", + "description": "The version of the model used for inference, expressed as the model date." + }, + "NeededClinicalInfo": { + "type": "array", + "description": "Clinical information which is needed to provide better trial matching results for the patient.", + "items": { + "$ref": "#/definitions/ExtendedClinicalCodedElement" + }, + "x-ms-identifiers": [] + }, + "OrderedProcedure": { + "type": "object", + "description": "Procedure information", + "properties": { + "code": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Procedure code" + }, + "description": { + "type": "string", + "description": "Procedure description" + }, + "extension": { + "type": "array", + "description": "Additional Content defined by implementations", + "items": { + "$ref": "#/definitions/Fhir.R4.Extension" + } + } + } + }, + "PatientDetails": { + "type": "object", + "description": "Patient structured information, including demographics and known structured clinical information.", + "properties": { + "sex": { + "$ref": "#/definitions/PatientSex", + "description": "The patient's sex." + }, + "birthDate": { + "type": "string", + "format": "date", + "description": "The patient's date of birth." + }, + "clinicalInfo": { + "type": "array", + "description": "Known clinical information for the patient, structured.", + "items": { + "$ref": "#/definitions/Fhir.R4.Resource" + } + } + } + }, + "PatientDocument": { + "type": "object", + "description": "A clinical document related to a patient. Document here is in the wide sense - not just a text document (note).", + "properties": { + "type": { + "$ref": "#/definitions/DocumentType", + "description": "The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON document)." + }, + "clinicalType": { + "$ref": "#/definitions/ClinicalDocumentType", + "description": "The type of the clinical document." + }, + "id": { + "type": "string", + "description": "A given identifier for the document. Has to be unique across all documents for a single patient.", + "minLength": 1 + }, + "language": { + "type": "string", + "description": "A 2 letter ISO 639-1 representation of the language of the document." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The date and time when the document was created." + }, + "authors": { + "type": "array", + "description": "Document author(s)", + "minItems": 1, + "items": { + "$ref": "#/definitions/DocumentAuthor" + } + }, + "specialtyType": { + "$ref": "#/definitions/SpecialtyType", + "description": "specialty type the document" + }, + "administrativeMetadata": { + "$ref": "#/definitions/DocumentAdministrativeMetadata", + "description": "Administrative metadata for the document." + }, + "content": { + "$ref": "#/definitions/DocumentContent", + "description": "The content of the patient document." + } + }, + "required": [ + "type", + "id", + "content" + ] + }, + "PatientEncounter": { + "type": "object", + "description": "visit/encounter information", + "properties": { + "id": { + "type": "string", + "description": "The id of the visit.", + "minLength": 1 + }, + "period": { + "$ref": "#/definitions/TimePeriod", + "description": "Time period of the visit.\nIn case of admission, use timePeriod.start to indicate the admission time and timePeriod.end to indicate the discharge time." + }, + "class": { + "$ref": "#/definitions/EncounterClass", + "description": "The class of the encounter." + } + }, + "required": [ + "id" + ] + }, + "PatientRecord": { + "type": "object", + "description": "A patient record, including their clinical information and data.", + "properties": { + "id": { + "type": "string", + "description": "A given identifier for the patient. Has to be unique across all patients in a single request.", + "minLength": 1 + }, + "details": { + "$ref": "#/definitions/PatientDetails", + "description": "Patient structured information, including demographics and known structured clinical information." + }, + "encounters": { + "type": "array", + "description": "Patient encounters/visits.", + "items": { + "$ref": "#/definitions/PatientEncounter" + } + }, + "patientDocuments": { + "type": "array", + "description": "Patient unstructured clinical data, given as documents.", + "items": { + "$ref": "#/definitions/PatientDocument" + } + } + }, + "required": [ + "id" + ] + }, + "PatientSex": { + "type": "string", + "description": "The patient's sex.", + "enum": [ + "female", + "male", + "unspecified" + ], + "x-ms-enum": { + "name": "PatientSex", + "modelAsString": true, + "values": [ + { + "name": "Female", + "value": "female" + }, + { + "name": "Male", + "value": "male" + }, + { + "name": "Unspecified", + "value": "unspecified" + } + ] + } + }, + "ProcedureRecommendation": { + "type": "object", + "description": "The procedure recommendation can be a generic procedure or an imaging procedure.", + "properties": { + "kind": { + "type": "string", + "description": "Discriminator property for ProcedureRecommendation." + }, + "extension": { + "type": "array", + "description": "Additional Content defined by implementations", + "items": { + "$ref": "#/definitions/Fhir.R4.Extension" + } + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "RadiologyCodeWithTypes": { + "type": "object", + "description": "Radiology code with types : used in imaging procedure recommendation for contrast and view.", + "properties": { + "code": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "The SNOMED CT code indicates whether imaging was conducted with or without contrast in the case of contrast, and in the case of views, it denotes the number of views." + }, + "types": { + "type": "array", + "description": "The collection of types will indicate the contrast substance used in the case of contrast and, in the case of views, it will specify the types of views, such as lateral and frontal, etc.", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + } + }, + "required": [ + "code", + "types" + ] + }, + "RadiologyInsightsData": { + "type": "object", + "description": "Contains the list of patients, and configuration data.", + "properties": { + "patients": { + "type": "array", + "description": "The list of patients, including their clinical information and data.", + "items": { + "$ref": "#/definitions/PatientRecord" + } + }, + "configuration": { + "$ref": "#/definitions/RadiologyInsightsModelConfiguration", + "description": "Configuration affecting the Radiology Insights model's inference." + } + }, + "required": [ + "patients" + ] + }, + "RadiologyInsightsInference": { + "type": "object", + "description": "An inference made by the Radiology Insights model regarding a patient.\n - AgeMismatch\n - SexMismatch\n - LateralityDiscrepancy\n - CompleteOrderDiscrepancy\n - LimitedOrderDiscrepancy\n - Finding\n - CriticalResult\n - FollowupRecommendation\n - RadiologyProcedure\n - FollowupCommunication", + "properties": { + "kind": { + "type": "string", + "description": "Discriminator property for RadiologyInsightsInference." + }, + "extension": { + "type": "array", + "description": "Additional Content defined by implementations", + "items": { + "$ref": "#/definitions/Fhir.R4.Extension" + } + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "RadiologyInsightsInferenceOptions": { + "type": "object", + "description": "Options regarding follow up recommendation inferences and finding inferences.", + "properties": { + "followupRecommendationOptions": { + "$ref": "#/definitions/FollowupRecommendationOptions", + "description": "Follow-up recommendation options." + }, + "findingOptions": { + "$ref": "#/definitions/FindingOptions", + "description": "Finding options." + } + } + }, + "RadiologyInsightsInferenceResult": { + "type": "object", + "description": "The inference results for the Radiology Insights request. If field 'status' has value 'succeeded', then field 'result' will contain an instance of RadiologyInsightsInferenceResult.", + "properties": { + "patientResults": { + "type": "array", + "description": "Results for the patients given in the request.", + "minItems": 1, + "items": { + "$ref": "#/definitions/RadiologyInsightsPatientResult" + }, + "x-ms-identifiers": [] + }, + "modelVersion": { + "$ref": "#/definitions/ModelVersion", + "description": "The version of the model used for inference, expressed as the model date.", + "pattern": "^(?:[2][0-9]{3}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12][0-9]|3[01])(?:-preview)?)$" + } + }, + "required": [ + "patientResults", + "modelVersion" + ] + }, + "RadiologyInsightsInferenceType": { + "type": "string", + "description": "A Radiology Insights inference types.", + "enum": [ + "ageMismatch", + "lateralityDiscrepancy", + "sexMismatch", + "completeOrderDiscrepancy", + "limitedOrderDiscrepancy", + "finding", + "criticalResult", + "followupRecommendation", + "followupCommunication", + "radiologyProcedure" + ], + "x-ms-enum": { + "name": "RadiologyInsightsInferenceType", + "modelAsString": true, + "values": [ + { + "name": "AgeMismatch", + "value": "ageMismatch", + "description": "Age mismatch inference type" + }, + { + "name": "LateralityDiscrepancy", + "value": "lateralityDiscrepancy", + "description": "Laterality discrepancy inference type" + }, + { + "name": "SexMismatch", + "value": "sexMismatch", + "description": "Sex mismatch inference type" + }, + { + "name": "CompleteOrderDiscrepancy", + "value": "completeOrderDiscrepancy", + "description": "Complete order discrepancy inference type" + }, + { + "name": "LimitedOrderDiscrepancy", + "value": "limitedOrderDiscrepancy", + "description": "Limited order discrepancy inference type" + }, + { + "name": "Finding", + "value": "finding", + "description": "Finding inference type" + }, + { + "name": "CriticalResult", + "value": "criticalResult", + "description": "Critical finding inference type" + }, + { + "name": "FollowupRecommendation", + "value": "followupRecommendation", + "description": "Recommendation inference type" + }, + { + "name": "FollowupCommunication", + "value": "followupCommunication", + "description": "Followup Communication inference type" + }, + { + "name": "RadiologyProcedure", + "value": "radiologyProcedure", + "description": "Radiology Procedure inference type" + } + ] + } + }, + "RadiologyInsightsJob": { + "type": "object", + "description": "Response for the Radiology Insights request.", + "properties": { + "jobData": { + "$ref": "#/definitions/RadiologyInsightsData", + "description": "The request data for the operation.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "result": { + "$ref": "#/definitions/RadiologyInsightsInferenceResult", + "description": "The result of the operation.", + "readOnly": true + }, + "id": { + "type": "string", + "description": "The unique ID of the job.", + "minLength": 3, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]+[a-zA-Z0-9]$", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The status of the job.", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job was created.", + "readOnly": true + }, + "expiresAt": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job is set to expire.", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job was last updated.", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Error object that describes the error when status is \"Failed\".", + "readOnly": true + } + }, + "required": [ + "id", + "status" + ] + }, + "RadiologyInsightsModelConfiguration": { + "type": "object", + "description": "Configuration affecting the Radiology Insights model's inference.", + "properties": { + "verbose": { + "type": "boolean", + "description": "An indication whether the model should produce verbose output.", + "default": false + }, + "includeEvidence": { + "type": "boolean", + "description": "An indication whether the model's output should include evidence for the inferences.", + "default": true + }, + "inferenceTypes": { + "type": "array", + "description": "This is a list of inference types to be inferred for the current request. It could be used if only part of the Radiology Insights inferences are required. If this list is omitted or empty, the model will return all the inference types.", + "minItems": 1, + "items": { + "$ref": "#/definitions/RadiologyInsightsInferenceType" + } + }, + "inferenceOptions": { + "$ref": "#/definitions/RadiologyInsightsInferenceOptions", + "description": "Options regarding follow up recommendation inferences and finding inferences." + }, + "locale": { + "type": "string", + "description": "Local for the model to use. If not specified, the model will use the default locale." + } + } + }, + "RadiologyInsightsPatientResult": { + "type": "object", + "description": "Results of the model's work for a single patient.", + "properties": { + "patientId": { + "type": "string", + "description": "Identifier given for the patient in the request." + }, + "inferences": { + "type": "array", + "description": "The model's inferences for the given patient.", + "minItems": 1, + "items": { + "$ref": "#/definitions/RadiologyInsightsInference" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "patientId", + "inferences" + ] + }, + "RadiologyProcedureInference": { + "type": "object", + "description": "Radiology procedures are the specific imaging studies or examinations ordered for the patient, extracted from the document information and text.", + "properties": { + "procedureCodes": { + "type": "array", + "description": "LOINC codes for the procedure.", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "imagingProcedures": { + "type": "array", + "description": "Imaging procedures.", + "minItems": 1, + "items": { + "$ref": "#/definitions/ImagingProcedure" + }, + "x-ms-identifiers": [] + }, + "orderedProcedure": { + "$ref": "#/definitions/OrderedProcedure", + "description": "Ordered procedure information from the document information or text." + } + }, + "required": [ + "imagingProcedures", + "orderedProcedure" + ], + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "radiologyProcedure" + }, + "RecommendationFinding": { + "type": "object", + "description": "Finding reference for recommendation.", + "properties": { + "finding": { + "$ref": "#/definitions/Fhir.R4.Observation", + "description": "Finding linked to a recommendation." + }, + "criticalFinding": { + "$ref": "#/definitions/CriticalResult", + "description": "Critical result linked to a recommendation." + }, + "recommendationFindingStatus": { + "$ref": "#/definitions/RecommendationFindingStatusType", + "description": "Recommendation finding status." + }, + "extension": { + "type": "array", + "description": "Additional Content defined by implementations", + "items": { + "$ref": "#/definitions/Fhir.R4.Extension" + } + } + }, + "required": [ + "recommendationFindingStatus" + ] + }, + "RecommendationFindingStatusType": { + "type": "string", + "description": "Recommendation finding status", + "enum": [ + "present", + "differential", + "ruleOut", + "conditional" + ], + "x-ms-enum": { + "name": "RecommendationFindingStatusType", + "modelAsString": true, + "values": [ + { + "name": "Present", + "value": "present", + "description": "Present finding status" + }, + { + "name": "Differential", + "value": "differential", + "description": "Differential finding status" + }, + { + "name": "RuleOut", + "value": "ruleOut", + "description": "Rule out finding status" + }, + { + "name": "Conditional", + "value": "conditional", + "description": "Conditional finding status" + } + ] + } + }, + "SexMismatchInference": { + "type": "object", + "description": "A notification for a sex mismatch is displayed when the gender, personal pronouns, gender-related body parts, or gender-related procedures mentioned in a patient's clinical document are either inconsistent or do not match the gender specified in the patient information.", + "properties": { + "sexIndication": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Sex indication : SNOMED CT code for gender finding." + } + }, + "required": [ + "sexIndication" + ], + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "sexMismatch" + }, + "SpecialtyType": { + "type": "string", + "description": "Known values codes that can be used to indicate the type of the Specialty.", + "enum": [ + "pathology", + "radiology" + ], + "x-ms-enum": { + "name": "SpecialtyType", + "modelAsString": true, + "values": [ + { + "name": "Pathology", + "value": "pathology", + "description": "pathology" + }, + { + "name": "Radiology", + "value": "radiology", + "description": "radiology" + } + ] + } + }, + "TimePeriod": { + "type": "object", + "description": "A duration of time during which an event is happening", + "properties": { + "start": { + "type": "string", + "format": "date-time", + "description": "Starting time with inclusive boundary" + }, + "end": { + "type": "string", + "format": "date-time", + "description": "End time with inclusive boundary, if not ongoing" + } + } + }, + "TrialMatcherData": { + "type": "object", + "description": "The body of the Trial Matcher request.", + "properties": { + "patients": { + "type": "array", + "description": "The list of patients, including their clinical information and data.", + "items": { + "$ref": "#/definitions/PatientRecord" + } + }, + "configuration": { + "$ref": "#/definitions/TrialMatcherModelConfiguration", + "description": "Configuration affecting the Trial Matcher model's inference." + } + }, + "required": [ + "patients" + ] + }, + "TrialMatcherInference": { + "type": "object", + "description": "An inference made by the Trial Matcher model regarding a patient.", + "properties": { + "type": { + "$ref": "#/definitions/TrialMatcherInferenceType", + "description": "The type of the Trial Matcher inference." + }, + "value": { + "type": "string", + "description": "The value of the inference, as relevant for the given inference type." + }, + "description": { + "type": "string", + "description": "The description corresponding to the inference value." + }, + "confidenceScore": { + "type": "number", + "format": "float", + "description": "Confidence score for this inference.", + "minimum": 0, + "maximum": 1 + }, + "evidence": { + "type": "array", + "description": "The evidence corresponding to the inference value.", + "items": { + "$ref": "#/definitions/TrialMatcherInferenceEvidence" + }, + "x-ms-identifiers": [] + }, + "clinicalTrialId": { + "type": "string", + "description": "The identifier of the clinical trial.", + "minLength": 1 + }, + "source": { + "$ref": "#/definitions/ClinicalTrialSource", + "description": "Possible sources of a clinical trial." + }, + "metadata": { + "$ref": "#/definitions/ClinicalTrialMetadata", + "description": "Trial data which is of interest to the potential participant." + } + }, + "required": [ + "type", + "value" + ] + }, + "TrialMatcherInferenceEvidence": { + "type": "object", + "description": "A piece of evidence corresponding to a Trial Matcher inference.", + "properties": { + "eligibilityCriteriaEvidence": { + "type": "string", + "description": "A piece of evidence from the eligibility criteria text of a clinical trial." + }, + "patientDataEvidence": { + "$ref": "#/definitions/ClinicalNoteEvidence", + "description": "A piece of evidence from a clinical note (text document)." + }, + "patientInfoEvidence": { + "$ref": "#/definitions/ClinicalCodedElement", + "description": "A piece of clinical information, expressed as a code in a clinical coding\nsystem." + }, + "importance": { + "type": "number", + "format": "float", + "description": "A value indicating how important this piece of evidence is for the inference.", + "minimum": 0, + "maximum": 1 + } + } + }, + "TrialMatcherInferenceResult": { + "type": "object", + "description": "The inference results for the Trial Matcher request.", + "properties": { + "patientResults": { + "type": "array", + "description": "Results for the patients given in the request.", + "items": { + "$ref": "#/definitions/TrialMatcherPatientResult" + }, + "x-ms-identifiers": [] + }, + "modelVersion": { + "$ref": "#/definitions/ModelVersion", + "description": "The version of the model used for inference, expressed as the model date." + }, + "knowledgeGraphLastUpdateDate": { + "type": "string", + "format": "date", + "description": "The date when the clinical trials knowledge graph was last updated." + } + }, + "required": [ + "patientResults", + "modelVersion" + ] + }, + "TrialMatcherInferenceType": { + "type": "string", + "description": "The type of the Trial Matcher inference.", + "enum": [ + "trialEligibility" + ], + "x-ms-enum": { + "name": "TrialMatcherInferenceType", + "modelAsString": true, + "values": [ + { + "name": "TrialEligibility", + "value": "trialEligibility" + } + ] + } + }, + "TrialMatcherJob": { + "type": "object", + "description": "Response for the Trial Matcher request.", + "properties": { + "jobData": { + "$ref": "#/definitions/TrialMatcherData", + "description": "The request data for the operation.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "result": { + "$ref": "#/definitions/TrialMatcherInferenceResult", + "description": "The result of the operation.", + "readOnly": true + }, + "id": { + "type": "string", + "description": "The unique ID of the job.", + "minLength": 3, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]+[a-zA-Z0-9]$", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The status of the job.", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job was created.", + "readOnly": true + }, + "expiresAt": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job is set to expire.", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job was last updated.", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Error object that describes the error when status is \"Failed\".", + "readOnly": true + } + }, + "required": [ + "id", + "status" + ] + }, + "TrialMatcherModelConfiguration": { + "type": "object", + "description": "Configuration affecting the Trial Matcher model's inference.", + "properties": { + "verbose": { + "type": "boolean", + "description": "An indication whether the model should produce verbose output.", + "default": false + }, + "includeEvidence": { + "type": "boolean", + "description": "An indication whether the model's output should include evidence for the inferences.", + "default": true + }, + "clinicalTrials": { + "$ref": "#/definitions/ClinicalTrials", + "description": "The clinical trials that the patient(s) should be matched to. The trial\nselection can be given as a list of custom clinical trials and/or a list of\nfilters to known clinical trial registries. In case both are given, the\nresulting trial set is a union of the two sets." + } + }, + "required": [ + "clinicalTrials" + ] + }, + "TrialMatcherPatientResult": { + "type": "object", + "description": "The results of the model's work for a single patient.", + "properties": { + "patientId": { + "type": "string", + "description": "The identifier given for the patient in the request." + }, + "inferences": { + "type": "array", + "description": "The inference results for the patient.", + "items": { + "$ref": "#/definitions/TrialMatcherInference" + }, + "x-ms-identifiers": [] + }, + "neededClinicalInfo": { + "$ref": "#/definitions/NeededClinicalInfo", + "description": "Clinical information which is needed to provide better trial matching results for the patient." + } + }, + "required": [ + "patientId", + "inferences" + ] + } + }, + "parameters": { + "Azure.Core.ExpandQueryParameter": { + "name": "expand", + "in": "query", + "description": "Expand the indicated resources into the response.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "x-ms-parameter-location": "method" + }, + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + } + } +} diff --git a/specification/ai/data-plane/HealthInsights/readme.md b/specification/ai/data-plane/HealthInsights/readme.md index 53968e027a2a..ff3bf66a5247 100644 --- a/specification/ai/data-plane/HealthInsights/readme.md +++ b/specification/ai/data-plane/HealthInsights/readme.md @@ -4,10 +4,10 @@ Configuration for generating Health Insights SDK. -The current release is `package-2024-04-01`. +The current release is `package-2024-08-01-preview`. ```yaml -tag: package-2024-04-01 +tag: package-2024-08-01-preview add-credentials: true openapi-type: data-plane ``` @@ -50,6 +50,21 @@ input-file: - stable/2024-04-01/openapi.json ``` +```yaml +directive: + - suppress: AvoidAnonymousTypes + reason: The spec is auto-generated. Tracking issue to fix is https://github.com/Azure/typespec-azure-pr/issues/3349 +``` + +### Release package-2024-08-01-preview + +These settings apply only when `--tag=package-2024-08-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-08-01-preview' +input-file: + - preview/2024-08-01-preview/openapi.json +``` + ```yaml directive: - suppress: AvoidAnonymousTypes From dc3c2752d37b091e2762818c5d1f793277f05e2d Mon Sep 17 00:00:00 2001 From: Mike Harder <mharder@microsoft.com> Date: Tue, 1 Oct 2024 15:01:27 -0700 Subject: [PATCH 22/47] Upgrade dependencies (#30818) --- eng/tools/specs-model/package.json | 2 +- eng/tools/suppressions/package.json | 2 +- eng/tools/tsp-client-tests/package.json | 2 +- eng/tools/typespec-requirement/package.json | 2 +- eng/tools/typespec-validation/package.json | 2 +- package-lock.json | 579 ++++++++++++-------- package.json | 2 +- 7 files changed, 347 insertions(+), 244 deletions(-) diff --git a/eng/tools/specs-model/package.json b/eng/tools/specs-model/package.json index 76937a240e11..c2a7eb6d990a 100644 --- a/eng/tools/specs-model/package.json +++ b/eng/tools/specs-model/package.json @@ -29,7 +29,7 @@ "@vitest/coverage-v8": "^2.0.4", "eslint": "^8.57.0", "eslint-plugin-unicorn": "^54.0.0", - "typescript": "~5.5.4", + "typescript": "~5.6.2", "typescript-eslint": "^7.16.0", "vitest": "^2.0.4" } diff --git a/eng/tools/suppressions/package.json b/eng/tools/suppressions/package.json index 5693ff57d0fa..0e7f38e7544c 100644 --- a/eng/tools/suppressions/package.json +++ b/eng/tools/suppressions/package.json @@ -24,7 +24,7 @@ "devDependencies": { "@types/node": "^18.19.31", "@vitest/coverage-v8": "^2.0.4", - "typescript": "~5.5.4", + "typescript": "~5.6.2", "vitest": "^2.0.4" } } diff --git a/eng/tools/tsp-client-tests/package.json b/eng/tools/tsp-client-tests/package.json index 87ec1cd20bf8..84fab0c2c943 100644 --- a/eng/tools/tsp-client-tests/package.json +++ b/eng/tools/tsp-client-tests/package.json @@ -5,7 +5,7 @@ "devDependencies": { "@types/node": "^18.19.31", "execa": "^9.3.0", - "typescript": "~5.5.4", + "typescript": "~5.6.2", "vitest": "^2.0.4" }, "scripts": { diff --git a/eng/tools/typespec-requirement/package.json b/eng/tools/typespec-requirement/package.json index 9663be1b00bf..ca94512736c4 100644 --- a/eng/tools/typespec-requirement/package.json +++ b/eng/tools/typespec-requirement/package.json @@ -5,7 +5,7 @@ "devDependencies": { "@types/node": "^18.19.31", "execa": "^9.3.0", - "typescript": "~5.5.4", + "typescript": "~5.6.2", "vitest": "^2.0.4" }, "scripts": { diff --git a/eng/tools/typespec-validation/package.json b/eng/tools/typespec-validation/package.json index b55534c750ca..6edf0c431073 100644 --- a/eng/tools/typespec-validation/package.json +++ b/eng/tools/typespec-validation/package.json @@ -15,7 +15,7 @@ "devDependencies": { "@types/node": "^18.19.31", "@vitest/coverage-v8": "^2.0.4", - "typescript": "~5.5.4", + "typescript": "~5.6.2", "vitest": "^2.0.4" }, "scripts": { diff --git a/package-lock.json b/package-lock.json index e54bdd8e9b3c..91ee30a15277 100644 --- a/package-lock.json +++ b/package-lock.json @@ -25,7 +25,7 @@ "azure-rest-api-specs-eng-tools": "file:eng/tools", "oav": "^3.3.7", "prettier": "~3.3.3", - "typescript": "~5.5.4" + "typescript": "~5.6.2" }, "engines": { "node": ">=18.0.0", @@ -44,9 +44,9 @@ } }, "eng/tools/node_modules/@types/node": { - "version": "18.19.50", - "resolved": "https://registry.npmjs.org/@types/node/-/node-18.19.50.tgz", - "integrity": "sha512-xonK+NRrMBRtkL1hVCc3G+uXtjh1Al4opBLjqVmipe5ZAaBYWW6cNAiBVZ1BvmkBhep698rP3UM3aRAdSALuhg==", + "version": "18.19.54", + "resolved": "https://registry.npmjs.org/@types/node/-/node-18.19.54.tgz", + "integrity": "sha512-+BRgt0G5gYjTvdLac9sIeE0iZcJxi4Jc4PV5EUzqi+88jmQLr+fRZdv2tCTV7IHKSGxM6SaLoOXQWWUiLUItMw==", "dev": true, "license": "MIT", "dependencies": { @@ -54,9 +54,9 @@ } }, "eng/tools/node_modules/@vitest/coverage-v8": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/@vitest/coverage-v8/-/coverage-v8-2.1.0.tgz", - "integrity": "sha512-yqCkr2nrV4o58VcVMxTVkS6Ggxzy7pmSD8JbTbhbH5PsQfUIES1QT716VUzo33wf2lX9EcWYdT3Vl2MMmjR59g==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/@vitest/coverage-v8/-/coverage-v8-2.1.1.tgz", + "integrity": "sha512-md/A7A3c42oTT8JUHSqjP5uKTWJejzUW4jalpvs+rZ27gsURsMU8DEb+8Jf8C6Kj2gwfSHJqobDNBuoqlm0cFw==", "dev": true, "license": "MIT", "dependencies": { @@ -77,8 +77,8 @@ "url": "https://opencollective.com/vitest" }, "peerDependencies": { - "@vitest/browser": "2.1.0", - "vitest": "2.1.0" + "@vitest/browser": "2.1.1", + "vitest": "2.1.1" }, "peerDependenciesMeta": { "@vitest/browser": { @@ -86,6 +86,34 @@ } } }, + "eng/tools/node_modules/@vitest/mocker": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-2.1.1.tgz", + "integrity": "sha512-LNN5VwOEdJqCmJ/2XJBywB11DLlkbY0ooDJW3uRX5cZyYCrc4PI/ePX0iQhE3BiEGiQmK4GE7Q/PqCkkaiPnrA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/spy": "^2.1.0-beta.1", + "estree-walker": "^3.0.3", + "magic-string": "^0.30.11" + }, + "funding": { + "url": "https://opencollective.com/vitest" + }, + "peerDependencies": { + "@vitest/spy": "2.1.1", + "msw": "^2.3.5", + "vite": "^5.0.0" + }, + "peerDependenciesMeta": { + "msw": { + "optional": true + }, + "vite": { + "optional": true + } + } + }, "eng/tools/node_modules/brace-expansion": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", @@ -120,9 +148,9 @@ "license": "MIT" }, "eng/tools/node_modules/vite": { - "version": "5.4.4", - "resolved": "https://registry.npmjs.org/vite/-/vite-5.4.4.tgz", - "integrity": "sha512-RHFCkULitycHVTtelJ6jQLd+KSAAzOgEYorV32R2q++M6COBjKJR6BxqClwp5sf0XaBDjVMuJ9wnNfyAJwjMkA==", + "version": "5.4.8", + "resolved": "https://registry.npmjs.org/vite/-/vite-5.4.8.tgz", + "integrity": "sha512-FqrItQ4DT1NC4zCUqMB4c4AZORMKIa0m8/URVCZ77OZ/QSNeJ54bU1vrFADbDsuwfIPcgknRkmqakQcgnL4GiQ==", "dev": true, "license": "MIT", "dependencies": { @@ -180,19 +208,19 @@ } }, "eng/tools/node_modules/vitest": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/vitest/-/vitest-2.1.0.tgz", - "integrity": "sha512-XuuEeyNkqbfr0FtAvd9vFbInSSNY1ykCQTYQ0sj9wPy4hx+1gR7gqVNdW0AX2wrrM1wWlN5fnJDjF9xG6mYRSQ==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/vitest/-/vitest-2.1.1.tgz", + "integrity": "sha512-97We7/VC0e9X5zBVkvt7SGQMGrRtn3KtySFQG5fpaMlS+l62eeXRQO633AYhSTC3z7IMebnPPNjGXVGNRFlxBA==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/expect": "2.1.0", - "@vitest/mocker": "2.1.0", - "@vitest/pretty-format": "^2.1.0", - "@vitest/runner": "2.1.0", - "@vitest/snapshot": "2.1.0", - "@vitest/spy": "2.1.0", - "@vitest/utils": "2.1.0", + "@vitest/expect": "2.1.1", + "@vitest/mocker": "2.1.1", + "@vitest/pretty-format": "^2.1.1", + "@vitest/runner": "2.1.1", + "@vitest/snapshot": "2.1.1", + "@vitest/spy": "2.1.1", + "@vitest/utils": "2.1.1", "chai": "^5.1.1", "debug": "^4.3.6", "magic-string": "^0.30.11", @@ -203,7 +231,7 @@ "tinypool": "^1.0.0", "tinyrainbow": "^1.2.0", "vite": "^5.0.0", - "vite-node": "2.1.0", + "vite-node": "2.1.1", "why-is-node-running": "^2.3.0" }, "bin": { @@ -218,8 +246,8 @@ "peerDependencies": { "@edge-runtime/vm": "*", "@types/node": "^18.0.0 || >=20.0.0", - "@vitest/browser": "2.1.0", - "@vitest/ui": "2.1.0", + "@vitest/browser": "2.1.1", + "@vitest/ui": "2.1.1", "happy-dom": "*", "jsdom": "*" }, @@ -244,34 +272,6 @@ } } }, - "eng/tools/node_modules/vitest/node_modules/@vitest/mocker": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-2.1.0.tgz", - "integrity": "sha512-ZxENovUqhzl+QiOFpagiHUNUuZ1qPd5yYTCYHomGIZOFArzn4mgX2oxZmiAItJWAaXHG6bbpb/DpSPhlk5DgtA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@vitest/spy": "^2.1.0-beta.1", - "estree-walker": "^3.0.3", - "magic-string": "^0.30.11" - }, - "funding": { - "url": "https://opencollective.com/vitest" - }, - "peerDependencies": { - "@vitest/spy": "2.1.0", - "msw": "^2.3.5", - "vite": "^5.0.0" - }, - "peerDependenciesMeta": { - "msw": { - "optional": true - }, - "vite": { - "optional": true - } - } - }, "eng/tools/specs-model": { "name": "@azure-tools/specs-model", "dev": true, @@ -287,7 +287,7 @@ "@vitest/coverage-v8": "^2.0.4", "eslint": "^8.57.0", "eslint-plugin-unicorn": "^54.0.0", - "typescript": "~5.5.4", + "typescript": "~5.6.2", "typescript-eslint": "^7.16.0", "vitest": "^2.0.4" }, @@ -311,7 +311,7 @@ "devDependencies": { "@types/node": "^18.19.31", "@vitest/coverage-v8": "^2.0.4", - "typescript": "~5.5.4", + "typescript": "~5.6.2", "vitest": "^2.0.4" }, "engines": { @@ -325,7 +325,7 @@ "devDependencies": { "@types/node": "^18.19.31", "execa": "^9.3.0", - "typescript": "~5.5.4", + "typescript": "~5.6.2", "vitest": "^2.0.4" }, "engines": { @@ -339,7 +339,7 @@ "devDependencies": { "@types/node": "^18.19.31", "execa": "^9.3.0", - "typescript": "~5.5.4", + "typescript": "~5.6.2", "vitest": "^2.0.4" }, "engines": { @@ -362,7 +362,7 @@ "devDependencies": { "@types/node": "^18.19.31", "@vitest/coverage-v8": "^2.0.4", - "typescript": "~5.5.4", + "typescript": "~5.6.2", "vitest": "^2.0.4" }, "engines": { @@ -1206,9 +1206,10 @@ } }, "node_modules/@azure/core-http": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/@azure/core-http/-/core-http-3.0.3.tgz", - "integrity": "sha512-QMib3wXotJMFhHgmJBPUF9YsyErw34H0XDFQd9CauH7TPB+RGcyl9Ayy7iURtJB04ngXhE6YwrQsWDXlSLrilg==", + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@azure/core-http/-/core-http-3.0.4.tgz", + "integrity": "sha512-Fok9VVhMdxAFOtqiiAtg74fL0UJkt0z3D+ouUUxcRLzZNBioPRAMJFVxiWoJljYpXsRi4GDQHzQHDc9AiYaIUQ==", + "deprecated": "This package is no longer supported. Please migrate to use @azure/core-rest-pipeline", "dev": true, "license": "MIT", "dependencies": { @@ -2046,9 +2047,9 @@ } }, "node_modules/@eslint-community/regexpp": { - "version": "4.11.0", - "resolved": "https://registry.npmjs.org/@eslint-community/regexpp/-/regexpp-4.11.0.tgz", - "integrity": "sha512-G/M/tIiMrTAxEWRfLfQJMmGNX28IxBg4PBz8XqQhqUHLFI6TL2htpIB1iQCj144V5ee/JaKyT9/WZ0MGZWfA7A==", + "version": "4.11.1", + "resolved": "https://registry.npmjs.org/@eslint-community/regexpp/-/regexpp-4.11.1.tgz", + "integrity": "sha512-m4DVN9ZqskZoLU5GlWZadwDnYo3vAEydiUayB9widCl9ffWx2IvPnp6n3on5rJmziJSw9Bv+Z3ChDVdMwXCY8Q==", "dev": true, "license": "MIT", "engines": { @@ -2104,9 +2105,9 @@ "license": "MIT" }, "node_modules/@eslint/js": { - "version": "9.10.0", - "resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.10.0.tgz", - "integrity": "sha512-fuXtbiP5GWIn8Fz+LWoOMVf/Jxm+aajZYkhi6CuEm4SxymFM+eUWzbO9qXT+L0iCkL5+KGYMCSGxo686H19S1g==", + "version": "9.11.1", + "resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.11.1.tgz", + "integrity": "sha512-/qu+TWz8WwPWc7/HcIJKi+c+MOm46GdVaSlTTQcaqaL53+GsoA6MxWp5PtTx48qbSP7ylM1Kn7nhvkugfJvRSA==", "dev": true, "license": "MIT", "engines": { @@ -2117,18 +2118,19 @@ "version": "5.5.3", "resolved": "https://registry.npmjs.org/@faker-js/faker/-/faker-5.5.3.tgz", "integrity": "sha512-R11tGE6yIFwqpaIqcfkcg7AICXzFg14+5h5v0TfF/9+RMDL6jhzCy/pxHVOfbALGdtVYdt6JdR21tuxEgl34dw==", + "deprecated": "Please update to a newer version.", "dev": true, "license": "MIT" }, "node_modules/@humanwhocodes/config-array": { - "version": "0.11.14", - "resolved": "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.11.14.tgz", - "integrity": "sha512-3T8LkOmg45BV5FICb15QQMsyUSWrQ8AygVfC7ZG32zOalnqrilm018ZVCw0eapXux8FtA33q8PSRSstjee3jSg==", + "version": "0.13.0", + "resolved": "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.13.0.tgz", + "integrity": "sha512-DZLEEqFWQFiyK6h5YIeynKx7JlvCYWL0cImfSRXZ9l4Sg2efkFGTuFf6vzXjK1cq6IYkU+Eg/JizXw+TD2vRNw==", "deprecated": "Use @eslint/config-array instead", "dev": true, "license": "Apache-2.0", "dependencies": { - "@humanwhocodes/object-schema": "^2.0.2", + "@humanwhocodes/object-schema": "^2.0.3", "debug": "^4.3.1", "minimatch": "^3.0.5" }, @@ -2580,9 +2582,9 @@ } }, "node_modules/@rollup/rollup-android-arm-eabi": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.21.3.tgz", - "integrity": "sha512-MmKSfaB9GX+zXl6E8z4koOr/xU63AMVleLEa64v7R0QF/ZloMs5vcD1sHgM64GXXS1csaJutG+ddtzcueI/BLg==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.23.0.tgz", + "integrity": "sha512-8OR+Ok3SGEMsAZispLx8jruuXw0HVF16k+ub2eNXKHDmdxL4cf9NlNpAzhlOhNyXzKDEJuFeq0nZm+XlNb1IFw==", "cpu": [ "arm" ], @@ -2594,9 +2596,9 @@ ] }, "node_modules/@rollup/rollup-android-arm64": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.21.3.tgz", - "integrity": "sha512-zrt8ecH07PE3sB4jPOggweBjJMzI1JG5xI2DIsUbkA+7K+Gkjys6eV7i9pOenNSDJH3eOr/jLb/PzqtmdwDq5g==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.23.0.tgz", + "integrity": "sha512-rEFtX1nP8gqmLmPZsXRMoLVNB5JBwOzIAk/XAcEPuKrPa2nPJ+DuGGpfQUR0XjRm8KjHfTZLpWbKXkA5BoFL3w==", "cpu": [ "arm64" ], @@ -2608,9 +2610,9 @@ ] }, "node_modules/@rollup/rollup-darwin-arm64": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.21.3.tgz", - "integrity": "sha512-P0UxIOrKNBFTQaXTxOH4RxuEBVCgEA5UTNV6Yz7z9QHnUJ7eLX9reOd/NYMO3+XZO2cco19mXTxDMXxit4R/eQ==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.23.0.tgz", + "integrity": "sha512-ZbqlMkJRMMPeapfaU4drYHns7Q5MIxjM/QeOO62qQZGPh9XWziap+NF9fsqPHT0KzEL6HaPspC7sOwpgyA3J9g==", "cpu": [ "arm64" ], @@ -2622,9 +2624,9 @@ ] }, "node_modules/@rollup/rollup-darwin-x64": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.21.3.tgz", - "integrity": "sha512-L1M0vKGO5ASKntqtsFEjTq/fD91vAqnzeaF6sfNAy55aD+Hi2pBI5DKwCO+UNDQHWsDViJLqshxOahXyLSh3EA==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.23.0.tgz", + "integrity": "sha512-PfmgQp78xx5rBCgn2oYPQ1rQTtOaQCna0kRaBlc5w7RlA3TDGGo7m3XaptgitUZ54US9915i7KeVPHoy3/W8tA==", "cpu": [ "x64" ], @@ -2636,9 +2638,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm-gnueabihf": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.21.3.tgz", - "integrity": "sha512-btVgIsCjuYFKUjopPoWiDqmoUXQDiW2A4C3Mtmp5vACm7/GnyuprqIDPNczeyR5W8rTXEbkmrJux7cJmD99D2g==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.23.0.tgz", + "integrity": "sha512-WAeZfAAPus56eQgBioezXRRzArAjWJGjNo/M+BHZygUcs9EePIuGI1Wfc6U/Ki+tMW17FFGvhCfYnfcKPh18SA==", "cpu": [ "arm" ], @@ -2650,9 +2652,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm-musleabihf": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.21.3.tgz", - "integrity": "sha512-zmjbSphplZlau6ZTkxd3+NMtE4UKVy7U4aVFMmHcgO5CUbw17ZP6QCgyxhzGaU/wFFdTfiojjbLG3/0p9HhAqA==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.23.0.tgz", + "integrity": "sha512-v7PGcp1O5XKZxKX8phTXtmJDVpE20Ub1eF6w9iMmI3qrrPak6yR9/5eeq7ziLMrMTjppkkskXyxnmm00HdtXjA==", "cpu": [ "arm" ], @@ -2664,9 +2666,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm64-gnu": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.21.3.tgz", - "integrity": "sha512-nSZfcZtAnQPRZmUkUQwZq2OjQciR6tEoJaZVFvLHsj0MF6QhNMg0fQ6mUOsiCUpTqxTx0/O6gX0V/nYc7LrgPw==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.23.0.tgz", + "integrity": "sha512-nAbWsDZ9UkU6xQiXEyXBNHAKbzSAi95H3gTStJq9UGiS1v+YVXwRHcQOQEF/3CHuhX5BVhShKoeOf6Q/1M+Zhg==", "cpu": [ "arm64" ], @@ -2678,9 +2680,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm64-musl": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.21.3.tgz", - "integrity": "sha512-MnvSPGO8KJXIMGlQDYfvYS3IosFN2rKsvxRpPO2l2cum+Z3exiExLwVU+GExL96pn8IP+GdH8Tz70EpBhO0sIQ==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.23.0.tgz", + "integrity": "sha512-5QT/Di5FbGNPaVw8hHO1wETunwkPuZBIu6W+5GNArlKHD9fkMHy7vS8zGHJk38oObXfWdsuLMogD4sBySLJ54g==", "cpu": [ "arm64" ], @@ -2692,9 +2694,9 @@ ] }, "node_modules/@rollup/rollup-linux-powerpc64le-gnu": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-powerpc64le-gnu/-/rollup-linux-powerpc64le-gnu-4.21.3.tgz", - "integrity": "sha512-+W+p/9QNDr2vE2AXU0qIy0qQE75E8RTwTwgqS2G5CRQ11vzq0tbnfBd6brWhS9bCRjAjepJe2fvvkvS3dno+iw==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-powerpc64le-gnu/-/rollup-linux-powerpc64le-gnu-4.23.0.tgz", + "integrity": "sha512-Sefl6vPyn5axzCsO13r1sHLcmPuiSOrKIImnq34CBurntcJ+lkQgAaTt/9JkgGmaZJ+OkaHmAJl4Bfd0DmdtOQ==", "cpu": [ "ppc64" ], @@ -2706,9 +2708,9 @@ ] }, "node_modules/@rollup/rollup-linux-riscv64-gnu": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.21.3.tgz", - "integrity": "sha512-yXH6K6KfqGXaxHrtr+Uoy+JpNlUlI46BKVyonGiaD74ravdnF9BUNC+vV+SIuB96hUMGShhKV693rF9QDfO6nQ==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.23.0.tgz", + "integrity": "sha512-o4QI2KU/QbP7ZExMse6ULotdV3oJUYMrdx3rBZCgUF3ur3gJPfe8Fuasn6tia16c5kZBBw0aTmaUygad6VB/hQ==", "cpu": [ "riscv64" ], @@ -2720,9 +2722,9 @@ ] }, "node_modules/@rollup/rollup-linux-s390x-gnu": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.21.3.tgz", - "integrity": "sha512-R8cwY9wcnApN/KDYWTH4gV/ypvy9yZUHlbJvfaiXSB48JO3KpwSpjOGqO4jnGkLDSk1hgjYkTbTt6Q7uvPf8eg==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.23.0.tgz", + "integrity": "sha512-+bxqx+V/D4FGrpXzPGKp/SEZIZ8cIW3K7wOtcJAoCrmXvzRtmdUhYNbgd+RztLzfDEfA2WtKj5F4tcbNPuqgeg==", "cpu": [ "s390x" ], @@ -2734,9 +2736,9 @@ ] }, "node_modules/@rollup/rollup-linux-x64-gnu": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.21.3.tgz", - "integrity": "sha512-kZPbX/NOPh0vhS5sI+dR8L1bU2cSO9FgxwM8r7wHzGydzfSjLRCFAT87GR5U9scj2rhzN3JPYVC7NoBbl4FZ0g==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.23.0.tgz", + "integrity": "sha512-I/eXsdVoCKtSgK9OwyQKPAfricWKUMNCwJKtatRYMmDo5N859tbO3UsBw5kT3dU1n6ZcM1JDzPRSGhAUkxfLxw==", "cpu": [ "x64" ], @@ -2748,9 +2750,9 @@ ] }, "node_modules/@rollup/rollup-linux-x64-musl": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.21.3.tgz", - "integrity": "sha512-S0Yq+xA1VEH66uiMNhijsWAafffydd2X5b77eLHfRmfLsRSpbiAWiRHV6DEpz6aOToPsgid7TI9rGd6zB1rhbg==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.23.0.tgz", + "integrity": "sha512-4ZoDZy5ShLbbe1KPSafbFh1vbl0asTVfkABC7eWqIs01+66ncM82YJxV2VtV3YVJTqq2P8HMx3DCoRSWB/N3rw==", "cpu": [ "x64" ], @@ -2762,9 +2764,9 @@ ] }, "node_modules/@rollup/rollup-win32-arm64-msvc": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.21.3.tgz", - "integrity": "sha512-9isNzeL34yquCPyerog+IMCNxKR8XYmGd0tHSV+OVx0TmE0aJOo9uw4fZfUuk2qxobP5sug6vNdZR6u7Mw7Q+Q==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.23.0.tgz", + "integrity": "sha512-+5Ky8dhft4STaOEbZu3/NU4QIyYssKO+r1cD3FzuusA0vO5gso15on7qGzKdNXnc1gOrsgCqZjRw1w+zL4y4hQ==", "cpu": [ "arm64" ], @@ -2776,9 +2778,9 @@ ] }, "node_modules/@rollup/rollup-win32-ia32-msvc": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.21.3.tgz", - "integrity": "sha512-nMIdKnfZfzn1Vsk+RuOvl43ONTZXoAPUUxgcU0tXooqg4YrAqzfKzVenqqk2g5efWh46/D28cKFrOzDSW28gTA==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.23.0.tgz", + "integrity": "sha512-0SPJk4cPZQhq9qA1UhIRumSE3+JJIBBjtlGl5PNC///BoaByckNZd53rOYD0glpTkYFBQSt7AkMeLVPfx65+BQ==", "cpu": [ "ia32" ], @@ -2790,9 +2792,9 @@ ] }, "node_modules/@rollup/rollup-win32-x64-msvc": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.21.3.tgz", - "integrity": "sha512-fOvu7PCQjAj4eWDEuD8Xz5gpzFqXzGlxHZozHP4b9Jxv9APtdxL6STqztDzMLuRXEc4UpXGGhx029Xgm91QBeA==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.23.0.tgz", + "integrity": "sha512-lqCK5GQC8fNo0+JvTSxcG7YB1UKYp8yrNLhsArlvPWN+16ovSZgoehlVHg6X0sSWPUkpjRBR5TuR12ZugowZ4g==", "cpu": [ "x64" ], @@ -3113,9 +3115,9 @@ } }, "node_modules/@types/estree": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.5.tgz", - "integrity": "sha512-/kYRxGDLWzHOB7q+wtSUQlFrtcdUccpfy+X+9iMBpHK8QLLhx2wIPYuS5DYtR9Wa/YlZAbIovy7qVdB1Aq6Lyw==", + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.6.tgz", + "integrity": "sha512-AYnb1nQyY49te+VRAVgmzfcgjYS91mY5P0TKUDCLEM+gNnA+3T6rWITXRLYCpahpqSQbN5cE+gHpnPyXjHWxcw==", "dev": true, "license": "MIT" }, @@ -3593,14 +3595,14 @@ "license": "ISC" }, "node_modules/@vitest/expect": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-2.1.0.tgz", - "integrity": "sha512-N3/xR4fSu0+6sVZETEtPT1orUs2+Y477JOXTcU3xKuu3uBlsgbD7/7Mz2LZ1Jr1XjwilEWlrIgSCj4N1+5ZmsQ==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-2.1.1.tgz", + "integrity": "sha512-YeueunS0HiHiQxk+KEOnq/QMzlUuOzbU1Go+PgAsHvvv3tUkJPm9xWt+6ITNTlzsMXUjmgm5T+U7KBPK2qQV6w==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/spy": "2.1.0", - "@vitest/utils": "2.1.0", + "@vitest/spy": "2.1.1", + "@vitest/utils": "2.1.1", "chai": "^5.1.1", "tinyrainbow": "^1.2.0" }, @@ -3609,9 +3611,9 @@ } }, "node_modules/@vitest/pretty-format": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-2.1.0.tgz", - "integrity": "sha512-7sxf2F3DNYatgmzXXcTh6cq+/fxwB47RIQqZJFoSH883wnVAoccSRT6g+dTKemUBo8Q5N4OYYj1EBXLuRKvp3Q==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-2.1.1.tgz", + "integrity": "sha512-SjxPFOtuINDUW8/UkElJYQSFtnWX7tMksSGW0vfjxMneFqxVr8YJ979QpMbDW7g+BIiq88RAGDjf7en6rvLPPQ==", "dev": true, "license": "MIT", "dependencies": { @@ -3622,13 +3624,13 @@ } }, "node_modules/@vitest/runner": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-2.1.0.tgz", - "integrity": "sha512-D9+ZiB8MbMt7qWDRJc4CRNNUlne/8E1X7dcKhZVAbcOKG58MGGYVDqAq19xlhNfMFZsW0bpVKgztBwks38Ko0w==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-2.1.1.tgz", + "integrity": "sha512-uTPuY6PWOYitIkLPidaY5L3t0JJITdGTSwBtwMjKzo5O6RCOEncz9PUN+0pDidX8kTHYjO0EwUIvhlGpnGpxmA==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/utils": "2.1.0", + "@vitest/utils": "2.1.1", "pathe": "^1.1.2" }, "funding": { @@ -3636,13 +3638,13 @@ } }, "node_modules/@vitest/snapshot": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-2.1.0.tgz", - "integrity": "sha512-x69CygGMzt9VCO283K2/FYQ+nBrOj66OTKpsPykjCR4Ac3lLV+m85hj9reaIGmjBSsKzVvbxWmjWE3kF5ha3uQ==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-2.1.1.tgz", + "integrity": "sha512-BnSku1WFy7r4mm96ha2FzN99AZJgpZOWrAhtQfoxjUU5YMRpq1zmHRq7a5K9/NjqonebO7iVDla+VvZS8BOWMw==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/pretty-format": "2.1.0", + "@vitest/pretty-format": "2.1.1", "magic-string": "^0.30.11", "pathe": "^1.1.2" }, @@ -3651,9 +3653,9 @@ } }, "node_modules/@vitest/spy": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-2.1.0.tgz", - "integrity": "sha512-IXX5NkbdgTYTog3F14i2LgnBc+20YmkXMx0IWai84mcxySUDRgm0ihbOfR4L0EVRBDFG85GjmQQEZNNKVVpkZw==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-2.1.1.tgz", + "integrity": "sha512-ZM39BnZ9t/xZ/nF4UwRH5il0Sw93QnZXd9NAZGRpIgj0yvVwPpLd702s/Cx955rGaMlyBQkZJ2Ir7qyY48VZ+g==", "dev": true, "license": "MIT", "dependencies": { @@ -3664,13 +3666,13 @@ } }, "node_modules/@vitest/utils": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-2.1.0.tgz", - "integrity": "sha512-rreyfVe0PuNqJfKYUwfPDfi6rrp0VSu0Wgvp5WBqJonP+4NvXHk48X6oBam1Lj47Hy6jbJtnMj3OcRdrkTP0tA==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-2.1.1.tgz", + "integrity": "sha512-Y6Q9TsI+qJ2CC0ZKj6VBb+T8UPz593N113nnUykqwANqhgf3QkZeHFlusgKLTqrnVHbj/XDKZcDHol+dxVT+rQ==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/pretty-format": "2.1.0", + "@vitest/pretty-format": "2.1.1", "loupe": "^3.1.1", "tinyrainbow": "^1.2.0" }, @@ -4011,9 +4013,9 @@ } }, "node_modules/browserslist": { - "version": "4.23.3", - "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.23.3.tgz", - "integrity": "sha512-btwCFJVjI4YWDNfau8RhZ+B1Q/VLoUITrm3RlP6y1tYGWIOa+InuYiRGXUBXo8nA1qKmHMyLB/iVQg5TT4eFoA==", + "version": "4.24.0", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.24.0.tgz", + "integrity": "sha512-Rmb62sR1Zpjql25eSanFGEhAxcFwfA1K0GuQcLoaJBAcENegrQut3hYdhXFF1obQfiDyqIW/cLM5HSJ/9k884A==", "dev": true, "funding": [ { @@ -4031,8 +4033,8 @@ ], "license": "MIT", "dependencies": { - "caniuse-lite": "^1.0.30001646", - "electron-to-chromium": "^1.5.4", + "caniuse-lite": "^1.0.30001663", + "electron-to-chromium": "^1.5.28", "node-releases": "^2.0.18", "update-browserslist-db": "^1.1.0" }, @@ -4043,6 +4045,31 @@ "node": "^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7" } }, + "node_modules/buffer": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/buffer/-/buffer-6.0.3.tgz", + "integrity": "sha512-FTiCpNxtwiZZHEZbcbTIcZjERVICn9yq/pDFkTl95/AxzD1naBctN7YO68riM/gLSDY7sdrMby8hofADYuuqOA==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT", + "dependencies": { + "base64-js": "^1.3.1", + "ieee754": "^1.2.1" + } + }, "node_modules/builtin-modules": { "version": "3.3.0", "resolved": "https://registry.npmjs.org/builtin-modules/-/builtin-modules-3.3.0.tgz", @@ -4094,9 +4121,9 @@ } }, "node_modules/caniuse-lite": { - "version": "1.0.30001660", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001660.tgz", - "integrity": "sha512-GacvNTTuATm26qC74pt+ad1fW15mlQ/zuTzzY1ZoIzECTP8HURDfF43kNxPgf7H1jmelCBQTTbBNxdSXOA7Bqg==", + "version": "1.0.30001664", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001664.tgz", + "integrity": "sha512-AmE7k4dXiNKQipgn7a2xg558IRqPN3jMQY/rOsbxDhrd0tyChwbITBfiwtnqz8bi2M5mIWbxAYBvk7W7QBUS2g==", "dev": true, "funding": [ { @@ -4670,9 +4697,9 @@ } }, "node_modules/electron-to-chromium": { - "version": "1.5.20", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.20.tgz", - "integrity": "sha512-74mdl6Fs1HHzK9SUX4CKFxAtAe3nUns48y79TskHNAG6fGOlLfyKA4j855x+0b5u8rWJIrlaG9tcTPstMlwjIw==", + "version": "1.5.30", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.30.tgz", + "integrity": "sha512-sXI35EBN4lYxzc/pIGorlymYNzDBOqkSlVRe6MkgBsW/hW1tpC/HDJ2fjG7XnjakzfLEuvdmux0Mjs6jHq4UOA==", "dev": true, "license": "ISC" }, @@ -4774,17 +4801,17 @@ } }, "node_modules/eslint": { - "version": "8.57.0", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.57.0.tgz", - "integrity": "sha512-dZ6+mexnaTIbSBZWgou51U6OmzIhYM2VcNdtiTtI7qPNZm35Akpr0f6vtw3w1Kmn5PYo+tZVfh13WrhpS6oLqQ==", + "version": "8.57.1", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.57.1.tgz", + "integrity": "sha512-ypowyDxpVSYpkXr9WPv2PAZCtNip1Mv5KTW0SCurXv/9iOpcrH9PaqUElksqEB6pChqHGDRCFTyrZlGhnLNGiA==", "dev": true, "license": "MIT", "dependencies": { "@eslint-community/eslint-utils": "^4.2.0", "@eslint-community/regexpp": "^4.6.1", "@eslint/eslintrc": "^2.1.4", - "@eslint/js": "8.57.0", - "@humanwhocodes/config-array": "^0.11.14", + "@eslint/js": "8.57.1", + "@humanwhocodes/config-array": "^0.13.0", "@humanwhocodes/module-importer": "^1.0.1", "@nodelib/fs.walk": "^1.2.8", "@ungap/structured-clone": "^1.2.0", @@ -4905,9 +4932,9 @@ } }, "node_modules/eslint-plugin-unicorn/node_modules/eslint-visitor-keys": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-4.0.0.tgz", - "integrity": "sha512-OtIRv/2GyiF6o/d8K7MYKKbXrOUBIK6SfkIRM4Z0dY3w+LiQ0vy3F57m0Z71bjbyeiWFiHJ8brqnmE6H6/jEuw==", + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-4.1.0.tgz", + "integrity": "sha512-Q7lok0mqMUSf5a/AdAZkA5a/gHcO6snwQClVNNvFKCAVlxXucdU8pKydU5ZVZjBx5xr37vGbFFWtLQYreLzrZg==", "dev": true, "license": "Apache-2.0", "engines": { @@ -4918,15 +4945,15 @@ } }, "node_modules/eslint-plugin-unicorn/node_modules/espree": { - "version": "10.1.0", - "resolved": "https://registry.npmjs.org/espree/-/espree-10.1.0.tgz", - "integrity": "sha512-M1M6CpiE6ffoigIOWYO9UDP8TMUw9kqb21tf+08IgDYjCsOvCuDt4jQcZmoYxx+w7zlKw9/N0KXfto+I8/FrXA==", + "version": "10.2.0", + "resolved": "https://registry.npmjs.org/espree/-/espree-10.2.0.tgz", + "integrity": "sha512-upbkBJbckcCNBDBDXEbuhjbP68n+scUd3k/U2EkyM9nw+I/jPiL4cLF/Al06CF96wRltFda16sxDFrxsI1v0/g==", "dev": true, "license": "BSD-2-Clause", "dependencies": { "acorn": "^8.12.0", "acorn-jsx": "^5.3.2", - "eslint-visitor-keys": "^4.0.0" + "eslint-visitor-keys": "^4.1.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -4986,9 +5013,9 @@ } }, "node_modules/eslint/node_modules/@eslint/js": { - "version": "8.57.0", - "resolved": "https://registry.npmjs.org/@eslint/js/-/js-8.57.0.tgz", - "integrity": "sha512-Ys+3g2TaW7gADOJzPt83SJtCDhMjndcDMFVQ/Tj9iA1BfJzFKD9mAUXT3OenpuPHbI6P/myECxRJrofUsDx/5g==", + "version": "8.57.1", + "resolved": "https://registry.npmjs.org/@eslint/js/-/js-8.57.1.tgz", + "integrity": "sha512-d9zaMRSTIKDLhctzH12MtXvJKSSUhaHcjV+2Z+GK+EEY7XKpP5yR4x+N3TAcHTcu963nIr+TMcCb4DBCYX1z6Q==", "dev": true, "license": "MIT", "engines": { @@ -5271,10 +5298,20 @@ "node": ">=6" } }, + "node_modules/events": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/events/-/events-3.3.0.tgz", + "integrity": "sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.8.x" + } + }, "node_modules/execa": { - "version": "9.3.1", - "resolved": "https://registry.npmjs.org/execa/-/execa-9.3.1.tgz", - "integrity": "sha512-gdhefCCNy/8tpH/2+ajP9IQc14vXchNdd0weyzSJEFURhRMGncQ+zKFxwjAufIewPEJm9BPOaJnvg2UtlH2gPQ==", + "version": "9.4.0", + "resolved": "https://registry.npmjs.org/execa/-/execa-9.4.0.tgz", + "integrity": "sha512-yKHlle2YGxZE842MERVIplWwNH5VYmqqcPFgtnlU//K8gxuFFXu0pwd/CrfXTumFpeEiufsP7+opT/bPJa1yVw==", "dev": true, "license": "MIT", "dependencies": { @@ -5285,7 +5322,7 @@ "human-signals": "^8.0.0", "is-plain-obj": "^4.1.0", "is-stream": "^4.0.1", - "npm-run-path": "^5.2.0", + "npm-run-path": "^6.0.0", "pretty-ms": "^9.0.0", "signal-exit": "^4.1.0", "strip-final-newline": "^4.0.0", @@ -5409,9 +5446,9 @@ "license": "MIT" }, "node_modules/fast-uri": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.0.1.tgz", - "integrity": "sha512-MWipKbbYiYI0UC7cl8m/i/IWTqfC8YXsqjzybjddLsFjStroQzsHXkc73JutMvBiXmOvapk+axIl79ig5t55Bw==", + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.0.2.tgz", + "integrity": "sha512-GR6f0hD7XXyNJa25Tb9BuIdN0tdr+0BMi6/CJPH3wJO1JjNG3n/VsSw38AwRdKZABm8lGbPfakLRkYzx2V9row==", "dev": true, "license": "MIT" }, @@ -6101,6 +6138,27 @@ "node": ">=0.10.0" } }, + "node_modules/ieee754": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/ieee754/-/ieee754-1.2.1.tgz", + "integrity": "sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "BSD-3-Clause" + }, "node_modules/ignore": { "version": "5.3.2", "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.2.tgz", @@ -7294,16 +7352,17 @@ } }, "node_modules/npm-run-path": { - "version": "5.3.0", - "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-5.3.0.tgz", - "integrity": "sha512-ppwTtiJZq0O/ai0z7yfudtBpWIoxM8yE6nHi1X47eFR2EWORqfbu6CnPlNsjeN683eT0qG6H/Pyf9fCcvjnnnQ==", + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-6.0.0.tgz", + "integrity": "sha512-9qny7Z9DsQU8Ou39ERsPU4OZQlSTP47ShQzuKZ6PRXpYLtIFgl/DEBYEXKlvcEa+9tHVcK8CF81Y2V72qaZhWA==", "dev": true, "license": "MIT", "dependencies": { - "path-key": "^4.0.0" + "path-key": "^4.0.0", + "unicorn-magic": "^0.3.0" }, "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + "node": ">=18" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" @@ -7322,6 +7381,19 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/npm-run-path/node_modules/unicorn-magic": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/unicorn-magic/-/unicorn-magic-0.3.0.tgz", + "integrity": "sha512-+QBBXBCvifc56fsbuxZQ6Sic3wqqc3WWaqxs58gvJrcOuN83HGTCwz3oS5phzU9LthRNE9VrJCFCLUgHeeFnfA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/oauth-sign": { "version": "0.9.0", "resolved": "https://registry.npmjs.org/oauth-sign/-/oauth-sign-0.9.0.tgz", @@ -7647,9 +7719,9 @@ } }, "node_modules/package-json-from-dist": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/package-json-from-dist/-/package-json-from-dist-1.0.0.tgz", - "integrity": "sha512-dATvCeZN/8wQsGywez1mzHtTlP22H8OEfPrVMLNr4/eGa+ijtLn/6M5f0dY8UKNrC2O9UCU6SSoG3qRKnt7STw==", + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/package-json-from-dist/-/package-json-from-dist-1.0.1.tgz", + "integrity": "sha512-UEZIS3/by4OC8vL3P2dTXRETpebLI2NiI5vIrjaD/5UtrkFX/tNbwjTSRAGC/+7CAo2pIcBaRgWmcBBHcsaCIw==", "dev": true, "license": "BlueOak-1.0.0" }, @@ -7831,9 +7903,9 @@ } }, "node_modules/postcss": { - "version": "8.4.45", - "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.45.tgz", - "integrity": "sha512-7KTLTdzdZZYscUc65XmjFiB73vBhBfbPztCYdUNvlaso9PrzjzcmjqBPR0lNGkcVlcO4BjiO5rK/qNz+XAen1Q==", + "version": "8.4.47", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.47.tgz", + "integrity": "sha512-56rxCq7G/XfB4EkXq9Egn5GCqugWvDFjafDOThIdMBsI15iqPqR5r15TfSr1YPYeEI19YeaXMCbY6u88Y76GLQ==", "dev": true, "funding": [ { @@ -7852,13 +7924,20 @@ "license": "MIT", "dependencies": { "nanoid": "^3.3.7", - "picocolors": "^1.0.1", - "source-map-js": "^1.2.0" + "picocolors": "^1.1.0", + "source-map-js": "^1.2.1" }, "engines": { "node": "^10 || ^12 || >=14" } }, + "node_modules/postcss/node_modules/picocolors": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.0.tgz", + "integrity": "sha512-TQ92mBOW0l3LeMeyLV6mzy/kWr8lkd/hp3mTg7wYK7zJhuBStmGMBG0BdeDZS/dZx1IukaX6Bk11zcln25o1Aw==", + "dev": true, + "license": "ISC" + }, "node_modules/postman-collection": { "version": "4.5.0", "resolved": "https://registry.npmjs.org/postman-collection/-/postman-collection-4.5.0.tgz", @@ -8478,13 +8557,13 @@ } }, "node_modules/rollup": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.21.3.tgz", - "integrity": "sha512-7sqRtBNnEbcBtMeRVc6VRsJMmpI+JU1z9VTvW8D4gXIYQFz0aLcsE6rRkyghZkLfEgUZgVvOG7A5CVz/VW5GIA==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.23.0.tgz", + "integrity": "sha512-vXB4IT9/KLDrS2WRXmY22sVB2wTsTwkpxjB8Q3mnakTENcYw3FRmfdYDy/acNmls+lHmDazgrRjK/yQ6hQAtwA==", "dev": true, "license": "MIT", "dependencies": { - "@types/estree": "1.0.5" + "@types/estree": "1.0.6" }, "bin": { "rollup": "dist/bin/rollup" @@ -8494,22 +8573,22 @@ "npm": ">=8.0.0" }, "optionalDependencies": { - "@rollup/rollup-android-arm-eabi": "4.21.3", - "@rollup/rollup-android-arm64": "4.21.3", - "@rollup/rollup-darwin-arm64": "4.21.3", - "@rollup/rollup-darwin-x64": "4.21.3", - "@rollup/rollup-linux-arm-gnueabihf": "4.21.3", - "@rollup/rollup-linux-arm-musleabihf": "4.21.3", - "@rollup/rollup-linux-arm64-gnu": "4.21.3", - "@rollup/rollup-linux-arm64-musl": "4.21.3", - "@rollup/rollup-linux-powerpc64le-gnu": "4.21.3", - "@rollup/rollup-linux-riscv64-gnu": "4.21.3", - "@rollup/rollup-linux-s390x-gnu": "4.21.3", - "@rollup/rollup-linux-x64-gnu": "4.21.3", - "@rollup/rollup-linux-x64-musl": "4.21.3", - "@rollup/rollup-win32-arm64-msvc": "4.21.3", - "@rollup/rollup-win32-ia32-msvc": "4.21.3", - "@rollup/rollup-win32-x64-msvc": "4.21.3", + "@rollup/rollup-android-arm-eabi": "4.23.0", + "@rollup/rollup-android-arm64": "4.23.0", + "@rollup/rollup-darwin-arm64": "4.23.0", + "@rollup/rollup-darwin-x64": "4.23.0", + "@rollup/rollup-linux-arm-gnueabihf": "4.23.0", + "@rollup/rollup-linux-arm-musleabihf": "4.23.0", + "@rollup/rollup-linux-arm64-gnu": "4.23.0", + "@rollup/rollup-linux-arm64-musl": "4.23.0", + "@rollup/rollup-linux-powerpc64le-gnu": "4.23.0", + "@rollup/rollup-linux-riscv64-gnu": "4.23.0", + "@rollup/rollup-linux-s390x-gnu": "4.23.0", + "@rollup/rollup-linux-x64-gnu": "4.23.0", + "@rollup/rollup-linux-x64-musl": "4.23.0", + "@rollup/rollup-win32-arm64-msvc": "4.23.0", + "@rollup/rollup-win32-ia32-msvc": "4.23.0", + "@rollup/rollup-win32-x64-msvc": "4.23.0", "fsevents": "~2.3.2" } }, @@ -8676,9 +8755,9 @@ } }, "node_modules/simple-git": { - "version": "3.26.0", - "resolved": "https://registry.npmjs.org/simple-git/-/simple-git-3.26.0.tgz", - "integrity": "sha512-5tbkCSzuskR6uA7uA23yjasmA0RzugVo8QM2bpsnxkrgP13eisFT7TMS4a+xKEJvbmr4qf+l0WT3eKa9IxxUyw==", + "version": "3.27.0", + "resolved": "https://registry.npmjs.org/simple-git/-/simple-git-3.27.0.tgz", + "integrity": "sha512-ivHoFS9Yi9GY49ogc6/YAi3Fl9ROnF4VyubNylgCkA+RVqLaKWnDSzXOVzya8csELIaWaYNutsEuAhZrtOjozA==", "dev": true, "license": "MIT", "dependencies": { @@ -9321,9 +9400,9 @@ } }, "node_modules/typescript": { - "version": "5.5.4", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.5.4.tgz", - "integrity": "sha512-Mtq29sKDAEYP7aljRgtPOpTvOfbwRWlS6dPRzwjdE+C0R4brX/GUyhHSecbHMFLNBLcJIPt9nl9yG5TZ1weH+Q==", + "version": "5.6.2", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.6.2.tgz", + "integrity": "sha512-NW8ByodCSNCwZeghjN3o+JX5OFH0Ojg6sadjEKY4huZ52TqbJTJnDo5+Tw98lSy63NZvi4n+ez5m2u5d4PkZyw==", "dev": true, "license": "Apache-2.0", "bin": { @@ -9413,9 +9492,9 @@ } }, "node_modules/update-browserslist-db": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.1.0.tgz", - "integrity": "sha512-EdRAaAyk2cUE1wOf2DkEhzxqOQvFOoRJFNS6NeyJ01Gp2beMRpBAINjM2iDXE3KCuKhwnvHIQCJm6ThL2Z+HzQ==", + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.1.1.tgz", + "integrity": "sha512-R8UzCaa9Az+38REPiJ1tXlImTJXlVfgHZsglwBD/k6nj76ctsH1E3q4doGrukiLQd3sGQYu56r5+lo5r94l29A==", "dev": true, "funding": [ { @@ -9433,8 +9512,8 @@ ], "license": "MIT", "dependencies": { - "escalade": "^3.1.2", - "picocolors": "^1.0.1" + "escalade": "^3.2.0", + "picocolors": "^1.1.0" }, "bin": { "update-browserslist-db": "cli.js" @@ -9443,6 +9522,13 @@ "browserslist": ">= 4.21.0" } }, + "node_modules/update-browserslist-db/node_modules/picocolors": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.0.tgz", + "integrity": "sha512-TQ92mBOW0l3LeMeyLV6mzy/kWr8lkd/hp3mTg7wYK7zJhuBStmGMBG0BdeDZS/dZx1IukaX6Bk11zcln25o1Aw==", + "dev": true, + "license": "ISC" + }, "node_modules/uri-js": { "version": "4.4.1", "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", @@ -9538,9 +9624,9 @@ } }, "node_modules/vite-node": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/vite-node/-/vite-node-2.1.0.tgz", - "integrity": "sha512-+ybYqBVUjYyIscoLzMWodus2enQDZOpGhcU6HdOVD6n8WZdk12w1GFL3mbnxLs7hPtRtqs1Wo5YF6/Tsr6fmhg==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/vite-node/-/vite-node-2.1.1.tgz", + "integrity": "sha512-N/mGckI1suG/5wQI35XeR9rsMsPqKXzq1CdUndzVstBj/HvyxxGctwnK6WX43NGt5L3Z5tcRf83g4TITKJhPrA==", "dev": true, "license": "MIT", "dependencies": { @@ -9560,9 +9646,9 @@ } }, "node_modules/vite-node/node_modules/@types/node": { - "version": "22.5.4", - "resolved": "https://registry.npmjs.org/@types/node/-/node-22.5.4.tgz", - "integrity": "sha512-FDuKUJQm/ju9fT/SeX/6+gBzoPzlVCzfzmGkwKvRHQVxi4BntVbyIwf6a4Xn62mrvndLiml6z/UBXIdEVjQLXg==", + "version": "22.7.4", + "resolved": "https://registry.npmjs.org/@types/node/-/node-22.7.4.tgz", + "integrity": "sha512-y+NPi1rFzDs1NdQHHToqeiX2TIS79SWEAw9GYhkkx8bD0ChpfqC+n2j5OXOCpzfojBEBt6DnEnnG9MY0zk1XLg==", "dev": true, "license": "MIT", "optional": true, @@ -9581,9 +9667,9 @@ "peer": true }, "node_modules/vite-node/node_modules/vite": { - "version": "5.4.4", - "resolved": "https://registry.npmjs.org/vite/-/vite-5.4.4.tgz", - "integrity": "sha512-RHFCkULitycHVTtelJ6jQLd+KSAAzOgEYorV32R2q++M6COBjKJR6BxqClwp5sf0XaBDjVMuJ9wnNfyAJwjMkA==", + "version": "5.4.8", + "resolved": "https://registry.npmjs.org/vite/-/vite-5.4.8.tgz", + "integrity": "sha512-FqrItQ4DT1NC4zCUqMB4c4AZORMKIa0m8/URVCZ77OZ/QSNeJ54bU1vrFADbDsuwfIPcgknRkmqakQcgnL4GiQ==", "dev": true, "license": "MIT", "dependencies": { @@ -9790,20 +9876,37 @@ } }, "node_modules/winston-transport": { - "version": "4.7.1", - "resolved": "https://registry.npmjs.org/winston-transport/-/winston-transport-4.7.1.tgz", - "integrity": "sha512-wQCXXVgfv/wUPOfb2x0ruxzwkcZfxcktz6JIMUaPLmcNhO4bZTwA/WtDWK74xV3F2dKu8YadrFv0qhwYjVEwhA==", + "version": "4.8.0", + "resolved": "https://registry.npmjs.org/winston-transport/-/winston-transport-4.8.0.tgz", + "integrity": "sha512-qxSTKswC6llEMZKgCQdaWgDuMJQnhuvF5f2Nk3SNXc4byfQ+voo2mX1Px9dkNOuR8p0KAjfPG29PuYUSIb+vSA==", "dev": true, "license": "MIT", "dependencies": { "logform": "^2.6.1", - "readable-stream": "^3.6.2", + "readable-stream": "^4.5.2", "triple-beam": "^1.3.0" }, "engines": { "node": ">= 12.0.0" } }, + "node_modules/winston-transport/node_modules/readable-stream": { + "version": "4.5.2", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-4.5.2.tgz", + "integrity": "sha512-yjavECdqeZ3GLXNgRXgeQEdz9fvDDkNKyHnbHRFtOr7/LcfgBcmct7t/ET+HaCTqfh06OzoAxrkN/IfjJBVe+g==", + "dev": true, + "license": "MIT", + "dependencies": { + "abort-controller": "^3.0.0", + "buffer": "^6.0.3", + "events": "^3.3.0", + "process": "^0.11.10", + "string_decoder": "^1.3.0" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + } + }, "node_modules/winston/node_modules/@colors/colors": { "version": "1.6.0", "resolved": "https://registry.npmjs.org/@colors/colors/-/colors-1.6.0.tgz", @@ -10093,9 +10196,9 @@ } }, "node_modules/zod-validation-error": { - "version": "3.3.1", - "resolved": "https://registry.npmjs.org/zod-validation-error/-/zod-validation-error-3.3.1.tgz", - "integrity": "sha512-uFzCZz7FQis256dqw4AhPQgD6f3pzNca/Zh62RNELavlumQB3nDIUFbF5JQfFLcMbO1s02Q7Xg/gpcOBlEnYZA==", + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/zod-validation-error/-/zod-validation-error-3.4.0.tgz", + "integrity": "sha512-ZOPR9SVY6Pb2qqO5XHt+MkkTRxGXb4EVtnjc9JpXUOtUB1T9Ru7mZOT361AN3MsetVe7R0a1KZshJDZdgp9miQ==", "dev": true, "license": "MIT", "engines": { diff --git a/package.json b/package.json index 2159e8f89683..2714200ab510 100644 --- a/package.json +++ b/package.json @@ -20,7 +20,7 @@ "azure-rest-api-specs-eng-tools": "file:eng/tools", "oav": "^3.3.7", "prettier": "~3.3.3", - "typescript": "~5.5.4" + "typescript": "~5.6.2" }, "engines": { "node": ">=18.0.0", From 313ef27f83c0236c16302bc1db33cd54cdc5b40c Mon Sep 17 00:00:00 2001 From: Mike Harder <mharder@microsoft.com> Date: Tue, 1 Oct 2024 15:14:00 -0700 Subject: [PATCH 23/47] [dependabot] Upgrade all packages under @azure-tools and @typespec scopes (#30817) --- .github/dependabot.yml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 2825b5913493..db134132a92a 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -5,4 +5,9 @@ updates: schedule: interval: "daily" allow: - - dependency-name: "@azure-tools/typespec-client-generator-cli" + - dependency-name: "@azure-tools/*" + - dependency-name: "@typespec/*" + groups: + typespec: + patterns: + - "*" From 7ee5d62bdb40de9facc21ebebd23ace920fdbfaa Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 1 Oct 2024 15:58:25 -0700 Subject: [PATCH 24/47] Bump the typespec group with 2 updates (#30819) Bumps the typespec group with 2 updates: [@azure-tools/typespec-client-generator-core](https://github.com/Azure/typespec-azure) and [@typespec/compiler](https://github.com/microsoft/typespec). Updates `@azure-tools/typespec-client-generator-core` from 0.46.0 to 0.46.2 - [Release notes](https://github.com/Azure/typespec-azure/releases) - [Commits](https://github.com/Azure/typespec-azure/compare/typespec-azure@0.46.0...@azure-tools/typespec-client-generator-core@0.46.2) Updates `@typespec/compiler` from 0.60.0 to 0.60.1 - [Release notes](https://github.com/microsoft/typespec/releases) - [Commits](https://github.com/microsoft/typespec/compare/typespec@0.60.0...@typespec/compiler@0.60.1) --- updated-dependencies: - dependency-name: "@azure-tools/typespec-client-generator-core" dependency-type: direct:development update-type: version-update:semver-patch dependency-group: typespec - dependency-name: "@typespec/compiler" dependency-type: direct:development update-type: version-update:semver-patch dependency-group: typespec ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package-lock.json | 18 ++++++++---------- package.json | 4 ++-- 2 files changed, 10 insertions(+), 12 deletions(-) diff --git a/package-lock.json b/package-lock.json index 91ee30a15277..28789aac7893 100644 --- a/package-lock.json +++ b/package-lock.json @@ -13,10 +13,10 @@ "@azure-tools/typespec-azure-resource-manager": "0.46.1", "@azure-tools/typespec-azure-rulesets": "0.46.0", "@azure-tools/typespec-client-generator-cli": "0.13.0", - "@azure-tools/typespec-client-generator-core": "0.46.0", + "@azure-tools/typespec-client-generator-core": "0.46.2", "@azure-tools/typespec-liftr-base": "0.4.0", "@azure/avocado": "^0.8.4", - "@typespec/compiler": "0.60.0", + "@typespec/compiler": "0.60.1", "@typespec/http": "0.60.0", "@typespec/openapi": "0.60.0", "@typespec/openapi3": "0.60.0", @@ -995,11 +995,10 @@ } }, "node_modules/@azure-tools/typespec-client-generator-core": { - "version": "0.46.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.46.0.tgz", - "integrity": "sha512-Ss0dNcOeTyc9CBsNFV6OToLV7OOKidAfeewmKePtY2qAHW+CqWZnVvUHunpFt2jFs6CqjFpgU9g+1wPbLCFj9A==", + "version": "0.46.2", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.46.2.tgz", + "integrity": "sha512-/HKeehCNDeylouOHMe7IwpcDcGJHRAuEy3a5FBnSY51m4EpMq4VMQzW9tka/8brFO2m5LLj7tyhOL/xnzi2fLg==", "dev": true, - "license": "MIT", "dependencies": { "change-case": "~5.4.4", "pluralize": "^8.0.0" @@ -3445,11 +3444,10 @@ } }, "node_modules/@typespec/compiler": { - "version": "0.60.0", - "resolved": "https://registry.npmjs.org/@typespec/compiler/-/compiler-0.60.0.tgz", - "integrity": "sha512-qAS99tJv6RvxSescfxRVal4QWSfdf3BzIOgE8+Az6emL68aTE/W8zQ0Ijpgmhax7sC2AnLTxCK1tM9kj1YguRw==", + "version": "0.60.1", + "resolved": "https://registry.npmjs.org/@typespec/compiler/-/compiler-0.60.1.tgz", + "integrity": "sha512-I6Vcpvd7mBP7SI5vCBh9rZGXAtVy95BKhAd33Enw32psswiSzRpA7zdyZhOMekTOGVXNS/+E5l2PGGCzQddB4w==", "dev": true, - "license": "MIT", "dependencies": { "@babel/code-frame": "~7.24.7", "ajv": "~8.17.1", diff --git a/package.json b/package.json index 2714200ab510..e9c2ab0f565d 100644 --- a/package.json +++ b/package.json @@ -8,10 +8,10 @@ "@azure-tools/typespec-azure-resource-manager": "0.46.1", "@azure-tools/typespec-azure-rulesets": "0.46.0", "@azure-tools/typespec-client-generator-cli": "0.13.0", - "@azure-tools/typespec-client-generator-core": "0.46.0", + "@azure-tools/typespec-client-generator-core": "0.46.2", "@azure-tools/typespec-liftr-base": "0.4.0", "@azure/avocado": "^0.8.4", - "@typespec/compiler": "0.60.0", + "@typespec/compiler": "0.60.1", "@typespec/http": "0.60.0", "@typespec/openapi": "0.60.0", "@typespec/openapi3": "0.60.0", From d5e7ea8689721b0be486805f9eadc883818d2fe1 Mon Sep 17 00:00:00 2001 From: Sandeep Prakash <sandep@microsoft.com> Date: Tue, 1 Oct 2024 17:11:47 -0700 Subject: [PATCH 25/47] Added support for NGroups operations (#30379) * Copy files from preview/2024-05-01-preview Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-09-01-preview Updated the API version from preview/2024-05-01-preview to preview/2024-09-01-preview. * Added tag for 2024-09-01-preview in readme file * Added missing tags from the last release. * resource name pattern fix * match original? * updated delete response * try * common? * try to match * location header added and 200 removed from delete * more fixes * fix json * change camel case to be all lower in uri * missing type object errors * camel case fixes * fix paramaeter name to match case * Fixing XmsPageableForListCalls violation from containerInstance.json * removed post 204 response * removed 204 from post * fix some type obejct references * last camel case * vnet name with pattern * updated sku to get nextLink * fixed json * updated nextlink in paged response * Fixing OperationsApiResponseSchema violation from containerInstance.json * Fixing OperationsApiSchemaUsesCommonTypes violation from containerInstance.json * fixed lint errors * Fixing LroLocationHeader, LroErrorContent and MissingTypeObject violation from containerInstance.json * camel case last * attempt at some object type failures * capital g in resource group * wrap in tag * revert to only Ngroups initial change * readonly location in patch * readonly fix * revert path change and use common tracked resource schema * fix location resource and readonly * file not referenced * remove unreferenced property * npx make prettier * remove standby from update * added ngroups to cspell * npx prettier for all examples * Addressing PR feedback. * Baseline file from stable-2023-05-01 for reference. * Revert: Baseline file from stable-2023-05-01 for reference. * Fixing spell check and Lint error. * spellcheck fix * TrackedResource has a required field for location, which is not needed for PATCH operation. So reverted it. * spellcheck fix2 * nit * Location property in PAtch operation should be readOnly or immutable. * addressed comments * updated provisioningState * added headers in the PUT response * used common managedIdentity for nGroups * Revert "used common managedIdentity for nGroups" This reverts commit fb6a58fc010970930fece8a1690b19b9c54de27a. * added long-running-operation-options * updated long-running-operation-options * updated headers in response * fixed lint errors --------- Co-authored-by: John Richardson <jorichardson@microsoft.com> Co-authored-by: Shivam Gupta <shivg@microsoft.com> --- cSpell.json | 6 + .../2024-09-01-preview/containerInstance.json | 3195 +++++++++++++++++ .../examples/CachedImagesList.json | 27 + .../examples/CapabilitiesList.json | 39 + .../examples/ContainerAttach.json | 17 + .../examples/ContainerExec.json | 24 + .../ContainerGroupCreateConfidential.json | 182 + .../ContainerGroupEncryptionProperties.json | 192 + .../examples/ContainerGroupExtensions.json | 208 ++ .../examples/ContainerGroupUsage.json | 24 + .../ContainerGroupsCreateOrUpdate.json | 316 ++ .../ContainerGroupsCreatePriority.json | 120 + .../examples/ContainerGroupsDelete.json | 85 + .../examples/ContainerGroupsGetPriority.json | 87 + .../examples/ContainerGroupsGet_Failed.json | 115 + .../ContainerGroupsGet_Succeeded.json | 79 + .../examples/ContainerGroupsList.json | 90 + .../ContainerGroupsListByResourceGroup.json | 82 + .../examples/ContainerGroupsRestart.json | 11 + .../examples/ContainerGroupsStart.json | 16 + .../examples/ContainerGroupsStop.json | 11 + .../examples/ContainerGroupsUpdate.json | 100 + .../examples/ContainerListLogs.json | 17 + .../examples/OperationsList.json | 23 + .../SubnetServiceAssociationLinkDelete.json | 18 + .../resource-manager/readme.md | 9 + 26 files changed, 5093 insertions(+) create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/containerInstance.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/CachedImagesList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/CapabilitiesList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerAttach.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerExec.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupCreateConfidential.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupEncryptionProperties.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupExtensions.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupUsage.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsCreateOrUpdate.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsCreatePriority.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsDelete.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsGetPriority.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsGet_Failed.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsGet_Succeeded.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsListByResourceGroup.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsRestart.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsStart.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsStop.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsUpdate.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerListLogs.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/OperationsList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/SubnetServiceAssociationLinkDelete.json diff --git a/cSpell.json b/cSpell.json index e7aeb6374c29..3ee89cdd3c60 100644 --- a/cSpell.json +++ b/cSpell.json @@ -208,6 +208,12 @@ "Noreuse" ] }, + { + "filename": "**/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/**/containerInstance.json", + "words": [ + "ngroups" + ] + }, { "filename": "**/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/**/*json", "words": [ diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/containerInstance.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/containerInstance.json new file mode 100644 index 000000000000..3c3cbf5216f6 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/containerInstance.json @@ -0,0 +1,3195 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-09-01-preview", + "title": "ContainerInstanceManagementClient" + }, + "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.ContainerInstance/containerGroups": { + "get": { + "operationId": "ContainerGroups_List", + "x-ms-examples": { + "ContainerGroupsList": { + "$ref": "./examples/ContainerGroupsList.json" + } + }, + "summary": "Get a list of container groups in the specified subscription.", + "description": "Get a list of container groups in the specified subscription. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups": { + "get": { + "operationId": "ContainerGroups_ListByResourceGroup", + "x-ms-examples": { + "ContainerGroupsListByResourceGroup": { + "$ref": "./examples/ContainerGroupsListByResourceGroup.json" + } + }, + "summary": "Get a list of container groups in the specified subscription and resource group.", + "description": "Get a list of container groups in a specified subscription and resource group. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}": { + "get": { + "operationId": "ContainerGroups_Get", + "x-ms-examples": { + "ContainerGroupsGet_Succeeded": { + "$ref": "./examples/ContainerGroupsGet_Succeeded.json" + }, + "ContainerGroupsGet_Failed": { + "$ref": "./examples/ContainerGroupsGet_Failed.json" + }, + "ContainerGroupsGetWithPriority": { + "$ref": "./examples/ContainerGroupsGetPriority.json" + } + }, + "summary": "Get the properties of the specified container group.", + "description": "Gets the properties of the specified container group in the specified subscription and resource group. The operation returns the properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "ContainerGroups_CreateOrUpdate", + "x-ms-examples": { + "ContainerGroupsCreateOrUpdate": { + "$ref": "./examples/ContainerGroupsCreateOrUpdate.json" + }, + "ContainerGroupCreateWithExtensions": { + "$ref": "./examples/ContainerGroupExtensions.json" + }, + "ContainerGroupWithEncryptionProperties": { + "$ref": "./examples/ContainerGroupEncryptionProperties.json" + }, + "ConfidentialContainerGroup": { + "$ref": "./examples/ContainerGroupCreateConfidential.json" + }, + "ContainerGroupsCreateWithPriority": { + "$ref": "./examples/ContainerGroupsCreatePriority.json" + } + }, + "summary": "Create or update container groups.", + "description": "Create or update container groups with specified configurations.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerGroup", + "description": "The properties of the container group to be created or updated.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "201": { + "description": "Created - the container group is created.", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "ContainerGroups_Update", + "x-ms-examples": { + "ContainerGroupsUpdate": { + "$ref": "./examples/ContainerGroupsUpdate.json" + } + }, + "summary": "Update container groups.", + "description": "Updates container group tags with specified values.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "Resource", + "description": "The container group resource with just the tags to be updated.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/Resource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "ContainerGroups_Delete", + "x-ms-examples": { + "ContainerGroupsDelete": { + "$ref": "./examples/ContainerGroupsDelete.json" + } + }, + "summary": "Delete the specified container group.", + "description": "Delete the specified container group in the specified subscription and resource group. The operation does not delete other resources provided by the user, such as volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "202": { + "description": "Delete started." + }, + "204": { + "description": "No Content - the specified container group was not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/restart": { + "post": { + "operationId": "ContainerGroups_Restart", + "x-ms-examples": { + "ContainerRestart": { + "$ref": "./examples/ContainerGroupsRestart.json" + } + }, + "summary": "Restarts all containers in a container group.", + "description": "Restarts all containers in a container group in place. If container image has updates, new image will be downloaded.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/stop": { + "post": { + "operationId": "ContainerGroups_Stop", + "x-ms-examples": { + "ContainerStop": { + "$ref": "./examples/ContainerGroupsStop.json" + } + }, + "summary": "Stops all containers in a container group.", + "description": "Stops all containers in a container group. Compute resources will be deallocated and billing will stop.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/start": { + "post": { + "operationId": "ContainerGroups_Start", + "x-ms-examples": { + "ContainerStart": { + "$ref": "./examples/ContainerGroupsStart.json" + } + }, + "summary": "Starts all containers in a container group.", + "description": "Starts all containers in a container group. Compute resources will be allocated and billing will start.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "202": { + "description": "Started - the container group is starting." + }, + "204": { + "description": "Started - the container group is already running or starting." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.ContainerInstance/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/OperationsList.json" + } + }, + "description": "List the operations for Azure Container Instance service.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/usages": { + "get": { + "operationId": "Location_ListUsage", + "x-ms-examples": { + "ContainerUsage": { + "$ref": "./examples/ContainerGroupUsage.json" + } + }, + "description": "Get the usage for a subscription", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UsageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/logs": { + "get": { + "operationId": "Containers_ListLogs", + "x-ms-examples": { + "ContainerListLogs": { + "$ref": "./examples/ContainerListLogs.json" + } + }, + "summary": "Get the logs for a specified container instance.", + "description": "Get the logs for a specified container instance in a specified resource group and container group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerName", + "in": "path", + "description": "The name of the container instance.", + "required": true, + "type": "string" + }, + { + "name": "tail", + "in": "query", + "description": "The number of lines to show from the tail of the container instance log. If not provided, all available logs are shown up to 4mb.", + "type": "integer", + "format": "int32" + }, + { + "name": "timestamps", + "in": "query", + "description": "If true, adds a timestamp at the beginning of every line of log output. If not provided, defaults to false.", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Logs" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/exec": { + "post": { + "operationId": "Containers_ExecuteCommand", + "x-ms-examples": { + "ContainerExec": { + "$ref": "./examples/ContainerExec.json" + } + }, + "summary": "Executes a command in a specific container instance.", + "description": "Executes a command for a specific container instance in a specified resource group and container group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerName", + "in": "path", + "description": "The name of the container instance.", + "required": true, + "type": "string" + }, + { + "name": "containerExecRequest", + "in": "body", + "description": "The request for the exec command.", + "required": true, + "schema": { + "$ref": "#/definitions/ContainerExecRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerExecResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/attach": { + "post": { + "operationId": "Containers_Attach", + "x-ms-examples": { + "ContainerAttach": { + "$ref": "./examples/ContainerAttach.json" + } + }, + "summary": "Attach to the output of a specific container instance.", + "description": "Attach to the output stream of a specific container instance in a specified resource group and container group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerName", + "in": "path", + "description": "The name of the container instance.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerAttachResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/cachedImages": { + "get": { + "operationId": "Location_ListCachedImages", + "x-ms-examples": { + "CachedImages": { + "$ref": "./examples/CachedImagesList.json" + } + }, + "summary": "Get the list of cached images.", + "description": "Get the list of cached images on specific OS type for a subscription in a region.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CachedImagesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/capabilities": { + "get": { + "operationId": "Location_ListCapabilities", + "x-ms-examples": { + "GetCapabilities": { + "$ref": "./examples/CapabilitiesList.json" + } + }, + "summary": "Get the list of capabilities of the location.", + "description": "Get the list of CPU/memory/GPU capabilities of a region.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapabilitiesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/outboundNetworkDependenciesEndpoints": { + "get": { + "operationId": "ContainerGroups_GetOutboundNetworkDependenciesEndpoints", + "x-ms-examples": {}, + "summary": "Get all network dependencies for container group.", + "description": "Gets all the network dependencies for this container group to allow complete control of network setting and configuration. For container groups, this will always be an empty list.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkDependenciesResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/providers/Microsoft.ContainerInstance/serviceAssociationLinks/default": { + "delete": { + "operationId": "SubnetServiceAssociationLink_Delete", + "x-ms-examples": { + "SubnetServiceAssociationLinkDelete": { + "$ref": "./examples/SubnetServiceAssociationLinkDelete.json" + } + }, + "summary": "Delete container group virtual network association links.", + "description": "Delete container group virtual network association links. The operation does not delete other resources provided by the user.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkNameParameter" + }, + { + "$ref": "#/parameters/SubnetNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Delete started." + }, + "204": { + "description": "No Content - the specified container group was not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}/skus": { + "get": { + "operationId": "NGroupsSkus_Get", + "x-ms-examples": {}, + "summary": "Get the resource sku, resource type, and sku capacity of the n groups.", + "description": "Get the resource sku, resource type, and sku capacity of the n groups.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NGroupsNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NGroupsSkusList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}": { + "get": { + "operationId": "NGroups_Get", + "x-ms-examples": {}, + "summary": "Display information about a specified nGroup.", + "description": "Get the properties of the specified n group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NGroupsNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "NGroups_CreateOrUpdate", + "x-ms-examples": {}, + "description": "Create or update a nGroup.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NGroupsNameParameter" + }, + { + "name": "nGroup", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NGroup" + }, + "description": "The nGroup object." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/NGroup" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/NGroup" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "operationId": "NGroups_Update", + "x-ms-examples": {}, + "summary": "Update a specified nGroup.", + "description": "Update a specified nGroup.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NGroupsNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NGroup" + }, + "description": "The nGroup object." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NGroup" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + } + }, + "202": { + "description": "nGroup update started", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + }, + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "NGroups_Delete", + "x-ms-examples": {}, + "summary": "Delete a nGroup.", + "description": "Deletes a nGroup.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NGroupsNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + }, + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}/start": { + "post": { + "operationId": "NGroups_Start", + "x-ms-examples": {}, + "summary": "Starts all container groups in a nGroup.", + "description": "Starts all container groups in a nGroup. Compute resources will be allocated and billing will start.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NGroupsNameParameter" + } + ], + "responses": { + "202": { + "description": "Started - the container groups are starting.", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + }, + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}/stop": { + "post": { + "operationId": "NGroups_Stop", + "x-ms-examples": {}, + "summary": "Stops all container groups in a nGroup.", + "description": "Stops all container groups in a nGroup. Compute resources will be deallocated and billing will stop.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NGroupsNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}/restart": { + "post": { + "operationId": "NGroups_Restart", + "x-ms-examples": {}, + "summary": "Restarts all container groups in a nGroup.", + "description": "Restarts all container groups in a nGroup in place. If container image has updates, new image will be downloaded.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NGroupsNameParameter" + } + ], + "responses": { + "202": { + "description": "NoContent", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + }, + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups": { + "get": { + "operationId": "NGroups_ListByResourceGroup", + "x-ms-examples": {}, + "summary": "Gets a list of all nGroups under a resource group.", + "description": "Gets a list of all nGroups under a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NGroupsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/ngroups": { + "get": { + "operationId": "NGroups_List", + "x-ms-examples": {}, + "summary": "Gets a list of all nGroups under a subscription.", + "description": "Gets a list of all nGroups under a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NGroupsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Container": { + "description": "A container instance.", + "type": "object", + "required": [ + "properties", + "name" + ], + "properties": { + "name": { + "description": "The user-provided name of the container instance.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of the container instance.", + "$ref": "#/definitions/ContainerProperties" + } + } + }, + "ContainerProperties": { + "description": "The container instance properties.", + "type": "object", + "required": [ + "image", + "resources" + ], + "properties": { + "image": { + "description": "The name of the image used to create the container instance.", + "type": "string" + }, + "command": { + "description": "The commands to execute within the container instance in exec form.", + "type": "array", + "items": { + "type": "string" + } + }, + "ports": { + "description": "The exposed ports on the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerPort" + }, + "x-ms-identifiers": [ + "port" + ] + }, + "environmentVariables": { + "description": "The environment variables to set in the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "instanceView": { + "description": "The instance view of the container instance. Only valid in response.", + "readOnly": true, + "type": "object", + "properties": { + "restartCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of times that the container instance has been restarted." + }, + "currentState": { + "readOnly": true, + "description": "Current container instance state.", + "$ref": "#/definitions/ContainerState" + }, + "previousState": { + "readOnly": true, + "description": "Previous container instance state.", + "$ref": "#/definitions/ContainerState" + }, + "events": { + "readOnly": true, + "description": "The events of the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/Event" + }, + "x-ms-identifiers": [ + "name", + "type" + ] + } + } + }, + "resources": { + "description": "The resource requirements of the container instance.", + "$ref": "#/definitions/ResourceRequirements" + }, + "volumeMounts": { + "description": "The volume mounts available to the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/VolumeMount" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "livenessProbe": { + "description": "The liveness probe.", + "$ref": "#/definitions/ContainerProbe" + }, + "readinessProbe": { + "description": "The readiness probe.", + "$ref": "#/definitions/ContainerProbe" + }, + "securityContext": { + "description": "The container security properties.", + "$ref": "#/definitions/SecurityContextDefinition" + } + } + }, + "SecurityContextDefinition": { + "description": "The security context for the container.", + "type": "object", + "properties": { + "privileged": { + "type": "boolean", + "description": "The flag to determine if the container permissions is elevated to Privileged." + }, + "allowPrivilegeEscalation": { + "type": "boolean", + "description": "A boolean value indicating whether the init process can elevate its privileges" + }, + "capabilities": { + "description": "The capabilities to add or drop from a container.", + "$ref": "#/definitions/SecurityContextCapabilitiesDefinition" + }, + "runAsGroup": { + "type": "integer", + "format": "int32", + "description": "Sets the User GID for the container." + }, + "runAsUser": { + "type": "integer", + "format": "int32", + "description": "Sets the User UID for the container." + }, + "seccompProfile": { + "type": "string", + "description": "a base64 encoded string containing the contents of the JSON in the seccomp profile" + } + } + }, + "SecurityContextCapabilitiesDefinition": { + "description": "The capabilities to add or drop from a container.", + "type": "object", + "properties": { + "add": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The capabilities to add to the container." + }, + "drop": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The capabilities to drop from the container." + } + } + }, + "ContainerState": { + "description": "The container instance state.", + "type": "object", + "readOnly": true, + "properties": { + "state": { + "type": "string", + "readOnly": true, + "description": "The state of the container instance." + }, + "startTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date-time when the container instance state started." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The container instance exit codes correspond to those from the `docker run` command." + }, + "finishTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date-time when the container instance state finished." + }, + "detailStatus": { + "type": "string", + "readOnly": true, + "description": "The human-readable status of the container instance state." + } + } + }, + "Event": { + "description": "A container group or container instance event.", + "type": "object", + "readOnly": true, + "properties": { + "count": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The count of the event." + }, + "firstTimestamp": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date-time of the earliest logged event." + }, + "lastTimestamp": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date-time of the latest logged event." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The event name." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The event message." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The event type." + } + } + }, + "ResourceRequirements": { + "description": "The resource requirements.", + "type": "object", + "required": [ + "requests" + ], + "properties": { + "requests": { + "description": "The resource requests of this container instance.", + "$ref": "#/definitions/ResourceRequests" + }, + "limits": { + "description": "The resource limits of this container instance.", + "$ref": "#/definitions/ResourceLimits" + } + } + }, + "ResourceRequests": { + "description": "The resource requests.", + "type": "object", + "required": [ + "memoryInGB", + "cpu" + ], + "properties": { + "memoryInGB": { + "description": "The memory request in GB of this container instance.", + "type": "number", + "format": "double" + }, + "cpu": { + "description": "The CPU request of this container instance.", + "type": "number", + "format": "double" + }, + "gpu": { + "description": "The GPU request of this container instance.", + "$ref": "#/definitions/GpuResource" + } + } + }, + "ResourceLimits": { + "description": "The resource limits.", + "type": "object", + "properties": { + "memoryInGB": { + "description": "The memory limit in GB of this container instance.", + "type": "number", + "format": "double" + }, + "cpu": { + "description": "The CPU limit of this container instance.", + "type": "number", + "format": "double" + }, + "gpu": { + "description": "The GPU limit of this container instance.", + "$ref": "#/definitions/GpuResource" + } + } + }, + "GpuResource": { + "description": "The GPU resource.", + "type": "object", + "required": [ + "count", + "sku" + ], + "properties": { + "count": { + "description": "The count of the GPU resource.", + "type": "integer", + "format": "int32" + }, + "sku": { + "type": "string", + "description": "The SKU of the GPU resource.", + "enum": [ + "K80", + "P100", + "V100" + ], + "x-ms-enum": { + "name": "GpuSku", + "modelAsString": true + } + } + } + }, + "AzureFileVolume": { + "description": "The properties of the Azure File volume. Azure File shares are mounted as volumes.", + "type": "object", + "required": [ + "shareName", + "storageAccountName" + ], + "properties": { + "shareName": { + "description": "The name of the Azure File share to be mounted as a volume.", + "type": "string" + }, + "readOnly": { + "description": "The flag indicating whether the Azure File shared mounted as a volume is read-only.", + "type": "boolean" + }, + "storageAccountName": { + "description": "The name of the storage account that contains the Azure File share.", + "type": "string" + }, + "storageAccountKey": { + "description": "The storage account access key used to access the Azure File share.", + "type": "string" + } + } + }, + "EmptyDirVolume": { + "description": "The empty directory volume.", + "type": "object", + "properties": {} + }, + "SecretVolume": { + "description": "The secret volume.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "GitRepoVolume": { + "description": "Represents a volume that is populated with the contents of a git repository", + "required": [ + "repository" + ], + "properties": { + "directory": { + "description": "Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.", + "type": "string" + }, + "repository": { + "description": "Repository URL", + "type": "string" + }, + "revision": { + "description": "Commit hash for the specified revision.", + "type": "string" + } + } + }, + "Volume": { + "description": "The properties of the volume.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "The name of the volume.", + "type": "string" + }, + "azureFile": { + "description": "The Azure File volume.", + "$ref": "#/definitions/AzureFileVolume" + }, + "emptyDir": { + "description": "The empty directory volume.", + "$ref": "#/definitions/EmptyDirVolume" + }, + "secret": { + "description": "The secret volume.", + "$ref": "#/definitions/SecretVolume" + }, + "gitRepo": { + "description": "The git repo volume.", + "$ref": "#/definitions/GitRepoVolume" + } + } + }, + "VolumeMount": { + "description": "The properties of the volume mount.", + "type": "object", + "required": [ + "name", + "mountPath" + ], + "properties": { + "name": { + "description": "The name of the volume mount.", + "type": "string" + }, + "mountPath": { + "description": "The path within the container where the volume should be mounted. Must not contain colon (:).", + "type": "string" + }, + "readOnly": { + "description": "The flag indicating whether the volume mount is read-only.", + "type": "boolean" + } + } + }, + "ContainerExec": { + "type": "object", + "description": "The container execution command, for liveness or readiness probe", + "properties": { + "command": { + "description": "The commands to execute within the container.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ContainerHttpGet": { + "type": "object", + "description": "The container Http Get settings, for liveness or readiness probe", + "properties": { + "path": { + "description": "The path to probe.", + "type": "string" + }, + "port": { + "type": "integer", + "description": "The port number to probe.", + "format": "int32" + }, + "scheme": { + "description": "The scheme.", + "type": "string", + "enum": [ + "http", + "https" + ], + "x-ms-enum": { + "name": "Scheme", + "modelAsString": true + } + }, + "httpHeaders": { + "description": "The HTTP headers.", + "type": "array", + "items": { + "$ref": "#/definitions/HttpHeader" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "required": [ + "port" + ] + }, + "ContainerProbe": { + "type": "object", + "description": "The container probe, for liveness or readiness", + "properties": { + "exec": { + "description": "The execution command to probe", + "$ref": "#/definitions/ContainerExec" + }, + "httpGet": { + "description": "The Http Get settings to probe", + "$ref": "#/definitions/ContainerHttpGet" + }, + "initialDelaySeconds": { + "description": "The initial delay seconds.", + "type": "integer", + "format": "int32" + }, + "periodSeconds": { + "description": "The period seconds.", + "type": "integer", + "format": "int32" + }, + "failureThreshold": { + "description": "The failure threshold.", + "type": "integer", + "format": "int32" + }, + "successThreshold": { + "description": "The success threshold.", + "type": "integer", + "format": "int32" + }, + "timeoutSeconds": { + "description": "The timeout seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "ContainerGroup": { + "description": "A container group.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "$ref": "#/definitions/ContainerGroupProperties" + } + ] + }, + "ContainerGroupProperties": { + "description": "The container group properties", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "identity": { + "$ref": "#/definitions/ContainerGroupIdentity", + "description": "The identity of the container group, if configured." + }, + "properties": { + "x-ms-client-flatten": true, + "type": "object", + "description": "The container group properties", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the container group. This only appears in the response." + }, + "containers": { + "type": "array", + "description": "The containers within the container group.", + "items": { + "$ref": "#/definitions/Container" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "imageRegistryCredentials": { + "type": "array", + "description": "The image registry credentials by which the container group is created from.", + "items": { + "$ref": "#/definitions/ImageRegistryCredential" + }, + "x-ms-identifiers": [ + "username" + ] + }, + "restartPolicy": { + "type": "string", + "description": "Restart policy for all containers within the container group. \n- `Always` Always restart\n- `OnFailure` Restart on failure\n- `Never` Never restart\n", + "enum": [ + "Always", + "OnFailure", + "Never" + ], + "x-ms-enum": { + "name": "ContainerGroupRestartPolicy", + "modelAsString": true + } + }, + "ipAddress": { + "description": "The IP address type of the container group.", + "$ref": "#/definitions/IpAddress" + }, + "osType": { + "type": "string", + "description": "The operating system type required by the containers in the container group.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": true + } + }, + "volumes": { + "type": "array", + "description": "The list of volumes that can be mounted by containers in this container group.", + "items": { + "$ref": "#/definitions/Volume" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "instanceView": { + "description": "The instance view of the container group. Only valid in response.", + "readOnly": true, + "type": "object", + "properties": { + "events": { + "description": "The events of this container group.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Event" + }, + "x-ms-identifiers": [ + "name", + "type" + ] + }, + "state": { + "readOnly": true, + "type": "string", + "description": "The state of the container group. Only valid in response." + } + } + }, + "diagnostics": { + "description": "The diagnostic information for a container group.", + "$ref": "#/definitions/ContainerGroupDiagnostics" + }, + "subnetIds": { + "type": "array", + "description": "The subnet resource IDs for a container group.", + "items": { + "$ref": "#/definitions/ContainerGroupSubnetId" + } + }, + "dnsConfig": { + "description": "The DNS config information for a container group.", + "$ref": "#/definitions/DnsConfiguration" + }, + "sku": { + "description": "The SKU for a container group.", + "$ref": "#/definitions/ContainerGroupSku" + }, + "encryptionProperties": { + "description": "The encryption properties for a container group.", + "$ref": "#/definitions/EncryptionProperties" + }, + "initContainers": { + "type": "array", + "description": "The init containers for a container group.", + "items": { + "$ref": "#/definitions/InitContainerDefinition" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "extensions": { + "type": "array", + "description": "extensions used by virtual kubelet", + "items": { + "$ref": "#/definitions/DeploymentExtensionSpec" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "confidentialComputeProperties": { + "description": "The properties for confidential container group", + "$ref": "#/definitions/ConfidentialComputeProperties" + }, + "priority": { + "type": "string", + "description": "The priority of the container group.", + "enum": [ + "Regular", + "Spot" + ], + "x-ms-enum": { + "name": "ContainerGroupPriority", + "modelAsString": true + } + } + }, + "required": [ + "containers", + "osType" + ] + } + } + }, + "DeploymentExtensionSpec": { + "description": "Extension sidecars to be added to the deployment.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the extension." + }, + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "description": "Extension specific properties", + "properties": { + "extensionType": { + "type": "string", + "description": "Type of extension to be added." + }, + "version": { + "type": "string", + "description": "Version of the extension being used." + }, + "settings": { + "type": "object", + "description": "Settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "Protected settings for the extension." + } + }, + "required": [ + "extensionType", + "version" + ] + } + }, + "required": [ + "name" + ] + }, + "ContainerGroupIdentity": { + "description": "Identity for the container group.", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the container group identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the container group. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the container group. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the container group.", + "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 container group.", + "additionalProperties": { + "description": "The list of user identities associated with the container group. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "$ref": "#/definitions/UserAssignedIdentities" + } + } + } + }, + "UserAssignedIdentities": { + "type": "object", + "description": "The list of user identities associated with the container group. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "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." + } + } + }, + "ImageRegistryCredential": { + "description": "Image registry credential.", + "type": "object", + "properties": { + "server": { + "type": "string", + "description": "The Docker image registry server without a protocol such as \"http\" and \"https\"." + }, + "username": { + "type": "string", + "description": "The username for the private registry." + }, + "password": { + "type": "string", + "description": "The password for the private registry.", + "x-ms-secret": true + }, + "identity": { + "type": "string", + "description": "The identity for the private registry." + }, + "identityUrl": { + "type": "string", + "description": "The identity URL for the private registry." + } + }, + "required": [ + "server" + ] + }, + "ContainerGroupDiagnostics": { + "description": "Container group diagnostic information.", + "type": "object", + "properties": { + "logAnalytics": { + "description": "Container group log analytics information.", + "$ref": "#/definitions/LogAnalytics" + } + } + }, + "LogAnalytics": { + "description": "Container group log analytics information.", + "type": "object", + "properties": { + "workspaceId": { + "description": "The workspace id for log analytics", + "type": "string" + }, + "workspaceKey": { + "description": "The workspace key for log analytics", + "type": "string", + "x-ms-secret": true + }, + "logType": { + "type": "string", + "description": "The log type to be used.", + "enum": [ + "ContainerInsights", + "ContainerInstanceLogs" + ], + "x-ms-enum": { + "name": "LogAnalyticsLogType", + "modelAsString": true + } + }, + "metadata": { + "type": "object", + "description": "Metadata for log analytics.", + "additionalProperties": { + "type": "string" + } + }, + "workspaceResourceId": { + "description": "The workspace resource id for log analytics", + "type": "string", + "x-ms-secret": true + } + }, + "required": [ + "workspaceId", + "workspaceKey" + ] + }, + "ContainerGroupSubnetId": { + "description": "Container group subnet information.", + "type": "object", + "properties": { + "id": { + "description": "Resource ID of virtual network and subnet.", + "type": "string" + }, + "name": { + "description": "Friendly name for the subnet.", + "type": "string" + } + }, + "required": [ + "id" + ] + }, + "IpAddress": { + "description": "IP address for the container group.", + "type": "object", + "properties": { + "ports": { + "type": "array", + "description": "The list of ports exposed on the container group.", + "items": { + "$ref": "#/definitions/Port" + }, + "x-ms-identifiers": [ + "port" + ] + }, + "type": { + "type": "string", + "description": "Specifies if the IP is exposed to the public internet or private VNET.", + "enum": [ + "Public", + "Private" + ], + "x-ms-enum": { + "name": "ContainerGroupIpAddressType", + "modelAsString": true + } + }, + "ip": { + "type": "string", + "description": "The IP exposed to the public internet." + }, + "dnsNameLabel": { + "type": "string", + "description": "The Dns name label for the IP." + }, + "autoGeneratedDomainNameLabelScope": { + "type": "string", + "description": "The value representing the security enum. The 'Unsecure' value is the default value if not selected and means the object's domain name label is not secured against subdomain takeover. The 'TenantReuse' value is the default value if selected and means the object's domain name label can be reused within the same tenant. The 'SubscriptionReuse' value means the object's domain name label can be reused within the same subscription. The 'ResourceGroupReuse' value means the object's domain name label can be reused within the same resource group. The 'NoReuse' value means the object's domain name label cannot be reused within the same resource group, subscription, or tenant.", + "enum": [ + "Unsecure", + "TenantReuse", + "SubscriptionReuse", + "ResourceGroupReuse", + "Noreuse" + ], + "default": "Unsecure", + "x-ms-enum": { + "name": "dnsNameLabelReusePolicy", + "modelAsString": true + } + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "The FQDN for the IP." + } + }, + "required": [ + "ports", + "type" + ] + }, + "Port": { + "description": "The port exposed on the container group.", + "type": "object", + "properties": { + "protocol": { + "type": "string", + "description": "The protocol associated with the port.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "ContainerGroupNetworkProtocol", + "modelAsString": true + } + }, + "port": { + "type": "integer", + "description": "The port number.", + "format": "int32" + } + }, + "required": [ + "port" + ] + }, + "ContainerPort": { + "description": "The port exposed on the container instance.", + "type": "object", + "properties": { + "protocol": { + "type": "string", + "description": "The protocol associated with the port.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "ContainerNetworkProtocol", + "modelAsString": true + } + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port number exposed within the container group." + } + }, + "required": [ + "port" + ] + }, + "EnvironmentVariable": { + "description": "The environment variable to set within the container instance.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the environment variable." + }, + "value": { + "type": "string", + "description": "The value of the environment variable." + }, + "secureValue": { + "type": "string", + "description": "The value of the secure environment variable.", + "x-ms-secret": true + } + }, + "required": [ + "name" + ] + }, + "OperationListResult": { + "description": "The operation list response that contains all operations for Azure Container Instance service.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of operations." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of operations." + } + } + }, + "Operation": { + "description": "An operation for Azure Container Instance service.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "display": { + "description": "The display information of the operation.", + "type": "object", + "properties": { + "provider": { + "description": "The name of the provider of the operation.", + "type": "string" + }, + "resource": { + "type": "string", + "description": "The name of the resource type of the operation." + }, + "operation": { + "description": "The friendly name of the operation.", + "type": "string" + }, + "description": { + "description": "The description of the operation.", + "type": "string" + } + } + }, + "properties": { + "type": "object", + "description": "The additional properties.", + "x-ms-client-flatten": true + }, + "origin": { + "type": "string", + "description": "The intended executor of the operation.", + "enum": [ + "User", + "System" + ], + "x-ms-enum": { + "name": "ContainerInstanceOperationsOrigin", + "modelAsString": true + } + } + }, + "required": [ + "name", + "display" + ] + }, + "UsageListResult": { + "description": "The response containing the usage data", + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "description": "The usage data.", + "items": { + "$ref": "#/definitions/Usage" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "Usage": { + "description": "A single usage result", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Id of the usage result" + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "Unit of the usage result" + }, + "currentValue": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The current usage of the resource" + }, + "limit": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The maximum permitted usage of the resource." + }, + "name": { + "readOnly": true, + "type": "object", + "description": "The name object of the resource", + "properties": { + "value": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "The localized name of the resource" + } + } + } + } + }, + "ContainerGroupListResult": { + "description": "The container group list response that contains the container group properties.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerGroup" + }, + "description": "The list of container groups." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of container groups." + } + } + }, + "Logs": { + "description": "The logs.", + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The content of the log." + } + } + }, + "ContainerExecRequest": { + "description": "The container exec request.", + "type": "object", + "properties": { + "command": { + "type": "string", + "description": "The command to be executed." + }, + "terminalSize": { + "type": "object", + "description": "The size of the terminal.", + "properties": { + "rows": { + "type": "integer", + "format": "int32", + "description": "The row size of the terminal" + }, + "cols": { + "type": "integer", + "format": "int32", + "description": "The column size of the terminal" + } + } + } + } + }, + "ContainerExecResponse": { + "description": "The information for the container exec command.", + "type": "object", + "properties": { + "webSocketUri": { + "type": "string", + "description": "The uri for the exec websocket." + }, + "password": { + "type": "string", + "description": "The password to start the exec command.", + "x-ms-secret": true + } + } + }, + "ContainerAttachResponse": { + "description": "The information for the output stream from container attach.", + "type": "object", + "properties": { + "webSocketUri": { + "type": "string", + "description": "The uri for the output stream from the attach." + }, + "password": { + "type": "string", + "description": "The password to the output stream from the attach. Send as an Authorization header value when connecting to the websocketUri.", + "x-ms-secret": true + } + } + }, + "HttpHeader": { + "description": "The HTTP header.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The header name." + }, + "value": { + "type": "string", + "description": "The header value." + } + } + }, + "DnsConfiguration": { + "description": "DNS configuration for the container group.", + "type": "object", + "required": [ + "nameServers" + ], + "properties": { + "nameServers": { + "description": "The DNS servers for the container group.", + "type": "array", + "items": { + "type": "string" + } + }, + "searchDomains": { + "description": "The DNS search domains for hostname lookup in the container group.", + "type": "string" + }, + "options": { + "description": "The DNS options for the container group.", + "type": "string" + } + } + }, + "Resource": { + "type": "object", + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource id." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "location": { + "type": "string", + "description": "The resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + }, + "zones": { + "description": "The zones for the container group.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-azure-resource": true + }, + "CachedImagesListResult": { + "description": "The response containing cached images.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/cachedImages" + }, + "x-ms-identifiers": [ + "image" + ], + "description": "The list of cached images." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of cached images." + } + } + }, + "cachedImages": { + "description": "The cached image and OS type.", + "type": "object", + "required": [ + "osType", + "image" + ], + "properties": { + "osType": { + "type": "string", + "description": "The OS type of the cached image." + }, + "image": { + "type": "string", + "description": "The cached image name." + } + } + }, + "CapabilitiesListResult": { + "description": "The response containing list of capabilities.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Capabilities" + }, + "x-ms-identifiers": [ + "resourceType", + "location" + ], + "description": "The list of capabilities." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of capabilities." + } + } + }, + "Capabilities": { + "description": "The regional capabilities.", + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "readOnly": true, + "description": "The resource type that this capability describes." + }, + "osType": { + "type": "string", + "readOnly": true, + "description": "The OS type that this capability describes." + }, + "location": { + "type": "string", + "readOnly": true, + "description": "The resource location." + }, + "ipAddressType": { + "type": "string", + "readOnly": true, + "description": "The ip address type that this capability describes." + }, + "gpu": { + "type": "string", + "readOnly": true, + "description": "The GPU sku that this capability describes." + }, + "capabilities": { + "type": "object", + "readOnly": true, + "description": "The supported capabilities.", + "properties": { + "maxMemoryInGB": { + "type": "number", + "readOnly": true, + "description": "The maximum allowed memory request in GB." + }, + "maxCpu": { + "type": "number", + "readOnly": true, + "description": "The maximum allowed CPU request in cores." + }, + "maxGpuCount": { + "type": "number", + "readOnly": true, + "description": "The maximum allowed GPU count." + } + } + } + } + }, + "ContainerGroupSku": { + "description": "The container group SKU.", + "type": "string", + "enum": [ + "Standard", + "Dedicated", + "Confidential" + ], + "x-ms-enum": { + "name": "ContainerGroupSku", + "modelAsString": true + } + }, + "EncryptionProperties": { + "description": "The container group encryption properties.", + "type": "object", + "properties": { + "vaultBaseUrl": { + "description": "The keyvault base url.", + "type": "string" + }, + "keyName": { + "description": "The encryption key name.", + "type": "string" + }, + "keyVersion": { + "description": "The encryption key version.", + "type": "string" + }, + "identity": { + "type": "string", + "description": "The keyvault managed identity." + } + }, + "required": [ + "vaultBaseUrl", + "keyName", + "keyVersion" + ] + }, + "InitContainerDefinition": { + "description": "The init container definition.", + "type": "object", + "properties": { + "name": { + "description": "The name for the init container.", + "type": "string" + }, + "properties": { + "description": "The properties for the init container.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/InitContainerPropertiesDefinition" + } + }, + "required": [ + "name", + "properties" + ] + }, + "InitContainerPropertiesDefinition": { + "description": "The init container definition properties.", + "type": "object", + "properties": { + "image": { + "description": "The image of the init container.", + "type": "string" + }, + "command": { + "description": "The command to execute within the init container in exec form.", + "type": "array", + "items": { + "type": "string" + } + }, + "environmentVariables": { + "description": "The environment variables to set in the init container.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "instanceView": { + "description": "The instance view of the init container. Only valid in response.", + "readOnly": true, + "type": "object", + "properties": { + "restartCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of times that the init container has been restarted." + }, + "currentState": { + "readOnly": true, + "description": "The current state of the init container.", + "$ref": "#/definitions/ContainerState" + }, + "previousState": { + "readOnly": true, + "description": "The previous state of the init container.", + "$ref": "#/definitions/ContainerState" + }, + "events": { + "readOnly": true, + "description": "The events of the init container.", + "type": "array", + "items": { + "$ref": "#/definitions/Event" + }, + "x-ms-identifiers": [ + "name", + "type" + ] + } + } + }, + "volumeMounts": { + "description": "The volume mounts available to the init container.", + "type": "array", + "items": { + "$ref": "#/definitions/VolumeMount" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "securityContext": { + "description": "The container security properties.", + "$ref": "#/definitions/SecurityContextDefinition" + } + } + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "description": "An error response from the Container Instance service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "x-ms-identifiers": [ + "message", + "target" + ], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Container Instance service." + }, + "NetworkDependenciesResponse": { + "description": "Response for network dependencies, always empty list.", + "type": "array", + "items": { + "type": "string" + } + }, + "ConfidentialComputeProperties": { + "description": "The properties for confidential container group", + "type": "object", + "properties": { + "ccePolicy": { + "type": "string", + "description": "The base64 encoded confidential compute enforcement policy" + } + } + }, + "NGroupsSkusList": { + "description": "List of SKU definitions. NGroups offer a single sku", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NGroupSkus" + }, + "description": "The list of N Groups SKUs." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of N Groups SKUs." + } + } + }, + "NGroupSkus": { + "description": "The container probe, for liveness or readiness.", + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "description": "The type of resource the sku is applied to." + }, + "sku": { + "type": "string", + "description": "The sku of the resource type" + }, + "skuCapacity": { + "type": "string", + "description": "The number of container groups of the nGroups." + } + } + }, + "NGroupsListResult": { + "description": "The nGroups list response that contains the nGroups properties.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NGroup" + }, + "description": "The list of N Groups." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of N Groups." + } + } + }, + "NGroup": { + "type": "object", + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/systemData", + "readOnly": true + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NGroupProperties" + }, + "identity": { + "$ref": "#/definitions/NGroupIdentity", + "description": "The identity of the nGroup, if configured." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The nGroups zones. NOTE: Availability zones can only be set when you create the scale set" + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a nGroup." + }, + "NGroupIdentity": { + "type": "object", + "description": "Identity for the nGroup.", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the nGroup identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the nGroup. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the container scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the nGroup.", + "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 container scale set. 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", + "$ref": "../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/UserAssignedIdentity" + } + } + } + }, + "NGroupProperties": { + "type": "object", + "properties": { + "elasticProfile": { + "$ref": "#/definitions/ElasticProfile", + "description": "The elastic profile." + }, + "containerGroupProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerGroupProfileStub" + }, + "x-ms-identifiers": [], + "description": "The Container Group Profiles that could be used in a nGroup." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "enum": [ + "Creating", + "Updating", + "Failed", + "Succeeded", + "Canceled", + "Deleting", + "Migrating" + ], + "description": "The provisioning state, which only appears in the response.", + "x-ms-enum": { + "name": "NGroupProvisioningState", + "modelAsString": true + } + } + }, + "description": "Describes the properties of a Container Scale Set." + }, + "ElasticProfile": { + "type": "object", + "properties": { + "desiredCount": { + "type": "integer", + "format": "int32" + } + }, + "description": "Describes the elastic profile of the Container Scale Set" + }, + "ContainerGroupProfileStub": { + "type": "object", + "properties": { + "resource": { + "$ref": "#/definitions/ApiEntityReference" + } + }, + "description": "The object that contains a reference to a Container Group Profile" + }, + "ApiEntityReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." + } + }, + "description": "The API entity reference." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "x-ms-parameter-location": "client" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The identifier for the physical azure location.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version", + "x-ms-parameter-location": "client" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ContainerGroupNameParameter": { + "name": "containerGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the container group.", + "x-ms-parameter-location": "method" + }, + "VirtualNetworkNameParameter": { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network.", + "x-ms-parameter-location": "method" + }, + "SubnetNameParameter": { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet.", + "x-ms-parameter-location": "method" + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The operation Id.", + "x-ms-parameter-location": "method" + }, + "NGroupsNameParameter": { + "name": "ngroupsName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "minLength": 1, + "maxLength": 63, + "description": "The N Groups name.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/CachedImagesList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/CachedImagesList.json new file mode 100644 index 000000000000..fefd8d0102c0 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/CachedImagesList.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "westcentralus", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "osType": "Linux", + "image": "ubuntu:16.04" + }, + { + "osType": "Linux", + "image": "alpine:3.6" + }, + { + "osType": "Windows", + "image": "microsoft/nanoserver:10.0.14393.2485" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/CapabilitiesList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/CapabilitiesList.json new file mode 100644 index 000000000000..779de5c4f0fc --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/CapabilitiesList.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "westus", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "containerGroups", + "osType": "Linux", + "location": "West US", + "ipAddressType": "Public", + "gpu": "K80", + "capabilities": { + "maxMemoryInGB": 14, + "maxCpu": 4, + "maxGpuCount": 4 + } + }, + { + "resourceType": "containerGroups", + "osType": "Windows", + "location": "West US", + "ipAddressType": "Public", + "gpu": "None", + "capabilities": { + "maxMemoryInGB": 14, + "maxCpu": 4, + "maxGpuCount": 0 + } + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerAttach.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerAttach.json new file mode 100644 index 000000000000..edac356d1e7a --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerAttach.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerName": "container1" + }, + "responses": { + "200": { + "body": { + "webSocketUri": "wss://web-socket-uri", + "password": "password" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerExec.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerExec.json new file mode 100644 index 000000000000..88bffeeadafe --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerExec.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerName": "container1", + "containerExecRequest": { + "command": "/bin/bash", + "terminalSize": { + "rows": 12, + "cols": 12 + } + } + }, + "responses": { + "200": { + "body": { + "webSocketUri": "wss://web-socket-uri", + "password": "password" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupCreateConfidential.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupCreateConfidential.json new file mode 100644 index 000000000000..687fb2f7af50 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupCreateConfidential.json @@ -0,0 +1,182 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "zones": [ + "1" + ], + "containerGroup": { + "location": "westeurope", + "properties": { + "containers": [ + { + "name": "accdemo", + "properties": { + "command": [], + "environmentVariables": [], + "image": "confiimage", + "ports": [ + { + "port": 8000 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "securityContext": { + "privileged": false, + "capabilities": { + "add": [ + "CAP_NET_ADMIN" + ] + } + } + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 8000 + } + ], + "type": "Public" + }, + "osType": "Linux", + "sku": "Confidential", + "confidentialComputeProperties": { + "ccePolicy": "eyJhbGxvd19hbGwiOiB0cnVlLCAiY29udGFpbmVycyI6IHsibGVuZ3RoIjogMCwgImVsZW1lbnRzIjogbnVsbH19" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Confidential", + "provisioningState": "Succeeded", + "containers": [ + { + "name": "accdemo", + "properties": { + "image": "confiimage", + "command": [], + "ports": [ + { + "port": 8000 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + }, + "securityContext": { + "privileged": false, + "capabilities": { + "add": [ + "CAP_NET_ADMIN" + ] + } + } + } + } + ], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 8000 + } + ], + "type": "Public" + }, + "initContainers": [], + "imageRegistryCredentials": [], + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Running" + }, + "confidentialComputeProperties": { + "ccePolicy": "eyJhbGxvd19hbGwiOiB0cnVlLCAiY29udGFpbmVycyI6IHsibGVuZ3RoIjogMCwgImVsZW1lbnRzIjogbnVsbH19" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "westeurope" + } + }, + "201": { + "body": { + "properties": { + "sku": "Confidential", + "provisioningState": "Succeeded", + "containers": [ + { + "name": "accdemo", + "properties": { + "image": "confiimage", + "command": [], + "ports": [ + { + "port": 8000 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + }, + "securityContext": { + "privileged": false, + "capabilities": { + "add": [ + "CAP_NET_ADMIN" + ] + } + } + } + } + ], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 8000 + } + ], + "type": "Public" + }, + "initContainers": [], + "imageRegistryCredentials": [], + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Running" + }, + "confidentialComputeProperties": { + "ccePolicy": "eyJhbGxvd19hbGwiOiB0cnVlLCAiY29udGFpbmVycyI6IHsibGVuZ3RoIjogMCwgImVsZW1lbnRzIjogbnVsbH19" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "westeurope" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupEncryptionProperties.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupEncryptionProperties.json new file mode 100644 index 000000000000..d0539125776a --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupEncryptionProperties.json @@ -0,0 +1,192 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "zones": [ + "1" + ], + "containerGroup": { + "location": "eastus2", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity": {} + } + }, + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + } + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public" + }, + "osType": "Linux", + "encryptionProperties": { + "vaultBaseUrl": "https://testkeyvault.vault.azure.net", + "keyName": "test-key", + "keyVersion": "<key version>", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Standard", + "encryptionProperties": { + "vaultBaseUrl": "https://testkeyvault.vault.azure.net/", + "keyName": "test-key", + "keyVersion": "<key version>", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity" + }, + "provisioningState": "Pending", + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public" + }, + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Pending" + } + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity": { + "principalId": "<principal id>", + "clientId": "<client id>" + } + }, + "tenantId": "<tenant id>", + "type": "UserAssigned" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus2" + } + }, + "201": { + "body": { + "properties": { + "sku": "Standard", + "encryptionProperties": { + "vaultBaseUrl": "https://testkeyvault.vault.azure.net/", + "keyName": "test-key", + "keyVersion": "key version", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity" + }, + "provisioningState": "Running", + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public" + }, + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Pending" + } + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity": { + "principalId": "<principal id>", + "clientId": "<client id>" + } + }, + "tenantId": "<tenant id>", + "type": "UserAssigned" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus2" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupExtensions.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupExtensions.json new file mode 100644 index 000000000000..b24127918d4a --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupExtensions.json @@ -0,0 +1,208 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "zones": [ + "1" + ], + "containerGroup": { + "location": "eastus2", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + } + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Private" + }, + "osType": "Linux", + "subnetIds": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-rg-vnet/subnets/test-subnet" + } + ], + "extensions": [ + { + "name": "kube-proxy", + "properties": { + "extensionType": "kube-proxy", + "version": "1.0", + "settings": { + "clusterCidr": "10.240.0.0/16", + "kubeVersion": "v1.9.10" + }, + "protectedSettings": { + "kubeConfig": "<kubeconfig encoded string>" + } + } + }, + { + "name": "vk-realtime-metrics", + "properties": { + "extensionType": "realtime-metrics", + "version": "1.0" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Standard", + "provisioningState": "Pending", + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "extensions": [ + { + "name": "kube-proxy", + "properties": { + "extensionType": "kube-proxy", + "version": "1.0", + "settings": { + "clusterCidr": "10.240.0.0/16", + "kubeVersion": "v1.9.10" + } + } + }, + { + "name": "vk-realtime-metrics", + "properties": { + "extensionType": "realtime-metrics", + "version": "1.0" + } + } + ], + "imageRegistryCredentials": [], + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Pending" + }, + "subnetIds": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-rg-vnet/subnets/test-subnet" + } + ] + }, + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus2" + } + }, + "201": { + "body": { + "properties": { + "sku": "Standard", + "provisioningState": "Pending", + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "extensions": [ + { + "name": "kube-proxy", + "properties": { + "extensionType": "kube-proxy", + "version": "1.0", + "settings": { + "clusterCidr": "10.240.0.0/16", + "kubeVersion": "v1.9.10" + } + } + }, + { + "name": "vk-realtime-metrics", + "properties": { + "extensionType": "realtime-metrics", + "version": "1.0" + } + } + ], + "imageRegistryCredentials": [], + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Running" + }, + "subnetIds": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-rg-vnet/subnets/test-subnet" + } + ] + }, + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus2" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupUsage.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupUsage.json new file mode 100644 index 000000000000..60bca4b4c9a6 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupUsage.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "westcentralus", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 1, + "limit": 2000, + "name": { + "value": "ContainerGroups", + "localizedValue": "Container Groups" + } + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsCreateOrUpdate.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsCreateOrUpdate.json new file mode 100644 index 000000000000..9324b0919049 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsCreateOrUpdate.json @@ -0,0 +1,316 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "zones": [ + "1" + ], + "containerGroup": { + "location": "west us", + "identity": { + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name": {} + } + }, + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "diagnostics": { + "logAnalytics": { + "workspaceId": "workspaceid", + "workspaceKey": "workspaceKey", + "logType": "ContainerInsights", + "metadata": { + "test-key": "test-metadata-value" + }, + "workspaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/microsoft.operationalinsights/workspaces/workspace" + } + }, + "subnetIds": [ + { + "id": "[resourceId('Microsoft.Network/virtualNetworks/subnets', parameters('vnetName'), parameters('subnetName'))]" + } + ], + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ], + "searchDomains": "cluster.local svc.cluster.local", + "options": "ndots:2" + }, + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "autoGeneratedDomainNameLabelScope": "Unsecure" + }, + "osType": "Linux", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName", + "storageAccountKey": "accountKey" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": { + "secretKey1": "SecretValue1InBase64", + "secretKey2": "SecretValue2InBase64" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "diagnostics": { + "logAnalytics": { + "workspaceId": "workspaceid" + } + }, + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ], + "searchDomains": "cluster.local svc.cluster.local", + "options": "ndots:2" + }, + "imageRegistryCredentials": [], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "autoGeneratedDomainNameLabelScope": "Unsecure", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {} + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ] + }, + "imageRegistryCredentials": [], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "autoGeneratedDomainNameLabelScope": "Unsecure", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {} + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsCreatePriority.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsCreatePriority.json new file mode 100644 index 000000000000..87429dd0c245 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsCreatePriority.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerGroup": { + "properties": { + "sku": "Standard", + "containers": [ + { + "name": "test-container-001", + "properties": { + "image": "alpine:latest", + "command": [ + "/bin/sh", + "-c", + "sleep 10" + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + } + ], + "restartPolicy": "Never", + "osType": "Linux", + "priority": "Spot" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Standard", + "provisioningState": "Succeeded", + "containers": [ + { + "name": "test-container-001", + "properties": { + "image": "alpine:latest", + "command": [ + "/bin/sh", + "-c", + "sleep 10" + ], + "ports": [], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + } + ], + "initContainers": [], + "restartPolicy": "Never", + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Succeeded" + }, + "priority": "Spot" + }, + "id": "/subscriptions/subId/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus" + } + }, + "201": { + "body": { + "properties": { + "sku": "Standard", + "provisioningState": "Created", + "containers": [ + { + "name": "test-container-001", + "properties": { + "image": "alpine:latest", + "command": [ + "/bin/sh", + "-c", + "sleep 10" + ], + "ports": [], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + } + ], + "initContainers": [], + "restartPolicy": "Never", + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Created" + }, + "priority": "Spot" + }, + "id": "/subscriptions/subId/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsDelete.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsDelete.json new file mode 100644 index 000000000000..e98e2da7886b --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsDelete.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/locations/location/operations/operationId?api-version=apiVersion" + } + }, + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsGetPriority.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsGetPriority.json new file mode 100644 index 000000000000..4c73b3b469ae --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsGetPriority.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Standard", + "provisioningState": "Succeeded", + "containers": [ + { + "name": "test-container-001", + "properties": { + "image": "alpine:latest", + "command": [ + "/bin/sh", + "-c", + "sleep 10" + ], + "ports": [], + "environmentVariables": [], + "instanceView": { + "restartCount": 0, + "currentState": { + "state": "Terminated", + "startTime": "2022-11-11T19:33:44.217Z", + "exitCode": 0, + "finishTime": "2022-11-11T19:33:55.565Z", + "detailStatus": "Completed" + }, + "events": [ + { + "count": 2, + "firstTimestamp": "2022-11-11T19:28:22Z", + "lastTimestamp": "2022-11-11T19:32:09Z", + "name": "Pulling", + "message": "pulling image \"alpine@sha256:1304f174557314a7ed9eddb4eab12fed12cb0cd9809e4c28f29af86979a3c870\"", + "type": "Normal" + }, + { + "count": 2, + "firstTimestamp": "2022-11-11T19:32:08Z", + "lastTimestamp": "2022-11-11T19:32:38Z", + "name": "Pulled", + "message": "Successfully pulled image \"alpine@sha256:1304f174557314a7ed9eddb4eab12fed12cb0cd9809e4c28f29af86979a3c870\"", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2022-11-11T19:33:44Z", + "lastTimestamp": "2022-11-11T19:33:44Z", + "name": "Started", + "message": "Started container", + "type": "Normal" + } + ] + }, + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + } + ], + "initContainers": [], + "restartPolicy": "Never", + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Succeeded" + }, + "priority": "Spot" + }, + "id": "/subscriptions/subId/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsGet_Failed.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsGet_Failed.json new file mode 100644 index 000000000000..7c2a1087e3a5 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsGet_Failed.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "instanceView": { + "restartCount": 0, + "currentState": { + "state": "Waiting", + "startTime": "2017-08-08T00:09:10Z", + "detailStatus": "" + }, + "events": [ + { + "count": 1, + "firstTimestamp": "2017-08-08T00:09:01Z", + "lastTimestamp": "2017-08-08T00:09:01Z", + "message": "pulling image \"nginx\"", + "name": "Pulling", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2017-08-08T00:09:10Z", + "lastTimestamp": "2017-08-08T00:09:10Z", + "message": "Successfully pulled image \"nginx\"", + "name": "Pulled", + "type": "Normal" + } + ] + }, + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "instanceView": { + "events": [ + { + "count": 1, + "firstTimestamp": "2017-10-08T00:19:10Z", + "lastTimestamp": "2017-10-08T00:19:10Z", + "message": "Output: mount error(2): Permission denied", + "name": "FailedMount", + "type": "Normal" + } + ], + "state": "Pending" + }, + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Failed", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsGet_Succeeded.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsGet_Succeeded.json new file mode 100644 index 000000000000..dfaaba943d59 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsGet_Succeeded.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsList.json new file mode 100644 index 000000000000..8636a3c35539 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsList.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "instanceView": { + "restartCount": 0, + "currentState": { + "state": "Running", + "startTime": "2017-10-17T17:27:21Z", + "detailStatus": "" + }, + "events": [] + }, + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsListByResourceGroup.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsListByResourceGroup.json new file mode 100644 index 000000000000..f768479644b9 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsListByResourceGroup.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsRestart.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsRestart.json new file mode 100644 index 000000000000..be2f897f0bf7 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsRestart.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsStart.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsStart.json new file mode 100644 index 000000000000..9e99a1dcea31 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsStart.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/locations/location/operations/operationId?api-version=apiVersion" + } + }, + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsStop.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsStop.json new file mode 100644 index 000000000000..be2f897f0bf7 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsStop.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsUpdate.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsUpdate.json new file mode 100644 index 000000000000..62bef19fc5c5 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsUpdate.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview", + "resourceGroupName": "demoResource", + "containerGroupName": "demo1", + "Resource": { + "tags": { + "tag1key": "tag1Value", + "tag2key": "tag2Value" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demoResource/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "tags": { + "tag1key": "tag1Value", + "tag2key": "tag2Value" + }, + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {} + } + ] + } + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerListLogs.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerListLogs.json new file mode 100644 index 000000000000..45d8b1fb34fe --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerListLogs.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerName": "container1", + "tail": 10 + }, + "responses": { + "200": { + "body": { + "content": "log content" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/OperationsList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/OperationsList.json new file mode 100644 index 000000000000..38cf7b181a1f --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/OperationsList.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ContainerInstance/containerGroups/read", + "display": { + "provider": "Microsoft Container Instance", + "resource": "Container Group", + "operation": "Get Container Groups", + "description": "Get all container goups." + }, + "origin": "User" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/SubnetServiceAssociationLinkDelete.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/SubnetServiceAssociationLinkDelete.json new file mode 100644 index 000000000000..fa165c2e8bc3 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/SubnetServiceAssociationLinkDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview", + "resourceGroupName": "demo", + "virtualNetworkName": "demo2", + "subnetName": "demo3" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/locations/location/operations/operationId?api-version=apiVersion" + } + }, + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/readme.md b/specification/containerinstance/resource-manager/readme.md index 37a58d82b8e1..e875793a7d4f 100644 --- a/specification/containerinstance/resource-manager/readme.md +++ b/specification/containerinstance/resource-manager/readme.md @@ -38,6 +38,15 @@ input-file: - Microsoft.ContainerInstance/preview/2024-10-01-preview/containerInstance.json ``` +### Tag: package-preview-2024-09 + +These settings apply only when `--tag=package-preview-2024-09` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-09' +input-file: + - Microsoft.ContainerInstance/preview/2024-09-01-preview/containerInstance.json +``` + ### Tag: package-preview-2024-05 These settings apply only when `--tag=package-preview-2024-05` is specified on the command line. From 45ddb11cbb6200ab23ec7967f968c435d90b1b02 Mon Sep 17 00:00:00 2001 From: Mike Harder <mharder@microsoft.com> Date: Tue, 1 Oct 2024 18:06:14 -0700 Subject: [PATCH 26/47] [ProtectedFiles] Always allow changes from bot account 'azure-sdk' (#30826) --- .github/workflows/protected-files.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/protected-files.yaml b/.github/workflows/protected-files.yaml index eaba06462474..1811f69a93d8 100644 --- a/.github/workflows/protected-files.yaml +++ b/.github/workflows/protected-files.yaml @@ -6,6 +6,9 @@ jobs: protected-files: name: Protected Files + # Always allow bot account 'azure-sdk' to update protected files + if: ${{ github.event.pull_request.user.login != 'azure-sdk' }} + runs-on: ubuntu-latest steps: From 228a05629eee68a209607fd2a7514aac38c0df67 Mon Sep 17 00:00:00 2001 From: Mike Harder <mharder@microsoft.com> Date: Tue, 1 Oct 2024 18:19:45 -0700 Subject: [PATCH 27/47] [ProtectedFiles] Skip steps instead of job (#30827) - Check is required --- .github/workflows/protected-files.yaml | 52 +++++++++++++------------- 1 file changed, 27 insertions(+), 25 deletions(-) diff --git a/.github/workflows/protected-files.yaml b/.github/workflows/protected-files.yaml index 1811f69a93d8..84a962a9726d 100644 --- a/.github/workflows/protected-files.yaml +++ b/.github/workflows/protected-files.yaml @@ -6,32 +6,34 @@ jobs: protected-files: name: Protected Files - # Always allow bot account 'azure-sdk' to update protected files - if: ${{ github.event.pull_request.user.login != 'azure-sdk' }} - runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 - with: - # Required since "HEAD^" is passed to Get-ChangedFiles - fetch-depth: 2 - - - name: Detect changes to protected files - run: | - . eng/scripts/ChangedFiles-Functions.ps1 - - $protectedFiles = @("package.json", "package-lock.json") - $changedFiles = @(Get-ChangedFiles -baseCommitish HEAD^ -targetCommitish HEAD -diffFilter "") - $matchedFiles = @($protectedFiles | Where-Object { $changedFiles -contains $_}) - - if ($matchedFiles.Count -gt 0) { - foreach ($file in $matchedFiles) { - Write-Output "::error file=$file::File '$file' should only be updated by the Azure SDK team. If intentional, the PR may be merged by the Azure SDK team via bypassing the branch protections." + # Always allow bot account 'azure-sdk' to update protected files. + # Since check is required, the job itself cannot be skipped, but all steps can. + + - uses: actions/checkout@v4 + if: github.event.pull_request.user.login != 'azure-sdk' + with: + # Required since "HEAD^" is passed to Get-ChangedFiles + fetch-depth: 2 + + - name: Detect changes to protected files + if: github.event.pull_request.user.login != 'azure-sdk' + run: | + . eng/scripts/ChangedFiles-Functions.ps1 + + $protectedFiles = @("package.json", "package-lock.json") + $changedFiles = @(Get-ChangedFiles -baseCommitish HEAD^ -targetCommitish HEAD -diffFilter "") + $matchedFiles = @($protectedFiles | Where-Object { $changedFiles -contains $_}) + + if ($matchedFiles.Count -gt 0) { + foreach ($file in $matchedFiles) { + Write-Output "::error file=$file::File '$file' should only be updated by the Azure SDK team. If intentional, the PR may be merged by the Azure SDK team via bypassing the branch protections." + } + exit 1 + } + else { + Write-Output "No changes to protected files: [$($protectedFiles -join ', ')]" } - exit 1 - } - else { - Write-Output "No changes to protected files: [$($protectedFiles -join ', ')]" - } - shell: pwsh + shell: pwsh From 27fabfc1a3aa7d221a796056e3a716db7f051c08 Mon Sep 17 00:00:00 2001 From: Mike Harder <mharder@microsoft.com> Date: Tue, 1 Oct 2024 18:36:49 -0700 Subject: [PATCH 28/47] [ProtectedFiles] Log message for user 'azure-sdk' (#30828) --- .github/workflows/protected-files.yaml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/.github/workflows/protected-files.yaml b/.github/workflows/protected-files.yaml index 84a962a9726d..37e7ae730f06 100644 --- a/.github/workflows/protected-files.yaml +++ b/.github/workflows/protected-files.yaml @@ -9,8 +9,11 @@ jobs: runs-on: ubuntu-latest steps: - # Always allow bot account 'azure-sdk' to update protected files. - # Since check is required, the job itself cannot be skipped, but all steps can. + # Allow bot account 'azure-sdk' to update protected files. + # Since check is required, the job itself cannot be skipped. + - name: Allow bot account 'azure-sdk' + if: github.event.pull_request.user.login == 'azure-sdk' + run: echo "Bot account 'azure-sdk' is allowed to update protected files" - uses: actions/checkout@v4 if: github.event.pull_request.user.login != 'azure-sdk' From bab251671443a0cc41db116f083987a90954c269 Mon Sep 17 00:00:00 2001 From: jovancevic123 <62032416+jovancevic123@users.noreply.github.com> Date: Wed, 2 Oct 2024 08:34:15 +0200 Subject: [PATCH 29/47] Changing the version of DistributedAvailabilityGroups API for Azure CLI development (#30079) * Chaning the version of DistributedAvailabilityGroups in package-composite-v5 tag section. * Moving new version of DAG to the bottom of v5 section. --------- Co-authored-by: jovancevic123 <jojovancevic@microsoft.com> --- specification/sql/resource-manager/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/sql/resource-manager/readme.md b/specification/sql/resource-manager/readme.md index ce1c05a50db0..4ef907be6d5a 100644 --- a/specification/sql/resource-manager/readme.md +++ b/specification/sql/resource-manager/readme.md @@ -1692,7 +1692,6 @@ input-file: - ./Microsoft.Sql/preview/2021-05-01-preview/LongTermRetentionManagedInstanceBackups.json - ./Microsoft.Sql/preview/2021-05-01-preview/RestorableDroppedManagedDatabases.json - ./Microsoft.Sql/preview/2021-05-01-preview/ServerConnectionPolicies.json -- ./Microsoft.Sql/preview/2021-11-01-preview/DistributedAvailabilityGroups.json - ./Microsoft.Sql/preview/2021-11-01-preview/ServerTrustCertificates.json - ./Microsoft.Sql/preview/2021-11-01-preview/EndpointCertificates.json - ./Microsoft.Sql/preview/2020-11-01-preview/ManagedDatabaseSensitivityLabels.json @@ -1741,6 +1740,7 @@ input-file: - ./Microsoft.Sql/preview/2023-05-01-preview/ManagedInstances.json - ./Microsoft.Sql/preview/2023-05-01-preview/Servers.json - ./Microsoft.Sql/preview/2023-05-01-preview/ReplicationLinks.json +- ./Microsoft.Sql/preview/2023-08-01-preview/DistributedAvailabilityGroups.json # Needed when there is more than one input file override-info: From 3b93aaa5209ed1e7541e10926e9d7f0c91ee3700 Mon Sep 17 00:00:00 2001 From: Mike Harder <mharder@microsoft.com> Date: Wed, 2 Oct 2024 10:40:21 -0700 Subject: [PATCH 30/47] Use 1ES pool for Ubuntu images (#30822) --- .azure-pipelines/azure-pipelines-data-container.yml | 1 + azure-pipelines.yml | 1 + 2 files changed, 2 insertions(+) diff --git a/.azure-pipelines/azure-pipelines-data-container.yml b/.azure-pipelines/azure-pipelines-data-container.yml index 4617ad2fed07..d506d873153e 100644 --- a/.azure-pipelines/azure-pipelines-data-container.yml +++ b/.azure-pipelines/azure-pipelines-data-container.yml @@ -7,6 +7,7 @@ schedules: always: true pool: + name: azsdk-pool-mms-ubuntu-2204-general vmImage: 'Ubuntu-22.04' variables: diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 3bbdde1f7b21..d14435e27ff2 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -1,6 +1,7 @@ name: "Azure OpenAPI" pool: + name: azsdk-pool-mms-ubuntu-2004-general vmImage: 'Ubuntu-20.04' trigger: From 380b5583844f6e39b232695c789f9370a3bc829c Mon Sep 17 00:00:00 2001 From: YunsongB <39966392+YunsongB@users.noreply.github.com> Date: Wed, 2 Oct 2024 13:19:11 -0600 Subject: [PATCH 31/47] Add AOAI 2024-09-01-preview API version (#30821) * Add AOAI 2024-09-01-preview API version * Add changes; * Fix inference json and yml errors; * Fix prettierCheck; * Fix prettierCheck; * Fix spell check; --------- Co-authored-by: Yunsong Bai <yunba@microsoft.com> --- cSpell.json | 10 +- .../2024-09-01-preview/azureopenai.json | 3853 +++++ .../2024-09-01-preview/azureopenai.yaml | 2569 ++++ .../examples/cancel_batch.json | 41 + .../examples/cancel_batch.yaml | 33 + .../examples/cancel_finetuning_job.json | 37 + .../examples/cancel_finetuning_job.yaml | 34 + .../examples/delete_file.json | 13 + .../examples/delete_file.yaml | 9 + .../examples/delete_finetuning_job.json | 13 + .../examples/delete_finetuning_job.yaml | 9 + .../examples/get_batch.json | 41 + .../examples/get_batch.yaml | 33 + .../examples/get_batches.json | 48 + .../examples/get_batches.yaml | 37 + .../2024-09-01-preview/examples/get_file.json | 21 + .../2024-09-01-preview/examples/get_file.yaml | 16 + .../examples/get_file_content.json | 14 + .../examples/get_file_content.yaml | 9 + .../examples/get_files.json | 33 + .../examples/get_files.yaml | 24 + .../examples/get_finetuning_job.json | 42 + .../examples/get_finetuning_job.yaml | 36 + .../get_finetuning_job_checkpoints.json | 70 + .../get_finetuning_job_checkpoints.yaml | 54 + .../examples/get_finetuning_job_events.json | 43 + .../examples/get_finetuning_job_events.yaml | 33 + .../examples/get_finetuning_jobs.json | 47 + .../examples/get_finetuning_jobs.yaml | 38 + .../examples/get_ingestion_job.json | 27 + .../examples/get_ingestion_job.yaml | 21 + .../examples/get_ingestion_job_run.json | 30 + .../examples/get_ingestion_job_run.yaml | 18 + .../examples/get_model_base.json | 31 + .../examples/get_model_base.yaml | 25 + .../examples/get_model_finetune.json | 32 + .../examples/get_model_finetune.yaml | 24 + .../examples/get_models.json | 54 + .../examples/get_models.yaml | 41 + .../examples/import_file.json | 27 + .../examples/import_file.yaml | 47 + .../examples/list_ingestion_job_runs.json | 29 + .../examples/list_ingestion_job_runs.yaml | 16 + .../examples/list_ingestion_jobs.json | 22 + .../examples/list_ingestion_jobs.yaml | 12 + .../examples/post_batch.json | 49 + .../examples/post_batch.yaml | 39 + .../examples/post_finetuning_job.json | 54 + .../examples/post_finetuning_job.yaml | 51 + .../examples/put_ingestion_job_sc.json | 72 + .../examples/put_ingestion_job_sc.yaml | 51 + .../examples/put_ingestion_job_uc.json | 46 + .../examples/put_ingestion_job_uc.yaml | 39 + .../examples/upload_file.json | 24 + .../examples/upload_file.yaml | 19 + .../examples/upload_file_cancel.json | 31 + .../examples/upload_file_cancel.yaml | 25 + .../examples/upload_file_complete.json | 37 + .../examples/upload_file_complete.yaml | 30 + .../examples/upload_file_part.json | 22 + .../examples/upload_file_part.yaml | 16 + .../examples/upload_file_start.json | 38 + .../examples/upload_file_start.yaml | 30 + .../AzureOpenAI/authoring/readme.md | 41 + .../examples/audio_speech.json | 18 + .../examples/audio_speech.yaml | 12 + .../examples/audio_transcription_object.json | 15 + .../examples/audio_transcription_object.yaml | 9 + .../examples/audio_transcription_text.json | 15 + .../examples/audio_transcription_text.yaml | 19 + .../examples/audio_translation_object.json | 16 + .../examples/audio_translation_object.yaml | 21 + .../examples/audio_translation_text.json | 15 + .../examples/audio_translation_text.yaml | 21 + .../examples/cancel_run.json | 46 + .../examples/cancel_run.yaml | 35 + .../cancel_vector_store_file_batch.json | 27 + .../cancel_vector_store_file_batch.yaml | 20 + .../examples/chat_completions.json | 43 + .../examples/chat_completions.yaml | 45 + ...hat_completions_azure_search_advanced.json | 96 + ...hat_completions_azure_search_advanced.yaml | 63 + ...completions_azure_search_image_vector.json | 58 + ...completions_azure_search_image_vector.yaml | 36 + ...chat_completions_azure_search_minimum.json | 63 + ...chat_completions_azure_search_minimum.yaml | 39 + .../examples/chat_completions_cosmos_db.json | 77 + .../examples/chat_completions_cosmos_db.yaml | 49 + .../chat_completions_elasticsearch.json | 65 + .../chat_completions_elasticsearch.yaml | 41 + .../examples/chat_completions_mongo_db.json | 80 + .../examples/chat_completions_mongo_db.yaml | 52 + .../examples/chat_completions_pinecone.json | 77 + .../examples/chat_completions_pinecone.yaml | 51 + .../examples/completions.json | 38 + .../examples/create_assistant.json | 39 + .../examples/create_assistant.yaml | 26 + .../examples/create_message.json | 36 + .../examples/create_message.yaml | 25 + .../examples/create_run.json | 49 + .../examples/create_run.yaml | 38 + .../examples/create_thread.json | 17 + .../examples/create_thread.yaml | 11 + .../examples/create_thread_and_run.json | 54 + .../examples/create_thread_and_run.yaml | 42 + .../examples/create_vector_store.json | 28 + .../examples/create_vector_store.yaml | 20 + .../examples/create_vector_store_file.json | 24 + .../examples/create_vector_store_file.yaml | 17 + .../create_vector_store_file_batch.json | 30 + .../create_vector_store_file_batch.yaml | 22 + .../examples/delete_assistant.json | 17 + .../examples/delete_assistant.yaml | 11 + .../examples/delete_assistant_file.json | 18 + .../examples/delete_assistant_file.yaml | 12 + .../examples/delete_message.json | 18 + .../examples/delete_message.yaml | 12 + .../examples/delete_thread.json | 17 + .../examples/delete_thread.yaml | 11 + .../examples/delete_vector_store.json | 17 + .../examples/delete_vector_store.yaml | 11 + .../examples/delete_vector_store_file.json | 18 + .../examples/delete_vector_store_file.yaml | 12 + .../examples/embeddings.json | 1566 ++ .../examples/embeddings.yaml | 1553 ++ .../examples/generated_audio_speech.json | 19 + .../generated_audio_transcription_object.json | 17 + .../generated_audio_transcription_text.json | 16 + .../generated_audio_translation_object.json | 17 + .../generated_audio_translation_text.json | 16 + .../examples/generated_chat_completions.json | 45 + .../examples/generated_completions.json | 38 + .../examples/generated_embeddings.json | 1567 ++ ...extensions_chat_completions_aml_index.json | 62 + ...hat_completions_azure_search_advanced.json | 86 + ...completions_azure_search_image_vector.json | 67 + ...chat_completions_azure_search_minimum.json | 61 + ...extensions_chat_completions_cosmos_db.json | 78 + ...nsions_chat_completions_elasticsearch.json | 66 + ..._extensions_chat_completions_pinecone.json | 78 + .../examples/generated_image_generation.json | 31 + .../examples/get_assistant_file.json | 19 + .../examples/get_assistant_file.yaml | 13 + .../examples/get_message.json | 33 + .../examples/get_message.yaml | 23 + .../examples/get_message_file.json | 20 + .../examples/get_message_file.yaml | 14 + .../2024-09-01-preview/examples/get_run.json | 32 + .../2024-09-01-preview/examples/get_run.yaml | 26 + .../examples/get_run_step.json | 40 + .../examples/get_run_step.yaml | 31 + .../examples/image_generation.json | 71 + .../examples/image_generation.yaml | 49 + .../examples/list_assistant_files.json | 26 + .../examples/list_assistant_files.yaml | 17 + .../examples/list_assistants.json | 70 + .../examples/list_assistants.yaml | 54 + .../examples/list_message_files.json | 33 + .../examples/list_message_files.yaml | 22 + .../examples/list_messages.json | 60 + .../examples/list_messages.yaml | 41 + .../examples/list_run_steps.json | 47 + .../examples/list_run_steps.yaml | 35 + .../examples/list_runs.json | 112 + .../examples/list_runs.yaml | 85 + .../list_vector_store_file_batch.json | 33 + .../list_vector_store_file_batch.yaml | 22 + .../examples/list_vector_store_files.json | 32 + .../examples/list_vector_store_files.yaml | 21 + .../examples/list_vector_stores.json | 47 + .../examples/list_vector_stores.yaml | 51 + .../examples/modify_assistant.json | 44 + .../examples/modify_assistant.yaml | 29 + .../examples/modify_message.json | 42 + .../examples/modify_message.yaml | 29 + .../examples/modify_run.json | 66 + .../examples/modify_run.yaml | 55 + .../examples/modify_thread.json | 28 + .../examples/modify_thread.yaml | 19 + .../examples/modify_vector_store.json | 29 + .../examples/modify_vector_store.yaml | 21 + .../examples/retrieve_assistant.json | 30 + .../examples/retrieve_assistant.yaml | 21 + .../examples/retrieve_message.json | 33 + .../examples/retrieve_message.yaml | 23 + .../examples/retrieve_run.json | 51 + .../examples/retrieve_run.yaml | 40 + .../examples/retrieve_run_step.json | 40 + .../examples/retrieve_run_step.yaml | 31 + .../examples/retrieve_thread.json | 23 + .../examples/retrieve_thread.yaml | 15 + .../examples/retrieve_vector_store.json | 17 + .../examples/retrieve_vector_store.yaml | 11 + .../examples/retrieve_vector_store_file.json | 21 + .../examples/retrieve_vector_store_file.yaml | 15 + .../retrieve_vector_store_file_batch.json | 27 + .../retrieve_vector_store_file_batch.yaml | 20 + .../examples/submit_tool_outputs_to_run.json | 77 + .../examples/submit_tool_outputs_to_run.yaml | 57 + .../preview/2024-09-01-preview/inference.json | 12043 ++++++++++++++++ .../preview/2024-09-01-preview/inference.yaml | 8336 +++++++++++ .../AzureOpenAI/inference/readme.md | 15 + 202 files changed, 38212 insertions(+), 2 deletions(-) create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/azureopenai.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/azureopenai.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_batch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_batch.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_finetuning_job.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_finetuning_job.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_finetuning_job.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_finetuning_job.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batch.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batches.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batches.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file_content.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file_content.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_files.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_files.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_checkpoints.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_checkpoints.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_events.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_events.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_jobs.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_jobs.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_base.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_base.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_finetune.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_finetune.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_models.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_models.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/import_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/import_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_job_runs.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_job_runs.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_jobs.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_jobs.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_batch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_batch.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_finetuning_job.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_finetuning_job.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_sc.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_sc.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_uc.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_uc.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_cancel.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_cancel.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_complete.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_complete.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_part.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_part.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_start.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_start.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_speech.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_speech.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_object.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_object.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_text.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_text.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_object.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_object.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_text.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_text.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_vector_store_file_batch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_vector_store_file_batch.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_advanced.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_advanced.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_image_vector.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_image_vector.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_minimum.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_minimum.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_cosmos_db.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_cosmos_db.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_elasticsearch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_elasticsearch.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_mongo_db.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_mongo_db.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_pinecone.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_pinecone.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/completions.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_assistant.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_assistant.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_message.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_message.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread_and_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread_and_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file_batch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file_batch.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_message.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_message.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_thread.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_thread.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/embeddings.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/embeddings.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_speech.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_transcription_object.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_transcription_text.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_translation_object.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_translation_text.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_chat_completions.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_completions.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_embeddings.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_aml_index.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_azure_search_advanced.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_azure_search_image_vector.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_azure_search_minimum.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_cosmos_db.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_elasticsearch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_pinecone.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_image_generation.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_assistant_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_assistant_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run_step.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run_step.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/image_generation.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/image_generation.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistant_files.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistant_files.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistants.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistants.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_message_files.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_message_files.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_messages.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_messages.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_run_steps.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_run_steps.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_runs.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_runs.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_file_batch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_file_batch.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_files.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_files.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_stores.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_stores.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_assistant.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_assistant.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_message.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_message.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_thread.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_thread.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_vector_store.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_vector_store.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_assistant.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_assistant.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_message.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_message.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run_step.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run_step.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_thread.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_thread.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file_batch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file_batch.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/submit_tool_outputs_to_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/submit_tool_outputs_to_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.yaml diff --git a/cSpell.json b/cSpell.json index 3ee89cdd3c60..12154bc72508 100644 --- a/cSpell.json +++ b/cSpell.json @@ -52,7 +52,7 @@ "words": [ "azurearcdata" ] - }, + }, { "filename": "**/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/**/*.json", "words": [ @@ -61,7 +61,7 @@ "SSIS", "PBIRS" ] - }, + }, { "filename": "**/specification/batch/**/*.json", "words": [ @@ -1402,6 +1402,12 @@ "rerank" ] }, + { + "filename": "**/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/**/*.json", + "words": [ + "wandb" + ] + }, { "filename": "**/specification/communication/data-plane/CallAutomation/**/*.json", "words": [ diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/azureopenai.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/azureopenai.json new file mode 100644 index 000000000000..6719b00175c3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/azureopenai.json @@ -0,0 +1,3853 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure OpenAI API version 2024-09-01-preview", + "description": "APIs for fine-tuning and managing deployments of OpenAI models.", + "version": "2024-09-01-preview" + }, + "paths": { + "/batches": { + "get": { + "tags": [ + "Batch:" + ], + "summary": "Gets a list of all batches owned by the Azure OpenAI resource.", + "operationId": "Batch_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "after", + "description": "Identifier for the last event from the previous pagination request.", + "type": "string" + }, + { + "in": "query", + "name": "limit", + "description": "Number of batches to retrieve. Defaults to 20.", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BatchesList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting all batches owned by this account.": { + "$ref": "./examples/get_batches.json" + } + } + }, + "post": { + "tags": [ + "Batch:" + ], + "summary": "Creates and executes a batch from an uploaded file of requests.\r\nResponse includes details of the enqueued job including job status.\r\nThe ID of the result file is added to the response once complete.", + "operationId": "Batch_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "createBatchRequest", + "description": "The specification of the batch to create and execute.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchCreateRequest" + } + } + ], + "responses": { + "201": { + "description": "The batch has been successfully created.", + "schema": { + "$ref": "#/definitions/Batch" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Creating a batch.": { + "$ref": "./examples/post_batch.json" + } + } + } + }, + "/batches/{batch-id}": { + "get": { + "tags": [ + "Batch:" + ], + "summary": "Gets details for a single batch specified by the given batch-id.", + "operationId": "Batch_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "batch-id", + "description": "The identifier of the batch.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Batch" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting a batch.": { + "$ref": "./examples/get_batch.json" + } + } + } + }, + "/batches/{batch-id}/cancel": { + "post": { + "tags": [ + "Batch:" + ], + "summary": "Cancels the processing of the batch specified by the given batch-id.", + "operationId": "Batch_Cancel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "batch-id", + "description": "The identifier of the batch.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "The batch has been successfully canceled.", + "schema": { + "$ref": "#/definitions/Batch" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Canceling a batch.": { + "$ref": "./examples/cancel_batch.json" + } + } + } + }, + "/files": { + "get": { + "tags": [ + "Files:" + ], + "summary": "Gets a list of all files owned by the Azure OpenAI resource.\r\nThese include user uploaded content like files with purpose \"fine-tune\" for training or validation of fine-tunes models\r\nas well as files that are generated by the service such as \"fine-tune-results\" which contains various metrics for the corresponding fine-tune job.", + "operationId": "Files_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "purpose", + "description": "Only return files with the given purpose.", + "type": "string", + "enum": [ + "fine-tune", + "fine-tune-results", + "assistants", + "assistants_output", + "batch", + "batch_output" + ], + "x-ms-enum": { + "name": "Purpose", + "modelAsString": true, + "values": [ + { + "value": "fine-tune", + "description": "This file contains training data for a fine tune job." + }, + { + "value": "fine-tune-results", + "description": "This file contains the results of a fine tune job." + }, + { + "value": "assistants", + "description": "This file contains data to be used in assistants." + }, + { + "value": "assistants_output", + "description": "This file contains the results of an assistant." + }, + { + "value": "batch", + "description": "This file contains the input data for a batch." + }, + { + "value": "batch_output", + "description": "This file contains the results of a batch." + } + ] + } + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FileList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting all files owned by this account.": { + "$ref": "./examples/get_files.json" + } + } + }, + "post": { + "tags": [ + "Files:" + ], + "summary": "Creates a new file entity by uploading data from a local machine. Uploaded files can, for example, be used for training or evaluating fine-tuned models.", + "operationId": "Files_Upload", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "formData", + "name": "purpose", + "description": "The intended purpose of the uploaded documents. Use \"fine-tune\" for fine-tuning. This allows us to validate the format of the uploaded file.", + "required": true, + "type": "string", + "enum": [ + "fine-tune", + "fine-tune-results", + "assistants", + "assistants_output", + "batch" + ], + "x-ms-enum": { + "name": "Purpose", + "modelAsString": true, + "values": [ + { + "value": "fine-tune", + "description": "This file contains training data for a fine tune job." + }, + { + "value": "fine-tune-results", + "description": "This file contains the results of a fine tune job." + }, + { + "value": "assistants", + "description": "This file contains data to be used in assistants." + }, + { + "value": "assistants_output", + "description": "This file contains the results of an assistant." + }, + { + "value": "batch", + "description": "This file contains the input data for a batch." + } + ] + } + }, + { + "in": "formData", + "name": "file", + "description": "Gets or sets the file to upload into Azure OpenAI.", + "required": true, + "type": "file" + } + ], + "responses": { + "201": { + "description": "The file has been successfully created.", + "schema": { + "$ref": "#/definitions/File" + }, + "headers": { + "Location": { + "description": "The location of the newly created item.", + "type": "string", + "format": "url" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Upload a file.": { + "$ref": "./examples/upload_file.json" + } + } + } + }, + "/files/import": { + "post": { + "tags": [ + "Files:" + ], + "summary": "Creates a new file entity by importing data from a provided url. Uploaded files can, for example, be used for training or evaluating fine-tuned models.", + "operationId": "Files_Import", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "fileImport", + "description": "The definition of the file to create including its purpose, the file name and the url of the file location.", + "required": true, + "schema": { + "$ref": "#/definitions/FileImport" + } + } + ], + "responses": { + "201": { + "description": "The file has been successfully created.", + "schema": { + "$ref": "#/definitions/File" + }, + "headers": { + "Location": { + "description": "The location of the newly created item.", + "type": "string", + "format": "url" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Importing a file with a blob url as source.": { + "$ref": "./examples/import_file.json" + } + } + } + }, + "/files/{file-id}": { + "get": { + "tags": [ + "Files:" + ], + "summary": "Gets details for a single file specified by the given file-id including status, size, purpose, etc.", + "operationId": "Files_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "file-id", + "description": "The identifier of the file.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting a file.": { + "$ref": "./examples/get_file.json" + } + } + }, + "delete": { + "tags": [ + "Files:" + ], + "summary": "Deletes the file with the given file-id.\r\nDeletion is also allowed if a file was used, e.g., as training file in a fine-tune job.", + "operationId": "Files_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "file-id", + "description": "The identifier of the file.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "204": { + "description": "The file was successfully deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deleting a file.": { + "$ref": "./examples/delete_file.json" + } + } + } + }, + "/files/{file-id}/content": { + "get": { + "tags": [ + "Files:" + ], + "summary": "Gets the content of the file specified by the given file-id.\r\nFiles can be user uploaded content or generated by the service like result metrics of a fine-tune job.", + "operationId": "Files_GetContent", + "produces": [ + "application/octet-stream", + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "file-id", + "description": "The identifier of the file.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "file" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting the file content.": { + "$ref": "./examples/get_file_content.json" + } + } + } + }, + "/fine_tuning/jobs": { + "get": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Gets a list of all fine-tune jobs owned by the Azure OpenAI resource.\r\nThe details that are returned for each fine-tune job contain besides its identifier\r\nthe base model, training and validation files, hyper parameters, time stamps, status and events.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded.", + "operationId": "FineTuning_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "after", + "description": "Identifier for the last event from the previous pagination request.", + "type": "string" + }, + { + "in": "query", + "name": "limit", + "description": "Number of events to retrieve. Defaults to 20.", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FineTuningJobList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting all fine tuning jobs owned by this account.": { + "$ref": "./examples/get_finetuning_jobs.json" + } + } + }, + "post": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Creates a job that fine-tunes a specified model from a given training file.\r\nResponse includes details of the enqueued job including job status and hyper parameters.\r\nThe name of the fine-tuned model is added to the response once complete.", + "operationId": "FineTuning_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "fineTuningJob", + "description": "The specification of the fine-tuned model to create.\r\nRequired parameters are the base model and the training file to use.\r\nOptionally a validation file can be specified to compute validation metrics during training.\r\nHyper parameters will be set to default values or can be optionally specified.\r\nThese include batch size, learning rate multiplier, number of epochs and others.", + "required": true, + "schema": { + "$ref": "#/definitions/FineTuningJobCreation" + } + } + ], + "responses": { + "201": { + "description": "The fine tune has been successfully created.", + "schema": { + "$ref": "#/definitions/FineTuningJob" + }, + "headers": { + "Location": { + "description": "The location of the newly created item.", + "type": "string", + "format": "url" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Creating a fine tuning job.": { + "$ref": "./examples/post_finetuning_job.json" + } + } + } + }, + "/fine_tuning/jobs/{fine-tuning-job-id}": { + "get": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Gets details for a single fine-tune job specified by the given fine-tune-id.\r\nThe details contain the base model, training and validation files, hyper parameters, time stamps, status and events.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded.", + "operationId": "FineTuning_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FineTuningJob" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting a fine tuning job.": { + "$ref": "./examples/get_finetuning_job.json" + } + } + }, + "delete": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Deletes the fine-tune job specified by the given fine-tune-id.", + "operationId": "FineTuning_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "204": { + "description": "The fine tune was successfully deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deleting a fine tuning job.": { + "$ref": "./examples/delete_finetuning_job.json" + } + } + } + }, + "/fine_tuning/jobs/{fine-tuning-job-id}/cancel": { + "post": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Cancels the processing of the fine-tune job specified by the given fine-tune-id.", + "operationId": "FineTuning_Cancel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "The fine tune has been successfully canceled", + "schema": { + "$ref": "#/definitions/FineTuningJob" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Canceling a fine tuning job.": { + "$ref": "./examples/cancel_finetuning_job.json" + } + } + } + }, + "/fine_tuning/jobs/{fine-tuning-job-id}/checkpoints": { + "get": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Gets the checkpoints for the fine-tune job specified by the given fine-tune-id.\r\nCheckpoints are created at the end of successful epochs during training.", + "operationId": "FineTuning_GetCheckpoints", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "after", + "description": "Identifier for the last checkpoint ID from the previous pagination request.", + "type": "string" + }, + { + "in": "query", + "name": "limit", + "description": "Number of checkpoints to retrieve. Defaults to 10.", + "type": "integer", + "format": "int32", + "default": 10 + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FineTuningJobCheckpointList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting checkpoints of a fine tuning job.": { + "$ref": "./examples/get_finetuning_job_checkpoints.json" + } + } + } + }, + "/fine_tuning/jobs/{fine-tuning-job-id}/events": { + "get": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Gets the events for the fine-tune job specified by the given fine-tune-id.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded.", + "operationId": "FineTuning_GetEvents", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "after", + "description": "Identifier for the last event from the previous pagination request.", + "type": "string" + }, + { + "in": "query", + "name": "limit", + "description": "Number of events to retrieve. Defaults to 20.", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FineTuningJobEventList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting events of a fine tuning job.": { + "$ref": "./examples/get_finetuning_job_events.json" + } + } + } + }, + "/ingestion/jobs": { + "get": { + "tags": [ + "Ingestion:" + ], + "summary": "Lists the ingestion jobs.", + "operationId": "IngestionJobs_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "header", + "name": "mgmt-user-token", + "type": "string", + "description": "The token used to access the workspace (needed only for user compute jobs)." + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IngestionJobList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List all ingestion jobs": { + "$ref": "./examples/list_ingestion_jobs.json" + } + } + } + }, + "/ingestion/jobs/{job-id}": { + "put": { + "tags": [ + "Ingestion:" + ], + "summary": "Creates an ingestion job with the specified job id.", + "operationId": "IngestionJobs_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "path", + "name": "job-id", + "required": true, + "type": "string", + "description": "The id of the job that will be created." + }, + { + "in": "header", + "name": "mgmt-user-token", + "type": "string", + "description": "The token used to access the workspace (needed only for user compute jobs)." + }, + { + "in": "header", + "name": "aml-user-token", + "type": "string", + "description": "The token used to access the resources within the job in the workspace (needed only for user compute jobs)." + }, + { + "in": "body", + "name": "ingestionJob", + "schema": { + "$ref": "#/definitions/IngestionJob" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IngestionJob" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a system-compute ingestion job": { + "$ref": "./examples/put_ingestion_job_sc.json" + }, + "Create a user-compute ingestion job": { + "$ref": "./examples/put_ingestion_job_uc.json" + } + } + }, + "get": { + "tags": [ + "Ingestion:" + ], + "summary": "Gets the details of the specified job id.", + "operationId": "IngestionJobs_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "path", + "name": "job-id", + "required": true, + "description": "The id of the job.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IngestionJob" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get ingestion job": { + "$ref": "./examples/get_ingestion_job.json" + } + } + } + }, + "/ingestion/jobs/{job-id}/runs": { + "get": { + "tags": [ + "Ingestion:" + ], + "summary": "Lists the runs of the specified job id.", + "operationId": "IngestionJobRuns_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "path", + "name": "job-id", + "required": true, + "description": "The id of the job.", + "type": "string" + }, + { + "in": "header", + "name": "mgmt-user-token", + "type": "string", + "description": "The token used to access the workspace (needed only for user compute jobs)." + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IngestionJobRunList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List ingestion job runs": { + "$ref": "./examples/list_ingestion_job_runs.json" + } + } + } + }, + "/ingestion/jobs/{job-id}/runs/{run-id}": { + "get": { + "tags": [ + "Ingestion:" + ], + "summary": "Gets the details of the specified run id as part of the specified job id.", + "operationId": "IngestionJobRuns_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "path", + "name": "job-id", + "required": true, + "description": "The id of the job.", + "type": "string" + }, + { + "in": "path", + "name": "run-id", + "required": true, + "description": "The id of the run.", + "type": "string" + }, + { + "in": "header", + "name": "mgmt-user-token", + "type": "string", + "description": "The token used to access the workspace (needed only for user compute jobs)." + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IngestionJobRun" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get ingestion job runs": { + "$ref": "./examples/get_ingestion_job_run.json" + } + } + } + }, + "/models": { + "get": { + "tags": [ + "Models:" + ], + "summary": "Gets a list of all models that are accessible by the Azure OpenAI resource.\r\nThese include base models as well as all successfully completed fine-tuned models owned by the Azure OpenAI resource.", + "operationId": "Models_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting all models owned by account.": { + "$ref": "./examples/get_models.json" + } + } + } + }, + "/models/{model-id}": { + "get": { + "tags": [ + "Models:" + ], + "summary": "Gets details for the model specified by the given modelId.", + "operationId": "Models_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "model-id", + "description": "The identifier of the model.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Model" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting a base model.": { + "$ref": "./examples/get_model_base.json" + }, + "Getting a fine-tuned model.": { + "$ref": "./examples/get_model_finetune.json" + } + } + } + }, + "/uploads": { + "post": { + "tags": [ + "UploadFile:" + ], + "summary": "An intermediate Upload object is created, allowing you to add Parts to it. Currently, an Upload size can be a maximum of 9 GB in total and will expire two hours after being created.\r\nAfter the Upload is completed a File object will be generated, containing all the uploaded parts. This File object can then be used across our platform just like any other file.", + "operationId": "UploadFile_Start", + "consumes": [ + "application/json", + "text/json", + "application/*+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "requestBody", + "description": "The definition of the file to create including its purpose and the location on the local machine.", + "required": true, + "schema": { + "$ref": "#/definitions/UploadFileStartBody" + } + } + ], + "responses": { + "200": { + "description": "The upload has been successfully created.", + "schema": { + "$ref": "#/definitions/UploadResource" + }, + "headers": { + "Location": { + "description": "The location of the newly created item.", + "type": "string", + "format": "url" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Start a large file upload operation.": { + "$ref": "./examples/upload_file_start.json" + } + } + } + }, + "/uploads/{upload-id}/cancel": { + "post": { + "tags": [ + "UploadFile:" + ], + "summary": "Cancels the Upload, and will lead to all uploaded parts to be deleted asynchronously.\r\nNo Parts may be added after an Upload is cancelled.", + "operationId": "UploadFile_Cancel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "upload-id", + "description": "The identifier of the upload.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/UploadResource" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Cancel a large file upload operation.": { + "$ref": "./examples/upload_file_cancel.json" + } + } + } + }, + "/uploads/{upload-id}/complete": { + "post": { + "tags": [ + "UploadFile:" + ], + "summary": "This completes the Upload, and the returned Upload object contains a nested File object that is ready for use across the platform.\r\nYou can define the order of the Parts by providing an ordered list of Part IDs.\r\nThe total number of bytes uploaded must match the size originally specified when creating the Upload object.\r\nAfter this operation no additional Parts can be added once the Upload is completed.", + "operationId": "UploadFile_Complete", + "consumes": [ + "application/json", + "text/json", + "application/*+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "upload-id", + "description": "The identifier of the upload.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "requestBody", + "description": "The definition of the file to create including its purpose and the location on the local machine.", + "required": true, + "schema": { + "$ref": "#/definitions/UploadFileCompleteBody" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/UploadResource" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Complete and validate a large file upload operation.": { + "$ref": "./examples/upload_file_complete.json" + } + } + } + }, + "/uploads/{upload-id}/parts": { + "post": { + "tags": [ + "UploadFile:" + ], + "summary": "Adds a Part to an Upload object, where each Part represents a segment of the file you are uploading.\r\nEach Part can be up to the standard size limit for file upload, based on the File Purpose. You can continue adding Parts until reaching the Upload size limit of 9 GB.", + "operationId": "UploadFile_Part", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "upload-id", + "description": "The identifier of the upload.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "formData", + "name": "data", + "required": true, + "type": "file" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/UploadPartResource" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Upload a part of large file upload operation.": { + "$ref": "./examples/upload_file_part.json" + } + } + } + } + }, + "definitions": { + "AzureAISearchIndex": { + "description": "Azure AI Search Index.", + "required": [ + "connectionId" + ], + "allOf": [ + { + "$ref": "#/definitions/TargetIndex" + }, + { + "type": "object", + "properties": { + "connectionId": { + "type": "string", + "description": "The id of the connection pointing to the Azure AI Search Index." + } + } + } + ], + "x-ms-discriminator-value": "AzureAISearch" + }, + "BaseConnection": { + "title": "BaseConnection", + "description": "A connection to a resource.", + "type": "object", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/ConnectionType" + } + }, + "discriminator": "kind" + }, + "Batch": { + "title": "Batch", + "description": "Defines the values of a batch.", + "required": [ + "id", + "input_file_id" + ], + "type": "object", + "properties": { + "id": { + "description": "The identity of this item.", + "type": "string" + }, + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "endpoint": { + "description": "The API endpoint used by the batch.", + "type": "string", + "readOnly": true + }, + "errors": { + "$ref": "#/definitions/BatchErrors" + }, + "input_file_id": { + "description": "The ID of the input file for the batch.", + "minLength": 1, + "type": "string" + }, + "completion_window": { + "description": "The time frame within which the batch should be processed.", + "type": "string" + }, + "status": { + "$ref": "#/definitions/BatchStatus" + }, + "output_file_id": { + "description": "The ID of the file containing outputs of successfully executed requests.", + "type": "string" + }, + "error_file_id": { + "description": "The ID of the file containing outputs of requests with errors.", + "type": "string" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this batch was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "in_progress_at": { + "format": "unixtime", + "description": "A timestamp when this batch started progressing (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "expires_at": { + "format": "unixtime", + "description": "A timestamp when this batch will expire (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "finalizing_at": { + "format": "unixtime", + "description": "A timestamp when this batch started finalizing (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "completed_at": { + "format": "unixtime", + "description": "A timestamp when this batch was completed (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "failed_at": { + "format": "unixtime", + "description": "A timestamp when this batch failed (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "expired_at": { + "format": "unixtime", + "description": "A timestamp when this batch expired (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "cancelling_at": { + "format": "unixtime", + "description": "A timestamp when this batch started cancelling (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "cancelled_at": { + "format": "unixtime", + "description": "A timestamp when this batch was cancelled (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "request_counts": { + "$ref": "#/definitions/BatchRequestCounts" + }, + "metadata": { + "description": "A set of key-value pairs that can be attached to the batch. This can be useful for storing additional information about the batch in a structured format.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "BatchCreateRequest": { + "title": "BatchCreateRequest", + "description": "Defines the request to create a batch.", + "required": [ + "input_file_id", + "endpoint", + "completion_window" + ], + "type": "object", + "properties": { + "input_file_id": { + "description": "The ID if the input file for the batch.", + "minLength": 1, + "type": "string" + }, + "endpoint": { + "description": "The API endpoint used by the batch.", + "type": "string" + }, + "completion_window": { + "description": "The time frame within which the batch should be processed.", + "type": "string" + }, + "metadata": { + "description": "A set of key-value pairs that can be attached to the batch. This can be useful for storing additional information about the batch in a structured format.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "BatchErrorData": { + "title": "BatchErrorData", + "description": "Error information for a failure in batch.", + "type": "object", + "properties": { + "code": { + "description": "An error code identifying the error type.", + "type": "string" + }, + "message": { + "description": "A human-readable message providing more details about the error.", + "type": "string" + }, + "param": { + "description": "The name of the parameter that caused the error, if applicable (can be null).", + "type": "string" + }, + "line": { + "description": "The line number of the input file where the error occurred, if applicable (can be null).", + "type": "string" + } + } + }, + "BatchErrors": { + "title": "BatchErrors", + "description": "For batches that have failed, this will contain more information on the cause of the failures.", + "type": "object", + "properties": { + "object": { + "description": "The type of the errors object. This is always 'list'.", + "type": "string" + }, + "data": { + "$ref": "#/definitions/BatchErrorData" + } + } + }, + "BatchRequestCounts": { + "title": "BatchRequestCounts", + "description": "The request counts for different statuses within the batch.", + "type": "object", + "properties": { + "total": { + "description": "The total number of requests in the batch.", + "type": "integer" + }, + "completed": { + "description": "The number of requests in the batch that have been completed successfully.", + "type": "integer" + }, + "failed": { + "description": "The number of requests in the batch that have failed.", + "type": "integer" + } + } + }, + "BatchStatus": { + "title": "BatchStatus", + "description": "The status of a batch.", + "enum": [ + "validating", + "failed", + "in_progress", + "finalizing", + "completed", + "expired", + "cancelling", + "cancelled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BatchStatus", + "modelAsString": true, + "values": [ + { + "value": "validating", + "description": "The input file is being validated before the batch can begin." + }, + { + "value": "failed", + "description": "The input file has failed the validation process." + }, + { + "value": "in_progress", + "description": "The input file was successfully validated and the batch is currently being executed." + }, + { + "value": "finalizing", + "description": "The batch has completed and the results are being prepared." + }, + { + "value": "completed", + "description": "The batch has been completed and the results are ready." + }, + { + "value": "expired", + "description": "The batch was not able to complete within the 24-hour time window." + }, + { + "value": "cancelling", + "description": "Cancellation of the batch has been initiated." + }, + { + "value": "cancelled", + "description": "The batch was cancelled." + } + ] + } + }, + "BatchesList": { + "title": "BatchList", + "description": "Represents a list of batches.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/Batch" + } + }, + "first_id": { + "description": "The id of the first batch in the list of batches returned.", + "type": "string" + }, + "last_id": { + "description": "The id of the last batch in the list of batches returned.", + "type": "string" + }, + "has_more": { + "description": "A value indicating whether the list contains more elements than returned.", + "type": "boolean" + } + } + }, + "Capabilities": { + "title": "Capabilities", + "description": "The capabilities of a base or fine tune model.", + "required": [ + "chat_completion", + "completion", + "embeddings", + "fine_tune", + "inference" + ], + "type": "object", + "properties": { + "fine_tune": { + "description": "A value indicating whether a model can be used for fine tuning.", + "type": "boolean" + }, + "inference": { + "description": "A value indicating whether a model can be deployed.", + "type": "boolean" + }, + "completion": { + "description": "A value indicating whether a model supports completion.", + "type": "boolean" + }, + "chat_completion": { + "description": "A value indicating whether a model supports chat completion.", + "type": "boolean" + }, + "embeddings": { + "description": "A value indicating whether a model supports embeddings.", + "type": "boolean" + } + } + }, + "ChunkingSettings": { + "type": "object", + "title": "ChunkingSettings", + "description": "Chunking settings", + "properties": { + "maxChunkSizeInTokens": { + "type": "integer" + } + } + }, + "CompletionAction": { + "type": "string", + "description": "The completion action.", + "enum": [ + "cleanUpTempAssets", + "keepAllAssets" + ], + "x-ms-enum": { + "name": "IngestionJobCompletionAction", + "modelAsString": true, + "values": [ + { + "name": "keepAllAssets", + "value": "keepAllAssets", + "description": "Will not clean up any of the intermediate assets created during the ingestion process." + }, + { + "name": "cleanUpTempAssets", + "value": "cleanUpTempAssets", + "description": "Will clean up intermediate assets created during the ingestion process." + } + ] + } + }, + "ComputeType": { + "type": "string", + "description": "The compute type.", + "enum": [ + "ServerlessCompute", + "CustomCompute" + ], + "x-ms-enum": { + "name": "ComputeType", + "modelAsString": true, + "values": [ + { + "name": "ServerlessCompute", + "value": "ServerlessCompute", + "description": "Serverless user compute." + }, + { + "name": "CustomCompute", + "value": "CustomCompute", + "description": "Custom user compute." + } + ] + } + }, + "ConnectionStringConnection": { + "description": "Connection string connection.", + "required": [ + "connectionString" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseConnection" + }, + { + "type": "object", + "properties": { + "connectionString": { + "type": "string", + "description": "Connection string" + } + } + } + ], + "x-ms-discriminator-value": "ConnectionString" + }, + "ConnectionType": { + "type": "string", + "description": "The connection type.", + "enum": [ + "EndpointWithKey", + "ConnectionString", + "EndpointWithManagedIdentity", + "WorkspaceConnection", + "RelativeConnection" + ], + "x-ms-enum": { + "name": "ConnectionType", + "modelAsString": true, + "values": [ + { + "name": "EndpointWithKey", + "value": "EndpointWithKey", + "description": "Endpoint and key connection." + }, + { + "name": "ConnectionString", + "value": "ConnectionString", + "description": "Connection string." + }, + { + "name": "EndpointWithManagedIdentity", + "value": "EndpointWithManagedIdentity", + "description": "Endpoint and managed identity." + }, + { + "name": "WorkspaceConnection", + "value": "WorkspaceConnection", + "description": "AML Workspace connection." + }, + { + "name": "RelativeConnection", + "value": "RelativeConnection", + "description": "Relative deployment" + } + ] + } + }, + "CosmosDBIndex": { + "description": "CosmosDB Index.", + "required": [ + "connectionId" + ], + "allOf": [ + { + "$ref": "#/definitions/TargetIndex" + }, + { + "type": "object", + "properties": { + "connectionId": { + "type": "string", + "description": "The id of the connection pointing to the cosmos DB." + }, + "collectionName": { + "type": "string", + "description": "The name of the cosmos DB collection." + }, + "databaseName": { + "type": "string", + "description": "The name of the cosmos DB database." + } + } + } + ], + "x-ms-discriminator-value": "CosmosDB" + }, + "CrawlingSettings": { + "type": "object", + "title": "CrawlingSettings", + "description": "Crawling settings", + "properties": { + "maxCrawlDepth": { + "type": "integer" + }, + "maxCrawlTimeInMins": { + "type": "integer" + }, + "maxDownloadTimeInMins": { + "type": "integer" + }, + "maxFileSize": { + "type": "integer" + }, + "maxRedirects": { + "type": "integer" + }, + "maxFiles": { + "type": "integer" + } + } + }, + "CustomCompute": { + "description": "Custom compute.", + "required": [ + "computeId" + ], + "allOf": [ + { + "$ref": "#/definitions/JobCompute" + }, + { + "type": "object", + "properties": { + "computeId": { + "type": "string", + "description": "Id of the custom compute" + } + } + } + ], + "x-ms-discriminator-value": "CustomCompute" + }, + "DeploymentConnection": { + "description": "Relative deployment connection.", + "allOf": [ + { + "$ref": "#/definitions/BaseConnection" + } + ], + "x-ms-discriminator-value": "RelativeConnection" + }, + "Deprecation": { + "title": "Deprecation", + "description": "Defines the dates of deprecation for the different use cases of a model.\r\nUsually base models support 1 year of fine tuning after creation. Inference is typically supported 2 years after creation of base or\r\nfine tuned models. The exact dates are specified in the properties.", + "required": [ + "inference" + ], + "type": "object", + "properties": { + "fine_tune": { + "format": "unixtime", + "description": "The end date of fine tune support of this model. Will be `null` for fine tune models.", + "type": "integer" + }, + "inference": { + "format": "unixtime", + "description": "The end date of inference support of this model.", + "type": "integer" + } + } + }, + "EndpointKeyConnection": { + "description": "Endpoint key connection.", + "required": [ + "endpoint", + "key" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseConnection" + }, + { + "type": "object", + "properties": { + "endpoint": { + "type": "string", + "description": "Endpoint" + }, + "key": { + "type": "string", + "description": "Key" + } + } + } + ], + "x-ms-discriminator-value": "EndpointWithKey" + }, + "EndpointMIConnection": { + "description": "Endpoint Managed Identity connection.", + "required": [ + "endpoint" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseConnection" + }, + { + "type": "object", + "properties": { + "endpoint": { + "type": "string", + "description": "Endpoint" + }, + "resourceId": { + "type": "string", + "description": "Resource Id" + } + } + } + ], + "x-ms-discriminator-value": "EndpointWithManagedIdentity" + }, + "Error": { + "title": "Error", + "description": "Error content as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "$ref": "#/definitions/ErrorCode" + }, + "message": { + "description": "The message of this error.", + "minLength": 1, + "type": "string" + }, + "target": { + "description": "The location where the error happened if available.", + "type": "string" + }, + "details": { + "description": "The error details if available.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + }, + "innererror": { + "$ref": "#/definitions/InnerError" + } + } + }, + "ErrorCode": { + "title": "ErrorCode", + "description": "Error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "enum": [ + "conflict", + "invalidPayload", + "forbidden", + "notFound", + "unexpectedEntityState", + "itemDoesAlreadyExist", + "serviceUnavailable", + "internalFailure", + "quotaExceeded", + "jsonlValidationFailed", + "fileImportFailed", + "tooManyRequests", + "unauthorized", + "contentFilter" + ], + "type": "string", + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true, + "values": [ + { + "value": "conflict", + "description": "The requested operation conflicts with the current resource state." + }, + { + "value": "invalidPayload", + "description": "The request data is invalid for this operation." + }, + { + "value": "forbidden", + "description": "The operation is forbidden for the current user/api key." + }, + { + "value": "notFound", + "description": "The resource is not found." + }, + { + "value": "unexpectedEntityState", + "description": "The operation cannot be executed in the current resource's state." + }, + { + "value": "itemDoesAlreadyExist", + "description": "The item does already exist." + }, + { + "value": "serviceUnavailable", + "description": "The service is currently not available." + }, + { + "value": "internalFailure", + "description": "Internal error. Please retry." + }, + { + "value": "quotaExceeded", + "description": "Quota exceeded." + }, + { + "value": "jsonlValidationFailed", + "description": "Validation of jsonl data failed." + }, + { + "value": "tooManyRequests", + "description": "Too many requests. Please retry later." + }, + { + "value": "unauthorized", + "description": "The current user/api key is not authorized for the operation." + }, + { + "value": "contentFilter", + "description": "Image generation failed as a result of our safety system." + }, + { + "value": "fileImportFailed", + "description": "Import of file failed." + } + ] + } + }, + "ErrorResponse": { + "title": "ErrorResponse", + "description": "Error response as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "required": [ + "error" + ], + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/Error" + } + } + }, + "EventType": { + "title": "EventType", + "description": "Defines the severity of a content filter result.", + "enum": [ + "message", + "metrics" + ], + "type": "string", + "x-ms-enum": { + "name": "EventType", + "modelAsString": true, + "values": [ + { + "value": "message", + "description": "Event only contains human readable messages." + }, + { + "value": "metrics", + "description": "Event contains metrics." + } + ] + } + }, + "File": { + "title": "File", + "description": "A file is a document usable for training and validation. It can also be a service generated document with result details.", + "required": [ + "filename", + "purpose" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "bytes": { + "format": "int64", + "description": "The size of this file when available (can be null). File sizes larger than 2^53-1 are not supported to ensure compatibility\r\nwith JavaScript integers.", + "type": "integer", + "readOnly": true + }, + "purpose": { + "$ref": "#/definitions/Purpose" + }, + "filename": { + "description": "The name of the file.", + "minLength": 1, + "type": "string" + } + }, + "readOnly": true + }, + "FileCreate": { + "title": "FileCreate", + "description": "Defines a document to import from an external content url to be usable with Azure OpenAI.", + "required": [ + "content_url", + "purpose" + ], + "type": "object", + "properties": { + "purpose": { + "$ref": "#/definitions/Purpose" + }, + "content_url": { + "format": "url", + "description": "The url to download the document from (can be SAS url of a blob or any other external url accessible with a GET request).", + "type": "string" + } + } + }, + "FileDetails": { + "title": "FileDetails", + "description": "A file detail is a document used by batch service to fetch file blob details.", + "required": [ + "filename", + "purpose" + ], + "type": "object", + "properties": { + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "filename": { + "description": "The name of the file.", + "minLength": 1, + "type": "string" + }, + "path": { + "description": "The the relative path to the file within the container.", + "type": "string", + "readOnly": true + }, + "storage_account_uri": { + "format": "url", + "description": "The storage account url of this file.", + "type": "string", + "readOnly": true + }, + "storage_container_name": { + "description": "The Storage Container Name of this file blob.", + "type": "string", + "readOnly": true + }, + "purpose": { + "$ref": "#/definitions/Purpose" + } + } + }, + "FileImport": { + "title": "FileImport", + "description": "Defines a document to import from an external content url to be usable with Azure OpenAI.", + "required": [ + "content_url", + "filename", + "purpose" + ], + "type": "object", + "properties": { + "purpose": { + "$ref": "#/definitions/Purpose" + }, + "filename": { + "description": "The name of the [JSON Lines](https://jsonlines.readthedocs.io/en/latest/) file to be uploaded.\r\nIf the `purpose` is set to \"fine-tune\", each line is a JSON record with \"prompt\" and \"completion\" fields representing your training examples.", + "minLength": 1, + "type": "string" + }, + "content_url": { + "format": "url", + "description": "The url to download the document from (can be SAS url of a blob or any other external url accessible with a GET request).", + "type": "string" + } + } + }, + "FileList": { + "title": "FileList", + "description": "Represents a list of files.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/File" + } + } + } + }, + "FineTuningHyperParameters": { + "title": "FineTuningHyperParameters", + "description": "The hyper parameter settings used in a fine tune job.", + "type": "object", + "properties": { + "n_epochs": { + "format": "int32", + "description": "The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.", + "type": "integer" + }, + "batch_size": { + "format": "int32", + "description": "The batch size to use for training. The batch size is the number of training examples used to train a single forward and backward pass.\r\nIn general, we've found that larger batch sizes tend to work better for larger datasets.\r\nThe default value as well as the maximum value for this property are specific to a base model.", + "type": "integer" + }, + "learning_rate_multiplier": { + "format": "double", + "description": "The learning rate multiplier to use for training. The fine-tuning learning rate is the original learning rate used for pre-training multiplied by this value.\r\nLarger learning rates tend to perform better with larger batch sizes.\r\nWe recommend experimenting with values in the range 0.02 to 0.2 to see what produces the best results.", + "type": "number" + } + } + }, + "FineTuningJob": { + "title": "FineTuningJob", + "description": "Defines the values of a fine tune job.", + "required": [ + "model", + "training_file" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/FineTuningState" + }, + "model": { + "description": "The identifier (model-id) of the base model used for the fine-tune.", + "minLength": 1, + "type": "string" + }, + "fine_tuned_model": { + "description": "The identifier (model-id) of the resulting fine tuned model. This property is only populated for successfully completed fine-tune runs.\r\nUse this identifier to create a deployment for inferencing.", + "type": "string" + }, + "training_file": { + "description": "The file which is used for training.", + "minLength": 1, + "type": "string" + }, + "validation_file": { + "description": "The file which is used to evaluate the fine tuned model during training.", + "type": "string" + }, + "result_files": { + "description": "The result file identities (file-id) containing training and evaluation metrics in csv format.\r\nThe file is only available for successfully completed fine-tune runs.", + "type": "array", + "items": { + "type": "string" + } + }, + "finished_at": { + "format": "int32", + "description": "A timestamp when this job or item has finished successfully (in unix epochs).", + "type": "integer" + }, + "organisation_id": { + "description": "The organisation id of this fine tune job. Unused on Azure OpenAI; compatibility for OpenAI only.", + "type": "string" + }, + "trained_tokens": { + "format": "int32", + "description": "The total number of billable tokens processed by this fine tuning job.", + "type": "integer", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/FineTuningJobError" + }, + "estimated_finish": { + "format": "int32", + "description": "The Unix timestamp (in seconds) for when the fine-tuning job is estimated to finish. The value will be null if the fine-tuning job is not running.", + "type": "integer" + }, + "hyperparameters": { + "$ref": "#/definitions/FineTuningHyperParameters" + }, + "suffix": { + "description": "The suffix used to identify the fine-tuned model. The suffix can contain up to 40 characters (a-z, A-Z, 0-9,- and _) that will be added to your fine-tuned model name.", + "type": "string" + }, + "seed": { + "format": "int32", + "description": "The seed used for the finetuning job.", + "type": "integer" + }, + "integrations": { + "description": "A list configurations for integrations supporting the fine-tuning job.\r\nThere are many integrations planned, so make sure to check and act on the integration type.", + "type": "array", + "items": { + "$ref": "#/definitions/WandBIntegrationRequestWrapper" + } + } + } + }, + "FineTuningJobCheckpoint": { + "title": "FineTuningJobCheckpoint", + "required": [ + "created_at", + "fine_tuned_model_checkpoint", + "fine_tuning_job_id", + "metrics", + "step_number" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "id": { + "description": "The identity of this checkpoint.", + "type": "string", + "readOnly": true + }, + "created_at": { + "format": "unixtime", + "description": "The Unix timestamp (in seconds) for when the checkpoint was created.", + "type": "integer" + }, + "fine_tuned_model_checkpoint": { + "description": "The name of the fine-tuned checkpoint model that is created.", + "minLength": 1, + "type": "string" + }, + "step_number": { + "format": "int32", + "description": "The step number that the checkpoint was created at.", + "type": "integer" + }, + "metrics": { + "title": "Dictionary`2", + "description": "The metrics at the step number during the fine-tuning job.", + "type": "object", + "additionalProperties": { + "format": "double", + "type": "number" + } + }, + "fine_tuning_job_id": { + "description": "The name of the fine-tuning job that this checkpoint was created from..", + "minLength": 1, + "type": "string" + } + } + }, + "FineTuningJobCheckpointList": { + "title": "FineTuningJobCheckpointList", + "description": "Represents a list of checkpoints.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/FineTuningJobCheckpoint" + } + }, + "has_more": { + "description": "A value indicating whether the list contains more elements than returned.", + "type": "boolean" + } + } + }, + "FineTuningJobCreation": { + "title": "FineTuningJobCreation", + "description": "Defines the values of a fine tune job.", + "required": [ + "model", + "training_file" + ], + "type": "object", + "properties": { + "model": { + "description": "The identifier (model-id) of the base model used for this fine-tune.", + "minLength": 1, + "type": "string" + }, + "training_file": { + "description": "The file identity (file-id) that is used for training this fine tuned model.", + "minLength": 1, + "type": "string" + }, + "validation_file": { + "description": "The file identity (file-id) that is used to evaluate the fine tuned model during training.", + "type": "string" + }, + "hyperparameters": { + "$ref": "#/definitions/FineTuningHyperParameters" + }, + "suffix": { + "description": "The suffix used to identify the fine-tuned model. The suffix can contain up to 40 characters (a-z, A-Z, 0-9,- and _) that will be added to your fine-tuned model name.", + "type": "string" + }, + "seed": { + "format": "int32", + "description": "The seed used for the finetuning job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases. If a seed is not specified, one will be generated for you.", + "type": "integer" + }, + "integrations": { + "description": "A list configurations for integrations supporting the fine-tuning job.\r\nThere are many integrations planned, so make sure to check and act on the integration type.", + "type": "array", + "items": { + "$ref": "#/definitions/WandBIntegrationRequestWrapper" + } + } + } + }, + "FineTuningJobError": { + "title": "FineTuningJobError", + "description": "For fine-tuning jobs that have failed, this will contain more information on the cause of the failure.", + "type": "object", + "properties": { + "code": { + "description": "The machine-readable error code..", + "type": "string" + }, + "message": { + "description": "The human-readable error message.", + "type": "string" + }, + "param": { + "description": "The parameter that was invalid, usually training_file or validation_file. This field will be null if the failure was not parameter-specific.", + "type": "string" + } + } + }, + "FineTuningJobEvent": { + "title": "FineTuningJobEvent", + "required": [ + "created_at", + "level", + "message", + "type" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "id": { + "description": "The identity of this event.", + "type": "string", + "readOnly": true + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this event was created (in unix epochs).", + "type": "integer" + }, + "level": { + "$ref": "#/definitions/LogLevel" + }, + "message": { + "description": "The message describing the event. This can be a change of state, e.g., enqueued, started, failed or completed, or other events like uploaded results.", + "minLength": 1, + "type": "string" + }, + "type": { + "$ref": "#/definitions/EventType" + }, + "data": { + "description": "Machine readable data of this event." + } + } + }, + "FineTuningJobEventList": { + "title": "FineTuningJobEventList", + "description": "Represents a list of events.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/FineTuningJobEvent" + } + }, + "has_more": { + "description": "A value indicating whether the list contains more elements than returned.", + "type": "boolean" + } + } + }, + "FineTuningJobList": { + "title": "FineTuningJobList", + "description": "Represents a list of fine tunes.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/FineTuningJob" + } + }, + "has_more": { + "description": "A value indicating whether the list contains more elements than returned.", + "type": "boolean" + } + } + }, + "FineTuningState": { + "title": "FineTuningState", + "description": "The state of a finetunes object or fine tuning job.", + "enum": [ + "created", + "pending", + "running", + "succeeded", + "cancelled", + "failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "FineTuningState", + "modelAsString": true, + "values": [ + { + "value": "created", + "description": "The operation was created. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state." + }, + { + "value": "pending", + "description": "The operation is not yet queued to be processed in the future. It can be categorized as an inactive state." + }, + { + "value": "running", + "description": "The operation has started to be processed. It can be categorized as an active state." + }, + { + "value": "succeeded", + "description": "The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state." + }, + { + "value": "cancelled", + "description": "The operation has been cancelled and is incomplete. It can be categorized as a terminal state." + }, + { + "value": "failed", + "description": "The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state." + } + ] + } + }, + "GenericEmbeddingSettings": { + "title": "ConnectionEmbeddingSettings", + "description": "Connection Embedding Settings", + "type": "object", + "properties": { + "connection": { + "$ref": "#/definitions/BaseConnection" + }, + "deploymentName": { + "type": "string" + }, + "modelName": { + "type": "string" + } + } + }, + "IngestionError": { + "title": "IngestionError", + "description": "The details of the ingestion error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "innerErrors": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "IngestionJob": { + "title": "IngestionJob", + "description": "Represents the details of a job.", + "type": "object", + "required": [ + "kind" + ], + "discriminator": "kind", + "properties": { + "kind": { + "$ref": "#/definitions/IngestionJobType" + }, + "jobId": { + "type": "string" + } + } + }, + "IngestionJobList": { + "title": "IngestionJobList", + "description": "Represents a list of ingestion jobs.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page.", + "type": "string" + }, + "value": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/IngestionJob" + } + } + } + }, + "IngestionJobProgress": { + "title": "IngestionJobProgress", + "type": "object", + "required": [ + "stageProgress" + ], + "properties": { + "stageProgress": { + "type": "array", + "items": { + "$ref": "#/definitions/IngestionJobStageProgress" + } + } + } + }, + "IngestionJobRun": { + "title": "IngestionJobRun", + "description": "The details of a job run", + "type": "object", + "properties": { + "jobId": { + "type": "string" + }, + "runId": { + "type": "string" + }, + "status": { + "$ref": "#/definitions/OperationState" + }, + "error": { + "$ref": "#/definitions/IngestionError" + }, + "warnings": { + "type": "array", + "items": { + "type": "string" + } + }, + "progress": { + "$ref": "#/definitions/IngestionJobProgress" + } + } + }, + "IngestionJobRunList": { + "title": "IngestionJobRunList", + "description": "Represents a list of ingestion job runs.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page.", + "type": "string" + }, + "value": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/IngestionJobRun" + } + } + } + }, + "IngestionJobStageProgress": { + "title": "IngestionJobStageProgress", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "totalItems": { + "type": "integer", + "format": "int32" + }, + "processedItems": { + "type": "integer", + "format": "int32" + }, + "state": { + "$ref": "#/definitions/OperationState" + }, + "subStageProgress": { + "type": "array", + "items": { + "$ref": "#/definitions/IngestionJobStageProgress" + } + } + } + }, + "IngestionJobSystemCompute": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IngestionJob" + }, + { + "type": "object", + "properties": { + "searchServiceConnection": { + "$ref": "#/definitions/BaseConnection" + }, + "datasource": { + "$ref": "#/definitions/SystemComputeDatasource" + }, + "completionAction": { + "$ref": "#/definitions/CompletionAction" + }, + "dataRefreshIntervalInHours": { + "type": "integer" + } + } + } + ], + "x-ms-discriminator-value": "SystemCompute" + }, + "IngestionJobType": { + "title": "IngestionJobType", + "type": "string", + "description": "The job type.", + "enum": [ + "SystemCompute", + "UserCompute" + ], + "x-ms-enum": { + "name": "IngestionJobType", + "modelAsString": true, + "values": [ + { + "name": "SystemCompute", + "value": "SystemCompute", + "description": "Jobs that run on service owned resources." + }, + { + "name": "UserCompute", + "value": "UserCompute", + "description": "Jobs that run on user owned workspace." + } + ] + } + }, + "IngestionJobUserCompute": { + "type": "object", + "required": [ + "workspaceId" + ], + "allOf": [ + { + "$ref": "#/definitions/IngestionJob" + }, + { + "type": "object", + "properties": { + "workspaceId": { + "type": "string" + }, + "compute": { + "$ref": "#/definitions/JobCompute" + }, + "target": { + "$ref": "#/definitions/TargetIndex" + }, + "datasource": { + "$ref": "#/definitions/UserComputeDatasource" + }, + "dataRefreshIntervalInHours": { + "type": "integer" + } + } + } + ], + "x-ms-discriminator-value": "UserCompute" + }, + "InnerError": { + "title": "InnerError", + "description": "Inner error as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "type": "object", + "properties": { + "code": { + "$ref": "#/definitions/InnerErrorCode" + }, + "innererror": { + "$ref": "#/definitions/InnerError" + } + } + }, + "InnerErrorCode": { + "title": "InnerErrorCode", + "description": "Inner error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "enum": [ + "invalidPayload" + ], + "type": "string", + "x-ms-enum": { + "name": "InnerErrorCode", + "modelAsString": true, + "values": [ + { + "value": "invalidPayload", + "description": "The request data is invalid for this operation." + } + ] + } + }, + "IntegrationTypes": { + "title": "IntegrationTypes", + "description": "List of Fine Tune integrations available.", + "enum": [ + "wandb" + ], + "type": "string" + }, + "JobCompute": { + "title": "JobCompute", + "description": "The compute settings of the job.", + "type": "object", + "discriminator": "kind", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/ComputeType" + } + } + }, + "LifeCycleStatus": { + "title": "LifeCycleStatus", + "description": "The life cycle status of a model.\r\nNote: A model can be promoted from \"preview\" to \"generally-available\", but never from \"generally-available\" to \"preview\".", + "enum": [ + "preview", + "generally-available" + ], + "type": "string", + "x-ms-enum": { + "name": "LifeCycleStatus", + "modelAsString": true, + "values": [ + { + "value": "preview", + "description": "Model is in preview and covered by the service preview terms." + }, + { + "value": "generally-available", + "description": "Model is generally available." + } + ] + } + }, + "LogLevel": { + "title": "LogLevel", + "description": "The verbosity level of an event.", + "enum": [ + "info", + "warning", + "error" + ], + "type": "string", + "x-ms-enum": { + "name": "LogLevel", + "modelAsString": true, + "values": [ + { + "value": "info", + "description": "This event is for information only." + }, + { + "value": "warning", + "description": "This event represents a mitigated issue." + }, + { + "value": "error", + "description": "This message represents a non recoverable issue." + } + ] + } + }, + "Model": { + "title": "Model", + "description": "A model is either a base model or the result of a successful fine tune job.", + "required": [ + "capabilities", + "deprecation", + "lifecycle_status" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/FineTuningState" + }, + "model": { + "description": "The base model identity (model-id) if this is a fine tune model; otherwise `null`.", + "type": "string" + }, + "fine_tune": { + "description": "The fine tune job identity (fine-tune-id) if this is a fine tune model; otherwise `null`.", + "type": "string" + }, + "capabilities": { + "$ref": "#/definitions/Capabilities" + }, + "lifecycle_status": { + "$ref": "#/definitions/LifeCycleStatus" + }, + "deprecation": { + "$ref": "#/definitions/Deprecation" + } + } + }, + "ModelList": { + "title": "ModelList", + "description": "Represents a list of models.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/Model" + } + } + } + }, + "OperationState": { + "title": "OperationState", + "description": "The state of a job or item.", + "enum": [ + "notRunning", + "running", + "succeeded", + "failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OperationState", + "modelAsString": true, + "values": [ + { + "value": "notRunning", + "description": "The operation is not yet queued to be processed in the future." + }, + { + "value": "running", + "description": "The operation has started to be processed." + }, + { + "value": "succeeded", + "description": "The operation has successfully be processed and is ready for consumption." + }, + { + "value": "failed", + "description": "The operation has completed processing with a failure and cannot be further consumed." + } + ] + } + }, + "PineconeIndex": { + "description": "Pinecone Index.", + "required": [ + "connectionId" + ], + "allOf": [ + { + "$ref": "#/definitions/TargetIndex" + }, + { + "type": "object", + "properties": { + "connectionId": { + "type": "string", + "description": "The id of the connection pointing to the pinecone." + } + } + } + ], + "x-ms-discriminator-value": "Pinecone" + }, + "Purpose": { + "title": "Purpose", + "description": "The intended purpose of the uploaded documents. Use \"fine-tune\" for fine-tuning. This allows us to validate the format of the uploaded file.", + "enum": [ + "fine-tune", + "fine-tune-results", + "assistants", + "assistants_output", + "batch", + "batch_output" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Purpose", + "modelAsString": true, + "values": [ + { + "value": "fine-tune", + "description": "This file contains training data for a fine tune job." + }, + { + "value": "fine-tune-results", + "description": "This file contains the results of a fine tune job." + }, + { + "value": "assistants", + "description": "This file contains data to be used in assistants." + }, + { + "value": "assistants_output", + "description": "This file contains the results of an assistant." + }, + { + "value": "batch", + "description": "This file contains the input data for a batch." + }, + { + "value": "batch_output", + "description": "This file contains the results of a batch." + } + ] + } + }, + "ServerlessCompute": { + "description": "Serverless compute.", + "allOf": [ + { + "$ref": "#/definitions/JobCompute" + }, + { + "type": "object", + "properties": { + "sku": { + "type": "string", + "description": "SKU Level" + }, + "instanceCount": { + "type": "integer", + "description": "The count of instances to run the job on." + } + } + } + ], + "x-ms-discriminator-value": "ServerlessCompute" + }, + "SystemComputeDatasource": { + "title": "SystemComputeDatasource", + "type": "object", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/SystemComputeDatasourceType" + } + }, + "discriminator": "kind" + }, + "SystemComputeDatasourceType": { + "type": "string", + "description": "The datasource type.", + "enum": [ + "Storage", + "Urls" + ], + "x-ms-enum": { + "name": "SystemComputeDatasourceType", + "modelAsString": true, + "values": [ + { + "name": "Storage", + "value": "Storage", + "description": "Azure Storage Account." + }, + { + "name": "Urls", + "value": "Urls", + "description": "URLs." + } + ] + } + }, + "SystemComputeStorage": { + "title": "SystemComputeStorage", + "description": "Storage account", + "required": [ + "connection", + "containerName", + "embeddings" + ], + "x-ms-discriminator-value": "Storage", + "allOf": [ + { + "$ref": "#/definitions/SystemComputeDatasource" + }, + { + "type": "object", + "properties": { + "connection": { + "$ref": "#/definitions/BaseConnection" + }, + "containerName": { + "type": "string", + "description": "container name" + }, + "chunking": { + "$ref": "#/definitions/ChunkingSettings" + }, + "embeddings": { + "type": "array", + "items": { + "$ref": "#/definitions/GenericEmbeddingSettings" + } + } + } + } + ] + }, + "SystemComputeUrl": { + "title": "SystemComputeUrl", + "description": "Urls", + "required": [ + "urls", + "connection", + "containerName", + "embeddings" + ], + "x-ms-discriminator-value": "Urls", + "allOf": [ + { + "$ref": "#/definitions/SystemComputeDatasource" + }, + { + "type": "object", + "properties": { + "urls": { + "type": "array", + "items": { + "type": "string" + } + }, + "connection": { + "$ref": "#/definitions/BaseConnection" + }, + "containerName": { + "type": "string", + "description": "container name" + }, + "crawling": { + "$ref": "#/definitions/CrawlingSettings" + }, + "chunking": { + "$ref": "#/definitions/ChunkingSettings" + }, + "embeddings": { + "type": "array", + "items": { + "$ref": "#/definitions/GenericEmbeddingSettings" + } + } + } + } + ] + }, + "TargetIndex": { + "title": "TargetIndex", + "description": "Information about the index to be created.", + "type": "object", + "discriminator": "kind", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/TargetType" + } + } + }, + "TargetType": { + "type": "string", + "description": "The target type.", + "enum": [ + "AzureAISearch", + "CosmosDB", + "Pinecone" + ], + "x-ms-enum": { + "name": "TargetType", + "modelAsString": true, + "values": [ + { + "name": "AzureAISearch", + "value": "AzureAISearch", + "description": "Azure AI Search Index." + }, + { + "name": "CosmosDB", + "value": "CosmosDB", + "description": "CosmosDB Index." + }, + { + "name": "Pinecone", + "value": "Pinecone", + "description": "Pinecone Index." + } + ] + } + }, + "TypeDiscriminator": { + "title": "TypeDiscriminator", + "description": "Defines the type of an object.", + "enum": [ + "list", + "fine_tuning.job", + "file", + "fine_tuning.job.event", + "fine_tuning.job.checkpoint", + "model", + "upload", + "upload.part" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "TypeDiscriminator", + "modelAsString": true, + "values": [ + { + "value": "list", + "description": "This object represents a list of other objects." + }, + { + "value": "fine_tuning.job", + "description": "This object represents a fine tune job." + }, + { + "value": "file", + "description": "This object represents a file." + }, + { + "value": "fine_tuning.job.event", + "description": "This object represents an event of a fine tuning job." + }, + { + "value": "fine_tuning.job.checkpoint", + "description": "This object represents a checkpoint of a fine tuning job." + }, + { + "value": "model", + "description": "This object represents a model (can be a base model or fine tune job result)." + }, + { + "value": "upload", + "description": "This object represents a file upload." + }, + { + "value": "upload.part", + "description": "This object represents part of a file upload." + }, + { + "value": "wandb", + "description": "This object represents the Weights and Biases Integration configuration." + } + ] + } + }, + "UploadFileCompleteBody": { + "title": "UploadFileCompleteBody", + "required": [ + "part_ids" + ], + "type": "object", + "properties": { + "part_ids": { + "title": "IList`1", + "type": "array", + "items": { + "type": "string" + } + }, + "md5": { + "type": "string" + } + } + }, + "UploadFileStartBody": { + "title": "UploadFileStartBody", + "required": [ + "bytes", + "filename", + "mime_type", + "purpose" + ], + "type": "object", + "properties": { + "purpose": { + "$ref": "#/definitions/Purpose" + }, + "filename": { + "minLength": 1, + "type": "string" + }, + "bytes": { + "format": "int64", + "type": "integer" + }, + "mime_type": { + "minLength": 1, + "type": "string" + } + } + }, + "UploadPartResource": { + "title": "UploadPartResource", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "upload_id": { + "type": "string", + "readOnly": true + }, + "azure_block_id": { + "type": "string", + "readOnly": true + } + } + }, + "UploadResource": { + "title": "UploadResource", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "bytes": { + "format": "int64", + "type": "integer", + "readOnly": true + }, + "filename": { + "type": "string", + "readOnly": true + }, + "purpose": { + "$ref": "#/definitions/Purpose" + }, + "status": { + "$ref": "#/definitions/UploadStatus" + }, + "expires_at": { + "format": "unixtime", + "type": "integer", + "readOnly": true + }, + "file": { + "$ref": "#/definitions/File" + } + } + }, + "UploadStatus": { + "title": "UploadStatus", + "enum": [ + "pending", + "expired", + "completed", + "cancelled" + ], + "type": "string", + "readOnly": true + }, + "UserComputeDataset": { + "type": "object", + "title": "UserComputeStorage", + "description": "Storage account", + "required": [ + "datasetId", + "datasetType" + ], + "x-ms-discriminator-value": "Dataset", + "allOf": [ + { + "$ref": "#/definitions/UserComputeDatasource" + }, + { + "type": "object", + "properties": { + "datasetId": { + "type": "string" + }, + "datasetType": { + "type": "string" + }, + "chunking": { + "$ref": "#/definitions/ChunkingSettings" + }, + "embeddings": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkspaceConnectionEmbeddingSettings" + } + } + } + } + ] + }, + "UserComputeDatasource": { + "title": "UserComputeDatasource", + "type": "object", + "discriminator": "kind", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/UserComputeDatasourceType" + } + } + }, + "UserComputeDatasourceType": { + "type": "string", + "description": "The datasource type.", + "enum": [ + "Dataset", + "Urls" + ], + "x-ms-enum": { + "name": "UserComputeDatasourceType", + "modelAsString": true, + "values": [ + { + "name": "Dataset", + "value": "Dataset", + "description": "Workspace Dataset." + }, + { + "name": "Urls", + "value": "Urls", + "description": "URLs." + } + ] + } + }, + "UserComputeUrl": { + "type": "object", + "title": "UserComputeUrl", + "description": "Urls", + "required": [ + "urls", + "embeddings" + ], + "x-ms-discriminator-value": "Urls", + "allOf": [ + { + "$ref": "#/definitions/UserComputeDatasource" + }, + { + "type": "object", + "properties": { + "urls": { + "type": "array", + "items": { + "type": "string" + } + }, + "crawling": { + "$ref": "#/definitions/CrawlingSettings" + }, + "chunking": { + "$ref": "#/definitions/ChunkingSettings" + }, + "embeddings": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkspaceConnectionEmbeddingSettings" + } + } + } + } + ] + }, + "WandBIntegrationRequest": { + "title": "WandBIntegrationRequest", + "required": [ + "project" + ], + "type": "object", + "properties": { + "project": { + "minLength": 1, + "type": "string" + }, + "name": { + "type": "string", + "readOnly": true + }, + "entity": { + "type": "string", + "readOnly": true + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "WandBIntegrationRequestWrapper": { + "title": "WandBIntegrationRequestWrapper", + "required": [ + "type", + "wandb" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/IntegrationTypes" + }, + "wandb": { + "$ref": "#/definitions/WandBIntegrationRequest" + } + } + }, + "WorkspaceConnection": { + "description": "AML Workspace connection.", + "required": [ + "connectionId" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseConnection" + }, + { + "type": "object", + "properties": { + "connectionId": { + "type": "string", + "description": "ConnectionId" + } + } + } + ], + "x-ms-discriminator-value": "WorkspaceConnection" + }, + "WorkspaceConnectionEmbeddingSettings": { + "title": "WorkspaceConnectionEmbeddingSettings", + "description": "Connection id to the embedding model", + "type": "object", + "properties": { + "connectionId": { + "type": "string" + }, + "deploymentName": { + "type": "string" + }, + "modelName": { + "type": "string" + } + } + } + }, + "parameters": { + "endpoint": { + "in": "path", + "name": "endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://aoairesource.openai.azure.com. Replace \"aoairesource\" with your Azure OpenAI account name).", + "required": true, + "type": "string", + "format": "url", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "apiVersionQueryParameter": { + "in": "query", + "name": "api-version", + "description": "The requested API version.", + "required": true, + "type": "string", + "x-ms-client-default": "2024-09-01-preview", + "x-ms-parameter-location": "client" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "OAuth2Auth": [ + "https://cognitiveservices.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "ApiKeyAuth": { + "description": "API key authentication", + "type": "apiKey", + "name": "api-key", + "in": "header" + }, + "OAuth2Auth": { + "description": "OAuth2 authentication", + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", + "scopes": { + "https://cognitiveservices.azure.com/.default": "" + } + } + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/openai", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/endpoint" + } + ] + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/azureopenai.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/azureopenai.yaml new file mode 100644 index 000000000000..3f8aa397e406 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/azureopenai.yaml @@ -0,0 +1,2569 @@ +swagger: "2.0" +info: + title: Azure OpenAI API version 2024-09-01-preview + description: APIs for fine-tuning and managing deployments of OpenAI models. + version: 2024-09-01-preview +paths: + /batches: + get: + tags: + - "Batch:" + summary: Gets a list of all batches owned by the Azure OpenAI resource. + operationId: Batch_List + produces: + - application/json + parameters: + - in: query + name: after + description: Identifier for the last event from the previous pagination request. + type: string + - in: query + name: limit + description: Number of batches to retrieve. Defaults to 20. + type: integer + format: int32 + default: 20 + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/BatchesList" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting all batches owned by this account.: + $ref: ./examples/get_batches.json + post: + tags: + - "Batch:" + summary: "Creates and executes a batch from an uploaded file of requests.\r\nResponse includes details of the enqueued job including job status.\r\nThe ID of the result file is added to the response once complete." + operationId: Batch_Create + consumes: + - application/json + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: body + name: createBatchRequest + description: The specification of the batch to create and execute. + required: true + schema: + $ref: "#/definitions/BatchCreateRequest" + responses: + "201": + description: The batch has been successfully created. + schema: + $ref: "#/definitions/Batch" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Creating a batch.: + $ref: ./examples/post_batch.json + /batches/{batch-id}: + get: + tags: + - "Batch:" + summary: Gets details for a single batch specified by the given batch-id. + operationId: Batch_Get + produces: + - application/json + parameters: + - in: path + name: batch-id + description: The identifier of the batch. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/Batch" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting a batch.: + $ref: ./examples/get_batch.json + /batches/{batch-id}/cancel: + post: + tags: + - "Batch:" + summary: Cancels the processing of the batch specified by the given batch-id. + operationId: Batch_Cancel + produces: + - application/json + parameters: + - in: path + name: batch-id + description: The identifier of the batch. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: The batch has been successfully canceled. + schema: + $ref: "#/definitions/Batch" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Canceling a batch.: + $ref: ./examples/cancel_batch.json + /files: + get: + tags: + - "Files:" + summary: "Gets a list of all files owned by the Azure OpenAI resource.\r\nThese include user uploaded content like files with purpose \"fine-tune\" for training or validation of fine-tunes models\r\nas well as files that are generated by the service such as \"fine-tune-results\" which contains various metrics for the corresponding fine-tune job." + operationId: Files_List + produces: + - application/json + parameters: + - in: query + name: purpose + description: Only return files with the given purpose. + type: string + enum: + - fine-tune + - fine-tune-results + - assistants + - assistants_output + - batch + - batch_output + x-ms-enum: + name: Purpose + modelAsString: true + values: + - value: fine-tune + description: This file contains training data for a fine tune job. + - value: fine-tune-results + description: This file contains the results of a fine tune job. + - value: assistants + description: This file contains data to be used in assistants. + - value: assistants_output + description: This file contains the results of an assistant. + - value: batch + description: This file contains the input data for a batch. + - value: batch_output + description: This file contains the results of a batch. + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/FileList" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting all files owned by this account.: + $ref: ./examples/get_files.yaml + post: + tags: + - "Files:" + summary: Creates a new file entity by uploading data from a local machine. Uploaded files can, for example, be used for training or evaluating fine-tuned models. + operationId: Files_Upload + consumes: + - multipart/form-data + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: formData + name: purpose + description: The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file. + required: true + type: string + enum: + - fine-tune + - fine-tune-results + - assistants + - assistants_output + - batch + x-ms-enum: + name: Purpose + modelAsString: true + values: + - value: fine-tune + description: This file contains training data for a fine tune job. + - value: fine-tune-results + description: This file contains the results of a fine tune job. + - value: assistants + description: This file contains data to be used in assistants. + - value: assistants_output + description: This file contains the results of an assistant. + - value: batch + description: This file contains the input data for a batch. + - in: formData + name: file + description: Gets or sets the file to upload into Azure OpenAI. + required: true + type: file + responses: + "201": + description: The file has been successfully created. + schema: + $ref: "#/definitions/File" + headers: + Location: + description: The location of the newly created item. + type: string + format: url + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Upload a file.: + $ref: ./examples/upload_file.yaml + /files/import: + post: + tags: + - "Files:" + summary: Creates a new file entity by importing data from a provided url. Uploaded files can, for example, be used for training or evaluating fine-tuned models. + operationId: Files_Import + consumes: + - application/json + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: body + name: fileImport + description: The definition of the file to create including its purpose, the file name and the url of the file location. + required: true + schema: + $ref: "#/definitions/FileImport" + responses: + "201": + description: The file has been successfully created. + schema: + $ref: "#/definitions/File" + headers: + Location: + description: The location of the newly created item. + type: string + format: url + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Importing a file with a blob url as source.: + $ref: ./examples/import_file.yaml + /files/{file-id}: + get: + tags: + - "Files:" + summary: Gets details for a single file specified by the given file-id including status, size, purpose, etc. + operationId: Files_Get + produces: + - application/json + parameters: + - in: path + name: file-id + description: The identifier of the file. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/File" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting a file.: + $ref: ./examples/get_file.yaml + delete: + tags: + - "Files:" + summary: "Deletes the file with the given file-id.\r\nDeletion is also allowed if a file was used, e.g., as training file in a fine-tune job." + operationId: Files_Delete + produces: + - application/json + parameters: + - in: path + name: file-id + description: The identifier of the file. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "204": + description: The file was successfully deleted. + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Deleting a file.: + $ref: ./examples/delete_file.yaml + /files/{file-id}/content: + get: + tags: + - "Files:" + summary: "Gets the content of the file specified by the given file-id.\r\nFiles can be user uploaded content or generated by the service like result metrics of a fine-tune job." + operationId: Files_GetContent + produces: + - application/octet-stream + - application/json + parameters: + - in: path + name: file-id + description: The identifier of the file. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + type: file + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting the file content.: + $ref: ./examples/get_file_content.yaml + /fine_tuning/jobs: + get: + tags: + - "Fine-tuning:" + summary: "Gets a list of all fine-tune jobs owned by the Azure OpenAI resource.\r\nThe details that are returned for each fine-tune job contain besides its identifier\r\nthe base model, training and validation files, hyper parameters, time stamps, status and events.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded." + operationId: FineTuning_List + produces: + - application/json + parameters: + - in: query + name: after + description: Identifier for the last event from the previous pagination request. + type: string + - in: query + name: limit + description: Number of events to retrieve. Defaults to 20. + type: integer + format: int32 + default: 20 + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/FineTuningJobList" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting all fine tuning jobs owned by this account.: + $ref: ./examples/get_finetuning_jobs.yaml + post: + tags: + - "Fine-tuning:" + summary: "Creates a job that fine-tunes a specified model from a given training file.\r\nResponse includes details of the enqueued job including job status and hyper parameters.\r\nThe name of the fine-tuned model is added to the response once complete." + operationId: FineTuning_Create + consumes: + - application/json + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: body + name: fineTuningJob + description: "The specification of the fine-tuned model to create.\r\nRequired parameters are the base model and the training file to use.\r\nOptionally a validation file can be specified to compute validation metrics during training.\r\nHyper parameters will be set to default values or can be optionally specified.\r\nThese include batch size, learning rate multiplier, number of epochs and others." + required: true + schema: + $ref: "#/definitions/FineTuningJobCreation" + responses: + "201": + description: The fine tune has been successfully created. + schema: + $ref: "#/definitions/FineTuningJob" + headers: + Location: + description: The location of the newly created item. + type: string + format: url + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Creating a fine tuning job.: + $ref: ./examples/post_finetuning_job.yaml + /fine_tuning/jobs/{fine-tuning-job-id}: + get: + tags: + - "Fine-tuning:" + summary: "Gets details for a single fine-tune job specified by the given fine-tune-id.\r\nThe details contain the base model, training and validation files, hyper parameters, time stamps, status and events.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded." + operationId: FineTuning_Get + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-id + description: The identifier of the fine-tune job. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/FineTuningJob" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting a fine tuning job.: + $ref: ./examples/get_finetuning_job.yaml + delete: + tags: + - "Fine-tuning:" + summary: Deletes the fine-tune job specified by the given fine-tune-id. + operationId: FineTuning_Delete + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-id + description: The identifier of the fine-tune job. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "204": + description: The fine tune was successfully deleted. + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Deleting a fine tuning job.: + $ref: ./examples/delete_finetuning_job.yaml + /fine_tuning/jobs/{fine-tuning-job-id}/cancel: + post: + tags: + - "Fine-tuning:" + summary: Cancels the processing of the fine-tune job specified by the given fine-tune-id. + operationId: FineTuning_Cancel + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-id + description: The identifier of the fine-tune job. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: The fine tune has been successfully canceled + schema: + $ref: "#/definitions/FineTuningJob" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Canceling a fine tuning job.: + $ref: ./examples/cancel_finetuning_job.yaml + /fine_tuning/jobs/{fine-tuning-job-id}/checkpoints: + get: + tags: + - "Fine-tuning:" + summary: "Gets the checkpoints for the fine-tune job specified by the given fine-tune-id.\r\nCheckpoints are created at the end of successful epochs during training." + operationId: FineTuning_GetCheckpoints + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-id + description: The identifier of the fine-tune job. + required: true + type: string + - in: query + name: after + description: Identifier for the last checkpoint ID from the previous pagination request. + type: string + - in: query + name: limit + description: Number of checkpoints to retrieve. Defaults to 10. + type: integer + format: int32 + default: 10 + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/FineTuningJobCheckpointList" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting checkpoints of a fine tuning job.: + $ref: ./examples/get_finetuning_job_checkpoints.yaml + /fine_tuning/jobs/{fine-tuning-job-id}/events: + get: + tags: + - "Fine-tuning:" + summary: "Gets the events for the fine-tune job specified by the given fine-tune-id.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded." + operationId: FineTuning_GetEvents + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-id + description: The identifier of the fine-tune job. + required: true + type: string + - in: query + name: after + description: Identifier for the last event from the previous pagination request. + type: string + - in: query + name: limit + description: Number of events to retrieve. Defaults to 20. + type: integer + format: int32 + default: 20 + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/FineTuningJobEventList" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting events of a fine tuning job.: + $ref: ./examples/get_finetuning_job_events.yaml + /ingestion/jobs: + get: + tags: + - "Ingestion:" + summary: Lists the ingestion jobs. + operationId: IngestionJobs_List + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: header + name: mgmt-user-token + type: string + description: The token used to access the workspace (needed only for user compute jobs). + responses: + "200": + description: Success + schema: + $ref: "#/definitions/IngestionJobList" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + List all ingestion jobs: + $ref: ./examples/list_ingestion_jobs.json + /ingestion/jobs/{job-id}: + put: + tags: + - "Ingestion:" + summary: Creates an ingestion job with the specified job id. + operationId: IngestionJobs_Create + consumes: + - application/json + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: path + name: job-id + required: true + type: string + description: The id of the job that will be created. + - in: header + name: mgmt-user-token + type: string + description: The token used to access the workspace (needed only for user compute jobs). + - in: header + name: aml-user-token + type: string + description: The token used to access the resources within the job in the workspace (needed only for user compute jobs). + - in: body + name: ingestionJob + schema: + $ref: "#/definitions/IngestionJob" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/IngestionJob" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Create a system-compute ingestion job: + $ref: ./examples/put_ingestion_job_sc.json + Create a user-compute ingestion job: + $ref: ./examples/put_ingestion_job_uc.json + get: + tags: + - "Ingestion:" + summary: Gets the details of the specified job id. + operationId: IngestionJobs_Get + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: path + name: job-id + required: true + description: The id of the job. + type: string + responses: + "200": + description: Success + schema: + $ref: "#/definitions/IngestionJob" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Get ingestion job: + $ref: ./examples/get_ingestion_job.json + /ingestion/jobs/{job-id}/runs: + get: + tags: + - "Ingestion:" + summary: Lists the runs of the specified job id. + operationId: IngestionJobRuns_List + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: path + name: job-id + required: true + description: The id of the job. + type: string + - in: header + name: mgmt-user-token + type: string + description: The token used to access the workspace (needed only for user compute jobs). + responses: + "200": + description: Success + schema: + $ref: "#/definitions/IngestionJobRunList" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + List ingestion job runs: + $ref: ./examples/list_ingestion_job_runs.json + /ingestion/jobs/{job-id}/runs/{run-id}: + get: + tags: + - "Ingestion:" + summary: Gets the details of the specified run id as part of the specified job id. + operationId: IngestionJobRuns_Get + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: path + name: job-id + required: true + description: The id of the job. + type: string + - in: path + name: run-id + required: true + description: The id of the run. + type: string + - in: header + name: mgmt-user-token + type: string + description: The token used to access the workspace (needed only for user compute jobs). + responses: + "200": + description: Success + schema: + $ref: "#/definitions/IngestionJobRun" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Get ingestion job runs: + $ref: ./examples/get_ingestion_job_run.json + /models: + get: + tags: + - "Models:" + summary: "Gets a list of all models that are accessible by the Azure OpenAI resource.\r\nThese include base models as well as all successfully completed fine-tuned models owned by the Azure OpenAI resource." + operationId: Models_List + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/ModelList" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting all models owned by account.: + $ref: ./examples/get_models.yaml + /models/{model-id}: + get: + tags: + - "Models:" + summary: Gets details for the model specified by the given modelId. + operationId: Models_Get + produces: + - application/json + parameters: + - in: path + name: model-id + description: The identifier of the model. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/Model" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting a base model.: + $ref: ./examples/get_model_base.yaml + Getting a fine-tuned model.: + $ref: ./examples/get_model_finetune.yaml + /uploads: + post: + tags: + - "UploadFile:" + summary: "An intermediate Upload object is created, allowing you to add Parts to it. Currently, an Upload size can be a maximum of 9 GB in total and will expire two hours after being created.\r\nAfter the Upload is completed a File object will be generated, containing all the uploaded parts. This File object can then be used across our platform just like any other file." + operationId: UploadFile_Start + consumes: + - application/json + - text/json + - application/*+json + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: body + name: requestBody + description: The definition of the file to create including its purpose and the location on the local machine. + required: true + schema: + $ref: "#/definitions/UploadFileStartBody" + responses: + "200": + description: The upload has been successfully created. + schema: + $ref: "#/definitions/UploadResource" + headers: + Location: + description: The location of the newly created item. + type: string + format: url + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Start a large file upload operation.: + $ref: ./examples/upload_file_start.yaml + /uploads/{upload-id}/cancel: + post: + tags: + - "UploadFile:" + summary: "Cancels the Upload, and will lead to all uploaded parts to be deleted asynchronously.\r\nNo Parts may be added after an Upload is cancelled." + operationId: UploadFile_Cancel + produces: + - application/json + parameters: + - in: path + name: upload-id + description: The identifier of the upload. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/UploadResource" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Cancel a large file upload operation.: + $ref: ./examples/upload_file_cancel.yaml + /uploads/{upload-id}/complete: + post: + tags: + - "UploadFile:" + summary: "This completes the Upload, and the returned Upload object contains a nested File object that is ready for use across the platform.\r\nYou can define the order of the Parts by providing an ordered list of Part IDs.\r\nThe total number of bytes uploaded must match the size originally specified when creating the Upload object.\r\nAfter this operation no additional Parts can be added once the Upload is completed." + operationId: UploadFile_Complete + consumes: + - application/json + - text/json + - application/*+json + produces: + - application/json + parameters: + - in: path + name: upload-id + description: The identifier of the upload. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + - in: body + name: requestBody + description: The definition of the file to create including its purpose and the location on the local machine. + required: true + schema: + $ref: "#/definitions/UploadFileCompleteBody" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/UploadResource" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Complete and validate a large file upload operation.: + $ref: ./examples/upload_file_complete.yaml + /uploads/{upload-id}/parts: + post: + tags: + - "UploadFile:" + summary: "Adds a Part to an Upload object, where each Part represents a segment of the file you are uploading.\r\nEach Part can be up to the standard size limit for file upload, based on the File Purpose. You can continue adding Parts until reaching the Upload size limit of 9 GB." + operationId: UploadFile_Part + consumes: + - multipart/form-data + produces: + - application/json + parameters: + - in: path + name: upload-id + description: The identifier of the upload. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + - in: formData + name: data + required: true + type: file + responses: + "200": + description: Success + schema: + $ref: "#/definitions/UploadPartResource" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Upload a part of large file upload operation.: + $ref: ./examples/upload_file_part.yaml +definitions: + AzureAISearchIndex: + description: Azure AI Search Index. + required: + - connectionId + allOf: + - $ref: "#/definitions/TargetIndex" + - type: object + properties: + connectionId: + type: string + description: The id of the connection pointing to the Azure AI Search Index. + x-ms-discriminator-value: AzureAISearch + BaseConnection: + title: BaseConnection + description: A connection to a resource. + type: object + required: + - kind + properties: + kind: + $ref: "#/definitions/ConnectionType" + discriminator: kind + Batch: + title: Batch + description: Defines the values of a batch. + required: + - id + - input_file_id + type: object + properties: + id: + description: The identity of this item. + type: string + object: + $ref: "#/definitions/TypeDiscriminator" + endpoint: + description: The API endpoint used by the batch. + type: string + readOnly: true + errors: + $ref: "#/definitions/BatchErrors" + input_file_id: + description: The ID of the input file for the batch. + minLength: 1 + type: string + completion_window: + description: The time frame within which the batch should be processed. + type: string + status: + $ref: "#/definitions/BatchStatus" + output_file_id: + description: The ID of the file containing outputs of successfully executed requests. + type: string + error_file_id: + description: The ID of the file containing outputs of requests with errors. + type: string + created_at: + format: unixtime + description: A timestamp when this batch was created (in unix epochs). + type: integer + readOnly: true + in_progress_at: + format: unixtime + description: A timestamp when this batch started progressing (in unix epochs). + type: integer + readOnly: true + expires_at: + format: unixtime + description: A timestamp when this batch will expire (in unix epochs). + type: integer + readOnly: true + finalizing_at: + format: unixtime + description: A timestamp when this batch started finalizing (in unix epochs). + type: integer + readOnly: true + completed_at: + format: unixtime + description: A timestamp when this batch was completed (in unix epochs). + type: integer + readOnly: true + failed_at: + format: unixtime + description: A timestamp when this batch failed (in unix epochs). + type: integer + readOnly: true + expired_at: + format: unixtime + description: A timestamp when this batch expired (in unix epochs). + type: integer + readOnly: true + cancelling_at: + format: unixtime + description: A timestamp when this batch started cancelling (in unix epochs). + type: integer + readOnly: true + cancelled_at: + format: unixtime + description: A timestamp when this batch was cancelled (in unix epochs). + type: integer + readOnly: true + request_counts: + $ref: "#/definitions/BatchRequestCounts" + metadata: + description: A set of key-value pairs that can be attached to the batch. This can be useful for storing additional infomration about the batch in a structured format. + type: object + additionalProperties: + type: string + BatchCreateRequest: + title: BatchCreateRequest + description: Defines the request to create a batch. + required: + - input_file_id + - endpoint + - completion_window + type: object + properties: + input_file_id: + description: The ID if the input file for the batch. + minLength: 1 + type: string + endpoint: + description: The API endpoint used by the batch. + type: string + completion_window: + description: The time frame within which the batch should be processed. + type: string + metadata: + description: A set of key-value pairs that can be attached to the batch. This can be useful for storing additional infomration about the batch in a structured format. + type: object + additionalProperties: + type: string + BatchErrorData: + title: BatchErrorData + description: Error information for a failure in batch. + type: object + properties: + code: + description: An error code identifying the error type. + type: string + message: + description: A human-readable message providing more details about the error. + type: string + param: + description: The name of the parameter that caused the error, if applicable (can be null). + type: string + line: + description: The line number of the input file where the error occurred, if applicable (can be null). + type: string + BatchErrors: + title: BatchErrors + description: For batches that have failed, this will contain more information on the cause of the failures. + type: object + properties: + object: + description: The type of the errors object. This is always 'list'. + type: string + data: + $ref: "#/definitions/BatchErrorData" + BatchRequestCounts: + title: BatchRequestCounts + description: The request counts for different statuses within the batch. + type: object + properties: + total: + description: The total number of requests in the batch. + type: integer + completed: + description: The number of requests in the batch that have been completed successfully. + type: integer + failed: + description: The number of requests in the batch that have failed. + type: integer + BatchStatus: + title: BatchStatus + description: The status of a batch. + enum: + - validating + - failed + - in_progress + - finalizing + - completed + - expired + - cancelling + - cancelled + type: string + readOnly: true + x-ms-enum: + name: BatchStatus + modelAsString: true + values: + - value: validating + description: The input file is being validated before the batch can begin. + - value: failed + description: The input file has failed the validation process. + - value: in_progress + description: The input file was successfully validated and the batch is currently being executed. + - value: finalizing + description: The batch has completed and the results are being prepared. + - value: completed + description: The batch has been completed and the results are ready. + - value: expired + description: The batch was not able to complete within the 24-hour time window. + - value: cancelling + description: Cancellation of the batch has been initiated. + - value: cancelled + description: The batch was cancelled. + BatchesList: + title: BatchList + description: Represents a list of batches. + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + data: + description: The list of items. + type: array + items: + $ref: "#/definitions/Batch" + first_id: + description: The id of the first batch in the list of batches returned. + type: string + last_id: + description: The id of the last batch in the list of batches returned. + type: string + has_more: + description: A value indicating whether the list contains more elements than returned. + type: boolean + Capabilities: + title: Capabilities + description: The capabilities of a base or fine tune model. + required: + - chat_completion + - completion + - embeddings + - fine_tune + - inference + type: object + properties: + fine_tune: + description: A value indicating whether a model can be used for fine tuning. + type: boolean + inference: + description: A value indicating whether a model can be deployed. + type: boolean + completion: + description: A value indicating whether a model supports completion. + type: boolean + chat_completion: + description: A value indicating whether a model supports chat completion. + type: boolean + embeddings: + description: A value indicating whether a model supports embeddings. + type: boolean + ChunkingSettings: + type: object + title: ChunkingSettings + description: Chunking settings + properties: + maxChunkSizeInTokens: + type: integer + CompletionAction: + type: string + description: The completion action. + enum: + - cleanUpTempAssets + - keepAllAssets + x-ms-enum: + name: IngestionJobCompletionAction + modelAsString: true + values: + - name: keepAllAssets + value: keepAllAssets + description: Will not clean up any of the intermediate assets created during the ingestion process. + - name: cleanUpTempAssets + value: cleanUpTempAssets + description: Will clean up intermediate assets created during the ingestion process. + ComputeType: + type: string + description: The compute type. + enum: + - ServerlessCompute + - CustomCompute + x-ms-enum: + name: ComputeType + modelAsString: true + values: + - name: ServerlessCompute + value: ServerlessCompute + description: Serverless user compute. + - name: CustomCompute + value: CustomCompute + description: Custom user compute. + ConnectionStringConnection: + description: Connection string connection. + required: + - connectionString + allOf: + - $ref: "#/definitions/BaseConnection" + - type: object + properties: + connectionString: + type: string + description: Connection string + x-ms-discriminator-value: ConnectionString + ConnectionType: + type: string + description: The connection type. + enum: + - EndpointWithKey + - ConnectionString + - EndpointWithManagedIdentity + - WorkspaceConnection + - RelativeConnection + x-ms-enum: + name: ConnectionType + modelAsString: true + values: + - name: EndpointWithKey + value: EndpointWithKey + description: Endpoint and key connection. + - name: ConnectionString + value: ConnectionString + description: Connection string. + - name: EndpointWithManagedIdentity + value: EndpointWithManagedIdentity + description: Endpoint and managed identity. + - name: WorkspaceConnection + value: WorkspaceConnection + description: AML Workspace connection. + - name: RelativeConnection + value: RelativeConnection + description: Relative deployment + CosmosDBIndex: + description: CosmosDB Index. + required: + - connectionId + allOf: + - $ref: "#/definitions/TargetIndex" + - type: object + properties: + connectionId: + type: string + description: The id of the connection pointing to the cosmos DB. + collectionName: + type: string + description: The name of the cosmos DB collection. + databaseName: + type: string + description: The name of the cosmos DB database. + x-ms-discriminator-value: CosmosDB + CrawlingSettings: + type: object + title: CrawlingSettings + description: Crawling settings + properties: + maxCrawlDepth: + type: integer + maxCrawlTimeInMins: + type: integer + maxDownloadTimeInMins: + type: integer + maxFileSize: + type: integer + maxRedirects: + type: integer + maxFiles: + type: integer + CustomCompute: + description: Custom compute. + required: + - computeId + allOf: + - $ref: "#/definitions/JobCompute" + - type: object + properties: + computeId: + type: string + description: Id of the custom compute + x-ms-discriminator-value: CustomCompute + DeploymentConnection: + description: Relative deployment connection. + allOf: + - $ref: "#/definitions/BaseConnection" + x-ms-discriminator-value: RelativeConnection + Deprecation: + title: Deprecation + description: "Defines the dates of deprecation for the different use cases of a model.\r\nUsually base models support 1 year of fine tuning after creation. Inference is typically supported 2 years after creation of base or\r\nfine tuned models. The exact dates are specified in the properties." + required: + - inference + type: object + properties: + fine_tune: + format: unixtime + description: The end date of fine tune support of this model. Will be `null` for fine tune models. + type: integer + inference: + format: unixtime + description: The end date of inference support of this model. + type: integer + EndpointKeyConnection: + description: Endpoint key connection. + required: + - endpoint + - key + allOf: + - $ref: "#/definitions/BaseConnection" + - type: object + properties: + endpoint: + type: string + description: Endpoint + key: + type: string + description: Key + x-ms-discriminator-value: EndpointWithKey + EndpointMIConnection: + description: Endpoint Managed Identity connection. + required: + - endpoint + allOf: + - $ref: "#/definitions/BaseConnection" + - type: object + properties: + endpoint: + type: string + description: Endpoint + resourceId: + type: string + description: Resource Id + x-ms-discriminator-value: EndpointWithManagedIdentity + Error: + title: Error + description: "Error content as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." + required: + - code + - message + type: object + properties: + code: + $ref: "#/definitions/ErrorCode" + message: + description: The message of this error. + minLength: 1 + type: string + target: + description: The location where the error happened if available. + type: string + details: + description: The error details if available. + type: array + items: + $ref: "#/definitions/Error" + innererror: + $ref: "#/definitions/InnerError" + ErrorCode: + title: ErrorCode + description: "Error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." + enum: + - conflict + - invalidPayload + - forbidden + - notFound + - unexpectedEntityState + - itemDoesAlreadyExist + - serviceUnavailable + - internalFailure + - quotaExceeded + - jsonlValidationFailed + - fileImportFailed + - tooManyRequests + - unauthorized + - contentFilter + type: string + x-ms-enum: + name: ErrorCode + modelAsString: true + values: + - value: conflict + description: The requested operation conflicts with the current resource state. + - value: invalidPayload + description: The request data is invalid for this operation. + - value: forbidden + description: The operation is forbidden for the current user/api key. + - value: notFound + description: The resource is not found. + - value: unexpectedEntityState + description: The operation cannot be executed in the current resource's state. + - value: itemDoesAlreadyExist + description: The item does already exist. + - value: serviceUnavailable + description: The service is currently not available. + - value: internalFailure + description: Internal error. Please retry. + - value: quotaExceeded + description: Quota exceeded. + - value: jsonlValidationFailed + description: Validation of jsonl data failed. + - value: fileImportFailed + description: Import of file failed. + - value: tooManyRequests + description: Too many requests. Please retry later. + - value: unauthorized + description: The current user/api key is not authorized for the operation. + - value: contentFilter + description: Image generation failed as a result of our safety system. + ErrorResponse: + title: ErrorResponse + description: "Error response as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." + required: + - error + type: object + properties: + error: + $ref: "#/definitions/Error" + EventType: + title: EventType + description: Defines the severity of a content filter result. + enum: + - message + - metrics + type: string + x-ms-enum: + name: EventType + modelAsString: true + values: + - value: message + description: Event only contains human readable messages. + - value: metrics + description: Event contains metrics. + File: + title: File + description: A file is a document usable for training and validation. It can also be a service generated document with result details. + required: + - filename + - purpose + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + created_at: + format: unixtime + description: A timestamp when this job or item was created (in unix epochs). + type: integer + readOnly: true + id: + description: The identity of this item. + type: string + readOnly: true + bytes: + format: int64 + description: "The size of this file when available (can be null). File sizes larger than 2^53-1 are not supported to ensure compatibility\r\nwith JavaScript integers." + type: integer + readOnly: true + purpose: + $ref: "#/definitions/Purpose" + filename: + description: The name of the file. + minLength: 1 + type: string + readOnly: true + FileCreate: + title: FileCreate + description: Defines a document to import from an external content url to be usable with Azure OpenAI. + required: + - content_url + - purpose + type: object + properties: + purpose: + $ref: "#/definitions/Purpose" + content_url: + format: url + description: The url to download the document from (can be SAS url of a blob or any other external url accessible with a GET request). + type: string + FileDetails: + title: FileDetails + description: A file detail is a document used by batch service to fetch file blob details. + required: + - filename + - purpose + type: object + properties: + id: + description: The identity of this item. + type: string + readOnly: true + filename: + description: The name of the file. + minLength: 1 + type: string + path: + description: The the relative path to the file within the container. + type: string + readOnly: true + storage_account_uri: + format: url + description: The storage account url of this file. + type: string + readOnly: true + storage_container_name: + description: The Storage Container Name of this file blob. + type: string + readOnly: true + purpose: + $ref: "#/definitions/Purpose" + FileImport: + title: FileImport + description: Defines a document to import from an external content url to be usable with Azure OpenAI. + required: + - content_url + - filename + - purpose + type: object + properties: + purpose: + $ref: "#/definitions/Purpose" + filename: + description: "The name of the [JSON Lines](https://jsonlines.readthedocs.io/en/latest/) file to be uploaded.\r\nIf the `purpose` is set to \"fine-tune\", each line is a JSON record with \"prompt\" and \"completion\" fields representing your training examples." + minLength: 1 + type: string + content_url: + format: url + description: The url to download the document from (can be SAS url of a blob or any other external url accessible with a GET request). + type: string + FileList: + title: FileList + description: Represents a list of files. + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + data: + description: The list of items. + type: array + items: + $ref: "#/definitions/File" + FineTuningHyperParameters: + title: FineTuningHyperParameters + description: The hyper parameter settings used in a fine tune job. + type: object + properties: + n_epochs: + format: int32 + description: The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset. + type: integer + batch_size: + format: int32 + description: "The batch size to use for training. The batch size is the number of training examples used to train a single forward and backward pass.\r\nIn general, we've found that larger batch sizes tend to work better for larger datasets.\r\nThe default value as well as the maximum value for this property are specific to a base model." + type: integer + learning_rate_multiplier: + format: double + description: "The learning rate multiplier to use for training. The fine-tuning learning rate is the original learning rate used for pre-training multiplied by this value.\r\nLarger learning rates tend to perform better with larger batch sizes.\r\nWe recommend experimenting with values in the range 0.02 to 0.2 to see what produces the best results." + type: number + FineTuningJob: + title: FineTuningJob + description: Defines the values of a fine tune job. + required: + - model + - training_file + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + created_at: + format: unixtime + description: A timestamp when this job or item was created (in unix epochs). + type: integer + readOnly: true + id: + description: The identity of this item. + type: string + readOnly: true + status: + $ref: "#/definitions/FineTuningState" + model: + description: The identifier (model-id) of the base model used for the fine-tune. + minLength: 1 + type: string + fine_tuned_model: + description: "The identifier (model-id) of the resulting fine tuned model. This property is only populated for successfully completed fine-tune runs.\r\nUse this identifier to create a deployment for inferencing." + type: string + training_file: + description: The file which is used for training. + minLength: 1 + type: string + validation_file: + description: The file which is used to evaluate the fine tuned model during training. + type: string + result_files: + description: "The result file identities (file-id) containing training and evaluation metrics in csv format.\r\nThe file is only available for successfully completed fine-tune runs." + type: array + items: + type: string + finished_at: + format: int32 + description: A timestamp when this job or item has finished successfully (in unix epochs). + type: integer + organisation_id: + description: The organisation id of this fine tune job. Unused on Azure OpenAI; compatibility for OpenAI only. + type: string + trained_tokens: + format: int32 + description: The total number of billable tokens processed by this fine tuning job. + type: integer + readOnly: true + error: + $ref: "#/definitions/FineTuningJobError" + estimated_finish: + format: int32 + description: The Unix timestamp (in seconds) for when the fine-tuning job is estimated to finish. The value will be null if the fine-tuning job is not running. + type: integer + hyperparameters: + $ref: "#/definitions/FineTuningHyperParameters" + suffix: + description: The suffix used to identify the fine-tuned model. The suffix can contain up to 40 characters (a-z, A-Z, 0-9,- and _) that will be added to your fine-tuned model name. + type: string + seed: + format: int32 + description: The seed used for the finetuning job. + type: integer + integrations: + type: array + items: + $ref: "#/definitions/WandBIntegrationRequestWrapper" + description: "A list configurations for integrations supporting the fine-tuning job.\r\nThere are many integrations planned, so make sure to check and act on the integration type." + FineTuningJobCheckpoint: + title: FineTuningJobCheckpoint + required: + - created_at + - fine_tuned_model_checkpoint + - fine_tuning_job_id + - metrics + - step_number + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + id: + description: The identity of this checkpoint. + type: string + readOnly: true + created_at: + format: unixtime + description: The Unix timestamp (in seconds) for when the checkpoint was created. + type: integer + fine_tuned_model_checkpoint: + description: The name of the fine-tuned checkpoint model that is created. + minLength: 1 + type: string + step_number: + format: int32 + description: The step number that the checkpoint was created at. + type: integer + metrics: + title: Dictionary`2 + description: The metrics at the step number during the fine-tuning job. + type: object + additionalProperties: + format: double + type: number + fine_tuning_job_id: + description: The name of the fine-tuning job that this checkpoint was created from.. + minLength: 1 + type: string + FineTuningJobCheckpointList: + title: FineTuningJobCheckpointList + description: Represents a list of checkpoints. + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + data: + description: The list of items. + type: array + items: + $ref: "#/definitions/FineTuningJobCheckpoint" + has_more: + description: A value indicating whether the list contains more elements than returned. + type: boolean + FineTuningJobCreation: + title: FineTuningJobCreation + description: Defines the values of a fine tune job. + required: + - model + - training_file + type: object + properties: + model: + description: The identifier (model-id) of the base model used for this fine-tune. + minLength: 1 + type: string + training_file: + description: The file identity (file-id) that is used for training this fine tuned model. + minLength: 1 + type: string + validation_file: + description: The file identity (file-id) that is used to evaluate the fine tuned model during training. + type: string + hyperparameters: + $ref: "#/definitions/FineTuningHyperParameters" + suffix: + description: The suffix used to identify the fine-tuned model. The suffix can contain up to 40 characters (a-z, A-Z, 0-9,- and _) that will be added to your fine-tuned model name. + type: string + seed: + format: int32 + description: The seed used for the finetuning job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases. If a seed is not specified, one will be generated for you. + type: integer + integrations: + type: array + items: + $ref: "#/definitions/WandBIntegrationRequestWrapper" + description: "A list configurations for integrations supporting the fine-tuning job.\r\nThere are many integrations planned, so make sure to check and act on the integration type." + FineTuningJobError: + title: FineTuningJobError + description: For fine-tuning jobs that have failed, this will contain more information on the cause of the failure. + type: object + properties: + code: + description: The machine-readable error code.. + type: string + message: + description: The human-readable error message. + type: string + param: + description: The parameter that was invalid, usually training_file or validation_file. This field will be null if the failure was not parameter-specific. + type: string + FineTuningJobEvent: + title: FineTuningJobEvent + required: + - created_at + - level + - message + - type + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + id: + description: The identity of this event. + type: string + readOnly: true + created_at: + format: unixtime + description: A timestamp when this event was created (in unix epochs). + type: integer + level: + $ref: "#/definitions/LogLevel" + message: + description: The message describing the event. This can be a change of state, e.g., enqueued, started, failed or completed, or other events like uploaded results. + minLength: 1 + type: string + type: + $ref: "#/definitions/EventType" + data: + description: Machine readable data of this event. + FineTuningJobEventList: + title: FineTuningJobEventList + description: Represents a list of events. + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + data: + description: The list of items. + type: array + items: + $ref: "#/definitions/FineTuningJobEvent" + has_more: + description: A value indicating whether the list contains more elements than returned. + type: boolean + FineTuningJobList: + title: FineTuningJobList + description: Represents a list of fine tunes. + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + data: + description: The list of items. + type: array + items: + $ref: "#/definitions/FineTuningJob" + has_more: + description: A value indicating whether the list contains more elements than returned. + type: boolean + FineTuningState: + title: FineTuningState + description: The state of a finetunes object or fine tuning job. + enum: + - created + - pending + - running + - succeeded + - cancelled + - failed + type: string + readOnly: true + x-ms-enum: + name: FineTuningState + modelAsString: true + values: + - value: created + description: The operation was created. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state. + - value: pending + description: The operation is not yet queued to be processed in the future. It can be categorized as an inactive state. + - value: running + description: The operation has started to be processed. It can be categorized as an active state. + - value: succeeded + description: The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state. + - value: cancelled + description: The operation has been cancelled and is incomplete. It can be categorized as a terminal state. + - value: failed + description: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. + GenericEmbeddingSettings: + title: ConnectionEmbeddingSettings + description: Connection Embedding Settings + type: object + properties: + connection: + $ref: "#/definitions/BaseConnection" + deploymentName: + type: string + modelName: + type: string + IngestionError: + title: IngestionError + description: The details of the ingestion error + type: object + properties: + message: + type: string + innerErrors: + type: array + items: + type: string + IngestionJob: + title: IngestionJob + description: Represents the details of a job. + type: object + required: + - kind + discriminator: kind + properties: + kind: + $ref: "#/definitions/IngestionJobType" + jobId: + type: string + IngestionJobList: + title: IngestionJobList + description: Represents a list of ingestion jobs. + type: object + properties: + nextLink: + description: The link to the next page. + type: string + value: + description: The list of items. + type: array + items: + $ref: "#/definitions/IngestionJob" + IngestionJobProgress: + title: IngestionJobProgress + type: object + required: + - stageProgress + properties: + stageProgress: + type: array + items: + $ref: "#/definitions/IngestionJobStageProgress" + IngestionJobRun: + title: IngestionJobRun + description: The details of a job run + type: object + properties: + jobId: + type: string + runId: + type: string + status: + $ref: "#/definitions/OperationState" + error: + $ref: "#/definitions/IngestionError" + warnings: + type: array + items: + type: string + progress: + $ref: "#/definitions/IngestionJobProgress" + IngestionJobRunList: + title: IngestionJobRunList + description: Represents a list of ingestion job runs. + type: object + properties: + nextLink: + description: The link to the next page. + type: string + value: + description: The list of items. + type: array + items: + $ref: "#/definitions/IngestionJobRun" + IngestionJobStageProgress: + title: IngestionJobStageProgress + type: object + properties: + name: + type: string + totalItems: + type: integer + format: int32 + processedItems: + type: integer + format: int32 + state: + $ref: "#/definitions/OperationState" + subStageProgress: + type: array + items: + $ref: "#/definitions/IngestionJobStageProgress" + IngestionJobSystemCompute: + type: object + allOf: + - $ref: "#/definitions/IngestionJob" + - type: object + properties: + searchServiceConnection: + $ref: "#/definitions/BaseConnection" + datasource: + $ref: "#/definitions/SystemComputeDatasource" + completionAction: + $ref: "#/definitions/CompletionAction" + dataRefreshIntervalInHours: + type: integer + x-ms-discriminator-value: SystemCompute + IngestionJobType: + title: IngestionJobType + type: string + description: The job type. + enum: + - SystemCompute + - UserCompute + x-ms-enum: + name: IngestionJobType + modelAsString: true + values: + - name: SystemCompute + value: SystemCompute + description: Jobs that run on service owned resources. + - name: UserCompute + value: UserCompute + description: Jobs that run on user owned workspace. + IngestionJobUserCompute: + type: object + required: + - workspaceId + allOf: + - $ref: "#/definitions/IngestionJob" + - type: object + properties: + workspaceId: + type: string + compute: + $ref: "#/definitions/JobCompute" + target: + $ref: "#/definitions/TargetIndex" + datasource: + $ref: "#/definitions/UserComputeDatasource" + dataRefreshIntervalInHours: + type: integer + x-ms-discriminator-value: UserCompute + InnerError: + title: InnerError + description: "Inner error as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." + type: object + properties: + code: + $ref: "#/definitions/InnerErrorCode" + innererror: + $ref: "#/definitions/InnerError" + InnerErrorCode: + title: InnerErrorCode + description: "Inner error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." + enum: + - invalidPayload + type: string + x-ms-enum: + name: InnerErrorCode + modelAsString: true + values: + - value: invalidPayload + description: The request data is invalid for this operation. + IntegrationTypes: + title: IntegrationTypes + enum: + - wandb + type: string + description: List of Fine Tune integrations available. + JobCompute: + title: JobCompute + description: The compute settings of the job. + type: object + discriminator: kind + required: + - kind + properties: + kind: + $ref: "#/definitions/ComputeType" + LifeCycleStatus: + title: LifeCycleStatus + description: "The life cycle status of a model.\r\nNote: A model can be promoted from \"preview\" to \"generally-available\", but never from \"generally-available\" to \"preview\"." + enum: + - preview + - generally-available + type: string + x-ms-enum: + name: LifeCycleStatus + modelAsString: true + values: + - value: preview + description: Model is in preview and covered by the service preview terms. + - value: generally-available + description: Model is generally available. + LogLevel: + title: LogLevel + description: The verbosity level of an event. + enum: + - info + - warning + - error + type: string + x-ms-enum: + name: LogLevel + modelAsString: true + values: + - value: info + description: This event is for information only. + - value: warning + description: This event represents a mitigated issue. + - value: error + description: This message represents a non recoverable issue. + Model: + title: Model + description: A model is either a base model or the result of a successful fine tune job. + required: + - capabilities + - deprecation + - lifecycle_status + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + created_at: + format: unixtime + description: A timestamp when this job or item was created (in unix epochs). + type: integer + readOnly: true + id: + description: The identity of this item. + type: string + readOnly: true + status: + $ref: "#/definitions/FineTuningState" + model: + description: The base model identity (model-id) if this is a fine tune model; otherwise `null`. + type: string + fine_tune: + description: The fine tune job identity (fine-tune-id) if this is a fine tune model; otherwise `null`. + type: string + capabilities: + $ref: "#/definitions/Capabilities" + lifecycle_status: + $ref: "#/definitions/LifeCycleStatus" + deprecation: + $ref: "#/definitions/Deprecation" + ModelList: + title: ModelList + description: Represents a list of models. + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + data: + description: The list of items. + type: array + items: + $ref: "#/definitions/Model" + OperationState: + title: OperationState + description: The state of a job or item. + enum: + - notRunning + - running + - succeeded + - failed + type: string + readOnly: true + x-ms-enum: + name: OperationState + modelAsString: true + values: + - value: notRunning + description: The operation is not yet queued to be processed in the future. + - value: running + description: The operation has started to be processed. + - value: succeeded + description: The operation has successfully be processed and is ready for consumption. + - value: failed + description: The operation has completed processing with a failure and cannot be further consumed. + PineconeIndex: + description: Pinecone Index. + required: + - connectionId + allOf: + - $ref: "#/definitions/TargetIndex" + - type: object + properties: + connectionId: + type: string + description: The id of the connection pointing to the pinecone. + x-ms-discriminator-value: Pinecone + Purpose: + title: Purpose + description: The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file. + enum: + - fine-tune + - fine-tune-results + - assistants + - assistants_output + type: string + readOnly: true + x-ms-enum: + name: Purpose + modelAsString: true + values: + - value: fine-tune + description: This file contains training data for a fine tune job. + - value: fine-tune-results + description: This file contains the results of a fine tune job. + - value: assistants + description: This file contains data to be used in assistants. + - value: assistants_output + description: This file contains the results of an assistant. + ServerlessCompute: + description: Serverless compute. + allOf: + - $ref: "#/definitions/JobCompute" + - type: object + properties: + sku: + type: string + description: SKU Level + instanceCount: + type: integer + description: The count of instances to run the job on. + x-ms-discriminator-value: ServerlessCompute + SystemComputeDatasource: + title: SystemComputeDatasource + type: object + required: + - kind + properties: + kind: + $ref: "#/definitions/SystemComputeDatasourceType" + discriminator: kind + SystemComputeDatasourceType: + type: string + description: The datasource type. + enum: + - Storage + - Urls + x-ms-enum: + name: SystemComputeDatasourceType + modelAsString: true + values: + - name: Storage + value: Storage + description: Azure Storage Account. + - name: Urls + value: Urls + description: URLs. + SystemComputeStorage: + title: SystemComputeStorage + description: Storage account + required: + - connection + - containerName + - embeddings + x-ms-discriminator-value: Storage + allOf: + - $ref: "#/definitions/SystemComputeDatasource" + - type: object + properties: + connection: + $ref: "#/definitions/BaseConnection" + containerName: + type: string + description: container name + chunking: + $ref: "#/definitions/ChunkingSettings" + embeddings: + type: array + items: + $ref: "#/definitions/GenericEmbeddingSettings" + SystemComputeUrl: + title: SystemComputeUrl + description: Urls + required: + - urls + - connection + - containerName + - embeddings + x-ms-discriminator-value: Urls + allOf: + - $ref: "#/definitions/SystemComputeDatasource" + - type: object + properties: + urls: + type: array + items: + type: string + connection: + $ref: "#/definitions/BaseConnection" + containerName: + type: string + description: container name + crawling: + $ref: "#/definitions/CrawlingSettings" + chunking: + $ref: "#/definitions/ChunkingSettings" + embeddings: + type: array + items: + $ref: "#/definitions/GenericEmbeddingSettings" + TargetIndex: + title: TargetIndex + description: Information about the index to be created. + type: object + discriminator: kind + required: + - kind + properties: + kind: + $ref: "#/definitions/TargetType" + TargetType: + type: string + description: The target type. + enum: + - AzureAISearch + - CosmosDB + - Pinecone + x-ms-enum: + name: TargetType + modelAsString: true + values: + - name: AzureAISearch + value: AzureAISearch + description: Azure AI Search Index. + - name: CosmosDB + value: CosmosDB + description: CosmosDB Index. + - name: Pinecone + value: Pinecone + description: Pinecone Index. + TypeDiscriminator: + title: TypeDiscriminator + description: Defines the type of an object. + enum: + - list + - fine_tuning.job + - file + - fine_tuning.job.event + - fine_tuning.job.checkpoint + - model + - upload + - upload.part + type: string + readOnly: true + x-ms-enum: + name: TypeDiscriminator + modelAsString: true + values: + - value: list + description: This object represents a list of other objects. + - value: fine_tuning.job + description: This object represents a fine tune job. + - value: file + description: This object represents a file. + - value: fine_tuning.job.event + description: This object represents an event of a fine tuning job. + - value: fine_tuning.job.checkpoint + description: This object represents a checkpoint of a fine tuning job. + - value: model + description: This object represents a model (can be a base model or fine tune job result). + - value: upload + description: This object represents a file upload. + - value: upload.part + description: This object represents part of a file upload. + UploadFileCompleteBody: + title: UploadFileCompleteBody + required: + - part_ids + type: object + properties: + part_ids: + title: IList`1 + type: array + items: + type: string + md5: + type: string + UploadFileStartBody: + title: UploadFileStartBody + required: + - bytes + - filename + - mime_type + - purpose + type: object + properties: + purpose: + $ref: "#/definitions/Purpose" + filename: + minLength: 1 + type: string + bytes: + format: int64 + type: integer + mime_type: + minLength: 1 + type: string + UploadPartResource: + title: UploadPartResource + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + created_at: + format: unixtime + description: A timestamp when this job or item was created (in unix epochs). + type: integer + readOnly: true + id: + description: The identity of this item. + type: string + readOnly: true + upload_id: + type: string + readOnly: true + azure_block_id: + type: string + readOnly: true + UploadResource: + title: UploadResource + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + created_at: + format: unixtime + description: A timestamp when this job or item was created (in unix epochs). + type: integer + readOnly: true + id: + description: The identity of this item. + type: string + readOnly: true + bytes: + format: int64 + type: integer + readOnly: true + filename: + type: string + readOnly: true + purpose: + $ref: "#/definitions/Purpose" + status: + $ref: "#/definitions/UploadStatus" + expires_at: + format: unixtime + type: integer + readOnly: true + file: + $ref: "#/definitions/File" + UploadStatus: + title: UploadStatus + enum: + - pending + - expired + - completed + - cancelled + type: string + readOnly: true + UserComputeDataset: + type: object + title: UserComputeStorage + description: Storage account + required: + - datasetId + - datasetType + x-ms-discriminator-value: Dataset + allOf: + - $ref: "#/definitions/UserComputeDatasource" + - type: object + properties: + datasetId: + type: string + datasetType: + type: string + chunking: + $ref: "#/definitions/ChunkingSettings" + embeddings: + type: array + items: + $ref: "#/definitions/WorkspaceConnectionEmbeddingSettings" + UserComputeDatasource: + title: UserComputeDatasource + type: object + discriminator: kind + required: + - kind + properties: + kind: + $ref: "#/definitions/UserComputeDatasourceType" + UserComputeDatasourceType: + type: string + description: The datasource type. + enum: + - Dataset + - Urls + x-ms-enum: + name: UserComputeDatasourceType + modelAsString: true + values: + - name: Dataset + value: Dataset + description: Workspace Dataset. + - name: Urls + value: Urls + description: URLs. + UserComputeUrl: + type: object + title: UserComputeUrl + description: Urls + required: + - urls + - embeddings + x-ms-discriminator-value: Urls + allOf: + - $ref: "#/definitions/UserComputeDatasource" + - type: object + properties: + urls: + type: array + items: + type: string + crawling: + $ref: "#/definitions/CrawlingSettings" + chunking: + $ref: "#/definitions/ChunkingSettings" + embeddings: + type: array + items: + $ref: "#/definitions/WorkspaceConnectionEmbeddingSettings" + WandBIntegrationRequest: + title: WandBIntegrationRequest + required: + - project + type: object + properties: + project: + minLength: 1 + type: string + name: + type: string + readOnly: true + entity: + type: string + readOnly: true + tags: + type: array + items: + type: string + readOnly: true + WandBIntegrationRequestWrapper: + title: WandBIntegrationRequestWrapper + required: + - type + - wandb + type: object + properties: + type: + $ref: '#/definitions/IntegrationTypes' + wandb: + $ref: "#/definitions/WandBIntegrationRequest" + WorkspaceConnection: + description: AML Workspace connection. + required: + - connectionId + allOf: + - $ref: "#/definitions/BaseConnection" + - type: object + properties: + connectionId: + type: string + description: ConnectionId + x-ms-discriminator-value: WorkspaceConnection + WorkspaceConnectionEmbeddingSettings: + title: WorkspaceConnectionEmbeddingSettings + description: Connection id to the embedding model + type: object + properties: + connectionId: + type: string + deploymentName: + type: string + modelName: + type: string +parameters: + endpoint: + in: path + name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and hostname, for example: https://aoairesource.openai.azure.com. Replace "aoairesource" with your Azure OpenAI account name).' + required: true + type: string + format: url + x-ms-skip-url-encoding: true + x-ms-parameter-location: client + apiVersionQueryParameter: + in: query + name: api-version + description: The requested API version. + required: true + type: string + x-ms-client-default: 2024-09-01-preview + x-ms-parameter-location: client +security: + - ApiKeyAuth: [] + - OAuth2Auth: + - https://cognitiveservices.azure.com/.default +securityDefinitions: + ApiKeyAuth: + description: API key authentication + type: apiKey + name: api-key + in: header + OAuth2Auth: + description: OAuth2 authentication + type: oauth2 + flow: implicit + authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize + scopes: + https://cognitiveservices.azure.com/.default: "" +schemes: + - https +x-ms-parameterized-host: + hostTemplate: "{endpoint}/openai" + useSchemePrefix: false + parameters: + - $ref: "#/parameters/endpoint" diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_batch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_batch.json new file mode 100644 index 000000000000..06e90cf421b7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_batch.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "batch-id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "object": "batch", + "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f", + "endpoint": "/chat/completions", + "errors": null, + "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f", + "completion_window": "24h", + "status": "cancelling", + "output_file_id": null, + "error_file_id": null, + "created_at": 1646126127, + "in_progress_at": 1646126130, + "expires_at": 1646126170, + "finalizing_at": null, + "completed_at": null, + "failed_at": null, + "expired_at": null, + "cancelling_at": 1646126138, + "cancelled_at": null, + "request_counts": { + "total": 500, + "completed": 100, + "failed": 5 + }, + "metadata": { + "batch_description": "Evaluation job" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_batch.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_batch.yaml new file mode 100644 index 000000000000..a7b0cae7114e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_batch.yaml @@ -0,0 +1,33 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + batch-id: batch_72a2792ef7d24ba7b82c7fe4a37e379f +responses: + "200": + headers: {} + body: + object: batch + id: batch_72a2792ef7d24ba7b82c7fe4a37e379f + endpoint: /chat/completions + errors: null + input_file_id: file-b4fa7277f3eb4722ac18b90f46102c3f + completion_window: 24h + status: cancelling + output_file_id: null + error_file_id: null + created_at: 1646126127 + in_progress_at: 1646126130 + expires_at: 1646126170 + finalizing_at: null + completed_at: null + failed_at: null + expired_at: null + cancelling_at: 1646126138 + cancelled_at: null + request_counts: + total: 500 + completed: 100 + failed: 5 + metadata: + batch_description: Evaluation job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_finetuning_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_finetuning_job.json new file mode 100644 index 000000000000..0d7b1e196793 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_finetuning_job.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "fine-tuning-job-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "hyperparameters": { + "n_epochs": -1 + }, + "integrations": [ + { + "type": "wandb", + "wandb": { + "project": "custom-wandb-project", + "tags": [ + "project:tag", + "lineage" + ] + } + } + ], + "status": "cancelled", + "model": "curie", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099", + "finished_at": 1646127311, + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "fine_tuning.job" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_finetuning_job.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_finetuning_job.yaml new file mode 100644 index 000000000000..f448ba97c619 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_finetuning_job.yaml @@ -0,0 +1,34 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-09-01-preview + fine-tuning-job-id: ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + hyperparameters: + n_epochs: -1 + suffix: + seed: + integrations: + - type: wandb + wandb: + project: custom-wandb-project + name: + entity: + tags: + - project:tag + - lineage + status: cancelled + model: curie + fine_tuned_model: + training_file: file-181a1cbdcdcf4677ada87f63a0928099 + validation_file: + result_files: + finished_at: 1646127311 + organisation_id: + error: + id: ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: fine_tuning.job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_file.json new file mode 100644 index 000000000000..eaedd0df71ed --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_file.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "file-id": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_file.yaml new file mode 100644 index 000000000000..6c9fea14e13b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_file.yaml @@ -0,0 +1,9 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + file-id: file-181a1cbdcdcf4677ada87f63a0928099 +responses: + 204: + headers: {} + body: diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_finetuning_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_finetuning_job.json new file mode 100644 index 000000000000..f697bbe970c4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_finetuning_job.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "fine-tuning-job-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_finetuning_job.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_finetuning_job.yaml new file mode 100644 index 000000000000..eea04bda3d68 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_finetuning_job.yaml @@ -0,0 +1,9 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + fine-tuning-job-id: ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 204: + headers: {} + body: diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batch.json new file mode 100644 index 000000000000..ba259ef7411a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batch.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "batch-id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "object": "batch", + "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f", + "endpoint": "/chat/completions", + "errors": null, + "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f", + "completion_window": "24h", + "status": "completed", + "output_file_id": "file-f2ddaf43-b48b-46dd-b264-90da10c7a85b", + "error_file_id": "file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c", + "created_at": 1646126127, + "in_progress_at": 1646126130, + "expires_at": 1646126170, + "finalizing_at": 1646126134, + "completed_at": 1646126136, + "failed_at": null, + "expired_at": null, + "cancelling_at": null, + "cancelled_at": null, + "request_counts": { + "total": 500, + "completed": 400, + "failed": 100 + }, + "metadata": { + "batch_description": "Evaluation job" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batch.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batch.yaml new file mode 100644 index 000000000000..059f28a8a8e0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batch.yaml @@ -0,0 +1,33 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + batch-id: batch_72a2792ef7d24ba7b82c7fe4a37e379f +responses: + "200": + headers: {} + body: + object: batch + id: batch_72a2792ef7d24ba7b82c7fe4a37e379f + endpoint: /chat/completions + errors: null + input_file_id: file-b4fa7277f3eb4722ac18b90f46102c3f + completion_window: 24h + status: completed + output_file_id: file-f2ddaf43-b48b-46dd-b264-90da10c7a85b + error_file_id: file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c + created_at: 1646126127 + in_progress_at: 1646126130 + expires_at: 1646126170 + finalizing_at: 1646126134 + completed_at: 1646126136 + failed_at: null + expired_at: null + cancelling_at: null + cancelled_at: null + request_counts: + total: 500 + completed: 400 + failed: 100 + metadata: + batch_description: Evaluation job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batches.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batches.json new file mode 100644 index 000000000000..23eb1bd08d70 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batches.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "has_more": false, + "data": [ + { + "object": "batch", + "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f", + "endpoint": "/chat/completions", + "errors": null, + "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f", + "completion_window": "24h", + "status": "completed", + "output_file_id": "file-f2ddaf43-b48b-46dd-b264-90da10c7a85b", + "error_file_id": "file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c", + "created_at": 1646126127, + "in_progress_at": 1646126130, + "expires_at": 1646126170, + "finalizing_at": 1646126134, + "completed_at": 1646126136, + "failed_at": null, + "expired_at": null, + "cancelling_at": null, + "cancelled_at": null, + "request_counts": { + "total": 500, + "completed": 400, + "failed": 100 + }, + "first_id": "batch_abc123", + "last_id": "batch_abc456", + "metadata": { + "batch_description": "Evaluation job" + } + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batches.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batches.yaml new file mode 100644 index 000000000000..416df037a551 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batches.yaml @@ -0,0 +1,37 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview +responses: + "200": + headers: {} + body: + has_more: false + data: + - object: batch + id: batch_72a2792ef7d24ba7b82c7fe4a37e379f + endpoint: /chat/completions + errors: null + input_file_id: file-b4fa7277f3eb4722ac18b90f46102c3f + completion_window: 24h + status: completed + output_file_id: file-f2ddaf43-b48b-46dd-b264-90da10c7a85b + error_file_id: file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c + created_at: 1646126127 + in_progress_at: 1646126130 + expires_at: 1646126170 + finalizing_at: 1646126134 + completed_at: 1646126136 + failed_at: null + expired_at: null + cancelling_at: null + cancelled_at: null + request_counts: + total: 500 + completed: 400 + failed: 100 + first_id: batch_abc123 + last_id: batch_abc456 + metadata: + batch_description: Evaluation job + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file.json new file mode 100644 index 000000000000..47a68258b6d9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "file-id": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file.yaml new file mode 100644 index 000000000000..d11929bbc1be --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file.yaml @@ -0,0 +1,16 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + file-id: file-181a1cbdcdcf4677ada87f63a0928099 +responses: + 200: + headers: {} + body: + metadata: + bytes: 140 + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file_content.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file_content.json new file mode 100644 index 000000000000..36c4ed963afc --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file_content.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "file-id": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "responses": { + "200": { + "headers": {}, + "body": "raw file content" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file_content.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file_content.yaml new file mode 100644 index 000000000000..3dac90507296 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file_content.yaml @@ -0,0 +1,9 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + file-id: file-181a1cbdcdcf4677ada87f63a0928099 +responses: + 200: + headers: {} + body: raw file content diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_files.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_files.json new file mode 100644 index 000000000000..0ad06c2cc933 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_files.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "data": [ + { + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + }, + { + "bytes": 32423, + "purpose": "fine-tune-results", + "filename": "results.csv", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_files.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_files.yaml new file mode 100644 index 000000000000..6d102f31519c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_files.yaml @@ -0,0 +1,24 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview +responses: + 200: + headers: {} + body: + data: + - metadata: + bytes: 140 + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file + - metadata: + bytes: 32423 + purpose: fine-tune-results + filename: results.csv + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job.json new file mode 100644 index 000000000000..facaa880d303 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "fine-tuning-job-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "hyperparameters": { + "n_epochs": -1 + }, + "integrations": [ + { + "type": "wandb", + "wandb": { + "project": "custom-wandb-project", + "tags": [ + "project:tag", + "lineage" + ] + } + } + ], + "status": "succeeded", + "model": "curie", + "fine_tuned_model": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099", + "result_files": [ + "file-181a1cbdcdcf4677ada87f63a0928099" + ], + "finished_at": 1646127311, + "trained_tokens": 2342, + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "fine_tuning.job" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job.yaml new file mode 100644 index 000000000000..857e3aa404b5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job.yaml @@ -0,0 +1,36 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-09-01-preview + fine-tuning-job-id: ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + hyperparameters: + n_epochs: -1 + suffix: + seed: + integrations: + - type: wandb + wandb: + project: custom-wandb-project + name: + entity: + tags: + - project:tag + - lineage + status: succeeded + model: curie + fine_tuned_model: curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f + training_file: file-181a1cbdcdcf4677ada87f63a0928099 + validation_file: + result_files: + - file-181a1cbdcdcf4677ada87f63a0928099 + finished_at: 1646127311 + organisation_id: + trained_tokens: 2342 + error: + id: ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: fine_tuning.job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_checkpoints.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_checkpoints.json new file mode 100644 index 000000000000..b3fa3f4728e3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_checkpoints.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "fine-tuning-job-id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "has_more": false, + "data": [ + { + "id": "ftckpt_qtZ5Gyk4BLq1SfLFWp3RtO3P", + "created_at": 1646126127, + "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-10", + "step_number": 10, + "metrics": { + "step": 10, + "train_loss": 0.478, + "train_mean_token_accuracy": 0.924, + "valid_loss": 10.112, + "valid_mean_token_accuracy": 0.145, + "full_valid_loss": 0.567, + "full_valid_mean_token_accuracy": 0.944 + }, + "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f", + "object": "fine_tuning.job.checkpoint" + }, + { + "id": "ftckpt_frtXDR2453C4FG67t03MLPs5", + "created_at": 1646126137, + "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-20", + "step_number": 20, + "metrics": { + "step": 20, + "train_loss": 0.355, + "train_mean_token_accuracy": 0.947, + "valid_loss": 11.32, + "valid_mean_token_accuracy": 0.122, + "full_valid_loss": 0.317, + "full_valid_mean_token_accuracy": 0.955 + }, + "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f", + "object": "fine_tuning.job.checkpoint" + }, + { + "id": "ftckpt_agLk6Gio560ORp14gl123fgd", + "created_at": 1646126147, + "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-30", + "step_number": 30, + "metrics": { + "step": 30, + "train_loss": 0.155, + "train_mean_token_accuracy": 0.975, + "valid_loss": 9.31, + "valid_mean_token_accuracy": 0.092, + "full_valid_loss": 0.114, + "full_valid_mean_token_accuracy": 0.963 + }, + "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f", + "object": "fine_tuning.job.checkpoint" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_checkpoints.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_checkpoints.yaml new file mode 100644 index 000000000000..724c1cfe494e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_checkpoints.yaml @@ -0,0 +1,54 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + fine-tuning-job-id: ftjob-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + has_more: false + data: + - id: ftckpt_qtZ5Gyk4BLq1SfLFWp3RtO3P + created_at: 1646126127 + fineTunedModelCheckpoint: gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-10 + stepNumber: 10 + metrics: + step: 10 + train_loss: 0.478 + train_mean_token_accuracy: 0.924 + valid_loss: 10.112 + valid_mean_token_accuracy: 0.145 + full_valid_loss: 0.567 + full_valid_mean_token_accuracy: 0.944 + fineTuningJobId: ftjob-72a2792ef7d24ba7b82c7fe4a37e379f + object: fine_tuning.job.checkpoint + - id: ftckpt_frtXDR2453C4FG67t03MLPs5 + created_at: 1646126137 + fineTunedModelCheckpoint: gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-20 + stepNumber: 20 + metrics: + step: 20 + train_loss: 0.355 + train_mean_token_accuracy: 0.947 + valid_loss: 11.32 + valid_mean_token_accuracy: 0.122 + full_valid_loss: 0.317 + full_valid_mean_token_accuracy: 0.955 + fineTuningJobId: ftjob-72a2792ef7d24ba7b82c7fe4a37e379f + object: fine_tuning.job.checkpoint + - id: ftckpt_agLk6Gio560ORp14gl123fgd + created_at: 1646126147 + fineTunedModelCheckpoint: gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-30 + stepNumber: 30 + metrics: + step: 30 + train_loss: 0.155 + train_mean_token_accuracy: 0.975 + valid_loss: 9.31 + valid_mean_token_accuracy: 0.092 + full_valid_loss: 0.114 + full_valid_mean_token_accuracy: 0.963 + fineTuningJobId: ftjob-72a2792ef7d24ba7b82c7fe4a37e379f + object: fine_tuning.job.checkpoint + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_events.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_events.json new file mode 100644 index 000000000000..582aebd35d81 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_events.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "fine-tuning-job-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "has_more": false, + "data": [ + { + "id": "ftevent-363dcd7cb4c74539bc53293c1dceef05", + "created_at": 1646126127, + "level": "info", + "message": "Job enqueued. Waiting for jobs ahead to complete.", + "type": "message", + "object": "fine_tuning.job.event" + }, + { + "id": "ftevent-8c2a44999790437cb3230e543fa2cf0f", + "created_at": 1646126169, + "level": "info", + "message": "Job started.", + "type": "message", + "object": "fine_tuning.job.event" + }, + { + "id": "ftevent-2d47d651d2f3484c8187c88c00078147", + "created_at": 1646126192, + "level": "info", + "message": "Job succeeded.", + "type": "message", + "object": "fine_tuning.job.event" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_events.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_events.yaml new file mode 100644 index 000000000000..c8c894d808f6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_events.yaml @@ -0,0 +1,33 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + fine-tuning-job-id: ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + has_more: false + data: + - id: ftevent-363dcd7cb4c74539bc53293c1dceef05 + created_at: 1646126127 + level: Info + message: Job enqueued. Waiting for jobs ahead to complete. + type: message + data: + object: fine_tuning.job.event + - id: ftevent-8c2a44999790437cb3230e543fa2cf0f + created_at: 1646126169 + level: Info + message: Job started. + type: message + data: + object: fine_tuning.job.event + - id: ftevent-2d47d651d2f3484c8187c88c00078147 + created_at: 1646126192 + level: Info + message: Job succeeded. + type: message + data: + object: fine_tuning.job.event + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_jobs.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_jobs.json new file mode 100644 index 000000000000..d83f41d8ecf6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_jobs.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "has_more": false, + "data": [ + { + "hyperparameters": { + "n_epochs": -1 + }, + "integrations": [ + { + "type": "wandb", + "wandb": { + "project": "custom-wandb-project", + "tags": [ + "project:tag", + "lineage" + ] + } + } + ], + "status": "succeeded", + "model": "curie", + "fine_tuned_model": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099", + "result_files": [ + "file-181a1cbdcdcf4677ada87f63a0928099" + ], + "finished_at": 1646127311, + "trained_tokens": 2342, + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "fine_tuning.job" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_jobs.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_jobs.yaml new file mode 100644 index 000000000000..2a36bddb5ab7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_jobs.yaml @@ -0,0 +1,38 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-09-01-preview +responses: + 200: + headers: {} + body: + has_more: false + data: + - hyperparameters: + n_epochs: -1 + suffix: + seed: + integrations: + - type: wandb + wandb: + project: custom-wandb-project + name: + entity: + tags: + - project:tag + - lineage + status: succeeded + model: curie + fine_tuned_model: curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f + training_file: file-181a1cbdcdcf4677ada87f63a0928099 + validation_file: + result_files: + - file-181a1cbdcdcf4677ada87f63a0928099 + finished_at: 1646127311 + organisation_id: + trained_tokens: 2342 + error: + id: ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: fine_tuning.job + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job.json new file mode 100644 index 000000000000..2603849d78fb --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-09-01-preview", + "job-id": "ingestion-job" + }, + "responses": { + "200": { + "body": { + "kind": "UserCompute", + "jobId": "ingestion-job", + "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev", + "compute": { + "kind": "ServerlessCompute" + }, + "target": { + "kind": "AzureAISearch", + "connectionId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection" + }, + "datasource": { + "kind": "Dataset", + "datasetId": "azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1", + "datasetType": "uri_folder" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job.yaml new file mode 100644 index 000000000000..f83bd13a9172 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job.yaml @@ -0,0 +1,21 @@ +parameters: + api-version: 2024-09-01-preview + job-id: ingestion-job +responses: + "200": + body: + kind: UserCompute + jobId: ingestion-job + workspaceId: >- + /subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev + compute: + kind: ServerlessCompute + target: + kind: AzureAISearch + connectionId: >- + /subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection + datasource: + kind: Dataset + datasetId: >- + azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1 + datasetType: uri_folder diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job_run.json new file mode 100644 index 000000000000..cf2a9c7f6b30 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job_run.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-09-01-preview", + "job-id": "ingestion-job", + "run-id": "5ef7a436-1147-4cbb-82e0-3d502bcc6a7b" + }, + "responses": { + "200": { + "body": { + "jobId": "ingestion-job", + "runId": "5ef7a436-1147-4cbb-82e0-3d502bcc6a7b", + "status": "running", + "progress": { + "stageProgress": [ + { + "name": "Preprocessing", + "totalItems": 14, + "processedItems": 0, + "state": "notRunning" + }, + { + "name": "Indexing", + "state": "notRunning" + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job_run.yaml new file mode 100644 index 000000000000..2ffcd8afe183 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job_run.yaml @@ -0,0 +1,18 @@ +parameters: + api-version: 2024-09-01-preview + job-id: ingestion-job + run-id: 5ef7a436-1147-4cbb-82e0-3d502bcc6a7b +responses: + "200": + body: + jobId: ingestion-job + runId: 5ef7a436-1147-4cbb-82e0-3d502bcc6a7b + status: running + progress: + stageProgress: + - name: Preprocessing + totalItems: 14 + processedItems: 0 + state: notRunning + - name: Indexing + state: notRunning diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_base.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_base.json new file mode 100644 index 000000000000..86b4b72c70b0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_base.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "model-id": "curie" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "status": "succeeded", + "capabilities": { + "fine_tune": true, + "inference": true, + "completion": true, + "chat_completion": false, + "embeddings": false + }, + "lifecycle_status": "generally-available", + "deprecation": { + "fine_tune": 1677662127, + "inference": 1709284527 + }, + "id": "curie", + "created_at": 1646126127, + "object": "model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_base.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_base.yaml new file mode 100644 index 000000000000..1aac487f7eb7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_base.yaml @@ -0,0 +1,25 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + model-id: curie +responses: + 200: + headers: {} + body: + status: succeeded + model: + fine_tune: + capabilities: + fine_tune: true + inference: true + completion: true + chat_completion: false + embeddings: false + lifecycle_status: generally-available + deprecation: + fine_tune: 1677662127 + inference: 1709284527 + id: curie + created_at: 1646126127 + object: model diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_finetune.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_finetune.json new file mode 100644 index 000000000000..482e68e36a8c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_finetune.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "model-id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "status": "succeeded", + "model": "curie", + "fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "capabilities": { + "fine_tune": false, + "inference": true, + "completion": true, + "chat_completion": false, + "embeddings": false + }, + "lifecycle_status": "generally-available", + "deprecation": { + "inference": 1709284527 + }, + "id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_finetune.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_finetune.yaml new file mode 100644 index 000000000000..81333da2bad3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_finetune.yaml @@ -0,0 +1,24 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + model-id: curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + status: succeeded + model: curie + fine_tune: ft-72a2792ef7d24ba7b82c7fe4a37e379f + capabilities: + fine_tune: false + inference: true + completion: true + chat_completion: false + embeddings: false + lifecycle_status: generally-available + deprecation: + inference: 1709284527 + id: curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: model diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_models.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_models.json new file mode 100644 index 000000000000..671fa6afea1a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_models.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "data": [ + { + "status": "succeeded", + "capabilities": { + "fine_tune": true, + "inference": true, + "completion": true, + "chat_completion": false, + "embeddings": false + }, + "lifecycle_status": "generally-available", + "deprecation": { + "fine_tune": 1677662127, + "inference": 1709284527 + }, + "id": "curie", + "created_at": 1646126127, + "object": "model" + }, + { + "status": "succeeded", + "model": "curie", + "fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "capabilities": { + "fine_tune": false, + "inference": true, + "completion": true, + "chat_completion": false, + "embeddings": false + }, + "lifecycle_status": "generally-available", + "deprecation": { + "inference": 1709284527 + }, + "id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "model" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_models.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_models.yaml new file mode 100644 index 000000000000..56a0bb3fc881 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_models.yaml @@ -0,0 +1,41 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview +responses: + 200: + headers: {} + body: + data: + - status: succeeded + model: + fine_tune: + capabilities: + fine_tune: true + inference: true + completion: true + chat_completion: false + embeddings: false + lifecycle_status: generally-available + deprecation: + fine_tune: 1677662127 + inference: 1709284527 + id: curie + created_at: 1646126127 + object: model + - status: succeeded + model: curie + fine_tune: ft-72a2792ef7d24ba7b82c7fe4a37e379f + capabilities: + fine_tune: false + inference: true + completion: true + chat_completion: false + embeddings: false + lifecycle_status: generally-available + deprecation: + inference: 1709284527 + id: curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: model + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/import_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/import_file.json new file mode 100644 index 000000000000..a83f15a12134 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/import_file.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "fileImport": { + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "content_url": "https://www.contoso.com/trainingdata/puppy.jsonl" + }, + "content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "location": "https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099" + }, + "body": { + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/import_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/import_file.yaml new file mode 100644 index 000000000000..07630887e468 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/import_file.yaml @@ -0,0 +1,47 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + fileImport: + purpose: fine-tune + filename: puppy.jsonl + content_url: &o0 + absolutePath: /trainingdata/puppy.jsonl + absoluteUri: *o0 + localPath: /trainingdata/puppy.jsonl + authority: www.contoso.com + hostNameType: Dns + isDefaultPort: true + isFile: false + isLoopback: false + pathAndQuery: /trainingdata/puppy.jsonl + segments: + - / + - trainingdata/ + - puppy.jsonl + isUnc: false + host: www.contoso.com + port: 443 + query: "" + fragment: "" + scheme: https + originalString: *o0 + dnsSafeHost: www.contoso.com + idnHost: www.contoso.com + isAbsoluteUri: true + userEscaped: false + userInfo: "" + metadata: + Content-Type: application/json +responses: + 201: + headers: + Location: https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099 + body: + metadata: + bytes: + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_job_runs.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_job_runs.json new file mode 100644 index 000000000000..f0ac20f776b1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_job_runs.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-09-01-preview", + "job-id": "ingestion-job" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "jobId": "ingestion-job", + "runId": "f375b912-331c-4fc5-8e9f-2d7205e3e036", + "status": "succeeded" + }, + { + "jobId": "ingestion-job", + "runId": "07f2d192-add7-4202-a2e3-858c2577f4fd", + "status": "failed" + }, + { + "jobId": "ingestion-job", + "runId": "5ef7a436-1147-4cbb-82e0-3d502bcc6a7b", + "status": "running" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_job_runs.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_job_runs.yaml new file mode 100644 index 000000000000..9b66890ac1be --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_job_runs.yaml @@ -0,0 +1,16 @@ +parameters: + api-version: 2024-09-01-preview + job-id: ingestion-job +responses: + "200": + body: + value: + - jobId: ingestion-job + runId: f375b912-331c-4fc5-8e9f-2d7205e3e036 + status: succeeded + - jobId: ingestion-job + runId: 07f2d192-add7-4202-a2e3-858c2577f4fd + status: failed + - jobId: ingestion-job + runId: 5ef7a436-1147-4cbb-82e0-3d502bcc6a7b + status: running diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_jobs.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_jobs.json new file mode 100644 index 000000000000..64f44cf47118 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_jobs.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "jobId": "usercompute-ingestion-job", + "kind": "UserCompute", + "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev" + }, + { + "jobId": "syscompute-ingestion-job", + "kind": "SystemCompute" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_jobs.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_jobs.yaml new file mode 100644 index 000000000000..4450f0a260e2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_jobs.yaml @@ -0,0 +1,12 @@ +parameters: + api-version: 2024-09-01-preview +responses: + "200": + body: + value: + - jobId: usercompute-ingestion-job + kind: UserCompute + workspaceId: >- + /subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev + - jobId: syscompute-ingestion-job + kind: SystemCompute diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_batch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_batch.json new file mode 100644 index 000000000000..c5374beff4b5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_batch.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "batchCreateRequest": { + "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f", + "endpoint": "/chat/completions", + "completion_window": "24h", + "metadata": { + "batch_description": "Evaluation job" + } + }, + "content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "object": "batch", + "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f", + "endpoint": "/chat/completions", + "errors": null, + "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f", + "completion_window": "24h", + "status": "validating", + "output_file_id": null, + "error_file_id": null, + "created_at": 1646126127, + "in_progress_at": null, + "expires_at": null, + "finalizing_at": null, + "completed_at": null, + "failed_at": null, + "expired_at": null, + "cancelling_at": null, + "cancelled_at": null, + "request_counts": { + "total": 0, + "completed": 0, + "failed": 0 + }, + "metadata": { + "batch_description": "Evaluation job" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_batch.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_batch.yaml new file mode 100644 index 000000000000..198c171c71fc --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_batch.yaml @@ -0,0 +1,39 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + batchCreateRequest: + input_file_id: file-b4fa7277f3eb4722ac18b90f46102c3f + endpoint: /chat/completions + completion_window: 24h + metadata: + batch_description: Evaluation job + content-Type: application/json +responses: + "201": + headers: {} + body: + object: batch + id: batch_72a2792ef7d24ba7b82c7fe4a37e379f + endpoint: /chat/completions + errors: null + input_file_id: file-b4fa7277f3eb4722ac18b90f46102c3f + completion_window: 24h + status: validating + output_file_id: null + error_file_id: null + created_at: 1646126127 + in_progress_at: null + expires_at: null + finalizing_at: null + completed_at: null + failed_at: null + expired_at: null + cancelling_at: null + cancelled_at: null + request_counts: + total: 0 + completed: 0 + failed: 0 + metadata: + batch_description: Evaluation job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_finetuning_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_finetuning_job.json new file mode 100644 index 000000000000..5f5bb21b38bf --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_finetuning_job.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "fineTuningJob": { + "integrations": [ + { + "type": "wandb", + "wandb": { + "project": "custom-wandb-project", + "tags": [ + "project:tag", + "lineage" + ] + } + } + ], + "model": "curie", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "location": "https://aoairesource.openai.azure.com/openai/fine_tuning/jobs/ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "body": { + "hyperparameters": { + "n_epochs": -1 + }, + "integrations": [ + { + "type": "wandb", + "wandb": { + "project": "custom-wandb-project", + "tags": [ + "project:tag", + "lineage" + ] + } + } + ], + "status": "pending", + "model": "curie", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099", + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "fine_tuning.job" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_finetuning_job.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_finetuning_job.yaml new file mode 100644 index 000000000000..0308fd74e3e1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_finetuning_job.yaml @@ -0,0 +1,51 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-09-01-preview + fineTuningJob: + hyperparameters: + suffix: + seed: + integrations: + - type: wandb + wandb: + project: custom-wandb-project + name: + entity: + tags: + - project:tag + - lineage + model: curie + trainingFile: file-181a1cbdcdcf4677ada87f63a0928099 + validationFile: + Content-Type: application/json +responses: + 201: + headers: + Location: https://aoairesource.openai.azure.com/openai/fine_tuning/jobs/ft-72a2792ef7d24ba7b82c7fe4a37e379f + body: + hyperparameters: + n_epochs: -1 + suffix: + seed: + integrations: + - type: wandb + wandb: + project: custom-wandb-project + name: + entity: + tags: + - project:tag + - lineage + status: pending + model: curie + fine_tuned_model: + training_file: file-181a1cbdcdcf4677ada87f63a0928099 + validation_file: + result_files: + finished_at: + organisation_id: + error: + id: ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: fine_tuning.job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_sc.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_sc.json new file mode 100644 index 000000000000..d28580c00aeb --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_sc.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2024-09-01-preview", + "job-id": "ingestion-job", + "ingestionJob": { + "kind": "SystemCompute", + "searchServiceConnection": { + "kind": "EndpointWithManagedIdentity", + "endpoint": "https://aykame-dev-search.search.windows.net" + }, + "datasource": { + "kind": "Storage", + "connection": { + "kind": "EndpointWithManagedIdentity", + "endpoint": "https://mystorage.blob.core.windows.net/", + "resourceId": "/subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage" + }, + "containerName": "container", + "chunking": { + "maxChunkSizeInTokens": 2048 + }, + "embeddings": [ + { + "connection": { + "kind": "RelativeConnection" + }, + "deploymentName": "Ada" + } + ] + }, + "dataRefreshIntervalInHours": 24, + "completionAction": "keepAllAssets" + } + }, + "responses": { + "200": { + "headers": { + "operation-location": "https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2024-09-01-preview" + }, + "body": { + "kind": "SystemCompute", + "jobId": "ingestion-job", + "searchServiceConnection": { + "kind": "EndpointWithManagedIdentity", + "endpoint": "https://aykame-dev-search.search.windows.net" + }, + "datasource": { + "kind": "Storage", + "connection": { + "kind": "EndpointWithManagedIdentity", + "endpoint": "https://mystorage.blob.core.windows.net/", + "resourceId": "/subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage" + }, + "containerName": "container", + "chunking": { + "maxChunkSizeInTokens": 2048 + }, + "embeddings": [ + { + "connection": { + "kind": "RelativeConnection" + }, + "deploymentName": "Ada" + } + ] + }, + "dataRefreshIntervalInHours": 24, + "completionAction": "keepAllAssets" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_sc.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_sc.yaml new file mode 100644 index 000000000000..541bf997ba38 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_sc.yaml @@ -0,0 +1,51 @@ +parameters: + api-version: 2024-09-01-preview + job-id: ingestion-job + ingestionJob: + kind: SystemCompute + searchServiceConnection: + kind: EndpointWithManagedIdentity + endpoint: "https://aykame-dev-search.search.windows.net" + datasource: + kind: Storage + connection: + kind: EndpointWithManagedIdentity + endpoint: "https://mystorage.blob.core.windows.net/" + resourceId: >- + /subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage + containerName: container + chunking: + maxChunkSizeInTokens: 2048 + embeddings: + - connection: + kind: RelativeConnection + deploymentName: Ada + dataRefreshIntervalInHours: 24 + completionAction: keepAllAssets +responses: + "200": + headers: + operation-location: >- + https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2024-09-01-preview + body: + kind: SystemCompute + jobId: ingestion-job + searchServiceConnection: + kind: EndpointWithManagedIdentity + endpoint: "https://aykame-dev-search.search.windows.net" + datasource: + kind: Storage + connection: + kind: EndpointWithManagedIdentity + endpoint: "https://mystorage.blob.core.windows.net/" + resourceId: >- + /subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage + containerName: container + chunking: + maxChunkSizeInTokens: 2048 + embeddings: + - connection: + kind: RelativeConnection + deploymentName: Ada + dataRefreshIntervalInHours: 24 + completionAction: keepAllAssets diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_uc.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_uc.json new file mode 100644 index 000000000000..4f600fd25b93 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_uc.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-09-01-preview", + "job-id": "ingestion-job", + "ingestionJob": { + "kind": "UserCompute", + "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev", + "compute": { + "kind": "ServerlessCompute" + }, + "target": { + "kind": "AzureAISearch", + "connectionId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection" + }, + "datasource": { + "kind": "Dataset", + "datasetId": "azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1", + "datasetType": "uri_folder" + } + } + }, + "responses": { + "200": { + "headers": { + "operation-location": "https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2024-09-01-preview" + }, + "body": { + "kind": "UserCompute", + "jobId": "ingestion-job", + "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev", + "compute": { + "kind": "ServerlessCompute" + }, + "target": { + "kind": "AzureAISearch", + "connectionId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection" + }, + "datasource": { + "kind": "Dataset", + "datasetId": "azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1", + "datasetType": "uri_folder" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_uc.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_uc.yaml new file mode 100644 index 000000000000..26ee8911164e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_uc.yaml @@ -0,0 +1,39 @@ +parameters: + api-version: 2024-09-01-preview + job-id: ingestion-job + ingestionJob: + kind: UserCompute + workspaceId: >- + /subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev + compute: + kind: ServerlessCompute + target: + kind: AzureAISearch + connectionId: >- + /subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection + datasource: + kind: Dataset + datasetId: >- + azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1 + datasetType: uri_folder +responses: + "200": + headers: + operation-location: >- + https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2024-09-01-preview + body: + kind: UserCompute + jobId: ingestion-job + workspaceId: >- + /subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev + compute: + kind: ServerlessCompute + target: + kind: AzureAISearch + connectionId: >- + /subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection + datasource: + kind: Dataset + datasetId: >- + azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1 + datasetType: uri_folder diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file.json new file mode 100644 index 000000000000..fcd9e4b3e83f --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "purpose": "fine-tune", + "content-Type": "multipart/form-data", + "file": "raw file content" + }, + "responses": { + "201": { + "headers": { + "location": "https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099" + }, + "body": { + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file.yaml new file mode 100644 index 000000000000..adae7e4c1046 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file.yaml @@ -0,0 +1,19 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + purpose: fine-tune + Content-Type: multipart/form-data + file: raw file content +responses: + 201: + headers: + Location: https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099 + body: + metadata: + bytes: + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_cancel.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_cancel.json new file mode 100644 index 000000000000..3e415bc1e4fe --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_cancel.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "upload-id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "bytes": 2097152, + "filename": "training_data_v21.jsonl", + "purpose": "fine-tune", + "status": "cancelled", + "expires_at": 1646133327, + "file": { + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + }, + "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "upload" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_cancel.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_cancel.yaml new file mode 100644 index 000000000000..fb0c72d1f816 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_cancel.yaml @@ -0,0 +1,25 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + upload-id: fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + bytes: 2097152 + filename: training_data_v21.jsonl + purpose: fine-tune + status: cancelled + expires_at: 1646133327 + file: + metadata: + bytes: 140 + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file + id: fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: upload diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_complete.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_complete.json new file mode 100644 index 000000000000..192e0010133d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_complete.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "upload-id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f", + "body": { + "part_ids": [ + "LnmictL3p0u4LH/ko343nw==", + "LmmictL3p0u4LH/ko343nw==" + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "bytes": 2097152, + "filename": "training_data_v21.jsonl", + "purpose": "fine-tune", + "status": "completed", + "expires_at": 1646133327, + "file": { + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + }, + "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "upload" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_complete.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_complete.yaml new file mode 100644 index 000000000000..6ab4ff431542 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_complete.yaml @@ -0,0 +1,30 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + upload-id: fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f + body: + part_ids: + - LnmictL3p0u4LH/ko343nw== + - LmmictL3p0u4LH/ko343nw== + md5: +responses: + 200: + headers: {} + body: + bytes: 2097152 + filename: training_data_v21.jsonl + purpose: fine-tune + status: completed + expires_at: 1646133327 + file: + metadata: + bytes: 140 + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file + id: fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: upload diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_part.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_part.json new file mode 100644 index 000000000000..a7c32b757f02 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_part.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "upload-id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f", + "data": "raw file content", + "content-Type": "multipart/form-data" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "upload_id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f", + "azure_block_id": "LnmictL3p0u4LH/ko343nw==", + "id": "uplprt-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "upload.part" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_part.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_part.yaml new file mode 100644 index 000000000000..a8d9603206d2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_part.yaml @@ -0,0 +1,16 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + upload-id: fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f + data: raw file content + Content-Type: multipart/form-data +responses: + 200: + headers: {} + body: + upload_id: fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f + azure_block_id: LnmictL3p0u4LH/ko343nw== + id: uplprt-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: upload.part diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_start.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_start.json new file mode 100644 index 000000000000..238249f7eabe --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_start.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "body": { + "purpose": "fine-tune", + "filename": "training_data_v21.jsonl", + "bytes": 2097152, + "mime_type": "application/json" + } + }, + "responses": { + "201": { + "headers": { + "location": "https://aoairesource.openai.azure.com/openai/uploads/runs/fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "body": { + "bytes": 2097152, + "filename": "training_data_v21.jsonl", + "purpose": "fine-tune", + "status": "pending", + "expires_at": 1646133327, + "file": { + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + }, + "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "upload" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_start.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_start.yaml new file mode 100644 index 000000000000..e15117542a5c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_start.yaml @@ -0,0 +1,30 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + body: + purpose: fine-tune + filename: training_data_v21.jsonl + bytes: 2097152 + mimeType: application/json +responses: + 201: + headers: + Location: https://aoairesource.openai.azure.com/openai/uploads/runs/fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f + body: + bytes: 2097152 + filename: training_data_v21.jsonl + purpose: fine-tune + status: pending + expires_at: 1646133327 + file: + metadata: + bytes: 140 + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file + id: fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: upload diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md index f946c4a17c65..97104e711bdc 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md @@ -349,3 +349,44 @@ directive: - suppress: IntegerTypeMustHaveFormat reason: API stewardship board recommend to use format "unixtime" which is not supported by linter at the moment. ``` + +## AzureOpenAI 2024-08-01-preview +These settings apply only when `--tag=release_2024_08_01_preview` is specified on the command line. + +``` yaml $(tag) == 'release_2024_08_01_preview' +input-file: preview/2024-08-01-preview/azureopenai.json +``` + +AutoRest-Linter Suppressions + +``` yaml +# Ignore autorest-linter issues that cannot be resolved without breaking compatibility to existing openai api +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + reason: Existing external API uses property names like n_epochs, created_at, not following naming/casing guidelines from azure. + - suppress: ValidFormats + reason: API stewardship board recommend to use format "unixtime" which is not supported by linter at the moment. + - suppress: IntegerTypeMustHaveFormat + reason: API stewardship board recommend to use format "unixtime" which is not supported by linter at the moment. +``` + + +## AzureOpenAI 2024-09-01-preview +These settings apply only when `--tag=release_2024_09_01_preview` is specified on the command line. + +``` yaml $(tag) == 'release_2024_09_01_preview' +input-file: preview/2024-09-01-preview/azureopenai.json +``` + +AutoRest-Linter Suppressions + +``` yaml +# Ignore autorest-linter issues that cannot be resolved without breaking compatibility to existing openai api +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + reason: Existing external API uses property names like n_epochs, created_at, not following naming/casing guidelines from azure. + - suppress: ValidFormats + reason: API stewardship board recommend to use format "unixtime" which is not supported by linter at the moment. + - suppress: IntegerTypeMustHaveFormat + reason: API stewardship board recommend to use format "unixtime" which is not supported by linter at the moment. +``` \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_speech.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_speech.json new file mode 100644 index 000000000000..a221dfb9d07d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_speech.json @@ -0,0 +1,18 @@ +{ + "title": "Synthesizes audio from the provided text.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>", + "body": { + "input": "Hi! What are you going to make?", + "voice": "fable", + "response_format": "mp3" + } + }, + "responses": { + "200": { + "body": "101010101" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_speech.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_speech.yaml new file mode 100644 index 000000000000..6b1838089f61 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_speech.yaml @@ -0,0 +1,12 @@ +parameters: + api-version: 2024-09-01-preview + body: + input: Hi! What are you going to make? + response_format: mp3 + voice: fable + deployment-id: <deployment-id> + endpoint: "{endpoint}" +responses: + "200": + body: "101010101" +title: Synthesizes audio from the provided text. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_object.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_object.json new file mode 100644 index 000000000000..69160f691d40 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_object.json @@ -0,0 +1,15 @@ +{ + "title": "Gets transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>" + }, + "responses": { + "200": { + "body": { + "text": "A structured object when requesting json or verbose_json" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_object.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_object.yaml new file mode 100644 index 000000000000..4f951e1ea432 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_object.yaml @@ -0,0 +1,9 @@ +parameters: + api-version: 2024-09-01-preview + deployment-id: <deployment-id> + endpoint: "{endpoint}" +responses: + "200": + body: + text: A structured object when requesting json or verbose_json +title: Gets transcribed text and associated metadata from provided spoken audio data. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_text.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_text.json new file mode 100644 index 000000000000..7ba01e8f58e9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_text.json @@ -0,0 +1,15 @@ +{ + "title": "Gets transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>", + "body": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--" + }, + "responses": { + "200": { + "type": "string", + "example": "plain text when requesting text, srt, or vtt" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_text.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_text.yaml new file mode 100644 index 000000000000..36014d364055 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_text.yaml @@ -0,0 +1,19 @@ +parameters: + api-version: 2024-09-01-preview + body: '---multipart-boundary + + Content-Disposition: form-data; name="file"; filename="file.wav" + + Content-Type: application/octet-stream + + + RIFF..audio.data.omitted + + ---multipart-boundary--' + deployment-id: <deployment-id> + endpoint: "{endpoint}" +responses: + "200": + example: plain text when requesting text, srt, or vtt + type: string +title: Gets transcribed text and associated metadata from provided spoken audio data. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_object.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_object.json new file mode 100644 index 000000000000..f45df5a88426 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_object.json @@ -0,0 +1,16 @@ +{ + "title": "Gets English language transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>", + "body": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--" + }, + "responses": { + "200": { + "body": { + "text": "A structured object when requesting json or verbose_json" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_object.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_object.yaml new file mode 100644 index 000000000000..43b372977f87 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_object.yaml @@ -0,0 +1,21 @@ +parameters: + api-version: 2024-09-01-preview + body: '---multipart-boundary + + Content-Disposition: form-data; name="file"; filename="file.wav" + + Content-Type: application/octet-stream + + + RIFF..audio.data.omitted + + ---multipart-boundary--' + deployment-id: <deployment-id> + endpoint: "{endpoint}" +responses: + "200": + body: + text: A structured object when requesting json or verbose_json +title: + Gets English language transcribed text and associated metadata from provided + spoken audio data. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_text.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_text.json new file mode 100644 index 000000000000..f4f07daf3b09 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_text.json @@ -0,0 +1,15 @@ +{ + "title": "Gets English language transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>", + "body": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--" + }, + "responses": { + "200": { + "type": "string", + "example": "plain text when requesting text, srt, or vtt" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_text.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_text.yaml new file mode 100644 index 000000000000..6420a78a029c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_text.yaml @@ -0,0 +1,21 @@ +parameters: + api-version: 2024-09-01-preview + body: '---multipart-boundary + + Content-Disposition: form-data; name="file"; filename="file.wav" + + Content-Type: application/octet-stream + + + RIFF..audio.data.omitted + + ---multipart-boundary--' + deployment-id: <deployment-id> + endpoint: "{endpoint}" +responses: + "200": + example: plain text when requesting text, srt, or vtt + type: string +title: + Gets English language transcribed text and associated metadata from provided + spoken audio data. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_run.json new file mode 100644 index 000000000000..93d353499279 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_run.json @@ -0,0 +1,46 @@ +{ + "title": "Cancels a run that is `in_progress`.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_abc123", + "run_id": "run_abc123" + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699076126, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "cancelling", + "started_at": 1699076126, + "expires_at": 1699076726, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": "You summarize books.", + "tools": [ + { + "type": "file_search" + } + ], + "tool_resources": { + "file_search": { + "vector_store_ids": [ + "vs_123" + ] + } + }, + "metadata": {}, + "usage": null, + "temperature": 1.0, + "top_p": 1.0, + "response_format": "auto" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_run.yaml new file mode 100644 index 000000000000..9d04a369faaf --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_run.yaml @@ -0,0 +1,35 @@ +title: | + Cancels a run that is `in_progress`. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_abc123 + run_id: run_abc123 +responses: + "200": + body: + id: run_abc123 + object: thread.run + created_at: 1699076126 + assistant_id: asst_abc123 + thread_id: thread_abc123 + status: cancelling + started_at: 1699076126 + expires_at: 1699076726 + cancelled_at: null + failed_at: null + completed_at: null + last_error: null + model: gpt-4-turbo + instructions: You summarize books. + tools: + - type: file_search + tool_resources: + file_search: + vector_store_ids: + - vs_123 + metadata: {} + usage: null + temperature: 1 + top_p: 1 + response_format: auto diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_vector_store_file_batch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_vector_store_file_batch.json new file mode 100644 index 000000000000..f0227f1667c0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_vector_store_file_batch.json @@ -0,0 +1,27 @@ +{ + "title": "Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "vector_store_id": "vs_abc123", + "batch_id": "vsfb_abc123" + }, + "responses": { + "200": { + "body": { + "id": "vsfb_abc123", + "object": "vector_store.file_batch", + "created_at": 1699061776, + "vector_store_id": "vs_abc123", + "status": "cancelling", + "file_counts": { + "in_progress": 12, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 15 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_vector_store_file_batch.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_vector_store_file_batch.yaml new file mode 100644 index 000000000000..d08cc5ccb9e2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_vector_store_file_batch.yaml @@ -0,0 +1,20 @@ +title: Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + vector_store_id: vs_abc123 + batch_id: vsfb_abc123 +responses: + "200": + body: + id: vsfb_abc123 + object: vector_store.file_batch + created_at: 1699061776 + vector_store_id: vs_abc123 + status: cancelling + file_counts: + in_progress: 12 + completed: 3 + failed: 0 + cancelled: 0 + total: 15 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions.json new file mode 100644 index 000000000000..39307e5a4d61 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions.json @@ -0,0 +1,43 @@ +{ + "title": "Creates a completion for the provided prompt, parameters and chosen model.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>", + "body": { + "messages": [ + { + "role": "system", + "content": "you are a helpful assistant that talks like a pirate" + }, + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!" + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions.yaml new file mode 100644 index 000000000000..85de47e7dd33 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions.yaml @@ -0,0 +1,45 @@ +title: Creates a completion for the provided prompt, parameters and chosen model. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + deployment-id: <deployment-id> + body: + messages: + - role: system + content: you are a helpful assistant that talks like a pirate + - role: user + content: can you tell me how to care for a parrot? +responses: + "200": + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: |- + Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy: + + 1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr! + + 2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh! + + 3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands! + + 4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh! + + 5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr! + + 6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag! + + 7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be. + + 8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners. + + So there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' "Yo-ho-ho" for many years to come! Good luck, sailor, and may the wind be at yer back! + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_advanced.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_advanced.json new file mode 100644 index 000000000000..f765e5a468d3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_advanced.json @@ -0,0 +1,96 @@ +{ + "title": "Creates a completion based on Azure Search vector data, previous assistant message and user-assigned managed identity.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a cat?" + }, + { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "intent": "cat care" + } + }, + { + "role": "user", + "content": "how about dog?" + } + ], + "data_sources": [ + { + "type": "azure_search", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "authentication": { + "type": "user_assigned_managed_identity", + "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}" + }, + "index_name": "{index name}", + "query_type": "vector", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "in_scope": true, + "top_n_documents": 5, + "strictness": 3, + "role_information": "You are an AI assistant that helps people find information.", + "fields_mapping": { + "content_fields_separator": "\\n", + "content_fields": [ + "content" + ], + "filepath_field": "filepath", + "title_field": "title", + "url_field": "url", + "vector_fields": [ + "contentvector" + ] + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content 2.", + "title": "Citation Title 2", + "filepath": "contoso2.txt", + "url": "https://contoso.blob.windows.net/container/contoso2.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_advanced.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_advanced.yaml new file mode 100644 index 000000000000..1bc8bcc445cc --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_advanced.yaml @@ -0,0 +1,63 @@ +title: Creates a completion based on Azure Search vector data, previous assistant message and user-assigned managed identity. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + deployment-id: <deployment-id> + body: + messages: + - role: user + content: can you tell me how to care for a cat? + - role: assistant + content: Content of the completion [doc1]. + context: + intent: cat care + - role: user + content: how about dog? + data_sources: + - type: azure_search + parameters: + endpoint: https://your-search-endpoint.search.windows.net/ + authentication: + type: user_assigned_managed_identity + managed_identity_resource_id: /subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name} + index_name: "{index name}" + query_type: vector + embedding_dependency: + type: deployment_name + deployment_name: "{embedding deployment name}" + in_scope: true + top_n_documents: 5 + strictness: 3 + role_information: You are an AI assistant that helps people find information. + fields_mapping: + content_fields_separator: \n + content_fields: + - content + filepath_field: filepath + title_field: title + url_field: url + vector_fields: + - contentvector +responses: + "200": + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content 2. + title: Citation Title 2 + filepath: contoso2.txt + url: https://contoso.blob.windows.net/container/contoso2.txt + chunk_id: "0" + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_image_vector.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_image_vector.json new file mode 100644 index 000000000000..ca5d71a0f222 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_image_vector.json @@ -0,0 +1,58 @@ +{ + "title": "Creates a completion based on Azure Search image vector data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a dog?" + } + ], + "data_sources": [ + { + "type": "azure_search", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "index_name": "{index name}", + "query_type": "vector", + "fields_mapping": { + "image_vector_fields": [ + "image_vector" + ] + }, + "authentication": { + "type": "api_key", + "key": "{api key}" + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion." + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_image_vector.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_image_vector.yaml new file mode 100644 index 000000000000..e57b8737b194 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_image_vector.yaml @@ -0,0 +1,36 @@ +title: Creates a completion based on Azure Search image vector data. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + deployment-id: <deployment-id> + body: + messages: + - role: user + content: can you tell me how to care for a dog? + data_sources: + - type: azure_search + parameters: + endpoint: https://your-search-endpoint.search.windows.net/ + index_name: "{index name}" + query_type: vector + fields_mapping: + image_vector_fields: + - image_vector + authentication: + type: api_key + key: "{api key}" +responses: + "200": + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion. + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_minimum.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_minimum.json new file mode 100644 index 000000000000..b4a93aa803dc --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_minimum.json @@ -0,0 +1,63 @@ +{ + "title": "Creates a completion based on Azure Search data and system-assigned managed identity.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a dog?" + } + ], + "data_sources": [ + { + "type": "azure_search", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "index_name": "{index name}", + "authentication": { + "type": "system_assigned_managed_identity" + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content.", + "title": "Citation Title", + "filepath": "contoso.txt", + "url": "https://contoso.blob.windows.net/container/contoso.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_minimum.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_minimum.yaml new file mode 100644 index 000000000000..c11f7641c5bd --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_minimum.yaml @@ -0,0 +1,39 @@ +title: Creates a completion based on Azure Search data and system-assigned managed identity. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + deployment-id: <deployment-id> + body: + messages: + - role: user + content: can you tell me how to care for a dog? + data_sources: + - type: azure_search + parameters: + endpoint: https://your-search-endpoint.search.windows.net/ + index_name: "{index name}" + authentication: + type: system_assigned_managed_identity +responses: + "200": + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content. + title: Citation Title + filepath: contoso.txt + url: https://contoso.blob.windows.net/container/contoso.txt + chunk_id: "0" + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_cosmos_db.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_cosmos_db.json new file mode 100644 index 000000000000..782d5c005578 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_cosmos_db.json @@ -0,0 +1,77 @@ +{ + "title": "Creates a completion for the provided Azure Cosmos DB.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a dog?" + } + ], + "data_sources": [ + { + "type": "azure_cosmos_db", + "parameters": { + "authentication": { + "type": "connection_string", + "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000" + }, + "database_name": "vectordb", + "container_name": "azuredocs", + "index_name": "azuredocindex", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "fields_mapping": { + "content_fields": [ + "content" + ], + "vector_fields": [ + "contentvector" + ] + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content.", + "title": "Citation Title", + "filepath": "contoso.txt", + "url": "https://contoso.blob.windows.net/container/contoso.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_cosmos_db.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_cosmos_db.yaml new file mode 100644 index 000000000000..8db15e42d918 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_cosmos_db.yaml @@ -0,0 +1,49 @@ +title: Creates a completion for the provided Azure Cosmos DB. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + deployment-id: <deployment-id> + body: + messages: + - role: user + content: can you tell me how to care for a dog? + data_sources: + - type: azure_cosmos_db + parameters: + authentication: + type: connection_string + connection_string: mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000 + database_name: vectordb + container_name: azuredocs + index_name: azuredocindex + embedding_dependency: + type: deployment_name + deployment_name: "{embedding deployment name}" + fields_mapping: + content_fields: + - content + vector_fields: + - contentvector +responses: + "200": + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content. + title: Citation Title + filepath: contoso.txt + url: https://contoso.blob.windows.net/container/contoso.txt + chunk_id: "0" + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_elasticsearch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_elasticsearch.json new file mode 100644 index 000000000000..0599afa0e10b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_elasticsearch.json @@ -0,0 +1,65 @@ +{ + "title": "Creates a completion for the provided Elasticsearch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a dog?" + } + ], + "data_sources": [ + { + "type": "elasticsearch", + "parameters": { + "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io", + "index_name": "{index name}", + "authentication": { + "type": "key_and_key_id", + "key": "{key}", + "key_id": "{key id}" + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content.", + "title": "Citation Title", + "filepath": "contoso.txt", + "url": "https://contoso.blob.windows.net/container/contoso.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_elasticsearch.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_elasticsearch.yaml new file mode 100644 index 000000000000..8bbf671e3349 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_elasticsearch.yaml @@ -0,0 +1,41 @@ +title: Creates a completion for the provided Elasticsearch. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + deployment-id: <deployment-id> + body: + messages: + - role: user + content: can you tell me how to care for a dog? + data_sources: + - type: elasticsearch + parameters: + endpoint: https://your-elasticsearch-endpoint.eastus.azurecontainer.io + index_name: "{index name}" + authentication: + type: key_and_key_id + key: "{key}" + key_id: "{key id}" +responses: + "200": + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content. + title: Citation Title + filepath: contoso.txt + url: https://contoso.blob.windows.net/container/contoso.txt + chunk_id: "0" + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_mongo_db.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_mongo_db.json new file mode 100644 index 000000000000..9b68418a4602 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_mongo_db.json @@ -0,0 +1,80 @@ +{ + "title": "Creates a completion for the provided Mongo DB.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a dog?" + } + ], + "data_sources": [ + { + "type": "mongo_db", + "parameters": { + "authentication": { + "type": "username_and_password", + "username": "<username>", + "password": "<password>" + }, + "endpoint": "<endpoint_name>", + "app_name": "<application name>", + "database_name": "sampledb", + "collection_name": "samplecollection", + "index_name": "sampleindex", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "fields_mapping": { + "content_fields": [ + "content" + ], + "vector_fields": [ + "contentvector" + ] + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content.", + "title": "Citation Title", + "filepath": "contoso.txt", + "url": "https://contoso.blob.windows.net/container/contoso.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_mongo_db.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_mongo_db.yaml new file mode 100644 index 000000000000..de0316d20c32 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_mongo_db.yaml @@ -0,0 +1,52 @@ +title: Creates a completion for the provided Azure Cosmos DB. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + deployment-id: <deployment-id> + body: + messages: + - role: user + content: can you tell me how to care for a dog? + data_sources: + - type: mongo_db + parameters: + authentication: + type: username_and_password + username: <username> + password: <password> + endpoint: <endpoint_name> + app_name: <application name> + database_name: sampledb + collection_name: samplecollection + index_name: azuredocindex + embedding_dependency: + type: deployment_name + deployment_name: "{embedding deployment name}" + fields_mapping: + content_fields: + - content + vector_fields: + - contentvector +responses: + "200": + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content. + title: Citation Title + filepath: contoso.txt + url: https://contoso.blob.windows.net/container/contoso.txt + chunk_id: "0" + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_pinecone.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_pinecone.json new file mode 100644 index 000000000000..eae9d2f987b4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_pinecone.json @@ -0,0 +1,77 @@ +{ + "title": "Creates a completion for the provided Pinecone resource.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a dog?" + } + ], + "data_sources": [ + { + "type": "pinecone", + "parameters": { + "authentication": { + "type": "api_key", + "key": "{api key}" + }, + "environment": "{environment name}", + "index_name": "{index name}", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "fields_mapping": { + "title_field": "title", + "url_field": "url", + "filepath_field": "filepath", + "content_fields": [ + "content" + ], + "content_fields_separator": "\n" + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content.", + "title": "Citation Title", + "filepath": "contoso.txt", + "url": "https://contoso.blob.windows.net/container/contoso.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_pinecone.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_pinecone.yaml new file mode 100644 index 000000000000..f23fdc61cc7a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_pinecone.yaml @@ -0,0 +1,51 @@ +title: Creates a completion for the provided Pinecone resource. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + deployment-id: <deployment-id> + body: + messages: + - role: user + content: can you tell me how to care for a dog? + data_sources: + - type: pinecone + parameters: + authentication: + type: api_key + key: "{api key}" + environment: "{environment name}" + index_name: "{index name}" + embedding_dependency: + type: deployment_name + deployment_name: "{embedding deployment name}" + fields_mapping: + title_field: title + url_field: url + filepath_field: filepath + content_fields: + - content + content_fields_separator: |+ + +responses: + "200": + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content. + title: Citation Title + filepath: contoso.txt + url: https://contoso.blob.windows.net/container/contoso.txt + chunk_id: "0" + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/completions.json new file mode 100644 index 000000000000..172e3e75914c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/completions.json @@ -0,0 +1,38 @@ +{ + "operationId": "GetCompletions", + "title": "Creates a completion for the provided prompt, parameters and chosen model.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>", + "body": { + "prompt": [ + "tell me a joke about mango" + ], + "max_tokens": 32, + "temperature": 1.0, + "n": 1 + } + }, + "responses": { + "200": { + "body": { + "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq", + "created": 1686617332, + "choices": [ + { + "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.", + "index": 0, + "finish_reason": "stop", + "logprobs": null + } + ], + "usage": { + "completion_tokens": 20, + "prompt_tokens": 6, + "total_tokens": 26 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_assistant.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_assistant.json new file mode 100644 index 000000000000..35a5010c75cc --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_assistant.json @@ -0,0 +1,39 @@ +{ + "title": "Create an assistant with a model and instructions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "body": { + "name": "Math Tutor", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "model": "gpt-4-1106-preview" + } + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant", + "created_at": 1707295707, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_assistant.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_assistant.yaml new file mode 100644 index 000000000000..56b1e0710802 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_assistant.yaml @@ -0,0 +1,26 @@ +title: Create an assistant with a model and instructions. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + body: + name: Math Tutor + instructions: When a customer asks about a specific math problem, use Python to evaluate their query. + tools: + - type: code_interpreter + model: gpt-4-1106-preview +responses: + "200": + body: + id: asst_4nsG2qgNzimRPE7MazXTXbU7 + object: assistant + created_at: 1707295707 + name: Math Tutor + description: null + model: gpt-4-1106-preview + instructions: When a customer asks about a specific math problem, use Python to evaluate their query. + tools: + - type: code_interpreter + metadata: {} + top_p: 1 + temperature: 1 + response_format: auto diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_message.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_message.json new file mode 100644 index 000000000000..5eae7c600986 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_message.json @@ -0,0 +1,36 @@ +{ + "title": "Create a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "role": "user", + "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces." + } + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "assistant_id": null, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "attachments": [], + "metadata": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_message.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_message.yaml new file mode 100644 index 000000000000..b0c285823053 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_message.yaml @@ -0,0 +1,25 @@ +title: Create a message. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_v7V4csrNOxtNmgcwGg496Smx + body: + role: user + content: What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces. +responses: + "200": + body: + id: msg_as3XIk1tpVP3hdHjWBGg3uG4 + object: thread.message + created_at: 1707298421 + assistant_id: null + thread_id: thread_v7V4csrNOxtNmgcwGg496Smx + run_id: null + role: user + content: + - type: text + text: + value: What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces. + annotations: [] + attachments: [] + metadata: {} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_run.json new file mode 100644 index 000000000000..51832c964c5f --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_run.json @@ -0,0 +1,49 @@ +{ + "title": "Create a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_abc123", + "body": { + "assistant_id": "asst_abc123" + } + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699063290, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "queued", + "started_at": 1699063290, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699063291, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {}, + "usage": null, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_run.yaml new file mode 100644 index 000000000000..e2ed5925c8fc --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_run.yaml @@ -0,0 +1,38 @@ +title: Create a run. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_abc123 + body: + assistant_id: asst_abc123 +responses: + "200": + body: + id: run_abc123 + object: thread.run + created_at: 1699063290 + assistant_id: asst_abc123 + thread_id: thread_abc123 + status: queued + started_at: 1699063290 + expires_at: null + cancelled_at: null + failed_at: null + completed_at: 1699063291 + last_error: null + model: gpt-4-turbo + instructions: null + incomplete_details: null + tools: + - type: code_interpreter + metadata: {} + usage: null + temperature: 1 + top_p: 1 + max_prompt_tokens: 1000 + max_completion_tokens: 1000 + truncation_strategy: + type: auto + last_messages: null + response_format: auto + tool_choice: auto diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread.json new file mode 100644 index 000000000000..8ac7dd7f5f4d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread.json @@ -0,0 +1,17 @@ +{ + "title": "Creates a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread.yaml new file mode 100644 index 000000000000..c2c590df98e8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread.yaml @@ -0,0 +1,11 @@ +title: Creates a thread. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview +responses: + "200": + body: + id: thread_v7V4csrNOxtNmgcwGg496Smx + object: thread + created_at: 1707297136 + metadata: {} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread_and_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread_and_run.json new file mode 100644 index 000000000000..ed6dbfcdac95 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread_and_run.json @@ -0,0 +1,54 @@ +{ + "title": "Create a thread and run it in one request.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "body": { + "assistant_id": "asst_abc123", + "thread": { + "messages": [ + { + "role": "user", + "content": "Explain deep learning to a 5 year old." + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699076792, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "queued", + "started_at": null, + "expires_at": 1699077392, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "required_action": null, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": "You are a helpful assistant.", + "tools": [], + "tool_resources": {}, + "metadata": {}, + "temperature": 1.0, + "top_p": 1.0, + "max_completion_tokens": null, + "max_prompt_tokens": null, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "incomplete_details": null, + "usage": null, + "response_format": "auto", + "tool_choice": "auto" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread_and_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread_and_run.yaml new file mode 100644 index 000000000000..9c87c3103b4b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread_and_run.yaml @@ -0,0 +1,42 @@ +title: Create a thread and run it in one request. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + body: + assistant_id: asst_abc123 + thread: + messages: + - role: user + content: Explain deep learning to a 5 year old. +responses: + "200": + body: + id: run_abc123 + object: thread.run + created_at: 1699076792 + assistant_id: asst_abc123 + thread_id: thread_abc123 + status: queued + started_at: null + expires_at: 1699077392 + cancelled_at: null + failed_at: null + completed_at: null + required_action: null + last_error: null + model: gpt-4-turbo + instructions: You are a helpful assistant. + tools: [] + tool_resources: {} + metadata: {} + temperature: 1 + top_p: 1 + max_completion_tokens: null + max_prompt_tokens: null + truncation_strategy: + type: auto + last_messages: null + incomplete_details: null + usage: null + response_format: auto + tool_choice: auto diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store.json new file mode 100644 index 000000000000..9536d5d35e5a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store.json @@ -0,0 +1,28 @@ +{ + "title": "Creates a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview" + }, + "body": { + "name": "Support FAQ" + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "bytes": 139920, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store.yaml new file mode 100644 index 000000000000..dd05ea8ef7bb --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store.yaml @@ -0,0 +1,20 @@ +title: Creates a vector store. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview +body: + name: Support FAQ +responses: + "200": + body: + id: vs_abc123 + object: vector_store + created_at: 1699061776 + name: Support FAQ + bytes: 139920 + file_counts: + in_progress: 0 + completed: 3 + failed: 0 + cancelled: 0 + total: 3 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file.json new file mode 100644 index 000000000000..7714990c5427 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file.json @@ -0,0 +1,24 @@ +{ + "title": "Create a vector store file by attaching a File to a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "vector_store_id": "vs_abc123", + "body": { + "file_id": "file-abc123" + } + }, + "responses": { + "200": { + "body": { + "id": "file-abc123", + "object": "vector_store.file", + "created_at": 1699061776, + "usage_bytes": 1234, + "vector_store_id": "vs_abcd", + "status": "completed", + "last_error": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file.yaml new file mode 100644 index 000000000000..428a67027d7c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file.yaml @@ -0,0 +1,17 @@ +title: Create a vector store file by attaching a File to a vector store. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + vector_store_id: vs_abc123 + body: + file_id: file-abc123 +responses: + "200": + body: + id: file-abc123 + object: vector_store.file + created_at: 1699061776 + usage_bytes: 1234 + vector_store_id: vs_abcd + status: completed + last_error: null diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file_batch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file_batch.json new file mode 100644 index 000000000000..1fc5b139ef15 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file_batch.json @@ -0,0 +1,30 @@ +{ + "title": "Create a vector store file batch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "vector_store_id": "vs_abc123", + "body": { + "file_ids": [ + "file-abc123", + "file-abc456" + ] + } + }, + "responses": { + "200": { + "id": "vsfb_abc123", + "object": "vector_store.file_batch", + "created_at": 1699061776, + "vector_store_id": "vs_abc123", + "status": "in_progress", + "file_counts": { + "in_progress": 1, + "completed": 1, + "failed": 0, + "cancelled": 0, + "total": 0 + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file_batch.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file_batch.yaml new file mode 100644 index 000000000000..e426327e81f6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file_batch.yaml @@ -0,0 +1,22 @@ +title: Create a vector store file batch. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + vector_store_id: vs_abc123 + body: + file_ids: + - file-abc123 + - file-abc456 +responses: + "200": + id: vsfb_abc123 + object: vector_store.file_batch + created_at: 1699061776 + vector_store_id: vs_abc123 + status: in_progress + file_counts: + in_progress: 1 + completed: 1 + failed: 0 + cancelled: 0 + total: 0 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant.json new file mode 100644 index 000000000000..a9dca4a44596 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant.json @@ -0,0 +1,17 @@ +{ + "title": "Deletes an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "assistant_id": "asst_4nsG2qgNzimRPE7MazXTXbU7" + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant.deleted", + "deleted": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant.yaml new file mode 100644 index 000000000000..132248140a66 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant.yaml @@ -0,0 +1,11 @@ +title: Deletes an assistant. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + assistant_id: asst_4nsG2qgNzimRPE7MazXTXbU7 +responses: + "200": + body: + id: asst_4nsG2qgNzimRPE7MazXTXbU7 + object: assistant.deleted + deleted: true diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant_file.json new file mode 100644 index 000000000000..2b1f26c90adb --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant_file.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes an AssistantFile.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA", + "file_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX" + }, + "responses": { + "200": { + "body": { + "id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "object": "assistant.file.deleted", + "deleted": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant_file.yaml new file mode 100644 index 000000000000..3591f15eb295 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant_file.yaml @@ -0,0 +1,12 @@ +title: Deletes an AssistantFile. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + assistant_id: asst_diz3BOIsXHMnqNnoMCyO9jlA + file_id: assistant-Vau3gDQ1MfiBJk4flihOxwZX +responses: + "200": + body: + id: assistant-Vau3gDQ1MfiBJk4flihOxwZX + object: assistant.file.deleted + deleted: true diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_message.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_message.json new file mode 100644 index 000000000000..b181429b000c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_message.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_abc123", + "message_id": "msg_abc123" + }, + "responses": { + "200": { + "body": { + "id": "msg_abc123", + "object": "thread.message.deleted", + "deleted": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_message.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_message.yaml new file mode 100644 index 000000000000..abfb0cd7d0fd --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_message.yaml @@ -0,0 +1,12 @@ +title: Deletes a message. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_abc123 + message_id: msg_abc123 +responses: + "200": + body: + id: msg_abc123 + object: thread.message.deleted + deleted: true diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_thread.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_thread.json new file mode 100644 index 000000000000..bc92b99f37fd --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_thread.json @@ -0,0 +1,17 @@ +{ + "title": "Deletes a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread.deleted", + "deleted": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_thread.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_thread.yaml new file mode 100644 index 000000000000..461e16ba52eb --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_thread.yaml @@ -0,0 +1,11 @@ +title: Deletes a thread. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_v7V4csrNOxtNmgcwGg496Smx +responses: + "200": + body: + id: thread_v7V4csrNOxtNmgcwGg496Smx + object: thread.deleted + deleted: true diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store.json new file mode 100644 index 000000000000..3b74d2e2cf8b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store.json @@ -0,0 +1,17 @@ +{ + "title": "Deletes a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "vector_store_id": "vs_abc123 " + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store.deleted", + "deleted": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store.yaml new file mode 100644 index 000000000000..c086c5296c97 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store.yaml @@ -0,0 +1,11 @@ +title: Deletes a vector store. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + vector_store_id: "vs_abc123 " +responses: + "200": + body: + id: vs_abc123 + object: vector_store.deleted + deleted: true diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store_file.json new file mode 100644 index 000000000000..d6ca3ba89746 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store_file.json @@ -0,0 +1,18 @@ +{ + "title": "Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file endpoint.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "vector_store_id": "vs_abc123", + "file_id": "file_abc123" + }, + "responses": { + "200": { + "body": { + "id": "file_abc123", + "object": "vector_store.file.deleted", + "deleted": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store_file.yaml new file mode 100644 index 000000000000..c33582ba3789 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store_file.yaml @@ -0,0 +1,12 @@ +title: Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file endpoint. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + vector_store_id: vs_abc123 + file_id: file_abc123 +responses: + "200": + body: + id: file_abc123 + object: vector_store.file.deleted + deleted: true diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/embeddings.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/embeddings.json new file mode 100644 index 000000000000..8f130c7d218e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/embeddings.json @@ -0,0 +1,1566 @@ +{ + "title": "Return the embeddings for a given prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "deployment-afa0669ca01e4693ae3a93baf40f26d6", + "body": { + "input": [ + "this is a test" + ] + } + }, + "responses": { + "200": { + "body": { + "data": [ + { + "index": 0, + "embedding": [ + -0.012838088, + -0.007421397, + -0.017617522, + -0.028278312, + -0.018666342, + 0.01737855, + -0.01821495, + -0.006950092, + -0.009937238, + -0.038580645, + 0.010674067, + 0.02412286, + -0.013647936, + 0.013189907, + 0.0021125758, + 0.012406612, + 0.020790534, + 0.00074595667, + 0.008397198, + -0.00535031, + 0.008968075, + 0.014351576, + -0.014086051, + 0.015055214, + -0.022211088, + -0.025198232, + 0.0065186154, + -0.036350243, + 0.009180495, + -0.009698266, + 0.009446018, + -0.008463579, + -0.0040426035, + -0.03443847, + -0.00091273896, + -0.0019217303, + 0.002349888, + -0.021560553, + 0.016515596, + -0.015572986, + 0.0038666942, + -0.00008432463, + 0.0032178196, + -0.020365695, + -0.009631885, + -0.007647093, + 0.0033837722, + -0.026764825, + -0.010501476, + 0.020219658, + 0.024640633, + -0.0066912062, + -0.036456455, + -0.0040923897, + -0.013966565, + 0.017816665, + 0.005366905, + 0.022835068, + 0.0103488, + -0.0010811808, + -0.028942121, + 0.0074280356, + -0.017033368, + 0.0074877786, + 0.021640211, + 0.002499245, + 0.013316032, + 0.0021524043, + 0.010129742, + 0.0054731146, + 0.03143805, + 0.014856071, + 0.0023366117, + -0.0008243692, + 0.022781964, + 0.003038591, + -0.017617522, + 0.0013309394, + 0.0022154662, + 0.00097414135, + 0.012041516, + -0.027906578, + -0.023817508, + 0.013302756, + -0.003003741, + -0.006890349, + 0.0016744611, + 0.023658194, + -0.015851786, + -0.0045305043, + -0.003038591, + 0.017710455, + 0.019237218, + 0.016037652, + -0.022503164, + 0.025795663, + -0.001129307, + 0.032500144, + -0.008178141, + -0.019940857, + -0.009877495, + 0.00018918588, + 0.023060765, + -0.005692172, + -0.018347712, + -0.011039163, + -0.0062066247, + -0.0000524047, + 0.020126723, + -0.0011691356, + -0.015811957, + 0.020086896, + -0.009114114, + -0.03056182, + 0.0029025099, + -0.006591635, + -0.014046223, + -0.01590489, + -0.02307404, + -0.008861865, + -0.004832538, + 0.010030171, + 0.02311387, + -0.012652221, + 0.024906157, + 0.003860056, + -0.01936998, + -0.02957938, + -0.008357369, + -0.0016371218, + 0.027800368, + 0.0077333883, + 0.021626934, + 0.02140124, + -0.030482162, + 0.026406368, + -0.008277712, + 0.012884554, + -0.043784916, + -0.0145639945, + -0.0070297495, + 0.034889862, + -0.00041508878, + -0.010528029, + -0.009572142, + 0.015692472, + 0.037810627, + -0.0022021902, + 0.008662722, + -0.016794397, + 0.0003090866, + -0.0060506295, + 0.015227805, + 0.0006650548, + 0.01842737, + 0.036801632, + -0.002461076, + -0.0029390194, + -0.0057120863, + -0.012486269, + -0.0046831807, + -0.0017474802, + -0.0036210844, + -0.01178263, + 0.017869769, + 0.039111692, + 0.010946229, + 0.018467197, + 0.0027780454, + -0.005851486, + -0.016489044, + 0.03186289, + -0.040333103, + 0.016648358, + -0.006870435, + 0.0072687212, + 0.000002370982, + 0.006465511, + -0.018201673, + -0.00020526254, + -0.025410652, + 0.02010017, + 0.017537864, + 0.022821793, + 0.0064555537, + -0.0012969191, + 0.02157383, + -0.0053536287, + -0.0087622935, + -0.010952868, + 0.017564416, + 0.02185263, + 0.0004733796, + 0.0018337755, + -0.6954606, + -0.011231667, + 0.02748174, + 0.003929756, + 0.0144843375, + 0.045192193, + 0.01898497, + -0.0070363875, + -0.007813046, + 0.017604245, + -0.017790113, + 0.011165286, + -0.0036376796, + -0.014736585, + 0.0016421003, + -0.019144284, + -0.0072222543, + -0.023127146, + 0.006936816, + 0.025198232, + 0.0030219958, + 0.011722887, + -0.004271618, + -0.0011127117, + -0.0051047, + 0.00077333883, + 0.018599961, + 0.0074877786, + 0.010820106, + 0.0033406245, + -0.015055214, + 0.02384406, + 0.006090458, + 0.00891497, + 0.023366116, + -0.011078991, + -0.019582398, + 0.0011566891, + 0.015413672, + 0.01793615, + -0.014736585, + 0.002492607, + 0.027800368, + 0.023923717, + -0.007421397, + 0.0016105693, + 0.011337877, + -0.015041938, + -0.008768932, + -0.003982861, + 0.002884255, + -0.007832959, + 0.0025457118, + -0.0023548664, + -0.0061767534, + -0.016754568, + 0.0006036523, + 0.0105346665, + 0.0055361767, + 0.01478969, + -0.0011251582, + 0.009605332, + -0.0037140178, + -0.017537864, + -0.021733144, + 0.012897831, + -0.024481317, + 0.022290744, + 0.0056523434, + -0.005366905, + 0.0020412162, + 0.013435517, + -0.003408665, + -0.01705992, + 0.029446619, + 0.022011945, + 0.009226961, + -0.003310753, + -0.007939169, + 0.021308305, + 0.0026718357, + 0.002129171, + -0.020047067, + -0.007474502, + 0.021534001, + -0.0110590765, + -0.018374264, + -0.001664504, + -0.003923118, + 0.015387119, + 0.025516862, + 0.0016421003, + -0.017498035, + -0.01825478, + 0.01451089, + -0.008198055, + -0.011656506, + 0.0044242945, + 0.031491153, + 0.01017621, + -0.010408543, + -0.009034456, + -0.0023283141, + 0.012021601, + 0.015639367, + 0.011736163, + 0.007912617, + 0.02031259, + 0.022104878, + -0.02241023, + 0.00041156227, + -0.009817752, + -0.030880447, + -0.0017823302, + 0.0030933553, + -0.04128899, + -0.0007783174, + 0.012393335, + 0.0122273825, + -0.009087561, + 0.022728859, + -0.002884255, + 0.028065892, + 0.0047396044, + 0.008065294, + 0.015519881, + 0.0133956885, + -0.02279524, + -0.011729525, + 0.0037206558, + -0.0046732235, + 0.003587894, + 0.024401661, + -0.013574918, + 0.012685412, + -0.0041620894, + 0.020578114, + 0.007394845, + 0.014139156, + -0.012512821, + -0.021042781, + 0.022423506, + -0.015360567, + 0.004009413, + 0.0104550095, + -0.024799947, + -0.0081449505, + -0.00063850236, + 0.0070231115, + -0.0009633545, + -0.015705748, + -0.0028942123, + -0.008815398, + 0.007461226, + -0.014417957, + -0.012931022, + 0.0015674217, + -0.02506547, + -0.0063128346, + -0.013422241, + -0.0058614435, + -0.0006007482, + -0.015002109, + 0.0037040606, + -0.008410474, + -0.0016089098, + -0.018653065, + 0.020538285, + -0.016980262, + -0.042244878, + -0.017498035, + 0.006727716, + -0.01877255, + 0.008987989, + 0.00077665783, + -0.0007119364, + -0.0067243967, + 0.0038467797, + -0.018055636, + -0.01440468, + 0.007534245, + 0.0051212953, + 0.002741536, + 0.011523744, + -0.0018603279, + 0.023684746, + 0.016196968, + 0.01731217, + -0.01992758, + 0.009372999, + -0.01982137, + 0.001150051, + -0.014417957, + 0.005672258, + -0.015785405, + 0.0049387473, + -0.0051445286, + 0.012632307, + 0.0011666464, + 0.024587527, + 0.04259006, + -0.0025672857, + 0.02311387, + -0.014524166, + 0.0013848739, + -0.04105002, + -0.010089914, + -0.009087561, + 0.015440224, + 0.009207047, + 0.0128048975, + -0.030216638, + -0.02549031, + 0.00499849, + 0.02737553, + 0.024985814, + -0.015055214, + 0.007580712, + -0.003979542, + 0.0016304837, + 0.0010446712, + 0.0033373055, + 0.0066314633, + -0.011948583, + -0.021281753, + 0.012161002, + 0.030747686, + 0.03555367, + 0.023751127, + -0.03159736, + -0.0110590765, + 0.015758853, + -0.0012197511, + -0.0023249951, + -0.0007488608, + 0.0074877786, + 0.01643594, + -0.008098484, + 0.03730613, + -0.0010056724, + -0.000034798173, + 0.011702972, + 0.039563086, + -0.012280487, + 0.027747264, + 0.018387541, + 0.033057746, + -0.004835857, + -0.00471969, + 0.025450481, + -0.0051146573, + 0.014603823, + 0.00022258384, + 0.00060863094, + 0.015665919, + -0.021626934, + -0.013674489, + 0.0062066247, + 0.018560132, + 0.031942543, + 0.012054792, + 0.004902238, + 0.0028510645, + -0.027667606, + 0.009817752, + -0.002580562, + 0.0069036256, + 0.020047067, + -0.009704905, + -0.012619031, + -0.0056755766, + -0.0036443176, + 0.019383255, + 0.0030701219, + 0.024972538, + 0.009100837, + 0.026353262, + 0.012758431, + 0.029074885, + 0.021202097, + -0.0038102702, + -0.032048754, + 0.003996137, + 0.0029738694, + 0.0032277768, + -0.026127568, + -0.02213143, + 0.0028742978, + 0.0010637557, + 0.000580419, + 0.0021789568, + 0.00083764544, + 0.026924139, + -0.03265946, + 0.0059211864, + 0.021892458, + 0.01178263, + 0.0018188398, + 0.009718181, + -0.020047067, + 0.017989255, + 0.0046035233, + -0.010561219, + -0.010342162, + 0.009505761, + -0.018334435, + -0.00667793, + -0.024534423, + 0.00035347888, + 0.00082561385, + -0.006143563, + 0.016820949, + -0.0013500239, + -0.0069832825, + 0.015347291, + -0.005094743, + 0.001838754, + 0.017073197, + 0.02521151, + 0.006209944, + -0.015612815, + -0.009744733, + -0.019794818, + 0.007786493, + 0.037624758, + 0.017564416, + 0.0076802834, + 0.0026203906, + 0.0022403593, + -0.024560975, + -0.04062518, + -0.016581977, + 0.00789934, + 0.0099305995, + 0.006996559, + 0.011078991, + 0.016236795, + -0.0068969876, + 0.01374087, + 0.014922452, + -0.0042882133, + 0.00022901449, + -0.0006692036, + 0.001359981, + -0.00007581957, + 0.0042616613, + 0.0066381013, + 0.012512821, + 0.021534001, + 0.0032775626, + 0.016913882, + -0.00789934, + -0.009200408, + -0.020286039, + -0.017033368, + 0.014378128, + 0.009233599, + 0.0070828544, + -0.013229736, + 0.025928425, + -0.011862287, + 0.008383922, + 0.012632307, + -0.0003097089, + 0.007593988, + 0.0059079104, + -0.0026369859, + -0.0262205, + 0.003335646, + -0.0067609064, + -0.0042882133, + 0.008549875, + -0.007600626, + -0.012592479, + 0.028623493, + -0.0030502076, + -0.006989921, + -0.015785405, + 0.010050085, + 0.016714739, + -0.023724575, + -0.006346025, + -0.014245366, + -0.032154962, + -0.03388087, + -0.024308728, + -0.002461076, + -0.003733932, + -0.02195884, + -0.021069333, + -0.022144707, + -0.007872788, + -0.017179407, + -0.009034456, + -0.010893124, + -0.02478667, + -0.020153277, + -0.023976821, + 0.014656927, + 0.0005368565, + -0.015878338, + 0.010123105, + -0.0030717815, + 0.01555971, + 0.0018321159, + -0.036244035, + 0.00017176087, + -0.013375774, + -0.010375353, + 0.026512576, + 0.016581977, + 0.013847079, + 0.015719024, + 0.013223098, + 0.004975257, + -0.0010579474, + -0.0034385365, + -0.029048331, + 0.017298892, + -0.022529716, + 0.008463579, + -0.014723309, + -0.005814977, + -0.009027818, + -0.009738095, + -0.0104682855, + -0.005044957, + 0.007905979, + 0.011656506, + 0.003153098, + -0.0005231654, + 0.019954132, + -0.021985391, + -0.005307162, + 0.0021839354, + -0.025184957, + 0.013926737, + -0.0059908866, + 0.0065717204, + 0.009884133, + -0.0062298584, + 0.03388087, + 0.0028577026, + -0.015931444, + 0.0010986058, + -0.025808938, + 0.0022835068, + 0.014152432, + 0.015227805, + 0.013701041, + -0.007872788, + -0.030614924, + -0.026393091, + 0.0010753724, + -0.016940435, + 0.013647936, + -0.007408121, + -0.024308728, + -0.031915992, + -0.018161846, + 0.00072521257, + 0.028862465, + 0.012234021, + -0.019555846, + -0.027641054, + -0.00082810316, + -0.0019150922, + -0.016276624, + -0.01125822, + -0.034146395, + -0.015294186, + 0.006671292, + -0.015533158, + 0.013674489, + -0.0011766035, + -0.017325444, + -0.023233354, + -0.013189907, + 0.0005580154, + -0.03188944, + -0.007056302, + -0.0059942054, + 0.03411984, + 0.04317421, + 0.029420065, + 0.006488744, + -0.0022436783, + 0.013063784, + 0.00012207884, + 0.008118398, + -0.023246631, + 0.0051909955, + -0.00894816, + 0.0081316745, + 0.0023200165, + 0.011510468, + -0.0005770999, + 0.00016979019, + 0.010129742, + 0.015506605, + -0.0073815687, + 0.0031995648, + -0.026578957, + -0.016674912, + 0.0049652997, + 0.0072687212, + -0.016568702, + -0.001964878, + -0.015692472, + -0.0048955996, + 0.027773816, + 0.012864641, + 0.01594472, + 0.008244522, + 0.017139578, + -0.01772373, + -0.0012521119, + 0.011689696, + 0.0111121815, + -0.0036476366, + 0.0012570905, + -0.007826322, + -0.016754568, + 0.011948583, + -0.0045968853, + 0.023963546, + -0.0052739717, + 0.014656927, + 0.009731457, + 0.010727172, + -0.01705992, + -0.0026071144, + 0.010760362, + 0.000919377, + -0.006365939, + -0.03013698, + -0.010554581, + -0.018613236, + 0.013886908, + 0.029420065, + -0.013030593, + 0.016860778, + -0.019237218, + -0.022118153, + 0.007919255, + -0.0004003605, + 0.046546366, + 0.01349526, + 0.006352663, + 0.014258642, + 0.0031813101, + -0.027017072, + 0.0070828544, + -0.020219658, + 0.0037140178, + 0.023366116, + 0.040386207, + -0.016382834, + -0.0023681426, + 0.0064522345, + 0.016528873, + 0.0006804054, + -0.02891557, + -0.0043545947, + 0.01101261, + -0.0014778073, + -0.018055636, + -0.0077001974, + -0.0358723, + 0.003373815, + -0.00071940426, + -0.011822458, + -0.024295451, + -0.009791199, + -0.026565682, + 0.020989677, + -0.035155386, + 0.01832116, + 0.014776413, + -0.028012788, + -0.007262083, + 0.0030402504, + -0.029446619, + 0.00010174965, + 0.009758009, + 0.03767786, + -0.0154535, + 0.009346447, + 0.016077481, + 0.0041189417, + -0.027800368, + 0.01720596, + -0.011158649, + 0.027800368, + -0.03003077, + -0.0072819972, + 0.0014296811, + 0.0145374425, + 0.0043280423, + -0.017086472, + -0.01611731, + -0.01258584, + -0.016927158, + 0.007607264, + 0.018825656, + 0.011331239, + -0.0057784673, + 0.001569911, + -0.013900184, + -0.014776413, + -0.0050814664, + -0.0012454737, + -0.0115967635, + -0.017458206, + -0.013203184, + -0.0063692583, + -0.01244644, + 0.011882202, + 0.0007708495, + -0.02035242, + 0.016250072, + 0.018414093, + -0.029526275, + 0.012751793, + -0.01555971, + 0.0013840442, + -0.019502742, + 0.0063758963, + 0.0037538463, + -0.035686433, + 0.027534844, + -0.016409386, + -0.03247359, + -0.008782208, + -0.0059842486, + 0.014338299, + 0.009233599, + -0.0053171194, + 0.006160158, + 0.0072952732, + 0.01401967, + 0.008815398, + -0.023790956, + 0.013096974, + -0.0031365028, + 0.005044957, + 0.0005356118, + -0.009379637, + 0.0066248253, + -0.00010724682, + 0.010289057, + 0.008815398, + -0.02279524, + -0.019701885, + -0.0027747264, + 0.016183691, + -0.014205537, + -0.003933075, + -0.013375774, + -0.005751915, + -0.010116466, + 0.004988533, + -0.005904591, + -0.008656085, + -0.017431654, + -0.011988411, + -0.01594472, + 0.00660823, + -0.027216217, + 0.0073218257, + -0.029977666, + -0.004593566, + -0.026671892, + -0.028517283, + -0.0050084474, + 0.009844304, + 0.025729282, + -0.013780698, + -0.026751548, + 0.004905557, + -0.035951957, + -0.026738273, + -0.019768266, + 0.0048690476, + 0.005250738, + 0.0014603822, + -0.018892037, + 0.017683903, + 0.0067177587, + 0.027694158, + -0.002618731, + -0.012419888, + 0.01772373, + -0.0032593077, + 0.006611549, + 0.016648358, + -0.03789028, + -0.023100592, + 0.023684746, + 0.0031248862, + 0.016382834, + 0.019967409, + -0.008941523, + -0.02014, + 0.0073882067, + 0.011357792, + -0.0031796505, + -0.0030253148, + -0.0010206081, + -0.017577693, + -0.009598695, + 0.002915786, + 0.001325131, + -0.0029207645, + -0.010780277, + -0.00325101, + -0.00811176, + -0.00073434, + -0.030083876, + -0.012864641, + -0.012745155, + -0.011769353, + 0.018785827, + -0.008264436, + -0.002675155, + 0.024255622, + 0.005483072, + -0.018480474, + -0.005426648, + 0.015095043, + 0.00044392303, + 0.011271496, + -0.0027548121, + 0.0026884312, + -0.00894816, + -0.015161424, + -0.014975557, + -0.024600804, + 0.004457485, + -0.015519881, + -0.012366783, + -0.012579202, + 0.01478969, + 0.0075541595, + -0.017962702, + -0.0017441611, + -0.014059499, + 0.005499667, + -0.0026884312, + 0.0031929268, + 0.0010853296, + -0.008045379, + 0.017471483, + 0.02590187, + -0.018546855, + -0.007826322, + 0.009333171, + 0.0157323, + 0.000086036016, + 0.004776114, + 0.22155327, + 0.006787459, + -0.0017823302, + 0.024919434, + 0.0023449094, + 0.03210186, + 0.0047329664, + -0.010879848, + 0.0044342517, + 0.015334014, + 0.029499723, + 0.019715162, + -0.008569789, + -0.0018901994, + -0.0077400263, + -0.019210665, + -0.005088105, + -0.023153698, + -0.032739118, + -0.029313855, + 0.00082146504, + -0.0212552, + 0.0044309325, + -0.005446562, + 0.018613236, + -0.009751371, + -0.013023955, + -0.001996409, + 0.01915756, + 0.017431654, + -0.031092867, + -0.0070231115, + 0.025330994, + -0.00018099198, + -0.025131851, + -0.011025886, + 0.0116498675, + -0.02506547, + 0.029234199, + -0.012287126, + 0.0069766445, + 0.0018752636, + 0.014271918, + 0.005108019, + -0.0109064, + 0.014391404, + 0.0062597296, + -0.031411495, + 0.00014935728, + 0.013236375, + -0.02891557, + -0.0006671292, + 0.008662722, + 0.012161002, + 0.020963125, + -0.0133691365, + 0.02653913, + -0.017989255, + 0.007978998, + 0.0093398085, + -0.02024621, + 0.03265946, + -0.02846418, + 0.025397375, + -0.024693737, + -0.0027050264, + -0.019330151, + -0.0104417335, + 0.015626092, + -0.006541849, + 0.004653309, + -0.025118576, + 0.0038268655, + 0.004045923, + -0.017564416, + -0.02444149, + 0.030296294, + 0.028756255, + 0.03927101, + 0.010767001, + -0.012034878, + -0.007122683, + -0.022476612, + -0.034942966, + -0.028411074, + -0.03927101, + -0.0037505273, + -0.0038799702, + -0.00037111135, + -0.009718181, + -0.013455432, + -0.015400395, + -0.0066978442, + -0.010760362, + 0.015121595, + 0.03111942, + 0.007992274, + 0.0270569, + -0.003104972, + 0.010056724, + -0.018414093, + 0.006472149, + 0.021281753, + 0.0043579135, + -0.00021490853, + 0.0008546556, + -0.01269205, + -0.003936394, + 0.0008870163, + 0.0009816092, + 0.0054664765, + -0.031278733, + 0.017245788, + 0.00027734818, + 0.005161124, + 0.0048093046, + -0.003923118, + -0.027149836, + 0.006950092, + -0.00615352, + 0.014205537, + 0.0016620146, + 0.0047396044, + 0.0039994563, + -0.015440224, + -0.0055627287, + -0.026273604, + 0.0013276202, + 0.0021009592, + -0.034810204, + 0.0064522345, + 0.00042608313, + 0.02307404, + -0.005957696, + 0.0016869075, + -0.0032775626, + -0.009041094, + -0.01227385, + -0.04349284, + 0.015652644, + 0.013468708, + -0.0023249951, + -0.011171925, + 0.0030352718, + -0.0061203293, + -0.023153698, + 0.046068422, + -0.005582643, + -0.02405648, + 0.005433286, + -0.02814555, + -0.0036874653, + 0.0067841397, + 0.006628144, + 0.029844904, + -0.0044276137, + -0.029127989, + -0.04548427, + 0.022091601, + 0.0038069512, + -0.030269742, + 0.0051578046, + 0.043572497, + -0.0144843375, + -0.02891557, + -0.010461648, + -0.17375894, + 0.029154541, + 0.019648781, + -0.00038335036, + 0.0029572742, + -0.0026469429, + 0.035925403, + -0.012021601, + 0.0015566348, + -0.0033124126, + 0.0010430117, + -0.010620962, + -0.022582822, + 0.00601412, + 0.008364008, + -0.0016586956, + -0.0011102224, + -0.013860356, + 0.022542993, + 0.020564837, + 0.018414093, + -0.008908332, + 0.032951534, + -0.011908754, + 0.010169571, + -0.011198477, + 0.0029108075, + 0.033084296, + 0.0029008503, + -0.0010015236, + -0.019794818, + 0.005844848, + 0.011669782, + 0.0052208668, + 0.010129742, + 0.0037737607, + 0.02880936, + -0.018599961, + -0.015095043, + 0.026578957, + 0.019662056, + 0.006823968, + -0.00045885876, + -0.019396532, + -0.0047993474, + 0.017192682, + 0.039589636, + -0.00874238, + 0.02146762, + -0.007667007, + 0.018785827, + -0.012758431, + -0.010010257, + -0.02052501, + 0.016090758, + 0.0061867107, + -0.0145507185, + 0.008065294, + 0.0104284575, + -0.0022386997, + -0.008324179, + -0.021640211, + 0.01705992, + -0.010541305, + -0.01639611, + -0.0074413116, + -0.034703992, + 0.007016473, + -0.003083398, + 0.0013691084, + -0.005108019, + -0.007886064, + 0.00053270767, + -0.018865485, + 0.025503585, + 0.005101381, + -0.027534844, + 0.015028661, + -0.009286704, + 0.006233177, + 0.00004343289, + 0.036031615, + 0.00957878, + 0.019250493, + 0.0024411618, + 0.0023664832, + -0.0030269742, + -0.007939169, + 0.0058581247, + 0.00587472, + 0.036589216, + -0.035288148, + -0.012997403, + -0.0110989055, + -0.002492607, + 0.008151589, + -0.008085207, + -0.00734174, + -0.0016802694, + 0.008403837, + -0.007793131, + -0.003913161, + -0.025437204, + 0.027123282, + 0.019330151, + -0.008729103, + 0.003943032, + 0.010289057, + 0.029977666, + 0.0014836156, + -0.024282174, + -0.0024361832, + 0.0110325245, + 0.021719867, + 0.012844726, + 0.015002109, + 0.020737428, + -0.013037231, + 0.014802966, + -0.0027332383, + 0.041634172, + -0.00926679, + -0.018759275, + 0.018666342, + 0.005386819, + -0.008822037, + -0.068399, + -0.054804165, + 0.027800368, + 0.04954679, + -0.00437119, + 0.029127989, + 0.03180978, + 0.021321582, + -0.022503164, + 0.010554581, + -0.006823968, + -0.021387963, + -0.021865906, + -0.0074479496, + 0.0037206558, + 0.004132218, + 0.01073381, + -0.0021673401, + -0.0012819833, + 0.041235887, + -0.010202762, + 0.004839176, + 0.0081715025, + -0.030402504, + -0.023764404, + -0.010800191, + -0.018374264, + 0.033641897, + 0.005416691, + -0.0055096243, + -0.0032775626, + -0.018095464, + 0.008563151, + -0.02339267, + -0.013674489, + 0.0023382711, + -0.028411074, + -0.0024063117, + 0.026658615, + -0.012413249, + 0.009333171, + 0.026446195, + -0.009107475, + -0.024560975, + 0.0011085629, + -0.02395027, + 0.0013857037, + 0.01926377, + -0.0020710877, + -0.031278733, + -0.015095043, + 0.0041720467, + -0.012798259, + 0.010162933, + 0.0063128346, + -0.010972782, + 0.045617033, + 0.016874054, + -0.010368714, + -0.0055992384, + -0.0092999805, + 0.0015782086, + -0.013581555, + 0.017843217, + -0.01615714, + 0.0036575939, + -0.027110007, + -0.013621384, + 0.022197811, + 0.0013964906, + -0.007348378, + 0.0145772705, + -0.003996137, + 0.0008364008, + -0.03411984, + 0.013030593, + -0.021454344, + -0.05034336, + 0.021095887, + -0.0055029863, + -0.025623072, + -0.023525432, + 0.007335102, + -0.043413185, + 0.016316453, + 0.016196968, + 0.0093132565, + -0.0110989055, + 0.0154535, + -0.045218747, + 0.0037737607, + 0.01639611, + 0.019887751, + -0.023366116, + -0.024043202, + 0.014258642, + 0.004271618, + -0.006877073, + 0.021387963, + -0.0019781543, + -0.036350243, + -0.009114114, + -0.037359234, + 0.01919739, + 0.011829097, + -0.015665919, + -0.0015591241, + 0.0144843375, + -0.003139822, + -0.024083031, + -0.015307462, + -0.0040990277, + -0.013223098, + 0.0024278855, + -0.008702551, + -0.0033207103, + -0.009804476, + -0.010554581, + 0.031066315, + 0.0044408897, + 0.025370823, + 0.009406189, + 0.025583243, + -0.002066109, + 0.015267633, + 0.008337456, + -0.009426104, + 0.01590489, + -0.011716249, + 0.007713474, + -0.029552827, + -0.013900184, + 0.0050150855, + -0.01650232, + -0.0015757193, + 0.008549875, + -0.020471904, + 0.008397198, + -0.013136802, + 0.021520725, + 0.0060406723, + 0.012858002, + -0.004723009, + -0.029313855, + 0.009240237, + -0.0212552, + -0.028118998, + 0.017803388, + -0.0314646, + 0.012353507, + 0.029632485, + -0.000016128512, + 0.016966987, + 0.009711542, + -0.037253026, + -0.015095043, + 0.013442155, + -0.00905437, + -0.000982439, + -0.0020495139, + 0.008337456, + -0.020644495, + 0.042085562, + -0.000744712, + 0.021135716, + -0.0072886352, + 0.01643594, + 0.013767422, + -0.0044707614, + -0.014763137, + 0.018852208, + -0.03080079, + -0.0049188333, + 0.0058846767, + 0.008330817, + 0.008257798, + 0.024202518, + 0.02307404, + 0.011065715, + 0.00036053188, + -0.00049412367, + 0.036270585, + 0.027043626, + 0.011902116, + -0.027773816, + 0.013289479, + 0.018374264, + -0.0033157317, + 0.0016636741, + 0.0020677685, + -0.012293763, + 0.008184779, + -0.034252603, + 0.010753725, + 0.008675998, + 0.00968499, + -0.003793675, + -0.011218391, + 0.010375353, + -0.0005737809, + 0.019781543, + 0.020591391, + 0.019954132, + -0.00053976063, + -0.0059444197, + -0.022675755, + -0.010003619, + 0.0038467797, + -0.0212552, + -0.033482585, + -0.015572986, + 0.0037737607, + 0.01451089, + 0.0036376796, + 0.007454588, + 0.013979842, + -0.013402327, + 0.014975557, + -0.010435095, + 0.0151747, + -0.030375952, + 0.023166973, + -0.0024760119, + -0.005881358, + 0.019914305, + -0.008596341, + 0.017737007, + -0.0036111271, + 0.012499545, + -0.02647275, + 0.0053901384, + 0.008556513, + 0.019648781, + 0.00874238, + -0.012439802, + -0.028623493, + -0.022330573, + -0.0029340407, + -0.016303178, + 0.007474502, + -0.016555425, + 0.060645696, + 0.0023631642, + -0.012054792, + 0.017604245, + 0.013103612, + 0.026061187, + 0.015533158, + 0.025742557, + 0.00013753316, + -0.013940013, + 0.02880936, + 0.010109829, + -0.0036111271, + -0.012419888, + -0.045457717, + 0.022835068, + -0.014139156, + 0.007819683, + -0.010461648, + -0.012008325, + 0.008895056, + 0.015984548, + 0.024043202, + -0.00059825886, + -0.0036376796, + -0.007939169, + 0.0242689, + -0.022197811, + -0.026313433, + -0.026724996, + 0.010939592, + 0.0023449094, + -0.012074706, + -0.018493751, + 0.017697178, + -0.0052142288, + -0.00360117, + 0.0056058764, + 0.01070062, + 0.0035248317, + 0.023671469, + 0.030880447, + -0.020299314, + -0.0145905465, + 0.018055636, + -0.013727593, + -0.023313012, + 0.013236375, + -0.0020113448 + ] + } + ], + "usage": { + "prompt_tokens": 4, + "total_tokens": 4 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/embeddings.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/embeddings.yaml new file mode 100644 index 000000000000..b76897d64de0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/embeddings.yaml @@ -0,0 +1,1553 @@ +title: Return the embeddings for a given prompt. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + deployment-id: deployment-afa0669ca01e4693ae3a93baf40f26d6 + body: + input: + - this is a test +responses: + "200": + body: + data: + - index: 0 + embedding: + - -0.012838088 + - -0.007421397 + - -0.017617522 + - -0.028278312 + - -0.018666342 + - 0.01737855 + - -0.01821495 + - -0.006950092 + - -0.009937238 + - -0.038580645 + - 0.010674067 + - 0.02412286 + - -0.013647936 + - 0.013189907 + - 0.0021125758 + - 0.012406612 + - 0.020790534 + - 0.00074595667 + - 0.008397198 + - -0.00535031 + - 0.008968075 + - 0.014351576 + - -0.014086051 + - 0.015055214 + - -0.022211088 + - -0.025198232 + - 0.0065186154 + - -0.036350243 + - 0.009180495 + - -0.009698266 + - 0.009446018 + - -0.008463579 + - -0.0040426035 + - -0.03443847 + - -0.00091273896 + - -0.0019217303 + - 0.002349888 + - -0.021560553 + - 0.016515596 + - -0.015572986 + - 0.0038666942 + - -8.432463e-05 + - 0.0032178196 + - -0.020365695 + - -0.009631885 + - -0.007647093 + - 0.0033837722 + - -0.026764825 + - -0.010501476 + - 0.020219658 + - 0.024640633 + - -0.0066912062 + - -0.036456455 + - -0.0040923897 + - -0.013966565 + - 0.017816665 + - 0.005366905 + - 0.022835068 + - 0.0103488 + - -0.0010811808 + - -0.028942121 + - 0.0074280356 + - -0.017033368 + - 0.0074877786 + - 0.021640211 + - 0.002499245 + - 0.013316032 + - 0.0021524043 + - 0.010129742 + - 0.0054731146 + - 0.03143805 + - 0.014856071 + - 0.0023366117 + - -0.0008243692 + - 0.022781964 + - 0.003038591 + - -0.017617522 + - 0.0013309394 + - 0.0022154662 + - 0.00097414135 + - 0.012041516 + - -0.027906578 + - -0.023817508 + - 0.013302756 + - -0.003003741 + - -0.006890349 + - 0.0016744611 + - 0.023658194 + - -0.015851786 + - -0.0045305043 + - -0.003038591 + - 0.017710455 + - 0.019237218 + - 0.016037652 + - -0.022503164 + - 0.025795663 + - -0.001129307 + - 0.032500144 + - -0.008178141 + - -0.019940857 + - -0.009877495 + - 0.00018918588 + - 0.023060765 + - -0.005692172 + - -0.018347712 + - -0.011039163 + - -0.0062066247 + - -5.24047e-05 + - 0.020126723 + - -0.0011691356 + - -0.015811957 + - 0.020086896 + - -0.009114114 + - -0.03056182 + - 0.0029025099 + - -0.006591635 + - -0.014046223 + - -0.01590489 + - -0.02307404 + - -0.008861865 + - -0.004832538 + - 0.010030171 + - 0.02311387 + - -0.012652221 + - 0.024906157 + - 0.003860056 + - -0.01936998 + - -0.02957938 + - -0.008357369 + - -0.0016371218 + - 0.027800368 + - 0.0077333883 + - 0.021626934 + - 0.02140124 + - -0.030482162 + - 0.026406368 + - -0.008277712 + - 0.012884554 + - -0.043784916 + - -0.0145639945 + - -0.0070297495 + - 0.034889862 + - -0.00041508878 + - -0.010528029 + - -0.009572142 + - 0.015692472 + - 0.037810627 + - -0.0022021902 + - 0.008662722 + - -0.016794397 + - 0.0003090866 + - -0.0060506295 + - 0.015227805 + - 0.0006650548 + - 0.01842737 + - 0.036801632 + - -0.002461076 + - -0.0029390194 + - -0.0057120863 + - -0.012486269 + - -0.0046831807 + - -0.0017474802 + - -0.0036210844 + - -0.01178263 + - 0.017869769 + - 0.039111692 + - 0.010946229 + - 0.018467197 + - 0.0027780454 + - -0.005851486 + - -0.016489044 + - 0.03186289 + - -0.040333103 + - 0.016648358 + - -0.006870435 + - 0.0072687212 + - 2.370982e-06 + - 0.006465511 + - -0.018201673 + - -0.00020526254 + - -0.025410652 + - 0.02010017 + - 0.017537864 + - 0.022821793 + - 0.0064555537 + - -0.0012969191 + - 0.02157383 + - -0.0053536287 + - -0.0087622935 + - -0.010952868 + - 0.017564416 + - 0.02185263 + - 0.0004733796 + - 0.0018337755 + - -0.6954606 + - -0.011231667 + - 0.02748174 + - 0.003929756 + - 0.0144843375 + - 0.045192193 + - 0.01898497 + - -0.0070363875 + - -0.007813046 + - 0.017604245 + - -0.017790113 + - 0.011165286 + - -0.0036376796 + - -0.014736585 + - 0.0016421003 + - -0.019144284 + - -0.0072222543 + - -0.023127146 + - 0.006936816 + - 0.025198232 + - 0.0030219958 + - 0.011722887 + - -0.004271618 + - -0.0011127117 + - -0.0051047 + - 0.00077333883 + - 0.018599961 + - 0.0074877786 + - 0.010820106 + - 0.0033406245 + - -0.015055214 + - 0.02384406 + - 0.006090458 + - 0.00891497 + - 0.023366116 + - -0.011078991 + - -0.019582398 + - 0.0011566891 + - 0.015413672 + - 0.01793615 + - -0.014736585 + - 0.002492607 + - 0.027800368 + - 0.023923717 + - -0.007421397 + - 0.0016105693 + - 0.011337877 + - -0.015041938 + - -0.008768932 + - -0.003982861 + - 0.002884255 + - -0.007832959 + - 0.0025457118 + - -0.0023548664 + - -0.0061767534 + - -0.016754568 + - 0.0006036523 + - 0.0105346665 + - 0.0055361767 + - 0.01478969 + - -0.0011251582 + - 0.009605332 + - -0.0037140178 + - -0.017537864 + - -0.021733144 + - 0.012897831 + - -0.024481317 + - 0.022290744 + - 0.0056523434 + - -0.005366905 + - 0.0020412162 + - 0.013435517 + - -0.003408665 + - -0.01705992 + - 0.029446619 + - 0.022011945 + - 0.009226961 + - -0.003310753 + - -0.007939169 + - 0.021308305 + - 0.0026718357 + - 0.002129171 + - -0.020047067 + - -0.007474502 + - 0.021534001 + - -0.0110590765 + - -0.018374264 + - -0.001664504 + - -0.003923118 + - 0.015387119 + - 0.025516862 + - 0.0016421003 + - -0.017498035 + - -0.01825478 + - 0.01451089 + - -0.008198055 + - -0.011656506 + - 0.0044242945 + - 0.031491153 + - 0.01017621 + - -0.010408543 + - -0.009034456 + - -0.0023283141 + - 0.012021601 + - 0.015639367 + - 0.011736163 + - 0.007912617 + - 0.02031259 + - 0.022104878 + - -0.02241023 + - 0.00041156227 + - -0.009817752 + - -0.030880447 + - -0.0017823302 + - 0.0030933553 + - -0.04128899 + - -0.0007783174 + - 0.012393335 + - 0.0122273825 + - -0.009087561 + - 0.022728859 + - -0.002884255 + - 0.028065892 + - 0.0047396044 + - 0.008065294 + - 0.015519881 + - 0.0133956885 + - -0.02279524 + - -0.011729525 + - 0.0037206558 + - -0.0046732235 + - 0.003587894 + - 0.024401661 + - -0.013574918 + - 0.012685412 + - -0.0041620894 + - 0.020578114 + - 0.007394845 + - 0.014139156 + - -0.012512821 + - -0.021042781 + - 0.022423506 + - -0.015360567 + - 0.004009413 + - 0.0104550095 + - -0.024799947 + - -0.0081449505 + - -0.00063850236 + - 0.0070231115 + - -0.0009633545 + - -0.015705748 + - -0.0028942123 + - -0.008815398 + - 0.007461226 + - -0.014417957 + - -0.012931022 + - 0.0015674217 + - -0.02506547 + - -0.0063128346 + - -0.013422241 + - -0.0058614435 + - -0.0006007482 + - -0.015002109 + - 0.0037040606 + - -0.008410474 + - -0.0016089098 + - -0.018653065 + - 0.020538285 + - -0.016980262 + - -0.042244878 + - -0.017498035 + - 0.006727716 + - -0.01877255 + - 0.008987989 + - 0.00077665783 + - -0.0007119364 + - -0.0067243967 + - 0.0038467797 + - -0.018055636 + - -0.01440468 + - 0.007534245 + - 0.0051212953 + - 0.002741536 + - 0.011523744 + - -0.0018603279 + - 0.023684746 + - 0.016196968 + - 0.01731217 + - -0.01992758 + - 0.009372999 + - -0.01982137 + - 0.001150051 + - -0.014417957 + - 0.005672258 + - -0.015785405 + - 0.0049387473 + - -0.0051445286 + - 0.012632307 + - 0.0011666464 + - 0.024587527 + - 0.04259006 + - -0.0025672857 + - 0.02311387 + - -0.014524166 + - 0.0013848739 + - -0.04105002 + - -0.010089914 + - -0.009087561 + - 0.015440224 + - 0.009207047 + - 0.0128048975 + - -0.030216638 + - -0.02549031 + - 0.00499849 + - 0.02737553 + - 0.024985814 + - -0.015055214 + - 0.007580712 + - -0.003979542 + - 0.0016304837 + - 0.0010446712 + - 0.0033373055 + - 0.0066314633 + - -0.011948583 + - -0.021281753 + - 0.012161002 + - 0.030747686 + - 0.03555367 + - 0.023751127 + - -0.03159736 + - -0.0110590765 + - 0.015758853 + - -0.0012197511 + - -0.0023249951 + - -0.0007488608 + - 0.0074877786 + - 0.01643594 + - -0.008098484 + - 0.03730613 + - -0.0010056724 + - -3.4798173e-05 + - 0.011702972 + - 0.039563086 + - -0.012280487 + - 0.027747264 + - 0.018387541 + - 0.033057746 + - -0.004835857 + - -0.00471969 + - 0.025450481 + - -0.0051146573 + - 0.014603823 + - 0.00022258384 + - 0.00060863094 + - 0.015665919 + - -0.021626934 + - -0.013674489 + - 0.0062066247 + - 0.018560132 + - 0.031942543 + - 0.012054792 + - 0.004902238 + - 0.0028510645 + - -0.027667606 + - 0.009817752 + - -0.002580562 + - 0.0069036256 + - 0.020047067 + - -0.009704905 + - -0.012619031 + - -0.0056755766 + - -0.0036443176 + - 0.019383255 + - 0.0030701219 + - 0.024972538 + - 0.009100837 + - 0.026353262 + - 0.012758431 + - 0.029074885 + - 0.021202097 + - -0.0038102702 + - -0.032048754 + - 0.003996137 + - 0.0029738694 + - 0.0032277768 + - -0.026127568 + - -0.02213143 + - 0.0028742978 + - 0.0010637557 + - 0.000580419 + - 0.0021789568 + - 0.00083764544 + - 0.026924139 + - -0.03265946 + - 0.0059211864 + - 0.021892458 + - 0.01178263 + - 0.0018188398 + - 0.009718181 + - -0.020047067 + - 0.017989255 + - 0.0046035233 + - -0.010561219 + - -0.010342162 + - 0.009505761 + - -0.018334435 + - -0.00667793 + - -0.024534423 + - 0.00035347888 + - 0.00082561385 + - -0.006143563 + - 0.016820949 + - -0.0013500239 + - -0.0069832825 + - 0.015347291 + - -0.005094743 + - 0.001838754 + - 0.017073197 + - 0.02521151 + - 0.006209944 + - -0.015612815 + - -0.009744733 + - -0.019794818 + - 0.007786493 + - 0.037624758 + - 0.017564416 + - 0.0076802834 + - 0.0026203906 + - 0.0022403593 + - -0.024560975 + - -0.04062518 + - -0.016581977 + - 0.00789934 + - 0.0099305995 + - 0.006996559 + - 0.011078991 + - 0.016236795 + - -0.0068969876 + - 0.01374087 + - 0.014922452 + - -0.0042882133 + - 0.00022901449 + - -0.0006692036 + - 0.001359981 + - -7.581957e-05 + - 0.0042616613 + - 0.0066381013 + - 0.012512821 + - 0.021534001 + - 0.0032775626 + - 0.016913882 + - -0.00789934 + - -0.009200408 + - -0.020286039 + - -0.017033368 + - 0.014378128 + - 0.009233599 + - 0.0070828544 + - -0.013229736 + - 0.025928425 + - -0.011862287 + - 0.008383922 + - 0.012632307 + - -0.0003097089 + - 0.007593988 + - 0.0059079104 + - -0.0026369859 + - -0.0262205 + - 0.003335646 + - -0.0067609064 + - -0.0042882133 + - 0.008549875 + - -0.007600626 + - -0.012592479 + - 0.028623493 + - -0.0030502076 + - -0.006989921 + - -0.015785405 + - 0.010050085 + - 0.016714739 + - -0.023724575 + - -0.006346025 + - -0.014245366 + - -0.032154962 + - -0.03388087 + - -0.024308728 + - -0.002461076 + - -0.003733932 + - -0.02195884 + - -0.021069333 + - -0.022144707 + - -0.007872788 + - -0.017179407 + - -0.009034456 + - -0.010893124 + - -0.02478667 + - -0.020153277 + - -0.023976821 + - 0.014656927 + - 0.0005368565 + - -0.015878338 + - 0.010123105 + - -0.0030717815 + - 0.01555971 + - 0.0018321159 + - -0.036244035 + - 0.00017176087 + - -0.013375774 + - -0.010375353 + - 0.026512576 + - 0.016581977 + - 0.013847079 + - 0.015719024 + - 0.013223098 + - 0.004975257 + - -0.0010579474 + - -0.0034385365 + - -0.029048331 + - 0.017298892 + - -0.022529716 + - 0.008463579 + - -0.014723309 + - -0.005814977 + - -0.009027818 + - -0.009738095 + - -0.0104682855 + - -0.005044957 + - 0.007905979 + - 0.011656506 + - 0.003153098 + - -0.0005231654 + - 0.019954132 + - -0.021985391 + - -0.005307162 + - 0.0021839354 + - -0.025184957 + - 0.013926737 + - -0.0059908866 + - 0.0065717204 + - 0.009884133 + - -0.0062298584 + - 0.03388087 + - 0.0028577026 + - -0.015931444 + - 0.0010986058 + - -0.025808938 + - 0.0022835068 + - 0.014152432 + - 0.015227805 + - 0.013701041 + - -0.007872788 + - -0.030614924 + - -0.026393091 + - 0.0010753724 + - -0.016940435 + - 0.013647936 + - -0.007408121 + - -0.024308728 + - -0.031915992 + - -0.018161846 + - 0.00072521257 + - 0.028862465 + - 0.012234021 + - -0.019555846 + - -0.027641054 + - -0.00082810316 + - -0.0019150922 + - -0.016276624 + - -0.01125822 + - -0.034146395 + - -0.015294186 + - 0.006671292 + - -0.015533158 + - 0.013674489 + - -0.0011766035 + - -0.017325444 + - -0.023233354 + - -0.013189907 + - 0.0005580154 + - -0.03188944 + - -0.007056302 + - -0.0059942054 + - 0.03411984 + - 0.04317421 + - 0.029420065 + - 0.006488744 + - -0.0022436783 + - 0.013063784 + - 0.00012207884 + - 0.008118398 + - -0.023246631 + - 0.0051909955 + - -0.00894816 + - 0.0081316745 + - 0.0023200165 + - 0.011510468 + - -0.0005770999 + - 0.00016979019 + - 0.010129742 + - 0.015506605 + - -0.0073815687 + - 0.0031995648 + - -0.026578957 + - -0.016674912 + - 0.0049652997 + - 0.0072687212 + - -0.016568702 + - -0.001964878 + - -0.015692472 + - -0.0048955996 + - 0.027773816 + - 0.012864641 + - 0.01594472 + - 0.008244522 + - 0.017139578 + - -0.01772373 + - -0.0012521119 + - 0.011689696 + - 0.0111121815 + - -0.0036476366 + - 0.0012570905 + - -0.007826322 + - -0.016754568 + - 0.011948583 + - -0.0045968853 + - 0.023963546 + - -0.0052739717 + - 0.014656927 + - 0.009731457 + - 0.010727172 + - -0.01705992 + - -0.0026071144 + - 0.010760362 + - 0.000919377 + - -0.006365939 + - -0.03013698 + - -0.010554581 + - -0.018613236 + - 0.013886908 + - 0.029420065 + - -0.013030593 + - 0.016860778 + - -0.019237218 + - -0.022118153 + - 0.007919255 + - -0.0004003605 + - 0.046546366 + - 0.01349526 + - 0.006352663 + - 0.014258642 + - 0.0031813101 + - -0.027017072 + - 0.0070828544 + - -0.020219658 + - 0.0037140178 + - 0.023366116 + - 0.040386207 + - -0.016382834 + - -0.0023681426 + - 0.0064522345 + - 0.016528873 + - 0.0006804054 + - -0.02891557 + - -0.0043545947 + - 0.01101261 + - -0.0014778073 + - -0.018055636 + - -0.0077001974 + - -0.0358723 + - 0.003373815 + - -0.00071940426 + - -0.011822458 + - -0.024295451 + - -0.009791199 + - -0.026565682 + - 0.020989677 + - -0.035155386 + - 0.01832116 + - 0.014776413 + - -0.028012788 + - -0.007262083 + - 0.0030402504 + - -0.029446619 + - 0.00010174965 + - 0.009758009 + - 0.03767786 + - -0.0154535 + - 0.009346447 + - 0.016077481 + - 0.0041189417 + - -0.027800368 + - 0.01720596 + - -0.011158649 + - 0.027800368 + - -0.03003077 + - -0.0072819972 + - 0.0014296811 + - 0.0145374425 + - 0.0043280423 + - -0.017086472 + - -0.01611731 + - -0.01258584 + - -0.016927158 + - 0.007607264 + - 0.018825656 + - 0.011331239 + - -0.0057784673 + - 0.001569911 + - -0.013900184 + - -0.014776413 + - -0.0050814664 + - -0.0012454737 + - -0.0115967635 + - -0.017458206 + - -0.013203184 + - -0.0063692583 + - -0.01244644 + - 0.011882202 + - 0.0007708495 + - -0.02035242 + - 0.016250072 + - 0.018414093 + - -0.029526275 + - 0.012751793 + - -0.01555971 + - 0.0013840442 + - -0.019502742 + - 0.0063758963 + - 0.0037538463 + - -0.035686433 + - 0.027534844 + - -0.016409386 + - -0.03247359 + - -0.008782208 + - -0.0059842486 + - 0.014338299 + - 0.009233599 + - -0.0053171194 + - 0.006160158 + - 0.0072952732 + - 0.01401967 + - 0.008815398 + - -0.023790956 + - 0.013096974 + - -0.0031365028 + - 0.005044957 + - 0.0005356118 + - -0.009379637 + - 0.0066248253 + - -0.00010724682 + - 0.010289057 + - 0.008815398 + - -0.02279524 + - -0.019701885 + - -0.0027747264 + - 0.016183691 + - -0.014205537 + - -0.003933075 + - -0.013375774 + - -0.005751915 + - -0.010116466 + - 0.004988533 + - -0.005904591 + - -0.008656085 + - -0.017431654 + - -0.011988411 + - -0.01594472 + - 0.00660823 + - -0.027216217 + - 0.0073218257 + - -0.029977666 + - -0.004593566 + - -0.026671892 + - -0.028517283 + - -0.0050084474 + - 0.009844304 + - 0.025729282 + - -0.013780698 + - -0.026751548 + - 0.004905557 + - -0.035951957 + - -0.026738273 + - -0.019768266 + - 0.0048690476 + - 0.005250738 + - 0.0014603822 + - -0.018892037 + - 0.017683903 + - 0.0067177587 + - 0.027694158 + - -0.002618731 + - -0.012419888 + - 0.01772373 + - -0.0032593077 + - 0.006611549 + - 0.016648358 + - -0.03789028 + - -0.023100592 + - 0.023684746 + - 0.0031248862 + - 0.016382834 + - 0.019967409 + - -0.008941523 + - -0.02014 + - 0.0073882067 + - 0.011357792 + - -0.0031796505 + - -0.0030253148 + - -0.0010206081 + - -0.017577693 + - -0.009598695 + - 0.002915786 + - 0.001325131 + - -0.0029207645 + - -0.010780277 + - -0.00325101 + - -0.00811176 + - -0.00073434 + - -0.030083876 + - -0.012864641 + - -0.012745155 + - -0.011769353 + - 0.018785827 + - -0.008264436 + - -0.002675155 + - 0.024255622 + - 0.005483072 + - -0.018480474 + - -0.005426648 + - 0.015095043 + - 0.00044392303 + - 0.011271496 + - -0.0027548121 + - 0.0026884312 + - -0.00894816 + - -0.015161424 + - -0.014975557 + - -0.024600804 + - 0.004457485 + - -0.015519881 + - -0.012366783 + - -0.012579202 + - 0.01478969 + - 0.0075541595 + - -0.017962702 + - -0.0017441611 + - -0.014059499 + - 0.005499667 + - -0.0026884312 + - 0.0031929268 + - 0.0010853296 + - -0.008045379 + - 0.017471483 + - 0.02590187 + - -0.018546855 + - -0.007826322 + - 0.009333171 + - 0.0157323 + - 8.6036016e-05 + - 0.004776114 + - 0.22155327 + - 0.006787459 + - -0.0017823302 + - 0.024919434 + - 0.0023449094 + - 0.03210186 + - 0.0047329664 + - -0.010879848 + - 0.0044342517 + - 0.015334014 + - 0.029499723 + - 0.019715162 + - -0.008569789 + - -0.0018901994 + - -0.0077400263 + - -0.019210665 + - -0.005088105 + - -0.023153698 + - -0.032739118 + - -0.029313855 + - 0.00082146504 + - -0.0212552 + - 0.0044309325 + - -0.005446562 + - 0.018613236 + - -0.009751371 + - -0.013023955 + - -0.001996409 + - 0.01915756 + - 0.017431654 + - -0.031092867 + - -0.0070231115 + - 0.025330994 + - -0.00018099198 + - -0.025131851 + - -0.011025886 + - 0.0116498675 + - -0.02506547 + - 0.029234199 + - -0.012287126 + - 0.0069766445 + - 0.0018752636 + - 0.014271918 + - 0.005108019 + - -0.0109064 + - 0.014391404 + - 0.0062597296 + - -0.031411495 + - 0.00014935728 + - 0.013236375 + - -0.02891557 + - -0.0006671292 + - 0.008662722 + - 0.012161002 + - 0.020963125 + - -0.0133691365 + - 0.02653913 + - -0.017989255 + - 0.007978998 + - 0.0093398085 + - -0.02024621 + - 0.03265946 + - -0.02846418 + - 0.025397375 + - -0.024693737 + - -0.0027050264 + - -0.019330151 + - -0.0104417335 + - 0.015626092 + - -0.006541849 + - 0.004653309 + - -0.025118576 + - 0.0038268655 + - 0.004045923 + - -0.017564416 + - -0.02444149 + - 0.030296294 + - 0.028756255 + - 0.03927101 + - 0.010767001 + - -0.012034878 + - -0.007122683 + - -0.022476612 + - -0.034942966 + - -0.028411074 + - -0.03927101 + - -0.0037505273 + - -0.0038799702 + - -0.00037111135 + - -0.009718181 + - -0.013455432 + - -0.015400395 + - -0.0066978442 + - -0.010760362 + - 0.015121595 + - 0.03111942 + - 0.007992274 + - 0.0270569 + - -0.003104972 + - 0.010056724 + - -0.018414093 + - 0.006472149 + - 0.021281753 + - 0.0043579135 + - -0.00021490853 + - 0.0008546556 + - -0.01269205 + - -0.003936394 + - 0.0008870163 + - 0.0009816092 + - 0.0054664765 + - -0.031278733 + - 0.017245788 + - 0.00027734818 + - 0.005161124 + - 0.0048093046 + - -0.003923118 + - -0.027149836 + - 0.006950092 + - -0.00615352 + - 0.014205537 + - 0.0016620146 + - 0.0047396044 + - 0.0039994563 + - -0.015440224 + - -0.0055627287 + - -0.026273604 + - 0.0013276202 + - 0.0021009592 + - -0.034810204 + - 0.0064522345 + - 0.00042608313 + - 0.02307404 + - -0.005957696 + - 0.0016869075 + - -0.0032775626 + - -0.009041094 + - -0.01227385 + - -0.04349284 + - 0.015652644 + - 0.013468708 + - -0.0023249951 + - -0.011171925 + - 0.0030352718 + - -0.0061203293 + - -0.023153698 + - 0.046068422 + - -0.005582643 + - -0.02405648 + - 0.005433286 + - -0.02814555 + - -0.0036874653 + - 0.0067841397 + - 0.006628144 + - 0.029844904 + - -0.0044276137 + - -0.029127989 + - -0.04548427 + - 0.022091601 + - 0.0038069512 + - -0.030269742 + - 0.0051578046 + - 0.043572497 + - -0.0144843375 + - -0.02891557 + - -0.010461648 + - -0.17375894 + - 0.029154541 + - 0.019648781 + - -0.00038335036 + - 0.0029572742 + - -0.0026469429 + - 0.035925403 + - -0.012021601 + - 0.0015566348 + - -0.0033124126 + - 0.0010430117 + - -0.010620962 + - -0.022582822 + - 0.00601412 + - 0.008364008 + - -0.0016586956 + - -0.0011102224 + - -0.013860356 + - 0.022542993 + - 0.020564837 + - 0.018414093 + - -0.008908332 + - 0.032951534 + - -0.011908754 + - 0.010169571 + - -0.011198477 + - 0.0029108075 + - 0.033084296 + - 0.0029008503 + - -0.0010015236 + - -0.019794818 + - 0.005844848 + - 0.011669782 + - 0.0052208668 + - 0.010129742 + - 0.0037737607 + - 0.02880936 + - -0.018599961 + - -0.015095043 + - 0.026578957 + - 0.019662056 + - 0.006823968 + - -0.00045885876 + - -0.019396532 + - -0.0047993474 + - 0.017192682 + - 0.039589636 + - -0.00874238 + - 0.02146762 + - -0.007667007 + - 0.018785827 + - -0.012758431 + - -0.010010257 + - -0.02052501 + - 0.016090758 + - 0.0061867107 + - -0.0145507185 + - 0.008065294 + - 0.0104284575 + - -0.0022386997 + - -0.008324179 + - -0.021640211 + - 0.01705992 + - -0.010541305 + - -0.01639611 + - -0.0074413116 + - -0.034703992 + - 0.007016473 + - -0.003083398 + - 0.0013691084 + - -0.005108019 + - -0.007886064 + - 0.00053270767 + - -0.018865485 + - 0.025503585 + - 0.005101381 + - -0.027534844 + - 0.015028661 + - -0.009286704 + - 0.006233177 + - 4.343289e-05 + - 0.036031615 + - 0.00957878 + - 0.019250493 + - 0.0024411618 + - 0.0023664832 + - -0.0030269742 + - -0.007939169 + - 0.0058581247 + - 0.00587472 + - 0.036589216 + - -0.035288148 + - -0.012997403 + - -0.0110989055 + - -0.002492607 + - 0.008151589 + - -0.008085207 + - -0.00734174 + - -0.0016802694 + - 0.008403837 + - -0.007793131 + - -0.003913161 + - -0.025437204 + - 0.027123282 + - 0.019330151 + - -0.008729103 + - 0.003943032 + - 0.010289057 + - 0.029977666 + - 0.0014836156 + - -0.024282174 + - -0.0024361832 + - 0.0110325245 + - 0.021719867 + - 0.012844726 + - 0.015002109 + - 0.020737428 + - -0.013037231 + - 0.014802966 + - -0.0027332383 + - 0.041634172 + - -0.00926679 + - -0.018759275 + - 0.018666342 + - 0.005386819 + - -0.008822037 + - -0.068399 + - -0.054804165 + - 0.027800368 + - 0.04954679 + - -0.00437119 + - 0.029127989 + - 0.03180978 + - 0.021321582 + - -0.022503164 + - 0.010554581 + - -0.006823968 + - -0.021387963 + - -0.021865906 + - -0.0074479496 + - 0.0037206558 + - 0.004132218 + - 0.01073381 + - -0.0021673401 + - -0.0012819833 + - 0.041235887 + - -0.010202762 + - 0.004839176 + - 0.0081715025 + - -0.030402504 + - -0.023764404 + - -0.010800191 + - -0.018374264 + - 0.033641897 + - 0.005416691 + - -0.0055096243 + - -0.0032775626 + - -0.018095464 + - 0.008563151 + - -0.02339267 + - -0.013674489 + - 0.0023382711 + - -0.028411074 + - -0.0024063117 + - 0.026658615 + - -0.012413249 + - 0.009333171 + - 0.026446195 + - -0.009107475 + - -0.024560975 + - 0.0011085629 + - -0.02395027 + - 0.0013857037 + - 0.01926377 + - -0.0020710877 + - -0.031278733 + - -0.015095043 + - 0.0041720467 + - -0.012798259 + - 0.010162933 + - 0.0063128346 + - -0.010972782 + - 0.045617033 + - 0.016874054 + - -0.010368714 + - -0.0055992384 + - -0.0092999805 + - 0.0015782086 + - -0.013581555 + - 0.017843217 + - -0.01615714 + - 0.0036575939 + - -0.027110007 + - -0.013621384 + - 0.022197811 + - 0.0013964906 + - -0.007348378 + - 0.0145772705 + - -0.003996137 + - 0.0008364008 + - -0.03411984 + - 0.013030593 + - -0.021454344 + - -0.05034336 + - 0.021095887 + - -0.0055029863 + - -0.025623072 + - -0.023525432 + - 0.007335102 + - -0.043413185 + - 0.016316453 + - 0.016196968 + - 0.0093132565 + - -0.0110989055 + - 0.0154535 + - -0.045218747 + - 0.0037737607 + - 0.01639611 + - 0.019887751 + - -0.023366116 + - -0.024043202 + - 0.014258642 + - 0.004271618 + - -0.006877073 + - 0.021387963 + - -0.0019781543 + - -0.036350243 + - -0.009114114 + - -0.037359234 + - 0.01919739 + - 0.011829097 + - -0.015665919 + - -0.0015591241 + - 0.0144843375 + - -0.003139822 + - -0.024083031 + - -0.015307462 + - -0.0040990277 + - -0.013223098 + - 0.0024278855 + - -0.008702551 + - -0.0033207103 + - -0.009804476 + - -0.010554581 + - 0.031066315 + - 0.0044408897 + - 0.025370823 + - 0.009406189 + - 0.025583243 + - -0.002066109 + - 0.015267633 + - 0.008337456 + - -0.009426104 + - 0.01590489 + - -0.011716249 + - 0.007713474 + - -0.029552827 + - -0.013900184 + - 0.0050150855 + - -0.01650232 + - -0.0015757193 + - 0.008549875 + - -0.020471904 + - 0.008397198 + - -0.013136802 + - 0.021520725 + - 0.0060406723 + - 0.012858002 + - -0.004723009 + - -0.029313855 + - 0.009240237 + - -0.0212552 + - -0.028118998 + - 0.017803388 + - -0.0314646 + - 0.012353507 + - 0.029632485 + - -1.6128512e-05 + - 0.016966987 + - 0.009711542 + - -0.037253026 + - -0.015095043 + - 0.013442155 + - -0.00905437 + - -0.000982439 + - -0.0020495139 + - 0.008337456 + - -0.020644495 + - 0.042085562 + - -0.000744712 + - 0.021135716 + - -0.0072886352 + - 0.01643594 + - 0.013767422 + - -0.0044707614 + - -0.014763137 + - 0.018852208 + - -0.03080079 + - -0.0049188333 + - 0.0058846767 + - 0.008330817 + - 0.008257798 + - 0.024202518 + - 0.02307404 + - 0.011065715 + - 0.00036053188 + - -0.00049412367 + - 0.036270585 + - 0.027043626 + - 0.011902116 + - -0.027773816 + - 0.013289479 + - 0.018374264 + - -0.0033157317 + - 0.0016636741 + - 0.0020677685 + - -0.012293763 + - 0.008184779 + - -0.034252603 + - 0.010753725 + - 0.008675998 + - 0.00968499 + - -0.003793675 + - -0.011218391 + - 0.010375353 + - -0.0005737809 + - 0.019781543 + - 0.020591391 + - 0.019954132 + - -0.00053976063 + - -0.0059444197 + - -0.022675755 + - -0.010003619 + - 0.0038467797 + - -0.0212552 + - -0.033482585 + - -0.015572986 + - 0.0037737607 + - 0.01451089 + - 0.0036376796 + - 0.007454588 + - 0.013979842 + - -0.013402327 + - 0.014975557 + - -0.010435095 + - 0.0151747 + - -0.030375952 + - 0.023166973 + - -0.0024760119 + - -0.005881358 + - 0.019914305 + - -0.008596341 + - 0.017737007 + - -0.0036111271 + - 0.012499545 + - -0.02647275 + - 0.0053901384 + - 0.008556513 + - 0.019648781 + - 0.00874238 + - -0.012439802 + - -0.028623493 + - -0.022330573 + - -0.0029340407 + - -0.016303178 + - 0.007474502 + - -0.016555425 + - 0.060645696 + - 0.0023631642 + - -0.012054792 + - 0.017604245 + - 0.013103612 + - 0.026061187 + - 0.015533158 + - 0.025742557 + - 0.00013753316 + - -0.013940013 + - 0.02880936 + - 0.010109829 + - -0.0036111271 + - -0.012419888 + - -0.045457717 + - 0.022835068 + - -0.014139156 + - 0.007819683 + - -0.010461648 + - -0.012008325 + - 0.008895056 + - 0.015984548 + - 0.024043202 + - -0.00059825886 + - -0.0036376796 + - -0.007939169 + - 0.0242689 + - -0.022197811 + - -0.026313433 + - -0.026724996 + - 0.010939592 + - 0.0023449094 + - -0.012074706 + - -0.018493751 + - 0.017697178 + - -0.0052142288 + - -0.00360117 + - 0.0056058764 + - 0.01070062 + - 0.0035248317 + - 0.023671469 + - 0.030880447 + - -0.020299314 + - -0.0145905465 + - 0.018055636 + - -0.013727593 + - -0.023313012 + - 0.013236375 + - -0.0020113448 + usage: + prompt_tokens: 4 + total_tokens: 4 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_speech.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_speech.json new file mode 100644 index 000000000000..7d1af9c002cf --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_speech.json @@ -0,0 +1,19 @@ +{ + "operationId": "GenerateSpeechFromText", + "title": "Generates text-to-speech audio from the input text.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "body": { + "input": "The text to generate audio for", + "voice": "alloy" + } + }, + "responses": { + "200": { + "content-type": "application/octet-stream", + "body": "RIFF...audio.data.omitted" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_transcription_object.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_transcription_object.json new file mode 100644 index 000000000000..fe26291868d0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_transcription_object.json @@ -0,0 +1,17 @@ +{ + "operationId": "GetAudioTranscriptionAsResponseObject", + "title": "Gets transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "file": "U3dhZ2dlciByb2Nrcw==" + }, + "responses": { + "200": { + "body": { + "text": "A structured object when requesting json or verbose_json" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_transcription_text.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_transcription_text.json new file mode 100644 index 000000000000..0ded5d22adfe --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_transcription_text.json @@ -0,0 +1,16 @@ +{ + "operationId": "GetAudioTranscriptionAsPlainText", + "title": "Gets transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "file": "U3dhZ2dlciByb2Nrcw==" + }, + "responses": { + "200": { + "type": "string", + "body": "plain text when requesting text, srt, or vtt" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_translation_object.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_translation_object.json new file mode 100644 index 000000000000..5fca9edee75d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_translation_object.json @@ -0,0 +1,17 @@ +{ + "operationId": "GetAudioTranslationAsResponseObject", + "title": "Gets English language transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "file": "U3dhZ2dlciByb2Nrcw==" + }, + "responses": { + "200": { + "body": { + "text": "A structured object when requesting json or verbose_json" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_translation_text.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_translation_text.json new file mode 100644 index 000000000000..489cf486ff03 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_translation_text.json @@ -0,0 +1,16 @@ +{ + "operationId": "GetAudioTranslationAsPlainText", + "title": "Gets English language transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "file": "U3dhZ2dlciByb2Nrcw==" + }, + "responses": { + "200": { + "type": "string", + "body": "plain text when requesting text, srt, or vtt" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_chat_completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_chat_completions.json new file mode 100644 index 000000000000..fd4287afdf45 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_chat_completions.json @@ -0,0 +1,45 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion for the provided prompt, parameters and chosen model.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "body": { + "messages": [ + { + "role": "system", + "content": "you are a helpful assistant that talks like a pirate" + }, + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!" + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_completions.json new file mode 100644 index 000000000000..d94a1de65122 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_completions.json @@ -0,0 +1,38 @@ +{ + "operationId": "GetCompletions", + "title": "Creates a completion for the provided prompt, parameters and chosen model.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "body": { + "prompt": [ + "tell me a joke about mango" + ], + "max_tokens": 32, + "temperature": 1.0, + "n": 1 + } + }, + "responses": { + "200": { + "body": { + "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq", + "created": 1686617332, + "choices": [ + { + "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.", + "index": 0, + "finish_reason": "stop", + "logprobs": null + } + ], + "usage": { + "completion_tokens": 20, + "prompt_tokens": 6, + "total_tokens": 26 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_embeddings.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_embeddings.json new file mode 100644 index 000000000000..01b1b4ad928e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_embeddings.json @@ -0,0 +1,1567 @@ +{ + "operationId": "GetEmbeddings", + "title": "Return the embeddings for a given prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "deployment-afa0669ca01e4693ae3a93baf40f26d6", + "body": { + "input": [ + "this is a test" + ] + } + }, + "responses": { + "200": { + "body": { + "data": [ + { + "index": 0, + "embedding": [ + -0.012838088, + -0.007421397, + -0.017617522, + -0.028278312, + -0.018666342, + 0.01737855, + -0.01821495, + -0.006950092, + -0.009937238, + -0.038580645, + 0.010674067, + 0.02412286, + -0.013647936, + 0.013189907, + 0.0021125758, + 0.012406612, + 0.020790534, + 0.00074595667, + 0.008397198, + -0.00535031, + 0.008968075, + 0.014351576, + -0.014086051, + 0.015055214, + -0.022211088, + -0.025198232, + 0.0065186154, + -0.036350243, + 0.009180495, + -0.009698266, + 0.009446018, + -0.008463579, + -0.0040426035, + -0.03443847, + -0.00091273896, + -0.0019217303, + 0.002349888, + -0.021560553, + 0.016515596, + -0.015572986, + 0.0038666942, + -0.00008432463, + 0.0032178196, + -0.020365695, + -0.009631885, + -0.007647093, + 0.0033837722, + -0.026764825, + -0.010501476, + 0.020219658, + 0.024640633, + -0.0066912062, + -0.036456455, + -0.0040923897, + -0.013966565, + 0.017816665, + 0.005366905, + 0.022835068, + 0.0103488, + -0.0010811808, + -0.028942121, + 0.0074280356, + -0.017033368, + 0.0074877786, + 0.021640211, + 0.002499245, + 0.013316032, + 0.0021524043, + 0.010129742, + 0.0054731146, + 0.03143805, + 0.014856071, + 0.0023366117, + -0.0008243692, + 0.022781964, + 0.003038591, + -0.017617522, + 0.0013309394, + 0.0022154662, + 0.00097414135, + 0.012041516, + -0.027906578, + -0.023817508, + 0.013302756, + -0.003003741, + -0.006890349, + 0.0016744611, + 0.023658194, + -0.015851786, + -0.0045305043, + -0.003038591, + 0.017710455, + 0.019237218, + 0.016037652, + -0.022503164, + 0.025795663, + -0.001129307, + 0.032500144, + -0.008178141, + -0.019940857, + -0.009877495, + 0.00018918588, + 0.023060765, + -0.005692172, + -0.018347712, + -0.011039163, + -0.0062066247, + -0.0000524047, + 0.020126723, + -0.0011691356, + -0.015811957, + 0.020086896, + -0.009114114, + -0.03056182, + 0.0029025099, + -0.006591635, + -0.014046223, + -0.01590489, + -0.02307404, + -0.008861865, + -0.004832538, + 0.010030171, + 0.02311387, + -0.012652221, + 0.024906157, + 0.003860056, + -0.01936998, + -0.02957938, + -0.008357369, + -0.0016371218, + 0.027800368, + 0.0077333883, + 0.021626934, + 0.02140124, + -0.030482162, + 0.026406368, + -0.008277712, + 0.012884554, + -0.043784916, + -0.0145639945, + -0.0070297495, + 0.034889862, + -0.00041508878, + -0.010528029, + -0.009572142, + 0.015692472, + 0.037810627, + -0.0022021902, + 0.008662722, + -0.016794397, + 0.0003090866, + -0.0060506295, + 0.015227805, + 0.0006650548, + 0.01842737, + 0.036801632, + -0.002461076, + -0.0029390194, + -0.0057120863, + -0.012486269, + -0.0046831807, + -0.0017474802, + -0.0036210844, + -0.01178263, + 0.017869769, + 0.039111692, + 0.010946229, + 0.018467197, + 0.0027780454, + -0.005851486, + -0.016489044, + 0.03186289, + -0.040333103, + 0.016648358, + -0.006870435, + 0.0072687212, + 0.000002370982, + 0.006465511, + -0.018201673, + -0.00020526254, + -0.025410652, + 0.02010017, + 0.017537864, + 0.022821793, + 0.0064555537, + -0.0012969191, + 0.02157383, + -0.0053536287, + -0.0087622935, + -0.010952868, + 0.017564416, + 0.02185263, + 0.0004733796, + 0.0018337755, + -0.6954606, + -0.011231667, + 0.02748174, + 0.003929756, + 0.0144843375, + 0.045192193, + 0.01898497, + -0.0070363875, + -0.007813046, + 0.017604245, + -0.017790113, + 0.011165286, + -0.0036376796, + -0.014736585, + 0.0016421003, + -0.019144284, + -0.0072222543, + -0.023127146, + 0.006936816, + 0.025198232, + 0.0030219958, + 0.011722887, + -0.004271618, + -0.0011127117, + -0.0051047, + 0.00077333883, + 0.018599961, + 0.0074877786, + 0.010820106, + 0.0033406245, + -0.015055214, + 0.02384406, + 0.006090458, + 0.00891497, + 0.023366116, + -0.011078991, + -0.019582398, + 0.0011566891, + 0.015413672, + 0.01793615, + -0.014736585, + 0.002492607, + 0.027800368, + 0.023923717, + -0.007421397, + 0.0016105693, + 0.011337877, + -0.015041938, + -0.008768932, + -0.003982861, + 0.002884255, + -0.007832959, + 0.0025457118, + -0.0023548664, + -0.0061767534, + -0.016754568, + 0.0006036523, + 0.0105346665, + 0.0055361767, + 0.01478969, + -0.0011251582, + 0.009605332, + -0.0037140178, + -0.017537864, + -0.021733144, + 0.012897831, + -0.024481317, + 0.022290744, + 0.0056523434, + -0.005366905, + 0.0020412162, + 0.013435517, + -0.003408665, + -0.01705992, + 0.029446619, + 0.022011945, + 0.009226961, + -0.003310753, + -0.007939169, + 0.021308305, + 0.0026718357, + 0.002129171, + -0.020047067, + -0.007474502, + 0.021534001, + -0.0110590765, + -0.018374264, + -0.001664504, + -0.003923118, + 0.015387119, + 0.025516862, + 0.0016421003, + -0.017498035, + -0.01825478, + 0.01451089, + -0.008198055, + -0.011656506, + 0.0044242945, + 0.031491153, + 0.01017621, + -0.010408543, + -0.009034456, + -0.0023283141, + 0.012021601, + 0.015639367, + 0.011736163, + 0.007912617, + 0.02031259, + 0.022104878, + -0.02241023, + 0.00041156227, + -0.009817752, + -0.030880447, + -0.0017823302, + 0.0030933553, + -0.04128899, + -0.0007783174, + 0.012393335, + 0.0122273825, + -0.009087561, + 0.022728859, + -0.002884255, + 0.028065892, + 0.0047396044, + 0.008065294, + 0.015519881, + 0.0133956885, + -0.02279524, + -0.011729525, + 0.0037206558, + -0.0046732235, + 0.003587894, + 0.024401661, + -0.013574918, + 0.012685412, + -0.0041620894, + 0.020578114, + 0.007394845, + 0.014139156, + -0.012512821, + -0.021042781, + 0.022423506, + -0.015360567, + 0.004009413, + 0.0104550095, + -0.024799947, + -0.0081449505, + -0.00063850236, + 0.0070231115, + -0.0009633545, + -0.015705748, + -0.0028942123, + -0.008815398, + 0.007461226, + -0.014417957, + -0.012931022, + 0.0015674217, + -0.02506547, + -0.0063128346, + -0.013422241, + -0.0058614435, + -0.0006007482, + -0.015002109, + 0.0037040606, + -0.008410474, + -0.0016089098, + -0.018653065, + 0.020538285, + -0.016980262, + -0.042244878, + -0.017498035, + 0.006727716, + -0.01877255, + 0.008987989, + 0.00077665783, + -0.0007119364, + -0.0067243967, + 0.0038467797, + -0.018055636, + -0.01440468, + 0.007534245, + 0.0051212953, + 0.002741536, + 0.011523744, + -0.0018603279, + 0.023684746, + 0.016196968, + 0.01731217, + -0.01992758, + 0.009372999, + -0.01982137, + 0.001150051, + -0.014417957, + 0.005672258, + -0.015785405, + 0.0049387473, + -0.0051445286, + 0.012632307, + 0.0011666464, + 0.024587527, + 0.04259006, + -0.0025672857, + 0.02311387, + -0.014524166, + 0.0013848739, + -0.04105002, + -0.010089914, + -0.009087561, + 0.015440224, + 0.009207047, + 0.0128048975, + -0.030216638, + -0.02549031, + 0.00499849, + 0.02737553, + 0.024985814, + -0.015055214, + 0.007580712, + -0.003979542, + 0.0016304837, + 0.0010446712, + 0.0033373055, + 0.0066314633, + -0.011948583, + -0.021281753, + 0.012161002, + 0.030747686, + 0.03555367, + 0.023751127, + -0.03159736, + -0.0110590765, + 0.015758853, + -0.0012197511, + -0.0023249951, + -0.0007488608, + 0.0074877786, + 0.01643594, + -0.008098484, + 0.03730613, + -0.0010056724, + -0.000034798173, + 0.011702972, + 0.039563086, + -0.012280487, + 0.027747264, + 0.018387541, + 0.033057746, + -0.004835857, + -0.00471969, + 0.025450481, + -0.0051146573, + 0.014603823, + 0.00022258384, + 0.00060863094, + 0.015665919, + -0.021626934, + -0.013674489, + 0.0062066247, + 0.018560132, + 0.031942543, + 0.012054792, + 0.004902238, + 0.0028510645, + -0.027667606, + 0.009817752, + -0.002580562, + 0.0069036256, + 0.020047067, + -0.009704905, + -0.012619031, + -0.0056755766, + -0.0036443176, + 0.019383255, + 0.0030701219, + 0.024972538, + 0.009100837, + 0.026353262, + 0.012758431, + 0.029074885, + 0.021202097, + -0.0038102702, + -0.032048754, + 0.003996137, + 0.0029738694, + 0.0032277768, + -0.026127568, + -0.02213143, + 0.0028742978, + 0.0010637557, + 0.000580419, + 0.0021789568, + 0.00083764544, + 0.026924139, + -0.03265946, + 0.0059211864, + 0.021892458, + 0.01178263, + 0.0018188398, + 0.009718181, + -0.020047067, + 0.017989255, + 0.0046035233, + -0.010561219, + -0.010342162, + 0.009505761, + -0.018334435, + -0.00667793, + -0.024534423, + 0.00035347888, + 0.00082561385, + -0.006143563, + 0.016820949, + -0.0013500239, + -0.0069832825, + 0.015347291, + -0.005094743, + 0.001838754, + 0.017073197, + 0.02521151, + 0.006209944, + -0.015612815, + -0.009744733, + -0.019794818, + 0.007786493, + 0.037624758, + 0.017564416, + 0.0076802834, + 0.0026203906, + 0.0022403593, + -0.024560975, + -0.04062518, + -0.016581977, + 0.00789934, + 0.0099305995, + 0.006996559, + 0.011078991, + 0.016236795, + -0.0068969876, + 0.01374087, + 0.014922452, + -0.0042882133, + 0.00022901449, + -0.0006692036, + 0.001359981, + -0.00007581957, + 0.0042616613, + 0.0066381013, + 0.012512821, + 0.021534001, + 0.0032775626, + 0.016913882, + -0.00789934, + -0.009200408, + -0.020286039, + -0.017033368, + 0.014378128, + 0.009233599, + 0.0070828544, + -0.013229736, + 0.025928425, + -0.011862287, + 0.008383922, + 0.012632307, + -0.0003097089, + 0.007593988, + 0.0059079104, + -0.0026369859, + -0.0262205, + 0.003335646, + -0.0067609064, + -0.0042882133, + 0.008549875, + -0.007600626, + -0.012592479, + 0.028623493, + -0.0030502076, + -0.006989921, + -0.015785405, + 0.010050085, + 0.016714739, + -0.023724575, + -0.006346025, + -0.014245366, + -0.032154962, + -0.03388087, + -0.024308728, + -0.002461076, + -0.003733932, + -0.02195884, + -0.021069333, + -0.022144707, + -0.007872788, + -0.017179407, + -0.009034456, + -0.010893124, + -0.02478667, + -0.020153277, + -0.023976821, + 0.014656927, + 0.0005368565, + -0.015878338, + 0.010123105, + -0.0030717815, + 0.01555971, + 0.0018321159, + -0.036244035, + 0.00017176087, + -0.013375774, + -0.010375353, + 0.026512576, + 0.016581977, + 0.013847079, + 0.015719024, + 0.013223098, + 0.004975257, + -0.0010579474, + -0.0034385365, + -0.029048331, + 0.017298892, + -0.022529716, + 0.008463579, + -0.014723309, + -0.005814977, + -0.009027818, + -0.009738095, + -0.0104682855, + -0.005044957, + 0.007905979, + 0.011656506, + 0.003153098, + -0.0005231654, + 0.019954132, + -0.021985391, + -0.005307162, + 0.0021839354, + -0.025184957, + 0.013926737, + -0.0059908866, + 0.0065717204, + 0.009884133, + -0.0062298584, + 0.03388087, + 0.0028577026, + -0.015931444, + 0.0010986058, + -0.025808938, + 0.0022835068, + 0.014152432, + 0.015227805, + 0.013701041, + -0.007872788, + -0.030614924, + -0.026393091, + 0.0010753724, + -0.016940435, + 0.013647936, + -0.007408121, + -0.024308728, + -0.031915992, + -0.018161846, + 0.00072521257, + 0.028862465, + 0.012234021, + -0.019555846, + -0.027641054, + -0.00082810316, + -0.0019150922, + -0.016276624, + -0.01125822, + -0.034146395, + -0.015294186, + 0.006671292, + -0.015533158, + 0.013674489, + -0.0011766035, + -0.017325444, + -0.023233354, + -0.013189907, + 0.0005580154, + -0.03188944, + -0.007056302, + -0.0059942054, + 0.03411984, + 0.04317421, + 0.029420065, + 0.006488744, + -0.0022436783, + 0.013063784, + 0.00012207884, + 0.008118398, + -0.023246631, + 0.0051909955, + -0.00894816, + 0.0081316745, + 0.0023200165, + 0.011510468, + -0.0005770999, + 0.00016979019, + 0.010129742, + 0.015506605, + -0.0073815687, + 0.0031995648, + -0.026578957, + -0.016674912, + 0.0049652997, + 0.0072687212, + -0.016568702, + -0.001964878, + -0.015692472, + -0.0048955996, + 0.027773816, + 0.012864641, + 0.01594472, + 0.008244522, + 0.017139578, + -0.01772373, + -0.0012521119, + 0.011689696, + 0.0111121815, + -0.0036476366, + 0.0012570905, + -0.007826322, + -0.016754568, + 0.011948583, + -0.0045968853, + 0.023963546, + -0.0052739717, + 0.014656927, + 0.009731457, + 0.010727172, + -0.01705992, + -0.0026071144, + 0.010760362, + 0.000919377, + -0.006365939, + -0.03013698, + -0.010554581, + -0.018613236, + 0.013886908, + 0.029420065, + -0.013030593, + 0.016860778, + -0.019237218, + -0.022118153, + 0.007919255, + -0.0004003605, + 0.046546366, + 0.01349526, + 0.006352663, + 0.014258642, + 0.0031813101, + -0.027017072, + 0.0070828544, + -0.020219658, + 0.0037140178, + 0.023366116, + 0.040386207, + -0.016382834, + -0.0023681426, + 0.0064522345, + 0.016528873, + 0.0006804054, + -0.02891557, + -0.0043545947, + 0.01101261, + -0.0014778073, + -0.018055636, + -0.0077001974, + -0.0358723, + 0.003373815, + -0.00071940426, + -0.011822458, + -0.024295451, + -0.009791199, + -0.026565682, + 0.020989677, + -0.035155386, + 0.01832116, + 0.014776413, + -0.028012788, + -0.007262083, + 0.0030402504, + -0.029446619, + 0.00010174965, + 0.009758009, + 0.03767786, + -0.0154535, + 0.009346447, + 0.016077481, + 0.0041189417, + -0.027800368, + 0.01720596, + -0.011158649, + 0.027800368, + -0.03003077, + -0.0072819972, + 0.0014296811, + 0.0145374425, + 0.0043280423, + -0.017086472, + -0.01611731, + -0.01258584, + -0.016927158, + 0.007607264, + 0.018825656, + 0.011331239, + -0.0057784673, + 0.001569911, + -0.013900184, + -0.014776413, + -0.0050814664, + -0.0012454737, + -0.0115967635, + -0.017458206, + -0.013203184, + -0.0063692583, + -0.01244644, + 0.011882202, + 0.0007708495, + -0.02035242, + 0.016250072, + 0.018414093, + -0.029526275, + 0.012751793, + -0.01555971, + 0.0013840442, + -0.019502742, + 0.0063758963, + 0.0037538463, + -0.035686433, + 0.027534844, + -0.016409386, + -0.03247359, + -0.008782208, + -0.0059842486, + 0.014338299, + 0.009233599, + -0.0053171194, + 0.006160158, + 0.0072952732, + 0.01401967, + 0.008815398, + -0.023790956, + 0.013096974, + -0.0031365028, + 0.005044957, + 0.0005356118, + -0.009379637, + 0.0066248253, + -0.00010724682, + 0.010289057, + 0.008815398, + -0.02279524, + -0.019701885, + -0.0027747264, + 0.016183691, + -0.014205537, + -0.003933075, + -0.013375774, + -0.005751915, + -0.010116466, + 0.004988533, + -0.005904591, + -0.008656085, + -0.017431654, + -0.011988411, + -0.01594472, + 0.00660823, + -0.027216217, + 0.0073218257, + -0.029977666, + -0.004593566, + -0.026671892, + -0.028517283, + -0.0050084474, + 0.009844304, + 0.025729282, + -0.013780698, + -0.026751548, + 0.004905557, + -0.035951957, + -0.026738273, + -0.019768266, + 0.0048690476, + 0.005250738, + 0.0014603822, + -0.018892037, + 0.017683903, + 0.0067177587, + 0.027694158, + -0.002618731, + -0.012419888, + 0.01772373, + -0.0032593077, + 0.006611549, + 0.016648358, + -0.03789028, + -0.023100592, + 0.023684746, + 0.0031248862, + 0.016382834, + 0.019967409, + -0.008941523, + -0.02014, + 0.0073882067, + 0.011357792, + -0.0031796505, + -0.0030253148, + -0.0010206081, + -0.017577693, + -0.009598695, + 0.002915786, + 0.001325131, + -0.0029207645, + -0.010780277, + -0.00325101, + -0.00811176, + -0.00073434, + -0.030083876, + -0.012864641, + -0.012745155, + -0.011769353, + 0.018785827, + -0.008264436, + -0.002675155, + 0.024255622, + 0.005483072, + -0.018480474, + -0.005426648, + 0.015095043, + 0.00044392303, + 0.011271496, + -0.0027548121, + 0.0026884312, + -0.00894816, + -0.015161424, + -0.014975557, + -0.024600804, + 0.004457485, + -0.015519881, + -0.012366783, + -0.012579202, + 0.01478969, + 0.0075541595, + -0.017962702, + -0.0017441611, + -0.014059499, + 0.005499667, + -0.0026884312, + 0.0031929268, + 0.0010853296, + -0.008045379, + 0.017471483, + 0.02590187, + -0.018546855, + -0.007826322, + 0.009333171, + 0.0157323, + 0.000086036016, + 0.004776114, + 0.22155327, + 0.006787459, + -0.0017823302, + 0.024919434, + 0.0023449094, + 0.03210186, + 0.0047329664, + -0.010879848, + 0.0044342517, + 0.015334014, + 0.029499723, + 0.019715162, + -0.008569789, + -0.0018901994, + -0.0077400263, + -0.019210665, + -0.005088105, + -0.023153698, + -0.032739118, + -0.029313855, + 0.00082146504, + -0.0212552, + 0.0044309325, + -0.005446562, + 0.018613236, + -0.009751371, + -0.013023955, + -0.001996409, + 0.01915756, + 0.017431654, + -0.031092867, + -0.0070231115, + 0.025330994, + -0.00018099198, + -0.025131851, + -0.011025886, + 0.0116498675, + -0.02506547, + 0.029234199, + -0.012287126, + 0.0069766445, + 0.0018752636, + 0.014271918, + 0.005108019, + -0.0109064, + 0.014391404, + 0.0062597296, + -0.031411495, + 0.00014935728, + 0.013236375, + -0.02891557, + -0.0006671292, + 0.008662722, + 0.012161002, + 0.020963125, + -0.0133691365, + 0.02653913, + -0.017989255, + 0.007978998, + 0.0093398085, + -0.02024621, + 0.03265946, + -0.02846418, + 0.025397375, + -0.024693737, + -0.0027050264, + -0.019330151, + -0.0104417335, + 0.015626092, + -0.006541849, + 0.004653309, + -0.025118576, + 0.0038268655, + 0.004045923, + -0.017564416, + -0.02444149, + 0.030296294, + 0.028756255, + 0.03927101, + 0.010767001, + -0.012034878, + -0.007122683, + -0.022476612, + -0.034942966, + -0.028411074, + -0.03927101, + -0.0037505273, + -0.0038799702, + -0.00037111135, + -0.009718181, + -0.013455432, + -0.015400395, + -0.0066978442, + -0.010760362, + 0.015121595, + 0.03111942, + 0.007992274, + 0.0270569, + -0.003104972, + 0.010056724, + -0.018414093, + 0.006472149, + 0.021281753, + 0.0043579135, + -0.00021490853, + 0.0008546556, + -0.01269205, + -0.003936394, + 0.0008870163, + 0.0009816092, + 0.0054664765, + -0.031278733, + 0.017245788, + 0.00027734818, + 0.005161124, + 0.0048093046, + -0.003923118, + -0.027149836, + 0.006950092, + -0.00615352, + 0.014205537, + 0.0016620146, + 0.0047396044, + 0.0039994563, + -0.015440224, + -0.0055627287, + -0.026273604, + 0.0013276202, + 0.0021009592, + -0.034810204, + 0.0064522345, + 0.00042608313, + 0.02307404, + -0.005957696, + 0.0016869075, + -0.0032775626, + -0.009041094, + -0.01227385, + -0.04349284, + 0.015652644, + 0.013468708, + -0.0023249951, + -0.011171925, + 0.0030352718, + -0.0061203293, + -0.023153698, + 0.046068422, + -0.005582643, + -0.02405648, + 0.005433286, + -0.02814555, + -0.0036874653, + 0.0067841397, + 0.006628144, + 0.029844904, + -0.0044276137, + -0.029127989, + -0.04548427, + 0.022091601, + 0.0038069512, + -0.030269742, + 0.0051578046, + 0.043572497, + -0.0144843375, + -0.02891557, + -0.010461648, + -0.17375894, + 0.029154541, + 0.019648781, + -0.00038335036, + 0.0029572742, + -0.0026469429, + 0.035925403, + -0.012021601, + 0.0015566348, + -0.0033124126, + 0.0010430117, + -0.010620962, + -0.022582822, + 0.00601412, + 0.008364008, + -0.0016586956, + -0.0011102224, + -0.013860356, + 0.022542993, + 0.020564837, + 0.018414093, + -0.008908332, + 0.032951534, + -0.011908754, + 0.010169571, + -0.011198477, + 0.0029108075, + 0.033084296, + 0.0029008503, + -0.0010015236, + -0.019794818, + 0.005844848, + 0.011669782, + 0.0052208668, + 0.010129742, + 0.0037737607, + 0.02880936, + -0.018599961, + -0.015095043, + 0.026578957, + 0.019662056, + 0.006823968, + -0.00045885876, + -0.019396532, + -0.0047993474, + 0.017192682, + 0.039589636, + -0.00874238, + 0.02146762, + -0.007667007, + 0.018785827, + -0.012758431, + -0.010010257, + -0.02052501, + 0.016090758, + 0.0061867107, + -0.0145507185, + 0.008065294, + 0.0104284575, + -0.0022386997, + -0.008324179, + -0.021640211, + 0.01705992, + -0.010541305, + -0.01639611, + -0.0074413116, + -0.034703992, + 0.007016473, + -0.003083398, + 0.0013691084, + -0.005108019, + -0.007886064, + 0.00053270767, + -0.018865485, + 0.025503585, + 0.005101381, + -0.027534844, + 0.015028661, + -0.009286704, + 0.006233177, + 0.00004343289, + 0.036031615, + 0.00957878, + 0.019250493, + 0.0024411618, + 0.0023664832, + -0.0030269742, + -0.007939169, + 0.0058581247, + 0.00587472, + 0.036589216, + -0.035288148, + -0.012997403, + -0.0110989055, + -0.002492607, + 0.008151589, + -0.008085207, + -0.00734174, + -0.0016802694, + 0.008403837, + -0.007793131, + -0.003913161, + -0.025437204, + 0.027123282, + 0.019330151, + -0.008729103, + 0.003943032, + 0.010289057, + 0.029977666, + 0.0014836156, + -0.024282174, + -0.0024361832, + 0.0110325245, + 0.021719867, + 0.012844726, + 0.015002109, + 0.020737428, + -0.013037231, + 0.014802966, + -0.0027332383, + 0.041634172, + -0.00926679, + -0.018759275, + 0.018666342, + 0.005386819, + -0.008822037, + -0.068399, + -0.054804165, + 0.027800368, + 0.04954679, + -0.00437119, + 0.029127989, + 0.03180978, + 0.021321582, + -0.022503164, + 0.010554581, + -0.006823968, + -0.021387963, + -0.021865906, + -0.0074479496, + 0.0037206558, + 0.004132218, + 0.01073381, + -0.0021673401, + -0.0012819833, + 0.041235887, + -0.010202762, + 0.004839176, + 0.0081715025, + -0.030402504, + -0.023764404, + -0.010800191, + -0.018374264, + 0.033641897, + 0.005416691, + -0.0055096243, + -0.0032775626, + -0.018095464, + 0.008563151, + -0.02339267, + -0.013674489, + 0.0023382711, + -0.028411074, + -0.0024063117, + 0.026658615, + -0.012413249, + 0.009333171, + 0.026446195, + -0.009107475, + -0.024560975, + 0.0011085629, + -0.02395027, + 0.0013857037, + 0.01926377, + -0.0020710877, + -0.031278733, + -0.015095043, + 0.0041720467, + -0.012798259, + 0.010162933, + 0.0063128346, + -0.010972782, + 0.045617033, + 0.016874054, + -0.010368714, + -0.0055992384, + -0.0092999805, + 0.0015782086, + -0.013581555, + 0.017843217, + -0.01615714, + 0.0036575939, + -0.027110007, + -0.013621384, + 0.022197811, + 0.0013964906, + -0.007348378, + 0.0145772705, + -0.003996137, + 0.0008364008, + -0.03411984, + 0.013030593, + -0.021454344, + -0.05034336, + 0.021095887, + -0.0055029863, + -0.025623072, + -0.023525432, + 0.007335102, + -0.043413185, + 0.016316453, + 0.016196968, + 0.0093132565, + -0.0110989055, + 0.0154535, + -0.045218747, + 0.0037737607, + 0.01639611, + 0.019887751, + -0.023366116, + -0.024043202, + 0.014258642, + 0.004271618, + -0.006877073, + 0.021387963, + -0.0019781543, + -0.036350243, + -0.009114114, + -0.037359234, + 0.01919739, + 0.011829097, + -0.015665919, + -0.0015591241, + 0.0144843375, + -0.003139822, + -0.024083031, + -0.015307462, + -0.0040990277, + -0.013223098, + 0.0024278855, + -0.008702551, + -0.0033207103, + -0.009804476, + -0.010554581, + 0.031066315, + 0.0044408897, + 0.025370823, + 0.009406189, + 0.025583243, + -0.002066109, + 0.015267633, + 0.008337456, + -0.009426104, + 0.01590489, + -0.011716249, + 0.007713474, + -0.029552827, + -0.013900184, + 0.0050150855, + -0.01650232, + -0.0015757193, + 0.008549875, + -0.020471904, + 0.008397198, + -0.013136802, + 0.021520725, + 0.0060406723, + 0.012858002, + -0.004723009, + -0.029313855, + 0.009240237, + -0.0212552, + -0.028118998, + 0.017803388, + -0.0314646, + 0.012353507, + 0.029632485, + -0.000016128512, + 0.016966987, + 0.009711542, + -0.037253026, + -0.015095043, + 0.013442155, + -0.00905437, + -0.000982439, + -0.0020495139, + 0.008337456, + -0.020644495, + 0.042085562, + -0.000744712, + 0.021135716, + -0.0072886352, + 0.01643594, + 0.013767422, + -0.0044707614, + -0.014763137, + 0.018852208, + -0.03080079, + -0.0049188333, + 0.0058846767, + 0.008330817, + 0.008257798, + 0.024202518, + 0.02307404, + 0.011065715, + 0.00036053188, + -0.00049412367, + 0.036270585, + 0.027043626, + 0.011902116, + -0.027773816, + 0.013289479, + 0.018374264, + -0.0033157317, + 0.0016636741, + 0.0020677685, + -0.012293763, + 0.008184779, + -0.034252603, + 0.010753725, + 0.008675998, + 0.00968499, + -0.003793675, + -0.011218391, + 0.010375353, + -0.0005737809, + 0.019781543, + 0.020591391, + 0.019954132, + -0.00053976063, + -0.0059444197, + -0.022675755, + -0.010003619, + 0.0038467797, + -0.0212552, + -0.033482585, + -0.015572986, + 0.0037737607, + 0.01451089, + 0.0036376796, + 0.007454588, + 0.013979842, + -0.013402327, + 0.014975557, + -0.010435095, + 0.0151747, + -0.030375952, + 0.023166973, + -0.0024760119, + -0.005881358, + 0.019914305, + -0.008596341, + 0.017737007, + -0.0036111271, + 0.012499545, + -0.02647275, + 0.0053901384, + 0.008556513, + 0.019648781, + 0.00874238, + -0.012439802, + -0.028623493, + -0.022330573, + -0.0029340407, + -0.016303178, + 0.007474502, + -0.016555425, + 0.060645696, + 0.0023631642, + -0.012054792, + 0.017604245, + 0.013103612, + 0.026061187, + 0.015533158, + 0.025742557, + 0.00013753316, + -0.013940013, + 0.02880936, + 0.010109829, + -0.0036111271, + -0.012419888, + -0.045457717, + 0.022835068, + -0.014139156, + 0.007819683, + -0.010461648, + -0.012008325, + 0.008895056, + 0.015984548, + 0.024043202, + -0.00059825886, + -0.0036376796, + -0.007939169, + 0.0242689, + -0.022197811, + -0.026313433, + -0.026724996, + 0.010939592, + 0.0023449094, + -0.012074706, + -0.018493751, + 0.017697178, + -0.0052142288, + -0.00360117, + 0.0056058764, + 0.01070062, + 0.0035248317, + 0.023671469, + 0.030880447, + -0.020299314, + -0.0145905465, + 0.018055636, + -0.013727593, + -0.023313012, + 0.013236375, + -0.0020113448 + ] + } + ], + "usage": { + "prompt_tokens": 4, + "total_tokens": 4 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_aml_index.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_aml_index.json new file mode 100644 index 000000000000..5cb1d840081b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_aml_index.json @@ -0,0 +1,62 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion for the provided AML index. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "data_sources": [ + { + "type": "azure_ml_index", + "parameters": { + "project_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.MachineLearningServices/workspaces/{workspace-id}", + "name": "gm-cars", + "version": "5" + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", + "context": { + "citations": [ + { + "content": "Content of the citation", + "url": "https://www.example.com", + "title": "Title of the citation", + "filepath": "path/to/file", + "chunk_id": "chunk-id" + } + ] + } + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_azure_search_advanced.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_azure_search_advanced.json new file mode 100644 index 000000000000..c47d97c1984e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_azure_search_advanced.json @@ -0,0 +1,86 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion based on Azure Cognitive Services vector data and user-assigned managed identity. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "data_sources": [ + { + "type": "azure_search", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "authentication": { + "type": "user_assigned_managed_identity", + "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}" + }, + "index_name": "{index name}", + "query_type": "vector", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "in_scope": true, + "top_n_documents": 5, + "strictness": 3, + "role_information": "You are an AI assistant that helps people find information.", + "fields_mapping": { + "content_fields_separator": "\\n", + "content_fields": [ + "content" + ], + "filepath_field": "filepath", + "title_field": "title", + "url_field": "url", + "vector_fields": [ + "contentvector" + ] + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", + "context": { + "citations": [ + { + "content": "Content of the citation", + "url": "https://www.example.com", + "title": "Title of the citation", + "filepath": "path/to/file", + "chunk_id": "chunk-id" + } + ] + } + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_azure_search_image_vector.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_azure_search_image_vector.json new file mode 100644 index 000000000000..1699f6235d2c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_azure_search_image_vector.json @@ -0,0 +1,67 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion based on Azure Cognitive Services image vector data. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "data_sources": [ + { + "type": "azure_search", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "index_name": "{index name}", + "query_type": "vector", + "fields_mapping": { + "image_vector_fields": [ + "image_vector" + ] + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", + "context": { + "citations": [ + { + "content": "Content of the citation", + "url": "https://www.example.com", + "title": "Title of the citation", + "filepath": "path/to/file", + "chunk_id": "chunk-id" + } + ] + } + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_azure_search_minimum.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_azure_search_minimum.json new file mode 100644 index 000000000000..b0cae005e699 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_azure_search_minimum.json @@ -0,0 +1,61 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion based on Azure Cognitive Services data and system-assigned managed identity. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "data_sources": [ + { + "type": "azure_search", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "index_name": "{index name}" + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", + "context": { + "citations": [ + { + "content": "Content of the citation", + "url": "https://www.example.com", + "title": "Title of the citation", + "filepath": "path/to/file", + "chunk_id": "chunk-id" + } + ] + } + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_cosmos_db.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_cosmos_db.json new file mode 100644 index 000000000000..a3c6c93ecf32 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_cosmos_db.json @@ -0,0 +1,78 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion for the provided Azure Cosmos DB. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "data_sources": [ + { + "type": "azure_cosmos_db", + "parameters": { + "authentication": { + "type": "connection_string", + "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000" + }, + "database_name": "vectordb", + "container_name": "azuredocs", + "index_name": "azuredocindex", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "fields_mapping": { + "content_fields": [ + "content" + ], + "vector_fields": [ + "contentvector" + ] + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", + "context": { + "citations": [ + { + "content": "Content of the citation", + "url": "https://www.example.com", + "title": "Title of the citation", + "filepath": "path/to/file", + "chunk_id": "chunk-id" + } + ] + } + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_elasticsearch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_elasticsearch.json new file mode 100644 index 000000000000..42c38d6e1e5f --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_elasticsearch.json @@ -0,0 +1,66 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion for the provided Elasticsearch. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "data_sources": [ + { + "type": "elasticsearch", + "parameters": { + "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io", + "index_name": "{index name}", + "authentication": { + "type": "key_and_key_id", + "key": "{key}", + "key_id": "{key id}" + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", + "context": { + "citations": [ + { + "content": "Content of the citation", + "url": "https://www.example.com", + "title": "Title of the citation", + "filepath": "path/to/file", + "chunk_id": "chunk-id" + } + ] + } + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_pinecone.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_pinecone.json new file mode 100644 index 000000000000..0c5c47d71096 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_pinecone.json @@ -0,0 +1,78 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion for the provided Pinecone resource. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "data_sources": [ + { + "type": "pinecone", + "parameters": { + "authentication": { + "type": "api_key", + "key": "{api key}" + }, + "environment": "{environment name}", + "index_name": "{index name}", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "fields_mapping": { + "title_field": "title", + "url_field": "url", + "filepath_field": "filepath", + "content_fields": [ + "content" + ], + "content_fields_separator": "\n" + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", + "context": { + "citations": [ + { + "content": "Content of the citation", + "url": "https://www.example.com", + "title": "Title of the citation", + "filepath": "path/to/file", + "chunk_id": "chunk-id" + } + ] + } + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_image_generation.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_image_generation.json new file mode 100644 index 000000000000..29795a2c140a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_image_generation.json @@ -0,0 +1,31 @@ +{ + "operationId": "GetImageGenerations", + "title": "Creates images given a prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "body": { + "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.", + "n": 1, + "style": "natural", + "quality": "standard" + } + }, + "responses": { + "200": { + "body": { + "created": 1698342300, + "data": [ + { + "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&..." + }, + { + "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_01.png?se=2023-10-27T17%3A45%3A09Z&...", + "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat." + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_assistant_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_assistant_file.json new file mode 100644 index 000000000000..29ec22d7bac7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_assistant_file.json @@ -0,0 +1,19 @@ +{ + "title": "Retrieves an AssistantFile.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA", + "file_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX" + }, + "responses": { + "200": { + "body": { + "id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "object": "assistant.file", + "created_at": 1707324164, + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_assistant_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_assistant_file.yaml new file mode 100644 index 000000000000..6eee6f078e42 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_assistant_file.yaml @@ -0,0 +1,13 @@ +title: Retrieves an AssistantFile. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + assistant_id: asst_diz3BOIsXHMnqNnoMCyO9jlA + file_id: assistant-Vau3gDQ1MfiBJk4flihOxwZX +responses: + "200": + body: + id: assistant-Vau3gDQ1MfiBJk4flihOxwZX + object: assistant.file + created_at: 1707324164 + assistant_id: asst_diz3BOIsXHMnqNnoMCyO9jlA diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message.json new file mode 100644 index 000000000000..9a550cb58094 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message.json @@ -0,0 +1,33 @@ +{ + "title": "Retrieve a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "message_id": "msg_as3XIk1tpVP3hdHjWBGg3uG4" + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "file_ids": [], + "assistant_id": null, + "run_id": null, + "metadata": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message.yaml new file mode 100644 index 000000000000..fa03465fd4bf --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message.yaml @@ -0,0 +1,23 @@ +title: Retrieve a message. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_v7V4csrNOxtNmgcwGg496Smx + message_id: msg_as3XIk1tpVP3hdHjWBGg3uG4 +responses: + "200": + body: + id: msg_as3XIk1tpVP3hdHjWBGg3uG4 + object: thread.message + created_at: 1707298421 + thread_id: thread_v7V4csrNOxtNmgcwGg496Smx + role: user + content: + - type: text + text: + value: What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces. + annotations: [] + file_ids: [] + assistant_id: null + run_id: null + metadata: {} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message_file.json new file mode 100644 index 000000000000..461c91870ab1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message_file.json @@ -0,0 +1,20 @@ +{ + "title": "Retrieves a message file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_abc123", + "message_id": "msg_abc123", + "file_id": "file_abc123" + }, + "responses": { + "200": { + "body": { + "id": "file-abc123", + "object": "thread.message.file", + "created_at": 1699061776, + "message_id": "msg_abc123" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message_file.yaml new file mode 100644 index 000000000000..6ecd21611f33 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message_file.yaml @@ -0,0 +1,14 @@ +title: Retrieves a message file. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_abc123 + message_id: msg_abc123 + file_id: file_abc123 +responses: + "200": + body: + id: file-abc123 + object: thread.message.file + created_at: 1699061776 + message_id: msg_abc123 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run.json new file mode 100644 index 000000000000..24d2144a2de2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run.json @@ -0,0 +1,32 @@ +{ + "title": "Gets a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1707303196, + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "completed", + "started_at": 1707303197, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1707303201, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "file_ids": [], + "metadata": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run.yaml new file mode 100644 index 000000000000..f2c2d5018aec --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run.yaml @@ -0,0 +1,26 @@ +title: Gets a run. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_eRNwflE3ncDYak1np6MdMHJh + run_id: run_HsO8tYM4K5AAMAHgK0J3om8Q +responses: + "200": + body: + id: run_HsO8tYM4K5AAMAHgK0J3om8Q + object: thread.run + created_at: 1707303196 + assistant_id: asst_JtTwHk28cIocgFXZPCBxhOzl + thread_id: thread_eRNwflE3ncDYak1np6MdMHJh + status: completed + started_at: 1707303197 + expires_at: null + cancelled_at: null + failed_at: null + completed_at: 1707303201 + last_error: null + model: gpt-4-1106-preview + instructions: You are an AI model that empowers every person and every organization on the planet to achieve more. + tools: [] + file_ids: [] + metadata: {} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run_step.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run_step.json new file mode 100644 index 000000000000..2c2d2bcf175f --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run_step.json @@ -0,0 +1,40 @@ +{ + "title": "Retrieves a run step.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "step_id": "step_abc123" + }, + "responses": { + "200": { + "body": { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_abc123", + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run_step.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run_step.yaml new file mode 100644 index 000000000000..bb7817db59bc --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run_step.yaml @@ -0,0 +1,31 @@ +title: Retrieves a run step. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_eRNwflE3ncDYak1np6MdMHJh + run_id: run_HsO8tYM4K5AAMAHgK0J3om8Q + step_id: step_abc123 +responses: + "200": + body: + id: step_abc123 + object: thread.run.step + created_at: 1699063291 + run_id: run_abc123 + assistant_id: asst_abc123 + thread_id: thread_abc123 + type: message_creation + status: completed + cancelled_at: null + completed_at: 1699063291 + expired_at: null + failed_at: null + last_error: null + step_details: + type: message_creation + message_creation: + message_id: msg_abc123 + usage: + prompt_tokens: 123 + completion_tokens: 456 + total_tokens: 579 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/image_generation.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/image_generation.json new file mode 100644 index 000000000000..7c0a8629147c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/image_generation.json @@ -0,0 +1,71 @@ +{ + "title": "Creates images given a prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>", + "body": { + "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.", + "n": 1, + "style": "natural", + "quality": "standard" + } + }, + "responses": { + "200": { + "body": { + "created": 1698342300, + "data": [ + { + "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.", + "prompt_filter_results": { + "sexual": { + "severity": "safe", + "filtered": false + }, + "violence": { + "severity": "safe", + "filtered": false + }, + "hate": { + "severity": "safe", + "filtered": false + }, + "self_harm": { + "severity": "safe", + "filtered": false + }, + "profanity": { + "detected": false, + "filtered": false + }, + "custom_blocklists": { + "filtered": false, + "details": [] + } + }, + "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...", + "content_filter_results": { + "sexual": { + "severity": "safe", + "filtered": false + }, + "violence": { + "severity": "safe", + "filtered": false + }, + "hate": { + "severity": "safe", + "filtered": false + }, + "self_harm": { + "severity": "safe", + "filtered": false + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/image_generation.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/image_generation.yaml new file mode 100644 index 000000000000..7d6565c27d96 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/image_generation.yaml @@ -0,0 +1,49 @@ +title: "Creates images given a prompt." +parameters: + endpoint: "{endpoint}" + api-version: "2024-09-01-preview" + deployment-id: "<deployment-id>" + body: + prompt: "In the style of WordArt, Microsoft Clippy wearing a cowboy hat." + n: 1 + style: "natural" + quality: "standard" +responses: + "200": + body: + created: 1698342300 + data: + - revised_prompt: "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat." + prompt_filter_results: + sexual: + severity: "safe" + filtered: false + violence: + severity: "safe" + filtered: false + hate: + severity: "safe" + filtered: false + self_harm: + severity: "safe" + filtered: false + profanity: + detected: false + filtered: false + custom_blocklists: + filtered: false + details: [] + url: "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&..." + content_filter_results: + sexual: + severity: "safe" + filtered: false + violence: + severity: "safe" + filtered: false + hate: + severity: "safe" + filtered: false + self_harm: + severity: "safe" + filtered: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistant_files.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistant_files.json new file mode 100644 index 000000000000..31f785c226a4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistant_files.json @@ -0,0 +1,26 @@ +{ + "title": "Returns a list of assistant files.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "object": "assistant.file", + "created_at": 1707324164, + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" + } + ], + "first_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "last_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistant_files.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistant_files.yaml new file mode 100644 index 000000000000..92c75a510af7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistant_files.yaml @@ -0,0 +1,17 @@ +title: Returns a list of assistant files. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + assistant_id: asst_diz3BOIsXHMnqNnoMCyO9jlA +responses: + "200": + body: + object: list + data: + - id: assistant-Vau3gDQ1MfiBJk4flihOxwZX + object: assistant.file + created_at: 1707324164 + assistant_id: asst_diz3BOIsXHMnqNnoMCyO9jlA + first_id: assistant-Vau3gDQ1MfiBJk4flihOxwZX + last_id: assistant-Vau3gDQ1MfiBJk4flihOxwZX + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistants.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistants.json new file mode 100644 index 000000000000..f4a76a772dec --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistants.json @@ -0,0 +1,70 @@ +{ + "title": "Returns a list of assistants.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "order": "desc", + "limit": 20 + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "asst_abc123", + "object": "assistant", + "created_at": 1707257477, + "name": "Stock Analyst", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "tool_resources": {}, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + }, + { + "id": "asst_abc456", + "object": "assistant", + "created_at": 1698982718, + "name": "My Assistant", + "description": null, + "model": "gpt-4-turbo", + "instructions": "You are a helpful assistant designed to make me better at coding!", + "tools": [], + "tool_resources": {}, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + }, + { + "id": "asst_abc789", + "object": "assistant", + "created_at": 1698982643, + "name": null, + "description": null, + "model": "gpt-4-turbo", + "instructions": null, + "tools": [], + "tool_resources": {}, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + } + ], + "first_id": "asst_abc123", + "last_id": "asst_abc789", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistants.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistants.yaml new file mode 100644 index 000000000000..dad9fa73c64d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistants.yaml @@ -0,0 +1,54 @@ +title: Returns a list of assistants. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + order: desc + limit: 20 +responses: + "200": + body: + object: list + data: + - id: asst_abc123 + object: assistant + created_at: 1707257477 + name: Stock Analyst + description: null + model: gpt-4-1106-preview + instructions: You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs. + tools: + - type: code_interpreter + tool_resources: {} + metadata: {} + top_p: 1 + temperature: 1 + response_format: auto + - id: asst_abc456 + object: assistant + created_at: 1698982718 + name: My Assistant + description: null + model: gpt-4-turbo + instructions: You are a helpful assistant designed to make me better at coding! + tools: [] + tool_resources: {} + metadata: {} + top_p: 1 + temperature: 1 + response_format: auto + - id: asst_abc789 + object: assistant + created_at: 1698982643 + name: null + description: null + model: gpt-4-turbo + instructions: null + tools: [] + tool_resources: {} + metadata: {} + top_p: 1 + temperature: 1 + response_format: auto + first_id: asst_abc123 + last_id: asst_abc789 + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_message_files.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_message_files.json new file mode 100644 index 000000000000..d572b8884185 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_message_files.json @@ -0,0 +1,33 @@ +{ + "title": "Returns a list of message files.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_abc123", + "message_id": "msg_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "file-abc123", + "object": "thread.message.file", + "created_at": 1699061776, + "message_id": "msg_abc123" + }, + { + "id": "file-abc123", + "object": "thread.message.file", + "created_at": 1699061776, + "message_id": "msg_abc123" + } + ], + "first_id": "file-abc123", + "last_id": "file-abc123", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_message_files.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_message_files.yaml new file mode 100644 index 000000000000..caa7a4a4d8ef --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_message_files.yaml @@ -0,0 +1,22 @@ +title: Returns a list of message files. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_abc123 + message_id: msg_abc123 +responses: + "200": + body: + object: list + data: + - id: file-abc123 + object: thread.message.file + created_at: 1699061776 + message_id: msg_abc123 + - id: file-abc123 + object: thread.message.file + created_at: 1699061776 + message_id: msg_abc123 + first_id: file-abc123 + last_id: file-abc123 + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_messages.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_messages.json new file mode 100644 index 000000000000..d52370c6be20 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_messages.json @@ -0,0 +1,60 @@ +{ + "title": "List Messages", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "msg_abc123", + "object": "thread.message", + "created_at": 1699016383, + "assistant_id": null, + "thread_id": "thread_abc123", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "How does AI work? Explain it in simple terms.", + "annotations": [] + } + } + ], + "attachments": [], + "metadata": {} + }, + { + "id": "msg_abc456", + "object": "thread.message", + "created_at": 1699016383, + "assistant_id": null, + "thread_id": "thread_abc123", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "Hello, what is AI?", + "annotations": [] + } + } + ], + "attachments": [], + "metadata": {} + } + ], + "first_id": "msg_abc123", + "last_id": "msg_abc456", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_messages.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_messages.yaml new file mode 100644 index 000000000000..70e6ce9e569d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_messages.yaml @@ -0,0 +1,41 @@ +title: List Messages +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_abc123 +responses: + "200": + body: + object: list + data: + - id: msg_abc123 + object: thread.message + created_at: 1699016383 + assistant_id: null + thread_id: thread_abc123 + run_id: null + role: user + content: + - type: text + text: + value: How does AI work? Explain it in simple terms. + annotations: [] + attachments: [] + metadata: {} + - id: msg_abc456 + object: thread.message + created_at: 1699016383 + assistant_id: null + thread_id: thread_abc123 + run_id: null + role: user + content: + - type: text + text: + value: Hello, what is AI? + annotations: [] + attachments: [] + metadata: {} + first_id: msg_abc123 + last_id: msg_abc456 + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_run_steps.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_run_steps.json new file mode 100644 index 000000000000..dc4d16ef63fc --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_run_steps.json @@ -0,0 +1,47 @@ +{ + "title": "Returns a list of run steps belonging to a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_abc123", + "run_id": "run_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_abc123", + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + } + } + ], + "first_id": "step_abc123", + "last_id": "step_abc456", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_run_steps.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_run_steps.yaml new file mode 100644 index 000000000000..3a5bb39ce519 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_run_steps.yaml @@ -0,0 +1,35 @@ +title: Returns a list of run steps belonging to a run. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_abc123 + run_id: run_abc123 +responses: + "200": + body: + object: list + data: + - id: step_abc123 + object: thread.run.step + created_at: 1699063291 + run_id: run_abc123 + assistant_id: asst_abc123 + thread_id: thread_abc123 + type: message_creation + status: completed + cancelled_at: null + completed_at: 1699063291 + expired_at: null + failed_at: null + last_error: null + step_details: + type: message_creation + message_creation: + message_id: msg_abc123 + usage: + prompt_tokens: 123 + completion_tokens: 456 + total_tokens: 579 + first_id: step_abc123 + last_id: step_abc456 + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_runs.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_runs.json new file mode 100644 index 000000000000..3fc2080000a3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_runs.json @@ -0,0 +1,112 @@ +{ + "title": "Returns a list of runs belonging to a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699075072, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "completed", + "started_at": 1699075072, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699075073, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "tool_resources": { + "code_interpreter": { + "file_ids": [ + "file-abc123", + "file-abc456" + ] + } + }, + "metadata": {}, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + }, + { + "id": "run_abc456", + "object": "thread.run", + "created_at": 1699063290, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "completed", + "started_at": 1699063290, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699063291, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "tool_resources": { + "code_interpreter": { + "file_ids": [ + "file-abc123", + "file-abc456" + ] + } + }, + "metadata": {}, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + ], + "first_id": "run_abc123", + "last_id": "run_abc456", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_runs.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_runs.yaml new file mode 100644 index 000000000000..b25871083c0c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_runs.yaml @@ -0,0 +1,85 @@ +title: Returns a list of runs belonging to a thread. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_abc123 +responses: + "200": + body: + object: list + data: + - id: run_abc123 + object: thread.run + created_at: 1699075072 + assistant_id: asst_abc123 + thread_id: thread_abc123 + status: completed + started_at: 1699075072 + expires_at: null + cancelled_at: null + failed_at: null + completed_at: 1699075073 + last_error: null + model: gpt-4-turbo + instructions: null + incomplete_details: null + tools: + - type: code_interpreter + tool_resources: + code_interpreter: + file_ids: + - file-abc123 + - file-abc456 + metadata: {} + usage: + prompt_tokens: 123 + completion_tokens: 456 + total_tokens: 579 + temperature: 1 + top_p: 1 + max_prompt_tokens: 1000 + max_completion_tokens: 1000 + truncation_strategy: + type: auto + last_messages: null + response_format: auto + tool_choice: auto + - id: run_abc456 + object: thread.run + created_at: 1699063290 + assistant_id: asst_abc123 + thread_id: thread_abc123 + status: completed + started_at: 1699063290 + expires_at: null + cancelled_at: null + failed_at: null + completed_at: 1699063291 + last_error: null + model: gpt-4-turbo + instructions: null + incomplete_details: null + tools: + - type: code_interpreter + tool_resources: + code_interpreter: + file_ids: + - file-abc123 + - file-abc456 + metadata: {} + usage: + prompt_tokens: 123 + completion_tokens: 456 + total_tokens: 579 + temperature: 1 + top_p: 1 + max_prompt_tokens: 1000 + max_completion_tokens: 1000 + truncation_strategy: + type: auto + last_messages: null + response_format: auto + tool_choice: auto + first_id: run_abc123 + last_id: run_abc456 + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_file_batch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_file_batch.json new file mode 100644 index 000000000000..ae13119d54c4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_file_batch.json @@ -0,0 +1,33 @@ +{ + "title": "Returns a list of vector store files in a batch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "vector_store_id": "vs_abc123", + "batch_id": "vsfb_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "file-abc123", + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + }, + { + "id": "file-abc456", + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + } + ], + "first_id": "file-abc123", + "last_id": "file-abc456", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_file_batch.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_file_batch.yaml new file mode 100644 index 000000000000..3e0c13a705c1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_file_batch.yaml @@ -0,0 +1,22 @@ +title: Returns a list of vector store files in a batch. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + vector_store_id: vs_abc123 + batch_id: vsfb_abc123 +responses: + "200": + body: + object: list + data: + - id: file-abc123 + object: vector_store.file + created_at: 1699061776 + vector_store_id: vs_abc123 + - id: file-abc456 + object: vector_store.file + created_at: 1699061776 + vector_store_id: vs_abc123 + first_id: file-abc123 + last_id: file-abc456 + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_files.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_files.json new file mode 100644 index 000000000000..6959a228ef94 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_files.json @@ -0,0 +1,32 @@ +{ + "title": "Returns a list of vector store files.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "vector_store_id": "vs_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "file-abc123", + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + }, + { + "id": "file-abc456", + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + } + ], + "first_id": "file-abc123", + "last_id": "file-abc456", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_files.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_files.yaml new file mode 100644 index 000000000000..e29484eae667 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_files.yaml @@ -0,0 +1,21 @@ +title: Returns a list of vector store files. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + vector_store_id: vs_abc123 +responses: + "200": + body: + object: list + data: + - id: file-abc123 + object: vector_store.file + created_at: 1699061776 + vector_store_id: vs_abc123 + - id: file-abc456 + object: vector_store.file + created_at: 1699061776 + vector_store_id: vs_abc123 + first_id: file-abc123 + last_id: file-abc456 + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_stores.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_stores.json new file mode 100644 index 000000000000..f11095daaa53 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_stores.json @@ -0,0 +1,47 @@ +{ + "title": "Returns a list of vector stores.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "bytes": 139920, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + }, + { + "id": "vs_abc456", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ v2", + "bytes": 139920, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + } + ], + "first_id": "vs_abc123", + "last_id": "vs_abc456", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_stores.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_stores.yaml new file mode 100644 index 000000000000..2d8c453d3c4c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_stores.yaml @@ -0,0 +1,51 @@ +{ + "title": "Returns a list of vector stores.", + "parameters": + { "endpoint": "{endpoint}", "api-version": "2024-09-01-preview" }, + "responses": + { + "200": + { + "body": + { + "object": "list", + "data": + [ + { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "bytes": 139920, + "file_counts": + { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3, + }, + }, + { + "id": "vs_abc456", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ v2", + "bytes": 139920, + "file_counts": + { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3, + }, + }, + ], + "first_id": "vs_abc123", + "last_id": "vs_abc456", + "has_more": false, + }, + }, + }, +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_assistant.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_assistant.json new file mode 100644 index 000000000000..243a12679843 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_assistant.json @@ -0,0 +1,44 @@ +{ + "title": "Modifies an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "assistant_id": "asst_abc123", + "body": { + "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.", + "tools": [ + { + "type": "file_search" + } + ], + "model": "gpt-4-turbo" + } + }, + "responses": { + "200": { + "body": { + "id": "asst_123", + "object": "assistant", + "created_at": 1699009709, + "name": "HR Helper", + "description": null, + "model": "gpt-4-turbo", + "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.", + "tools": [ + { + "type": "file_search" + } + ], + "tool_resources": { + "file_search": { + "vector_store_ids": [] + } + }, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_assistant.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_assistant.yaml new file mode 100644 index 000000000000..d950b17bee07 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_assistant.yaml @@ -0,0 +1,29 @@ +title: Modifies an assistant. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + assistant_id: asst_abc123 + body: + instructions: You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files. + tools: + - type: file_search + model: gpt-4-turbo +responses: + "200": + body: + id: asst_123 + object: assistant + created_at: 1699009709 + name: HR Helper + description: null + model: gpt-4-turbo + instructions: You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files. + tools: + - type: file_search + tool_resources: + file_search: + vector_store_ids: [] + metadata: {} + top_p: 1 + temperature: 1 + response_format: auto diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_message.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_message.json new file mode 100644 index 000000000000..cd2bdf2378e7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_message.json @@ -0,0 +1,42 @@ +{ + "title": "Modify a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_abc123", + "message_id": "msg_abc123 ", + "body": { + "metadata": { + "modified": "true", + "user": "abc123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "msg_abc123", + "object": "thread.message", + "created_at": 1699017614, + "assistant_id": null, + "thread_id": "thread_abc123", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "How does AI work? Explain it in simple terms.", + "annotations": [] + } + } + ], + "file_ids": [], + "metadata": { + "modified": "true", + "user": "abc123" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_message.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_message.yaml new file mode 100644 index 000000000000..91c015766fe8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_message.yaml @@ -0,0 +1,29 @@ +title: Modify a message. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_abc123 + message_id: "msg_abc123 " + body: + metadata: + modified: "true" + user: abc123 +responses: + "200": + body: + id: msg_abc123 + object: thread.message + created_at: 1699017614 + assistant_id: null + thread_id: thread_abc123 + run_id: null + role: user + content: + - type: text + text: + value: How does AI work? Explain it in simple terms. + annotations: [] + file_ids: [] + metadata: + modified: "true" + user: abc123 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_run.json new file mode 100644 index 000000000000..99524da44988 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_run.json @@ -0,0 +1,66 @@ +{ + "title": "Modifies a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_abc123", + "run_id": "run_abc123", + "body": { + "metadata": { + "user_id": "user_abc123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699075072, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "completed", + "started_at": 1699075072, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699075073, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "tool_resources": { + "code_interpreter": { + "file_ids": [ + "file-abc123", + "file-abc456" + ] + } + }, + "metadata": { + "user_id": "user_abc123" + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_run.yaml new file mode 100644 index 000000000000..7933976c0973 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_run.yaml @@ -0,0 +1,55 @@ +{ + "title": "Modifies a run.", + "parameters": + { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_abc123", + "run_id": "run_abc123", + "body": { "metadata": { "user_id": "user_abc123" } }, + }, + "responses": + { + "200": + { + "body": + { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699075072, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "completed", + "started_at": 1699075072, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699075073, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "incomplete_details": null, + "tools": [{ "type": "code_interpreter" }], + "tool_resources": + { + "code_interpreter": + { "file_ids": ["file-abc123", "file-abc456"] }, + }, + "metadata": { "user_id": "user_abc123" }, + "usage": + { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579, + }, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { "type": "auto", "last_messages": null }, + "response_format": "auto", + "tool_choice": "auto", + }, + }, + }, +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_thread.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_thread.json new file mode 100644 index 000000000000..6aaaebeea592 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_thread.json @@ -0,0 +1,28 @@ +{ + "title": "Modifies a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "metadata": { + "modified": "true", + "user": "abc123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": { + "modified": "true", + "user": "abc123" + }, + "tool_resources": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_thread.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_thread.yaml new file mode 100644 index 000000000000..1b5d1bfdde6d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_thread.yaml @@ -0,0 +1,19 @@ +title: Modifies a thread. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_v7V4csrNOxtNmgcwGg496Smx + body: + metadata: + modified: "true" + user: abc123 +responses: + "200": + body: + id: thread_v7V4csrNOxtNmgcwGg496Smx + object: thread + created_at: 1707297136 + metadata: + modified: "true" + user: abc123 + tool_resources: {} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_vector_store.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_vector_store.json new file mode 100644 index 000000000000..35e295f4f080 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_vector_store.json @@ -0,0 +1,29 @@ +{ + "title": "Modifies a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "vector_store_id": "vs_abc123", + "body": { + "name": "Support FAQ" + } + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "bytes": 139920, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_vector_store.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_vector_store.yaml new file mode 100644 index 000000000000..ddc3879fee79 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_vector_store.yaml @@ -0,0 +1,21 @@ +title: Modifies a vector store. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + vector_store_id: vs_abc123 + body: + name: Support FAQ +responses: + "200": + body: + id: vs_abc123 + object: vector_store + created_at: 1699061776 + name: Support FAQ + bytes: 139920 + file_counts: + in_progress: 0 + completed: 3 + failed: 0 + cancelled: 0 + total: 3 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_assistant.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_assistant.json new file mode 100644 index 000000000000..90cf5d8b1d9a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_assistant.json @@ -0,0 +1,30 @@ +{ + "title": "Retrieves an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "assistant_id": "asst_abc123" + }, + "responses": { + "200": { + "body": { + "id": "asst_abc123", + "object": "assistant", + "created_at": 1699009709, + "name": "HR Helper", + "description": null, + "model": "gpt-4-turbo", + "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.", + "tools": [ + { + "type": "file_search" + } + ], + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_assistant.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_assistant.yaml new file mode 100644 index 000000000000..c98fe77bbe8b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_assistant.yaml @@ -0,0 +1,21 @@ +title: Retrieves an assistant. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + assistant_id: asst_abc123 +responses: + "200": + body: + id: asst_abc123 + object: assistant + created_at: 1699009709 + name: HR Helper + description: null + model: gpt-4-turbo + instructions: You are an HR bot, and you have access to files to answer employee questions about company policies. + tools: + - type: file_search + metadata: {} + top_p: 1 + temperature: 1 + response_format: auto diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_message.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_message.json new file mode 100644 index 000000000000..2c79c290e8fd --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_message.json @@ -0,0 +1,33 @@ +{ + "title": "Retrieves a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_abc123", + "message_id": "msg_abc123" + }, + "responses": { + "200": { + "body": { + "id": "msg_abc123", + "object": "thread.message", + "created_at": 1699017614, + "assistant_id": null, + "thread_id": "thread_abc123", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "How does AI work? Explain it in simple terms.", + "annotations": [] + } + } + ], + "attachments": [], + "metadata": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_message.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_message.yaml new file mode 100644 index 000000000000..4421dd91cb1a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_message.yaml @@ -0,0 +1,23 @@ +title: Retrieves a message. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_abc123 + message_id: msg_abc123 +responses: + "200": + body: + id: msg_abc123 + object: thread.message + created_at: 1699017614 + assistant_id: null + thread_id: thread_abc123 + run_id: null + role: user + content: + - type: text + text: + value: How does AI work? Explain it in simple terms. + annotations: [] + attachments: [] + metadata: {} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run.json new file mode 100644 index 000000000000..ede9a4a06f59 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run.json @@ -0,0 +1,51 @@ +{ + "title": "Retrieves a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_abc123", + "run_id": "run_abc123" + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699075072, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "completed", + "started_at": 1699075072, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699075073, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {}, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run.yaml new file mode 100644 index 000000000000..41f1160397ee --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run.yaml @@ -0,0 +1,40 @@ +title: Retrieves a run. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_abc123 + run_id: run_abc123 +responses: + "200": + body: + id: run_abc123 + object: thread.run + created_at: 1699075072 + assistant_id: asst_abc123 + thread_id: thread_abc123 + status: completed + started_at: 1699075072 + expires_at: null + cancelled_at: null + failed_at: null + completed_at: 1699075073 + last_error: null + model: gpt-4-turbo + instructions: null + incomplete_details: null + tools: + - type: code_interpreter + metadata: {} + usage: + prompt_tokens: 123 + completion_tokens: 456 + total_tokens: 579 + temperature: 1 + top_p: 1 + max_prompt_tokens: 1000 + max_completion_tokens: 1000 + truncation_strategy: + type: auto + last_messages: null + response_format: auto + tool_choice: auto diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run_step.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run_step.json new file mode 100644 index 000000000000..517db84138e3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run_step.json @@ -0,0 +1,40 @@ +{ + "title": "Retrieves a run step.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_abc123", + "run_id": "run_abc123", + "step_id": "step_abc123" + }, + "responses": { + "200": { + "body": { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_abc123", + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run_step.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run_step.yaml new file mode 100644 index 000000000000..567775bf38c9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run_step.yaml @@ -0,0 +1,31 @@ +title: Retrieves a run step. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_abc123 + run_id: run_abc123 + step_id: step_abc123 +responses: + "200": + body: + id: step_abc123 + object: thread.run.step + created_at: 1699063291 + run_id: run_abc123 + assistant_id: asst_abc123 + thread_id: thread_abc123 + type: message_creation + status: completed + cancelled_at: null + completed_at: 1699063291 + expired_at: null + failed_at: null + last_error: null + step_details: + type: message_creation + message_creation: + message_id: msg_abc123 + usage: + prompt_tokens: 123 + completion_tokens: 456 + total_tokens: 579 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_thread.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_thread.json new file mode 100644 index 000000000000..437233e6c135 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_thread.json @@ -0,0 +1,23 @@ +{ + "title": "Retrieves a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {}, + "tool_resources": { + "code_interpreter": { + "file_ids": [] + } + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_thread.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_thread.yaml new file mode 100644 index 000000000000..e3e9046858f6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_thread.yaml @@ -0,0 +1,15 @@ +title: Retrieves a thread. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_v7V4csrNOxtNmgcwGg496Smx +responses: + "200": + body: + id: thread_v7V4csrNOxtNmgcwGg496Smx + object: thread + created_at: 1707297136 + metadata: {} + tool_resources: + code_interpreter: + file_ids: [] diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store.json new file mode 100644 index 000000000000..d961c14ca4db --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store.json @@ -0,0 +1,17 @@ +{ + "title": "Retrieves a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "vector_store_id": "vs_abc123" + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776 + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store.yaml new file mode 100644 index 000000000000..b8c1d099df73 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store.yaml @@ -0,0 +1,11 @@ +title: Retrieves a vector store. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + vector_store_id: vs_abc123 +responses: + "200": + body: + id: vs_abc123 + object: vector_store + created_at: 1699061776 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file.json new file mode 100644 index 000000000000..0786a19ff5d6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file.json @@ -0,0 +1,21 @@ +{ + "title": "Retrieves a vector store file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "vector_store_id": "vs_abc123", + "file_id": "file-abc123" + }, + "responses": { + "200": { + "body": { + "id": "file-abc123", + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abcd", + "status": "completed", + "last_error": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file.yaml new file mode 100644 index 000000000000..0601c2490c0a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file.yaml @@ -0,0 +1,15 @@ +title: Retrieves a vector store file. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + vector_store_id: vs_abc123 + file_id: file-abc123 +responses: + "200": + body: + id: file-abc123 + object: vector_store.file + created_at: 1699061776 + vector_store_id: vs_abcd + status: completed + last_error: null diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file_batch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file_batch.json new file mode 100644 index 000000000000..128b84bf8206 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file_batch.json @@ -0,0 +1,27 @@ +{ + "title": "Retrieves a vector store file batch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "vector_store_id": "vs_abc123", + "batch_id": "vsfb_abc123" + }, + "responses": { + "200": { + "body": { + "id": "vsfb_abc123", + "object": "vector_store.file_batch", + "created_at": 1699061776, + "vector_store_id": "vs_abc123", + "status": "in_progress", + "file_counts": { + "in_progress": 1, + "completed": 1, + "failed": 0, + "cancelled": 0, + "total": 0 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file_batch.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file_batch.yaml new file mode 100644 index 000000000000..66df30f983ed --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file_batch.yaml @@ -0,0 +1,20 @@ +title: Retrieves a vector store file batch. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + vector_store_id: vs_abc123 + batch_id: vsfb_abc123 +responses: + "200": + body: + id: vsfb_abc123 + object: vector_store.file_batch + created_at: 1699061776 + vector_store_id: vs_abc123 + status: in_progress + file_counts: + in_progress: 1 + completed: 1 + failed: 0 + cancelled: 0 + total: 0 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/submit_tool_outputs_to_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/submit_tool_outputs_to_run.json new file mode 100644 index 000000000000..d327d5ddace9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/submit_tool_outputs_to_run.json @@ -0,0 +1,77 @@ +{ + "title": "When a run has the `status: \"requires_action\"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_123", + "run_id": "run_123", + "body": { + "tool_outputs": [ + { + "tool_call_id": "call_001", + "output": "70 degrees and sunny." + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "run_123", + "object": "thread.run", + "created_at": 1699075592, + "assistant_id": "asst_123", + "thread_id": "thread_123", + "status": "queued", + "started_at": 1699075592, + "expires_at": 1699076192, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "tools": [ + { + "type": "function", + "function": { + "name": "get_current_weather", + "description": "Get the current weather in a given location", + "parameters": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The city and state, e.g. San Francisco, CA" + }, + "unit": { + "type": "string", + "enum": [ + "celsius", + "fahrenheit" + ] + } + }, + "required": [ + "location" + ] + } + } + } + ], + "metadata": {}, + "usage": null, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/submit_tool_outputs_to_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/submit_tool_outputs_to_run.yaml new file mode 100644 index 000000000000..5b1d569c4cfc --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/submit_tool_outputs_to_run.yaml @@ -0,0 +1,57 @@ +title: | + When a run has the `status: "requires_action"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_123 + run_id: run_123 + body: + tool_outputs: + - tool_call_id: call_001 + output: 70 degrees and sunny. +responses: + "200": + body: + id: run_123 + object: thread.run + created_at: 1699075592 + assistant_id: asst_123 + thread_id: thread_123 + status: queued + started_at: 1699075592 + expires_at: 1699076192 + cancelled_at: null + failed_at: null + completed_at: null + last_error: null + model: gpt-4-turbo + instructions: null + tools: + - type: function + function: + name: get_current_weather + description: Get the current weather in a given location + parameters: + type: object + properties: + location: + type: string + description: The city and state, e.g. San Francisco, CA + unit: + type: string + enum: + - celsius + - fahrenheit + required: + - location + metadata: {} + usage: null + temperature: 1 + top_p: 1 + max_prompt_tokens: 1000 + max_completion_tokens: 1000 + truncation_strategy: + type: auto + last_messages: null + response_format: auto + tool_choice: auto diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.json new file mode 100644 index 000000000000..3be6ffd7734d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.json @@ -0,0 +1,12043 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "Azure OpenAI Service API", + "description": "Azure OpenAI APIs for completions and search", + "version": "2024-09-01-preview" + }, + "servers": [ + { + "url": "https://{endpoint}/openai", + "variables": { + "endpoint": { + "default": "your-resource-name.openai.azure.com" + } + } + } + ], + "security": [ + { + "bearer": [ + "api.read" + ] + }, + { + "apiKey": [] + } + ], + "paths": { + "/deployments/{deployment-id}/completions": { + "post": { + "summary": "Creates a completion for the provided prompt, parameters and chosen model.", + "operationId": "Completions_Create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "davinci", + "description": "Deployment id of the model which was deployed." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createCompletionRequest" + }, + "example": { + "prompt": "Negate the following sentence.The price for bubblegum increased on thursday.\n\n Negated Sentence:", + "max_tokens": 50 + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createCompletionResponse" + }, + "example": { + "model": "davinci", + "object": "text_completion", + "id": "cmpl-4509KAos68kxOqpE2uYGw81j6m7uo", + "created": 1637097562, + "choices": [ + { + "index": 0, + "text": "The price for bubblegum decreased on thursday.", + "logprobs": null, + "finish_reason": "stop" + } + ] + } + } + }, + "headers": { + "apim-request-id": { + "description": "Request ID for troubleshooting purposes", + "schema": { + "type": "string" + } + } + } + }, + "default": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/errorResponse" + } + } + }, + "headers": { + "apim-request-id": { + "description": "Request ID for troubleshooting purposes", + "schema": { + "type": "string" + } + } + } + } + }, + "x-ms-examples": { + "Create a completion.": { + "$ref": "./examples/completions.json" + } + } + } + }, + "/deployments/{deployment-id}/embeddings": { + "post": { + "summary": "Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.", + "operationId": "embeddings_create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "ada-search-index-v1" + }, + "description": "The deployment id of the model which was deployed." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true, + "properties": { + "input": { + "description": "Input text to get embeddings for, encoded as a string. To get embeddings for multiple inputs in a single request, pass an array of strings. Each input must not exceed 2048 tokens in length.\nUnless you are embedding code, we suggest replacing newlines (\\n) in your input with a single space, as we have observed inferior results when newlines are present.", + "oneOf": [ + { + "type": "string", + "default": "", + "example": "This is a test.", + "nullable": true + }, + { + "type": "array", + "minItems": 1, + "maxItems": 2048, + "items": { + "type": "string", + "minLength": 1, + "example": "This is a test.", + "nullable": false + } + } + ] + }, + "user": { + "description": "A unique identifier representing your end-user, which can help monitoring and detecting abuse.", + "type": "string", + "nullable": false + }, + "input_type": { + "description": "input type of embedding search to use", + "type": "string", + "example": "query" + }, + "encoding_format": { + "description": "The format to return the embeddings in. Can be either `float` or `base64`. Defaults to `float`.", + "type": "string", + "example": "float", + "nullable": true + }, + "dimensions": { + "description": "The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models.", + "type": "integer", + "example": 1, + "nullable": true + } + }, + "required": [ + "input" + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "object": { + "type": "string" + }, + "model": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "index": { + "type": "integer" + }, + "object": { + "type": "string" + }, + "embedding": { + "type": "array", + "items": { + "type": "number" + } + } + }, + "required": [ + "index", + "object", + "embedding" + ] + } + }, + "usage": { + "type": "object", + "properties": { + "prompt_tokens": { + "type": "integer" + }, + "total_tokens": { + "type": "integer" + } + }, + "required": [ + "prompt_tokens", + "total_tokens" + ] + } + }, + "required": [ + "object", + "model", + "data", + "usage" + ] + } + } + } + } + }, + "x-ms-examples": { + "Create a embeddings.": { + "$ref": "./examples/embeddings.json" + } + } + } + }, + "/deployments/{deployment-id}/chat/completions": { + "post": { + "summary": "Creates a completion for the chat message", + "operationId": "ChatCompletions_Create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "description": "Deployment id of the model which was deployed." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createChatCompletionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/createChatCompletionResponse" + }, + { + "$ref": "#/components/schemas/createChatCompletionStreamResponse" + } + ] + } + } + }, + "headers": { + "apim-request-id": { + "description": "Request ID for troubleshooting purposes", + "schema": { + "type": "string" + } + } + } + }, + "default": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/errorResponse" + } + } + }, + "headers": { + "apim-request-id": { + "description": "Request ID for troubleshooting purposes", + "schema": { + "type": "string" + } + } + } + } + }, + "x-ms-examples": { + "Create a chat completion.": { + "$ref": "./examples/chat_completions.json" + }, + "Creates a completion based on Azure Search data and system-assigned managed identity.": { + "$ref": "./examples/chat_completions_azure_search_minimum.json" + }, + "Creates a completion based on Azure Search image vector data.": { + "$ref": "./examples/chat_completions_azure_search_image_vector.json" + }, + "Creates a completion based on Azure Search vector data, previous assistant message and user-assigned managed identity.": { + "$ref": "./examples/chat_completions_azure_search_advanced.json" + }, + "Creates a completion for the provided Azure Cosmos DB.": { + "$ref": "./examples/chat_completions_cosmos_db.json" + }, + "Creates a completion for the provided Mongo DB.": { + "$ref": "./examples/chat_completions_mongo_db.json" + }, + "Creates a completion for the provided Elasticsearch.": { + "$ref": "./examples/chat_completions_elasticsearch.json" + }, + "Creates a completion for the provided Pinecone resource.": { + "$ref": "./examples/chat_completions_pinecone.json" + } + } + } + }, + "/deployments/{deployment-id}/audio/transcriptions": { + "post": { + "summary": "Transcribes audio into the input language.", + "operationId": "Transcriptions_Create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "whisper", + "description": "Deployment id of the whisper model." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/createTranscriptionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/audioResponse" + }, + { + "$ref": "#/components/schemas/audioVerboseResponse" + } + ] + } + }, + "text/plain": { + "schema": { + "type": "string", + "description": "Transcribed text in the output format (when response_format was one of text, vtt or srt)." + } + } + } + } + }, + "x-ms-examples": { + "Create an audio transcription with json response format.": { + "$ref": "./examples/audio_transcription_object.json" + }, + "Create an audio transcription with text response format.": { + "$ref": "./examples/audio_transcription_text.json" + } + } + } + }, + "/deployments/{deployment-id}/audio/translations": { + "post": { + "summary": "Transcribes and translates input audio into English text.", + "operationId": "Translations_Create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "whisper", + "description": "Deployment id of the whisper model which was deployed." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/createTranslationRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/audioResponse" + }, + { + "$ref": "#/components/schemas/audioVerboseResponse" + } + ] + } + }, + "text/plain": { + "schema": { + "type": "string", + "description": "Transcribed text in the output format (when response_format was one of text, vtt or srt)." + } + } + } + } + }, + "x-ms-examples": { + "Create an audio translation with json response format.": { + "$ref": "./examples/audio_translation_object.json" + }, + "Create an audio translation with text response format.": { + "$ref": "./examples/audio_translation_text.json" + } + } + } + }, + "/deployments/{deployment-id}/audio/speech": { + "post": { + "summary": "Generates audio from the input text.", + "operationId": "Speech_Create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "tts-1", + "description": "Deployment id of the tts model which was deployed." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/createSpeechRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + } + }, + "x-ms-examples": { + "Create an audio from text with response format mp3.": { + "$ref": "./examples/audio_speech.json" + } + } + } + }, + "/deployments/{deployment-id}/images/generations": { + "post": { + "summary": "Generates a batch of images from a text caption on a given DALLE model deployment", + "operationId": "ImageGenerations_Create", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/imageGenerationsRequest" + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "dalle-deployment", + "description": "Deployment id of the dalle model which was deployed." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/generateImagesResponse" + } + } + } + }, + "default": { + "description": "An error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dalleErrorResponse" + } + } + } + } + }, + "x-ms-examples": { + "Create an image.": { + "$ref": "./examples/image_generation.json" + } + } + } + }, + "/assistants": { + "get": { + "operationId": "List_Assistants", + "tags": [ + "Assistants" + ], + "summary": "Returns a list of assistants.", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n", + "required": false, + "schema": { + "type": "integer", + "default": 20 + } + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListAssistantsOrder", + "modelAsString": true, + "values": [ + { + "value": "asc", + "description": "Order results in ascending order" + }, + { + "value": "desc", + "description": "Order results in descending order" + } + ] + } + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/listAssistantsResponse" + } + } + } + } + }, + "x-ms-examples": { + "List all assistants.": { + "$ref": "./examples/list_assistants.json" + } + } + }, + "post": { + "operationId": "Create_Assistant", + "tags": [ + "Assistants" + ], + "summary": "Create an assistant with a model and instructions.", + "parameters": [ + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createAssistantRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/assistantObject" + } + } + } + } + }, + "x-ms-examples": { + "Create an assistant.": { + "$ref": "./examples/create_assistant.json" + } + } + } + }, + "/assistants/{assistant_id}": { + "get": { + "operationId": "Get_Assistant", + "tags": [ + "Assistants" + ], + "summary": "Retrieves an assistant.", + "parameters": [ + { + "in": "path", + "name": "assistant_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the assistant to retrieve." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/assistantObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieves an assistant.": { + "$ref": "./examples/retrieve_assistant.json" + } + } + }, + "post": { + "operationId": "Modify_Assistant", + "tags": [ + "Assistant" + ], + "summary": "Modifies an assistant.", + "parameters": [ + { + "in": "path", + "name": "assistant_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the assistant to modify." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/modifyAssistantRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/assistantObject" + } + } + } + } + }, + "x-ms-examples": { + "Modifies an assistant.": { + "$ref": "./examples/modify_assistant.json" + } + } + }, + "delete": { + "operationId": "Delete_Assistant", + "tags": [ + "Assistants" + ], + "summary": "Delete an assistant.", + "parameters": [ + { + "in": "path", + "name": "assistant_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the assistant to delete." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deleteAssistantResponse" + } + } + } + } + }, + "x-ms-examples": { + "Delete an assistant.": { + "$ref": "./examples/delete_assistant.json" + } + } + } + }, + "/threads": { + "post": { + "operationId": "Create_Thread", + "tags": [ + "Assistants" + ], + "summary": "Create a thread.", + "parameters": [ + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createThreadRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/threadObject" + } + } + } + } + }, + "x-ms-examples": { + "Create a thread.": { + "$ref": "./examples/create_thread.json" + } + } + } + }, + "/threads/{thread_id}": { + "get": { + "operationId": "Get_Thread", + "tags": [ + "Assistants" + ], + "summary": "Retrieves a thread.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to retrieve." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/threadObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieve a thread.": { + "$ref": "./examples/retrieve_thread.json" + } + } + }, + "post": { + "operationId": "Modify_Thread", + "tags": [ + "Assistants" + ], + "summary": "Modifies a thread.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to modify. Only the `metadata` can be modified." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/modifyThreadRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/threadObject" + } + } + } + } + }, + "x-ms-examples": { + "Modify a thread.": { + "$ref": "./examples/modify_thread.json" + } + } + }, + "delete": { + "operationId": "Delete_Thread", + "tags": [ + "Assistants" + ], + "summary": "Delete a thread.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to delete." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deleteThreadResponse" + } + } + } + } + }, + "x-ms-examples": { + "Delete a thread.": { + "$ref": "./examples/delete_thread.json" + } + } + } + }, + "/threads/{thread_id}/messages": { + "get": { + "operationId": "List_Messages", + "tags": [ + "Assistants" + ], + "summary": "Returns a list of messages for a given thread.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the [thread](/docs/api-reference/threads) the messages belong to." + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n", + "required": false, + "schema": { + "type": "integer", + "default": 20 + } + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListMessagesOrder", + "modelAsString": true, + "values": [ + { + "value": "asc", + "description": "Order results in ascending order" + }, + { + "value": "desc", + "description": "Order results in descending order" + } + ] + } + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "in": "query", + "description": "Filter messages by the run ID that generated them.\n", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/listMessagesResponse" + } + } + } + } + }, + "x-ms-examples": { + "List all messages.": { + "$ref": "./examples/list_messages.json" + } + } + }, + "post": { + "operationId": "Create_Message", + "tags": [ + "Assistants" + ], + "summary": "Create a message.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the [thread](/docs/api-reference/threads) to create a message for." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createMessageRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/messageObject" + } + } + } + } + }, + "x-ms-examples": { + "Create a message.": { + "$ref": "./examples/create_message.json" + } + } + } + }, + "/threads/{thread_id}/messages/{message_id}": { + "get": { + "operationId": "Get_Message", + "tags": [ + "Assistants" + ], + "summary": "Retrieve a message.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the [thread](/docs/api-reference/threads) to which this message belongs." + }, + { + "in": "path", + "name": "message_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the message to retrieve." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/messageObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieve a message.": { + "$ref": "./examples/get_message.json" + } + } + }, + "post": { + "operationId": "Modify_Message", + "tags": [ + "Assistants" + ], + "summary": "Modifies a message.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to which this message belongs." + }, + { + "in": "path", + "name": "message_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the message to modify." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/modifyMessageRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/messageObject" + } + } + } + } + }, + "x-ms-examples": { + "Modify a message.": { + "$ref": "./examples/modify_message.json" + } + } + } + }, + "/threads/runs": { + "post": { + "operationId": "Create_Thread_And_Run", + "tags": [ + "Assistants" + ], + "summary": "Create a thread and run it in one request.", + "parameters": [ + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createThreadAndRunRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runObject" + } + } + } + } + }, + "x-ms-examples": { + "Create a thread and run it.": { + "$ref": "./examples/create_thread_and_run.json" + } + } + } + }, + "/threads/{thread_id}/runs": { + "get": { + "operationId": "List_Runs", + "tags": [ + "Assistants" + ], + "summary": "Returns a list of runs belonging to a thread.", + "parameters": [ + { + "name": "thread_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread the run belongs to." + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n", + "required": false, + "schema": { + "type": "integer", + "default": 20 + } + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListRunsOrder", + "modelAsString": true, + "values": [ + { + "value": "asc", + "description": "Order results in ascending order" + }, + { + "value": "desc", + "description": "Order results in descending order" + } + ] + } + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/listRunsResponse" + } + } + } + } + }, + "x-ms-examples": { + "List all runs.": { + "$ref": "./examples/list_runs.json" + } + } + }, + "post": { + "operationId": "Create_Run", + "tags": [ + "Assistants" + ], + "summary": "Create a run.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to run." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createRunRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runObject" + } + } + } + } + }, + "x-ms-examples": { + "Create a run.": { + "$ref": "./examples/create_run.json" + } + } + } + }, + "/threads/{thread_id}/runs/{run_id}": { + "get": { + "operationId": "Get_Run", + "tags": [ + "Assistants" + ], + "summary": "Retrieves a run.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the [thread](/docs/api-reference/threads) that was run." + }, + { + "in": "path", + "name": "run_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the run to retrieve." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieve a run.": { + "$ref": "./examples/get_run.json" + } + } + }, + "post": { + "operationId": "Modify_Run", + "tags": [ + "Assistants" + ], + "summary": "Modifies a run.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the [thread](/docs/api-reference/threads) that was run." + }, + { + "in": "path", + "name": "run_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the run to modify." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/modifyRunRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runObject" + } + } + } + } + }, + "x-ms-examples": { + "Modify a run.": { + "$ref": "./examples/modify_run.json" + } + } + } + }, + "/threads/{thread_id}/runs/{run_id}/submit_tool_outputs": { + "post": { + "operationId": "Submit_Tool_Outputs_To_Run", + "tags": [ + "Assistants" + ], + "summary": "When a run has the `status: \"requires_action\"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.\n", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the [thread](/docs/api-reference/threads) to which this run belongs." + }, + { + "in": "path", + "name": "run_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the run that requires the tool output submission." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/submitToolOutputsRunRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runObject" + } + } + } + } + }, + "x-ms-examples": { + "Submit tool outputs to a run.": { + "$ref": "./examples/submit_tool_outputs_to_run.json" + } + } + } + }, + "/threads/{thread_id}/runs/{run_id}/cancel": { + "post": { + "operationId": "Cancel_Run", + "tags": [ + "Assistants" + ], + "summary": "Cancels a run that is `in_progress`.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to which this run belongs." + }, + { + "in": "path", + "name": "run_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the run to cancel." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runObject" + } + } + } + } + }, + "x-ms-examples": { + "Cancel a run.": { + "$ref": "./examples/cancel_run.json" + } + } + } + }, + "/threads/{thread_id}/runs/{run_id}/steps": { + "get": { + "operationId": "List_Run_Steps", + "tags": [ + "Assistants" + ], + "summary": "Returns a list of run steps belonging to a run.", + "parameters": [ + { + "name": "thread_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread the run and run steps belong to." + }, + { + "name": "run_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the run the run steps belong to." + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n", + "required": false, + "schema": { + "type": "integer", + "default": 20 + } + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListRunStepsOrder", + "modelAsString": true, + "values": [ + { + "value": "asc", + "description": "Order results in ascending order" + }, + { + "value": "desc", + "description": "Order results in descending order" + } + ] + } + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/listRunStepsResponse" + } + } + } + } + }, + "x-ms-examples": { + "List all run steps.": { + "$ref": "./examples/list_run_steps.json" + } + } + } + }, + "/threads/{thread_id}/runs/{run_id}/steps/{step_id}": { + "get": { + "operationId": "Get_Run_Step", + "tags": [ + "Assistants" + ], + "summary": "Retrieves a run step.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to which the run and run step belongs." + }, + { + "in": "path", + "name": "run_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the run to which the run step belongs." + }, + { + "in": "path", + "name": "step_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the run step to retrieve." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runStepObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieve a run step.": { + "$ref": "./examples/get_run_step.json" + } + } + } + }, + "/vector_stores": { + "get": { + "operationId": "List_Vector_Stores", + "tags": [ + "Vector Stores" + ], + "summary": "Returns a list of vector stores.", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n", + "required": false, + "schema": { + "type": "integer", + "default": 20 + } + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListVectorStoresOrder", + "modelAsString": true, + "values": [ + { + "value": "asc" + }, + { + "value": "desc" + } + ] + } + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/listVectorStoresResponse" + } + } + } + } + }, + "x-ms-examples": { + "List all vector stores.": { + "$ref": "./examples/list_vector_stores.json" + } + } + }, + "post": { + "operationId": "Create_Vector_Store", + "tags": [ + "Vector Stores" + ], + "summary": "Create a vector store.", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createVectorStoreRequest" + } + } + } + }, + "parameters": [ + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vectorStoreObject" + } + } + } + } + }, + "x-ms-examples": { + "Create a vector store.": { + "$ref": "./examples/create_vector_store.json" + } + } + } + }, + "/vector_stores/{vector_store_id}": { + "get": { + "operationId": "Get_Vector_Store", + "tags": [ + "Vector Stores" + ], + "summary": "Retrieves a vector store.", + "parameters": [ + { + "in": "path", + "name": "vector_store_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the vector store to retrieve." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vectorStoreObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieve a vector store.": { + "$ref": "./examples/retrieve_vector_store.json" + } + } + }, + "post": { + "operationId": "Modify_Vector_Store", + "tags": [ + "Vector Stores" + ], + "summary": "Modifies a vector store.", + "parameters": [ + { + "in": "path", + "name": "vector_store_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the vector store to modify." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview" + }, + "description": "api version" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/updateVectorStoreRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vectorStoreObject" + } + } + } + } + }, + "x-ms-examples": { + "Modify a vector store.": { + "$ref": "./examples/modify_vector_store.json" + } + } + }, + "delete": { + "operationId": "Delete_Vector_Store", + "tags": [ + "Vector Stores" + ], + "summary": "Delete a vector store.", + "parameters": [ + { + "in": "path", + "name": "vector_store_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the vector store to delete." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deleteVectorStoreResponse" + } + } + } + } + }, + "x-ms-examples": { + "Delete a vector store.": { + "$ref": "./examples/delete_vector_store.json" + } + } + } + }, + "/vector_stores/{vector_store_id}/files": { + "get": { + "operationId": "List_Vector_Store_Files", + "tags": [ + "Vector Stores" + ], + "summary": "Returns a list of vector store files.", + "parameters": [ + { + "name": "vector_store_id", + "in": "path", + "description": "The ID of the vector store that the files belong to.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n", + "required": false, + "schema": { + "type": "integer", + "default": 20 + } + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListVectorStoreFilesOrder", + "modelAsString": true, + "values": [ + { + "value": "asc" + }, + { + "value": "desc" + } + ] + } + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "in": "query", + "description": "Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.", + "schema": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "failed", + "cancelled" + ], + "x-ms-enum": { + "name": "ListVectorStoreFilesFilter", + "modelAsString": true, + "values": [ + { + "value": "in_progress" + }, + { + "value": "completed" + }, + { + "value": "failed" + }, + { + "value": "cancelled" + } + ] + } + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/listVectorStoreFilesResponse" + } + } + } + } + }, + "x-ms-examples": { + "List all vector store files.": { + "$ref": "./examples/list_vector_store_files.json" + } + } + }, + "post": { + "operationId": "Create_Vector_Store_File", + "tags": [ + "Vector Stores" + ], + "summary": "Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object).", + "parameters": [ + { + "in": "path", + "name": "vector_store_id", + "required": true, + "schema": { + "type": "string", + "example": "vs_abc123" + }, + "description": "The ID of the vector store for which to create a File.\n" + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview" + }, + "description": "api version" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createVectorStoreFileRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vectorStoreFileObject" + } + } + } + } + }, + "x-ms-examples": { + "Create a vector store file.": { + "$ref": "./examples/create_vector_store_file.json" + } + } + } + }, + "/vector_stores/{vector_store_id}/files/{file_id}": { + "get": { + "operationId": "Get_Vector_Store_File", + "tags": [ + "Vector Stores" + ], + "summary": "Retrieves a vector store file.", + "parameters": [ + { + "in": "path", + "name": "vector_store_id", + "required": true, + "schema": { + "type": "string", + "example": "vs_abc123" + }, + "description": "The ID of the vector store that the file belongs to." + }, + { + "in": "path", + "name": "file_id", + "required": true, + "schema": { + "type": "string", + "example": "file-abc123" + }, + "description": "The ID of the file being retrieved." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vectorStoreFileObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieve a vector store file.": { + "$ref": "./examples/retrieve_vector_store_file.json" + } + } + }, + "delete": { + "operationId": "Delete_Vector_Store_File", + "tags": [ + "Vector Stores" + ], + "summary": "Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the [delete file](/docs/api-reference/files/delete) endpoint.", + "parameters": [ + { + "in": "path", + "name": "vector_store_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the vector store that the file belongs to." + }, + { + "in": "path", + "name": "file_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the file to delete." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deleteVectorStoreFileResponse" + } + } + } + } + }, + "x-ms-examples": { + "Delete a vector store file.": { + "$ref": "./examples/delete_vector_store_file.json" + } + } + } + }, + "/vector_stores/{vector_store_id}/file_batches": { + "post": { + "operationId": "Create_Vector_Store_File_Batch", + "tags": [ + "Vector Stores" + ], + "summary": "Create a vector store file batch.", + "parameters": [ + { + "in": "path", + "name": "vector_store_id", + "required": true, + "schema": { + "type": "string", + "example": "vs_abc123" + }, + "description": "The ID of the vector store for which to create a File Batch.\n" + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview" + }, + "description": "api version" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createVectorStoreFileBatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vectorStoreFileBatchObject" + } + } + } + } + }, + "x-ms-examples": { + "Create a vector store file batch.": { + "$ref": "./examples/create_vector_store_file_batch.json" + } + } + } + }, + "/vector_stores/{vector_store_id}/file_batches/{batch_id}": { + "get": { + "operationId": "Get_Vector_Store_File_Batch", + "tags": [ + "Vector Stores" + ], + "summary": "Retrieves a vector store file batch.", + "parameters": [ + { + "in": "path", + "name": "vector_store_id", + "required": true, + "schema": { + "type": "string", + "example": "vs_abc123" + }, + "description": "The ID of the vector store that the file batch belongs to." + }, + { + "in": "path", + "name": "batch_id", + "required": true, + "schema": { + "type": "string", + "example": "vs_b_abc123" + }, + "description": "The ID of the file batch being retrieved." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vectorStoreFileBatchObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieve a vector store file batch.": { + "$ref": "./examples/retrieve_vector_store_file_batch.json" + } + } + } + }, + "/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel": { + "post": { + "operationId": "Cancel_Vector_Store_File_Batch", + "tags": [ + "Vector Stores" + ], + "summary": "Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.", + "parameters": [ + { + "in": "path", + "name": "vector_store_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the vector store that the file batch belongs to." + }, + { + "in": "path", + "name": "batch_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the file batch to cancel." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vectorStoreFileBatchObject" + } + } + } + } + }, + "x-ms-examples": { + "Cancel a vector store file batch.": { + "$ref": "./examples/cancel_vector_store_file_batch.json" + } + } + } + }, + "/vector_stores/{vector_store_id}/file_batches/{batch_id}/files": { + "get": { + "operationId": "List_Vector_Store_File_Batch_Files", + "tags": [ + "Vector Stores" + ], + "summary": "Returns a list of vector store files in a batch.", + "parameters": [ + { + "name": "vector_store_id", + "in": "path", + "description": "The ID of the vector store that the files belong to.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "batch_id", + "in": "path", + "description": "The ID of the file batch that the files belong to.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n", + "required": false, + "schema": { + "type": "integer", + "default": 20 + } + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListVectorStoreFilesOrder", + "modelAsString": true, + "values": [ + { + "value": "asc" + }, + { + "value": "desc" + } + ] + } + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "in": "query", + "description": "Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.", + "schema": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "failed", + "cancelled" + ], + "x-ms-enum": { + "name": "ListVectorStoreFilesFilter", + "modelAsString": true, + "values": [ + { + "value": "in_progress" + }, + { + "value": "completed" + }, + { + "value": "failed" + }, + { + "value": "cancelled" + } + ] + } + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/listVectorStoreFilesResponse" + } + } + } + } + }, + "x-ms-examples": { + "List all vector store files in a batch.": { + "$ref": "./examples/list_vector_store_files.json" + } + } + } + } + }, + "components": { + "schemas": { + "errorResponse": { + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/error" + } + } + }, + "errorBase": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "error": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/errorBase" + } + ], + "properties": { + "param": { + "type": "string" + }, + "type": { + "type": "string" + }, + "inner_error": { + "$ref": "#/components/schemas/innerError" + } + } + }, + "innerError": { + "description": "Inner error with additional details.", + "type": "object", + "properties": { + "code": { + "$ref": "#/components/schemas/innerErrorCode" + }, + "content_filter_results": { + "$ref": "#/components/schemas/contentFilterPromptResults" + } + } + }, + "innerErrorCode": { + "description": "Error codes for the inner error object.", + "enum": [ + "ResponsibleAIPolicyViolation" + ], + "type": "string", + "x-ms-enum": { + "name": "InnerErrorCode", + "modelAsString": true, + "values": [ + { + "value": "ResponsibleAIPolicyViolation", + "description": "The prompt violated one of more content filter rules." + } + ] + } + }, + "dalleErrorResponse": { + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/dalleError" + } + } + }, + "dalleError": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/errorBase" + } + ], + "properties": { + "param": { + "type": "string" + }, + "type": { + "type": "string" + }, + "inner_error": { + "$ref": "#/components/schemas/dalleInnerError" + } + } + }, + "dalleInnerError": { + "description": "Inner error with additional details.", + "type": "object", + "properties": { + "code": { + "$ref": "#/components/schemas/innerErrorCode" + }, + "content_filter_results": { + "$ref": "#/components/schemas/dalleFilterResults" + }, + "revised_prompt": { + "type": "string", + "description": "The prompt that was used to generate the image, if there was any revision to the prompt." + } + } + }, + "contentFilterResultBase": { + "type": "object", + "properties": { + "filtered": { + "type": "boolean" + } + }, + "required": [ + "filtered" + ] + }, + "contentFilterSeverityResult": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultBase" + }, + { + "properties": { + "severity": { + "type": "string", + "enum": [ + "safe", + "low", + "medium", + "high" + ], + "x-ms-enum": { + "name": "ContentFilterSeverity", + "modelAsString": true, + "values": [ + { + "value": "safe", + "description": "General content or related content in generic or non-harmful contexts." + }, + { + "value": "low", + "description": "Harmful content at a low intensity and risk level." + }, + { + "value": "medium", + "description": "Harmful content at a medium intensity and risk level." + }, + { + "value": "high", + "description": "Harmful content at a high intensity and risk level." + } + ] + } + } + } + } + ], + "required": [ + "severity", + "filtered" + ] + }, + "contentFilterDetectedResult": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultBase" + }, + { + "properties": { + "detected": { + "type": "boolean" + } + } + } + ], + "required": [ + "detected", + "filtered" + ] + }, + "contentFilterDetectedWithCitationResult": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterDetectedResult" + }, + { + "properties": { + "citation": { + "type": "object", + "properties": { + "URL": { + "type": "string" + }, + "license": { + "type": "string" + } + } + } + } + } + ], + "required": [ + "detected", + "filtered" + ] + }, + "contentFilterIdResult": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultBase" + }, + { + "properties": { + "id": { + "type": "string" + } + } + } + ], + "required": [ + "id", + "filtered" + ] + }, + "contentFilterResultsBase": { + "type": "object", + "description": "Information about the content filtering results.", + "properties": { + "sexual": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "violence": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "hate": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "self_harm": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "profanity": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + }, + "custom_blocklists": { + "$ref": "#/components/schemas/contentFilterDetailedResults" + }, + "error": { + "$ref": "#/components/schemas/errorBase" + } + } + }, + "contentFilterPromptResults": { + "type": "object", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id.", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultsBase" + }, + { + "properties": { + "jailbreak": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + }, + "indirect_attack": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + } + } + } + ] + }, + "contentFilterChoiceResults": { + "type": "object", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about third party text and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id.", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultsBase" + }, + { + "properties": { + "protected_material_text": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + } + } + }, + { + "properties": { + "protected_material_code": { + "$ref": "#/components/schemas/contentFilterDetectedWithCitationResult" + } + } + } + ] + }, + "contentFilterDetailedResults": { + "type": "object", + "description": "Content filtering results with a detail of content filter ids for the filtered segments.", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultBase" + }, + { + "properties": { + "details": { + "items": { + "$ref": "#/components/schemas/contentFilterIdResult" + }, + "type": "array" + } + } + } + ], + "required": [ + "filtered", + "details" + ] + }, + "promptFilterResult": { + "type": "object", + "description": "Content filtering results for a single prompt in the request.", + "properties": { + "prompt_index": { + "type": "integer" + }, + "content_filter_results": { + "$ref": "#/components/schemas/contentFilterPromptResults" + } + } + }, + "promptFilterResults": { + "type": "array", + "description": "Content filtering results for zero or more prompts in the request. In a streaming request, results for different prompts may arrive at different times or in different orders.", + "items": { + "$ref": "#/components/schemas/promptFilterResult" + } + }, + "dalleContentFilterResults": { + "type": "object", + "description": "Information about the content filtering results.", + "properties": { + "sexual": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "violence": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "hate": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "self_harm": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + } + } + }, + "dalleFilterResults": { + "type": "object", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id.", + "allOf": [ + { + "$ref": "#/components/schemas/dalleContentFilterResults" + }, + { + "properties": { + "profanity": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + }, + "jailbreak": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + }, + "custom_blocklists": { + "$ref": "#/components/schemas/contentFilterDetailedResults" + } + } + } + ] + }, + "chatCompletionsRequestCommon": { + "type": "object", + "properties": { + "temperature": { + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nWe generally recommend altering this or `top_p` but not both.", + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true + }, + "top_p": { + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\nWe generally recommend altering this or `temperature` but not both.", + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true + }, + "stream": { + "description": "If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a `data: [DONE]` message.", + "type": "boolean", + "nullable": true, + "default": false + }, + "stop": { + "description": "Up to 4 sequences where the API will stop generating further tokens.", + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "array", + "items": { + "type": "string", + "nullable": false + }, + "minItems": 1, + "maxItems": 4, + "description": "Array minimum size of 1 and maximum of 4" + } + ], + "default": null + }, + "max_tokens": { + "description": "The maximum number of tokens allowed for the generated answer. By default, the number of tokens the model can return will be (4096 - prompt tokens). This value is now deprecated in favor of `max_completion_tokens`, and is not compatible with o1 series models.", + "type": "integer", + "default": 4096 + }, + "max_completion_tokens": { + "description": "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.", + "type": "integer", + "nullable": true + }, + "presence_penalty": { + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.", + "type": "number", + "default": 0, + "minimum": -2, + "maximum": 2 + }, + "frequency_penalty": { + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.", + "type": "number", + "default": 0, + "minimum": -2, + "maximum": 2 + }, + "logit_bias": { + "description": "Modify the likelihood of specified tokens appearing in the completion. Accepts a json object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.", + "type": "object", + "nullable": true + }, + "user": { + "description": "A unique identifier representing your end-user, which can help Azure OpenAI to monitor and detect abuse.", + "type": "string", + "example": "user-1234", + "nullable": false + } + } + }, + "createCompletionRequest": { + "type": "object", + "properties": { + "prompt": { + "description": "The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays.\n\nNote that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document.\n", + "default": "<|endoftext|>", + "nullable": true, + "oneOf": [ + { + "type": "string", + "default": "", + "example": "This is a test." + }, + { + "type": "array", + "items": { + "type": "string", + "default": "", + "example": "This is a test." + } + } + ] + }, + "best_of": { + "type": "integer", + "default": 1, + "minimum": 0, + "maximum": 20, + "nullable": true, + "description": "Generates `best_of` completions server-side and returns the \"best\" (the one with the highest log probability per token). Results cannot be streamed.\n\nWhen used with `n`, `best_of` controls the number of candidate completions and `n` specifies how many to return – `best_of` must be greater than `n`.\n\n**Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.\n" + }, + "echo": { + "type": "boolean", + "default": false, + "nullable": true, + "description": "Echo back the prompt in addition to the completion\n" + }, + "frequency_penalty": { + "type": "number", + "default": 0, + "minimum": -2, + "maximum": 2, + "nullable": true, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.\n" + }, + "logit_bias": { + "type": "object", + "x-oaiTypeLabel": "map", + "default": null, + "nullable": true, + "additionalProperties": { + "type": "integer" + }, + "description": "Modify the likelihood of specified tokens appearing in the completion.\n\nAccepts a JSON object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. You can use this [tokenizer tool](https://platform.openai.com/tokenizer?view=bpe) to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.\n\nAs an example, you can pass `{\"50256\": -100}` to prevent the <|endoftext|> token from being generated.\n" + }, + "logprobs": { + "type": "integer", + "minimum": 0, + "maximum": 5, + "default": null, + "nullable": true, + "description": "Include the log probabilities on the `logprobs` most likely output tokens, as well the chosen tokens. For example, if `logprobs` is 5, the API will return a list of the 5 most likely tokens. The API will always return the `logprob` of the sampled token, so there may be up to `logprobs+1` elements in the response.\n\nThe maximum value for `logprobs` is 5.\n" + }, + "max_tokens": { + "type": "integer", + "minimum": 0, + "default": 16, + "example": 16, + "nullable": true, + "description": "The maximum number of [tokens](https://platform.openai.com/tokenizer) that can be generated in the completion.\n\nThe token count of your prompt plus `max_tokens` cannot exceed the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens.\n" + }, + "n": { + "type": "integer", + "minimum": 1, + "maximum": 128, + "default": 1, + "example": 1, + "nullable": true, + "description": "How many completions to generate for each prompt.\n\n**Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.\n" + }, + "presence_penalty": { + "type": "number", + "default": 0, + "minimum": -2, + "maximum": 2, + "nullable": true, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.\n" + }, + "seed": { + "type": "integer", + "minimum": -9223372036854775808, + "maximum": 9223372036854775807, + "nullable": true, + "description": "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.\n\nDeterminism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.\n" + }, + "stop": { + "description": "Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.\n", + "default": null, + "nullable": true, + "oneOf": [ + { + "type": "string", + "default": "<|endoftext|>", + "example": "\n", + "nullable": true + }, + { + "type": "array", + "minItems": 1, + "maxItems": 4, + "items": { + "type": "string", + "example": "[\"\\n\"]" + } + } + ] + }, + "stream": { + "description": "Whether to stream back partial progress. If set, tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).\n", + "type": "boolean", + "nullable": true, + "default": false + }, + "suffix": { + "description": "The suffix that comes after a completion of inserted text.\n\nThis parameter is only supported for `gpt-3.5-turbo-instruct`.\n", + "default": null, + "nullable": true, + "type": "string", + "example": "test." + }, + "temperature": { + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true, + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n\nWe generally recommend altering this or `top_p` but not both.\n" + }, + "top_p": { + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or `temperature` but not both.\n" + }, + "user": { + "type": "string", + "example": "user-1234", + "description": "A unique identifier representing your end-user, which can help to monitor and detect abuse.\n" + } + }, + "required": [ + "prompt" + ] + }, + "createCompletionResponse": { + "type": "object", + "description": "Represents a completion response from the API. Note: both the streamed and non-streamed response objects share the same shape (unlike the chat endpoint).\n", + "properties": { + "id": { + "type": "string", + "description": "A unique identifier for the completion." + }, + "choices": { + "type": "array", + "description": "The list of completion choices the model generated for the input prompt.", + "items": { + "type": "object", + "required": [ + "finish_reason", + "index", + "logprobs", + "text" + ], + "properties": { + "finish_reason": { + "type": "string", + "description": "The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,\n`length` if the maximum number of tokens specified in the request was reached,\nor `content_filter` if content was omitted due to a flag from our content filters.\n", + "enum": [ + "stop", + "length", + "content_filter" + ] + }, + "index": { + "type": "integer" + }, + "logprobs": { + "type": "object", + "nullable": true, + "properties": { + "text_offset": { + "type": "array", + "items": { + "type": "integer" + } + }, + "token_logprobs": { + "type": "array", + "items": { + "type": "number" + } + }, + "tokens": { + "type": "array", + "items": { + "type": "string" + } + }, + "top_logprobs": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "type": "number" + } + } + } + } + }, + "text": { + "type": "string" + }, + "content_filter_results": { + "$ref": "#/components/schemas/contentFilterChoiceResults" + } + } + } + }, + "created": { + "type": "integer", + "description": "The Unix timestamp (in seconds) of when the completion was created." + }, + "model": { + "type": "string", + "description": "The model used for completion." + }, + "prompt_filter_results": { + "$ref": "#/components/schemas/promptFilterResults" + }, + "system_fingerprint": { + "type": "string", + "description": "This fingerprint represents the backend configuration that the model runs with.\n\nCan be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.\n" + }, + "object": { + "type": "string", + "description": "The object type, which is always \"text_completion\"", + "enum": [ + "text_completion" + ] + }, + "usage": { + "$ref": "#/components/schemas/completionUsage" + } + }, + "required": [ + "id", + "object", + "created", + "model", + "choices" + ] + }, + "createChatCompletionRequest": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionsRequestCommon" + }, + { + "properties": { + "messages": { + "description": "A list of messages comprising the conversation so far. [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_format_inputs_to_ChatGPT_models.ipynb).", + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/components/schemas/chatCompletionRequestMessage" + } + }, + "data_sources": { + "type": "array", + "description": " The configuration entries for Azure OpenAI chat extensions that use them.\n This additional specification is only compatible with Azure OpenAI.", + "items": { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + } + }, + "frequency_penalty": { + "type": "number", + "default": 0, + "minimum": -2, + "maximum": 2, + "nullable": true, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.\n" + }, + "logit_bias": { + "type": "object", + "default": null, + "nullable": true, + "additionalProperties": { + "type": "integer" + }, + "description": "Modify the likelihood of specified tokens appearing in the completion.\n\nAccepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.\n" + }, + "logprobs": { + "description": "Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`.", + "type": "boolean", + "default": false, + "nullable": true + }, + "top_logprobs": { + "description": "An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used.", + "type": "integer", + "minimum": 0, + "maximum": 20, + "nullable": true + }, + "max_tokens": { + "description": "The maximum number of [tokens](/tokenizer) that can be generated in the chat completion.\n\nThe total length of input tokens and generated tokens is limited by the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens.\n", + "type": "integer", + "nullable": true + }, + "n": { + "type": "integer", + "minimum": 1, + "maximum": 128, + "default": 1, + "example": 1, + "nullable": true, + "description": "How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep `n` as `1` to minimize costs." + }, + "presence_penalty": { + "type": "number", + "default": 0, + "minimum": -2, + "maximum": 2, + "nullable": true, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.\n" + }, + "response_format": { + "description": "An object specifying the format that the model must output. Compatible with [GPT-4o](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models), [GPT-4o mini](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models), [GPT-4 Turbo](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models) and all [GPT-3.5](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-35) Turbo models newer than `gpt-3.5-turbo-1106`.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which guarantees the model will match your supplied JSON schema.\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which guarantees the message the model generates is valid JSON.\n\n**Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.\n", + "oneOf": [ + { + "$ref": "#/components/schemas/ResponseFormatText" + }, + { + "$ref": "#/components/schemas/ResponseFormatJsonObject" + }, + { + "$ref": "#/components/schemas/ResponseFormatJsonSchema" + } + ], + "x-oaiExpandable": true + }, + "seed": { + "type": "integer", + "minimum": -9223372036854775808, + "maximum": 9223372036854775807, + "nullable": true, + "description": "This feature is in Beta.\nIf specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.\nDeterminism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.\n" + }, + "stop": { + "description": "Up to 4 sequences where the API will stop generating further tokens.\n", + "default": null, + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "array", + "minItems": 1, + "maxItems": 4, + "items": { + "type": "string" + } + } + ] + }, + "stream": { + "description": "If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).\n", + "type": "boolean", + "nullable": true, + "default": false + }, + "temperature": { + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true, + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n\nWe generally recommend altering this or `top_p` but not both.\n" + }, + "top_p": { + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or `temperature` but not both.\n" + }, + "tools": { + "type": "array", + "description": "A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported.\n", + "items": { + "$ref": "#/components/schemas/chatCompletionTool" + } + }, + "tool_choice": { + "$ref": "#/components/schemas/chatCompletionToolChoiceOption" + }, + "function_call": { + "deprecated": true, + "description": "Deprecated in favor of `tool_choice`.\n\nControls which (if any) function is called by the model.\n`none` means the model will not call a function and instead generates a message.\n`auto` means the model can pick between generating a message or calling a function.\nSpecifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.\n\n`none` is the default when no functions are present. `auto` is the default if functions are present.\n", + "oneOf": [ + { + "type": "string", + "description": "`none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function.\n", + "enum": [ + "none", + "auto" + ] + }, + { + "$ref": "#/components/schemas/chatCompletionFunctionCallOption" + } + ], + "x-oaiExpandable": true + }, + "functions": { + "deprecated": true, + "description": "Deprecated in favor of `tools`.\n\nA list of functions the model may generate JSON inputs for.\n", + "type": "array", + "minItems": 1, + "maxItems": 128, + "items": { + "$ref": "#/components/schemas/chatCompletionFunctions" + } + }, + "user": { + "type": "string", + "example": "user-1234", + "description": "A unique identifier representing your end-user, which can help to monitor and detect abuse.\n" + } + }, + "required": [ + "messages" + ] + } + ] + }, + "chatCompletionFunctions": { + "type": "object", + "deprecated": true, + "properties": { + "description": { + "type": "string", + "description": "A description of what the function does, used by the model to choose when and how to call the function." + }, + "name": { + "type": "string", + "description": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + }, + "parameters": { + "$ref": "#/components/schemas/FunctionParameters" + } + }, + "required": [ + "name" + ] + }, + "chatCompletionFunctionCallOption": { + "type": "object", + "description": "Specifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.\n", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + } + }, + "required": [ + "name" + ] + }, + "chatCompletionFunctionParameters": { + "type": "object", + "description": "The parameters the functions accepts, described as a JSON Schema object. See the [guide/](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.", + "additionalProperties": true + }, + "chatCompletionRequestMessage": { + "oneOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestSystemMessage" + }, + { + "$ref": "#/components/schemas/chatCompletionRequestUserMessage" + }, + { + "$ref": "#/components/schemas/chatCompletionRequestAssistantMessage" + }, + { + "$ref": "#/components/schemas/chatCompletionRequestToolMessage" + }, + { + "$ref": "#/components/schemas/chatCompletionRequestFunctionMessage" + } + ] + }, + "chatCompletionRequestSystemMessage": { + "type": "object", + "title": "System message", + "properties": { + "content": { + "description": "The contents of the system message.", + "oneOf": [ + { + "type": "string", + "description": "The contents of the system message.", + "title": "Text content" + }, + { + "type": "array", + "description": "An array of content parts with a defined type. For system messages, only type `text` is supported.", + "title": "Array of content parts", + "items": { + "$ref": "#/components/schemas/chatCompletionRequestSystemMessageContentPart" + }, + "minItems": 1 + } + ] + }, + "role": { + "type": "string", + "enum": [ + "system" + ], + "description": "The role of the messages author, in this case `system`." + }, + "name": { + "type": "string", + "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role." + } + }, + "required": [ + "content", + "role" + ] + }, + "chatCompletionRequestUserMessage": { + "type": "object", + "title": "User message", + "properties": { + "content": { + "description": "The contents of the user message.\n", + "oneOf": [ + { + "type": "string", + "description": "The text contents of the message.", + "title": "Text content" + }, + { + "type": "array", + "description": "An array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. Image input is only supported when using the `gpt-4o` model.", + "title": "Array of content parts", + "items": { + "$ref": "#/components/schemas/chatCompletionRequestUserMessageContentPart" + }, + "minItems": 1 + } + ], + "x-oaiExpandable": true + }, + "role": { + "type": "string", + "enum": [ + "user" + ], + "description": "The role of the messages author, in this case `user`." + }, + "name": { + "type": "string", + "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role." + } + }, + "required": [ + "content", + "role" + ] + }, + "chatCompletionRequestAssistantMessage": { + "type": "object", + "title": "Assistant message", + "properties": { + "content": { + "nullable": true, + "oneOf": [ + { + "type": "string", + "description": "The contents of the assistant message.", + "title": "Text content" + }, + { + "type": "array", + "description": "An array of content parts with a defined type. Can be one or more of type `text`, or exactly one of type `refusal`.", + "title": "Array of content parts", + "items": { + "$ref": "#/components/schemas/chatCompletionRequestAssistantMessageContentPart" + }, + "minItems": 1 + } + ], + "description": "The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.\n" + }, + "refusal": { + "nullable": true, + "type": "string", + "description": "The refusal message by the assistant." + }, + "role": { + "type": "string", + "enum": [ + "assistant" + ], + "description": "The role of the messages author, in this case `assistant`." + }, + "name": { + "type": "string", + "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role." + }, + "tool_calls": { + "$ref": "#/components/schemas/chatCompletionMessageToolCalls" + }, + "function_call": { + "type": "object", + "deprecated": true, + "description": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.", + "nullable": true, + "properties": { + "arguments": { + "type": "string", + "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." + }, + "name": { + "type": "string", + "description": "The name of the function to call." + } + }, + "required": [ + "arguments", + "name" + ] + } + }, + "required": [ + "role" + ] + }, + "chatCompletionRequestToolMessage": { + "type": "object", + "title": "Tool message", + "properties": { + "role": { + "type": "string", + "enum": [ + "tool" + ], + "description": "The role of the messages author, in this case `tool`." + }, + "content": { + "oneOf": [ + { + "type": "string", + "description": "The contents of the tool message.", + "title": "Text content" + }, + { + "type": "array", + "description": "An array of content parts with a defined type. For tool messages, only type `text` is supported.", + "title": "Array of content parts", + "items": { + "$ref": "#/components/schemas/chatCompletionRequestToolMessageContentPart" + }, + "minItems": 1 + } + ], + "description": "The contents of the tool message." + }, + "tool_call_id": { + "type": "string", + "description": "Tool call that this message is responding to." + } + }, + "required": [ + "role", + "content", + "tool_call_id" + ] + }, + "chatCompletionRequestFunctionMessage": { + "type": "object", + "title": "Function message", + "deprecated": true, + "properties": { + "role": { + "type": "string", + "enum": [ + "function" + ], + "description": "The role of the messages author, in this case `function`." + }, + "content": { + "nullable": true, + "type": "string", + "description": "The contents of the function message." + }, + "name": { + "type": "string", + "description": "The name of the function to call." + } + }, + "required": [ + "role", + "content", + "name" + ] + }, + "chatCompletionRequestSystemMessageContentPart": { + "oneOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartText" + } + ] + }, + "chatCompletionRequestUserMessageContentPart": { + "oneOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartText" + }, + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartImage" + } + ] + }, + "chatCompletionRequestAssistantMessageContentPart": { + "oneOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartText" + }, + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartRefusal" + } + ] + }, + "chatCompletionRequestToolMessageContentPart": { + "oneOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartText" + } + ] + }, + "chatCompletionRequestMessageContentPartText": { + "type": "object", + "title": "Text content part", + "properties": { + "type": { + "type": "string", + "enum": [ + "text" + ], + "description": "The type of the content part." + }, + "text": { + "type": "string", + "description": "The text content." + } + }, + "required": [ + "type", + "text" + ] + }, + "chatCompletionRequestMessageContentPartImage": { + "type": "object", + "title": "Image content part", + "properties": { + "type": { + "type": "string", + "enum": [ + "image_url" + ], + "description": "The type of the content part." + }, + "image_url": { + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "Either a URL of the image or the base64 encoded image data.", + "format": "uri" + }, + "detail": { + "type": "string", + "description": "Specifies the detail level of the image. Learn more in the [Vision guide](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/gpt-with-vision?tabs=rest%2Csystem-assigned%2Cresource#detail-parameter-settings-in-image-processing-low-high-auto).", + "enum": [ + "auto", + "low", + "high" + ], + "default": "auto" + } + }, + "required": [ + "url" + ] + } + }, + "required": [ + "type", + "image_url" + ] + }, + "chatCompletionRequestMessageContentPartRefusal": { + "type": "object", + "title": "Refusal content part", + "properties": { + "type": { + "type": "string", + "enum": [ + "refusal" + ], + "description": "The type of the content part." + }, + "refusal": { + "type": "string", + "description": "The refusal message generated by the model." + } + }, + "required": [ + "type", + "refusal" + ] + }, + "azureChatExtensionConfiguration": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/azureChatExtensionType" + } + }, + "description": " A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat\n completions request that should use Azure OpenAI chat extensions to augment the response behavior.\n The use of this configuration is compatible only with Azure OpenAI.", + "discriminator": { + "propertyName": "type", + "mapping": { + "azure_search": "#/components/schemas/azureSearchChatExtensionConfiguration", + "azure_cosmos_db": "#/components/schemas/azureCosmosDBChatExtensionConfiguration", + "elasticsearch": "#/components/schemas/elasticsearchChatExtensionConfiguration", + "mongo_db": "#/components/schemas/mongoDBChatExtensionConfiguration", + "pinecone": "#/components/schemas/pineconeChatExtensionConfiguration" + } + } + }, + "azureChatExtensionType": { + "type": "string", + "description": " A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat\n completions request that should use Azure OpenAI chat extensions to augment the response behavior.\n The use of this configuration is compatible only with Azure OpenAI.", + "enum": [ + "azure_search", + "azure_cosmos_db", + "elasticsearch", + "mongo_db", + "pinecone" + ], + "x-ms-enum": { + "name": "AzureChatExtensionType", + "modelAsString": true, + "values": [ + { + "name": "azureSearch", + "value": "azure_search", + "description": "Represents the use of Azure Search as an Azure OpenAI chat extension." + }, + { + "name": "azureCosmosDB", + "value": "azure_cosmos_db", + "description": "Represents the use of Azure Cosmos DB as an Azure OpenAI chat extension." + }, + { + "name": "elasticsearch", + "value": "elasticsearch", + "description": "Represents the use of Elasticsearch® index as an Azure OpenAI chat extension." + }, + { + "name": "mongoDB", + "value": "mongo_db", + "description": "Represents the use of Mongo DB as an Azure OpenAI chat extension." + }, + { + "name": "pinecone", + "value": "pinecone", + "description": "Represents the use of Pinecone index as an Azure OpenAI chat extension." + } + ] + } + }, + "azureSearchChatExtensionConfiguration": { + "required": [ + "parameters" + ], + "description": "A specific representation of configurable options for Azure Search when using it as an Azure OpenAI chat\nextension.", + "allOf": [ + { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + }, + { + "properties": { + "parameters": { + "$ref": "#/components/schemas/azureSearchChatExtensionParameters" + } + } + } + ], + "x-ms-discriminator-value": "azure_search" + }, + "azureSearchChatExtensionParameters": { + "required": [ + "authentication", + "endpoint", + "index_name" + ], + "type": "object", + "properties": { + "authentication": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + }, + { + "$ref": "#/components/schemas/onYourDataSystemAssignedManagedIdentityAuthenticationOptions" + }, + { + "$ref": "#/components/schemas/onYourDataUserAssignedManagedIdentityAuthenticationOptions" + }, + { + "$ref": "#/components/schemas/onYourDataAccessTokenAuthenticationOptions" + } + ] + }, + "top_n_documents": { + "type": "integer", + "description": "The configured top number of documents to feature for the configured query.", + "format": "int32" + }, + "max_search_queries": { + "type": "integer", + "description": "The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send.", + "format": "int32" + }, + "allow_partial_result": { + "type": "boolean", + "default": false, + "description": "If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails." + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "strictness": { + "maximum": 5, + "minimum": 1, + "type": "integer", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "format": "int32" + }, + "endpoint": { + "type": "string", + "description": "The absolute endpoint path for the Azure Search resource to use.", + "format": "uri" + }, + "index_name": { + "type": "string", + "description": "The name of the index to use as available in the referenced Azure Search resource." + }, + "fields_mapping": { + "$ref": "#/components/schemas/azureSearchIndexFieldMappingOptions" + }, + "query_type": { + "$ref": "#/components/schemas/azureSearchQueryType" + }, + "semantic_configuration": { + "type": "string", + "description": "The additional semantic configuration for the query." + }, + "filter": { + "type": "string", + "description": "Search filter." + }, + "embedding_dependency": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataEndpointVectorizationSource" + }, + { + "$ref": "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + }, + { + "$ref": "#/components/schemas/onYourDataIntegratedVectorizationSource" + } + ] + }, + "include_contexts": { + "type": "array", + "description": "The included properties of the output context. If not specified, the default value is `citations` and `intent`.", + "items": { + "$ref": "#/components/schemas/onYourDataContextProperty" + } + } + }, + "description": "Parameters for Azure Search when used as an Azure OpenAI chat extension." + }, + "azureSearchIndexFieldMappingOptions": { + "type": "object", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use." + }, + "vector_fields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + } + }, + "image_vector_fields": { + "type": "array", + "description": "The names of fields that represent image vector data.", + "items": { + "type": "string" + } + } + }, + "description": "Optional settings to control how fields are processed when using a configured Azure Search resource." + }, + "azureSearchQueryType": { + "type": "string", + "description": "The type of Azure Search retrieval query that should be executed when using it as an Azure OpenAI chat extension.", + "enum": [ + "simple", + "semantic", + "vector", + "vector_simple_hybrid", + "vector_semantic_hybrid" + ], + "x-ms-enum": { + "name": "AzureSearchQueryType", + "modelAsString": true, + "values": [ + { + "name": "simple", + "value": "simple", + "description": "Represents the default, simple query parser." + }, + { + "name": "semantic", + "value": "semantic", + "description": "Represents the semantic query parser for advanced semantic modeling." + }, + { + "name": "vector", + "value": "vector", + "description": "Represents vector search over computed data." + }, + { + "name": "vectorSimpleHybrid", + "value": "vector_simple_hybrid", + "description": "Represents a combination of the simple query strategy with vector data." + }, + { + "name": "vectorSemanticHybrid", + "value": "vector_semantic_hybrid", + "description": "Represents a combination of semantic search and vector data querying." + } + ] + } + }, + "azureCosmosDBChatExtensionConfiguration": { + "required": [ + "parameters" + ], + "description": "A specific representation of configurable options for Azure Cosmos DB when using it as an Azure OpenAI chat\nextension.", + "allOf": [ + { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + }, + { + "properties": { + "parameters": { + "$ref": "#/components/schemas/azureCosmosDBChatExtensionParameters" + } + } + } + ], + "x-ms-discriminator-value": "azure_cosmos_db" + }, + "azureCosmosDBChatExtensionParameters": { + "required": [ + "authentication", + "container_name", + "database_name", + "embedding_dependency", + "fields_mapping", + "index_name" + ], + "type": "object", + "properties": { + "authentication": { + "$ref": "#/components/schemas/onYourDataConnectionStringAuthenticationOptions" + }, + "top_n_documents": { + "type": "integer", + "description": "The configured top number of documents to feature for the configured query.", + "format": "int32" + }, + "max_search_queries": { + "type": "integer", + "description": "The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send.", + "format": "int32" + }, + "allow_partial_result": { + "type": "boolean", + "default": false, + "description": "If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails." + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "strictness": { + "maximum": 5, + "minimum": 1, + "type": "integer", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "format": "int32" + }, + "database_name": { + "type": "string", + "description": "The MongoDB vCore database name to use with Azure Cosmos DB." + }, + "container_name": { + "type": "string", + "description": "The name of the Azure Cosmos DB resource container." + }, + "index_name": { + "type": "string", + "description": "The MongoDB vCore index name to use with Azure Cosmos DB." + }, + "fields_mapping": { + "$ref": "#/components/schemas/azureCosmosDBFieldMappingOptions" + }, + "embedding_dependency": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataEndpointVectorizationSource" + }, + { + "$ref": "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + } + ] + }, + "include_contexts": { + "type": "array", + "description": "The included properties of the output context. If not specified, the default value is `citations` and `intent`.", + "items": { + "$ref": "#/components/schemas/onYourDataContextProperty" + } + } + }, + "description": "Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for\nMongoDB vCore." + }, + "azureCosmosDBFieldMappingOptions": { + "required": [ + "content_fields", + "vector_fields" + ], + "type": "object", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use." + }, + "vector_fields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + } + } + }, + "description": "Optional settings to control how fields are processed when using a configured Azure Cosmos DB resource." + }, + "elasticsearchChatExtensionConfiguration": { + "required": [ + "parameters" + ], + "description": "A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat\nextension.", + "allOf": [ + { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + }, + { + "properties": { + "parameters": { + "$ref": "#/components/schemas/elasticsearchChatExtensionParameters" + } + } + } + ], + "x-ms-discriminator-value": "elasticsearch" + }, + "elasticsearchChatExtensionParameters": { + "required": [ + "authentication", + "endpoint", + "index_name" + ], + "type": "object", + "properties": { + "authentication": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataKeyAndKeyIdAuthenticationOptions" + }, + { + "$ref": "#/components/schemas/onYourDataEncodedApiKeyAuthenticationOptions" + } + ] + }, + "top_n_documents": { + "type": "integer", + "description": "The configured top number of documents to feature for the configured query.", + "format": "int32" + }, + "max_search_queries": { + "type": "integer", + "description": "The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send.", + "format": "int32" + }, + "allow_partial_result": { + "type": "boolean", + "default": false, + "description": "If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails." + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "strictness": { + "maximum": 5, + "minimum": 1, + "type": "integer", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "format": "int32" + }, + "endpoint": { + "type": "string", + "description": "The endpoint of Elasticsearch®.", + "format": "uri" + }, + "index_name": { + "type": "string", + "description": "The index name of Elasticsearch®." + }, + "fields_mapping": { + "$ref": "#/components/schemas/elasticsearchIndexFieldMappingOptions" + }, + "query_type": { + "$ref": "#/components/schemas/elasticsearchQueryType" + }, + "embedding_dependency": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataEndpointVectorizationSource" + }, + { + "$ref": "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + }, + { + "$ref": "#/components/schemas/onYourDataModelIdVectorizationSource" + } + ] + }, + "include_contexts": { + "type": "array", + "description": "The included properties of the output context. If not specified, the default value is `citations` and `intent`.", + "items": { + "$ref": "#/components/schemas/onYourDataContextProperty" + } + } + }, + "description": "Parameters to use when configuring Elasticsearch® as an Azure OpenAI chat extension. " + }, + "elasticsearchIndexFieldMappingOptions": { + "type": "object", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use." + }, + "vector_fields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + } + } + }, + "description": "Optional settings to control how fields are processed when using a configured Elasticsearch® resource." + }, + "elasticsearchQueryType": { + "type": "string", + "description": "The type of Elasticsearch® retrieval query that should be executed when using it as an Azure OpenAI chat extension.", + "enum": [ + "simple", + "vector" + ], + "x-ms-enum": { + "name": "ElasticsearchQueryType", + "modelAsString": true, + "values": [ + { + "name": "simple", + "value": "simple", + "description": "Represents the default, simple query parser." + }, + { + "name": "vector", + "value": "vector", + "description": "Represents vector search over computed data." + } + ] + } + }, + "mongoDBChatExtensionConfiguration": { + "required": [ + "parameters" + ], + "description": "A specific representation of configurable options for Mongo DB when using it as an Azure OpenAI chat\nextension.", + "allOf": [ + { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + }, + { + "properties": { + "parameters": { + "$ref": "#/components/schemas/mongoDBChatExtensionParameters" + } + } + } + ], + "x-ms-discriminator-value": "mongo_db" + }, + "mongoDBChatExtensionParameters": { + "required": [ + "authentication", + "app_name", + "collection_name", + "database_name", + "endpoint", + "embedding_dependency", + "fields_mapping", + "index_name" + ], + "type": "object", + "properties": { + "authentication": { + "$ref": "#/components/schemas/onYourDataUsernameAndPasswordAuthenticationOptions" + }, + "top_n_documents": { + "type": "integer", + "description": "The configured top number of documents to feature for the configured query.", + "format": "int32" + }, + "max_search_queries": { + "type": "integer", + "description": "The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send.", + "format": "int32" + }, + "allow_partial_result": { + "type": "boolean", + "default": false, + "description": "If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails." + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "strictness": { + "maximum": 5, + "minimum": 1, + "type": "integer", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "format": "int32" + }, + "endpoint": { + "type": "string", + "description": "The name of the Mongo DB cluster endpoint." + }, + "database_name": { + "type": "string", + "description": "The name of the Mongo DB database." + }, + "collection_name": { + "type": "string", + "description": "The name of the Mongo DB Collection." + }, + "app_name": { + "type": "string", + "description": "The name of the Mongo DB Application." + }, + "index_name": { + "type": "string", + "description": "The The name of the Mongo DB index." + }, + "fields_mapping": { + "$ref": "#/components/schemas/mongoDBFieldMappingOptions" + }, + "embedding_dependency": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataEndpointVectorizationSource" + }, + { + "$ref": "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + } + ] + }, + "include_contexts": { + "type": "array", + "description": "The included properties of the output context. If not specified, the default value is `citations` and `intent`.", + "items": { + "$ref": "#/components/schemas/onYourDataContextProperty" + } + } + }, + "description": "Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Mongo DB." + }, + "mongoDBFieldMappingOptions": { + "required": [ + "content_fields", + "vector_fields" + ], + "type": "object", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use." + }, + "vector_fields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + } + } + }, + "description": "Optional settings to control how fields are processed when using a configured Mongo DB resource." + }, + "pineconeChatExtensionConfiguration": { + "required": [ + "parameters" + ], + "description": "A specific representation of configurable options for Pinecone when using it as an Azure OpenAI chat\nextension.", + "allOf": [ + { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + }, + { + "properties": { + "parameters": { + "$ref": "#/components/schemas/pineconeChatExtensionParameters" + } + } + } + ], + "x-ms-discriminator-value": "pinecone" + }, + "pineconeChatExtensionParameters": { + "required": [ + "authentication", + "embedding_dependency", + "environment", + "fields_mapping", + "index_name" + ], + "type": "object", + "properties": { + "authentication": { + "$ref": "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + }, + "top_n_documents": { + "type": "integer", + "description": "The configured top number of documents to feature for the configured query.", + "format": "int32" + }, + "max_search_queries": { + "type": "integer", + "description": "The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send.", + "format": "int32" + }, + "allow_partial_result": { + "type": "boolean", + "default": false, + "description": "If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails." + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "strictness": { + "maximum": 5, + "minimum": 1, + "type": "integer", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "format": "int32" + }, + "environment": { + "type": "string", + "description": "The environment name of Pinecone." + }, + "index_name": { + "type": "string", + "description": "The name of the Pinecone database index." + }, + "fields_mapping": { + "$ref": "#/components/schemas/pineconeFieldMappingOptions" + }, + "embedding_dependency": { + "$ref": "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + }, + "include_contexts": { + "type": "array", + "description": "The included properties of the output context. If not specified, the default value is `citations` and `intent`.", + "items": { + "$ref": "#/components/schemas/onYourDataContextProperty" + } + } + }, + "description": "Parameters for configuring Azure OpenAI Pinecone chat extensions." + }, + "pineconeFieldMappingOptions": { + "required": [ + "content_fields" + ], + "type": "object", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use." + } + }, + "description": "Optional settings to control how fields are processed when using a configured Pinecone resource." + }, + "onYourDataAuthenticationOptions": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/onYourDataAuthenticationType" + } + }, + "description": "The authentication options for Azure OpenAI On Your Data.", + "discriminator": { + "propertyName": "type", + "mapping": { + "api_key": "#/components/schemas/onYourDataApiKeyAuthenticationOptions", + "connection_string": "#/components/schemas/onYourDataConnectionStringAuthenticationOptions", + "key_and_key_id": "#/components/schemas/onYourDataKeyAndKeyIdAuthenticationOptions", + "encoded_api_key": "#/components/schemas/onYourDataEncodedApiKeyAuthenticationOptions", + "access_token": "#/components/schemas/onYourDataAccessTokenAuthenticationOptions", + "system_assigned_managed_identity": "#/components/schemas/onYourDataSystemAssignedManagedIdentityAuthenticationOptions", + "user_assigned_managed_identity": "#/components/schemas/onYourDataUserAssignedManagedIdentityAuthenticationOptions", + "username_and_password": "#/components/schemas/onYourDataUsernameAndPasswordAuthenticationOptions" + } + } + }, + "onYourDataContextProperty": { + "type": "string", + "description": "The context property.", + "enum": [ + "citations", + "intent", + "all_retrieved_documents" + ], + "x-ms-enum": { + "name": "OnYourDataContextProperty", + "modelAsString": true, + "values": [ + { + "name": "citations", + "value": "citations", + "description": "The `citations` property." + }, + { + "name": "intent", + "value": "intent", + "description": "The `intent` property." + }, + { + "name": "allRetrievedDocuments", + "value": "all_retrieved_documents", + "description": "The `all_retrieved_documents` property." + } + ] + } + }, + "onYourDataAuthenticationType": { + "type": "string", + "description": "The authentication types supported with Azure OpenAI On Your Data.", + "enum": [ + "api_key", + "connection_string", + "key_and_key_id", + "encoded_api_key", + "access_token", + "system_assigned_managed_identity", + "user_assigned_managed_identity", + "username_and_password" + ], + "x-ms-enum": { + "name": "OnYourDataAuthenticationType", + "modelAsString": true, + "values": [ + { + "name": "apiKey", + "value": "api_key", + "description": "Authentication via API key." + }, + { + "name": "connectionString", + "value": "connection_string", + "description": "Authentication via connection string." + }, + { + "name": "keyAndKeyId", + "value": "key_and_key_id", + "description": "Authentication via key and key ID pair." + }, + { + "name": "encodedApiKey", + "value": "encoded_api_key", + "description": "Authentication via encoded API key." + }, + { + "name": "accessToken", + "value": "access_token", + "description": "Authentication via access token." + }, + { + "name": "systemAssignedManagedIdentity", + "value": "system_assigned_managed_identity", + "description": "Authentication via system-assigned managed identity." + }, + { + "name": "userAssignedManagedIdentity", + "value": "user_assigned_managed_identity", + "description": "Authentication via user-assigned managed identity." + }, + { + "name": "usernameAndPassword", + "value": "username_and_password", + "description": "Authentication via username and password." + } + ] + } + }, + "onYourDataApiKeyAuthenticationOptions": { + "required": [ + "key" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using an API key.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "key": { + "type": "string", + "description": "The API key to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "api_key" + }, + "onYourDataConnectionStringAuthenticationOptions": { + "required": [ + "connection_string" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using a connection string.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "connection_string": { + "type": "string", + "description": "The connection string to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "connection_string" + }, + "onYourDataKeyAndKeyIdAuthenticationOptions": { + "required": [ + "key", + "key_id" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using an Elasticsearch key and key ID pair.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "key": { + "type": "string", + "description": "The Elasticsearch key to use for authentication." + }, + "key_id": { + "type": "string", + "description": "The Elasticsearch key ID to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "key_and_key_id" + }, + "onYourDataEncodedApiKeyAuthenticationOptions": { + "required": [ + "encoded_api_key" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using an Elasticsearch encoded API key.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "encoded_api_key": { + "type": "string", + "description": "The Elasticsearch encoded API key to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "encoded_api_key" + }, + "onYourDataAccessTokenAuthenticationOptions": { + "required": [ + "access_token" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using access token.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "access_token": { + "type": "string", + "description": "The access token to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "access_token" + }, + "onYourDataSystemAssignedManagedIdentityAuthenticationOptions": { + "description": "The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "system_assigned_managed_identity" + }, + "onYourDataUserAssignedManagedIdentityAuthenticationOptions": { + "required": [ + "managed_identity_resource_id" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "managed_identity_resource_id": { + "type": "string", + "description": "The resource ID of the user-assigned managed identity to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "user_assigned_managed_identity" + }, + "onYourDataUsernameAndPasswordAuthenticationOptions": { + "required": [ + "username", + "password" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using a username and a password.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "username": { + "type": "string", + "description": "The username to use for authentication." + }, + "password": { + "type": "string", + "description": "The password. to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "username_and_password" + }, + "onYourDataVectorizationSource": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/onYourDataVectorizationSourceType" + } + }, + "description": "An abstract representation of a vectorization source for Azure OpenAI On Your Data with vector search.", + "discriminator": { + "propertyName": "type", + "mapping": { + "endpoint": "#/components/schemas/onYourDataEndpointVectorizationSource", + "deployment_name": "#/components/schemas/onYourDataDeploymentNameVectorizationSource", + "integrated": "#/components/schemas/onYourDataIntegratedVectorizationSource", + "model_id": "#/components/schemas/onYourDataModelIdVectorizationSource" + } + } + }, + "onYourDataVectorizationSourceType": { + "type": "string", + "description": "Represents the available sources Azure OpenAI On Your Data can use to configure vectorization of data for use with\nvector search.", + "enum": [ + "endpoint", + "deployment_name", + "integrated", + "model_id" + ], + "x-ms-enum": { + "name": "OnYourDataVectorizationSourceType", + "modelAsString": true, + "values": [ + { + "name": "endpoint", + "value": "endpoint", + "description": "Represents vectorization performed by public service calls to an Azure OpenAI embedding model." + }, + { + "name": "deploymentName", + "value": "deployment_name", + "description": "Represents an Ada model deployment name to use. This model deployment must be in the same Azure OpenAI resource, but\nOn Your Data will use this model deployment via an internal call rather than a public one, which enables vector\nsearch even in private networks." + }, + { + "name": "integrated", + "value": "integrated", + "description": "Represents the integrated vectorizer defined within the search resource." + }, + { + "name": "modelId", + "value": "model_id", + "description": "Represents a specific embedding model ID as defined in the search service.\nCurrently only supported by Elasticsearch®." + } + ] + } + }, + "onYourDataEndpointVectorizationSource": { + "required": [ + "authentication", + "endpoint" + ], + "description": "The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based\non a public Azure OpenAI endpoint call for embeddings.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataVectorizationSource" + }, + { + "properties": { + "endpoint": { + "type": "string", + "description": "Specifies the resource endpoint URL from which embeddings should be retrieved. It should be in the format of https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. The api-version query parameter is not allowed.", + "format": "uri" + }, + "authentication": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + }, + { + "$ref": "#/components/schemas/onYourDataAccessTokenAuthenticationOptions" + } + ] + }, + "dimensions": { + "type": "integer", + "description": "The number of dimensions the embeddings should have. Only supported in `text-embedding-3` and later models.", + "format": "int32" + } + } + } + ], + "x-ms-discriminator-value": "endpoint" + }, + "onYourDataDeploymentNameVectorizationSource": { + "required": [ + "deployment_name" + ], + "description": "The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based\non an internal embeddings model deployment name in the same Azure OpenAI resource.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataVectorizationSource" + }, + { + "properties": { + "deployment_name": { + "type": "string", + "description": "Specifies the name of the model deployment to use for vectorization. This model deployment must be in the same Azure OpenAI resource, but On Your Data will use this model deployment via an internal call rather than a public one, which enables vector search even in private networks." + }, + "dimensions": { + "type": "integer", + "description": "The number of dimensions the embeddings should have. Only supported in `text-embedding-3` and later models.", + "format": "int32" + } + } + } + ], + "x-ms-discriminator-value": "deployment_name" + }, + "onYourDataIntegratedVectorizationSource": { + "description": "Represents the integrated vectorizer defined within the search resource.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataVectorizationSource" + } + ], + "x-ms-discriminator-value": "integrated" + }, + "onYourDataModelIdVectorizationSource": { + "required": [ + "model_id" + ], + "description": "The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based\non a search service model ID. Currently only supported by Elasticsearch®.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataVectorizationSource" + }, + { + "properties": { + "model_id": { + "type": "string", + "description": "Specifies the model ID to use for vectorization. This model ID must be defined in the search service." + } + } + } + ], + "x-ms-discriminator-value": "model_id" + }, + "azureChatExtensionsMessageContext": { + "type": "object", + "properties": { + "citations": { + "type": "array", + "description": "The data source retrieval result, used to generate the assistant message in the response.", + "items": { + "$ref": "#/components/schemas/citation" + }, + "x-ms-identifiers": [] + }, + "intent": { + "type": "string", + "description": "The detected intent from the chat history, used to pass to the next turn to carry over the context." + }, + "all_retrieved_documents": { + "type": "array", + "description": "All the retrieved documents.", + "items": { + "$ref": "#/components/schemas/retrievedDocument" + } + } + }, + "description": " A representation of the additional context information available when Azure OpenAI chat extensions are involved\n in the generation of a corresponding chat completions response. This context information is only populated when\n using an Azure OpenAI request configured to use a matching extension." + }, + "citation": { + "required": [ + "content" + ], + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The content of the citation." + }, + "title": { + "type": "string", + "description": "The title of the citation." + }, + "url": { + "type": "string", + "description": "The URL of the citation." + }, + "filepath": { + "type": "string", + "description": "The file path of the citation." + }, + "chunk_id": { + "type": "string", + "description": "The chunk ID of the citation." + }, + "rerank_score": { + "type": "number", + "description": "The rerank score of the retrieved document.", + "format": "double" + } + }, + "description": "citation information for a chat completions response message." + }, + "retrievedDocument": { + "type": "object", + "description": "The retrieved document.", + "required": [ + "search_queries", + "data_source_index", + "original_search_score" + ], + "allOf": [ + { + "$ref": "#/components/schemas/citation" + }, + { + "properties": { + "search_queries": { + "type": "array", + "description": "The search queries used to retrieve the document.", + "items": { + "type": "string" + } + }, + "data_source_index": { + "type": "integer", + "description": "The index of the data source.", + "format": "int32" + }, + "original_search_score": { + "type": "number", + "description": "The original search score of the retrieved document.", + "format": "double" + }, + "filter_reason": { + "$ref": "#/components/schemas/filterReason", + "description": "Represents the rationale for filtering the document. If the document does not undergo filtering, this field will remain unset." + } + } + } + ] + }, + "filterReason": { + "type": "string", + "description": "The filtering reason of the retrieved document.", + "enum": [ + "score", + "rerank" + ], + "x-ms-enum": { + "name": "FilterReason", + "modelAsString": true, + "values": [ + { + "name": "score", + "value": "score", + "description": "The document is filtered by original search score threshold defined by `strictness` configure." + }, + { + "name": "rerank", + "value": "rerank", + "description": "The document is not filtered by original search score threshold, but is filtered by rerank score and `top_n_documents` configure." + } + ] + } + }, + "chatCompletionMessageToolCall": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the tool call." + }, + "type": { + "$ref": "#/components/schemas/toolCallType" + }, + "function": { + "type": "object", + "description": "The function that the model called.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + }, + "arguments": { + "type": "string", + "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." + } + }, + "required": [ + "name", + "arguments" + ] + } + }, + "required": [ + "id", + "type", + "function" + ] + }, + "toolCallType": { + "type": "string", + "enum": [ + "function" + ], + "description": "The type of the tool call, in this case `function`.", + "x-ms-enum": { + "name": "ToolCallType", + "modelAsString": true, + "values": [ + { + "value": "function", + "description": "The tool call type is function." + } + ] + } + }, + "chatCompletionRequestMessageTool": { + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessage" + }, + { + "type": "object", + "nullable": true, + "properties": { + "tool_call_id": { + "type": "string", + "description": "Tool call that this message is responding to." + }, + "content": { + "type": "string", + "description": "The contents of the message.", + "nullable": true + } + } + } + ], + "required": [ + "tool_call_id", + "content" + ] + }, + "chatCompletionRequestMessageFunction": { + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessage" + }, + { + "type": "object", + "description": "Deprecated. Message that represents a function.", + "nullable": true, + "properties": { + "role": { + "type": "string", + "enum": [ + "function" + ], + "description": "The role of the messages author, in this case `function`." + }, + "name": { + "type": "string", + "description": "The contents of the message." + }, + "content": { + "type": "string", + "description": "The contents of the message.", + "nullable": true + } + } + } + ], + "required": [ + "function_call_id", + "content" + ] + }, + "createChatCompletionResponse": { + "type": "object", + "description": "Represents a chat completion response returned by model, based on the provided input.", + "properties": { + "id": { + "type": "string", + "description": "A unique identifier for the chat completion." + }, + "prompt_filter_results": { + "$ref": "#/components/schemas/promptFilterResults" + }, + "choices": { + "type": "array", + "description": "A list of chat completion choices. Can be more than one if `n` is greater than 1.", + "items": { + "type": "object", + "required": [ + "finish_reason", + "index", + "message", + "logprobs" + ], + "properties": { + "finish_reason": { + "type": "string", + "description": "The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,\n`length` if the maximum number of tokens specified in the request was reached,\n`content_filter` if content was omitted due to a flag from our content filters,\n`tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function.\n", + "enum": [ + "stop", + "length", + "tool_calls", + "content_filter", + "function_call" + ] + }, + "index": { + "type": "integer", + "description": "The index of the choice in the list of choices." + }, + "message": { + "$ref": "#/components/schemas/chatCompletionResponseMessage" + }, + "content_filter_results": { + "$ref": "#/components/schemas/contentFilterChoiceResults" + }, + "logprobs": { + "description": "Log probability information for the choice.", + "type": "object", + "nullable": true, + "properties": { + "content": { + "description": "A list of message content tokens with log probability information.", + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionTokenLogprob" + }, + "nullable": true + }, + "refusal": { + "description": "A list of message refusal tokens with log probability information.", + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionTokenLogprob" + }, + "nullable": true + } + }, + "required": [ + "content", + "refusal" + ] + } + } + } + }, + "created": { + "type": "integer", + "description": "The Unix timestamp (in seconds) of when the chat completion was created." + }, + "model": { + "type": "string", + "description": "The model used for the chat completion." + }, + "system_fingerprint": { + "type": "string", + "description": "This fingerprint represents the backend configuration that the model runs with.\n\nCan be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.\n" + }, + "object": { + "type": "string", + "description": "The object type, which is always `chat.completion`.", + "enum": [ + "chat.completion" + ] + }, + "usage": { + "$ref": "#/components/schemas/completionUsage" + } + }, + "required": [ + "choices", + "created", + "id", + "model", + "object" + ] + }, + "createChatCompletionStreamResponse": { + "type": "object", + "description": "Represents a streamed chunk of a chat completion response returned by model, based on the provided input.", + "properties": { + "id": { + "type": "string", + "description": "A unique identifier for the chat completion. Each chunk has the same ID." + }, + "choices": { + "type": "array", + "description": "A list of chat completion choices. Can contain more than one elements if `n` is greater than 1.\n", + "items": { + "type": "object", + "required": [ + "delta", + "finish_reason", + "index" + ], + "properties": { + "delta": { + "$ref": "#/components/schemas/chatCompletionStreamResponseDelta" + }, + "logprobs": { + "description": "Log probability information for the choice.", + "type": "object", + "nullable": true, + "properties": { + "content": { + "description": "A list of message content tokens with log probability information.", + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionTokenLogprob" + }, + "nullable": true + }, + "refusal": { + "description": "A list of message refusal tokens with log probability information.", + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionTokenLogprob" + }, + "nullable": true + } + }, + "required": [ + "content", + "refusal" + ] + }, + "finish_reason": { + "type": "string", + "description": "The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,\n`length` if the maximum number of tokens specified in the request was reached,\n`content_filter` if content was omitted due to a flag from our content filters,\n`tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function.\n", + "enum": [ + "stop", + "length", + "tool_calls", + "content_filter", + "function_call" + ], + "nullable": true + }, + "index": { + "type": "integer", + "description": "The index of the choice in the list of choices." + } + } + } + }, + "created": { + "type": "integer", + "description": "The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp." + }, + "model": { + "type": "string", + "description": "The model to generate the completion." + }, + "system_fingerprint": { + "type": "string", + "description": "This fingerprint represents the backend configuration that the model runs with.\nCan be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.\n" + }, + "object": { + "type": "string", + "description": "The object type, which is always `chat.completion.chunk`.", + "enum": [ + "chat.completion.chunk" + ], + "required": [ + "prompt_tokens", + "completion_tokens", + "total_tokens" + ] + } + }, + "required": [ + "choices", + "created", + "id", + "model", + "object" + ] + }, + "chatCompletionStreamResponseDelta": { + "type": "object", + "description": "A chat completion delta generated by streamed model responses.", + "properties": { + "content": { + "type": "string", + "description": "The contents of the chunk message.", + "nullable": true + }, + "function_call": { + "deprecated": true, + "type": "object", + "description": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.", + "properties": { + "arguments": { + "type": "string", + "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." + }, + "name": { + "type": "string", + "description": "The name of the function to call." + } + } + }, + "tool_calls": { + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionMessageToolCallChunk" + } + }, + "role": { + "type": "string", + "enum": [ + "system", + "user", + "assistant", + "tool" + ], + "description": "The role of the author of this message." + }, + "refusal": { + "type": "string", + "description": "The refusal message generated by the model.", + "nullable": true + } + } + }, + "chatCompletionMessageToolCallChunk": { + "type": "object", + "properties": { + "index": { + "type": "integer" + }, + "id": { + "type": "string", + "description": "The ID of the tool call." + }, + "type": { + "type": "string", + "enum": [ + "function" + ], + "description": "The type of the tool. Currently, only `function` is supported." + }, + "function": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + }, + "arguments": { + "type": "string", + "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." + } + } + } + }, + "required": [ + "index" + ] + }, + "chatCompletionStreamOptions": { + "description": "Options for streaming response. Only set this when you set `stream: true`.\n", + "type": "object", + "nullable": true, + "default": null, + "properties": { + "include_usage": { + "type": "boolean", + "description": "If set, an additional chunk will be streamed before the `data: [DONE]` message. The `usage` field on this chunk shows the token usage statistics for the entire request, and the `choices` field will always be an empty array. All other chunks will also include a `usage` field, but with a null value.\n" + } + } + }, + "chatCompletionChoiceLogProbs": { + "description": "Log probability information for the choice.", + "type": "object", + "nullable": true, + "properties": { + "content": { + "description": "A list of message content tokens with log probability information.", + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionTokenLogprob" + }, + "nullable": true + }, + "refusal": { + "description": "A list of message refusal tokens with log probability information.", + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionTokenLogprob" + }, + "nullable": true + } + }, + "required": [ + "content" + ] + }, + "chatCompletionTokenLogprob": { + "type": "object", + "properties": { + "token": { + "description": "The token.", + "type": "string" + }, + "logprob": { + "description": "The log probability of this token.", + "type": "number" + }, + "bytes": { + "description": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.", + "type": "array", + "items": { + "type": "integer" + }, + "nullable": true + }, + "top_logprobs": { + "description": "List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned.", + "type": "array", + "items": { + "type": "object", + "properties": { + "token": { + "description": "The token.", + "type": "string" + }, + "logprob": { + "description": "The log probability of this token.", + "type": "number" + }, + "bytes": { + "description": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.", + "type": "array", + "items": { + "type": "integer" + }, + "nullable": true + } + }, + "required": [ + "token", + "logprob", + "bytes" + ] + } + } + }, + "required": [ + "token", + "logprob", + "bytes", + "top_logprobs" + ] + }, + "chatCompletionResponseMessage": { + "type": "object", + "description": "A chat completion message generated by the model.", + "properties": { + "role": { + "$ref": "#/components/schemas/chatCompletionResponseMessageRole" + }, + "refusal": { + "type": "string", + "description": "The refusal message generated by the model.", + "nullable": true + }, + "content": { + "type": "string", + "description": "The contents of the message.", + "nullable": true + }, + "tool_calls": { + "type": "array", + "description": "The tool calls generated by the model, such as function calls.", + "items": { + "$ref": "#/components/schemas/chatCompletionMessageToolCall" + } + }, + "function_call": { + "$ref": "#/components/schemas/chatCompletionFunctionCall" + }, + "context": { + "$ref": "#/components/schemas/azureChatExtensionsMessageContext" + } + }, + "required": [ + "role", + "content", + "refusal" + ] + }, + "chatCompletionResponseMessageRole": { + "type": "string", + "enum": [ + "assistant" + ], + "description": "The role of the author of the response message." + }, + "chatCompletionToolChoiceOption": { + "description": "Controls which (if any) tool is called by the model. `none` means the model will not call any tool and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools. Specifying a particular tool via `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool. `none` is the default when no tools are present. `auto` is the default if tools are present.", + "oneOf": [ + { + "type": "string", + "description": "`none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function.", + "enum": [ + "none", + "auto", + "required" + ] + }, + { + "$ref": "#/components/schemas/chatCompletionNamedToolChoice" + } + ] + }, + "chatCompletionNamedToolChoice": { + "type": "object", + "description": "Specifies a tool the model should use. Use to force the model to call a specific function.", + "properties": { + "type": { + "type": "string", + "enum": [ + "function" + ], + "description": "The type of the tool. Currently, only `function` is supported." + }, + "function": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "type", + "function" + ] + }, + "ParallelToolCalls": { + "type": "boolean", + "description": "Whether to enable parallel function calling during tool use.", + "default": true + }, + "chatCompletionMessageToolCalls": { + "type": "array", + "description": "The tool calls generated by the model, such as function calls.", + "items": { + "$ref": "#/components/schemas/chatCompletionMessageToolCall" + } + }, + "chatCompletionFunctionCall": { + "type": "object", + "description": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + }, + "arguments": { + "type": "string", + "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." + } + }, + "required": [ + "name", + "arguments" + ] + }, + "completionUsage": { + "type": "object", + "description": "Usage statistics for the completion request.", + "properties": { + "prompt_tokens": { + "type": "integer", + "description": "Number of tokens in the prompt." + }, + "completion_tokens": { + "type": "integer", + "description": "Number of tokens in the generated completion." + }, + "total_tokens": { + "type": "integer", + "description": "Total number of tokens used in the request (prompt + completion)." + }, + "completion_tokens_details": { + "type": "object", + "description": "Breakdown of tokens used in a completion.", + "properties": { + "reasoning_tokens": { + "type": "integer", + "description": "Tokens generated by the model for reasoning." + } + } + } + }, + "required": [ + "prompt_tokens", + "completion_tokens", + "total_tokens" + ] + }, + "chatCompletionTool": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "function" + ], + "description": "The type of the tool. Currently, only `function` is supported." + }, + "function": { + "$ref": "#/components/schemas/FunctionObject" + } + }, + "required": [ + "type", + "function" + ] + }, + "FunctionParameters": { + "type": "object", + "description": "The parameters the functions accepts, described as a JSON Schema object. See the guide](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.", + "additionalProperties": true + }, + "FunctionObject": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of what the function does, used by the model to choose when and how to call the function." + }, + "name": { + "type": "string", + "description": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + }, + "parameters": { + "$ref": "#/components/schemas/FunctionParameters" + }, + "strict": { + "type": "boolean", + "nullable": true, + "default": false, + "description": "Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](docs/guides/function-calling)." + } + }, + "required": [ + "name" + ] + }, + "ResponseFormatText": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of response format being defined: `text`", + "enum": [ + "text" + ] + } + }, + "required": [ + "type" + ] + }, + "ResponseFormatJsonObject": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of response format being defined: `json_object`", + "enum": [ + "json_object" + ] + } + }, + "required": [ + "type" + ] + }, + "ResponseFormatJsonSchemaSchema": { + "type": "object", + "description": "The schema for the response format, described as a JSON Schema object.", + "additionalProperties": true + }, + "ResponseFormatJsonSchema": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of response format being defined: `json_schema`", + "enum": [ + "json_schema" + ] + }, + "json_schema": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of what the response format is for, used by the model to determine how to respond in the format." + }, + "name": { + "type": "string", + "description": "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + }, + "schema": { + "$ref": "#/components/schemas/ResponseFormatJsonSchemaSchema" + }, + "strict": { + "type": "boolean", + "nullable": true, + "default": false, + "description": "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`." + } + }, + "required": [ + "type", + "name" + ] + } + }, + "required": [ + "type", + "json_schema" + ] + }, + "chatCompletionChoiceCommon": { + "type": "object", + "properties": { + "index": { + "type": "integer" + }, + "finish_reason": { + "type": "string" + } + } + }, + "createTranslationRequest": { + "type": "object", + "description": "Translation request.", + "properties": { + "file": { + "type": "string", + "description": "The audio file to translate.", + "format": "binary" + }, + "prompt": { + "type": "string", + "description": "An optional text to guide the model's style or continue a previous audio segment. The prompt should be in English." + }, + "response_format": { + "$ref": "#/components/schemas/audioResponseFormat" + }, + "temperature": { + "type": "number", + "default": 0, + "description": "The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit." + } + }, + "required": [ + "file" + ] + }, + "audioResponse": { + "description": "Translation or transcription response when response_format was json", + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "Translated or transcribed text." + } + }, + "required": [ + "text" + ] + }, + "audioVerboseResponse": { + "description": "Translation or transcription response when response_format was verbose_json", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/audioResponse" + }, + { + "properties": { + "task": { + "type": "string", + "description": "Type of audio task.", + "enum": [ + "transcribe", + "translate" + ], + "x-ms-enum": { + "modelAsString": true + } + }, + "language": { + "type": "string", + "description": "Language." + }, + "duration": { + "type": "number", + "description": "Duration." + }, + "segments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/audioSegment" + } + }, + "words": { + "type": "array", + "items": { + "$ref": "#/components/schemas/audioWord" + } + } + } + } + ], + "required": [ + "text" + ] + }, + "audioResponseFormat": { + "title": "AudioResponseFormat", + "description": "Defines the format of the output.", + "enum": [ + "json", + "text", + "srt", + "verbose_json", + "vtt" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true + } + }, + "createTranscriptionRequest": { + "type": "object", + "description": "Transcription request.", + "properties": { + "file": { + "type": "string", + "description": "The audio file object to transcribe.", + "format": "binary" + }, + "prompt": { + "type": "string", + "description": "An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language." + }, + "response_format": { + "$ref": "#/components/schemas/audioResponseFormat" + }, + "temperature": { + "type": "number", + "default": 0, + "description": "The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit." + }, + "language": { + "type": "string", + "description": "The language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency." + }, + "timestamp_granularities[]": { + "type": "array", + "description": "The timestamp granularities to populate for this transcription. `response_format` must be set `verbose_json` to use timestamp granularities. Either or both of these options are supported: `word`, or `segment`. Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency.", + "items": { + "type": "string", + "enum": [ + "word", + "segment" + ] + }, + "default": [ + "segment" + ] + } + }, + "required": [ + "file" + ] + }, + "audioSegment": { + "type": "object", + "description": "Transcription or translation segment.", + "properties": { + "id": { + "type": "integer", + "description": "Segment identifier." + }, + "seek": { + "type": "number", + "description": "Offset of the segment." + }, + "start": { + "type": "number", + "description": "Segment start offset." + }, + "end": { + "type": "number", + "description": "Segment end offset." + }, + "text": { + "type": "string", + "description": "Segment text." + }, + "tokens": { + "type": "array", + "items": { + "type": "number", + "nullable": false + }, + "description": "Tokens of the text." + }, + "temperature": { + "type": "number", + "description": "Temperature." + }, + "avg_logprob": { + "type": "number", + "description": "Average log probability." + }, + "compression_ratio": { + "type": "number", + "description": "Compression ratio." + }, + "no_speech_prob": { + "type": "number", + "description": "Probability of 'no speech'." + } + } + }, + "audioWord": { + "type": "object", + "description": "Transcription or translation word.", + "properties": { + "word": { + "type": "string", + "description": "Word" + }, + "start": { + "type": "number", + "description": "Word start offset." + }, + "end": { + "type": "number", + "description": "Word end offset." + } + } + }, + "createSpeechRequest": { + "type": "object", + "description": "Speech request.", + "properties": { + "input": { + "type": "string", + "description": "The text to synthesize audio for. The maximum length is 4096 characters.", + "maxLength": 4096 + }, + "voice": { + "type": "string", + "description": "The voice to use for speech synthesis.", + "enum": [ + "alloy", + "echo", + "fable", + "onyx", + "nova", + "shimmer" + ] + }, + "response_format": { + "type": "string", + "description": "The format to synthesize the audio in.", + "enum": [ + "mp3", + "opus", + "aac", + "flac", + "wav", + "pcm" + ] + }, + "speed": { + "description": "The speed of the synthesize audio. Select a value from `0.25` to `4.0`. `1.0` is the default.", + "type": "number", + "default": 1.0, + "minimum": 0.25, + "maximum": 4.0 + } + }, + "required": [ + "input", + "voice" + ] + }, + "imageQuality": { + "description": "The quality of the image that will be generated.", + "type": "string", + "enum": [ + "standard", + "hd" + ], + "default": "standard", + "x-ms-enum": { + "name": "Quality", + "modelAsString": true, + "values": [ + { + "value": "standard", + "description": "Standard quality creates images with standard quality.", + "name": "Standard" + }, + { + "value": "hd", + "description": "HD quality creates images with finer details and greater consistency across the image.", + "name": "HD" + } + ] + } + }, + "imagesResponseFormat": { + "description": "The format in which the generated images are returned.", + "type": "string", + "enum": [ + "url", + "b64_json" + ], + "default": "url", + "x-ms-enum": { + "name": "ImagesResponseFormat", + "modelAsString": true, + "values": [ + { + "value": "url", + "description": "The URL that provides temporary access to download the generated images.", + "name": "Url" + }, + { + "value": "b64_json", + "description": "The generated images are returned as base64 encoded string.", + "name": "Base64Json" + } + ] + } + }, + "imageSize": { + "description": "The size of the generated images.", + "type": "string", + "enum": [ + "256x256", + "512x512", + "1792x1024", + "1024x1792", + "1024x1024" + ], + "default": "1024x1024", + "x-ms-enum": { + "name": "Size", + "modelAsString": true, + "values": [ + { + "value": "256x256", + "description": "The desired size of the generated image is 256x256 pixels. Only supported for dall-e-2.", + "name": "Size256x256" + }, + { + "value": "512x512", + "description": "The desired size of the generated image is 512x512 pixels. Only supported for dall-e-2.", + "name": "Size512x512" + }, + { + "value": "1792x1024", + "description": "The desired size of the generated image is 1792x1024 pixels. Only supported for dall-e-3.", + "name": "Size1792x1024" + }, + { + "value": "1024x1792", + "description": "The desired size of the generated image is 1024x1792 pixels. Only supported for dall-e-3.", + "name": "Size1024x1792" + }, + { + "value": "1024x1024", + "description": "The desired size of the generated image is 1024x1024 pixels.", + "name": "Size1024x1024" + } + ] + } + }, + "imageStyle": { + "description": "The style of the generated images.", + "type": "string", + "enum": [ + "vivid", + "natural" + ], + "default": "vivid", + "x-ms-enum": { + "name": "Style", + "modelAsString": true, + "values": [ + { + "value": "vivid", + "description": "Vivid creates images that are hyper-realistic and dramatic.", + "name": "Vivid" + }, + { + "value": "natural", + "description": "Natural creates images that are more natural and less hyper-realistic.", + "name": "Natural" + } + ] + } + }, + "imageGenerationsRequest": { + "type": "object", + "properties": { + "prompt": { + "description": "A text description of the desired image(s). The maximum length is 4000 characters.", + "type": "string", + "format": "string", + "example": "a corgi in a field", + "minLength": 1 + }, + "n": { + "description": "The number of images to generate.", + "type": "integer", + "minimum": 1, + "maximum": 1, + "default": 1 + }, + "size": { + "$ref": "#/components/schemas/imageSize" + }, + "response_format": { + "$ref": "#/components/schemas/imagesResponseFormat" + }, + "user": { + "description": "A unique identifier representing your end-user, which can help to monitor and detect abuse.", + "type": "string", + "format": "string", + "example": "user123456" + }, + "quality": { + "$ref": "#/components/schemas/imageQuality" + }, + "style": { + "$ref": "#/components/schemas/imageStyle" + } + }, + "required": [ + "prompt" + ] + }, + "generateImagesResponse": { + "type": "object", + "properties": { + "created": { + "type": "integer", + "format": "unixtime", + "description": "The unix timestamp when the operation was created.", + "example": "1676540381" + }, + "data": { + "type": "array", + "description": "The result data of the operation, if successful", + "items": { + "$ref": "#/components/schemas/imageResult" + } + } + }, + "required": [ + "created", + "data" + ] + }, + "imageResult": { + "type": "object", + "description": "The image url or encoded image if successful, and an error otherwise.", + "properties": { + "url": { + "type": "string", + "description": "The image url.", + "example": "https://www.contoso.com" + }, + "b64_json": { + "type": "string", + "description": "The base64 encoded image" + }, + "content_filter_results": { + "$ref": "#/components/schemas/dalleContentFilterResults" + }, + "revised_prompt": { + "type": "string", + "description": "The prompt that was used to generate the image, if there was any revision to the prompt." + }, + "prompt_filter_results": { + "$ref": "#/components/schemas/dalleFilterResults" + } + } + }, + "line": { + "type": "object", + "description": "A content line object consisting of an adjacent sequence of content elements, such as words and selection marks.", + "properties": { + "text": { + "type": "string" + }, + "spans": { + "type": "array", + "description": "An array of spans that represent detected objects and its bounding box information.", + "items": { + "$ref": "#/components/schemas/span" + } + } + }, + "required": [ + "text", + "spans" + ] + }, + "span": { + "type": "object", + "description": "A span object that represents a detected object and its bounding box information.", + "properties": { + "text": { + "type": "string", + "description": "The text content of the span that represents the detected object." + }, + "offset": { + "type": "integer", + "description": "The character offset within the text where the span begins. This offset is defined as the position of the first character of the span, counting from the start of the text as Unicode codepoints." + }, + "length": { + "type": "integer", + "description": "The length of the span in characters, measured in Unicode codepoints." + }, + "polygon": { + "type": "array", + "description": "An array of objects representing points in the polygon that encloses the detected object.", + "items": { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "The x-coordinate of the point." + }, + "y": { + "type": "number", + "description": "The y-coordinate of the point." + } + } + } + } + }, + "required": [ + "text", + "offset", + "length", + "polygon" + ] + }, + "runCompletionUsage": { + "type": "object", + "description": "Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.).", + "properties": { + "completion_tokens": { + "type": "integer", + "description": "Number of completion tokens used over the course of the run." + }, + "prompt_tokens": { + "type": "integer", + "description": "Number of prompt tokens used over the course of the run." + }, + "total_tokens": { + "type": "integer", + "description": "Total number of tokens used (prompt + completion)." + } + }, + "required": [ + "prompt_tokens", + "completion_tokens", + "total_tokens" + ], + "nullable": true + }, + "runStepCompletionUsage": { + "type": "object", + "description": "Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`.", + "properties": { + "completion_tokens": { + "type": "integer", + "description": "Number of completion tokens used over the course of the run step." + }, + "prompt_tokens": { + "type": "integer", + "description": "Number of prompt tokens used over the course of the run step." + }, + "total_tokens": { + "type": "integer", + "description": "Total number of tokens used (prompt + completion)." + } + }, + "required": [ + "prompt_tokens", + "completion_tokens", + "total_tokens" + ], + "nullable": true + }, + "assistantsApiResponseFormatOption": { + "description": "Specifies the format that the model must output. Compatible with GPT-4 Turbo and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which guarantees the message the model generates is valid JSON.\n\n**Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.\n", + "oneOf": [ + { + "type": "string", + "description": "`auto` is the default value\n", + "enum": [ + "none", + "auto" + ], + "x-ms-enum": { + "name": "AssistantsApiResponseFormatOption", + "modelAsString": true, + "values": [ + { + "value": "none" + }, + { + "value": "auto" + } + ] + } + }, + { + "$ref": "#/components/schemas/assistantsApiResponseFormat" + } + ] + }, + "assistantsApiResponseFormat": { + "type": "object", + "description": "An object describing the expected output of the model. If `json_object` only `function` type `tools` are allowed to be passed to the Run. If `text` the model can return text or any value needed.\n", + "properties": { + "type": { + "type": "string", + "enum": [ + "text", + "json_object" + ], + "x-ms-enum": { + "name": "AssistantsApiResponseFormat", + "modelAsString": true, + "values": [ + { + "value": "text" + }, + { + "value": "json_object" + } + ] + }, + "example": "json_object", + "default": "text", + "description": "Must be one of `text` or `json_object`." + } + } + }, + "assistantObject": { + "type": "object", + "title": "Assistant", + "description": "Represents an `assistant` that can call the model and use tools.", + "properties": { + "id": { + "description": "The identifier, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `assistant`.", + "type": "string", + "enum": [ + "assistant" + ], + "x-ms-enum": { + "name": "AssistantObjectType", + "modelAsString": true, + "values": [ + { + "value": "assistant", + "description": "The object type, which is always assistant" + } + ] + } + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the assistant was created.", + "type": "integer" + }, + "name": { + "description": "The name of the assistant. The maximum length is 256 characters.\n", + "type": "string", + "maxLength": 256, + "nullable": true + }, + "description": { + "description": "The description of the assistant. The maximum length is 512 characters.\n", + "type": "string", + "maxLength": 512, + "nullable": true + }, + "model": { + "description": "ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them.\n", + "type": "string" + }, + "instructions": { + "description": "The system instructions that the assistant uses. The maximum length is 256,000 characters.\n", + "type": "string", + "maxLength": 256000, + "nullable": true + }, + "tools": { + "description": "A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `file_search`, or `function`.\n", + "default": [], + "type": "array", + "maxItems": 128, + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsFileSearch" + }, + { + "$ref": "#/components/schemas/assistantToolsFunction" + } + ] + } + }, + "tool_resources": { + "type": "object", + "description": "A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n", + "properties": { + "code_interpreter": { + "type": "object", + "properties": { + "file_ids": { + "type": "array", + "description": "A list of file IDs made available to the `code_interpreter`` tool. There can be a maximum of 20 files associated with the tool.\n", + "default": [], + "maxItems": 20, + "items": { + "type": "string" + } + } + } + }, + "file_search": { + "type": "object", + "properties": { + "vector_store_ids": { + "type": "array", + "description": "The ID of the vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant.\n", + "maxItems": 1, + "items": { + "type": "string" + } + } + } + } + } + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + }, + "temperature": { + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n", + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true + }, + "top_p": { + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or temperature but not both.\n" + }, + "response_format": { + "$ref": "#/components/schemas/assistantsApiResponseFormatOption", + "nullable": true + } + }, + "required": [ + "id", + "object", + "created_at", + "name", + "description", + "model", + "instructions", + "tools", + "metadata" + ] + }, + "createAssistantRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "model": { + "description": "ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them.\n", + "anyOf": [ + { + "type": "string" + } + ] + }, + "name": { + "description": "The name of the assistant. The maximum length is 256 characters.\n", + "type": "string", + "nullable": true, + "maxLength": 256 + }, + "description": { + "description": "The description of the assistant. The maximum length is 512 characters.\n", + "type": "string", + "nullable": true, + "maxLength": 512 + }, + "instructions": { + "description": "The system instructions that the assistant uses. The maximum length is 256,000 characters.\n", + "type": "string", + "nullable": true, + "maxLength": 256000 + }, + "tools": { + "description": "A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `retrieval`, or `function`.\n", + "default": [], + "type": "array", + "maxItems": 128, + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsFileSearch" + }, + { + "$ref": "#/components/schemas/assistantToolsFunction" + } + ] + } + }, + "tool_resources": { + "type": "object", + "description": "A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n", + "properties": { + "code_interpreter": { + "type": "object", + "properties": { + "file_ids": { + "type": "array", + "description": "A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.\n", + "default": [], + "maxItems": 20, + "items": { + "type": "string" + } + } + } + }, + "file_search": { + "type": "object", + "properties": { + "vector_store_ids": { + "type": "array", + "description": "The vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant.\n", + "maxItems": 1, + "items": { + "type": "string" + } + }, + "vector_stores": { + "type": "array", + "description": "A helper to create a vector store with file_ids and attach it to this assistant. There can be a maximum of 1 vector store attached to the assistant.\n", + "maxItems": 1, + "items": { + "type": "object", + "properties": { + "file_ids": { + "type": "array", + "description": "A list of file IDs to add to the vector store. There can be a maximum of 10000 files in a vector store.\n", + "maxItems": 10000, + "items": { + "type": "string" + } + }, + "chunking_strategy": { + "type": "object", + "description": "The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy.", + "oneOf": [ + { + "type": "object", + "title": "Auto Chunking Strategy", + "description": "The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`.", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "description": "Always `auto`.", + "enum": [ + "auto" + ], + "x-ms-enum": { + "name": "AutoChunkingStrategyType", + "modelAsString": true, + "values": [ + { + "value": "auto" + } + ] + } + } + }, + "required": [ + "type" + ] + }, + { + "type": "object", + "title": "Static Chunking Strategy", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "description": "Always `static`.", + "enum": [ + "static" + ], + "x-ms-enum": { + "name": "StaticChunkingStrategyType", + "modelAsString": true, + "values": [ + { + "value": "static" + } + ] + } + }, + "static": { + "type": "object", + "additionalProperties": false, + "properties": { + "max_chunk_size_tokens": { + "type": "integer", + "minimum": 100, + "maximum": 4096, + "description": "The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`." + }, + "chunk_overlap_tokens": { + "type": "integer", + "description": "The number of tokens that overlap between chunks. The default value is `400`.\n\nNote that the overlap must not exceed half of `max_chunk_size_tokens`.\n" + } + }, + "required": [ + "max_chunk_size_tokens", + "chunk_overlap_tokens" + ] + } + }, + "required": [ + "type", + "static" + ] + } + ] + }, + "metadata": { + "type": "object", + "description": "Set of 16 key-value pairs that can be attached to a vector store. This can be useful for storing additional information about the vector store in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "x-oaiTypeLabel": "map" + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "vector_store_ids" + ] + }, + { + "required": [ + "vector_stores" + ] + } + ] + } + }, + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + }, + "temperature": { + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n", + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true + }, + "top_p": { + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or temperature but not both.\n" + }, + "response_format": { + "$ref": "#/components/schemas/assistantsApiResponseFormatOption", + "nullable": true + } + }, + "required": [ + "model" + ] + }, + "modifyAssistantRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "model": { + "description": "ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them.\n", + "anyOf": [ + { + "type": "string" + } + ] + }, + "name": { + "description": "The name of the assistant. The maximum length is 256 characters.\n", + "type": "string", + "nullable": true, + "maxLength": 256 + }, + "description": { + "description": "The description of the assistant. The maximum length is 512 characters.\n", + "type": "string", + "nullable": true, + "maxLength": 512 + }, + "instructions": { + "description": "The system instructions that the assistant uses. The maximum length is 32768 characters.\n", + "type": "string", + "nullable": true, + "maxLength": 32768 + }, + "tools": { + "description": "A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `retrieval`, or `function`.\n", + "default": [], + "type": "array", + "maxItems": 128, + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsFileSearch" + }, + { + "$ref": "#/components/schemas/assistantToolsFunction" + } + ] + } + }, + "tool_resources": { + "type": "object", + "description": "A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n", + "properties": { + "code_interpreter": { + "type": "object", + "properties": { + "file_ids": { + "type": "array", + "description": "Overrides the list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.\n", + "default": [], + "maxItems": 20, + "items": { + "type": "string" + } + } + } + }, + "file_search": { + "type": "object", + "properties": { + "vector_store_ids": { + "type": "array", + "description": "Overrides the vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant.\n", + "maxItems": 1, + "items": { + "type": "string" + } + } + } + } + } + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + }, + "temperature": { + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n", + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true + }, + "top_p": { + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or temperature but not both.\n" + }, + "response_format": { + "$ref": "#/components/schemas/assistantsApiResponseFormatOption", + "nullable": true + } + } + }, + "deleteAssistantResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "object": { + "type": "string", + "enum": [ + "assistant.deleted" + ], + "x-ms-enum": { + "name": "DeleteAssistantResponseState", + "modelAsString": true, + "values": [ + { + "value": "assistant.deleted" + } + ] + } + } + }, + "required": [ + "id", + "object", + "deleted" + ] + }, + "listAssistantsResponse": { + "type": "object", + "properties": { + "object": { + "type": "string", + "example": "list" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/assistantObject" + } + }, + "first_id": { + "type": "string" + }, + "last_id": { + "type": "string" + }, + "has_more": { + "type": "boolean", + "example": false + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + }, + "assistantToolsCode": { + "type": "object", + "title": "Code interpreter tool", + "properties": { + "type": { + "type": "string", + "description": "The type of tool being defined: `code_interpreter`", + "enum": [ + "code_interpreter" + ], + "x-ms-enum": { + "name": "assistantToolsCodeType", + "modelAsString": true, + "values": [ + { + "value": "code_interpreter" + } + ] + } + } + }, + "required": [ + "type" + ] + }, + "assistantToolsFileSearch": { + "type": "object", + "title": "FileSearch tool", + "properties": { + "type": { + "type": "string", + "description": "The type of tool being defined: `file_search`", + "enum": [ + "file_search" + ], + "x-ms-enum": { + "name": "assistantToolsFileSearchType", + "modelAsString": true, + "values": [ + { + "value": "file_search" + } + ] + } + }, + "file_search": { + "type": "object", + "description": "Overrides for the file search tool.", + "properties": { + "max_num_results": { + "type": "integer", + "minimum": 1, + "maximum": 50, + "description": "The maximum number of results the file search tool should output. The default is 20 for gpt-4* models and 5 for gpt-3.5-turbo. This number should be between 1 and 50 inclusive.\n\nNote that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](/docs/assistants/tools/file-search/number-of-chunks-returned) for more information.\n" + } + } + } + }, + "required": [ + "type" + ] + }, + "assistantToolsFileSearchTypeOnly": { + "type": "object", + "title": "FileSearch tool", + "properties": { + "type": { + "type": "string", + "description": "The type of tool being defined: `file_search`", + "enum": [ + "file_search" + ], + "x-ms-enum": { + "name": "assistantToolsFileSearchType", + "modelAsString": true, + "values": [ + { + "value": "file_search" + } + ] + } + } + }, + "required": [ + "type" + ] + }, + "assistantToolsFunction": { + "type": "object", + "title": "Function tool", + "properties": { + "type": { + "type": "string", + "description": "The type of tool being defined: `function`", + "enum": [ + "function" + ], + "x-ms-enum": { + "name": "assistantToolsFunction", + "modelAsString": true, + "values": [ + { + "value": "function" + } + ] + } + }, + "function": { + "type": "object", + "description": "The function definition.", + "properties": { + "description": { + "type": "string", + "description": "A description of what the function does, used by the model to choose when and how to call the function." + }, + "name": { + "type": "string", + "description": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + }, + "parameters": { + "$ref": "#/components/schemas/chatCompletionFunctionParameters" + } + }, + "required": [ + "name", + "parameters", + "description" + ] + } + }, + "required": [ + "type", + "function" + ] + }, + "truncationObject": { + "type": "object", + "title": "Thread Truncation Controls", + "description": "Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.", + "properties": { + "type": { + "type": "string", + "description": "The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`.", + "enum": [ + "auto", + "last_messages" + ], + "x-ms-enum": { + "name": "TruncationType", + "modelAsString": true, + "values": [ + { + "value": "auto" + }, + { + "value": "last_messages" + } + ] + } + }, + "last_messages": { + "type": "integer", + "description": "The number of most recent messages from the thread when constructing the context for the run.", + "minimum": 1, + "nullable": true + } + }, + "required": [ + "type" + ] + }, + "assistantsApiToolChoiceOption": { + "description": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling a tool.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", + "oneOf": [ + { + "type": "string", + "description": "`none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function.\n", + "enum": [ + "none", + "auto" + ], + "x-ms-enum": { + "name": "AssistantsApiToolChoiceOption", + "modelAsString": true, + "values": [ + { + "value": "none" + }, + { + "value": "auto" + } + ] + } + }, + { + "$ref": "#/components/schemas/assistantsNamedToolChoice" + } + ] + }, + "assistantsNamedToolChoice": { + "type": "object", + "description": "Specifies a tool the model should use. Use to force the model to call a specific tool.", + "properties": { + "type": { + "type": "string", + "enum": [ + "function", + "code_interpreter", + "file_search" + ], + "description": "The type of the tool. If type is `function`, the function name must be set", + "x-ms-enum": { + "name": "AssistantsNamedToolChoiceType", + "modelAsString": true, + "values": [ + { + "value": "function" + }, + { + "value": "code_interpreter" + }, + { + "value": "file_search" + } + ] + } + }, + "function": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "type" + ] + }, + "runObject": { + "type": "object", + "title": "A run on a thread", + "description": "Represents an execution run on a [thread](/docs/api-reference/threads).", + "properties": { + "id": { + "description": "The identifier, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `thread.run`.", + "type": "string", + "enum": [ + "thread.run" + ], + "x-ms-enum": { + "name": "runObjectType", + "modelAsString": true, + "values": [ + { + "value": "thread.run", + "description": "The run object type which is always thread.run" + } + ] + } + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the run was created.", + "type": "integer" + }, + "thread_id": { + "description": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", + "type": "string" + }, + "assistant_id": { + "description": "The ID of the assistant used for execution of this run.", + "type": "string" + }, + "status": { + "description": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, or `expired`.", + "type": "string", + "enum": [ + "queued", + "in_progress", + "requires_action", + "cancelling", + "cancelled", + "failed", + "completed", + "expired" + ], + "x-ms-enum": { + "name": "RunObjectStatus", + "modelAsString": true, + "values": [ + { + "value": "queued", + "description": "The queued state" + }, + { + "value": "in_progress", + "description": "The in_progress state" + }, + { + "value": "requires_action", + "description": "The required_action state" + }, + { + "value": "cancelling", + "description": "The cancelling state" + }, + { + "value": "cancelled", + "description": "The cancelled state" + }, + { + "value": "failed", + "description": "The failed state" + }, + { + "value": "completed", + "description": "The completed state" + }, + { + "value": "expired", + "description": "The expired state" + } + ] + } + }, + "required_action": { + "type": "object", + "description": "Details on the action required to continue the run. Will be `null` if no action is required.", + "nullable": true, + "properties": { + "type": { + "description": "For now, this is always `submit_tool_outputs`.", + "type": "string", + "enum": [ + "submit_tool_outputs" + ] + }, + "submit_tool_outputs": { + "type": "object", + "description": "Details on the tool outputs needed for this run to continue.", + "properties": { + "tool_calls": { + "type": "array", + "description": "A list of the relevant tool calls.", + "items": { + "$ref": "#/components/schemas/runToolCallObject" + } + } + }, + "required": [ + "tool_calls" + ] + } + }, + "required": [ + "type", + "submit_tool_outputs" + ] + }, + "last_error": { + "type": "object", + "description": "The last error associated with this run. Will be `null` if there are no errors.", + "nullable": true, + "properties": { + "code": { + "type": "string", + "description": "One of `server_error` or `rate_limit_exceeded`.", + "enum": [ + "server_error", + "rate_limit_exceeded" + ], + "x-ms-enum": { + "name": "LastErrorCode", + "modelAsString": true, + "values": [ + { + "value": "server_error", + "description": "The server failed to respond to request due to server error" + }, + { + "value": "rate_limit_exceeded", + "description": "The server failed to respond to request due to rate limit exceeded" + } + ] + } + }, + "message": { + "type": "string", + "description": "A human-readable description of the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "expires_at": { + "description": "The Unix timestamp (in seconds) for when the run will expire.", + "type": "integer" + }, + "started_at": { + "description": "The Unix timestamp (in seconds) for when the run was started.", + "type": "integer", + "nullable": true + }, + "cancelled_at": { + "description": "The Unix timestamp (in seconds) for when the run was cancelled.", + "type": "integer", + "nullable": true + }, + "failed_at": { + "description": "The Unix timestamp (in seconds) for when the run failed.", + "type": "integer", + "nullable": true + }, + "completed_at": { + "description": "The Unix timestamp (in seconds) for when the run was completed.", + "type": "integer", + "nullable": true + }, + "incomplete_details": { + "description": "Details on why the run is incomplete. Will be `null` if the run is not incomplete.", + "type": "object", + "nullable": true, + "properties": { + "reason": { + "description": "The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.", + "type": "string", + "enum": [ + "max_completion_tokens", + "max_prompt_tokens" + ], + "x-ms-enum": { + "name": "IncompleteDetailsReason", + "modelAsString": true, + "values": [ + { + "value": "max_completion_tokens" + }, + { + "value": "max_prompt_tokens" + } + ] + } + } + } + }, + "model": { + "description": "The model that the assistant used for this run.", + "type": "string" + }, + "instructions": { + "description": "The instructions that the assistant used for this run.", + "type": "string" + }, + "tools": { + "description": "The list of tools that the assistant used for this run.", + "default": [], + "type": "array", + "maxItems": 20, + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsFileSearch" + }, + { + "$ref": "#/components/schemas/assistantToolsFunction" + } + ] + } + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + }, + "usage": { + "$ref": "#/components/schemas/runCompletionUsage" + }, + "temperature": { + "description": "The sampling temperature used for this run. If not set, defaults to 1.", + "type": "number", + "nullable": true + }, + "top_p": { + "description": "The nucleus sampling value used for this run. If not set, defaults to 1.", + "type": "number", + "nullable": true + }, + "max_prompt_tokens": { + "type": "integer", + "nullable": true, + "description": "The maximum number of prompt tokens specified to have been used over the course of the run.\n", + "minimum": 256 + }, + "max_completion_tokens": { + "type": "integer", + "nullable": true, + "description": "The maximum number of completion tokens specified to have been used over the course of the run.\n", + "minimum": 256 + }, + "truncation_strategy": { + "$ref": "#/components/schemas/truncationObject", + "nullable": true + }, + "tool_choice": { + "$ref": "#/components/schemas/assistantsApiToolChoiceOption", + "nullable": true + }, + "parallel_tool_calls": { + "$ref": "#/components/schemas/ParallelToolCalls", + "nullable": true + }, + "response_format": { + "$ref": "#/components/schemas/assistantsApiResponseFormatOption", + "nullable": true + } + }, + "required": [ + "id", + "object", + "created_at", + "thread_id", + "assistant_id", + "status", + "required_action", + "last_error", + "expires_at", + "started_at", + "cancelled_at", + "failed_at", + "completed_at", + "model", + "instructions", + "tools", + "metadata", + "usage", + "incomplete_details", + "max_prompt_tokens", + "max_completion_tokens", + "truncation_strategy", + "tool_choice", + "response_format" + ] + }, + "createRunRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "assistant_id": { + "description": "The ID of the assistant to use to execute this run.", + "type": "string" + }, + "model": { + "description": "The ID of the Model to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.", + "type": "string", + "nullable": true + }, + "instructions": { + "description": "Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis.", + "type": "string", + "nullable": true + }, + "additional_instructions": { + "description": "Appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions.", + "type": "string", + "nullable": true + }, + "additional_messages": { + "description": "Adds additional messages to the thread before creating the run.", + "type": "array", + "items": { + "$ref": "#/components/schemas/createMessageRequest" + }, + "nullable": true + }, + "tools": { + "description": "Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.", + "nullable": true, + "type": "array", + "maxItems": 20, + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsFileSearch" + }, + { + "$ref": "#/components/schemas/assistantToolsFunction" + } + ] + } + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + }, + "temperature": { + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true, + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n" + }, + "top_p": { + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or temperature but not both.\n" + }, + "stream": { + "type": "boolean", + "nullable": true, + "description": "If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.\n" + }, + "stream_options": { + "$ref": "#/components/schemas/chatCompletionStreamOptions", + "nullable": true + }, + "max_prompt_tokens": { + "type": "integer", + "nullable": true, + "description": "The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.\n", + "minimum": 256 + }, + "max_completion_tokens": { + "type": "integer", + "nullable": true, + "description": "The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.\n", + "minimum": 256 + }, + "truncation_strategy": { + "$ref": "#/components/schemas/truncationObject", + "nullable": true + }, + "tool_choice": { + "$ref": "#/components/schemas/assistantsApiToolChoiceOption", + "nullable": true + }, + "response_format": { + "$ref": "#/components/schemas/assistantsApiResponseFormatOption", + "nullable": true + } + }, + "required": [ + "thread_id", + "assistant_id" + ] + }, + "listRunsResponse": { + "type": "object", + "properties": { + "object": { + "type": "string", + "example": "list" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/runObject" + } + }, + "first_id": { + "type": "string" + }, + "last_id": { + "type": "string" + }, + "has_more": { + "type": "boolean", + "example": false + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + }, + "modifyRunRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + } + }, + "submitToolOutputsRunRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "tool_outputs": { + "description": "A list of tools for which the outputs are being submitted.", + "type": "array", + "items": { + "type": "object", + "properties": { + "tool_call_id": { + "type": "string", + "description": "The ID of the tool call in the `required_action` object within the run object the output is being submitted for." + }, + "output": { + "type": "string", + "description": "The output of the tool call to be submitted to continue the run." + } + } + } + }, + "stream": { + "type": "boolean", + "nullable": true, + "description": "If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.\n" + } + }, + "required": [ + "tool_outputs" + ] + }, + "runToolCallObject": { + "type": "object", + "description": "Tool call objects", + "properties": { + "id": { + "type": "string", + "description": "The ID of the tool call. This ID must be referenced when you submit the tool outputs in using the [Submit tool outputs to run](/docs/api-reference/runs/submitToolOutputs) endpoint." + }, + "type": { + "type": "string", + "description": "The type of tool call the output is required for. For now, this is always `function`.", + "enum": [ + "function" + ], + "x-ms-enum": { + "name": "RunToolCallObjectType", + "modelAsString": true, + "values": [ + { + "value": "function" + } + ] + } + }, + "function": { + "type": "object", + "description": "The function definition.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function." + }, + "arguments": { + "type": "string", + "description": "The arguments that the model expects you to pass to the function." + } + }, + "required": [ + "name", + "arguments" + ] + } + }, + "required": [ + "id", + "type", + "function" + ] + }, + "createThreadAndRunRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "assistant_id": { + "description": "The ID of the assistant to use to execute this run.", + "type": "string" + }, + "thread": { + "$ref": "#/components/schemas/createThreadRequest", + "description": "If no thread is provided, an empty thread will be created." + }, + "model": { + "description": "The ID of the [Model](/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.", + "type": "string", + "nullable": true + }, + "instructions": { + "description": "Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis.", + "type": "string", + "nullable": true + }, + "tools": { + "description": "Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.", + "nullable": true, + "type": "array", + "maxItems": 20, + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsFileSearch" + }, + { + "$ref": "#/components/schemas/assistantToolsFunction" + } + ] + } + }, + "tool_resources": { + "type": "object", + "description": "A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n", + "properties": { + "code_interpreter": { + "type": "object", + "properties": { + "file_ids": { + "type": "array", + "description": "A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.\n", + "default": [], + "maxItems": 20, + "items": { + "type": "string" + } + } + } + }, + "file_search": { + "type": "object", + "properties": { + "vector_store_ids": { + "type": "array", + "description": "The ID of the vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant.\n", + "maxItems": 1, + "items": { + "type": "string" + } + } + } + } + }, + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + }, + "temperature": { + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true, + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n" + }, + "top_p": { + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or temperature but not both.\n" + }, + "stream": { + "type": "boolean", + "nullable": true, + "description": "If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.\n" + }, + "stream_options": { + "$ref": "#/components/schemas/chatCompletionStreamOptions", + "nullable": true + }, + "max_prompt_tokens": { + "type": "integer", + "nullable": true, + "description": "The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.\n", + "minimum": 256 + }, + "max_completion_tokens": { + "type": "integer", + "nullable": true, + "description": "The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.\n", + "minimum": 256 + }, + "truncation_strategy": { + "$ref": "#/components/schemas/truncationObject", + "nullable": true + }, + "tool_choice": { + "$ref": "#/components/schemas/assistantsApiToolChoiceOption", + "nullable": true + }, + "response_format": { + "$ref": "#/components/schemas/assistantsApiResponseFormatOption", + "nullable": true + } + }, + "required": [ + "thread_id", + "assistant_id" + ] + }, + "threadObject": { + "type": "object", + "title": "Thread", + "description": "Represents a thread that contains [messages](/docs/api-reference/messages).", + "properties": { + "id": { + "description": "The identifier, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `thread`.", + "type": "string", + "enum": [ + "thread" + ], + "x-ms-enum": { + "name": "ThreadObjectType", + "modelAsString": true, + "values": [ + { + "value": "thread", + "description": "The type of thread object which is always `thread`" + } + ] + } + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the thread was created.", + "type": "integer" + }, + "tool_resources": { + "type": "object", + "description": "A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n", + "properties": { + "code_interpreter": { + "type": "object", + "properties": { + "file_ids": { + "type": "array", + "description": "A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.\n", + "default": [], + "maxItems": 20, + "items": { + "type": "string" + } + } + } + }, + "file_search": { + "type": "object", + "properties": { + "vector_store_ids": { + "type": "array", + "description": "The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread.\n", + "maxItems": 1, + "items": { + "type": "string" + } + } + } + } + }, + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + }, + "required": [ + "id", + "object", + "created_at", + "tool_resources", + "metadata" + ] + }, + "createThreadRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "messages": { + "description": "A list of [messages](/docs/api-reference/messages) to start the thread with.", + "type": "array", + "items": { + "$ref": "#/components/schemas/createMessageRequest" + } + }, + "tool_resources": { + "type": "object", + "description": "A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n", + "properties": { + "code_interpreter": { + "type": "object", + "properties": { + "file_ids": { + "type": "array", + "description": "A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.\n", + "default": [], + "maxItems": 20, + "items": { + "type": "string" + } + } + } + }, + "file_search": { + "type": "object", + "properties": { + "vector_store_ids": { + "type": "array", + "description": "The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread.\n", + "maxItems": 1, + "items": { + "type": "string" + } + }, + "vector_stores": { + "type": "array", + "description": "A helper to create a vector store with file_ids and attach it to this thread. There can be a maximum of 1 vector store attached to the thread.\n", + "maxItems": 1, + "items": { + "type": "object", + "properties": { + "file_ids": { + "type": "array", + "description": "A list of file IDs to add to the vector store. There can be a maximum of 10000 files in a vector store.\n", + "maxItems": 10000, + "items": { + "type": "string" + } + }, + "chunking_strategy": { + "type": "object", + "description": "The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy.", + "oneOf": [ + { + "type": "object", + "title": "Auto Chunking Strategy", + "description": "The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`.", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "description": "Always `auto`.", + "enum": [ + "auto" + ], + "x-ms-enum": { + "name": "AutoChunkingStrategyType", + "modelAsString": true, + "values": [ + { + "value": "auto" + } + ] + } + } + }, + "required": [ + "type" + ] + }, + { + "type": "object", + "title": "Static Chunking Strategy", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "description": "Always `static`.", + "enum": [ + "static" + ], + "x-ms-enum": { + "name": "StaticChunkingStrategyType", + "modelAsString": true, + "values": [ + { + "value": "static" + } + ] + } + }, + "static": { + "type": "object", + "additionalProperties": false, + "properties": { + "max_chunk_size_tokens": { + "type": "integer", + "minimum": 100, + "maximum": 4096, + "description": "The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`." + }, + "chunk_overlap_tokens": { + "type": "integer", + "description": "The number of tokens that overlap between chunks. The default value is `400`.\n\nNote that the overlap must not exceed half of `max_chunk_size_tokens`.\n" + } + }, + "required": [ + "max_chunk_size_tokens", + "chunk_overlap_tokens" + ] + } + }, + "required": [ + "type", + "static" + ] + } + ] + }, + "metadata": { + "type": "object", + "description": "Set of 16 key-value pairs that can be attached to a vector store. This can be useful for storing additional information about the vector store in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n" + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "vector_store_ids" + ] + }, + { + "required": [ + "vector_stores" + ] + } + ] + } + }, + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + } + }, + "modifyThreadRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "tool_resources": { + "type": "object", + "description": "A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n", + "properties": { + "code_interpreter": { + "type": "object", + "properties": { + "file_ids": { + "type": "array", + "description": "A list of File IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.\n", + "default": [], + "maxItems": 20, + "items": { + "type": "string" + } + } + } + }, + "file_search": { + "type": "object", + "properties": { + "vector_store_ids": { + "type": "array", + "description": "The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread.\n", + "maxItems": 1, + "items": { + "type": "string" + } + } + } + } + }, + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + } + }, + "deleteThreadResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "object": { + "type": "string", + "enum": [ + "thread.deleted" + ], + "x-ms-enum": { + "name": "DeleteThreadResponseObjectState", + "modelAsString": true, + "values": [ + { + "value": "thread.deleted", + "description": "The delete thread response object state which is `thread.deleted`" + } + ] + } + } + }, + "required": [ + "id", + "object", + "deleted" + ] + }, + "listThreadsResponse": { + "properties": { + "object": { + "type": "string", + "example": "list" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/threadObject" + } + }, + "first_id": { + "type": "string" + }, + "last_id": { + "type": "string" + }, + "has_more": { + "type": "boolean", + "example": false + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + }, + "messageObject": { + "type": "object", + "title": "The message object", + "description": "Represents a message within a [thread](/docs/api-reference/threads).", + "properties": { + "id": { + "description": "The identifier, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `thread.message`.", + "type": "string", + "enum": [ + "thread.message" + ], + "x-ms-enum": { + "name": "MessageObjectType", + "modelAsString": true, + "values": [ + { + "value": "thread.message", + "description": "The message object type which is `thread.message`" + } + ] + } + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the message was created.", + "type": "integer" + }, + "thread_id": { + "description": "The [thread](/docs/api-reference/threads) ID that this message belongs to.", + "type": "string" + }, + "status": { + "description": "The status of the message, which can be either `in_progress`, `incomplete`, or `completed`.", + "type": "string", + "enum": [ + "in_progress", + "incomplete", + "completed" + ], + "x-ms-enum": { + "name": "MessageObjectStatus", + "modelAsString": true, + "values": [ + { + "value": "in_progress" + }, + { + "value": "incomplete" + }, + { + "value": "completed" + } + ] + } + }, + "incomplete_details": { + "description": "On an incomplete message, details about why the message is incomplete.", + "type": "object", + "properties": { + "reason": { + "type": "string", + "description": "The reason the message is incomplete.", + "enum": [ + "content_filter", + "max_tokens", + "run_cancelled", + "run_expired", + "run_failed" + ], + "x-ms-enum": { + "name": "MessageObjectIncompleteReason", + "modelAsString": true, + "values": [ + { + "value": "content_filter" + }, + { + "value": "max_tokens" + }, + { + "value": "run_cancelled" + }, + { + "value": "run_expired" + }, + { + "value": "run_failed" + } + ] + } + } + }, + "nullable": true, + "required": [ + "reason" + ] + }, + "completed_at": { + "description": "The Unix timestamp (in seconds) for when the message was completed.", + "type": "integer", + "nullable": true + }, + "incomplete_at": { + "description": "The Unix timestamp (in seconds) for when the message was marked as incomplete.", + "type": "integer", + "nullable": true + }, + "role": { + "description": "The entity that produced the message. One of `user` or `assistant`.", + "type": "string", + "enum": [ + "user", + "assistant" + ], + "x-ms-enum": { + "name": "MessageObjectRole", + "modelAsString": true, + "values": [ + { + "value": "user" + }, + { + "value": "assistant" + } + ] + } + }, + "content": { + "description": "The content of the message in array of text and/or images.", + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/messageContentImageFileObject" + }, + { + "$ref": "#/components/schemas/messageContentTextObject" + } + ] + } + }, + "assistant_id": { + "description": "If applicable, the ID of the assistant that authored this message.", + "type": "string", + "nullable": true + }, + "run_id": { + "description": "If applicable, the ID of the [run](/docs/api-reference/runs) associated with the authoring of this message.", + "type": "string", + "nullable": true + }, + "attachments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "file_id": { + "type": "string", + "description": "The ID of the file to attach to the message." + }, + "tools": { + "description": "The tools to add this file to.", + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsFileSearchTypeOnly" + } + ] + } + } + } + }, + "description": "A list of files attached to the message, and the tools they were added to.", + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + }, + "required": [ + "id", + "object", + "created_at", + "thread_id", + "status", + "incomplete_details", + "completed_at", + "incomplete_at", + "role", + "content", + "assistant_id", + "run_id", + "attachments", + "metadata" + ] + }, + "messageDeltaObject": { + "type": "object", + "title": "Message delta object", + "description": "Represents a message delta i.e. any changed fields on a message during streaming.\n", + "properties": { + "id": { + "description": "The identifier of the message, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `thread.message.delta`.", + "type": "string", + "enum": [ + "thread.message.delta" + ], + "x-ms-enum": { + "name": "MessageDeltaObjectType", + "modelAsString": true, + "values": [ + { + "value": "thread.message.delta" + } + ] + } + }, + "delta": { + "description": "The delta containing the fields that have changed on the Message.", + "type": "object", + "properties": { + "role": { + "description": "The entity that produced the message. One of `user` or `assistant`.", + "type": "string", + "enum": [ + "user", + "assistant" + ], + "x-ms-enum": { + "name": "MessageDeltaObjectDeltaRole", + "modelAsString": true, + "values": [ + { + "value": "user" + }, + { + "value": "assistant" + } + ] + } + }, + "content": { + "description": "The content of the message in array of text and/or images.", + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/messageDeltaContentImageFileObject" + }, + { + "$ref": "#/components/schemas/messageDeltaContentTextObject" + } + ] + } + } + } + } + }, + "required": [ + "id", + "object", + "delta" + ] + }, + "createMessageRequest": { + "type": "object", + "additionalProperties": false, + "required": [ + "role", + "content" + ], + "properties": { + "role": { + "type": "string", + "enum": [ + "user", + "assistant" + ], + "x-ms-enum": { + "name": "CreateMessageRequestRole", + "modelAsString": true, + "values": [ + { + "value": "user" + }, + { + "value": "assistant" + } + ] + }, + "description": "The role of the entity that is creating the message. Allowed values include:\n- `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages.\n- `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation.\n" + }, + "content": { + "type": "string", + "minLength": 1, + "maxLength": 256000, + "description": "The content of the message." + }, + "attachments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "file_id": { + "type": "string", + "description": "The ID of the file to attach to the message." + }, + "tools": { + "description": "The tools to add this file to.", + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsFileSearchTypeOnly" + } + ] + } + } + } + }, + "description": "A list of files attached to the message, and the tools they should be added to.", + "required": [ + "file_id", + "tools" + ], + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + } + }, + "modifyMessageRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + } + }, + "deleteMessageResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "object": { + "type": "string", + "enum": [ + "thread.message.deleted" + ], + "x-ms-enum": { + "name": "DeleteMessageResponseObject", + "modelAsString": true, + "values": [ + { + "value": "thread.message.deleted", + "description": "The delete message response object state" + } + ] + } + } + }, + "required": [ + "id", + "object", + "deleted" + ] + }, + "listMessagesResponse": { + "properties": { + "object": { + "type": "string", + "example": "list" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/messageObject" + } + }, + "first_id": { + "type": "string" + }, + "last_id": { + "type": "string" + }, + "has_more": { + "type": "boolean", + "example": false + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + }, + "messageContentImageFileObject": { + "title": "Image file", + "type": "object", + "description": "References an image File in the content of a message.", + "properties": { + "type": { + "description": "Always `image_file`.", + "type": "string", + "enum": [ + "image_file" + ], + "x-ms-enum": { + "name": "MessageContentImageFileObjectType", + "modelAsString": true, + "values": [ + { + "value": "image_file", + "description": "The message content image file type" + } + ] + } + }, + "image_file": { + "type": "object", + "properties": { + "file_id": { + "description": "The File ID of the image in the message content.", + "type": "string" + } + }, + "required": [ + "file_id" + ] + } + }, + "required": [ + "type", + "image_file" + ] + }, + "messageContentTextObject": { + "title": "Text", + "type": "object", + "description": "The text content that is part of a message.", + "properties": { + "type": { + "description": "Always `text`.", + "type": "string", + "enum": [ + "text" + ], + "x-ms-enum": { + "name": "messageContentTextObjectType", + "modelAsString": true, + "values": [ + { + "value": "text", + "description": "The message content text Object type" + } + ] + } + }, + "text": { + "type": "object", + "properties": { + "value": { + "description": "The data that makes up the text.", + "type": "string" + }, + "annotations": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/messageContentTextAnnotationsFileCitationObject" + }, + { + "$ref": "#/components/schemas/messageContentTextAnnotationsFilePathObject" + } + ] + } + } + }, + "required": [ + "value", + "annotations" + ] + } + }, + "required": [ + "type", + "text" + ] + }, + "messageContentTextAnnotationsFileCitationObject": { + "title": "File citation", + "type": "object", + "description": "A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the \"retrieval\" tool to search files.", + "properties": { + "type": { + "description": "Always `file_citation`.", + "type": "string", + "enum": [ + "file_citation" + ], + "x-ms-enum": { + "name": "FileCitationObjectType", + "modelAsString": true, + "values": [ + { + "value": "file_citation", + "description": "The file citation object type" + } + ] + } + }, + "text": { + "description": "The text in the message content that needs to be replaced.", + "type": "string" + }, + "file_citation": { + "type": "object", + "properties": { + "file_id": { + "description": "The ID of the specific File the citation is from.", + "type": "string" + } + }, + "required": [ + "file_id" + ] + }, + "start_index": { + "type": "integer", + "minimum": 0 + }, + "end_index": { + "type": "integer", + "minimum": 0 + } + }, + "required": [ + "type", + "text", + "file_citation", + "start_index", + "end_index" + ] + }, + "messageContentTextAnnotationsFilePathObject": { + "title": "File path", + "type": "object", + "description": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.", + "properties": { + "type": { + "description": "Always `file_path`.", + "type": "string", + "enum": [ + "file_path" + ], + "x-ms-enum": { + "name": "FilePathObjectType", + "modelAsString": true, + "values": [ + { + "value": "file_path", + "description": "The file path object type" + } + ] + } + }, + "text": { + "description": "The text in the message content that needs to be replaced.", + "type": "string" + }, + "file_path": { + "type": "object", + "properties": { + "file_id": { + "description": "The ID of the file that was generated.", + "type": "string" + } + }, + "required": [ + "file_id" + ] + }, + "start_index": { + "type": "integer", + "minimum": 0 + }, + "end_index": { + "type": "integer", + "minimum": 0 + } + }, + "required": [ + "type", + "text", + "file_path", + "start_index", + "end_index" + ] + }, + "messageDeltaContentImageFileObject": { + "title": "Image file", + "type": "object", + "description": "References an image File in the content of a message.", + "properties": { + "index": { + "type": "integer", + "description": "The index of the content part in the message." + }, + "type": { + "description": "Always `image_file`.", + "type": "string", + "enum": [ + "image_file" + ], + "x-ms-enum": { + "name": "MessageDeltaContentImageFileObjectType", + "modelAsString": true, + "values": [ + { + "value": "image_file" + } + ] + } + }, + "image_file": { + "type": "object", + "properties": { + "file_id": { + "description": "The File ID of the image in the message content.", + "type": "string" + } + } + } + }, + "required": [ + "index", + "type" + ] + }, + "messageDeltaContentTextObject": { + "title": "Text", + "type": "object", + "description": "The text content that is part of a message.", + "properties": { + "index": { + "type": "integer", + "description": "The index of the content part in the message." + }, + "type": { + "description": "Always `text`.", + "type": "string", + "enum": [ + "text" + ], + "x-ms-enum": { + "name": "MessageDeltaContentTextObjectType", + "modelAsString": true, + "values": [ + { + "value": "text" + } + ] + } + }, + "text": { + "type": "object", + "properties": { + "value": { + "description": "The data that makes up the text.", + "type": "string" + }, + "annotations": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/messageDeltaContentTextAnnotationsFileCitationObject" + }, + { + "$ref": "#/components/schemas/messageDeltaContentTextAnnotationsFilePathObject" + } + ] + } + } + } + } + }, + "required": [ + "index", + "type" + ] + }, + "messageDeltaContentTextAnnotationsFileCitationObject": { + "title": "File citation", + "type": "object", + "description": "A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the \"file_search\" tool to search files.", + "properties": { + "index": { + "type": "integer", + "description": "The index of the annotation in the text content part." + }, + "type": { + "description": "Always `file_citation`.", + "type": "string", + "enum": [ + "file_citation" + ], + "x-ms-enum": { + "name": "MessageDeltaContentTextAnnotationsFileCitationObjectType", + "modelAsString": true, + "values": [ + { + "value": "file_citation" + } + ] + } + }, + "text": { + "description": "The text in the message content that needs to be replaced.", + "type": "string" + }, + "file_citation": { + "type": "object", + "properties": { + "file_id": { + "description": "The ID of the specific File the citation is from.", + "type": "string" + }, + "quote": { + "description": "The specific quote in the file.", + "type": "string" + } + } + }, + "start_index": { + "type": "integer", + "minimum": 0 + }, + "end_index": { + "type": "integer", + "minimum": 0 + } + }, + "required": [ + "index", + "type" + ] + }, + "messageDeltaContentTextAnnotationsFilePathObject": { + "title": "File path", + "type": "object", + "description": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.", + "properties": { + "index": { + "type": "integer", + "description": "The index of the annotation in the text content part." + }, + "type": { + "description": "Always `file_path`.", + "type": "string", + "enum": [ + "file_path" + ], + "x-ms-enum": { + "name": "MessageDeltaContentTextAnnotationsFilePathObjectType", + "modelAsString": true, + "values": [ + { + "value": "file_path" + } + ] + } + }, + "text": { + "description": "The text in the message content that needs to be replaced.", + "type": "string" + }, + "file_path": { + "type": "object", + "properties": { + "file_id": { + "description": "The ID of the file that was generated.", + "type": "string" + } + } + }, + "start_index": { + "type": "integer", + "minimum": 0 + }, + "end_index": { + "type": "integer", + "minimum": 0 + } + }, + "required": [ + "index", + "type" + ] + }, + "runStepObject": { + "type": "object", + "title": "Run steps", + "description": "Represents a step in execution of a run.\n", + "properties": { + "id": { + "description": "The identifier of the run step, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `assistant.run.step``.", + "type": "string", + "enum": [ + "assistant.run.step" + ], + "x-ms-enum": { + "name": "RunStepObjectType", + "modelAsString": true, + "values": [ + { + "value": "assistant.run.step", + "description": "The object type, which is always `assistant.run.step`" + } + ] + } + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the run step was created.", + "type": "integer" + }, + "assistant_id": { + "description": "The ID of the [assistant](/docs/api-reference/assistants) associated with the run step.", + "type": "string" + }, + "thread_id": { + "description": "The ID of the [thread](/docs/api-reference/threads) that was run.", + "type": "string" + }, + "run_id": { + "description": "The ID of the [run](/docs/api-reference/runs) that this run step is a part of.", + "type": "string" + }, + "type": { + "description": "The type of run step, which can be either `message_creation` or `tool_calls`.", + "type": "string", + "enum": [ + "message_creation", + "tool_calls" + ], + "x-ms-enum": { + "name": "RunStepObjectType", + "modelAsString": true, + "values": [ + { + "value": "message_creation", + "description": "The message_creation run step" + }, + { + "value": "tool_calls", + "description": "The tool_calls run step" + } + ] + } + }, + "status": { + "description": "The status of the run, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`.", + "type": "string", + "enum": [ + "in_progress", + "cancelled", + "failed", + "completed", + "expired" + ], + "x-ms-enum": { + "name": "RunStepObjectStatus", + "modelAsString": true, + "values": [ + { + "value": "in_progress", + "description": "The in_progress run status" + }, + { + "value": "cancelled", + "description": "The cancelled run status" + }, + { + "value": "failed", + "description": "The cancelled run status" + }, + { + "value": "completed", + "description": "The cancelled run status" + }, + { + "value": "expired", + "description": "The cancelled run status" + } + ] + } + }, + "step_details": { + "type": "object", + "description": "The details of the run step.", + "oneOf": [ + { + "$ref": "#/components/schemas/runStepDetailsMessageCreationObject" + }, + { + "$ref": "#/components/schemas/runStepDetailsToolCallsObject" + } + ] + }, + "last_error": { + "type": "object", + "description": "The last error associated with this run step. Will be `null` if there are no errors.", + "nullable": true, + "properties": { + "code": { + "type": "string", + "description": "One of `server_error` or `rate_limit_exceeded`.", + "enum": [ + "server_error", + "rate_limit_exceeded" + ], + "x-ms-enum": { + "name": "LastErrorCode", + "modelAsString": true, + "values": [ + { + "value": "server_error", + "description": "The server_error" + }, + { + "value": "rate_limit_exceeded", + "description": "The rate_limit_exceeded status" + } + ] + } + }, + "message": { + "type": "string", + "description": "A human-readable description of the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "expired_at": { + "description": "The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.", + "type": "integer", + "nullable": true + }, + "cancelled_at": { + "description": "The Unix timestamp (in seconds) for when the run step was cancelled.", + "type": "integer", + "nullable": true + }, + "failed_at": { + "description": "The Unix timestamp (in seconds) for when the run step failed.", + "type": "integer", + "nullable": true + }, + "completed_at": { + "description": "The Unix timestamp (in seconds) for when the run step completed.", + "type": "integer", + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + }, + "required": [ + "id", + "object", + "created_at", + "assistant_id", + "thread_id", + "run_id", + "type", + "status", + "step_details", + "last_error", + "expired_at", + "cancelled_at", + "failed_at", + "completed_at", + "metadata" + ] + }, + "runStepDeltaObject": { + "type": "object", + "title": "Run step delta object", + "description": "Represents a run step delta i.e. any changed fields on a run step during streaming.\n", + "properties": { + "id": { + "description": "The identifier of the run step, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `thread.run.step.delta`.", + "type": "string", + "enum": [ + "thread.run.step.delta" + ], + "x-ms-enum": { + "name": "RunStepDeltaObjectType", + "modelAsString": true, + "values": [ + { + "value": "thread.run.step.delta" + } + ] + } + }, + "delta": { + "description": "The delta containing the fields that have changed on the run step.", + "type": "object", + "properties": { + "step_details": { + "type": "object", + "description": "The details of the run step.", + "oneOf": [ + { + "$ref": "#/components/schemas/runStepDeltaStepDetailsMessageCreationObject" + }, + { + "$ref": "#/components/schemas/runStepDeltaStepDetailsToolCallsObject" + } + ] + } + } + } + }, + "required": [ + "id", + "object", + "delta" + ] + }, + "listRunStepsResponse": { + "properties": { + "object": { + "type": "string", + "example": "list" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/runStepObject" + } + }, + "first_id": { + "type": "string" + }, + "last_id": { + "type": "string" + }, + "has_more": { + "type": "boolean", + "example": false + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + }, + "runStepDetailsMessageCreationObject": { + "title": "Message creation", + "type": "object", + "description": "Details of the message creation by the run step.", + "properties": { + "type": { + "description": "Always `message_creation``.", + "type": "string", + "enum": [ + "message_creation" + ], + "x-ms-enum": { + "name": "RunStepDetailsMessageCreationObjectType", + "modelAsString": true, + "values": [ + { + "value": "message_creation" + } + ] + } + }, + "message_creation": { + "type": "object", + "properties": { + "message_id": { + "type": "string", + "description": "The ID of the message that was created by this run step." + } + }, + "required": [ + "message_id" + ] + } + }, + "required": [ + "type", + "message_creation" + ] + }, + "runStepDeltaStepDetailsMessageCreationObject": { + "title": "Message creation", + "type": "object", + "description": "Details of the message creation by the run step.", + "properties": { + "type": { + "description": "Always `message_creation`.", + "type": "string", + "enum": [ + "message_creation" + ], + "x-ms-enum": { + "name": "RunStepDeltaStepDetailsMessageCreationObjectType", + "modelAsString": true, + "values": [ + { + "value": "message_creation" + } + ] + } + }, + "message_creation": { + "type": "object", + "properties": { + "message_id": { + "type": "string", + "description": "The ID of the message that was created by this run step." + } + } + } + }, + "required": [ + "type" + ] + }, + "runStepDetailsToolCallsObject": { + "title": "Tool calls", + "type": "object", + "description": "Details of the tool call.", + "properties": { + "type": { + "description": "Always `tool_calls`.", + "type": "string", + "enum": [ + "tool_calls" + ], + "x-ms-enum": { + "name": "RunStepDetailsToolCallsObjectType", + "modelAsString": true, + "values": [ + { + "value": "tool_calls" + } + ] + } + }, + "tool_calls": { + "type": "array", + "description": "An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `retrieval` or `function`.\n", + "items": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/runStepDetailsToolCallsCodeObject" + }, + { + "$ref": "#/components/schemas/runStepDetailsToolCallsFileSearchObject" + }, + { + "$ref": "#/components/schemas/runStepDetailsToolCallsFunctionObject" + } + ] + } + } + }, + "required": [ + "type", + "tool_calls" + ] + }, + "runStepDeltaStepDetailsToolCallsObject": { + "title": "Tool calls", + "type": "object", + "description": "Details of the tool call.", + "properties": { + "type": { + "description": "Always `tool_calls`.", + "type": "string", + "enum": [ + "tool_calls" + ], + "x-ms-enum": { + "name": "RunStepDeltaStepDetailsToolCallsObjectType", + "modelAsString": true, + "values": [ + { + "value": "tool_calls" + } + ] + } + }, + "tool_calls": { + "type": "array", + "description": "An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search` or `function`.\n", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/runStepDeltaStepDetailsToolCallsCodeObject" + }, + { + "$ref": "#/components/schemas/runStepDeltaStepDetailsToolCallsFileSearchObject" + }, + { + "$ref": "#/components/schemas/runStepDeltaStepDetailsToolCallsFunctionObject" + } + ] + } + } + }, + "required": [ + "type" + ] + }, + "runStepDetailsToolCallsCodeObject": { + "title": "Code interpreter tool call", + "type": "object", + "description": "Details of the Code Interpreter tool call the run step was involved in.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the tool call." + }, + "type": { + "type": "string", + "description": "The type of tool call. This is always going to be `code_interpreter` for this type of tool call.", + "enum": [ + "code_interpreter" + ], + "x-ms-enum": { + "name": "RunStepDetailsToolCallsCodeObjectType", + "modelAsString": true, + "values": [ + { + "value": "code_interpreter" + } + ] + } + }, + "code_interpreter": { + "type": "object", + "description": "The Code Interpreter tool call definition.", + "required": [ + "input", + "outputs" + ], + "properties": { + "input": { + "type": "string", + "description": "The input to the Code Interpreter tool call." + }, + "outputs": { + "type": "array", + "description": "The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.", + "items": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/runStepDetailsToolCallsCodeOutputLogsObject" + }, + { + "$ref": "#/components/schemas/runStepDetailsToolCallsCodeOutputImageObject" + } + ] + } + } + } + } + }, + "required": [ + "id", + "type", + "code_interpreter" + ] + }, + "runStepDeltaStepDetailsToolCallsCodeObject": { + "title": "Code interpreter tool call", + "type": "object", + "description": "Details of the Code Interpreter tool call the run step was involved in.", + "properties": { + "index": { + "type": "integer", + "description": "The index of the tool call in the tool calls array." + }, + "id": { + "type": "string", + "description": "The ID of the tool call." + }, + "type": { + "type": "string", + "description": "The type of tool call. This is always going to be `code_interpreter` for this type of tool call.", + "enum": [ + "code_interpreter" + ], + "x-ms-enum": { + "name": "RunStepDeltaStepDetailsToolCallsCodeObjectType", + "modelAsString": true, + "values": [ + { + "value": "code_interpreter" + } + ] + } + }, + "code_interpreter": { + "type": "object", + "description": "The Code Interpreter tool call definition.", + "properties": { + "input": { + "type": "string", + "description": "The input to the Code Interpreter tool call." + }, + "outputs": { + "type": "array", + "description": "The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.", + "items": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/runStepDeltaStepDetailsToolCallsCodeOutputLogsObject" + }, + { + "$ref": "#/components/schemas/runStepDeltaStepDetailsToolCallsCodeOutputImageObject" + } + ] + } + } + } + } + }, + "required": [ + "index", + "type" + ] + }, + "runStepDetailsToolCallsCodeOutputLogsObject": { + "title": "Code interpreter log output", + "type": "object", + "description": "Text output from the Code Interpreter tool call as part of a run step.", + "properties": { + "type": { + "description": "Always `logs`.", + "type": "string", + "enum": [ + "logs" + ], + "x-ms-enum": { + "name": "RunStepDetailsToolCallsCodeOutputLogsObjectType", + "modelAsString": true, + "values": [ + { + "value": "logs" + } + ] + } + }, + "logs": { + "type": "string", + "description": "The text output from the Code Interpreter tool call." + } + }, + "required": [ + "type", + "logs" + ] + }, + "runStepDeltaStepDetailsToolCallsCodeOutputLogsObject": { + "title": "Code interpreter log output", + "type": "object", + "description": "Text output from the Code Interpreter tool call as part of a run step.", + "properties": { + "index": { + "type": "integer", + "description": "The index of the output in the outputs array." + }, + "type": { + "description": "Always `logs`.", + "type": "string", + "enum": [ + "logs" + ], + "x-ms-enum": { + "name": "RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType", + "modelAsString": true, + "values": [ + { + "value": "logs" + } + ] + } + }, + "logs": { + "type": "string", + "description": "The text output from the Code Interpreter tool call." + } + }, + "required": [ + "index", + "type" + ] + }, + "runStepDetailsToolCallsCodeOutputImageObject": { + "title": "Code interpreter image output", + "type": "object", + "properties": { + "type": { + "description": "Always `image`.", + "type": "string", + "enum": [ + "image" + ], + "x-ms-enum": { + "name": "RunStepDetailsToolCallsCodeOutputImageObjectType", + "modelAsString": true, + "values": [ + { + "value": "image" + } + ] + } + }, + "image": { + "type": "object", + "properties": { + "file_id": { + "description": "The File ID of the image.", + "type": "string" + } + }, + "required": [ + "file_id" + ] + } + }, + "required": [ + "type", + "image" + ] + }, + "runStepDeltaStepDetailsToolCallsCodeOutputImageObject": { + "title": "Code interpreter image output", + "type": "object", + "properties": { + "index": { + "type": "integer", + "description": "The index of the output in the outputs array." + }, + "type": { + "description": "Always `image`.", + "type": "string", + "enum": [ + "image" + ], + "x-ms-enum": { + "name": "RunStepDeltaStepDetailsToolCallsCodeOutputImageObject", + "modelAsString": true, + "values": [ + { + "value": "image" + } + ] + } + }, + "image": { + "type": "object", + "properties": { + "file_id": { + "description": "The file ID of the image.", + "type": "string" + } + } + } + }, + "required": [ + "index", + "type" + ] + }, + "runStepDetailsToolCallsFileSearchObject": { + "title": "File search tool call", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the tool call object." + }, + "type": { + "type": "string", + "description": "The type of tool call. This is always going to be `file_search` for this type of tool call.", + "enum": [ + "file_search" + ], + "x-ms-enum": { + "name": "RunStepDetailsToolCallsFileSearchObjectType", + "modelAsString": true, + "values": [ + { + "value": "file_search" + } + ] + } + }, + "file_search": { + "type": "object", + "description": "For now, this is always going to be an empty object." + } + }, + "required": [ + "id", + "type", + "file_search" + ] + }, + "runStepDeltaStepDetailsToolCallsFileSearchObject": { + "title": "File search tool call", + "type": "object", + "properties": { + "index": { + "type": "integer", + "description": "The index of the tool call in the tool calls array." + }, + "id": { + "type": "string", + "description": "The ID of the tool call object." + }, + "type": { + "type": "string", + "description": "The type of tool call. This is always going to be `retrieval` for this type of tool call.", + "enum": [ + "file_search" + ], + "x-ms-enum": { + "name": "RunStepDeltaStepDetailsToolCallsFileSearchObjectType", + "modelAsString": true, + "values": [ + { + "value": "file_search" + } + ] + } + }, + "file_search": { + "type": "object", + "description": "For now, this is always going to be an empty object." + } + }, + "required": [ + "index", + "type", + "file_search" + ] + }, + "runStepDetailsToolCallsFunctionObject": { + "type": "object", + "title": "Function tool call", + "properties": { + "id": { + "type": "string", + "description": "The ID of the tool call object." + }, + "type": { + "type": "string", + "description": "The type of tool call. This is always going to be `function` for this type of tool call.", + "enum": [ + "function" + ], + "x-ms-enum": { + "name": "RunStepDetailsToolCallsFunctionObjectType", + "modelAsString": true, + "values": [ + { + "value": "function" + } + ] + } + }, + "function": { + "type": "object", + "description": "The definition of the function that was called.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function." + }, + "arguments": { + "type": "string", + "description": "The arguments passed to the function." + }, + "output": { + "type": "string", + "description": "The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet.", + "nullable": true + } + }, + "required": [ + "name", + "arguments", + "output" + ] + } + }, + "required": [ + "id", + "type", + "function" + ] + }, + "runStepDeltaStepDetailsToolCallsFunctionObject": { + "type": "object", + "title": "Function tool call", + "properties": { + "index": { + "type": "integer", + "description": "The index of the tool call in the tool calls array." + }, + "id": { + "type": "string", + "description": "The ID of the tool call object." + }, + "type": { + "type": "string", + "description": "The type of tool call. This is always going to be `function` for this type of tool call.", + "enum": [ + "function" + ], + "x-ms-enum": { + "name": "RunStepDetailsToolCallsFunctionObjectType", + "modelAsString": true, + "values": [ + { + "value": "function" + } + ] + } + }, + "function": { + "type": "object", + "description": "The definition of the function that was called.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function." + }, + "arguments": { + "type": "string", + "description": "The arguments passed to the function." + }, + "output": { + "type": "string", + "description": "The output of the function. This will be `null` if the outputs have not been submitted yet.", + "nullable": true + } + } + } + }, + "required": [ + "index", + "type" + ] + }, + "vectorStoreExpirationAfter": { + "type": "object", + "title": "Vector store expiration policy", + "description": "The expiration policy for a vector store.", + "properties": { + "anchor": { + "description": "Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`.", + "type": "string", + "enum": [ + "last_active_at" + ], + "x-ms-enum": { + "name": "VectorStoreExpirationAfterAnchor", + "modelAsString": true, + "values": [ + { + "value": "last_active_at", + "description": "The anchor timestamp after which the expiration policy applies." + } + ] + } + }, + "days": { + "description": "The number of days after the anchor time that the vector store will expire.", + "type": "integer", + "minimum": 1, + "maximum": 365 + } + }, + "required": [ + "anchor", + "days" + ] + }, + "vectorStoreObject": { + "type": "object", + "title": "Vector store", + "description": "A vector store is a collection of processed files can be used by the `file_search` tool.", + "properties": { + "id": { + "description": "The identifier, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `vector_store`.", + "type": "string", + "enum": [ + "vector_store" + ] + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the vector store was created.", + "type": "integer" + }, + "name": { + "description": "The name of the vector store.", + "type": "string" + }, + "usage_bytes": { + "description": "The total number of bytes used by the files in the vector store.", + "type": "integer" + }, + "file_counts": { + "type": "object", + "properties": { + "in_progress": { + "description": "The number of files that are currently being processed.", + "type": "integer" + }, + "completed": { + "description": "The number of files that have been successfully processed.", + "type": "integer" + }, + "failed": { + "description": "The number of files that have failed to process.", + "type": "integer" + }, + "cancelled": { + "description": "The number of files that were cancelled.", + "type": "integer" + }, + "total": { + "description": "The total number of files.", + "type": "integer" + } + }, + "required": [ + "in_progress", + "completed", + "failed", + "cancelled", + "total" + ] + }, + "status": { + "description": "The status of the vector store, which can be either `expired`, `in_progress`, or `completed`. A status of `completed` indicates that the vector store is ready for use.", + "type": "string", + "enum": [ + "expired", + "in_progress", + "completed" + ], + "x-ms-enum": { + "name": "VectorStoreObjectStatus", + "modelAsString": true, + "values": [ + { + "value": "expired" + }, + { + "value": "in_progress" + }, + { + "value": "completed" + } + ] + } + }, + "expires_after": { + "$ref": "#/components/schemas/vectorStoreExpirationAfter" + }, + "expires_at": { + "description": "The Unix timestamp (in seconds) for when the vector store will expire.", + "type": "integer", + "nullable": true + }, + "last_active_at": { + "description": "The Unix timestamp (in seconds) for when the vector store was last active.", + "type": "integer", + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + }, + "required": [ + "id", + "object", + "usage_bytes", + "created_at", + "status", + "last_active_at", + "name", + "bytes", + "file_counts", + "metadata" + ] + }, + "createVectorStoreRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "file_ids": { + "description": "A list of file IDs that the vector store should use. Useful for tools like `file_search` that can access files.", + "type": "array", + "maxItems": 500, + "items": { + "type": "string" + } + }, + "name": { + "description": "The name of the vector store.", + "type": "string" + }, + "expires_after": { + "$ref": "#/components/schemas/vectorStoreExpirationAfter" + }, + "chunking_strategy": { + "type": "object", + "description": "The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. Only applicable if `file_ids` is non-empty.", + "oneOf": [ + { + "$ref": "#/components/schemas/autoChunkingStrategyRequestParam" + }, + { + "$ref": "#/components/schemas/staticChunkingStrategyRequestParam" + } + ] + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + } + }, + "updateVectorStoreRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "description": "The name of the vector store.", + "type": "string", + "nullable": true + }, + "expires_after": { + "$ref": "#/components/schemas/vectorStoreExpirationAfter", + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + } + }, + "listVectorStoresResponse": { + "properties": { + "object": { + "type": "string", + "example": "list" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/vectorStoreObject" + } + }, + "first_id": { + "type": "string", + "example": "vs_abc123" + }, + "last_id": { + "type": "string", + "example": "vs_abc456" + }, + "has_more": { + "type": "boolean", + "example": false + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + }, + "deleteVectorStoreResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "object": { + "type": "string", + "enum": [ + "vector_store.deleted" + ], + "x-ms-enum": { + "name": "DeleteVectorStoreResponseObject", + "modelAsString": true, + "values": [ + { + "value": "vector_store.deleted", + "description": "The delete vector store response object state" + } + ] + } + } + }, + "required": [ + "id", + "object", + "deleted" + ] + }, + "vectorStoreFileObject": { + "type": "object", + "title": "Vector store files", + "description": "A list of files attached to a vector store.", + "properties": { + "id": { + "description": "The identifier, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `vector_store.file`.", + "type": "string", + "enum": [ + "vector_store.file" + ], + "x-ms-enum": { + "name": "VectorStoreFileObjectType", + "modelAsString": true, + "values": [ + { + "value": "vector_store.file" + } + ] + } + }, + "usage_bytes": { + "description": "The total vector store usage in bytes. Note that this may be different from the original file size.", + "type": "integer" + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the vector store file was created.", + "type": "integer" + }, + "vector_store_id": { + "description": "The ID of the vector store that the file is attached to.", + "type": "string" + }, + "status": { + "description": "The status of the vector store file, which can be either `in_progress`, `completed`, `cancelled`, or `failed`. The status `completed` indicates that the vector store file is ready for use.", + "type": "string", + "enum": [ + "in_progress", + "completed", + "cancelled", + "failed" + ], + "x-ms-enum": { + "name": "VectorStoreFileObjectStatus", + "modelAsString": true, + "values": [ + { + "value": "in_progress" + }, + { + "value": "completed" + }, + { + "value": "cancelled" + }, + { + "value": "failed" + } + ] + } + }, + "last_error": { + "type": "object", + "description": "The last error associated with this vector store file. Will be `null` if there are no errors.", + "nullable": true, + "properties": { + "code": { + "type": "string", + "description": "One of `server_error` or `rate_limit_exceeded`.", + "enum": [ + "internal_error", + "file_not_found", + "parsing_error", + "unhandled_mime_type" + ], + "x-ms-enum": { + "name": "VectorStoreFileObjectLastErrorCode", + "modelAsString": true, + "values": [ + { + "value": "internal_error" + }, + { + "value": "file_not_found" + }, + { + "value": "parsing_error" + }, + { + "value": "unhandled_mime_type" + } + ] + } + }, + "message": { + "type": "string", + "description": "A human-readable description of the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "chunking_strategy": { + "type": "object", + "description": "The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. Only applicable if `file_ids` is non-empty.", + "oneOf": [ + { + "$ref": "#/components/schemas/autoChunkingStrategyRequestParam" + }, + { + "$ref": "#/components/schemas/staticChunkingStrategyRequestParam" + } + ] + } + }, + "required": [ + "id", + "object", + "usage_bytes", + "created_at", + "vector_store_id", + "status", + "last_error" + ] + }, + "otherChunkingStrategyResponseParam": { + "type": "object", + "title": "Other Chunking Strategy", + "description": "This is returned when the chunking strategy is unknown. Typically, this is because the file was indexed before the `chunking_strategy` concept was introduced in the API.", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "description": "Always `other`.", + "enum": [ + "other" + ], + "x-ms-enum": { + "name": "OtherChunkingStrategyResponseParamType", + "modelAsString": true, + "values": [ + { + "value": "other" + } + ] + } + } + }, + "required": [ + "type" + ] + }, + "staticChunkingStrategyResponseParam": { + "type": "object", + "title": "Static Chunking Strategy", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "description": "Always `static`.", + "enum": [ + "static" + ], + "x-ms-enum": { + "name": "StaticChunkingStrategyResponseParamType", + "modelAsString": true, + "values": [ + { + "value": "static" + } + ] + } + }, + "static": { + "$ref": "#/components/schemas/staticChunkingStrategy" + } + }, + "required": [ + "type", + "static" + ] + }, + "staticChunkingStrategy": { + "type": "object", + "additionalProperties": false, + "properties": { + "max_chunk_size_tokens": { + "type": "integer", + "minimum": 100, + "maximum": 4096, + "description": "The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`." + }, + "chunk_overlap_tokens": { + "type": "integer", + "description": "The number of tokens that overlap between chunks. The default value is `400`.\n\nNote that the overlap must not exceed half of `max_chunk_size_tokens`.\n" + } + }, + "required": [ + "max_chunk_size_tokens", + "chunk_overlap_tokens" + ] + }, + "autoChunkingStrategyRequestParam": { + "type": "object", + "title": "Auto Chunking Strategy", + "description": "The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`.", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "description": "Always `auto`.", + "enum": [ + "auto" + ] + } + }, + "required": [ + "type" + ] + }, + "staticChunkingStrategyRequestParam": { + "type": "object", + "title": "Static Chunking Strategy", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "description": "Always `static`.", + "enum": [ + "static" + ] + }, + "static": { + "$ref": "#/components/schemas/staticChunkingStrategy" + } + }, + "required": [ + "type", + "static" + ] + }, + "chunkingStrategyRequestParam": { + "type": "object", + "description": "The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy.", + "oneOf": [ + { + "$ref": "#/components/schemas/autoChunkingStrategyRequestParam" + }, + { + "$ref": "#/components/schemas/staticChunkingStrategyRequestParam" + } + ] + }, + "createVectorStoreFileRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "file_id": { + "description": "A File ID that the vector store should use. Useful for tools like `file_search` that can access files.", + "type": "string" + }, + "chunking_strategy": { + "$ref": "#/components/schemas/chunkingStrategyRequestParam" + } + }, + "required": [ + "file_id" + ] + }, + "listVectorStoreFilesResponse": { + "properties": { + "object": { + "type": "string", + "example": "list" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/vectorStoreFileObject" + } + }, + "first_id": { + "type": "string", + "example": "file-abc123" + }, + "last_id": { + "type": "string", + "example": "file-abc456" + }, + "has_more": { + "type": "boolean", + "example": false + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + }, + "deleteVectorStoreFileResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "object": { + "type": "string", + "enum": [ + "vector_store.file.deleted" + ], + "x-ms-enum": { + "name": "DeleteVectorStoreFileResponseObject", + "modelAsString": true, + "values": [ + { + "value": "vector_store.file.deleted" + } + ] + } + } + }, + "required": [ + "id", + "object", + "deleted" + ] + }, + "vectorStoreFileBatchObject": { + "type": "object", + "title": "Vector store file batch", + "description": "A batch of files attached to a vector store.", + "properties": { + "id": { + "description": "The identifier, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `vector_store.file_batch`.", + "type": "string", + "enum": [ + "vector_store.files_batch" + ], + "x-ms-enum": { + "name": "VectorStoreFileBatchObjectType", + "modelAsString": true, + "values": [ + { + "value": "vector_store.files_batch" + } + ] + } + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the vector store files batch was created.", + "type": "integer" + }, + "vector_store_id": { + "description": "The ID of the vector store that the File is attached to.", + "type": "string" + }, + "status": { + "description": "The status of the vector store files batch, which can be either `in_progress`, `completed`, `cancelled` or `failed`.", + "type": "string", + "enum": [ + "in_progress", + "completed", + "cancelled", + "failed" + ], + "x-ms-enum": { + "name": "VectorStoreFileBatchObjectStatus", + "modelAsString": true, + "values": [ + { + "value": "in_progress" + }, + { + "value": "completed" + }, + { + "value": "cancelled" + }, + { + "value": "failed" + } + ] + } + }, + "file_counts": { + "type": "object", + "properties": { + "in_progress": { + "description": "The number of files that are currently being processed.", + "type": "integer" + }, + "completed": { + "description": "The number of files that have been processed.", + "type": "integer" + }, + "failed": { + "description": "The number of files that have failed to process.", + "type": "integer" + }, + "cancelled": { + "description": "The number of files that where cancelled.", + "type": "integer" + }, + "total": { + "description": "The total number of files.", + "type": "integer" + } + }, + "required": [ + "in_progress", + "completed", + "cancelled", + "failed", + "total" + ] + } + }, + "required": [ + "id", + "object", + "created_at", + "vector_store_id", + "status", + "file_counts" + ] + }, + "createVectorStoreFileBatchRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "file_ids": { + "description": "A list of File IDs that the vector store should use. Useful for tools like `file_search` that can access files.", + "type": "array", + "minItems": 1, + "maxItems": 500, + "items": { + "type": "string" + } + }, + "chunking_strategy": { + "$ref": "#/components/schemas/chunkingStrategyRequestParam" + } + }, + "required": [ + "file_ids" + ] + }, + "assistantStreamEvent": { + "description": "Represents an event emitted when streaming a Run.\n\nEach event in a server-sent events stream has an `event` and `data` property:\n\n```\nevent: thread.created\ndata: {\"id\": \"thread_123\", \"object\": \"thread\", ...}\n```\n\nWe emit events whenever a new object is created, transitions to a new state, or is being\nstreamed in parts (deltas). For example, we emit `thread.run.created` when a new run\nis created, `thread.run.completed` when a run completes, and so on. When an Assistant chooses\nto create a message during a run, we emit a `thread.message.created event`, a\n`thread.message.in_progress` event, many `thread.message.delta` events, and finally a\n`thread.message.completed` event.\n\nWe may add additional events over time, so we recommend handling unknown events gracefully\nin your code. See the [Assistants API quick start](/docs/assistants/overview) to learn how to\nintegrate the Assistants API with streaming.\n", + "oneOf": [ + { + "$ref": "#/components/schemas/threadStreamEvent" + }, + { + "$ref": "#/components/schemas/runStreamEvent" + }, + { + "$ref": "#/components/schemas/runStepStreamEvent" + }, + { + "$ref": "#/components/schemas/messageStreamEvent" + }, + { + "$ref": "#/components/schemas/errorEvent" + }, + { + "$ref": "#/components/schemas/doneEvent" + } + ] + }, + "threadStreamEvent": { + "oneOf": [ + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.created" + ], + "x-ms-enum": { + "name": "ThreadStreamEventEnum", + "modelAsString": true, + "values": [ + { + "value": "thread.created", + "description": "The thread created event" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/threadObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a new thread is created." + } + ] + }, + "runStreamEvent": { + "oneOf": [ + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.created" + ], + "x-ms-enum": { + "name": "RunStreamEventCreated", + "modelAsString": true, + "values": [ + { + "value": "thread.run.created" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a new run is created." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.queued" + ], + "x-ms-enum": { + "name": "RunStreamEventQueued", + "modelAsString": true, + "values": [ + { + "value": "thread.run.queued" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run moves to a `queued` status." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.in_progress" + ], + "x-ms-enum": { + "name": "RunStreamEventInProgress", + "modelAsString": true, + "values": [ + { + "value": "thread.run.in_progress" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run moves to an `in_progress` status." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.requires_action" + ], + "x-ms-enum": { + "name": "RunStreamEventRequiresAction", + "modelAsString": true, + "values": [ + { + "value": "thread.run.requires_action" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run moves to a `requires_action` status." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.completed" + ], + "x-ms-enum": { + "name": "RunStreamEventCompleted", + "modelAsString": true, + "values": [ + { + "value": "thread.run.completed" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run is completed." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.failed" + ], + "x-ms-enum": { + "name": "RunStreamEventFailed", + "modelAsString": true, + "values": [ + { + "value": "thread.run.failed" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run fails." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.cancelling" + ], + "x-ms-enum": { + "name": "RunStreamEventCancelling", + "modelAsString": true, + "values": [ + { + "value": "thread.run.cancelling" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run moves to a `cancelling` status." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.cancelled" + ], + "x-ms-enum": { + "name": "RunStreamEventCancelled", + "modelAsString": true, + "values": [ + { + "value": "thread.run.cancelled" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run is cancelled." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.expired" + ], + "x-ms-enum": { + "name": "RunStreamEventExpired", + "modelAsString": true, + "values": [ + { + "value": "thread.run.expired" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run expires." + } + ] + }, + "runStepStreamEvent": { + "oneOf": [ + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.step.created" + ], + "x-ms-enum": { + "name": "RunStepStreamEventCreated", + "modelAsString": true, + "values": [ + { + "value": "thread.run.step.created" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runStepObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run step is created." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.step.in_progress" + ], + "x-ms-enum": { + "name": "RunStepStreamEventInProgress", + "modelAsString": true, + "values": [ + { + "value": "thread.run.step.in_progress" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runStepObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run step moves to an `in_progress` state." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.step.delta" + ], + "x-ms-enum": { + "name": "RunStepStreamEventDelta", + "modelAsString": true, + "values": [ + { + "value": "thread.run.step.delta" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runStepDeltaObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when parts of a run step are being streamed." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.step.completed" + ], + "x-ms-enum": { + "name": "RunStepStreamEventCompleted", + "modelAsString": true, + "values": [ + { + "value": "thread.run.step.completed" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runStepObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run step is completed." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.step.failed" + ], + "x-ms-enum": { + "name": "RunStepStreamEventFailed", + "modelAsString": true, + "values": [ + { + "value": "thread.run.step.failed" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runStepObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run step fails." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.step.cancelled" + ], + "x-ms-enum": { + "name": "RunStepStreamEventCancelled", + "modelAsString": true, + "values": [ + { + "value": "thread.run.step.cancelled" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runStepObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run step is cancelled." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.step.expired" + ], + "x-ms-enum": { + "name": "RunStepStreamEventExpired", + "modelAsString": true, + "values": [ + { + "value": "thread.run.step.expired" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runStepObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run step expires." + } + ] + }, + "messageStreamEvent": { + "oneOf": [ + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.message.created" + ], + "x-ms-enum": { + "name": "MessageStreamEventCreated", + "modelAsString": true, + "values": [ + { + "value": "thread.message.created" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/messageObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a message is created." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.message.in_progress" + ], + "x-ms-enum": { + "name": "MessageStreamEventInProgress", + "modelAsString": true, + "values": [ + { + "value": "thread.message.in_progress" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/messageObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a message moves to an `in_progress` state." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.message.delta" + ], + "x-ms-enum": { + "name": "MessageStreamEventDelta", + "modelAsString": true, + "values": [ + { + "value": "thread.message.delta" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/messageDeltaObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when parts of a message are being streamed." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.message.completed" + ], + "x-ms-enum": { + "name": "MessageStreamEventCompleted", + "modelAsString": true, + "values": [ + { + "value": "thread.message.completed" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/messageObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a message is completed." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.message.incomplete" + ], + "x-ms-enum": { + "name": "MessageStreamEventIncomplete", + "modelAsString": true, + "values": [ + { + "value": "thread.message.incomplete" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/messageObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a message ends before it is completed." + } + ] + }, + "errorEvent": { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "error" + ], + "x-ms-enum": { + "name": "ErrorEventEnum", + "modelAsString": true, + "values": [ + { + "value": "error" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/error" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when an error occurs. This can happen due to an internal server error or a timeout." + }, + "doneEvent": { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "done" + ], + "x-ms-enum": { + "name": "DoneEventEnum", + "modelAsString": true, + "values": [ + { + "value": "done" + } + ] + } + }, + "data": { + "type": "string", + "enum": [ + "[DONE]" + ], + "x-ms-enum": { + "name": "DoneEventDataEnum", + "modelAsString": true, + "values": [ + { + "value": "[DONE]" + } + ] + } + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a stream ends." + } + }, + "securitySchemes": { + "bearer": { + "type": "oauth2", + "flows": { + "implicit": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", + "scopes": {} + } + }, + "x-tokenInfoFunc": "api.middleware.auth.bearer_auth", + "x-scopeValidateFunc": "api.middleware.auth.validate_scopes" + }, + "apiKey": { + "type": "apiKey", + "name": "api-key", + "in": "header" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.yaml new file mode 100644 index 000000000000..aa5051f82553 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.yaml @@ -0,0 +1,8336 @@ +openapi: 3.0.0 +info: + title: Azure OpenAI Service API + description: Azure OpenAI APIs for completions and search + version: 2024-09-01-preview +servers: + - url: https://{endpoint}/openai + variables: + endpoint: + default: your-resource-name.openai.azure.com +security: + - bearer: + - api.read + - apiKey: [] +paths: + /deployments/{deployment-id}/completions: + post: + summary: Creates a completion for the provided prompt, parameters and chosen model. + operationId: Completions_Create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: davinci + description: Deployment id of the model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createCompletionRequest" + example: + prompt: |- + Negate the following sentence.The price for bubblegum increased on thursday. + + Negated Sentence: + max_tokens: 50 + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/createCompletionResponse" + example: + model: davinci + object: text_completion + id: cmpl-4509KAos68kxOqpE2uYGw81j6m7uo + created: 1637097562 + choices: + - index: 0 + text: The price for bubblegum decreased on thursday. + logprobs: null + finish_reason: stop + headers: + apim-request-id: + description: Request ID for troubleshooting purposes + schema: + type: string + default: + description: Service unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/errorResponse" + headers: + apim-request-id: + description: Request ID for troubleshooting purposes + schema: + type: string + /deployments/{deployment-id}/embeddings: + post: + summary: Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms. + operationId: embeddings_create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: ada-search-index-v1 + description: The deployment id of the model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: true + properties: + input: + description: |- + Input text to get embeddings for, encoded as a string. To get embeddings for multiple inputs in a single request, pass an array of strings. Each input must not exceed 2048 tokens in length. + Unless you are embedding code, we suggest replacing newlines (\n) in your input with a single space, as we have observed inferior results when newlines are present. + oneOf: + - type: string + default: "" + example: This is a test. + nullable: true + - type: array + minItems: 1 + maxItems: 2048 + items: + type: string + minLength: 1 + example: This is a test. + nullable: false + user: + description: A unique identifier representing your end-user, which can help monitoring and detecting abuse. + type: string + nullable: false + input_type: + description: input type of embedding search to use + type: string + example: query + encoding_format: + description: The format to return the embeddings in. Can be either `float` or `base64`. Defaults to `float`. + type: string + example: base64 + nullable: true + dimensions: + description: The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models. + type: integer + example: 1 + nullable: true + required: + - input + responses: + "200": + description: OK + content: + application/json: + schema: + type: object + properties: + object: + type: string + model: + type: string + data: + type: array + items: + type: object + properties: + index: + type: integer + object: + type: string + embedding: + type: array + items: + type: number + required: + - index + - object + - embedding + usage: + type: object + properties: + prompt_tokens: + type: integer + total_tokens: + type: integer + required: + - prompt_tokens + - total_tokens + required: + - object + - model + - data + - usage + x-ms-examples: + Create a embeddings.: + $ref: ./examples/embeddings.yaml + /deployments/{deployment-id}/chat/completions: + post: + summary: Creates a completion for the chat message + operationId: ChatCompletions_Create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + description: Deployment id of the model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createChatCompletionRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + oneOf: + - $ref: "#/components/schemas/createChatCompletionResponse" + - $ref: "#/components/schemas/createChatCompletionStreamResponse" + headers: + apim-request-id: + description: Request ID for troubleshooting purposes + schema: + type: string + default: + description: Service unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/errorResponse" + headers: + apim-request-id: + description: Request ID for troubleshooting purposes + schema: + type: string + x-ms-examples: + Create a chat completion.: + $ref: ./examples/chat_completions.yaml + Creates a completion based on Azure Search data and system-assigned managed identity.: + $ref: ./examples/chat_completions_azure_search_minimum.yaml + Creates a completion based on Azure Search image vector data.: + $ref: ./examples/chat_completions_azure_search_image_vector.yaml + Creates a completion based on Azure Search vector data, previous assistant message and user-assigned managed identity.: + $ref: ./examples/chat_completions_azure_search_advanced.yaml + Creates a completion for the provided Azure Cosmos DB.: + $ref: ./examples/chat_completions_cosmos_db.yaml + Creates a completion for the provided Mongo DB.: + $ref: ./examples/chat_completions_mongo_db.yaml + Creates a completion for the provided Elasticsearch.: + $ref: ./examples/chat_completions_elasticsearch.yaml + Creates a completion for the provided Pinecone resource.: + $ref: ./examples/chat_completions_pinecone.yaml + /deployments/{deployment-id}/audio/transcriptions: + post: + summary: Transcribes audio into the input language. + operationId: Transcriptions_Create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: whisper + description: Deployment id of the whisper model. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + multipart/form-data: + schema: + $ref: "#/components/schemas/createTranscriptionRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + oneOf: + - $ref: "#/components/schemas/audioResponse" + - $ref: "#/components/schemas/audioVerboseResponse" + text/plain: + schema: + type: string + description: Transcribed text in the output format (when response_format was one of text, vtt or srt). + x-ms-examples: + Create an audio transcription with json response format.: + $ref: ./examples/audio_transcription_object.yaml + Create an audio transcription with text response format.: + $ref: ./examples/audio_transcription_text.yaml + /deployments/{deployment-id}/audio/translations: + post: + summary: Transcribes and translates input audio into English text. + operationId: Translations_Create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: whisper + description: Deployment id of the whisper model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + multipart/form-data: + schema: + $ref: "#/components/schemas/createTranslationRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + oneOf: + - $ref: "#/components/schemas/audioResponse" + - $ref: "#/components/schemas/audioVerboseResponse" + text/plain: + schema: + type: string + description: Transcribed text in the output format (when response_format was one of text, vtt or srt). + x-ms-examples: + Create an audio translation with json response format.: + $ref: ./examples/audio_translation_object.yaml + Create an audio translation with text response format.: + $ref: ./examples/audio_translation_text.yaml + /deployments/{deployment-id}/audio/speech: + post: + summary: Generates audio from the input text. + operationId: Speech_Create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: tts-1 + description: Deployment id of the tts model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + multipart/form-data: + schema: + $ref: "#/components/schemas/createSpeechRequest" + responses: + "200": + description: OK + content: + application/octet-stream: + schema: + type: string + format: binary + x-ms-examples: + Create an audio from text with response format mp3.: + $ref: ./examples/audio_speech.yaml + /deployments/{deployment-id}/images/generations: + post: + summary: Generates a batch of images from a text caption on a given DALLE model deployment + operationId: ImageGenerations_Create + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/imageGenerationsRequest" + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: dalle-deployment + description: Deployment id of the dalle model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: Ok + content: + application/json: + schema: + $ref: "#/components/schemas/generateImagesResponse" + default: + description: An error occurred. + content: + application/json: + schema: + $ref: "#/components/schemas/dalleErrorResponse" + x-ms-examples: + Create an image.: + $ref: ./examples/image_generation.yaml + /assistants: + get: + operationId: List_Assistants + tags: + - Assistants + summary: Returns a list of assistants. + parameters: + - name: limit + in: query + description: &pagination_limit_param_description | + A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + required: false + schema: + type: integer + default: 20 + - name: order + in: query + description: &pagination_order_param_description | + Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order. + schema: + type: string + default: desc + enum: + - asc + - desc + x-ms-enum: + name: ListAssistantsOrder + modelAsString: true + values: + - value: asc + description: Order results in ascending order + - value: desc + description: Order results in descending order + - name: after + in: query + description: &pagination_after_param_description | + A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + description: &pagination_before_param_description | + A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/listAssistantsResponse" + x-ms-examples: + Create an image.: + $ref: ./examples/list_assistants.yaml + post: + operationId: Create_Assistant + tags: + - Assistants + summary: Create an assistant with a model and instructions. + parameters: + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createAssistantRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/assistantObject" + x-ms-examples: + Create an assistant.: + $ref: ./examples/create_assistant.yaml + + /assistants/{assistant_id}: + get: + operationId: Get_Assistant + tags: + - Assistants + summary: Retrieves an assistant. + parameters: + - in: path + name: assistant_id + required: true + schema: + type: string + description: The ID of the assistant to retrieve. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/assistantObject" + x-ms-examples: + Create an assistant.: + $ref: ./examples/retrieve_assistant.yaml + post: + operationId: Modify_Assistant + tags: + - Assistant + summary: Modifies an assistant. + parameters: + - in: path + name: assistant_id + required: true + schema: + type: string + description: The ID of the assistant to modify. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/modifyAssistantRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/assistantObject" + x-ms-examples: + Create an assistant.: + $ref: ./examples/modify_assistant.yaml + delete: + operationId: Delete_Assistant + tags: + - Assistants + summary: Delete an assistant. + parameters: + - in: path + name: assistant_id + required: true + schema: + type: string + description: The ID of the assistant to delete. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/deleteAssistantResponse" + x-ms-examples: + Create an assistant.: + $ref: ./examples/delete_assistant.yaml + /threads: + post: + operationId: Create_Thread + tags: + - Assistants + summary: Create a thread. + parameters: + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createThreadRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/threadObject" + x-ms-examples: + Create a thread.: + $ref: ./examples/create_thread.yaml + /threads/{thread_id}: + get: + operationId: Get_Thread + tags: + - Assistants + summary: Retrieves a thread. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the thread to retrieve. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/threadObject" + x-ms-examples: + Create a thread.: + $ref: ./examples/retrieve_thread.yaml + post: + operationId: Modify_Thread + tags: + - Assistants + summary: Modifies a thread. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the thread to modify. Only the `metadata` can be modified. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/modifyThreadRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/threadObject" + x-ms-examples: + Modify a thread.: + $ref: ./examples/modify_thread.yaml + delete: + operationId: Delete_Thread + tags: + - Assistants + summary: Delete a thread. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the thread to delete. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/deleteThreadResponse" + x-ms-examples: + Delete a thread.: + $ref: ./examples/delete_thread.yaml + /threads/{thread_id}/messages: + get: + operationId: List_Messages + tags: + - Assistants + summary: Returns a list of messages for a given thread. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the [thread](/docs/api-reference/threads) the messages belong to. + - name: limit + in: query + description: *pagination_limit_param_description + required: false + schema: + type: integer + default: 20 + - name: order + in: query + description: | + Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order. + schema: + type: string + default: desc + enum: + - asc + - desc + x-ms-enum: + name: ListMessagesOrder + modelAsString: true + values: + - value: asc + description: Order results in ascending order + - value: desc + description: Order results in descending order + - name: after + in: query + description: | + A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + description: | + A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + - name: run_id + in: query + description: | + Filter messages by the run ID that generated them. + schema: + type: string + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/listMessagesResponse" + x-ms-examples: + List messages.: + $ref: ./examples/list_messages.yaml + post: + operationId: Create_Message + tags: + - Assistants + summary: Create a message. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the [thread](/docs/api-reference/threads) to create a message for. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createMessageRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/messageObject" + x-ms-examples: + Create a message.: + $ref: ./examples/create_message.yaml + /threads/{thread_id}/messages/{message_id}: + get: + operationId: Get_Message + tags: + - Assistants + summary: Retrieve a message. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the [thread](/docs/api-reference/threads) to which this message belongs. + - in: path + name: message_id + required: true + schema: + type: string + description: The ID of the message to retrieve. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/messageObject" + x-ms-examples: + Retrieve a message.: + $ref: ./examples/get_message.yaml + post: + operationId: Modify_Message + tags: + - Assistants + summary: Modifies a message. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the thread to which this message belongs. + - in: path + name: message_id + required: true + schema: + type: string + description: The ID of the message to modify. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/modifyMessageRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/messageObject" + x-ms-examples: + Modify a message.: + $ref: ./examples/modify_message.yaml + /threads/runs: + post: + operationId: Create_Thread_And_Run + tags: + - Assistants + summary: Create a thread and run it in one request. + parameters: + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createThreadAndRunRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/runObject" + x-ms-examples: + Create a thread and run it.: + $ref: ./examples/create_thread_and_run.yaml + /threads/{thread_id}/runs: + get: + operationId: List_Runs + tags: + - Assistants + summary: Returns a list of runs belonging to a thread. + parameters: + - name: thread_id + in: path + required: true + schema: + type: string + description: The ID of the thread the run belongs to. + - name: limit + in: query + description: *pagination_limit_param_description + required: false + schema: + type: integer + default: 20 + - name: order + in: query + description: *pagination_order_param_description + schema: + type: string + default: desc + enum: + - asc + - desc + x-ms-enum: + name: ListRunsOrder + modelAsString: true + values: + - value: asc + description: Order results in ascending order + - value: desc + description: Order results in descending order + - name: after + in: query + description: *pagination_after_param_description + schema: + type: string + - name: before + in: query + description: *pagination_before_param_description + schema: + type: string + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/listRunsResponse" + x-ms-examples: + List runs.: + $ref: ./examples/list_runs.yaml + post: + operationId: Create_Run + tags: + - Assistants + summary: Create a run. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the thread to run. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createRunRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/runObject" + x-ms-examples: + Create a run.: + $ref: ./examples/create_run.yaml + /threads/{thread_id}/runs/{run_id}: + get: + operationId: Get_Run + tags: + - Assistants + summary: Retrieves a run. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the [thread](/docs/api-reference/threads) that was run. + - in: path + name: run_id + required: true + schema: + type: string + description: The ID of the run to retrieve. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/runObject" + x-ms-examples: + Retrieve a run.: + $ref: ./examples/get_run.yaml + post: + operationId: Modify_Run + tags: + - Assistants + summary: Modifies a run. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the [thread](/docs/api-reference/threads) that was run. + - in: path + name: run_id + required: true + schema: + type: string + description: The ID of the run to modify. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/modifyRunRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/runObject" + x-ms-examples: + Modify a run.: + $ref: ./examples/modify_run.yaml + /threads/{thread_id}/runs/{run_id}/submit_tool_outputs: + post: + operationId: Submit_Tool_Outputs_To_Run + tags: + - Assistants + summary: | + When a run has the `status: "requires_action"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the [thread](/docs/api-reference/threads) to which this run belongs. + - in: path + name: run_id + required: true + schema: + type: string + description: The ID of the run that requires the tool output submission. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/submitToolOutputsRunRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/runObject" + x-ms-examples: + Submit tool outputs to a run.: + $ref: ./examples/submit_tool_outputs_to_run.yaml + /threads/{thread_id}/runs/{run_id}/cancel: + post: + operationId: Cancel_Run + tags: + - Assistants + summary: Cancels a run that is `in_progress`. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the thread to which this run belongs. + - in: path + name: run_id + required: true + schema: + type: string + description: The ID of the run to cancel. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/runObject" + x-ms-examples: + Cancel a run.: + $ref: ./examples/cancel_run.yaml + /threads/{thread_id}/runs/{run_id}/steps: + get: + operationId: List_Run_Steps + tags: + - Assistants + summary: Returns a list of run steps belonging to a run. + parameters: + - name: thread_id + in: path + required: true + schema: + type: string + description: The ID of the thread the run and run steps belong to. + - name: run_id + in: path + required: true + schema: + type: string + description: The ID of the run the run steps belong to. + - name: limit + in: query + description: *pagination_limit_param_description + required: false + schema: + type: integer + default: 20 + - name: order + in: query + description: *pagination_order_param_description + schema: + type: string + default: desc + enum: + - asc + - desc + x-ms-enum: + name: ListRunStepsOrder + modelAsString: true + values: + - value: asc + description: Order results in ascending order + - value: desc + description: Order results in descending order + - name: after + in: query + description: *pagination_after_param_description + schema: + type: string + - name: before + in: query + description: *pagination_before_param_description + schema: + type: string + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/listRunStepsResponse" + x-ms-examples: + List run steps.: + $ref: ./examples/list_run_steps.yaml + /threads/{thread_id}/runs/{run_id}/steps/{step_id}: + get: + operationId: Get_Run_Step + tags: + - Assistants + summary: Retrieves a run step. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the thread to which the run and run step belongs. + - in: path + name: run_id + required: true + schema: + type: string + description: The ID of the run to which the run step belongs. + - in: path + name: step_id + required: true + schema: + type: string + description: The ID of the run step to retrieve. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/runStepObject" + x-ms-examples: + Retrieve a run step.: + $ref: ./examples/get_run_step.yaml + /vector_stores: + get: + operationId: List_Vector_Stores + tags: + - Vector Stores + summary: Returns a list of vector stores. + parameters: + - name: limit + in: query + description: *pagination_limit_param_description + required: false + schema: + type: integer + default: 20 + - name: order + in: query + description: *pagination_order_param_description + schema: + type: string + default: desc + enum: ["asc", "desc"] + x-ms-enum: + name: ListVectorStoresOrder + modelAsString: true + values: + - value: asc + - value: desc + - name: after + in: query + description: *pagination_after_param_description + schema: + type: string + - name: before + in: query + description: *pagination_before_param_description + schema: + type: string + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/listVectorStoresResponse" + x-ms-examples: + List vector stores.: + $ref: ./examples/list_vector_stores.yaml + post: + operationId: Create_Vector_Store + tags: + - Vector Stores + summary: Create a vector store. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createVectorStoreRequest" + parameters: + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/vectorStoreObject" + x-ms-examples: + Create a vector store.: + $ref: ./examples/create_vector_store.yaml + + /vector_stores/{vector_store_id}: + get: + operationId: Get_Vector_Store + tags: + - Vector Stores + summary: Retrieves a vector store. + parameters: + - in: path + name: vector_store_id + required: true + schema: + type: string + description: The ID of the vector store to retrieve. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/vectorStoreObject" + x-ms-examples: + Retrieve a vector store.: + $ref: ./examples/retrieve_vector_store.yaml + post: + operationId: Modify_Vector_Store + tags: + - Vector Stores + summary: Modifies a vector store. + parameters: + - in: path + name: vector_store_id + required: true + schema: + type: string + description: The ID of the vector store to modify. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/updateVectorStoreRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/vectorStoreObject" + x-ms-examples: + Modify a vector store.: + $ref: ./examples/modify_vector_store.yaml + + delete: + operationId: Delete_Vector_Store + tags: + - Vector Stores + summary: Delete a vector store. + parameters: + - in: path + name: vector_store_id + required: true + schema: + type: string + description: The ID of the vector store to delete. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/deleteVectorStoreResponse" + x-ms-examples: + Delete a vector store.: + $ref: ./examples/delete_vector_store.yaml + + /vector_stores/{vector_store_id}/files: + get: + operationId: List_Vector_Store_Files + tags: + - Vector Stores + summary: Returns a list of vector store files. + parameters: + - name: vector_store_id + in: path + description: The ID of the vector store that the files belong to. + required: true + schema: + type: string + - name: limit + in: query + description: *pagination_limit_param_description + required: false + schema: + type: integer + default: 20 + - name: order + in: query + description: *pagination_order_param_description + schema: + type: string + default: desc + enum: ["asc", "desc"] + x-ms-enum: + name: ListVectorStoreFilesOrder + modelAsString: true + values: + - value: asc + - value: desc + - name: after + in: query + description: *pagination_after_param_description + schema: + type: string + - name: before + in: query + description: *pagination_before_param_description + schema: + type: string + - name: filter + in: query + description: "Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`." + schema: + type: string + enum: ["in_progress", "completed", "failed", "cancelled"] + x-ms-enum: + name: ListVectorStoreFilesFilter + modelAsString: true + values: + - value: in_progress + - value: completed + - value: failed + - value: cancelled + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/listVectorStoreFilesResponse" + x-ms-examples: + List vector store files.: + $ref: ./examples/list_vector_store_files.yaml + post: + operationId: Create_Vector_Store_File + tags: + - Vector Stores + summary: Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object). + parameters: + - in: path + name: vector_store_id + required: true + schema: + type: string + example: vs_abc123 + description: | + The ID of the vector store for which to create a File. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createVectorStoreFileRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/vectorStoreFileObject" + x-ms-examples: + Create a vector store file.: + $ref: ./examples/create_vector_store_file.yaml + + /vector_stores/{vector_store_id}/files/{file_id}: + get: + operationId: Get_Vector_Store_File + tags: + - Vector Stores + summary: Retrieves a vector store file. + parameters: + - in: path + name: vector_store_id + required: true + schema: + type: string + example: vs_abc123 + description: The ID of the vector store that the file belongs to. + - in: path + name: file_id + required: true + schema: + type: string + example: file-abc123 + description: The ID of the file being retrieved. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/vectorStoreFileObject" + x-ms-examples: + Retrieve a vector store file.: + $ref: ./examples/retrieve_vector_store_file.yaml + delete: + operationId: Delete_Vector_Store_File + tags: + - Vector Stores + summary: Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the [delete file](/docs/api-reference/files/delete) endpoint. + parameters: + - in: path + name: vector_store_id + required: true + schema: + type: string + description: The ID of the vector store that the file belongs to. + - in: path + name: file_id + required: true + schema: + type: string + description: The ID of the file to delete. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/deleteVectorStoreFileResponse" + x-ms-examples: + Delete a vector store file.: + $ref: ./examples/delete_vector_store_file.yaml + + /vector_stores/{vector_store_id}/file_batches: + post: + operationId: Create_Vector_Store_File_Batch + tags: + - Vector Stores + summary: Create a vector store file batch. + parameters: + - in: path + name: vector_store_id + required: true + schema: + type: string + example: vs_abc123 + description: | + The ID of the vector store for which to create a File Batch. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createVectorStoreFileBatchRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/vectorStoreFileBatchObject" + x-ms-examples: + Create a vector store file batch.: + $ref: ./examples/create_vector_store_file_batch.yaml + + /vector_stores/{vector_store_id}/file_batches/{batch_id}: + get: + operationId: Get_Vector_Store_File_Batch + tags: + - Vector Stores + summary: Retrieves a vector store file batch. + parameters: + - in: path + name: vector_store_id + required: true + schema: + type: string + example: vs_abc123 + description: The ID of the vector store that the file batch belongs to. + - in: path + name: batch_id + required: true + schema: + type: string + example: vsfb_abc123 + description: The ID of the file batch being retrieved. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/vectorStoreFileBatchObject" + x-ms-examples: + Retrieve a vector store file batch.: + $ref: ./examples/retrieve_vector_store_file_batch.yaml + + /vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel: + post: + operationId: Cancel_Vector_Store_File_Batch + tags: + - Vector Stores + summary: Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible. + parameters: + - in: path + name: vector_store_id + required: true + schema: + type: string + description: The ID of the vector store that the file batch belongs to. + - in: path + name: batch_id + required: true + schema: + type: string + description: The ID of the file batch to cancel. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/vectorStoreFileBatchObject" + x-ms-examples: + Cancel a vector store file batch.: + $ref: ./examples/cancel_vector_store_file_batch.yaml + + /vector_stores/{vector_store_id}/file_batches/{batch_id}/files: + get: + operationId: List_Vector_Store_File_Batch_Files + tags: + - Vector Stores + summary: Returns a list of vector store files in a batch. + parameters: + - name: vector_store_id + in: path + description: The ID of the vector store that the files belong to. + required: true + schema: + type: string + - name: batch_id + in: path + description: The ID of the file batch that the files belong to. + required: true + schema: + type: string + - name: limit + in: query + description: *pagination_limit_param_description + required: false + schema: + type: integer + default: 20 + - name: order + in: query + description: *pagination_order_param_description + schema: + type: string + default: desc + enum: ["asc", "desc"] + x-ms-enum: + name: ListVectorStoreFilesOrder + modelAsString: true + values: + - value: asc + - value: desc + - name: after + in: query + description: *pagination_after_param_description + schema: + type: string + - name: before + in: query + description: *pagination_before_param_description + schema: + type: string + - name: filter + in: query + description: "Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`." + schema: + type: string + enum: ["in_progress", "completed", "failed", "cancelled"] + x-ms-enum: + name: ListVectorStoreFilesFilter + modelAsString: true + values: + - value: in_progress + - value: completed + - value: failed + - value: cancelled + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/listVectorStoreFilesResponse" + x-ms-examples: + List vector store files in a batch.: + $ref: ./examples/list_vector_store_file_batch.yaml + +components: + schemas: + errorResponse: + type: object + properties: + error: + $ref: "#/components/schemas/error" + errorBase: + type: object + properties: + code: + type: string + message: + type: string + error: + type: object + allOf: + - $ref: "#/components/schemas/errorBase" + properties: + param: + type: string + type: + type: string + inner_error: + $ref: "#/components/schemas/innerError" + innerError: + description: Inner error with additional details. + type: object + properties: + code: + $ref: "#/components/schemas/innerErrorCode" + content_filter_results: + $ref: "#/components/schemas/contentFilterPromptResults" + innerErrorCode: + description: Error codes for the inner error object. + enum: + - ResponsibleAIPolicyViolation + type: string + x-ms-enum: + name: InnerErrorCode + modelAsString: true + values: + - value: ResponsibleAIPolicyViolation + description: The prompt violated one of more content filter rules. + dalleErrorResponse: + type: object + properties: + error: + $ref: "#/components/schemas/dalleError" + dalleError: + type: object + allOf: + - $ref: "#/components/schemas/errorBase" + properties: + param: + type: string + type: + type: string + inner_error: + $ref: "#/components/schemas/dalleInnerError" + dalleInnerError: + description: Inner error with additional details. + type: object + properties: + code: + $ref: "#/components/schemas/innerErrorCode" + content_filter_results: + $ref: "#/components/schemas/dalleFilterResults" + revised_prompt: + type: string + description: The prompt that was used to generate the image, if there was any revision to the prompt. + contentFilterResultBase: + type: object + properties: + filtered: + type: boolean + required: + - filtered + contentFilterSeverityResult: + type: object + allOf: + - $ref: "#/components/schemas/contentFilterResultBase" + - properties: + severity: + type: string + enum: + - safe + - low + - medium + - high + x-ms-enum: + name: ContentFilterSeverity + modelAsString: true + values: + - value: safe + description: General content or related content in generic or non-harmful contexts. + - value: low + description: Harmful content at a low intensity and risk level. + - value: medium + description: Harmful content at a medium intensity and risk level. + - value: high + description: Harmful content at a high intensity and risk level. + required: + - severity + - filtered + contentFilterDetectedResult: + type: object + allOf: + - $ref: "#/components/schemas/contentFilterResultBase" + - properties: + detected: + type: boolean + required: + - detected + - filtered + contentFilterDetectedWithCitationResult: + type: object + allOf: + - $ref: "#/components/schemas/contentFilterDetectedResult" + - properties: + citation: + type: object + properties: + URL: + type: string + license: + type: string + required: + - detected + - filtered + contentFilterIdResult: + type: object + allOf: + - $ref: "#/components/schemas/contentFilterResultBase" + - properties: + id: + type: string + required: + - id + - filtered + contentFilterResultsBase: + type: object + description: Information about the content filtering results. + properties: + sexual: + $ref: "#/components/schemas/contentFilterSeverityResult" + violence: + $ref: "#/components/schemas/contentFilterSeverityResult" + hate: + $ref: "#/components/schemas/contentFilterSeverityResult" + self_harm: + $ref: "#/components/schemas/contentFilterSeverityResult" + profanity: + $ref: "#/components/schemas/contentFilterDetectedResult" + custom_blocklists: + $ref: "#/components/schemas/contentFilterDetailedResults" + error: + $ref: "#/components/schemas/errorBase" + contentFilterPromptResults: + type: object + description: Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id. + allOf: + - $ref: "#/components/schemas/contentFilterResultsBase" + - properties: + jailbreak: + $ref: "#/components/schemas/contentFilterDetectedResult" + indirect_attack: + $ref: "#/components/schemas/contentFilterDetectedResult" + contentFilterChoiceResults: + type: object + description: Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about third party text and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id. + allOf: + - $ref: "#/components/schemas/contentFilterResultsBase" + - properties: + protected_material_text: + $ref: "#/components/schemas/contentFilterDetectedResult" + - properties: + protected_material_code: + $ref: "#/components/schemas/contentFilterDetectedWithCitationResult" + contentFilterDetailedResults: + type: object + description: Content filtering results with a detail of content filter ids for the filtered segments. + allOf: + - $ref: "#/components/schemas/contentFilterResultBase" + - properties: + details: + items: + $ref: "#/components/schemas/contentFilterIdResult" + type: array + required: + - filtered + - details + promptFilterResult: + type: object + description: Content filtering results for a single prompt in the request. + properties: + prompt_index: + type: integer + content_filter_results: + $ref: "#/components/schemas/contentFilterPromptResults" + promptFilterResults: + type: array + description: Content filtering results for zero or more prompts in the request. In a streaming request, results for different prompts may arrive at different times or in different orders. + items: + $ref: "#/components/schemas/promptFilterResult" + dalleContentFilterResults: + type: object + description: Information about the content filtering results. + properties: + sexual: + $ref: "#/components/schemas/contentFilterSeverityResult" + violence: + $ref: "#/components/schemas/contentFilterSeverityResult" + hate: + $ref: "#/components/schemas/contentFilterSeverityResult" + self_harm: + $ref: "#/components/schemas/contentFilterSeverityResult" + dalleFilterResults: + type: object + description: Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id. + allOf: + - $ref: "#/components/schemas/dalleContentFilterResults" + - properties: + profanity: + $ref: "#/components/schemas/contentFilterDetectedResult" + jailbreak: + $ref: "#/components/schemas/contentFilterDetectedResult" + custom_blocklists: + $ref: "#/components/schemas/contentFilterDetailedResults" + chatCompletionsRequestCommon: + type: object + properties: + temperature: + description: |- + What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. + We generally recommend altering this or `top_p` but not both. + type: number + minimum: 0 + maximum: 2 + default: 1 + example: 1 + nullable: true + top_p: + description: |- + An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. + We generally recommend altering this or `temperature` but not both. + type: number + minimum: 0 + maximum: 1 + default: 1 + example: 1 + nullable: true + stream: + description: "If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a `data: [DONE]` message." + type: boolean + nullable: true + default: false + stop: + description: Up to 4 sequences where the API will stop generating further tokens. + oneOf: + - type: string + nullable: true + - type: array + items: + type: string + nullable: false + minItems: 1 + maxItems: 4 + description: Array minimum size of 1 and maximum of 4 + default: null + max_tokens: + description: | + The maximum number of tokens allowed for the generated answer. By default, the number of tokens the model can return will be (4096 - prompt tokens). + + This value is now deprecated in favor of `max_completion_tokens`, and is not compatible with o1 series models. + type: integer + default: 4096 + max_completion_tokens: + description: | + An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens. + + type: integer + nullable: true + presence_penalty: + description: Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. + type: number + default: 0 + minimum: -2 + maximum: 2 + frequency_penalty: + description: Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. + type: number + default: 0 + minimum: -2 + maximum: 2 + logit_bias: + description: Modify the likelihood of specified tokens appearing in the completion. Accepts a json object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. + type: object + nullable: true + user: + description: A unique identifier representing your end-user, which can help Azure OpenAI to monitor and detect abuse. + type: string + example: user-1234 + nullable: false + createCompletionRequest: + type: object + properties: + prompt: + description: &completions_prompt_description | + The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays. + + Note that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document. + default: "<|endoftext|>" + nullable: true + oneOf: + - type: string + default: "" + example: "This is a test." + - type: array + items: + type: string + default: "" + example: "This is a test." + best_of: + type: integer + default: 1 + minimum: 0 + maximum: 20 + nullable: true + description: &completions_best_of_description | + Generates `best_of` completions server-side and returns the "best" (the one with the highest log probability per token). Results cannot be streamed. + + When used with `n`, `best_of` controls the number of candidate completions and `n` specifies how many to return – `best_of` must be greater than `n`. + + **Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`. + echo: + type: boolean + default: false + nullable: true + description: &completions_echo_description > + Echo back the prompt in addition to the completion + frequency_penalty: + type: number + default: 0 + minimum: -2 + maximum: 2 + nullable: true + description: &completions_frequency_penalty_description | + Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. + + logit_bias: &completions_logit_bias + type: object + x-oaiTypeLabel: map + default: null + nullable: true + additionalProperties: + type: integer + description: &completions_logit_bias_description | + Modify the likelihood of specified tokens appearing in the completion. + + Accepts a JSON object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. You can use this [tokenizer tool](https://platform.openai.com/tokenizer?view=bpe) to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. + + As an example, you can pass `{"50256": -100}` to prevent the <|endoftext|> token from being generated. + logprobs: &completions_logprobs_configuration + type: integer + minimum: 0 + maximum: 5 + default: null + nullable: true + description: &completions_logprobs_description | + Include the log probabilities on the `logprobs` most likely output tokens, as well the chosen tokens. For example, if `logprobs` is 5, the API will return a list of the 5 most likely tokens. The API will always return the `logprob` of the sampled token, so there may be up to `logprobs+1` elements in the response. + + The maximum value for `logprobs` is 5. + max_tokens: + type: integer + minimum: 0 + default: 16 + example: 16 + nullable: true + description: &completions_max_tokens_description | + The maximum number of [tokens](https://platform.openai.com/tokenizer) that can be generated in the completion. + + The token count of your prompt plus `max_tokens` cannot exceed the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens. + n: + type: integer + minimum: 1 + maximum: 128 + default: 1 + example: 1 + nullable: true + description: &completions_completions_description | + How many completions to generate for each prompt. + + **Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`. + presence_penalty: + type: number + default: 0 + minimum: -2 + maximum: 2 + nullable: true + description: &completions_presence_penalty_description | + Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. + seed: &completions_seed_param + type: integer + minimum: -9223372036854775808 + maximum: 9223372036854775807 + nullable: true + description: | + If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result. + + Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend. + stop: + description: &completions_stop_description > + Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence. + default: null + nullable: true + oneOf: + - type: string + default: <|endoftext|> + example: "\n" + nullable: true + - type: array + minItems: 1 + maxItems: 4 + items: + type: string + example: '["\n"]' + stream: + description: > + Whether to stream back partial progress. If set, tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) + as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions). + type: boolean + nullable: true + default: false + suffix: + description: | + The suffix that comes after a completion of inserted text. + + This parameter is only supported for `gpt-3.5-turbo-instruct`. + default: null + nullable: true + type: string + example: "test." + stream_options: + $ref: "#/components/schemas/chatCompletionStreamOptions" + temperature: + type: number + minimum: 0 + maximum: 2 + default: 1 + example: 1 + nullable: true + description: &completions_temperature_description | + What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. + + We generally recommend altering this or `top_p` but not both. + top_p: + type: number + minimum: 0 + maximum: 1 + default: 1 + example: 1 + nullable: true + description: &completions_top_p_description | + An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. + + We generally recommend altering this or `temperature` but not both. + user: &end_user_param_configuration + type: string + example: user-1234 + description: | + A unique identifier representing your end-user, which can help to monitor and detect abuse. + required: + - prompt + + createCompletionResponse: + type: object + description: | + Represents a completion response from the API. Note: both the streamed and non-streamed response objects share the same shape (unlike the chat endpoint). + properties: + id: + type: string + description: A unique identifier for the completion. + choices: + type: array + description: The list of completion choices the model generated for the input prompt. + items: + type: object + required: + - finish_reason + - index + - logprobs + - text + properties: + finish_reason: + type: string + description: &completion_finish_reason_description | + The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, + `length` if the maximum number of tokens specified in the request was reached, + or `content_filter` if content was omitted due to a flag from our content filters. + enum: ["stop", "length", "content_filter"] + index: + type: integer + logprobs: + type: object + nullable: true + properties: + text_offset: + type: array + items: + type: integer + token_logprobs: + type: array + items: + type: number + tokens: + type: array + items: + type: string + top_logprobs: + type: array + items: + type: object + additionalProperties: + type: number + text: + type: string + content_filter_results: + $ref: "#/components/schemas/contentFilterChoiceResults" + created: + type: integer + description: The Unix timestamp (in seconds) of when the completion was created. + model: + type: string + description: The model used for completion. + prompt_filter_results: + $ref: "#/components/schemas/promptFilterResults" + system_fingerprint: + type: string + description: | + This fingerprint represents the backend configuration that the model runs with. + + Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. + object: + type: string + description: The object type, which is always "text_completion" + enum: [text_completion] + usage: + $ref: "#/components/schemas/completionUsage" + required: + - id + - object + - created + - model + - choices + + createChatCompletionRequest: + type: object + allOf: + - $ref: "#/components/schemas/chatCompletionsRequestCommon" + - properties: + messages: + description: A list of messages comprising the conversation so far. [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_format_inputs_to_ChatGPT_models.ipynb). + type: array + minItems: 1 + items: + $ref: "#/components/schemas/chatCompletionRequestMessage" + data_sources: + type: array + description: |2- + The configuration entries for Azure OpenAI chat extensions that use them. + This additional specification is only compatible with Azure OpenAI. + items: + $ref: "#/components/schemas/azureChatExtensionConfiguration" + frequency_penalty: + type: number + default: 0 + minimum: -2 + maximum: 2 + nullable: true + description: *completions_frequency_penalty_description + logit_bias: + type: object + default: null + nullable: true + additionalProperties: + type: integer + description: | + Modify the likelihood of specified tokens appearing in the completion. + + Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. + logprobs: + description: Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`. + type: boolean + default: false + nullable: true + top_logprobs: + description: An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used. + type: integer + minimum: 0 + maximum: 20 + nullable: true + max_tokens: + description: | + The maximum number of [tokens](/tokenizer) that can be generated in the chat completion. + + The total length of input tokens and generated tokens is limited by the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens. + type: integer + nullable: true + n: + type: integer + minimum: 1 + maximum: 128 + default: 1 + example: 1 + nullable: true + description: How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep `n` as `1` to minimize costs. + presence_penalty: + type: number + default: 0 + minimum: -2 + maximum: 2 + nullable: true + description: *completions_presence_penalty_description + response_format: + description: | + An object specifying the format that the model must output. Compatible with [GPT-4o](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models), [GPT-4o mini](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models), [GPT-4 Turbo](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models) and all [GPT-3.5](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-35) Turbo models newer than `gpt-3.5-turbo-1106`. + + Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured Outputs which guarantees the model will match your supplied JSON schema. + + Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is valid JSON. + + **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. + oneOf: + - $ref: "#/components/schemas/ResponseFormatText" + - $ref: "#/components/schemas/ResponseFormatJsonObject" + - $ref: "#/components/schemas/ResponseFormatJsonSchema" + x-oaiExpandable: true + seed: + type: integer + minimum: -9223372036854775808 + maximum: 9223372036854775807 + nullable: true + description: | + This feature is in Beta. + If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result. + Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend. + stop: + description: | + Up to 4 sequences where the API will stop generating further tokens. + default: null + oneOf: + - type: string + nullable: true + - type: array + minItems: 1 + maxItems: 4 + items: + type: string + stream: + description: > + If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) + as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions). + type: boolean + nullable: true + default: false + stream_options: + $ref: "#/components/schemas/chatCompletionStreamOptions" + temperature: + type: number + minimum: 0 + maximum: 2 + default: 1 + example: 1 + nullable: true + description: *completions_temperature_description + top_p: + type: number + minimum: 0 + maximum: 1 + default: 1 + example: 1 + nullable: true + description: *completions_top_p_description + tools: + type: array + description: > + A list of tools the model may call. Currently, only functions are supported as a tool. + Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported. + items: + $ref: "#/components/schemas/chatCompletionTool" + tool_choice: + $ref: "#/components/schemas/chatCompletionToolChoiceOption" + function_call: + deprecated: true + description: | + Deprecated in favor of `tool_choice`. + + Controls which (if any) function is called by the model. + `none` means the model will not call a function and instead generates a message. + `auto` means the model can pick between generating a message or calling a function. + Specifying a particular function via `{"name": "my_function"}` forces the model to call that function. + + `none` is the default when no functions are present. `auto` is the default if functions are present. + oneOf: + - type: string + description: > + `none` means the model will not call a function and instead generates a message. + `auto` means the model can pick between generating a message or calling a function. + enum: [none, auto] + - $ref: "#/components/schemas/chatCompletionFunctionCallOption" + x-oaiExpandable: true + functions: + deprecated: true + description: | + Deprecated in favor of `tools`. + + A list of functions the model may generate JSON inputs for. + type: array + minItems: 1 + maxItems: 128 + items: + $ref: "#/components/schemas/chatCompletionFunctions" + user: *end_user_param_configuration + + required: + - messages + + chatCompletionFunctions: + type: object + deprecated: true + properties: + description: + type: string + description: A description of what the function does, used by the model to choose when and how to call the function. + name: + type: string + description: The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. + parameters: + $ref: "#/components/schemas/FunctionParameters" + required: + - name + + chatCompletionFunctionCallOption: + type: object + description: > + Specifying a particular function via `{"name": "my_function"}` forces the model to call that function. + properties: + name: + type: string + description: The name of the function to call. + required: + - name + + chatCompletionFunctionParameters: + type: object + description: The parameters the functions accepts, described as a JSON Schema object. See the [guide/](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. + additionalProperties: true + + chatCompletionRequestMessage: + oneOf: + - $ref: "#/components/schemas/chatCompletionRequestSystemMessage" + - $ref: "#/components/schemas/chatCompletionRequestUserMessage" + - $ref: "#/components/schemas/chatCompletionRequestAssistantMessage" + - $ref: "#/components/schemas/chatCompletionRequestToolMessage" + - $ref: "#/components/schemas/chatCompletionRequestFunctionMessage" + + chatCompletionRequestSystemMessage: + type: object + title: System message + properties: + content: + description: The contents of the system message. + oneOf: + - type: string + description: The contents of the system message. + title: Text content + - type: array + description: An array of content parts with a defined type. For system messages, only type `text` is supported. + title: Array of content parts + items: + $ref: "#/components/schemas/chatCompletionRequestSystemMessageContentPart" + minItems: 1 + role: + type: string + enum: ["system"] + description: The role of the messages author, in this case `system`. + name: + type: string + description: An optional name for the participant. Provides the model information to differentiate between participants of the same role. + required: + - content + - role + + chatCompletionRequestUserMessage: + type: object + title: User message + properties: + content: + description: | + The contents of the user message. + oneOf: + - type: string + description: The text contents of the message. + title: Text content + - type: array + description: An array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. Image input is only supported when using the `gpt-4o` model. + title: Array of content parts + items: + $ref: "#/components/schemas/chatCompletionRequestUserMessageContentPart" + minItems: 1 + x-oaiExpandable: true + role: + type: string + enum: ["user"] + description: The role of the messages author, in this case `user`. + name: + type: string + description: An optional name for the participant. Provides the model information to differentiate between participants of the same role. + required: + - content + - role + + chatCompletionRequestAssistantMessage: + type: object + title: Assistant message + properties: + content: + nullable: true + oneOf: + - type: string + description: The contents of the assistant message. + title: Text content + - type: array + description: An array of content parts with a defined type. Can be one or more of type `text`, or exactly one of type `refusal`. + title: Array of content parts + items: + $ref: "#/components/schemas/chatCompletionRequestAssistantMessageContentPart" + minItems: 1 + description: | + The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified. + refusal: + nullable: true + type: string + description: The refusal message by the assistant. + role: + type: string + enum: ["assistant"] + description: The role of the messages author, in this case `assistant`. + name: + type: string + description: An optional name for the participant. Provides the model information to differentiate between participants of the same role. + tool_calls: + $ref: "#/components/schemas/chatCompletionMessageToolCalls" + function_call: + type: object + deprecated: true + description: "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model." + nullable: true + properties: + arguments: + type: string + description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. + name: + type: string + description: The name of the function to call. + required: + - arguments + - name + required: + - role + + chatCompletionRequestToolMessage: + type: object + title: Tool message + properties: + role: + type: string + enum: ["tool"] + description: The role of the messages author, in this case `tool`. + content: + oneOf: + - type: string + description: The contents of the tool message. + title: Text content + - type: array + description: An array of content parts with a defined type. For tool messages, only type `text` is supported. + title: Array of content parts + items: + $ref: "#/components/schemas/chatCompletionRequestToolMessageContentPart" + minItems: 1 + description: The contents of the tool message. + tool_call_id: + type: string + description: Tool call that this message is responding to. + required: + - role + - content + - tool_call_id + + chatCompletionRequestFunctionMessage: + type: object + title: Function message + deprecated: true + properties: + role: + type: string + enum: ["function"] + description: The role of the messages author, in this case `function`. + content: + nullable: true + type: string + description: The contents of the function message. + name: + type: string + description: The name of the function to call. + required: + - role + - content + - name + + chatCompletionRequestSystemMessageContentPart: + oneOf: + - $ref: "#/components/schemas/chatCompletionRequestMessageContentPartText" + + chatCompletionRequestUserMessageContentPart: + oneOf: + - $ref: "#/components/schemas/chatCompletionRequestMessageContentPartText" + - $ref: "#/components/schemas/chatCompletionRequestMessageContentPartImage" + + chatCompletionRequestAssistantMessageContentPart: + oneOf: + - $ref: "#/components/schemas/chatCompletionRequestMessageContentPartText" + - $ref: "#/components/schemas/chatCompletionRequestMessageContentPartRefusal" + + chatCompletionRequestToolMessageContentPart: + oneOf: + - $ref: "#/components/schemas/chatCompletionRequestMessageContentPartText" + + chatCompletionRequestMessageContentPartText: + type: object + title: Text content part + properties: + type: + type: string + enum: ["text"] + description: The type of the content part. + text: + type: string + description: The text content. + required: + - type + - text + + chatCompletionRequestMessageContentPartImage: + type: object + title: Image content part + properties: + type: + type: string + enum: ["image_url"] + description: The type of the content part. + image_url: + type: object + properties: + url: + type: string + description: Either a URL of the image or the base64 encoded image data. + format: uri + detail: + type: string + description: Specifies the detail level of the image. Learn more in the [Vision guide](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/gpt-with-vision?tabs=rest%2Csystem-assigned%2Cresource#detail-parameter-settings-in-image-processing-low-high-auto). + enum: ["auto", "low", "high"] + default: "auto" + required: + - url + required: + - type + - image_url + + chatCompletionRequestMessageContentPartRefusal: + type: object + title: Refusal content part + properties: + type: + type: string + enum: ["refusal"] + description: The type of the content part. + refusal: + type: string + description: The refusal message generated by the model. + required: + - type + - refusal + azureChatExtensionConfiguration: + required: + - type + type: object + properties: + type: + $ref: "#/components/schemas/azureChatExtensionType" + description: |2- + A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat + completions request that should use Azure OpenAI chat extensions to augment the response behavior. + The use of this configuration is compatible only with Azure OpenAI. + discriminator: + propertyName: type + mapping: + azure_search: "#/components/schemas/azureSearchChatExtensionConfiguration" + azure_cosmos_db: "#/components/schemas/azureCosmosDBChatExtensionConfiguration" + elasticsearch: "#/components/schemas/elasticsearchChatExtensionConfiguration" + mongo_db: "#/components/schemas/mongoDBChatExtensionConfiguration" + pinecone: "#/components/schemas/pineconeChatExtensionConfiguration" + azureChatExtensionType: + type: string + description: |2- + A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat + completions request that should use Azure OpenAI chat extensions to augment the response behavior. + The use of this configuration is compatible only with Azure OpenAI. + enum: + - azure_search + - azure_cosmos_db + - elasticsearch + - mongo_db + - pinecone + x-ms-enum: + name: AzureChatExtensionType + modelAsString: true + values: + - name: azureSearch + value: azure_search + description: Represents the use of Azure Search as an Azure OpenAI chat extension. + - name: azureCosmosDB + value: azure_cosmos_db + description: Represents the use of Azure Cosmos DB as an Azure OpenAI chat extension. + - name: elasticsearch + value: elasticsearch + description: Represents the use of Elasticsearch® index as an Azure OpenAI chat extension. + - name: mongoDB + value: mongo_db + description: Represents the use of Mongo DB as an Azure OpenAI chat extension. + - name: pinecone + value: pinecone + description: Represents the use of Pinecone index as an Azure OpenAI chat extension. + azureSearchChatExtensionConfiguration: + required: + - parameters + description: |- + A specific representation of configurable options for Azure Search when using it as an Azure OpenAI chat + extension. + allOf: + - $ref: "#/components/schemas/azureChatExtensionConfiguration" + - properties: + parameters: + $ref: "#/components/schemas/azureSearchChatExtensionParameters" + x-ms-discriminator-value: azure_search + azureSearchChatExtensionParameters: + required: + - authentication + - endpoint + - index_name + type: object + properties: + authentication: + oneOf: + - $ref: "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + - $ref: "#/components/schemas/onYourDataSystemAssignedManagedIdentityAuthenticationOptions" + - $ref: "#/components/schemas/onYourDataUserAssignedManagedIdentityAuthenticationOptions" + - $ref: "#/components/schemas/onYourDataAccessTokenAuthenticationOptions" + top_n_documents: + type: integer + description: The configured top number of documents to feature for the configured query. + format: int32 + max_search_queries: + type: integer + description: The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send. + format: int32 + allow_partial_result: + type: boolean + default: false + description: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails. + in_scope: + type: boolean + description: Whether queries should be restricted to use of indexed data. + strictness: + maximum: 5 + minimum: 1 + type: integer + description: The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer. + format: int32 + endpoint: + type: string + description: The absolute endpoint path for the Azure Search resource to use. + format: uri + index_name: + type: string + description: The name of the index to use as available in the referenced Azure Search resource. + fields_mapping: + $ref: "#/components/schemas/azureSearchIndexFieldMappingOptions" + query_type: + $ref: "#/components/schemas/azureSearchQueryType" + semantic_configuration: + type: string + description: The additional semantic configuration for the query. + filter: + type: string + description: Search filter. + embedding_dependency: + oneOf: + - $ref: "#/components/schemas/onYourDataEndpointVectorizationSource" + - $ref: "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + - $ref: "#/components/schemas/onYourDataIntegratedVectorizationSource" + include_contexts: + type: array + description: The included properties of the output context. If not specified, the default value is `citations` and `intent`. + items: + $ref: "#/components/schemas/onYourDataContextProperty" + description: Parameters for Azure Search when used as an Azure OpenAI chat extension. + azureSearchIndexFieldMappingOptions: + type: object + properties: + title_field: + type: string + description: The name of the index field to use as a title. + url_field: + type: string + description: The name of the index field to use as a URL. + filepath_field: + type: string + description: The name of the index field to use as a filepath. + content_fields: + type: array + description: The names of index fields that should be treated as content. + items: + type: string + content_fields_separator: + type: string + description: The separator pattern that content fields should use. + vector_fields: + type: array + description: The names of fields that represent vector data. + items: + type: string + image_vector_fields: + type: array + description: The names of fields that represent image vector data. + items: + type: string + description: Optional settings to control how fields are processed when using a configured Azure Search resource. + azureSearchQueryType: + type: string + description: The type of Azure Search retrieval query that should be executed when using it as an Azure OpenAI chat extension. + enum: + - simple + - semantic + - vector + - vector_simple_hybrid + - vector_semantic_hybrid + x-ms-enum: + name: AzureSearchQueryType + modelAsString: true + values: + - name: simple + value: simple + description: Represents the default, simple query parser. + - name: semantic + value: semantic + description: Represents the semantic query parser for advanced semantic modeling. + - name: vector + value: vector + description: Represents vector search over computed data. + - name: vectorSimpleHybrid + value: vector_simple_hybrid + description: Represents a combination of the simple query strategy with vector data. + - name: vectorSemanticHybrid + value: vector_semantic_hybrid + description: Represents a combination of semantic search and vector data querying. + azureCosmosDBChatExtensionConfiguration: + required: + - parameters + description: |- + A specific representation of configurable options for Azure Cosmos DB when using it as an Azure OpenAI chat + extension. + allOf: + - $ref: "#/components/schemas/azureChatExtensionConfiguration" + - properties: + parameters: + $ref: "#/components/schemas/azureCosmosDBChatExtensionParameters" + x-ms-discriminator-value: azure_cosmos_db + azureCosmosDBChatExtensionParameters: + required: + - authentication + - container_name + - database_name + - embedding_dependency + - fields_mapping + - index_name + type: object + properties: + authentication: + $ref: "#/components/schemas/onYourDataConnectionStringAuthenticationOptions" + top_n_documents: + type: integer + description: The configured top number of documents to feature for the configured query. + format: int32 + max_search_queries: + type: integer + description: The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send. + format: int32 + allow_partial_result: + type: boolean + default: false + description: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails. + in_scope: + type: boolean + description: Whether queries should be restricted to use of indexed data. + strictness: + maximum: 5 + minimum: 1 + type: integer + description: The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer. + format: int32 + database_name: + type: string + description: The MongoDB vCore database name to use with Azure Cosmos DB. + container_name: + type: string + description: The name of the Azure Cosmos DB resource container. + index_name: + type: string + description: The MongoDB vCore index name to use with Azure Cosmos DB. + fields_mapping: + $ref: "#/components/schemas/azureCosmosDBFieldMappingOptions" + embedding_dependency: + oneOf: + - $ref: "#/components/schemas/onYourDataEndpointVectorizationSource" + - $ref: "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + include_contexts: + type: array + description: The included properties of the output context. If not specified, the default value is `citations` and `intent`. + items: + $ref: "#/components/schemas/onYourDataContextProperty" + description: |- + Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for + MongoDB vCore. + azureCosmosDBFieldMappingOptions: + required: + - content_fields + - vector_fields + type: object + properties: + title_field: + type: string + description: The name of the index field to use as a title. + url_field: + type: string + description: The name of the index field to use as a URL. + filepath_field: + type: string + description: The name of the index field to use as a filepath. + content_fields: + type: array + description: The names of index fields that should be treated as content. + items: + type: string + content_fields_separator: + type: string + description: The separator pattern that content fields should use. + vector_fields: + type: array + description: The names of fields that represent vector data. + items: + type: string + description: Optional settings to control how fields are processed when using a configured Azure Cosmos DB resource. + elasticsearchChatExtensionConfiguration: + required: + - parameters + description: |- + A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat + extension. + allOf: + - $ref: "#/components/schemas/azureChatExtensionConfiguration" + - properties: + parameters: + $ref: "#/components/schemas/elasticsearchChatExtensionParameters" + x-ms-discriminator-value: elasticsearch + elasticsearchChatExtensionParameters: + required: + - authentication + - endpoint + - index_name + type: object + properties: + authentication: + oneOf: + - $ref: "#/components/schemas/onYourDataKeyAndKeyIdAuthenticationOptions" + - $ref: "#/components/schemas/onYourDataEncodedApiKeyAuthenticationOptions" + top_n_documents: + type: integer + description: The configured top number of documents to feature for the configured query. + format: int32 + max_search_queries: + type: integer + description: The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send. + format: int32 + allow_partial_result: + type: boolean + default: false + description: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails. + in_scope: + type: boolean + description: Whether queries should be restricted to use of indexed data. + strictness: + maximum: 5 + minimum: 1 + type: integer + description: The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer. + format: int32 + endpoint: + type: string + description: The endpoint of Elasticsearch®. + format: uri + index_name: + type: string + description: The index name of Elasticsearch®. + fields_mapping: + $ref: "#/components/schemas/elasticsearchIndexFieldMappingOptions" + query_type: + $ref: "#/components/schemas/elasticsearchQueryType" + embedding_dependency: + oneOf: + - $ref: "#/components/schemas/onYourDataEndpointVectorizationSource" + - $ref: "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + - $ref: "#/components/schemas/onYourDataModelIdVectorizationSource" + include_contexts: + type: array + description: The included properties of the output context. If not specified, the default value is `citations` and `intent`. + items: + $ref: "#/components/schemas/onYourDataContextProperty" + description: "Parameters to use when configuring Elasticsearch® as an Azure OpenAI chat extension. " + elasticsearchIndexFieldMappingOptions: + type: object + properties: + title_field: + type: string + description: The name of the index field to use as a title. + url_field: + type: string + description: The name of the index field to use as a URL. + filepath_field: + type: string + description: The name of the index field to use as a filepath. + content_fields: + type: array + description: The names of index fields that should be treated as content. + items: + type: string + content_fields_separator: + type: string + description: The separator pattern that content fields should use. + vector_fields: + type: array + description: The names of fields that represent vector data. + items: + type: string + description: Optional settings to control how fields are processed when using a configured Elasticsearch® resource. + elasticsearchQueryType: + type: string + description: The type of Elasticsearch® retrieval query that should be executed when using it as an Azure OpenAI chat extension. + enum: + - simple + - vector + x-ms-enum: + name: ElasticsearchQueryType + modelAsString: true + values: + - name: simple + value: simple + description: Represents the default, simple query parser. + - name: vector + value: vector + description: Represents vector search over computed data. + mongoDBChatExtensionConfiguration: + required: + - parameters + description: |- + A specific representation of configurable options for Mongo DB when using it as an Azure OpenAI chat + extension. + allOf: + - $ref: "#/components/schemas/azureChatExtensionConfiguration" + - properties: + parameters: + $ref: "#/components/schemas/mongoDBChatExtensionParameters" + x-ms-discriminator-value: mongo_db + mongoDBChatExtensionParameters: + required: + - authentication + - app_name + - collection_name + - database_name + - endpoint + - embedding_dependency + - fields_mapping + - index_name + type: object + properties: + authentication: + $ref: "#/components/schemas/onYourDataUsernameAndPasswordAuthenticationOptions" + top_n_documents: + type: integer + description: The configured top number of documents to feature for the configured query. + format: int32 + max_search_queries: + type: integer + description: The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send. + format: int32 + allow_partial_result: + type: boolean + default: false + description: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails. + in_scope: + type: boolean + description: Whether queries should be restricted to use of indexed data. + strictness: + maximum: 5 + minimum: 1 + type: integer + description: The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer. + format: int32 + endpoint: + type: string + description: The name of the Mongo DB cluster endpoint. + database_name: + type: string + description: The name of the Mongo DB database. + collection_name: + type: string + description: The name of the Mongo DB Collection. + app_name: + type: string + description: The name of the Mongo DB Application. + index_name: + type: string + description: The The name of the Mongo DB index. + fields_mapping: + $ref: "#/components/schemas/mongoDBFieldMappingOptions" + embedding_dependency: + oneOf: + - $ref: "#/components/schemas/onYourDataEndpointVectorizationSource" + - $ref: "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + include_contexts: + type: array + description: The included properties of the output context. If not specified, the default value is `citations` and `intent`. + items: + $ref: "#/components/schemas/onYourDataContextProperty" + description: |- + Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Mongo DB. + + mongoDBFieldMappingOptions: + required: + - content_fields + - vector_fields + type: object + properties: + title_field: + type: string + description: The name of the index field to use as a title. + url_field: + type: string + description: The name of the index field to use as a URL. + filepath_field: + type: string + description: The name of the index field to use as a filepath. + content_fields: + type: array + description: The names of index fields that should be treated as content. + items: + type: string + content_fields_separator: + type: string + description: The separator pattern that content fields should use. + vector_fields: + type: array + description: The names of fields that represent vector data. + items: + type: string + description: Optional settings to control how fields are processed when using a configured Mongo DB resource. + + pineconeChatExtensionConfiguration: + required: + - parameters + description: |- + A specific representation of configurable options for Pinecone when using it as an Azure OpenAI chat + extension. + allOf: + - $ref: "#/components/schemas/azureChatExtensionConfiguration" + - properties: + parameters: + $ref: "#/components/schemas/pineconeChatExtensionParameters" + x-ms-discriminator-value: pinecone + pineconeChatExtensionParameters: + required: + - authentication + - embedding_dependency + - environment + - fields_mapping + - index_name + type: object + properties: + authentication: + $ref: "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + top_n_documents: + type: integer + description: The configured top number of documents to feature for the configured query. + format: int32 + max_search_queries: + type: integer + description: The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send. + format: int32 + allow_partial_result: + type: boolean + default: false + description: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails. + in_scope: + type: boolean + description: Whether queries should be restricted to use of indexed data. + strictness: + maximum: 5 + minimum: 1 + type: integer + description: The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer. + format: int32 + environment: + type: string + description: The environment name of Pinecone. + index_name: + type: string + description: The name of the Pinecone database index. + fields_mapping: + $ref: "#/components/schemas/pineconeFieldMappingOptions" + embedding_dependency: + $ref: "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + include_contexts: + type: array + description: The included properties of the output context. If not specified, the default value is `citations` and `intent`. + items: + $ref: "#/components/schemas/onYourDataContextProperty" + description: Parameters for configuring Azure OpenAI Pinecone chat extensions. + pineconeFieldMappingOptions: + required: + - content_fields + type: object + properties: + title_field: + type: string + description: The name of the index field to use as a title. + url_field: + type: string + description: The name of the index field to use as a URL. + filepath_field: + type: string + description: The name of the index field to use as a filepath. + content_fields: + type: array + description: The names of index fields that should be treated as content. + items: + type: string + content_fields_separator: + type: string + description: The separator pattern that content fields should use. + description: Optional settings to control how fields are processed when using a configured Pinecone resource. + onYourDataAuthenticationOptions: + required: + - type + type: object + properties: + type: + $ref: "#/components/schemas/onYourDataAuthenticationType" + description: The authentication options for Azure OpenAI On Your Data. + discriminator: + propertyName: type + mapping: + api_key: "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + connection_string: "#/components/schemas/onYourDataConnectionStringAuthenticationOptions" + key_and_key_id: "#/components/schemas/onYourDataKeyAndKeyIdAuthenticationOptions" + encoded_api_key: "#/components/schemas/onYourDataEncodedApiKeyAuthenticationOptions" + access_token: "#/components/schemas/onYourDataAccessTokenAuthenticationOptions" + system_assigned_managed_identity: "#/components/schemas/onYourDataSystemAssignedManagedIdentityAuthenticationOptions" + user_assigned_managed_identity: "#/components/schemas/onYourDataUserAssignedManagedIdentityAuthenticationOptions" + username_and_password: "#/components/schemas/onYourDataUsernameAndPasswordAuthenticationOptions" + onYourDataContextProperty: + type: string + description: The context property. + enum: + - citations + - intent + - all_retrieved_documents + x-ms-enum: + name: OnYourDataContextProperty + modelAsString: true + values: + - name: citations + value: citations + description: The `citations` property. + - name: intent + value: intent + description: The `intent` property. + - name: allRetrievedDocuments + value: all_retrieved_documents + description: The `all_retrieved_documents` property. + onYourDataAuthenticationType: + type: string + description: The authentication types supported with Azure OpenAI On Your Data. + enum: + - api_key + - connection_string + - key_and_key_id + - encoded_api_key + - access_token + - system_assigned_managed_identity + - user_assigned_managed_identity + - username_and_password + x-ms-enum: + name: OnYourDataAuthenticationType + modelAsString: true + values: + - name: apiKey + value: api_key + description: Authentication via API key. + - name: connectionString + value: connection_string + description: Authentication via connection string. + - name: keyAndKeyId + value: key_and_key_id + description: Authentication via key and key ID pair. + - name: encodedApiKey + value: encoded_api_key + description: Authentication via encoded API key. + - name: accessToken + value: access_token + description: Authentication via access token. + - name: systemAssignedManagedIdentity + value: system_assigned_managed_identity + description: Authentication via system-assigned managed identity. + - name: userAssignedManagedIdentity + value: user_assigned_managed_identity + description: Authentication via user-assigned managed identity. + - name: usernameAndPassword + value: username_and_password + description: Authentication via username and password. + onYourDataApiKeyAuthenticationOptions: + required: + - key + description: The authentication options for Azure OpenAI On Your Data when using an API key. + allOf: + - $ref: "#/components/schemas/onYourDataAuthenticationOptions" + - properties: + key: + type: string + description: The API key to use for authentication. + x-ms-discriminator-value: api_key + onYourDataConnectionStringAuthenticationOptions: + required: + - connection_string + description: The authentication options for Azure OpenAI On Your Data when using a connection string. + allOf: + - $ref: "#/components/schemas/onYourDataAuthenticationOptions" + - properties: + connection_string: + type: string + description: The connection string to use for authentication. + x-ms-discriminator-value: connection_string + onYourDataKeyAndKeyIdAuthenticationOptions: + required: + - key + - key_id + description: The authentication options for Azure OpenAI On Your Data when using an Elasticsearch key and key ID pair. + allOf: + - $ref: "#/components/schemas/onYourDataAuthenticationOptions" + - properties: + key: + type: string + description: The Elasticsearch key to use for authentication. + key_id: + type: string + description: The Elasticsearch key ID to use for authentication. + x-ms-discriminator-value: key_and_key_id + onYourDataEncodedApiKeyAuthenticationOptions: + required: + - encoded_api_key + description: The authentication options for Azure OpenAI On Your Data when using an Elasticsearch encoded API key. + allOf: + - $ref: "#/components/schemas/onYourDataAuthenticationOptions" + - properties: + encoded_api_key: + type: string + description: The Elasticsearch encoded API key to use for authentication. + x-ms-discriminator-value: encoded_api_key + onYourDataAccessTokenAuthenticationOptions: + required: + - access_token + description: The authentication options for Azure OpenAI On Your Data when using access token. + allOf: + - $ref: "#/components/schemas/onYourDataAuthenticationOptions" + - properties: + access_token: + type: string + description: The access token to use for authentication. + x-ms-discriminator-value: access_token + onYourDataSystemAssignedManagedIdentityAuthenticationOptions: + description: The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity. + allOf: + - $ref: "#/components/schemas/onYourDataAuthenticationOptions" + x-ms-discriminator-value: system_assigned_managed_identity + onYourDataUserAssignedManagedIdentityAuthenticationOptions: + required: + - managed_identity_resource_id + description: The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity. + allOf: + - $ref: "#/components/schemas/onYourDataAuthenticationOptions" + - properties: + managed_identity_resource_id: + type: string + description: The resource ID of the user-assigned managed identity to use for authentication. + x-ms-discriminator-value: user_assigned_managed_identity + onYourDataUsernameAndPasswordAuthenticationOptions: + required: + - username + - password + description: The authentication options for Azure OpenAI On Your Data when using a username and a password. + allOf: + - $ref: "#/components/schemas/onYourDataAuthenticationOptions" + - properties: + username: + type: string + description: The username to use for authentication. + password: + type: string + description: The password. to use for authentication. + x-ms-discriminator-value: username_and_password + onYourDataVectorizationSource: + required: + - type + type: object + properties: + type: + $ref: "#/components/schemas/onYourDataVectorizationSourceType" + description: An abstract representation of a vectorization source for Azure OpenAI On Your Data with vector search. + discriminator: + propertyName: type + mapping: + endpoint: "#/components/schemas/onYourDataEndpointVectorizationSource" + deployment_name: "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + integrated: "#/components/schemas/onYourDataIntegratedVectorizationSource" + model_id: "#/components/schemas/onYourDataModelIdVectorizationSource" + onYourDataVectorizationSourceType: + type: string + description: |- + Represents the available sources Azure OpenAI On Your Data can use to configure vectorization of data for use with + vector search. + enum: + - endpoint + - deployment_name + - integrated + - model_id + x-ms-enum: + name: OnYourDataVectorizationSourceType + modelAsString: true + values: + - name: endpoint + value: endpoint + description: Represents vectorization performed by public service calls to an Azure OpenAI embedding model. + - name: deploymentName + value: deployment_name + description: |- + Represents an Ada model deployment name to use. This model deployment must be in the same Azure OpenAI resource, but + On Your Data will use this model deployment via an internal call rather than a public one, which enables vector + search even in private networks. + - name: integrated + value: integrated + description: Represents the integrated vectorizer defined within the search resource. + - name: modelId + value: model_id + description: |- + Represents a specific embedding model ID as defined in the search service. + Currently only supported by Elasticsearch®. + onYourDataEndpointVectorizationSource: + required: + - authentication + - endpoint + description: |- + The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based + on a public Azure OpenAI endpoint call for embeddings. + allOf: + - $ref: "#/components/schemas/onYourDataVectorizationSource" + - properties: + endpoint: + type: string + description: Specifies the resource endpoint URL from which embeddings should be retrieved. It should be in the format of https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. The api-version query parameter is not allowed. + format: uri + authentication: + oneOf: + - $ref: "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + - $ref: "#/components/schemas/onYourDataAccessTokenAuthenticationOptions" + dimensions: + type: integer + description: The number of dimensions the embeddings should have. Only supported in `text-embedding-3` and later models. + format: int32 + x-ms-discriminator-value: endpoint + onYourDataDeploymentNameVectorizationSource: + required: + - deployment_name + description: |- + The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based + on an internal embeddings model deployment name in the same Azure OpenAI resource. + allOf: + - $ref: "#/components/schemas/onYourDataVectorizationSource" + - properties: + deployment_name: + type: string + description: Specifies the name of the model deployment to use for vectorization. This model deployment must be in the same Azure OpenAI resource, but On Your Data will use this model deployment via an internal call rather than a public one, which enables vector search even in private networks. + dimensions: + type: integer + description: The number of dimensions the embeddings should have. Only supported in `text-embedding-3` and later models. + format: int32 + x-ms-discriminator-value: deployment_name + onYourDataIntegratedVectorizationSource: + description: |- + Represents the integrated vectorizer defined within the search resource. + allOf: + - $ref: "#/components/schemas/onYourDataVectorizationSource" + x-ms-discriminator-value: integrated + onYourDataModelIdVectorizationSource: + required: + - model_id + description: |- + The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based + on a search service model ID. Currently only supported by Elasticsearch®. + allOf: + - $ref: "#/components/schemas/onYourDataVectorizationSource" + - properties: + model_id: + type: string + description: Specifies the model ID to use for vectorization. This model ID must be defined in the search service. + x-ms-discriminator-value: model_id + azureChatExtensionsMessageContext: + type: object + properties: + citations: + type: array + description: The data source retrieval result, used to generate the assistant message in the response. + items: + $ref: "#/components/schemas/citation" + x-ms-identifiers: [] + intent: + type: string + description: The detected intent from the chat history, used to pass to the next turn to carry over the context. + all_retrieved_documents: + type: array + description: All the retrieved documents. + items: + $ref: "#/components/schemas/retrievedDocument" + + description: |2- + A representation of the additional context information available when Azure OpenAI chat extensions are involved + in the generation of a corresponding chat completions response. This context information is only populated when + using an Azure OpenAI request configured to use a matching extension. + citation: + required: + - content + type: object + properties: + content: + type: string + description: The content of the citation. + title: + type: string + description: The title of the citation. + url: + type: string + description: The URL of the citation. + filepath: + type: string + description: The file path of the citation. + chunk_id: + type: string + description: The chunk ID of the citation. + rerank_score: + type: number + description: The rerank score of the retrieved document. + format: double + description: citation information for a chat completions response message. + retrievedDocument: + type: object + description: The retrieved document. + required: + - search_queries + - data_source_index + allOf: + - $ref: "#/components/schemas/citation" + - properties: + search_queries: + type: array + description: The search queries used to retrieve the document. + items: + type: string + data_source_index: + type: integer + description: The index of the data source. + format: int32 + original_search_score: + type: number + description: The original search score of the retrieved document. + format: double + filter_reason: + $ref: "#/components/schemas/filterReason" + description: Represents the rationale for filtering the document. If the document does not undergo filtering, this field will remain unset. + + filterReason: + type: string + description: The filtering reason of the retrieved document. + enum: + - score + - rerank + x-ms-enum: + name: FilterReason + modelAsString: true + values: + - name: score + value: score + description: The document is filtered by original search score threshold defined by `strictness` configure. + - name: rerank + value: rerank + description: The document is not filtered by original search score threshold, but is filtered by rerank score and `top_n_documents` configure. + + chatCompletionMessageToolCall: + type: object + properties: + id: + type: string + description: The ID of the tool call. + type: + $ref: "#/components/schemas/toolCallType" + function: + type: object + description: The function that the model called. + properties: + name: + type: string + description: The name of the function to call. + arguments: + type: string + description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. + required: + - name + - arguments + required: + - id + - type + - function + toolCallType: + type: string + enum: + - function + description: The type of the tool call, in this case `function`. + x-ms-enum: + name: ToolCallType + modelAsString: true + values: + - value: function + description: The tool call type is function. + chatCompletionRequestMessageTool: + allOf: + - $ref: "#/components/schemas/chatCompletionRequestMessage" + - type: object + nullable: true + properties: + tool_call_id: + type: string + description: Tool call that this message is responding to. + content: + type: string + description: The contents of the message. + nullable: true + required: + - tool_call_id + - content + chatCompletionRequestMessageFunction: + allOf: + - $ref: "#/components/schemas/chatCompletionRequestMessage" + - type: object + description: Deprecated. Message that represents a function. + nullable: true + properties: + role: + type: string + enum: + - function + description: The role of the messages author, in this case `function`. + name: + type: string + description: The contents of the message. + content: + type: string + description: The contents of the message. + nullable: true + required: + - function_call_id + - content + createChatCompletionResponse: + type: object + description: Represents a chat completion response returned by model, based on the provided input. + properties: + id: + type: string + description: A unique identifier for the chat completion. + prompt_filter_results: + $ref: "#/components/schemas/promptFilterResults" + choices: + type: array + description: A list of chat completion choices. Can be more than one if `n` is greater than 1. + items: + type: object + required: + - finish_reason + - index + - message + - logprobs + properties: + finish_reason: + type: string + description: &chat_completion_finish_reason_description | + The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, + `length` if the maximum number of tokens specified in the request was reached, + `content_filter` if content was omitted due to a flag from our content filters, + `tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function. + enum: + [ + "stop", + "length", + "tool_calls", + "content_filter", + "function_call", + ] + index: + type: integer + description: The index of the choice in the list of choices. + message: + $ref: "#/components/schemas/chatCompletionResponseMessage" + content_filter_results: + $ref: "#/components/schemas/contentFilterChoiceResults" + logprobs: &chat_completion_response_logprobs + description: Log probability information for the choice. + type: object + nullable: true + properties: + content: + description: A list of message content tokens with log probability information. + type: array + items: + $ref: "#/components/schemas/chatCompletionTokenLogprob" + nullable: true + refusal: + description: A list of message refusal tokens with log probability information. + type: array + items: + $ref: "#/components/schemas/chatCompletionTokenLogprob" + nullable: true + required: + - content + - refusal + created: + type: integer + description: The Unix timestamp (in seconds) of when the chat completion was created. + model: + type: string + description: The model used for the chat completion. + system_fingerprint: + type: string + description: | + This fingerprint represents the backend configuration that the model runs with. + + Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. + object: + type: string + description: The object type, which is always `chat.completion`. + enum: [chat.completion] + usage: + $ref: "#/components/schemas/completionUsage" + required: + - choices + - created + - id + - model + - object + + createChatCompletionStreamResponse: + type: object + description: Represents a streamed chunk of a chat completion response returned by model, based on the provided input. + properties: + id: + type: string + description: A unique identifier for the chat completion. Each chunk has the same ID. + choices: + type: array + description: | + A list of chat completion choices. Can contain more than one elements if `n` is greater than 1. + items: + type: object + required: + - delta + - finish_reason + - index + properties: + delta: + $ref: "#/components/schemas/chatCompletionStreamResponseDelta" + logprobs: *chat_completion_response_logprobs + finish_reason: + type: string + description: *chat_completion_finish_reason_description + enum: + [ + "stop", + "length", + "tool_calls", + "content_filter", + "function_call", + ] + nullable: true + index: + type: integer + description: The index of the choice in the list of choices. + created: + type: integer + description: The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp. + model: + type: string + description: The model to generate the completion. + system_fingerprint: + type: string + description: | + This fingerprint represents the backend configuration that the model runs with. + Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. + object: + type: string + description: The object type, which is always `chat.completion.chunk`. + enum: [chat.completion.chunk] + required: + - prompt_tokens + - completion_tokens + - total_tokens + required: + - choices + - created + - id + - model + - object + + chatCompletionStreamResponseDelta: + type: object + description: A chat completion delta generated by streamed model responses. + properties: + content: + type: string + description: The contents of the chunk message. + nullable: true + function_call: + deprecated: true + type: object + description: "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model." + properties: + arguments: + type: string + description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. + name: + type: string + description: The name of the function to call. + tool_calls: + type: array + items: + $ref: "#/components/schemas/chatCompletionMessageToolCallChunk" + role: + type: string + enum: ["system", "user", "assistant", "tool"] + description: The role of the author of this message. + refusal: + type: string + description: The refusal message generated by the model. + nullable: true + + chatCompletionMessageToolCallChunk: + type: object + properties: + index: + type: integer + id: + type: string + description: The ID of the tool call. + type: + type: string + enum: ["function"] + description: The type of the tool. Currently, only `function` is supported. + function: + type: object + properties: + name: + type: string + description: The name of the function to call. + arguments: + type: string + description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. + required: + - index + + chatCompletionStreamOptions: + description: | + Options for streaming response. Only set this when you set `stream: true`. + type: object + nullable: true + default: null + properties: + include_usage: + type: boolean + description: | + If set, an additional chunk will be streamed before the `data: [DONE]` message. The `usage` field on this chunk shows the token usage statistics for the entire request, and the `choices` field will always be an empty array. All other chunks will also include a `usage` field, but with a null value. + + chatCompletionChoiceLogProbs: + description: Log probability information for the choice. + type: object + nullable: true + properties: + content: + description: A list of message content tokens with log probability information. + type: array + items: + $ref: "#/components/schemas/chatCompletionTokenLogprob" + nullable: true + refusal: + description: A list of message refusal tokens with log probability information. + type: array + items: + $ref: "#/components/schemas/chatCompletionTokenLogprob" + nullable: true + required: + - content + chatCompletionTokenLogprob: + type: object + properties: + token: + description: The token. + type: string + logprob: + description: The log probability of this token. + type: number + bytes: + description: A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. + type: array + items: + type: integer + nullable: true + top_logprobs: + description: List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned. + type: array + items: + type: object + properties: + token: + description: The token. + type: string + logprob: + description: The log probability of this token. + type: number + bytes: + description: A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. + type: array + items: + type: integer + nullable: true + required: + - token + - logprob + - bytes + required: + - token + - logprob + - bytes + - top_logprobs + + chatCompletionResponseMessage: + type: object + description: A chat completion message generated by the model. + properties: + role: + $ref: "#/components/schemas/chatCompletionResponseMessageRole" + refusal: + type: string + description: The refusal message generated by the model. + nullable: true + content: + type: string + description: The contents of the message. + nullable: true + tool_calls: + type: array + description: The tool calls generated by the model, such as function calls. + items: + $ref: "#/components/schemas/chatCompletionMessageToolCall" + function_call: + $ref: "#/components/schemas/chatCompletionFunctionCall" + context: + $ref: "#/components/schemas/azureChatExtensionsMessageContext" + required: + - role + - content + - refusal + chatCompletionResponseMessageRole: + type: string + enum: + - assistant + description: The role of the author of the response message. + chatCompletionToolChoiceOption: + description: | + Controls which (if any) tool is called by the model. + `none` means the model will not call any tool and instead generates a message. + `auto` means the model can pick between generating a message or calling one or more tools. + `required` means the model must call one or more tools. + Specifying a particular tool via `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. + `none` is the default when no tools are present. `auto` is the default if tools are present. + oneOf: + - type: string + description: > + `none` means the model will not call any tool and instead generates a message. + `auto` means the model can pick between generating a message or calling one or more tools. + `required` means the model must call one or more tools. + enum: + - none + - auto + - required + - $ref: "#/components/schemas/chatCompletionNamedToolChoice" + chatCompletionNamedToolChoice: + type: object + description: Specifies a tool the model should use. Use to force the model to call a specific function. + properties: + type: + type: string + enum: + - "function" + description: The type of the tool. Currently, only `function` is supported. + function: + type: object + properties: + name: + type: string + description: The name of the function to call. + required: + - name + required: + - type + - function + + ParallelToolCalls: + description: Whether to enable parallel function calling during tool use. + type: boolean + default: true + + chatCompletionMessageToolCalls: + type: array + description: The tool calls generated by the model, such as function calls. + items: + $ref: "#/components/schemas/chatCompletionMessageToolCall" + + chatCompletionFunctionCall: + type: object + description: Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model. + properties: + name: + type: string + description: The name of the function to call. + arguments: + type: string + description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. + required: + - name + - arguments + completionUsage: + type: object + description: Usage statistics for the completion request. + properties: + prompt_tokens: + type: integer + description: Number of tokens in the prompt. + completion_tokens: + type: integer + description: Number of tokens in the generated completion. + total_tokens: + type: integer + description: Total number of tokens used in the request (prompt + completion). + completion_tokens_details: + type: object + description: Breakdown of tokens used in a completion. + properties: + reasoning_tokens: + type: integer + description: Tokens generated by the model for reasoning. + required: + - prompt_tokens + - completion_tokens + - total_tokens + chatCompletionTool: + type: object + properties: + type: + type: string + enum: ["function"] + description: The type of the tool. Currently, only `function` is supported. + function: + $ref: "#/components/schemas/FunctionObject" + required: + - type + - function + + FunctionParameters: + type: object + description: "The parameters the functions accepts, described as a JSON Schema object. See the guide](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list." + additionalProperties: true + + FunctionObject: + type: object + properties: + description: + type: string + description: A description of what the function does, used by the model to choose when and how to call the function. + name: + type: string + description: The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. + parameters: + $ref: "#/components/schemas/FunctionParameters" + strict: + type: boolean + nullable: true + default: false + description: Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](docs/guides/function-calling). + required: + - name + + ResponseFormatText: + type: object + properties: + type: + type: string + description: "The type of response format being defined: `text`" + enum: ["text"] + required: + - type + + ResponseFormatJsonObject: + type: object + properties: + type: + type: string + description: "The type of response format being defined: `json_object`" + enum: ["json_object"] + required: + - type + + ResponseFormatJsonSchemaSchema: + type: object + description: "The schema for the response format, described as a JSON Schema object." + additionalProperties: true + + ResponseFormatJsonSchema: + type: object + properties: + type: + type: string + description: "The type of response format being defined: `json_schema`" + enum: ["json_schema"] + json_schema: + type: object + properties: + description: + type: string + description: A description of what the response format is for, used by the model to determine how to respond in the format. + name: + type: string + description: The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. + schema: + $ref: "#/components/schemas/ResponseFormatJsonSchemaSchema" + strict: + type: boolean + nullable: true + default: false + description: Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`. + required: + - type + - name + required: + - type + - json_schema + + chatCompletionChoiceCommon: + type: object + properties: + index: + type: integer + finish_reason: + type: string + createTranslationRequest: + type: object + description: Translation request. + properties: + file: + type: string + description: The audio file to translate. + format: binary + prompt: + type: string + description: An optional text to guide the model's style or continue a previous audio segment. The prompt should be in English. + response_format: + $ref: "#/components/schemas/audioResponseFormat" + temperature: + type: number + default: 0 + description: The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit. + required: + - file + audioResponse: + description: Translation or transcription response when response_format was json + type: object + properties: + text: + type: string + description: Translated or transcribed text. + required: + - text + audioVerboseResponse: + description: Translation or transcription response when response_format was verbose_json + type: object + allOf: + - $ref: "#/components/schemas/audioResponse" + - properties: + task: + type: string + description: Type of audio task. + enum: + - transcribe + - translate + x-ms-enum: + modelAsString: true + language: + type: string + description: Language. + duration: + type: number + description: Duration. + segments: + type: array + items: + $ref: "#/components/schemas/audioSegment" + words: + type: array + items: + $ref: "#/components/schemas/audioWord" + + required: + - text + audioResponseFormat: + title: AudioResponseFormat + description: Defines the format of the output. + enum: + - json + - text + - srt + - verbose_json + - vtt + type: string + x-ms-enum: + modelAsString: true + createTranscriptionRequest: + type: object + description: Transcription request. + properties: + file: + type: string + description: The audio file object to transcribe. + format: binary + prompt: + type: string + description: An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language. + response_format: + $ref: "#/components/schemas/audioResponseFormat" + temperature: + type: number + default: 0 + description: The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit. + language: + type: string + description: The language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency. + timestamp_granularities[]: + description: | + The timestamp granularities to populate for this transcription. `response_format` must be set `verbose_json` to use timestamp granularities. Either or both of these options are supported: `word`, or `segment`. Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency. + type: array + items: + type: string + enum: + - word + - segment + default: [segment] + required: + - file + audioSegment: + type: object + description: Transcription or translation segment. + properties: + id: + type: integer + description: Segment identifier. + seek: + type: number + description: Offset of the segment. + start: + type: number + description: Segment start offset. + end: + type: number + description: Segment end offset. + text: + type: string + description: Segment text. + tokens: + type: array + items: + type: number + nullable: false + description: Tokens of the text. + temperature: + type: number + description: Temperature. + avg_logprob: + type: number + description: Average log probability. + compression_ratio: + type: number + description: Compression ratio. + no_speech_prob: + type: number + description: Probability of 'no speech'. + audioWord: + type: object + description: Transcription or translation word. + properties: + word: + type: string + description: Word + start: + type: number + description: Word start offset. + end: + type: number + description: Word end offset. + createSpeechRequest: + type: object + description: Speech request. + properties: + input: + type: string + description: The text to synthesize audio for. The maximum length is 4096 characters. + maxLength: 4096 + voice: + type: string + description: The voice to use for speech synthesis. + enum: + - alloy + - echo + - fable + - onyx + - nova + - shimmer + response_format: + type: string + description: The format to synthesize the audio in. + enum: + - mp3 + - opus + - aac + - flac + - wav + - pcm + speed: + description: The speed of the synthesize audio. Select a value from `0.25` to `4.0`. `1.0` is the default. + type: number + default: 1 + minimum: 0.25 + maximum: 4 + required: + - input + - voice + imageQuality: + description: The quality of the image that will be generated. + type: string + enum: + - standard + - hd + default: standard + x-ms-enum: + name: Quality + modelAsString: true + values: + - value: standard + description: Standard quality creates images with standard quality. + name: Standard + - value: hd + description: HD quality creates images with finer details and greater consistency across the image. + name: HD + imagesResponseFormat: + description: The format in which the generated images are returned. + type: string + enum: + - url + - b64_json + default: url + x-ms-enum: + name: ImagesResponseFormat + modelAsString: true + values: + - value: url + description: The URL that provides temporary access to download the generated images. + name: Url + - value: b64_json + description: The generated images are returned as base64 encoded string. + name: Base64Json + imageSize: + description: The size of the generated images. + type: string + enum: + - 256x256 + - 512x512 + - 1792x1024 + - 1024x1792 + - 1024x1024 + default: 1024x1024 + x-ms-enum: + name: Size + modelAsString: true + values: + - value: 256x256 + description: The desired size of the generated image is 256x256 pixels. Only supported for dall-e-2. + name: Size256x256 + - value: 512x512 + description: The desired size of the generated image is 512x512 pixels. Only supported for dall-e-2. + name: Size512x512 + - value: 1792x1024 + description: The desired size of the generated image is 1792x1024 pixels. Only supported for dall-e-3. + name: Size1792x1024 + - value: 1024x1792 + description: The desired size of the generated image is 1024x1792 pixels. Only supported for dall-e-3. + name: Size1024x1792 + - value: 1024x1024 + description: The desired size of the generated image is 1024x1024 pixels. + name: Size1024x1024 + imageStyle: + description: The style of the generated images. + type: string + enum: + - vivid + - natural + default: vivid + x-ms-enum: + name: Style + modelAsString: true + values: + - value: vivid + description: Vivid creates images that are hyper-realistic and dramatic. + name: Vivid + - value: natural + description: Natural creates images that are more natural and less hyper-realistic. + name: Natural + imageGenerationsRequest: + type: object + properties: + prompt: + description: A text description of the desired image(s). The maximum length is 4000 characters. + type: string + format: string + example: a corgi in a field + minLength: 1 + "n": + description: The number of images to generate. + type: integer + minimum: 1 + maximum: 1 + default: 1 + size: + $ref: "#/components/schemas/imageSize" + response_format: + $ref: "#/components/schemas/imagesResponseFormat" + user: + description: A unique identifier representing your end-user, which can help to monitor and detect abuse. + type: string + format: string + example: user123456 + quality: + $ref: "#/components/schemas/imageQuality" + style: + $ref: "#/components/schemas/imageStyle" + required: + - prompt + generateImagesResponse: + type: object + properties: + created: + type: integer + format: unixtime + description: The unix timestamp when the operation was created. + example: "1676540381" + data: + type: array + description: The result data of the operation, if successful + items: + $ref: "#/components/schemas/imageResult" + required: + - created + - data + imageResult: + type: object + description: The image url or encoded image if successful, and an error otherwise. + properties: + url: + type: string + description: The image url. + example: https://www.contoso.com + b64_json: + type: string + description: The base64 encoded image + content_filter_results: + $ref: "#/components/schemas/dalleContentFilterResults" + revised_prompt: + type: string + description: The prompt that was used to generate the image, if there was any revision to the prompt. + prompt_filter_results: + $ref: "#/components/schemas/dalleFilterResults" + line: + type: object + description: A content line object consisting of an adjacent sequence of content elements, such as words and selection marks. + properties: + text: + type: string + spans: + type: array + description: An array of spans that represent detected objects and its bounding box information. + items: + $ref: "#/components/schemas/span" + required: + - text + - spans + span: + type: object + description: A span object that represents a detected object and its bounding box information. + properties: + text: + type: string + description: The text content of the span that represents the detected object. + offset: + type: integer + description: The character offset within the text where the span begins. This offset is defined as the position of the first character of the span, counting from the start of the text as Unicode codepoints. + length: + type: integer + description: The length of the span in characters, measured in Unicode codepoints. + polygon: + type: array + description: An array of objects representing points in the polygon that encloses the detected object. + items: + type: object + properties: + x: + type: number + description: The x-coordinate of the point. + "y": + type: number + description: The y-coordinate of the point. + required: + - text + - offset + - length + - polygon + + runCompletionUsage: + type: object + description: Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). + properties: + completion_tokens: + type: integer + description: Number of completion tokens used over the course of the run. + prompt_tokens: + type: integer + description: Number of prompt tokens used over the course of the run. + total_tokens: + type: integer + description: Total number of tokens used (prompt + completion). + required: + - prompt_tokens + - completion_tokens + - total_tokens + nullable: true + + runStepCompletionUsage: + type: object + description: Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`. + properties: + completion_tokens: + type: integer + description: Number of completion tokens used over the course of the run step. + prompt_tokens: + type: integer + description: Number of prompt tokens used over the course of the run step. + total_tokens: + type: integer + description: Total number of tokens used (prompt + completion). + required: + - prompt_tokens + - completion_tokens + - total_tokens + nullable: true + + assistantsApiResponseFormatOption: + description: | + Specifies the format that the model must output. Compatible with GPT-4 Turbo and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`. + + Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is valid JSON. + + **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. + oneOf: + - type: string + description: > + `auto` is the default value + enum: [none, auto] + x-ms-enum: + name: AssistantsApiResponseFormatOption + modelAsString: true + values: + - value: none + - value: auto + - $ref: "#/components/schemas/assistantsApiResponseFormat" + + assistantsApiResponseFormat: + type: object + description: | + An object describing the expected output of the model. If `json_object` only `function` type `tools` are allowed to be passed to the Run. If `text` the model can return text or any value needed. + properties: + type: + type: string + enum: ["text", "json_object"] + x-ms-enum: + name: AssistantsApiResponseFormat + modelAsString: true + values: + - value: text + - value: json_object + example: "json_object" + default: "text" + description: Must be one of `text` or `json_object`. + + assistantObject: + type: object + title: Assistant + description: Represents an `assistant` that can call the model and use tools. + properties: + id: + description: The identifier, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `assistant`. + type: string + enum: + - assistant + x-ms-enum: + name: AssistantObjectType + modelAsString: true + values: + - value: assistant + created_at: + type: integer + description: The Unix timestamp (in seconds) for when the assistant was created. + name: + description: &assistant_name_param_description | + The name of the assistant. The maximum length is 256 characters. + type: string + maxLength: 256 + nullable: true + description: + description: &assistant_description_param_description | + The description of the assistant. The maximum length is 512 characters. + type: string + maxLength: 512 + nullable: true + model: + description: | + ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them. + type: string + instructions: + description: &assistant_instructions_param_description | + The system instructions that the assistant uses. The maximum length is 256,000 characters. + type: string + maxLength: 256000 + nullable: true + tools: + description: &assistant_tools_param_description | + A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `file_search`, or `function`. + default: [] + type: array + maxItems: 128 + items: + oneOf: + - $ref: "#/components/schemas/assistantToolsCode" + - $ref: "#/components/schemas/assistantToolsFileSearch" + - $ref: "#/components/schemas/assistantToolsFunction" + tool_resources: + type: object + description: | + A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. + properties: + code_interpreter: + type: object + properties: + file_ids: + type: array + description: | + A list of file IDs made available to the `code_interpreter`` tool. There can be a maximum of 20 files associated with the tool. + default: [] + maxItems: 20 + items: + type: string + file_search: + type: object + properties: + vector_store_ids: + type: array + description: | + The ID of the vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. + maxItems: 1 + items: + type: string + metadata: + description: &metadata_description | + Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. + type: object + nullable: true + temperature: + description: &run_temperature_description | + What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. + type: number + minimum: 0 + maximum: 2 + default: 1 + example: 1 + nullable: true + top_p: + type: number + minimum: 0 + maximum: 1 + default: 1 + example: 1 + nullable: true + description: &run_top_p_description | + An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. + + We generally recommend altering this or temperature but not both. + response_format: + $ref: "#/components/schemas/assistantsApiResponseFormatOption" + nullable: true + required: + - id + - object + - created_at + - name + - description + - model + - instructions + - tools + - metadata + + createAssistantRequest: + type: object + additionalProperties: false + properties: + model: + description: | + ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them. + anyOf: + - type: string + name: + description: *assistant_name_param_description + type: string + nullable: true + maxLength: 256 + description: + description: *assistant_description_param_description + type: string + nullable: true + maxLength: 512 + instructions: + description: *assistant_instructions_param_description + type: string + nullable: true + maxLength: 256000 + tools: + description: *assistant_tools_param_description + default: [] + type: array + maxItems: 128 + items: + oneOf: + - $ref: "#/components/schemas/assistantToolsCode" + - $ref: "#/components/schemas/assistantToolsFileSearch" + - $ref: "#/components/schemas/assistantToolsFunction" + tool_resources: + type: object + description: | + A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. + properties: + code_interpreter: + type: object + properties: + file_ids: + type: array + description: | + A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. + default: [] + maxItems: 20 + items: + type: string + file_search: + type: object + properties: + vector_store_ids: + type: array + description: | + The vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. + maxItems: 1 + items: + type: string + vector_stores: + type: array + description: | + A helper to create a vector store with file_ids and attach it to this assistant. There can be a maximum of 1 vector store attached to the assistant. + maxItems: 1 + items: + type: object + properties: + file_ids: + type: array + description: | + A list of file IDs to add to the vector store. There can be a maximum of 10000 files in a vector store. + maxItems: 10000 + items: + type: string + chunking_strategy: + # Ideally we'd reuse the chunking strategy schema here, but it doesn't expand properly + type: object + description: The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. + oneOf: + - type: object + title: Auto Chunking Strategy + description: The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`. + additionalProperties: false + properties: + type: + type: string + description: Always `auto`. + enum: ["auto"] + x-ms-enum: + name: AutoChunkingStrategyType + modelAsString: true + values: + - value: auto + required: + - type + - type: object + title: Static Chunking Strategy + additionalProperties: false + properties: + type: + type: string + description: Always `static`. + enum: ["static"] + x-ms-enum: + name: StaticChunkingStrategyType + modelAsString: true + values: + - value: static + static: + type: object + additionalProperties: false + properties: + max_chunk_size_tokens: + type: integer + minimum: 100 + maximum: 4096 + description: The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`. + chunk_overlap_tokens: + type: integer + description: | + The number of tokens that overlap between chunks. The default value is `400`. + + Note that the overlap must not exceed half of `max_chunk_size_tokens`. + required: + - max_chunk_size_tokens + - chunk_overlap_tokens + required: + - type + - static + metadata: + type: object + description: | + Set of 16 key-value pairs that can be attached to a vector store. This can be useful for storing additional information about the vector store in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. + oneOf: + - required: [vector_store_ids] + - required: [vector_stores] + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + temperature: + description: *run_temperature_description + type: number + minimum: 0 + maximum: 2 + default: 1 + example: 1 + nullable: true + top_p: + type: number + minimum: 0 + maximum: 1 + default: 1 + example: 1 + nullable: true + description: *run_top_p_description + response_format: + $ref: "#/components/schemas/assistantsApiResponseFormatOption" + nullable: true + required: + - model + + modifyAssistantRequest: + type: object + additionalProperties: false + properties: + model: + description: | + ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them. + anyOf: + - type: string + name: + description: | + The name of the assistant. The maximum length is 256 characters. + type: string + nullable: true + maxLength: 256 + description: + description: | + The description of the assistant. The maximum length is 512 characters. + type: string + nullable: true + maxLength: 512 + instructions: + description: | + The system instructions that the assistant uses. The maximum length is 32768 characters. + type: string + nullable: true + maxLength: 32768 + tools: + description: | + A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `retrieval`, or `function`. + default: [] + type: array + maxItems: 128 + items: + oneOf: + - $ref: "#/components/schemas/assistantToolsCode" + - $ref: "#/components/schemas/assistantToolsFileSearch" + - $ref: "#/components/schemas/assistantToolsFunction" + tool_resources: + type: object + description: | + A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. + properties: + code_interpreter: + type: object + properties: + file_ids: + type: array + description: | + Overrides the list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. + default: [] + maxItems: 20 + items: + type: string + file_search: + type: object + properties: + vector_store_ids: + type: array + description: | + Overrides the vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. + maxItems: 1 + items: + type: string + metadata: + description: *metadata_description + type: object + nullable: true + temperature: + description: *run_temperature_description + type: number + minimum: 0 + maximum: 2 + default: 1 + example: 1 + nullable: true + top_p: + type: number + minimum: 0 + maximum: 1 + default: 1 + example: 1 + nullable: true + description: *run_top_p_description + response_format: + $ref: "#/components/schemas/assistantsApiResponseFormatOption" + nullable: true + + deleteAssistantResponse: + type: object + properties: + id: + type: string + deleted: + type: boolean + object: + type: string + enum: + - assistant.deleted + x-ms-enum: + name: DeleteAssistantResponseState + modelAsString: true + values: + - value: assistant.deleted + required: + - id + - object + - deleted + + listAssistantsResponse: + type: object + properties: + object: + type: string + example: list + data: + type: array + items: + $ref: "#/components/schemas/assistantObject" + first_id: + type: string + example: asst_hLBK7PXBv5Lr2NQT7KLY0ag1 + last_id: + type: string + example: asst_QLoItBbqwyAJEzlTy4y9kOMM + has_more: + type: boolean + example: false + required: + - object + - data + - first_id + - last_id + - has_more + + assistantToolsCode: + type: object + title: Code interpreter tool + properties: + type: + type: string + description: "The type of tool being defined: `code_interpreter`" + enum: + - code_interpreter + x-ms-enum: + name: assistantToolsCodeType + modelAsString: true + values: + - value: code_interpreter + required: + - type + + assistantToolsFileSearch: + type: object + title: FileSearch tool + properties: + type: + type: string + description: "The type of tool being defined: `file_search`" + enum: + - file_search + x-ms-enum: + name: assistantToolsFileSearchType + modelAsString: true + values: + - value: file_search + file_search: + type: object + description: Overrides for the file search tool. + properties: + max_num_results: + type: integer + minimum: 1 + maximum: 50 + description: | + The maximum number of results the file search tool should output. The + default is 20 for gpt-4* models and 5 for gpt-3.5-turbo. This number + should be between 1 and 50 inclusive. + + + Note that the file search tool may output fewer than `max_num_results` + results. See the [file search tool + documentation](/docs/assistants/tools/file-search/number-of-chunks-returned) + for more information. + required: + - type + + assistantToolsFileSearchTypeOnly: + type: object + title: FileSearch tool + properties: + type: + type: string + description: "The type of tool being defined: `file_search`" + enum: + - file_search + x-ms-enum: + name: assistantToolsFileSearchType + modelAsString: true + values: + - value: file_search + required: + - type + + assistantToolsFunction: + type: object + title: Function tool + properties: + type: + type: string + description: "The type of tool being defined: `function`" + enum: + - function + x-ms-enum: + name: assistantToolsFunction + modelAsString: true + values: + - value: function + function: + type: object + description: The function definition. + properties: + description: + type: string + description: A description of what the function does, used by the model to choose when and how to call the function. + name: + type: string + description: The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. + parameters: + $ref: "#/components/schemas/chatCompletionFunctionParameters" + required: + - name + - parameters + - description + required: + - type + - function + + truncationObject: + type: object + title: Thread Truncation Controls + description: Controls for how a thread will be truncated prior to the run. Use this to control the intial context window of the run. + properties: + type: + type: string + description: The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`. + enum: ["auto", "last_messages"] + x-ms-enum: + name: TruncationType + modelAsString: true + values: + - value: auto + - value: last_messages + last_messages: + type: integer + description: The number of most recent messages from the thread when constructing the context for the run. + minimum: 1 + nullable: true + required: + - type + + assistantsApiToolChoiceOption: + description: | + Controls which (if any) tool is called by the model. + `none` means the model will not call any tools and instead generates a message. + `auto` is the default value and means the model can pick between generating a message or calling a tool. + Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. + oneOf: + - type: string + description: > + `none` means the model will not call a function and instead generates a message. + `auto` means the model can pick between generating a message or calling a function. + enum: [none, auto] + x-ms-enum: + name: AssistantsApiToolChoiceOption + modelAsString: true + values: + - value: none + - value: auto + - $ref: "#/components/schemas/assistantsNamedToolChoice" + + assistantsNamedToolChoice: + type: object + description: Specifies a tool the model should use. Use to force the model to call a specific tool. + properties: + type: + type: string + enum: ["function", "code_interpreter", "file_search"] + description: The type of the tool. If type is `function`, the function name must be set + x-ms-enum: + name: AssistantsNamedToolChoiceType + modelAsString: true + values: + - value: function + - value: code_interpreter + - value: file_search + function: + type: object + properties: + name: + type: string + description: The name of the function to call. + required: + - name + required: + - type + + runObject: + type: object + title: A run on a thread + description: Represents an execution run on a [thread](/docs/api-reference/threads). + properties: + id: + description: The identifier, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `thread.run`. + type: string + enum: + - thread.run + x-ms-enum: + name: runObjectType + modelAsString: true + values: + - value: thread.run + description: The run object type which is always thread.run + created_at: + description: The Unix timestamp (in seconds) for when the run was created. + type: integer + thread_id: + description: The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run. + type: string + assistant_id: + description: The ID of the assistant used for execution of this run. + type: string + status: + description: The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, or `expired`. + type: string + enum: + - queued + - in_progress + - requires_action + - cancelling + - cancelled + - failed + - completed + - expired + x-ms-enum: + name: RunObjectStatus + modelAsString: true + values: + - value: queued + description: The queued state + - value: in_progress + description: The in_progress state + - value: requires_action + description: The required_action state + - value: cancelling + description: The cancelling state + - value: cancelled + description: The cancelled state + - value: failed + description: The failed state + - value: completed + description: The completed state + - value: expired + description: The expired state + required_action: + type: object + description: Details on the action required to continue the run. Will be `null` if no action is required. + nullable: true + properties: + type: + description: For now, this is always `submit_tool_outputs`. + type: string + enum: + - submit_tool_outputs + submit_tool_outputs: + type: object + description: Details on the tool outputs needed for this run to continue. + properties: + tool_calls: + type: array + description: A list of the relevant tool calls. + items: + $ref: "#/components/schemas/runToolCallObject" + required: + - tool_calls + required: + - type + - submit_tool_outputs + last_error: + type: object + description: The last error associated with this run. Will be `null` if there are no errors. + nullable: true + properties: + code: + type: string + description: One of `server_error` or `rate_limit_exceeded`. + enum: + - server_error + - rate_limit_exceeded + x-ms-enum: + name: LastErrorCode + modelAsString: true + values: + - value: server_error + description: The server failed to respond to request due to server error + - value: rate_limit_exceeded + description: The server failed to respond to request due to rate limit exceeded + message: + type: string + description: A human-readable description of the error. + required: + - code + - message + expires_at: + description: The Unix timestamp (in seconds) for when the run will expire. + type: integer + started_at: + description: The Unix timestamp (in seconds) for when the run was started. + type: integer + nullable: true + cancelled_at: + description: The Unix timestamp (in seconds) for when the run was cancelled. + type: integer + nullable: true + failed_at: + description: The Unix timestamp (in seconds) for when the run failed. + type: integer + nullable: true + completed_at: + description: The Unix timestamp (in seconds) for when the run was completed. + type: integer + nullable: true + incomplete_details: + description: Details on why the run is incomplete. Will be `null` if the run is not incomplete. + type: object + nullable: true + properties: + reason: + description: The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. + type: string + enum: ["max_completion_tokens", "max_prompt_tokens"] + x-ms-enum: + name: IncompleteDetailsReason + modelAsString: true + values: + - value: max_completion_tokens + - value: max_prompt_tokens + model: + description: The model that the assistant used for this run. + type: string + instructions: + description: The instructions that the assistant used for this run. + type: string + tools: + description: The list of tools that the assistant used for this run. + default: [] + type: array + maxItems: 20 + items: + oneOf: + - $ref: "#/components/schemas/assistantToolsCode" + - $ref: "#/components/schemas/assistantToolsFileSearch" + - $ref: "#/components/schemas/assistantToolsFunction" + metadata: + description: *metadata_description + type: object + nullable: true + usage: + $ref: "#/components/schemas/runCompletionUsage" + temperature: + description: The sampling temperature used for this run. If not set, defaults to 1. + type: number + nullable: true + top_p: + description: The nucleus sampling value used for this run. If not set, defaults to 1. + type: number + nullable: true + max_prompt_tokens: + type: integer + nullable: true + description: | + The maximum number of prompt tokens specified to have been used over the course of the run. + minimum: 256 + max_completion_tokens: + type: integer + nullable: true + description: | + The maximum number of completion tokens specified to have been used over the course of the run. + minimum: 256 + truncation_strategy: + $ref: "#/components/schemas/truncationObject" + nullable: true + tool_choice: + $ref: "#/components/schemas/assistantsApiToolChoiceOption" + nullable: true + parallel_tool_calls: + $ref: "#/components/schemas/ParallelToolCalls" + response_format: + $ref: "#/components/schemas/assistantsApiResponseFormatOption" + nullable: true + required: + - id + - object + - created_at + - thread_id + - assistant_id + - status + - required_action + - last_error + - expires_at + - started_at + - cancelled_at + - failed_at + - completed_at + - model + - instructions + - tools + - metadata + - usage + - incomplete_details + - max_prompt_tokens + - max_completion_tokens + - truncation_strategy + - tool_choice + - response_format + + createRunRequest: + type: object + additionalProperties: false + properties: + assistant_id: + description: The ID of the assistant to use to execute this run. + type: string + model: + description: The ID of the Model to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used. + type: string + nullable: true + instructions: + description: Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis. + type: string + nullable: true + additional_instructions: + description: Appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions. + type: string + nullable: true + additional_messages: + description: Adds additional messages to the thread before creating the run. + type: array + items: + $ref: "#/components/schemas/createMessageRequest" + nullable: true + tools: + description: Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis. + nullable: true + type: array + maxItems: 20 + items: + oneOf: + - $ref: "#/components/schemas/assistantToolsCode" + - $ref: "#/components/schemas/assistantToolsFileSearch" + - $ref: "#/components/schemas/assistantToolsFunction" + metadata: + description: *metadata_description + type: object + nullable: true + temperature: + type: number + minimum: 0 + maximum: 2 + default: 1 + example: 1 + nullable: true + description: *run_temperature_description + top_p: + type: number + minimum: 0 + maximum: 1 + default: 1 + example: 1 + nullable: true + description: *run_top_p_description + stream: + type: boolean + nullable: true + description: | + If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. + max_prompt_tokens: + type: integer + nullable: true + description: | + The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. + minimum: 256 + max_completion_tokens: + type: integer + nullable: true + description: | + The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. + minimum: 256 + truncation_strategy: + $ref: "#/components/schemas/truncationObject" + nullable: true + tool_choice: + $ref: "#/components/schemas/assistantsApiToolChoiceOption" + nullable: true + response_format: + $ref: "#/components/schemas/assistantsApiResponseFormatOption" + nullable: true + required: + - thread_id + - assistant_id + + listRunsResponse: + type: object + properties: + object: + type: string + example: list + data: + type: array + items: + $ref: "#/components/schemas/runObject" + first_id: + type: string + example: run_hLBK7PXBv5Lr2NQT7KLY0ag1 + last_id: + type: string + example: run_QLoItBbqwyAJEzlTy4y9kOMM + has_more: + type: boolean + example: false + required: + - object + - data + - first_id + - last_id + - has_more + + modifyRunRequest: + type: object + additionalProperties: false + properties: + metadata: + description: *metadata_description + type: object + nullable: true + + submitToolOutputsRunRequest: + type: object + additionalProperties: false + properties: + tool_outputs: + description: A list of tools for which the outputs are being submitted. + type: array + items: + type: object + properties: + tool_call_id: + type: string + description: The ID of the tool call in the `required_action` object within the run object the output is being submitted for. + output: + type: string + description: The output of the tool call to be submitted to continue the run. + stream: + type: boolean + nullable: true + description: | + If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. + required: + - tool_outputs + + runToolCallObject: + type: object + description: Tool call objects + properties: + id: + type: string + description: The ID of the tool call. This ID must be referenced when you submit the tool outputs in using the [Submit tool outputs to run](/docs/api-reference/runs/submitToolOutputs) endpoint. + type: + type: string + description: The type of tool call the output is required for. For now, this is always `function`. + enum: + - function + x-ms-enum: + name: RunToolCallObjectType + modelAsString: true + values: + - value: function + function: + type: object + description: The function definition. + properties: + name: + type: string + description: The name of the function. + arguments: + type: string + description: The arguments that the model expects you to pass to the function. + required: + - name + - arguments + required: + - id + - type + - function + + createThreadAndRunRequest: + type: object + additionalProperties: false + properties: + assistant_id: + description: The ID of the assistant to use to execute this run. + type: string + thread: + $ref: "#/components/schemas/createThreadRequest" + description: If no thread is provided, an empty thread will be created. + model: + description: The ID of the [Model](/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used. + type: string + nullable: true + instructions: + description: Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis. + type: string + nullable: true + tools: + description: Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis. + nullable: true + type: array + maxItems: 20 + items: + oneOf: + - $ref: "#/components/schemas/assistantToolsCode" + - $ref: "#/components/schemas/assistantToolsFileSearch" + - $ref: "#/components/schemas/assistantToolsFunction" + tool_resources: + type: object + description: | + A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. + properties: + code_interpreter: + type: object + properties: + file_ids: + type: array + description: | + A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. + default: [] + maxItems: 20 + items: + type: string + file_search: + type: object + properties: + vector_store_ids: + type: array + description: | + The ID of the vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. + maxItems: 1 + items: + type: string + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + temperature: + type: number + minimum: 0 + maximum: 2 + default: 1 + example: 1 + nullable: true + description: *run_temperature_description + top_p: + type: number + minimum: 0 + maximum: 1 + default: 1 + example: 1 + nullable: true + description: *run_top_p_description + stream: + type: boolean + nullable: true + description: | + If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. + max_prompt_tokens: + type: integer + nullable: true + description: | + The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. + minimum: 256 + max_completion_tokens: + type: integer + nullable: true + description: | + The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. + minimum: 256 + truncation_strategy: + $ref: "#/components/schemas/truncationObject" + nullable: true + tool_choice: + $ref: "#/components/schemas/assistantsApiToolChoiceOption" + nullable: true + response_format: + $ref: "#/components/schemas/assistantsApiResponseFormatOption" + nullable: true + required: + - thread_id + - assistant_id + + threadObject: + type: object + title: Thread + description: Represents a thread that contains [messages](/docs/api-reference/messages). + properties: + id: + description: The identifier, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `thread`. + type: string + enum: + - thread + x-ms-enum: + name: ThreadObjectType + modelAsString: true + values: + - value: thread + description: The type of thread object which is always `thread` + created_at: + description: The Unix timestamp (in seconds) for when the thread was created. + type: integer + tool_resources: + type: object + description: | + A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. + properties: + code_interpreter: + type: object + properties: + file_ids: + type: array + description: | + A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. + default: [] + maxItems: 20 + items: + type: string + file_search: + type: object + properties: + vector_store_ids: + type: array + description: | + The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread. + maxItems: 1 + items: + type: string + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + required: + - id + - object + - created_at + - tool_resources + - metadata + + createThreadRequest: + type: object + additionalProperties: false + properties: + messages: + description: A list of messages to start the thread with. + type: array + items: + $ref: "#/components/schemas/createMessageRequest" + tool_resources: + type: object + description: | + A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. + properties: + code_interpreter: + type: object + properties: + file_ids: + type: array + description: | + A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. + default: [] + maxItems: 20 + items: + type: string + file_search: + type: object + properties: + vector_store_ids: + type: array + description: | + The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread. + maxItems: 1 + items: + type: string + vector_stores: + type: array + description: | + A helper to create a vector store with file_ids and attach it to this thread. There can be a maximum of 1 vector store attached to the thread. + maxItems: 1 + items: + type: object + properties: + file_ids: + type: array + description: | + A list of file IDs to add to the vector store. There can be a maximum of 10000 files in a vector store. + maxItems: 10000 + items: + type: string + chunking_strategy: + # Ideally we'd reuse the chunking strategy schema here, but it doesn't expand properly + type: object + description: The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. + oneOf: + - type: object + title: Auto Chunking Strategy + description: The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`. + additionalProperties: false + properties: + type: + type: string + description: Always `auto`. + enum: ["auto"] + x-ms-enum: + name: AutoChunkingStrategyType + modelAsString: true + values: + - value: auto + required: + - type + - type: object + title: Static Chunking Strategy + additionalProperties: false + properties: + type: + type: string + description: Always `static`. + enum: ["static"] + x-ms-enum: + name: StaticChunkingStrategyType + modelAsString: true + values: + - value: static + static: + type: object + additionalProperties: false + properties: + max_chunk_size_tokens: + type: integer + minimum: 100 + maximum: 4096 + description: The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`. + chunk_overlap_tokens: + type: integer + description: | + The number of tokens that overlap between chunks. The default value is `400`. + + Note that the overlap must not exceed half of `max_chunk_size_tokens`. + required: + - max_chunk_size_tokens + - chunk_overlap_tokens + required: + - type + - static + metadata: + type: object + description: | + Set of 16 key-value pairs that can be attached to a vector store. This can be useful for storing additional information about the vector store in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. + oneOf: + - required: [vector_store_ids] + - required: [vector_stores] + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + + modifyThreadRequest: + type: object + additionalProperties: false + properties: + tool_resources: + type: object + description: | + A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. + properties: + code_interpreter: + type: object + properties: + file_ids: + type: array + description: | + A list of File IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. + default: [] + maxItems: 20 + items: + type: string + file_search: + type: object + properties: + vector_store_ids: + type: array + description: | + The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread. + maxItems: 1 + items: + type: string + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + + deleteThreadResponse: + type: object + properties: + id: + type: string + deleted: + type: boolean + object: + type: string + enum: + - thread.deleted + x-ms-enum: + name: DeleteThreadResponseObjectState + modelAsString: true + values: + - value: thread.deleted + description: The delete thread response object state which is `thread.deleted` + required: + - id + - object + - deleted + + listThreadsResponse: + properties: + object: + type: string + example: list + data: + type: array + items: + $ref: "#/components/schemas/threadObject" + first_id: + type: string + example: asst_hLBK7PXBv5Lr2NQT7KLY0ag1 + last_id: + type: string + example: asst_QLoItBbqwyAJEzlTy4y9kOMM + has_more: + type: boolean + example: false + required: + - object + - data + - first_id + - last_id + - has_more + + messageObject: + type: object + title: The message object + description: Represents a message within a [thread](/docs/api-reference/threads). + properties: + id: + description: The identifier, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `thread.message`. + type: string + enum: + - thread.message + x-ms-enum: + name: MessageObjectType + modelAsString: true + values: + - value: thread.message + description: The message object type which is `thread.message` + created_at: + description: The Unix timestamp (in seconds) for when the message was created. + type: integer + thread_id: + description: The [thread](/docs/api-reference/threads) ID that this message belongs to. + type: string + status: + description: The status of the message, which can be either `in_progress`, `incomplete`, or `completed`. + type: string + enum: ["in_progress", "incomplete", "completed"] + x-ms-enum: + name: MessageObjectStatus + modelAsString: true + values: + - value: in_progress + - value: incomplete + - value: completed + incomplete_details: + description: On an incomplete message, details about why the message is incomplete. + type: object + properties: + reason: + type: string + description: The reason the message is incomplete. + enum: + [ + "content_filter", + "max_tokens", + "run_cancelled", + "run_expired", + "run_failed", + ] + x-ms-enum: + name: MessageObjectIncompleteReason + modelAsString: true + values: + - value: content_filter + - value: max_tokens + - value: run_cancelled + - value: run_expired + - value: run_failed + nullable: true + required: + - reason + completed_at: + description: The Unix timestamp (in seconds) for when the message was completed. + type: integer + nullable: true + incomplete_at: + description: The Unix timestamp (in seconds) for when the message was marked as incomplete. + type: integer + nullable: true + role: + description: The entity that produced the message. One of `user` or `assistant`. + type: string + enum: + - user + - assistant + x-ms-enum: + name: MessageObjectRole + modelAsString: true + values: + - value: user + - value: assistant + content: + description: The content of the message in array of text and/or images. + type: array + items: + oneOf: + - $ref: "#/components/schemas/messageContentImageFileObject" + - $ref: "#/components/schemas/messageContentTextObject" + assistant_id: + description: If applicable, the ID of the assistant that authored this message. + type: string + nullable: true + run_id: + description: If applicable, the ID of the [run](/docs/api-reference/runs) associated with the authoring of this message. + type: string + nullable: true + attachments: + type: array + items: + type: object + properties: + file_id: + type: string + description: The ID of the file to attach to the message. + tools: + description: The tools to add this file to. + type: array + items: + oneOf: + - $ref: "#/components/schemas/assistantToolsCode" + - $ref: "#/components/schemas/assistantToolsFileSearchTypeOnly" + description: A list of files attached to the message, and the tools they were added to. + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + required: + - id + - object + - created_at + - thread_id + - status + - incomplete_details + - completed_at + - incomplete_at + - role + - content + - assistant_id + - run_id + - attachments + - metadata + + messageDeltaObject: + type: object + title: Message delta object + description: | + Represents a message delta i.e. any changed fields on a message during streaming. + properties: + id: + description: The identifier of the message, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `thread.message.delta`. + type: string + enum: ["thread.message.delta"] + x-ms-enum: + name: MessageDeltaObjectType + modelAsString: true + values: + - value: thread.message.delta + delta: + description: The delta containing the fields that have changed on the Message. + type: object + properties: + role: + description: The entity that produced the message. One of `user` or `assistant`. + type: string + enum: ["user", "assistant"] + x-ms-enum: + name: MessageDeltaObjectDeltaRole + modelAsString: true + values: + - value: user + - value: assistant + content: + description: The content of the message in array of text and/or images. + type: array + items: + oneOf: + - $ref: "#/components/schemas/messageDeltaContentImageFileObject" + - $ref: "#/components/schemas/messageDeltaContentTextObject" + required: + - id + - object + - delta + + createMessageRequest: + type: object + additionalProperties: false + required: + - role + - content + properties: + role: + type: string + enum: + - user + - assistant + x-ms-enum: + name: CreateMessageRequestRole + modelAsString: true + values: + - value: user + - value: assistant + description: | + The role of the entity that is creating the message. Allowed values include: + - `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages. + - `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation. + content: + type: string + minLength: 1 + maxLength: 256000 + description: The content of the message. + attachments: + type: array + items: + type: object + properties: + file_id: + type: string + description: The ID of the file to attach to the message. + tools: + description: The tools to add this file to. + type: array + items: + oneOf: + - $ref: "#/components/schemas/assistantToolsCode" + - $ref: "#/components/schemas/assistantToolsFileSearchTypeOnly" + x-oaiExpandable: true + description: A list of files attached to the message, and the tools they should be added to. + required: + - file_id + - tools + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + modifyMessageRequest: + type: object + additionalProperties: false + properties: + metadata: + description: *metadata_description + type: object + nullable: true + deleteMessageResponse: + type: object + properties: + id: + type: string + deleted: + type: boolean + object: + type: string + enum: + - thread.message.deleted + x-ms-enum: + name: DeleteMessageResponseObject + modelAsString: true + values: + - value: thread.message.deleted + description: The delete message response object state + required: + - id + - object + - deleted + listMessagesResponse: + properties: + object: + type: string + example: list + data: + type: array + items: + $ref: "#/components/schemas/messageObject" + first_id: + type: string + example: msg_hLBK7PXBv5Lr2NQT7KLY0ag1 + last_id: + type: string + example: msg_QLoItBbqwyAJEzlTy4y9kOMM + has_more: + type: boolean + example: false + required: + - object + - data + - first_id + - last_id + - has_more + + messageContentImageFileObject: + title: Image file + type: object + description: References an image file in the content of a message. + properties: + type: + description: Always `image_file`. + type: string + enum: + - image_file + x-ms-enum: + name: MessageContentImageFileObjectType + modelAsString: true + values: + - value: image_file + description: The message content image file type + image_file: + type: object + properties: + file_id: + description: The file ID of the image in the message content. + type: string + required: + - file_id + required: + - type + - image_file + + messageContentTextObject: + title: Text + type: object + description: The text content that is part of a message. + properties: + type: + description: Always `text`. + type: string + enum: + - text + x-ms-enum: + name: messageContentTextObjectType + modelAsString: true + values: + - value: text + description: The message content text Object type + text: + type: object + properties: + value: + description: The data that makes up the text. + type: string + annotations: + type: array + items: + oneOf: + - $ref: "#/components/schemas/messageContentTextAnnotationsFileCitationObject" + - $ref: "#/components/schemas/messageContentTextAnnotationsFilePathObject" + required: + - value + - annotations + required: + - type + - text + + messageContentTextAnnotationsFileCitationObject: + title: File citation + type: object + description: A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "retrieval" tool to search files. + properties: + type: + description: Always `file_citation`. + type: string + enum: + - file_citation + x-ms-enum: + name: FileCitationObjectType + modelAsString: true + values: + - value: file_citation + description: The file citation object type + text: + description: The text in the message content that needs to be replaced. + type: string + file_citation: + type: object + properties: + file_id: + description: The ID of the specific File the citation is from. + type: string + required: + - file_id + start_index: + type: integer + minimum: 0 + end_index: + type: integer + minimum: 0 + required: + - type + - text + - file_citation + - start_index + - end_index + + messageContentTextAnnotationsFilePathObject: + title: File path + type: object + description: A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. + properties: + type: + description: Always `file_path`. + type: string + enum: + - file_path + x-ms-enum: + name: FilePathObjectType + modelAsString: true + values: + - value: file_path + description: The file path object type + text: + description: The text in the message content that needs to be replaced. + type: string + file_path: + type: object + properties: + file_id: + description: The ID of the file that was generated. + type: string + required: + - file_id + start_index: + type: integer + minimum: 0 + end_index: + type: integer + minimum: 0 + required: + - type + - text + - file_path + - start_index + - end_index + + messageDeltaContentImageFileObject: + title: Image file + type: object + description: References an image File in the content of a message. + properties: + index: + type: integer + description: The index of the content part in the message. + type: + description: Always `image_file`. + type: string + enum: ["image_file"] + x-ms-enum: + name: MessageDeltaContentImageFileObjectType + modelAsString: true + values: + - value: image_file + image_file: + type: object + properties: + file_id: + description: The File ID of the image in the message content. + type: string + required: + - index + - type + + messageDeltaContentTextObject: + title: Text + type: object + description: The text content that is part of a message. + properties: + index: + type: integer + description: The index of the content part in the message. + type: + description: Always `text`. + type: string + enum: ["text"] + x-ms-enum: + name: MessageDeltaContentTextObjectType + modelAsString: true + values: + - value: text + text: + type: object + properties: + value: + description: The data that makes up the text. + type: string + annotations: + type: array + items: + oneOf: + - $ref: "#/components/schemas/messageDeltaContentTextAnnotationsFileCitationObject" + - $ref: "#/components/schemas/messageDeltaContentTextAnnotationsFilePathObject" + required: + - index + - type + + messageDeltaContentTextAnnotationsFileCitationObject: + title: File citation + type: object + description: A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "file_search" tool to search files. + properties: + index: + type: integer + description: The index of the annotation in the text content part. + type: + description: Always `file_citation`. + type: string + enum: ["file_citation"] + x-ms-enum: + name: MessageDeltaContentTextAnnotationsFileCitationObjectType + modelAsString: true + values: + - value: file_citation + text: + description: The text in the message content that needs to be replaced. + type: string + file_citation: + type: object + properties: + file_id: + description: The ID of the specific File the citation is from. + type: string + quote: + description: The specific quote in the file. + type: string + start_index: + type: integer + minimum: 0 + end_index: + type: integer + minimum: 0 + required: + - index + - type + + messageDeltaContentTextAnnotationsFilePathObject: + title: File path + type: object + description: A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. + properties: + index: + type: integer + description: The index of the annotation in the text content part. + type: + description: Always `file_path`. + type: string + enum: ["file_path"] + x-ms-enum: + name: MessageDeltaContentTextAnnotationsFilePathObjectType + modelAsString: true + values: + - value: file_path + text: + description: The text in the message content that needs to be replaced. + type: string + file_path: + type: object + properties: + file_id: + description: The ID of the file that was generated. + type: string + start_index: + type: integer + minimum: 0 + end_index: + type: integer + minimum: 0 + required: + - index + - type + + runStepObject: + type: object + title: Run steps + description: | + Represents a step in execution of a run. + properties: + id: + description: The identifier of the run step, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `assistant.run.step``. + type: string + enum: + - assistant.run.step + x-ms-enum: + name: RunStepObjectType + modelAsString: true + values: + - value: assistant.run.step + description: The object type, which is always `assistant.run.step` + created_at: + description: The Unix timestamp (in seconds) for when the run step was created. + type: integer + assistant_id: + description: The ID of the assistant associated with the run step. + type: string + thread_id: + description: The ID of the [thread](/docs/api-reference/threads) that was run. + type: string + run_id: + description: The ID of the [run](/docs/api-reference/runs) that this run step is a part of. + type: string + type: + description: The type of run step, which can be either `message_creation` or `tool_calls`. + type: string + enum: + - message_creation + - tool_calls + x-ms-enum: + name: RunStepObjectType + modelAsString: true + values: + - value: message_creation + description: The message_creation run step + - value: tool_calls + description: The tool_calls run step + status: + description: The status of the run, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`. + type: string + enum: + - in_progress + - cancelled + - failed + - completed + - expired + x-ms-enum: + name: RunStepObjectStatus + modelAsString: true + values: + - value: in_progress + description: The in_progress run status + - value: cancelled + description: The cancelled run status + - value: failed + description: The cancelled run status + - value: completed + description: The cancelled run status + - value: expired + description: The cancelled run status + step_details: + type: object + description: The details of the run step. + oneOf: + - $ref: "#/components/schemas/runStepDetailsMessageCreationObject" + - $ref: "#/components/schemas/runStepDetailsToolCallsObject" + last_error: + type: object + description: The last error associated with this run step. Will be `null` if there are no errors. + nullable: true + properties: + code: + type: string + description: One of `server_error` or `rate_limit_exceeded`. + enum: + - server_error + - rate_limit_exceeded + x-ms-enum: + name: LastErrorCode + modelAsString: true + values: + - value: server_error + description: The server_error + - value: rate_limit_exceeded + description: The rate_limit_exceeded status + message: + type: string + description: A human-readable description of the error. + required: + - code + - message + expired_at: + description: The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired. + type: integer + nullable: true + cancelled_at: + description: The Unix timestamp (in seconds) for when the run step was cancelled. + type: integer + nullable: true + failed_at: + description: The Unix timestamp (in seconds) for when the run step failed. + type: integer + nullable: true + completed_at: + description: The Unix timestamp (in seconds) for when the run step completed. + type: integer + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + required: + - id + - object + - created_at + - assistant_id + - thread_id + - run_id + - type + - status + - step_details + - last_error + - expired_at + - cancelled_at + - failed_at + - completed_at + - metadata + + runStepDeltaObject: + type: object + title: Run step delta object + description: | + Represents a run step delta i.e. any changed fields on a run step during streaming. + properties: + id: + description: The identifier of the run step, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `thread.run.step.delta`. + type: string + enum: ["thread.run.step.delta"] + x-ms-enum: + name: RunStepDeltaObjectType + modelAsString: true + values: + - value: thread.run.step.delta + delta: + description: The delta containing the fields that have changed on the run step. + type: object + properties: + step_details: + type: object + description: The details of the run step. + oneOf: + - $ref: "#/components/schemas/runStepDeltaStepDetailsMessageCreationObject" + - $ref: "#/components/schemas/runStepDeltaStepDetailsToolCallsObject" + required: + - id + - object + - delta + + listRunStepsResponse: + properties: + object: + type: string + example: list + data: + type: array + items: + $ref: "#/components/schemas/runStepObject" + first_id: + type: string + example: step_hLBK7PXBv5Lr2NQT7KLY0ag1 + last_id: + type: string + example: step_QLoItBbqwyAJEzlTy4y9kOMM + has_more: + type: boolean + example: false + required: + - object + - data + - first_id + - last_id + - has_more + + runStepDetailsMessageCreationObject: + title: Message creation + type: object + description: Details of the message creation by the run step. + properties: + type: + description: Always `message_creation``. + type: string + enum: + - message_creation + x-ms-enum: + name: RunStepDetailsMessageCreationObjectType + modelAsString: true + values: + - value: message_creation + message_creation: + type: object + properties: + message_id: + type: string + description: The ID of the message that was created by this run step. + required: + - message_id + required: + - type + - message_creation + + runStepDeltaStepDetailsMessageCreationObject: + title: Message creation + type: object + description: Details of the message creation by the run step. + properties: + type: + description: Always `message_creation`. + type: string + enum: ["message_creation"] + x-ms-enum: + name: RunStepDeltaStepDetailsMessageCreationObjectType + modelAsString: true + values: + - value: message_creation + message_creation: + type: object + properties: + message_id: + type: string + description: The ID of the message that was created by this run step. + required: + - type + + runStepDetailsToolCallsObject: + title: Tool calls + type: object + description: Details of the tool call. + properties: + type: + description: Always `tool_calls`. + type: string + enum: + - tool_calls + x-ms-enum: + name: RunStepDetailsToolCallsObjectType + modelAsString: true + values: + - value: tool_calls + tool_calls: + type: array + description: | + An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `retrieval` or `function`. + items: + type: object + oneOf: + - $ref: "#/components/schemas/runStepDetailsToolCallsCodeObject" + - $ref: "#/components/schemas/runStepDetailsToolCallsFileSearchObject" + - $ref: "#/components/schemas/runStepDetailsToolCallsFunctionObject" + required: + - type + - tool_calls + + runStepDeltaStepDetailsToolCallsObject: + title: Tool calls + type: object + description: Details of the tool call. + properties: + type: + description: Always `tool_calls`. + type: string + enum: ["tool_calls"] + x-ms-enum: + name: RunStepDeltaStepDetailsToolCallsObjectType + modelAsString: true + values: + - value: tool_calls + tool_calls: + type: array + description: | + An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search` or `function`. + items: + oneOf: + - $ref: "#/components/schemas/runStepDeltaStepDetailsToolCallsCodeObject" + - $ref: "#/components/schemas/runStepDeltaStepDetailsToolCallsFileSearchObject" + - $ref: "#/components/schemas/runStepDeltaStepDetailsToolCallsFunctionObject" + required: + - type + + runStepDetailsToolCallsCodeObject: + title: Code interpreter tool call + type: object + description: Details of the Code Interpreter tool call the run step was involved in. + properties: + id: + type: string + description: The ID of the tool call. + type: + type: string + description: The type of tool call. This is always going to be `code_interpreter` for this type of tool call. + enum: + - code_interpreter + x-ms-enum: + name: RunStepDetailsToolCallsCodeObjectType + modelAsString: true + values: + - value: code_interpreter + code_interpreter: + type: object + description: The Code Interpreter tool call definition. + required: + - input + - outputs + properties: + input: + type: string + description: The input to the Code Interpreter tool call. + outputs: + type: array + description: The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type. + items: + type: object + oneOf: + - $ref: "#/components/schemas/runStepDetailsToolCallsCodeOutputLogsObject" + - $ref: "#/components/schemas/runStepDetailsToolCallsCodeOutputImageObject" + required: + - id + - type + - code_interpreter + + runStepDeltaStepDetailsToolCallsCodeObject: + title: Code interpreter tool call + type: object + description: Details of the Code Interpreter tool call the run step was involved in. + properties: + index: + type: integer + description: The index of the tool call in the tool calls array. + id: + type: string + description: The ID of the tool call. + type: + type: string + description: The type of tool call. This is always going to be `code_interpreter` for this type of tool call. + enum: ["code_interpreter"] + x-ms-enum: + name: RunStepDeltaStepDetailsToolCallsCodeObjectType + modelAsString: true + values: + - value: code_interpreter + code_interpreter: + type: object + description: The Code Interpreter tool call definition. + properties: + input: + type: string + description: The input to the Code Interpreter tool call. + outputs: + type: array + description: The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type. + items: + type: object + oneOf: + - $ref: "#/components/schemas/runStepDeltaStepDetailsToolCallsCodeOutputLogsObject" + - $ref: "#/components/schemas/runStepDeltaStepDetailsToolCallsCodeOutputImageObject" + required: + - index + - type + + runStepDetailsToolCallsCodeOutputLogsObject: + title: Code interpreter log output + type: object + description: Text output from the Code Interpreter tool call as part of a run step. + properties: + type: + description: Always `logs`. + type: string + enum: + - logs + x-ms-enum: + name: RunStepDetailsToolCallsCodeOutputLogsObjectType + modelAsString: true + values: + - value: logs + logs: + type: string + description: The text output from the Code Interpreter tool call. + required: + - type + - logs + + runStepDeltaStepDetailsToolCallsCodeOutputLogsObject: + title: Code interpreter log output + type: object + description: Text output from the Code Interpreter tool call as part of a run step. + properties: + index: + type: integer + description: The index of the output in the outputs array. + type: + description: Always `logs`. + type: string + enum: ["logs"] + x-ms-enum: + name: RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType + modelAsString: true + values: + - value: logs + logs: + type: string + description: The text output from the Code Interpreter tool call. + required: + - index + - type + + runStepDetailsToolCallsCodeOutputImageObject: + title: Code interpreter image output + type: object + properties: + type: + description: Always `image`. + type: string + enum: + - image + x-ms-enum: + name: RunStepDetailsToolCallsCodeOutputImageObjectType + modelAsString: true + values: + - value: image + image: + type: object + properties: + file_id: + description: The file ID of the image. + type: string + required: + - file_id + required: + - type + - image + + runStepDeltaStepDetailsToolCallsCodeOutputImageObject: + title: Code interpreter image output + type: object + properties: + index: + type: integer + description: The index of the output in the outputs array. + type: + description: Always `image`. + type: string + enum: ["image"] + x-ms-enum: + name: RunStepDeltaStepDetailsToolCallsCodeOutputImageObject + modelAsString: true + values: + - value: image + image: + type: object + properties: + file_id: + description: The file ID of the image. + type: string + required: + - index + - type + + runStepDetailsToolCallsFileSearchObject: + title: File search tool call + type: object + properties: + id: + type: string + description: The ID of the tool call object. + type: + type: string + description: The type of tool call. This is always going to be `file_search` for this type of tool call. + enum: ["file_search"] + x-ms-enum: + name: RunStepDetailsToolCallsFileSearchObjectType + modelAsString: true + values: + - value: file_search + file_search: + type: object + description: For now, this is always going to be an empty object. + required: + - id + - type + - file_search + + runStepDeltaStepDetailsToolCallsFileSearchObject: + title: File search tool call + type: object + properties: + index: + type: integer + description: The index of the tool call in the tool calls array. + id: + type: string + description: The ID of the tool call object. + type: + type: string + description: The type of tool call. This is always going to be `retrieval` for this type of tool call. + enum: + - file_search + x-ms-enum: + name: RunStepDeltaStepDetailsToolCallsFileSearchObjectType + modelAsString: true + values: + - value: file_search + file_search: + type: object + description: For now, this is always going to be an empty object. + required: + - index + - type + - file_search + + runStepDetailsToolCallsFunctionObject: + type: object + title: Function tool call + properties: + id: + type: string + description: The ID of the tool call object. + type: + type: string + description: The type of tool call. This is always going to be `function` for this type of tool call. + enum: + - function + x-ms-enum: + name: RunStepDetailsToolCallsFunctionObjectType + modelAsString: true + values: + - value: function + function: + type: object + description: The definition of the function that was called. + properties: + name: + type: string + description: The name of the function. + arguments: + type: string + description: The arguments passed to the function. + output: + type: string + description: The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet. + nullable: true + required: + - name + - arguments + - output + required: + - id + - type + - function + + runStepDeltaStepDetailsToolCallsFunctionObject: + type: object + title: Function tool call + properties: + index: + type: integer + description: The index of the tool call in the tool calls array. + id: + type: string + description: The ID of the tool call object. + type: + type: string + description: The type of tool call. This is always going to be `function` for this type of tool call. + enum: ["function"] + x-ms-enum: + name: RunStepDetailsToolCallsFunctionObjectType + modelAsString: true + values: + - value: function + function: + type: object + description: The definition of the function that was called. + properties: + name: + type: string + description: The name of the function. + arguments: + type: string + description: The arguments passed to the function. + output: + type: string + description: The output of the function. This will be `null` if the outputs have not been submitted yet. + nullable: true + required: + - index + - type + + vectorStoreExpirationAfter: + type: object + title: Vector store expiration policy + description: The expiration policy for a vector store. + properties: + anchor: + description: "Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`." + type: string + enum: ["last_active_at"] + x-ms-enum: + name: VectorStoreExpirationAfterAnchor + modelAsString: true + values: + - value: last_active_at + description: The anchor timestamp after which the expiration policy applies. + days: + description: The number of days after the anchor time that the vector store will expire. + type: integer + minimum: 1 + maximum: 365 + required: + - anchor + - days + + vectorStoreObject: + type: object + title: Vector store + description: A vector store is a collection of processed files can be used by the `file_search` tool. + properties: + id: + description: The identifier, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `vector_store`. + type: string + enum: ["vector_store"] + created_at: + description: The Unix timestamp (in seconds) for when the vector store was created. + type: integer + name: + description: The name of the vector store. + type: string + usage_bytes: + description: The total number of bytes used by the files in the vector store. + type: integer + file_counts: + type: object + properties: + in_progress: + description: The number of files that are currently being processed. + type: integer + completed: + description: The number of files that have been successfully processed. + type: integer + failed: + description: The number of files that have failed to process. + type: integer + cancelled: + description: The number of files that were cancelled. + type: integer + total: + description: The total number of files. + type: integer + required: + - in_progress + - completed + - failed + - cancelled + - total + status: + description: The status of the vector store, which can be either `expired`, `in_progress`, or `completed`. A status of `completed` indicates that the vector store is ready for use. + type: string + enum: ["expired", "in_progress", "completed"] + x-ms-enum: + name: VectorStoreObjectStatus + modelAsString: true + values: + - value: expired + - value: in_progress + - value: completed + expires_after: + $ref: "#/components/schemas/vectorStoreExpirationAfter" + expires_at: + description: The Unix timestamp (in seconds) for when the vector store will expire. + type: integer + nullable: true + last_active_at: + description: The Unix timestamp (in seconds) for when the vector store was last active. + type: integer + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + required: + - id + - object + - usage_bytes + - created_at + - status + - last_active_at + - name + - bytes + - file_counts + - metadata + + createVectorStoreRequest: + type: object + additionalProperties: false + properties: + file_ids: + description: A list of file IDs that the vector store should use. Useful for tools like `file_search` that can access files. + type: array + maxItems: 500 + items: + type: string + name: + description: The name of the vector store. + type: string + expires_after: + $ref: "#/components/schemas/vectorStoreExpirationAfter" + chunking_strategy: + type: object + description: >- + The chunking strategy used to chunk the file(s). If not set, will use the + `auto` strategy. Only applicable if `file_ids` is non-empty. + oneOf: + - $ref: "#/components/schemas/autoChunkingStrategyRequestParam" + - $ref: "#/components/schemas/staticChunkingStrategyRequestParam" + metadata: + description: *metadata_description + type: object + nullable: true + + updateVectorStoreRequest: + type: object + additionalProperties: false + properties: + name: + description: The name of the vector store. + type: string + nullable: true + expires_after: + $ref: "#/components/schemas/vectorStoreExpirationAfter" + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + + listVectorStoresResponse: + properties: + object: + type: string + example: "list" + data: + type: array + items: + $ref: "#/components/schemas/vectorStoreObject" + first_id: + type: string + example: "vs_abc123" + last_id: + type: string + example: "vs_abc456" + has_more: + type: boolean + example: false + required: + - object + - data + - first_id + - last_id + - has_more + + deleteVectorStoreResponse: + type: object + properties: + id: + type: string + deleted: + type: boolean + object: + type: string + enum: [vector_store.deleted] + x-ms-enum: + name: DeleteVectorStoreResponseObject + modelAsString: true + values: + - value: vector_store.deleted + description: The delete vector store response object state + required: + - id + - object + - deleted + + vectorStoreFileObject: + type: object + title: Vector store files + description: A list of files attached to a vector store. + properties: + id: + description: The identifier, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `vector_store.file`. + type: string + enum: ["vector_store.file"] + x-ms-enum: + name: VectorStoreFileObjectType + modelAsString: true + values: + - value: vector_store.file + usage_bytes: + description: The total vector store usage in bytes. Note that this may be different from the original file size. + type: integer + created_at: + description: The Unix timestamp (in seconds) for when the vector store file was created. + type: integer + vector_store_id: + description: The ID of the vector store that the file is attached to. + type: string + status: + description: The status of the vector store file, which can be either `in_progress`, `completed`, `cancelled`, or `failed`. The status `completed` indicates that the vector store file is ready for use. + type: string + enum: ["in_progress", "completed", "cancelled", "failed"] + x-ms-enum: + name: VectorStoreFileObjectStatus + modelAsString: true + values: + - value: in_progress + - value: completed + - value: cancelled + - value: failed + last_error: + type: object + description: The last error associated with this vector store file. Will be `null` if there are no errors. + nullable: true + properties: + code: + type: string + description: One of `server_error` or `rate_limit_exceeded`. + enum: + [ + "internal_error", + "file_not_found", + "parsing_error", + "unhandled_mime_type", + ] + x-ms-enum: + name: VectorStoreFileObjectLastErrorCode + modelAsString: true + values: + - value: internal_error + - value: file_not_found + - value: parsing_error + - value: unhandled_mime_type + message: + type: string + description: A human-readable description of the error. + required: + - code + - message + chunking_strategy: + type: object + description: | + The chunking strategy used to chunk the file(s). If not set, will use the + `auto` strategy. Only applicable if `file_ids` is non-empty. + oneOf: + - $ref: "#/components/schemas/autoChunkingStrategyRequestParam" + - $ref: "#/components/schemas/staticChunkingStrategyRequestParam" + required: + - id + - object + - usage_bytes + - created_at + - vector_store_id + - status + - last_error + + otherChunkingStrategyResponseParam: + type: object + title: Other Chunking Strategy + description: | + This is returned when the chunking strategy is unknown. Typically, this is + because the file was indexed before the `chunking_strategy` concept was + introduced in the API. + additionalProperties: false + properties: + type: + type: string + description: Always `other`. + enum: + - other + x-ms-enum: + name: OtherChunkingStrategyResponseParamType + modelAsString: true + values: + - value: other + required: + - type + + staticChunkingStrategyResponseParam: + type: object + title: Static Chunking Strategy + additionalProperties: false + properties: + type: + type: string + description: Always `static`. + enum: + - static + x-ms-enum: + name: StaticChunkingStrategyResponseParamType + modelAsString: true + values: + - value: static + static: + $ref: "#/components/schemas/staticChunkingStrategy" + required: + - type + - static + + staticChunkingStrategy: + type: object + additionalProperties: false + properties: + max_chunk_size_tokens: + type: integer + minimum: 100 + maximum: 4096 + description: | + The maximum number of tokens in each chunk. The default value is `800`. + The minimum value is `100` and the maximum value is `4096`. + chunk_overlap_tokens: + type: integer + description: > + The number of tokens that overlap between chunks. The default value is + `400`. + Note that the overlap must not exceed half of `max_chunk_size_tokens`. + required: + - max_chunk_size_tokens + - chunk_overlap_tokens + + autoChunkingStrategyRequestParam: + type: object + title: Auto Chunking Strategy + description: | + The default strategy. This strategy currently uses a `max_chunk_size_tokens` + of `800` and `chunk_overlap_tokens` of `400`. + additionalProperties: false + properties: + type: + type: string + description: Always `auto`. + enum: + - auto + required: + - type + + staticChunkingStrategyRequestParam: + type: object + title: Static Chunking Strategy + additionalProperties: false + properties: + type: + type: string + description: Always `static`. + enum: + - static + static: + $ref: "#/components/schemas/staticChunkingStrategy" + required: + - type + - static + + chunkingStrategyRequestParam: + type: object + description: >- + The chunking strategy used to chunk the file(s). If not set, will use the + `auto` strategy. + oneOf: + - $ref: "#/components/schemas/autoChunkingStrategyRequestParam" + - $ref: "#/components/schemas/staticChunkingStrategyRequestParam" + + createVectorStoreFileRequest: + type: object + additionalProperties: false + properties: + file_id: + description: A File ID that the vector store should use. Useful for tools like `file_search` that can access files. + type: string + chunking_strategy: + $ref: "#/components/schemas/chunkingStrategyRequestParam" + required: + - file_id + + listVectorStoreFilesResponse: + properties: + object: + type: string + example: "list" + data: + type: array + items: + $ref: "#/components/schemas/vectorStoreFileObject" + first_id: + type: string + example: "file-abc123" + last_id: + type: string + example: "file-abc456" + has_more: + type: boolean + example: false + required: + - object + - data + - first_id + - last_id + - has_more + + deleteVectorStoreFileResponse: + type: object + properties: + id: + type: string + deleted: + type: boolean + object: + type: string + enum: [vector_store.file.deleted] + x-ms-enum: + name: DeleteVectorStoreFileResponseObject + modelAsString: true + values: + - value: vector_store.file.deleted + required: + - id + - object + - deleted + + vectorStoreFileBatchObject: + type: object + title: Vector store file batch + description: A batch of files attached to a vector store. + properties: + id: + description: The identifier, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `vector_store.file_batch`. + type: string + enum: ["vector_store.files_batch"] + x-ms-enum: + name: VectorStoreFileBatchObjectType + modelAsString: true + values: + - value: vector_store.files_batch + created_at: + description: The Unix timestamp (in seconds) for when the vector store files batch was created. + type: integer + vector_store_id: + description: The ID of the vector store that the File is attached to. + type: string + status: + description: The status of the vector store files batch, which can be either `in_progress`, `completed`, `cancelled` or `failed`. + type: string + enum: ["in_progress", "completed", "cancelled", "failed"] + x-ms-enum: + name: VectorStoreFileBatchObjectStatus + modelAsString: true + values: + - value: in_progress + - value: completed + - value: cancelled + - value: failed + file_counts: + type: object + properties: + in_progress: + description: The number of files that are currently being processed. + type: integer + completed: + description: The number of files that have been processed. + type: integer + failed: + description: The number of files that have failed to process. + type: integer + cancelled: + description: The number of files that where cancelled. + type: integer + total: + description: The total number of files. + type: integer + required: + - in_progress + - completed + - cancelled + - failed + - total + required: + - id + - object + - created_at + - vector_store_id + - status + - file_counts + + createVectorStoreFileBatchRequest: + type: object + additionalProperties: false + properties: + file_ids: + description: A list of File IDs that the vector store should use. Useful for tools like `file_search` that can access files. + type: array + minItems: 1 + maxItems: 500 + items: + type: string + chunking_strategy: + $ref: "#/components/schemas/chunkingStrategyRequestParam" + required: + - file_ids + + assistantStreamEvent: + description: | + Represents an event emitted when streaming a Run. + + Each event in a server-sent events stream has an `event` and `data` property: + + ``` + event: thread.created + data: {"id": "thread_123", "object": "thread", ...} + ``` + + We emit events whenever a new object is created, transitions to a new state, or is being + streamed in parts (deltas). For example, we emit `thread.run.created` when a new run + is created, `thread.run.completed` when a run completes, and so on. When an Assistant chooses + to create a message during a run, we emit a `thread.message.created event`, a + `thread.message.in_progress` event, many `thread.message.delta` events, and finally a + `thread.message.completed` event. + + We may add additional events over time, so we recommend handling unknown events gracefully + in your code. See the [Assistants API quickstart](/docs/assistants/overview) to learn how to + integrate the Assistants API with streaming. + oneOf: + - $ref: "#/components/schemas/threadStreamEvent" + - $ref: "#/components/schemas/runStreamEvent" + - $ref: "#/components/schemas/runStepStreamEvent" + - $ref: "#/components/schemas/messageStreamEvent" + - $ref: "#/components/schemas/errorEvent" + - $ref: "#/components/schemas/doneEvent" + + threadStreamEvent: + oneOf: + - type: object + properties: + event: + type: string + enum: ["thread.created"] + x-ms-enum: + name: ThreadStreamEventEnum + modelAsString: true + values: + - value: thread.created + description: The thread created event + data: + $ref: "#/components/schemas/threadObject" + required: + - event + - data + description: Occurs when a new thread is created. + + runStreamEvent: + oneOf: + - type: object + properties: + event: + type: string + enum: ["thread.run.created"] + x-ms-enum: + name: RunStreamEventCreated + modelAsString: true + values: + - value: thread.run.created + data: + $ref: "#/components/schemas/runObject" + required: + - event + - data + description: Occurs when a new run is created. + - type: object + properties: + event: + type: string + enum: ["thread.run.queued"] + x-ms-enum: + name: RunStreamEventQueued + modelAsString: true + values: + - value: thread.run.queued + data: + $ref: "#/components/schemas/runObject" + required: + - event + - data + description: Occurs when a run moves to a `queued` status. + - type: object + properties: + event: + type: string + enum: ["thread.run.in_progress"] + x-ms-enum: + name: RunStreamEventInProgress + modelAsString: true + values: + - value: thread.run.in_progress + data: + $ref: "#/components/schemas/runObject" + required: + - event + - data + description: Occurs when a run moves to an `in_progress` status. + - type: object + properties: + event: + type: string + enum: ["thread.run.requires_action"] + x-ms-enum: + name: RunStreamEventRequiresAction + modelAsString: true + values: + - value: thread.run.requires_action + data: + $ref: "#/components/schemas/runObject" + required: + - event + - data + description: Occurs when a run moves to a `requires_action` status. + - type: object + properties: + event: + type: string + enum: ["thread.run.completed"] + x-ms-enum: + name: RunStreamEventCompleted + modelAsString: true + values: + - value: thread.run.completed + data: + $ref: "#/components/schemas/runObject" + required: + - event + - data + description: Occurs when a run is completed. + - type: object + properties: + event: + type: string + enum: ["thread.run.failed"] + x-ms-enum: + name: RunStreamEventFailed + modelAsString: true + values: + - value: thread.run.failed + data: + $ref: "#/components/schemas/runObject" + required: + - event + - data + description: Occurs when a run fails. + - type: object + properties: + event: + type: string + enum: ["thread.run.cancelling"] + x-ms-enum: + name: RunStreamEventCancelling + modelAsString: true + values: + - value: thread.run.cancelling + data: + $ref: "#/components/schemas/runObject" + required: + - event + - data + description: Occurs when a run moves to a `cancelling` status. + - type: object + properties: + event: + type: string + enum: ["thread.run.cancelled"] + x-ms-enum: + name: RunStreamEventCancelled + modelAsString: true + values: + - value: thread.run.cancelled + data: + $ref: "#/components/schemas/runObject" + required: + - event + - data + description: Occurs when a run is cancelled. + - type: object + properties: + event: + type: string + enum: ["thread.run.expired"] + x-ms-enum: + name: RunStreamEventExpired + modelAsString: true + values: + - value: thread.run.expired + data: + $ref: "#/components/schemas/runObject" + required: + - event + - data + description: Occurs when a run expires. + + runStepStreamEvent: + oneOf: + - type: object + properties: + event: + type: string + enum: ["thread.run.step.created"] + x-ms-enum: + name: RunStepStreamEventCreated + modelAsString: true + values: + - value: thread.run.step.created + data: + $ref: "#/components/schemas/runStepObject" + required: + - event + - data + description: Occurs when a run step is created. + + - type: object + properties: + event: + type: string + enum: ["thread.run.step.in_progress"] + x-ms-enum: + name: RunStepStreamEventInProgress + modelAsString: true + values: + - value: thread.run.step.in_progress + data: + $ref: "#/components/schemas/runStepObject" + required: + - event + - data + description: Occurs when a run step moves to an `in_progress` state. + - type: object + properties: + event: + type: string + enum: ["thread.run.step.delta"] + x-ms-enum: + name: RunStepStreamEventDelta + modelAsString: true + values: + - value: thread.run.step.delta + data: + $ref: "#/components/schemas/runStepDeltaObject" + required: + - event + - data + description: Occurs when parts of a run step are being streamed. + - type: object + properties: + event: + type: string + enum: ["thread.run.step.completed"] + x-ms-enum: + name: RunStepStreamEventCompleted + modelAsString: true + values: + - value: thread.run.step.completed + data: + $ref: "#/components/schemas/runStepObject" + required: + - event + - data + description: Occurs when a run step is completed. + - type: object + properties: + event: + type: string + enum: ["thread.run.step.failed"] + x-ms-enum: + name: RunStepStreamEventFailed + modelAsString: true + values: + - value: thread.run.step.failed + data: + $ref: "#/components/schemas/runStepObject" + required: + - event + - data + description: Occurs when a run step fails. + - type: object + properties: + event: + type: string + enum: ["thread.run.step.cancelled"] + x-ms-enum: + name: RunStepStreamEventCancelled + modelAsString: true + values: + - value: thread.run.step.cancelled + data: + $ref: "#/components/schemas/runStepObject" + required: + - event + - data + description: Occurs when a run step is cancelled. + - type: object + properties: + event: + type: string + enum: ["thread.run.step.expired"] + x-ms-enum: + name: RunStepStreamEventExpired + modelAsString: true + values: + - value: thread.run.step.expired + data: + $ref: "#/components/schemas/runStepObject" + required: + - event + - data + description: Occurs when a run step expires. + + messageStreamEvent: + oneOf: + - type: object + properties: + event: + type: string + enum: ["thread.message.created"] + x-ms-enum: + name: MessageStreamEventCreated + modelAsString: true + values: + - value: thread.message.created + data: + $ref: "#/components/schemas/messageObject" + required: + - event + - data + description: Occurs when a message is created. + - type: object + properties: + event: + type: string + enum: ["thread.message.in_progress"] + x-ms-enum: + name: MessageStreamEventInProgress + modelAsString: true + values: + - value: thread.message.in_progress + data: + $ref: "#/components/schemas/messageObject" + required: + - event + - data + description: Occurs when a message moves to an `in_progress` state. + - type: object + properties: + event: + type: string + enum: ["thread.message.delta"] + x-ms-enum: + name: MessageStreamEventDelta + modelAsString: true + values: + - value: thread.message.delta + data: + $ref: "#/components/schemas/messageDeltaObject" + required: + - event + - data + description: Occurs when parts of a message are being streamed. + - type: object + properties: + event: + type: string + enum: ["thread.message.completed"] + x-ms-enum: + name: MessageStreamEventCompleted + modelAsString: true + values: + - value: thread.message.completed + data: + $ref: "#/components/schemas/messageObject" + required: + - event + - data + description: Occurs when a message is completed. + - type: object + properties: + event: + type: string + enum: ["thread.message.incomplete"] + x-ms-enum: + name: MessageStreamEventIncomplete + modelAsString: true + values: + - value: thread.message.incomplete + data: + $ref: "#/components/schemas/messageObject" + required: + - event + - data + description: Occurs when a message ends before it is completed. + + errorEvent: + type: object + properties: + event: + type: string + enum: ["error"] + x-ms-enum: + name: ErrorEventEnum + modelAsString: true + values: + - value: error + data: + $ref: "#/components/schemas/error" + required: + - event + - data + description: Occurs when an error occurs. This can happen due to an internal server error or a timeout. + + doneEvent: + type: object + properties: + event: + type: string + enum: ["done"] + x-ms-enum: + name: DoneEventEnum + modelAsString: true + values: + - value: done + data: + type: string + enum: ["[DONE]"] + x-ms-enum: + name: DoneEventDataEnum + modelAsString: true + values: + - value: "[DONE]" + required: + - event + - data + description: Occurs when a stream ends. + securitySchemes: + bearer: + type: oauth2 + flows: + implicit: + authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize + scopes: {} + x-tokenInfoFunc: api.middleware.auth.bearer_auth + x-scopeValidateFunc: api.middleware.auth.validate_scopes + apiKey: + type: apiKey + name: api-key + in: header diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md index 340fdd0967f3..9f30703c02fe 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md @@ -252,3 +252,18 @@ These settings apply only when `--tag=release_2024_07_01_preview_autogen` is spe ``` yaml $(tag) == 'release_2024_07_01_preview_autogen' input-file: preview/2024-07-01-preview/generated.json ``` + +## AzureOpenAI 2024-08-01-preview +These settings apply only when `--tag=release_2024_08_01_preview` is specified on the command line. + +``` yaml $(tag) == 'release_2024_08_01_preview' +input-file: preview/2024-08-01-preview/inference.json +``` + + +## AzureOpenAI 2024-09-01-preview +These settings apply only when `--tag=release_2024_09_01_preview` is specified on the command line. + +``` yaml $(tag) == 'release_2024_09_01_preview' +input-file: preview/2024-09-01-preview/inference.json +``` From 8db3b5bb8d09fd06a6b053a1f5baf711d0f56b0a Mon Sep 17 00:00:00 2001 From: amruthashree18 <110563260+amruthashree18@users.noreply.github.com> Date: Wed, 2 Oct 2024 15:06:37 -0500 Subject: [PATCH 32/47] =?UTF-8?q?Updating=20the=20API=20specification=20fo?= =?UTF-8?q?r=20confidential=20ledger=20for=20custom=20endpoints=20an?= =?UTF-8?q?=E2=80=A6=20(#30290)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Updating the API spec for confidential ledger for custom endpoints and custom roles change * Updating endpoint name and few minor changes * Updating API version and some minor spec updates * Fixing validation errors * Fixing swagger validation errors * Updating JSON reference * Fixing schema validation issues * Fixing minor issue * Fixing schema validation errors * Fixing schema validation errors * Fixing validation errors * Fixing validation errors * Fixinf validation errors * Fixing errors * Fixinf schema * Updating user role schema * Updating role name and action schema * Updating schema * Fixing schema validation * Updating API parameters * Fixinf schema errors * Updating properties * Updating definition * Updating paramter names * Fixinf schema errors * Fixing schema validation * Fixing schematic errors * Fixing minor issue * Fixing errors * Fixing property errors * Validation errors fixing * Fixing schema definition errors * Fixing validation errors * Fixing type errors * Fixing type errors * Fixing type errors * Fixing type errors * Fixing type errors * Fixing type errors * Fixing type errors * Fixing type errors * Fixing type errors * Fixing type errors * Fixing type errors * Addressing PR review comments * Updating query body for patch runtime options * Updating Assignedroles * Addressing review comments from https://github.com/Azure/azure-rest-api-specs/issues/30481 * Fixing schema * Fixing schema * Fixing schema * Fixing schema * Fixing schema * Fixing schema * Fixing schema * Fixing schema * Fixing schema * Fixing stable version differences * Fixing schema * Fixing additional properties of metadata * Fixing additional properties of Metadata * Adding new endpoint to return multiple user roles * Updating schema * Updating schema * Updating app/users endpoint * Updating schema * Adding new endpoint for user Id lookup for app/users endpoint * Updating schema * Updating API version and schema * Updating user roles definition * Updating user details parameter * Updating user parameter * Updating Addressing review comments * Updated module parameter * Updating get response for modules endpoint * Updating response body in examples * Updating new endpoint names * Updating filenames * Updating example * Updating role name parameter * Fixing the lint errors * Reverting * Addressing some of review comments --- .npmrc | 2 +- .../preview/2024-08-22-preview/common.json | 47 + .../confidentialledger.json | 1863 +++++++++++++++++ .../examples/identity/GetLedgerIdentity.json | 14 + .../examples/ledger/CreateLedgerEntry.json | 19 + .../ledger/CreateOrUpdateLedgerUsers.json | 24 + .../examples/ledger/CreateOrUpdateUser.json | 18 + .../ledger/CreateUserDefinedEndpoint.json | 29 + .../examples/ledger/DeleteUser.json | 10 + .../ledger/DeleteUserDefinedRole.json | 11 + .../examples/ledger/GetConstitution.json | 14 + .../ledger/GetCurrentLedgerEntry.json | 15 + .../examples/ledger/GetEnclaveQuotes.json | 27 + .../examples/ledger/GetLedgerEntry.json | 19 + .../examples/ledger/GetLedgerUsers.json | 18 + .../examples/ledger/GetReceipt.json | 50 + .../examples/ledger/GetRuntimeOptions.json | 18 + .../examples/ledger/GetTransactionStatus.json | 15 + .../examples/ledger/GetUser.json | 15 + .../ledger/GetUserDefinedEndpoint.json | 28 + .../ledger/GetUserDefinedEndpointsModule.json | 15 + .../examples/ledger/GetUserDefinedRole.json | 17 + .../examples/ledger/ListCollections.json | 21 + .../ledger/ListConsortiumMembers.json | 19 + .../examples/ledger/ListLedgerEntries.json | 23 + .../examples/ledger/ListLedgerUsers.json | 35 + .../examples/ledger/ListUsers.json | 27 + .../examples/ledger/PatchRuntimeOptions.json | 22 + .../examples/ledger/PatchUserDefinedRole.json | 16 + .../examples/ledger/PutUserDefinedRole.json | 16 + .../2024-08-22-preview/identityservice.json | 90 + .../confidentialledger/data-plane/readme.md | 23 +- 32 files changed, 2577 insertions(+), 3 deletions(-) create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/common.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/confidentialledger.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/identity/GetLedgerIdentity.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateLedgerEntry.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateOrUpdateLedgerUsers.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateOrUpdateUser.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateUserDefinedEndpoint.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/DeleteUser.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/DeleteUserDefinedRole.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetConstitution.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetCurrentLedgerEntry.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetEnclaveQuotes.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetLedgerEntry.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetLedgerUsers.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetReceipt.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetRuntimeOptions.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetTransactionStatus.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUser.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUserDefinedEndpoint.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUserDefinedEndpointsModule.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUserDefinedRole.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListCollections.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListConsortiumMembers.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListLedgerEntries.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListLedgerUsers.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListUsers.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/PatchRuntimeOptions.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/PatchUserDefinedRole.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/PutUserDefinedRole.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/identityservice.json diff --git a/.npmrc b/.npmrc index b6f27f135954..4fd021952d5a 100644 --- a/.npmrc +++ b/.npmrc @@ -1 +1 @@ -engine-strict=true +engine-strict=true \ No newline at end of file diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/common.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/common.json new file mode 100644 index 000000000000..faeb586d4b36 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/common.json @@ -0,0 +1,47 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-22-preview", + "title": "ConfidentialLedgerClient", + "description": "The ConfidentialLedgerClient writes and retrieves ledger entries against the Confidential Ledger service." + }, + "paths": {}, + "definitions": { + "ConfidentialLedgerError": { + "description": "An error response from Confidential Ledger.", + "properties": { + "error": { + "readOnly": true, + "$ref": "#/definitions/ConfidentialLedgerErrorBody" + } + }, + "type": "object" + }, + "ConfidentialLedgerErrorBody": { + "description": "An error response from Confidential Ledger.", + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "The error code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The error message." + } + }, + "x-nullable": true, + "type": "object" + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to be used with the HTTP request." + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/confidentialledger.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/confidentialledger.json new file mode 100644 index 000000000000..590149878f02 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/confidentialledger.json @@ -0,0 +1,1863 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-22-preview", + "title": "ConfidentialLedgerClient", + "description": "The ConfidentialLedgerClient writes and retrieves ledger entries against the Confidential Ledger service." + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "name": "endpoint", + "description": "The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com", + "required": true, + "type": "string", + "in": "path", + "format": "url", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/app/governance/constitution": { + "get": { + "operationId": "GetConstitution", + "x-ms-examples": { + "GetConstitution": { + "$ref": "./examples/ledger/GetConstitution.json" + } + }, + "summary": "Gets the constitution used for governance.", + "description": "The constitution is a script that assesses and applies proposals from consortium members.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The constitution.", + "schema": { + "$ref": "#/definitions/Constitution" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/governance/members": { + "get": { + "operationId": "ListConsortiumMembers", + "x-ms-examples": { + "ListConsortiumMembers": { + "$ref": "./examples/ledger/ListConsortiumMembers.json" + } + }, + "x-ms-pageable": { + "itemName": "members", + "nextLinkName": "nextLink" + }, + "summary": "Lists the consortium members.", + "description": "Consortium members can manage the Confidential Ledger.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of consortium members.", + "schema": { + "$ref": "#/definitions/Consortium" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/enclaveQuotes": { + "get": { + "operationId": "GetEnclaveQuotes", + "x-ms-examples": { + "GetEnclaveQuotes": { + "$ref": "./examples/ledger/GetEnclaveQuotes.json" + } + }, + "summary": "Gets quotes for all nodes of the Confidential Ledger.", + "description": "A quote is an SGX enclave measurement that can be used to verify the validity of a node and its enclave.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Response containing enclave quotes.", + "schema": { + "$ref": "#/definitions/ConfidentialLedgerEnclaves" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/collections": { + "get": { + "operationId": "ListCollections", + "x-ms-examples": { + "GetCollectionIds": { + "$ref": "./examples/ledger/ListCollections.json" + } + }, + "x-ms-pageable": { + "itemName": "collections", + "nextLinkName": "nextLink" + }, + "summary": "Retrieves a list of collection ids present in the Confidential Ledger", + "description": "Collection ids are user-created collections of ledger entries", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of collections", + "schema": { + "$ref": "#/definitions/PagedCollections" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/transactions": { + "get": { + "operationId": "ListLedgerEntries", + "x-ms-examples": { + "ListLedgerEntries": { + "$ref": "./examples/ledger/ListLedgerEntries.json" + } + }, + "x-ms-pageable": { + "itemName": "entries", + "nextLinkName": "nextLink" + }, + "summary": "Gets ledger entries from a collection corresponding to a range.", + "description": "A collection id may optionally be specified. Only entries in the specified (or default) collection will be returned.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/CollectionIdParameter" + }, + { + "$ref": "#/parameters/TransactionIdFromParameter" + }, + { + "$ref": "#/parameters/TransactionIdToParameter" + } + ], + "responses": { + "200": { + "description": "Ledger entries in the specified range.", + "schema": { + "$ref": "#/definitions/PagedLedgerEntries" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + }, + "post": { + "operationId": "CreateLedgerEntry", + "x-ms-examples": { + "CreateLedgerEntry": { + "$ref": "./examples/ledger/CreateLedgerEntry.json" + } + }, + "summary": "Writes a ledger entry.", + "description": "A collection id may optionally be specified.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/CollectionIdParameter" + }, + { + "in": "body", + "name": "entry", + "description": "Ledger entry.", + "required": true, + "schema": { + "$ref": "#/definitions/LedgerEntry" + } + } + ], + "responses": { + "200": { + "description": "Returns the transaction id at which the write will be durably stored.", + "headers": { + "x-ms-ccf-transaction-id": { + "type": "string", + "description": "The transaction id at which this write will become durable." + } + }, + "schema": { + "$ref": "#/definitions/LedgerWriteResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/transactions/{transactionId}": { + "get": { + "operationId": "GetLedgerEntry", + "x-ms-examples": { + "GetLedgerEntry": { + "$ref": "./examples/ledger/GetLedgerEntry.json" + } + }, + "summary": "Gets the ledger entry at the specified transaction id. A collection id may optionally be specified to indicate the collection from which to fetch the value.", + "description": "To return older ledger entries, the relevant sections of the ledger must be read from disk and validated. To prevent blocking within the enclave, the response will indicate whether the entry is ready and part of the response, or if the loading is still ongoing.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/CollectionIdParameter" + }, + { + "$ref": "#/parameters/TransactionIdParameter" + } + ], + "responses": { + "200": { + "description": "The result of querying the Confidential Ledger.", + "schema": { + "$ref": "#/definitions/LedgerQueryResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/transactions/{transactionId}/receipt": { + "get": { + "operationId": "GetReceipt", + "x-ms-examples": { + "GetReceipt": { + "$ref": "./examples/ledger/GetReceipt.json" + } + }, + "summary": "Gets a receipt certifying ledger contents at a particular transaction id.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TransactionIdParameter" + } + ], + "responses": { + "200": { + "description": "The receipt for the write occurring at the transaction id.", + "schema": { + "$ref": "#/definitions/TransactionReceipt" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/transactions/{transactionId}/status": { + "get": { + "operationId": "GetTransactionStatus", + "x-ms-examples": { + "GetTransactionStatus": { + "$ref": "./examples/ledger/GetTransactionStatus.json" + } + }, + "summary": "Gets the status of an entry identified by a transaction id.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TransactionIdParameter" + } + ], + "responses": { + "200": { + "description": "The status of the entry recorded at the specified transaction id.", + "schema": { + "$ref": "#/definitions/TransactionStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/transactions/current": { + "get": { + "operationId": "GetCurrentLedgerEntry", + "x-ms-examples": { + "GetCurrentLedgerEntry": { + "$ref": "./examples/ledger/GetCurrentLedgerEntry.json" + } + }, + "summary": "Gets the current value available in the ledger.", + "description": "A collection id may optionally be specified.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/CollectionIdParameter" + } + ], + "responses": { + "200": { + "description": "The current ledger entry available on the receiving node. Non-primary nodes may return older values.", + "schema": { + "$ref": "#/definitions/LedgerEntry" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/users": { + "get": { + "operationId": "ListUsers", + "x-ms-examples": { + "ListUserEntries": { + "$ref": "./examples/ledger/ListUsers.json" + } + }, + "x-ms-pageable": { + "itemName": "ledgerUsers", + "nextLinkName": "nextLink" + }, + "summary": "Gets details on a list of users.", + "description": "All users' object IDs and single role per user will be returned.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Users in the paged specified range.", + "schema": { + "$ref": "#/definitions/PagedUsers" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/ledgerUsers": { + "get": { + "operationId": "ListLedgerUsers", + "x-ms-examples": { + "ListLedgerUsersEntries": { + "$ref": "./examples/ledger/ListLedgerUsers.json" + } + }, + "x-ms-pageable": { + "itemName": "ledgerUsers", + "nextLinkName": "nextLink" + }, + "summary": "Gets details on a list of users.", + "description": "All users' object IDs and multiple roles will be returned.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Users in the paged specified range.", + "schema": { + "$ref": "#/definitions/PagedLedgerUsers" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/users/{userId}": { + "delete": { + "operationId": "DeleteUser", + "x-ms-examples": { + "DeleteUser": { + "$ref": "./examples/ledger/DeleteUser.json" + } + }, + "summary": "Deletes a user from the Confidential Ledger.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + } + ], + "responses": { + "204": { + "description": "The specified user is deleted." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + }, + "get": { + "operationId": "GetUser", + "x-ms-examples": { + "GetUser": { + "$ref": "./examples/ledger/GetUser.json" + } + }, + "summary": "Gets a user.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + } + ], + "responses": { + "200": { + "description": "Details about the specified user.", + "schema": { + "$ref": "#/definitions/LedgerUser" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + }, + "patch": { + "operationId": "CreateOrUpdateUser", + "x-ms-examples": { + "CreateOrUpdateUser": { + "$ref": "./examples/ledger/CreateOrUpdateUser.json" + } + }, + "summary": "Adds a user or updates a user's fields.", + "description": "A JSON merge patch is applied for existing users", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/UserDetailsParameter" + } + ], + "responses": { + "200": { + "description": "User created or updated successfully.", + "schema": { + "$ref": "#/definitions/LedgerUser" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/ledgerUsers/{userId}": { + "delete": { + "operationId": "DeleteLedgerUsers", + "x-ms-examples": { + "DeleteUser": { + "$ref": "./examples/ledger/DeleteUser.json" + } + }, + "summary": "Deletes a user with multiple roles from the Confidential Ledger.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + } + ], + "responses": { + "204": { + "description": "The specified user is deleted." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + }, + "get": { + "operationId": "GetLedgerUsers", + "x-ms-examples": { + "GetLedgerUsers": { + "$ref": "./examples/ledger/GetLedgerUsers.json" + } + }, + "summary": "Gets a user with multiple roles.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + } + ], + "responses": { + "200": { + "description": "Details about the specified user.", + "schema": { + "$ref": "#/definitions/LedgerUserMultipleRoles" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + }, + "patch": { + "operationId": "CreateOrUpdateLedgerUsers", + "x-ms-examples": { + "CreateOrUpdateLedgerUsers": { + "$ref": "./examples/ledger/CreateOrUpdateLedgerUsers.json" + } + }, + "summary": "Adds a user or updates a user's fields.", + "description": "A JSON merge patch is applied for existing users", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/UserMultipleRolesParameter" + } + ], + "responses": { + "200": { + "description": "User created or updated successfully.", + "schema": { + "$ref": "#/definitions/LedgerUserMultipleRoles" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/userDefinedEndpoints": { + "get": { + "operationId": "GetUserDefinedEndpoint", + "x-ms-examples": { + "GetUserDefinedEndpoint": { + "$ref": "./examples/ledger/GetUserDefinedEndpoint.json" + } + }, + "summary": "Gets a user defined endpoint.", + "description": "Returns the user defined endpoint in the ACL instance", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Gets the user defined endpoints.", + "schema": { + "$ref": "#/definitions/Bundle" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + }, + "put": { + "operationId": "CreateUserDefinedEndpoint", + "x-ms-examples": { + "CreateUserDefinedEndpoint": { + "$ref": "./examples/ledger/CreateUserDefinedEndpoint.json" + } + }, + "summary": "Creates a user defined endpoint.", + "description": "Creates the user defined endpoint in the ACL instance ", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/BundleParameter" + } + ], + "responses": { + "201": { + "description": "The user defined endpoint is created." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/userDefinedEndpoints/runTimeOptions": { + "get": { + "operationId": "GetRuntimeOptions", + "x-ms-examples": { + "GetRuntimeOptions": { + "$ref": "./examples/ledger/GetRuntimeOptions.json" + } + }, + "summary": "Runtime options for user defined endpoints.", + "description": "It returns the runtime options", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": " Runtime options for user defined endpoints.", + "schema": { + "$ref": "#/definitions/JSRuntimeOptions" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + }, + "patch": { + "operationId": "PatchRuntimeOptions", + "x-ms-examples": { + "PatchRuntimeOptions": { + "$ref": "./examples/ledger/PatchRuntimeOptions.json" + } + }, + "summary": "Runtime options for user defined endpoints.", + "description": "Updates the runtime options.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/JSRuntimeOptionsParameter" + } + ], + "responses": { + "200": { + "description": " Runtime options for user defined endpoints.", + "schema": { + "$ref": "#/definitions/JSRuntimeOptions" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/userDefinedEndpoints/modules": { + "get": { + "operationId": "GetUserDefinedEndpointsModule", + "x-ms-examples": { + "GetUserDefinedEndpointsModule": { + "$ref": "./examples/ledger/GetUserDefinedEndpointsModule.json" + } + }, + "summary": "Module for user defined endpoints.", + "description": "It gets the module for the user defined endpoint.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ModuleNameParameter" + } + ], + "responses": { + "200": { + "description": "Module for user defined endpoints.", + "schema": { + "$ref": "#/definitions/ModuleDef" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/roles": { + "get": { + "operationId": "GetUserDefinedRole", + "x-ms-examples": { + "GetUserDefinedRole": { + "$ref": "./examples/ledger/GetUserDefinedRole.json" + } + }, + "summary": "Gets role actions for user defined roles", + "description": "user defined roles allow users to define and manage app specific AuthZ policy.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/RoleNameParameter" + } + ], + "responses": { + "200": { + "description": "Gets role actions for user defined roles", + "schema": { + "$ref": "#/definitions/Role" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + }, + "put": { + "operationId": "PutUserDefinedRole", + "x-ms-examples": { + "PutUserDefinedRole": { + "$ref": "./examples/ledger/PutUserDefinedRole.json" + } + }, + "summary": "Creates new roles and their actions", + "description": "User defined roles allow users to define and manage app specific AuthZ policy.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/RoleParameter" + } + ], + "responses": { + "200": { + "description": "Successfully added the roles." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + }, + "patch": { + "operationId": "PatchUserDefinedRole", + "x-ms-examples": { + "PatchUserDefinedRole": { + "$ref": "./examples/ledger/PatchUserDefinedRole.json" + } + }, + "summary": "Patch replaces the allowed action on existing roles", + "description": "User defined roles allow users to define and manage app specific AuthZ policy.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/RoleParameter" + } + ], + "responses": { + "200": { + "description": "Successfully patched the roles." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + }, + "delete": { + "operationId": "DeleteUserDefinedRole", + "x-ms-examples": { + "DeleteUserDefinedRole": { + "$ref": "./examples/ledger/DeleteUserDefinedRole.json" + } + }, + "summary": "Deletes user defined roles", + "description": "A user defined role allows the users to create and manage their own role actions using the API.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/RoleNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the user roles." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + } + }, + "definitions": { + "ApplicationClaims": { + "description": "List of application claims.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationClaim" + } + }, + "ApplicationClaim": { + "description": "A claim of a ledger application.", + "required": [ + "kind" + ], + "properties": { + "digest": { + "$ref": "#/definitions/ClaimDigest" + }, + "kind": { + "$ref": "#/definitions/ApplicationClaimKind" + }, + "ledgerEntry": { + "$ref": "#/definitions/LedgerEntryClaim" + } + }, + "type": "object" + }, + "ApplicationClaimKind": { + "type": "string", + "description": "Represents the kind of an application claim.", + "enum": [ + "LedgerEntry", + "ClaimDigest" + ], + "x-ms-enum": { + "name": "ApplicationClaimKind", + "modelAsString": true + } + }, + "ApplicationClaimProtocol": { + "type": "string", + "description": "Represents the protocol to be used to compute the digest of a claim from the given claim data.", + "enum": [ + "LedgerEntryV1" + ], + "x-ms-enum": { + "name": "ApplicationClaimProtocol", + "modelAsString": true + } + }, + "ClaimDigest": { + "description": "An application claim in digested form.", + "required": [ + "protocol" + ], + "properties": { + "value": { + "type": "string", + "description": "The digest of the application claim, in hexadecimal form." + }, + "protocol": { + "$ref": "#/definitions/ApplicationClaimProtocol" + } + }, + "type": "object" + }, + "LedgerEntryClaim": { + "description": "An application claim derived from ledger entry data.", + "required": [ + "protocol" + ], + "properties": { + "collectionId": { + "description": "Identifier of a collection.", + "type": "string" + }, + "contents": { + "description": "Contents of a ledger entry.", + "type": "string" + }, + "secretKey": { + "type": "string", + "description": "Base64-encoded secret key." + }, + "protocol": { + "$ref": "#/definitions/ApplicationClaimProtocol" + } + }, + "type": "object" + }, + "ConfidentialLedgerEnclaves": { + "description": "Information about the enclaves running the Confidential Ledger.", + "required": [ + "currentNodeId", + "enclaveQuotes" + ], + "properties": { + "currentNodeId": { + "description": "Id of the Confidential Ledger node responding to the request.", + "$ref": "#/definitions/EntityId" + }, + "enclaveQuotes": { + "$ref": "#/definitions/EnclaveQuotes" + } + }, + "type": "object" + }, + "Consortium": { + "description": "List of members in the consortium.", + "required": [ + "members" + ], + "properties": { + "members": { + "type": "array", + "items": { + "$ref": "#/definitions/ConsortiumMember" + } + }, + "nextLink": { + "description": "Path from which to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ConsortiumMember": { + "description": "Describes a member of the consortium.", + "required": [ + "certificate", + "id" + ], + "properties": { + "certificate": { + "type": "string", + "description": "PEM-encoded certificate associated with the member." + }, + "id": { + "description": "Identifier assigned to the member.", + "$ref": "#/definitions/EntityId" + } + }, + "type": "object" + }, + "Constitution": { + "description": "The governance script for the application.", + "required": [ + "digest", + "script" + ], + "properties": { + "digest": { + "description": "SHA256 digest of the constitution script.", + "type": "string" + }, + "script": { + "description": "Contents of the constitution.", + "type": "string" + } + }, + "type": "object" + }, + "EnclaveQuote": { + "description": "Contains the enclave quote.", + "required": [ + "nodeId", + "quoteVersion", + "raw" + ], + "properties": { + "nodeId": { + "description": "ID assigned to this node.", + "$ref": "#/definitions/EntityId" + }, + "mrenclave": { + "description": "MRENCLAVE value of the code running in the enclave.", + "type": "string" + }, + "quoteVersion": { + "description": "Version of the quote presented.", + "type": "string" + }, + "raw": { + "description": "Raw SGX quote, parsable by tools like Open Enclave's oeverify.", + "type": "string" + } + }, + "type": "object" + }, + "EnclaveQuotes": { + "description": "Dictionary of enclave quotes, indexed by node id.", + "additionalProperties": { + "$ref": "#/definitions/EnclaveQuote" + }, + "type": "object" + }, + "EntityId": { + "description": "Identifier for an entity.", + "type": "string" + }, + "LedgerEntries": { + "description": "Array of ledger entries.", + "type": "array", + "items": { + "$ref": "#/definitions/LedgerEntry" + } + }, + "LedgerEntry": { + "description": "An entry in the ledger.", + "required": [ + "contents" + ], + "properties": { + "contents": { + "type": "string", + "description": "Contents of the ledger entry." + }, + "collectionId": { + "type": "string", + "readOnly": true + }, + "transactionId": { + "$ref": "#/definitions/TransactionId", + "readOnly": true + } + }, + "type": "object" + }, + "LedgerQueryResult": { + "description": "The result of querying for a ledger entry from an older transaction id. The ledger entry is available in the response only if the returned state is Ready.", + "required": [ + "state" + ], + "properties": { + "state": { + "$ref": "#/definitions/LedgerQueryState" + }, + "entry": { + "description": "The ledger entry found as a result of the query. This is only available if the query is in Ready state.", + "$ref": "#/definitions/LedgerEntry" + } + }, + "type": "object" + }, + "LedgerQueryState": { + "description": "State of a ledger query.", + "type": "string", + "enum": [ + "Loading", + "Ready" + ], + "x-ms-enum": { + "name": "ConfidentialLedgerQueryState", + "modelAsString": true + } + }, + "LedgerUser": { + "description": "Details about a Confidential Ledger user.", + "required": [ + "assignedRole" + ], + "properties": { + "assignedRole": { + "$ref": "#/definitions/LedgerUserRole" + }, + "userId": { + "$ref": "#/definitions/UserId", + "readOnly": true + } + }, + "type": "object" + }, + "LedgerUserMultipleRoles": { + "description": "Details about a Confidential Ledger user.", + "required": [ + "assignedRoles" + ], + "properties": { + "assignedRoles": { + "$ref": "#/definitions/LedgerUserMultipleRolesDef" + }, + "userId": { + "$ref": "#/definitions/UserId", + "readOnly": true + } + }, + "type": "object" + }, + "LedgerUserRole": { + "type": "string", + "description": "Represents an assignable role.", + "enum": [ + "Administrator", + "Contributor", + "Reader" + ], + "x-ms-enum": { + "name": "ConfidentialLedgerUserRoleName", + "modelAsString": true + } + }, + "LedgerUserMultipleRolesDef": { + "description": "Represents an assignable role.", + "type": "array", + "items": { + "$ref": "#/definitions/MultipleRolesList" + } + }, + "MultipleRolesList": { + "description": "Represents list of roles for single user", + "type": "string", + "enum": [ + "Administrator", + "Contributor", + "Reader" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ConfidentialLedgerUserRoleName" + } + }, + "LedgerWriteResult": { + "description": "Returned as a result of a write to the Confidential Ledger, the transaction id in the response indicates when the write will become durable.", + "required": [ + "collectionId" + ], + "properties": { + "collectionId": { + "type": "string" + } + }, + "type": "object" + }, + "MerkleProof": { + "description": "The Merkle proof verifying a transaction.", + "type": "array", + "items": { + "$ref": "#/definitions/MerkleProofElement" + } + }, + "MerkleProofElement": { + "description": "An item in the Merkle proof.", + "type": "object", + "properties": { + "left": { + "type": "string" + }, + "right": { + "type": "string" + } + } + }, + "PagedLedgerEntries": { + "description": "Paginated ledger entries returned in response to a query.", + "type": "object", + "required": [ + "state", + "entries" + ], + "properties": { + "state": { + "$ref": "#/definitions/LedgerQueryState" + }, + "nextLink": { + "description": "Path from which to retrieve the next page of results.", + "type": "string" + }, + "entries": { + "$ref": "#/definitions/LedgerEntries" + } + } + }, + "Pem": { + "type": "string" + }, + "PemArray": { + "items": { + "$ref": "#/definitions/Pem" + }, + "type": "array" + }, + "ReceiptContents": { + "properties": { + "cert": { + "type": "string" + }, + "leaf": { + "type": "string" + }, + "leafComponents": { + "$ref": "#/definitions/ReceiptLeafComponents" + }, + "nodeId": { + "type": "string" + }, + "proof": { + "$ref": "#/definitions/ReceiptElementArray" + }, + "root": { + "type": "string" + }, + "serviceEndorsements": { + "$ref": "#/definitions/PemArray" + }, + "signature": { + "type": "string" + } + }, + "required": [ + "signature", + "proof", + "nodeId" + ], + "type": "object" + }, + "ReceiptElement": { + "properties": { + "left": { + "type": "string" + }, + "right": { + "type": "string" + } + }, + "type": "object" + }, + "ReceiptElementArray": { + "items": { + "$ref": "#/definitions/ReceiptElement" + }, + "type": "array" + }, + "ReceiptLeafComponents": { + "properties": { + "claimsDigest": { + "type": "string" + }, + "commitEvidence": { + "type": "string" + }, + "writeSetDigest": { + "type": "string" + } + }, + "type": "object" + }, + "RoleAssignment": { + "description": "Object for assigning a role to a user.", + "required": [ + "roleName" + ], + "properties": { + "roleName": { + "$ref": "#/definitions/LedgerUserRole" + }, + "description": { + "description": "Description of the role.", + "type": "string" + } + }, + "type": "object" + }, + "Collection": { + "description": "Identifier for collections.", + "required": [ + "collectionId" + ], + "properties": { + "collectionId": { + "type": "string" + } + }, + "type": "object" + }, + "PagedCollections": { + "description": "Paginated collections returned in response to a query.", + "type": "object", + "required": [ + "collections" + ], + "properties": { + "collections": { + "items": { + "$ref": "#/definitions/Collection" + }, + "type": "array" + }, + "nextLink": { + "description": "Path from which to retrieve the next page of results.", + "type": "string" + } + } + }, + "PagedUsers": { + "description": "Paginated users returned in response to a query.", + "type": "object", + "properties": { + "ledgerUsers": { + "items": { + "$ref": "#/definitions/LedgerUser" + }, + "type": "array" + }, + "nextLink": { + "description": "Path from which to retrieve the next page of results.", + "type": "string" + } + } + }, + "PagedLedgerUsers": { + "description": "Paginated users returned in response to a query.", + "type": "object", + "properties": { + "ledgerUsers": { + "items": { + "$ref": "#/definitions/LedgerUserMultipleRoles" + }, + "type": "array" + }, + "nextLink": { + "description": "Path from which to retrieve the next page of results.", + "type": "string" + } + } + }, + "TransactionId": { + "description": "A unique identifier for the state of the ledger. If returned as part of a LedgerEntry, it indicates the state from which the entry was read.", + "type": "string" + }, + "TransactionReceipt": { + "description": "A receipt certifying the transaction at the specified id.", + "required": [ + "state", + "transactionId" + ], + "properties": { + "applicationClaims": { + "$ref": "#/definitions/ApplicationClaims" + }, + "receipt": { + "$ref": "#/definitions/ReceiptContents" + }, + "state": { + "$ref": "#/definitions/LedgerQueryState" + }, + "transactionId": { + "$ref": "#/definitions/TransactionId" + } + }, + "type": "object" + }, + "TransactionState": { + "type": "string", + "description": "Represents the state of the transaction.", + "enum": [ + "Committed", + "Pending" + ], + "x-ms-enum": { + "name": "TransactionState", + "modelAsString": true + } + }, + "TransactionStatus": { + "description": "Response returned to a query for the transaction status", + "required": [ + "state", + "transactionId" + ], + "properties": { + "state": { + "$ref": "#/definitions/TransactionState" + }, + "transactionId": { + "$ref": "#/definitions/TransactionId" + } + }, + "type": "object" + }, + "UserId": { + "description": "Identifier for the user. This must either be an AAD object id or a certificate fingerprint.", + "type": "string" + }, + "Bundle": { + "description": "bundle for the user defined endpoints", + "properties": { + "metadata": { + "$ref": "#/definitions/Metadata" + }, + "modules": { + "$ref": "#/definitions/ModuleDef_array" + } + }, + "required": [ + "modules", + "metadata" + ], + "type": "object" + }, + "Metadata": { + "properties": { + "endpoints": { + "$ref": "#/definitions/path" + } + }, + "required": [ + "endpoints" + ], + "type": "object" + }, + "path": { + "description": "A map of path to method endpoints for the path", + "additionalProperties": { + "$ref": "#/definitions/method_to_EndpointProperties" + }, + "type": "object" + }, + "method_to_EndpointProperties": { + "properties": { + "get": { + "$ref": "#/definitions/EndpointProperties" + }, + "put": { + "$ref": "#/definitions/EndpointProperties" + }, + "patch": { + "$ref": "#/definitions/EndpointProperties" + }, + "delete": { + "$ref": "#/definitions/EndpointProperties" + } + }, + "type": "object" + }, + "EndpointProperties": { + "properties": { + "authn_policies": { + "$ref": "#/definitions/json_array" + }, + "forwarding_required": { + "$ref": "#/definitions/ForwardingRequired" + }, + "interpreter_reuse": { + "$ref": "#/definitions/InterpreterReusePolicy" + }, + "js_function": { + "type": "string" + }, + "js_module": { + "type": "string" + }, + "mode": { + "$ref": "#/definitions/Mode" + }, + "openapi": { + "$ref": "#/definitions/json" + }, + "openapi_hidden": { + "$ref": "#/definitions/boolean" + }, + "redirection_strategy": { + "$ref": "#/definitions/RedirectionStrategy" + } + }, + "required": [ + "forwarding_required", + "authn_policies" + ], + "type": "object" + }, + "json": {}, + "json_array": { + "items": { + "$ref": "#/definitions/json" + }, + "type": "array" + }, + "ForwardingRequired": { + "enum": [ + "sometimes", + "always", + "never" + ], + "x-ms-enum": { + "name": "ForwardingRequired", + "modelAsString": true + }, + "type": "string" + }, + "InterpreterReusePolicy": { + "properties": { + "key": { + "type": "string" + } + }, + "required": [ + "key" + ], + "type": "object" + }, + "Mode": { + "enum": [ + "readwrite", + "readonly", + "historical" + ], + "x-ms-enum": { + "name": "Mode", + "modelAsString": true + }, + "type": "string" + }, + "RedirectionStrategy": { + "enum": [ + "none", + "to_primary", + "to_backup" + ], + "x-ms-enum": { + "name": "RedirectionStrategy", + "modelAsString": true + }, + "type": "string" + }, + "ModuleDef": { + "properties": { + "module": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "name", + "module" + ], + "type": "object" + }, + "ModuleDef_array": { + "items": { + "$ref": "#/definitions/ModuleDef" + }, + "type": "object" + }, + "JSRuntimeOptions": { + "description": "JS runtime options for user defined endpoints", + "properties": { + "log_exception_details": { + "$ref": "#/definitions/boolean" + }, + "max_cached_interpreters": { + "$ref": "#/definitions/uint64" + }, + "max_execution_time_ms": { + "$ref": "#/definitions/uint64" + }, + "max_heap_bytes": { + "$ref": "#/definitions/uint64" + }, + "max_stack_bytes": { + "$ref": "#/definitions/uint64" + }, + "return_exception_details": { + "$ref": "#/definitions/boolean" + } + }, + "type": "object" + }, + "uint64": { + "minimum": 0, + "type": "integer", + "format": "int64" + }, + "boolean": { + "type": "boolean" + }, + "Role": { + "description": "Definition for roles", + "type": "object", + "properties": { + "roleName": { + "description": "name of the user defined role", + "type": "string" + }, + "roleActions": { + "items": { + "$ref": "#/definitions/RoleActionDef" + }, + "type": "object" + } + } + }, + "RoleActionDef": { + "properties": { + "roleActions": { + "description": "action of the user defined role", + "type": "string" + } + }, + "required": [ + "roleActions" + ], + "type": "string" + } + }, + "parameters": { + "CommitParameter": { + "name": "commit", + "in": "query", + "required": true, + "x-ms-parameter-location": "method", + "type": "integer", + "format": "int64", + "description": "The commit in the consensus protocol." + }, + "CollectionIdParameter": { + "name": "collectionId", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "description": "The collection id.", + "type": "string" + }, + "TransactionIdParameter": { + "name": "transactionId", + "in": "path", + "required": true, + "x-ms-parameter-location": "method", + "description": "Identifies a write transaction.", + "type": "string" + }, + "TransactionIdFromParameter": { + "name": "fromTransactionId", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "description": "Specify the first transaction ID in a range.", + "type": "string" + }, + "TransactionIdToParameter": { + "name": "toTransactionId", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "description": "Specify the last transaction ID in a range.", + "type": "string" + }, + "UserDetailsParameter": { + "name": "userDetails", + "description": "Details about a Confidential Ledger user.", + "in": "body", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/LedgerUser" + } + }, + "UserMultipleRolesParameter": { + "name": "userMultipleRoles", + "description": "Details about a Confidential Ledger user with multiple roles.", + "in": "body", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/LedgerUserMultipleRoles" + } + }, + "UserIdParameter": { + "name": "userId", + "in": "path", + "required": true, + "description": "The user id, either an AAD object ID or certificate fingerprint.", + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "BundleParameter": { + "name": "bundle", + "description": "bundle parameter description", + "in": "body", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/Bundle" + } + }, + "ModuleNameParameter": { + "name": "module", + "required": true, + "description": "module name of the user defined endpoint", + "in": "query", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string" + }, + "JSRuntimeOptionsParameter": { + "name": "JSRuntimeOptions", + "description": "JS runtime options", + "in": "body", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/JSRuntimeOptions" + } + }, + "RoleParameter": { + "name": "role", + "description": "user defined role", + "in": "body", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/Role" + } + }, + "RoleNameParameter": { + "name": "roleName", + "description": "user defined role name", + "in": "query", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/identity/GetLedgerIdentity.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/identity/GetLedgerIdentity.json new file mode 100644 index 000000000000..9362923dcc23 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/identity/GetLedgerIdentity.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerId": "contoso-ledger-12345", + "certificateEndpoint": "identity.confidential-ledger.core.azure.com" + }, + "responses": { + "200": { + "body": { + "ledgerTlsCertificate": "-----BEGIN CERTIFICATE-----\nMIIBvjCCAUKgAwIBAgIQVL+0VqZp3VzMyFKqD4Cs8zAMBggqhkjOPQQDAwUAMBYx\nFDASBgNVBAMMC0NDRiBOZXR3b3JrMB4XDTE5MTEwMTAwMDAwMFoXDTIxMTIzMTIz\nNTk1OVowFjEUMBIGA1UEAwwLQ0NGIE5ldHdvcmswdjAQBgcqhkjOPQIBBgUrgQQA\nIgNiAATBm4jNV4Kyj6bc/iMKDEXTCyU6P6U1KWAiDodl+Jd8aDJsBwLimtg4QCug\n1mpHnVPmcbPAbNM11+xrLHuFEfuZlS3DI+CCX8FUB2VvDVT3SfWLDVmr1xLStTDH\nuN4YjBOjUzBRMA8GA1UdEwQIMAYBAf8CAQAwHQYDVR0OBBYEFGSdsThwxrTOEQxb\nZ2NsslNvJRYkMB8GA1UdIwQYMBaAFGSdsThwxrTOEQxbZ2NsslNvJRYkMAwGCCqG\nSM49BAMDBQADaAAwZQIwJLLWllNZ83ym/HQuvtGGSdF/RCZwUoh+yhad/vUfVnhE\n2dYLDDEJOORpxpEIVfXgAjEA/CLcRwSZxzEmLDYe1y4puXKuSDCUiu+bKYgdvRLj\nRQJgTygutcTdI64sSweqPveK\n-----END CERTIFICATE-----\n\u0000" + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateLedgerEntry.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateLedgerEntry.json new file mode 100644 index 000000000000..240b5ed04929 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateLedgerEntry.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com", + "entry": { + "contents": "New ledger entry contents." + } + }, + "responses": { + "200": { + "headers": { + "x-ms-ccf-transaction-id": "2.15" + }, + "body": { + "collectionId": "subledger:0" + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateOrUpdateLedgerUsers.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateOrUpdateLedgerUsers.json new file mode 100644 index 000000000000..215928b14f2b --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateOrUpdateLedgerUsers.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com", + "userId": "AAD object id", + "userMultipleRoles": { + "assignedRoles": [ + "Reader", + "Writer" + ] + } + }, + "responses": { + "200": { + "body": { + "assignedRoles": [ + "Reader", + "Writer" + ], + "userId": "AAD object id" + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateOrUpdateUser.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateOrUpdateUser.json new file mode 100644 index 000000000000..e5e40e36b421 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateOrUpdateUser.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com", + "userId": "AAD object id", + "userDetails": { + "assignedRole": "Reader" + } + }, + "responses": { + "200": { + "body": { + "assignedRole": "Reader", + "userId": "AAD object id" + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateUserDefinedEndpoint.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateUserDefinedEndpoint.json new file mode 100644 index 000000000000..009d67407ff0 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateUserDefinedEndpoint.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "description": "User definied endpoint.", + "bundle": { + "metadata": { + "endpoints": { + "/content": { + "get": { + "forwarding_required": "always", + "authn_policies": [ + {} + ] + } + } + } + }, + "modules": { + "name": "test.js", + "module": "TESTJS" + } + } + }, + "responses": { + "201": { + "description": "The custom endpoint." + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/DeleteUser.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/DeleteUser.json new file mode 100644 index 000000000000..4c35e312a9d1 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/DeleteUser.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com", + "userId": "AAD object id" + }, + "responses": { + "204": {} + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/DeleteUserDefinedRole.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/DeleteUserDefinedRole.json new file mode 100644 index 000000000000..635506d708e5 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/DeleteUserDefinedRole.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "roleName": "reader" + }, + "responses": { + "200": { + "description": "Get user defined roles and actions" + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetConstitution.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetConstitution.json new file mode 100644 index 000000000000..b544a6449d79 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetConstitution.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com" + }, + "responses": { + "200": { + "body": { + "digest": "cd04f484d93a13df44eab4235c14df37e20907b3216c5a37b9e484a363a76c8e", + "script": "<constitution script contents>" + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetCurrentLedgerEntry.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetCurrentLedgerEntry.json new file mode 100644 index 000000000000..9bd31b82a365 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetCurrentLedgerEntry.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com" + }, + "responses": { + "200": { + "body": { + "contents": "Current ledger entry contents.", + "collectionId": "subledger:0", + "transactionId": "2.15" + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetEnclaveQuotes.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetEnclaveQuotes.json new file mode 100644 index 000000000000..e24e328c5523 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetEnclaveQuotes.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com" + }, + "responses": { + "200": { + "body": { + "currentNodeId": "0", + "enclaveQuotes": { + "0": { + "mrenclave": "9b4b6890a5fff10854e3ca4fa5af5801dae57a46bfef3f23749bf47a61a1b1d7", + "nodeId": "0", + "raw": "0100000002000000e811000000000000030002000000000005000a00939a7233f79c4ca9940a0db3957f06074b17f6b893ef49abff5c9b689576dc08000000000f0f0305ff80060000000000000000000000000000000000000000000000000000000000000000000000000000000000050000000000000007000000000000009b4b6890a5fff10854e3ca4fa5af5801dae57a46bfef3f23749bf47a61a1b1d700000000000000000000000000000000000000000000000000000000000000005bebf77a60c142b06ec46417957f4374b42102092d2ac7465daa3af9a62fcd7f000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000010001000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002a7c7f007fe7242cb20ad7d6eda114b47dfd92b1f615ae728a777852ce1377e2000000000000000000000000000000000000000000000000000000000000000034100000014d855131f932a590d06f9d6d6e0f2ade47054c7a9c5de61d38ccc2f35f4c00aa83ec2b3c3642af9aa050555a23c1272c1cdb0563a4e4264552a6a8514f5671378f81f331f54a8a2965275d64c061246d64c18df5b3383a498d3b5a4e997734bb35a09b0e8374bb039889dc168523251a90d8d96d921f697efb342a6534333c0f0f0305ff8006000000000000000000000000000000000000000000000000000000000000000000000000000000000015000000000000000700000000000000cdcadfb7db22ada5fd603455cde1bf9fa258fa5f284dcd6e0c63392f633a110500000000000000000000000000000000000000000000000000000000000000008c4f5775d796503e96137f77c68a829a0056ac8ded70140b081b094490c57bff000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000010005000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000004cb3dda245424884c47313c09366c2103703cbdef3a75f20316a2796d9243e6b0000000000000000000000000000000000000000000000000000000000000000326e8be8be9b1e8f3fb3a44d8743ca30d4cde23750294f51f282401adf08334ff280afdb1b6d912b39e2c7931837f2ac91f17689ca9cb943f5a491d60bb314332000000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f0500cc0d00002d2d2d2d2d424547494e2043455254494649434154452d2d2d2d2d0a4d494945674443434243616741774942416749555576735257764147614b502b724b36424449515776477948656a6777436759494b6f5a497a6a3045417749770a6354456a4d4345474131554541777761535735305a577767553064594946424453794251636d396a5a584e7a6233496751304578476a415942674e5642416f4d0a45556c756447567349454e76636e4276636d4630615739754d5251774567594456515148444174545957353059534244624746795954454c4d416b47413155450a4341774351304578437a414a42674e5642415954416c56544d423458445449774d4459784f4441774d5449304f466f58445449334d4459784f4441774d5449300a4f466f77634445694d434147413155454177775a535735305a5777675530645949464244537942445a584a3061575a70593246305a5445614d426747413155450a43677752535735305a577767513239796347397959585270623234784644415342674e564241634d43314e68626e526849454e7359584a684d517377435159440a5651514944414a445154454c4d416b474131554542684d4356564d775754415442676371686b6a4f5051494242676771686b6a4f50514d4242774e43414154570a663645447136324762714844326677574564656538645853645179694e665039493945594a59472b3770475a586b326173775370374f3876456d58425a52345a0a6b713075452f65687233435935793774323246786f3449436d7a434341706377487759445652306a42426777466f4155304f6971326e58582b53354a463567380a6578526c304e587957553077587759445652306642466777566a42556f464b6755495a4f6148523063484d364c79396863476b7564484a316333526c5a484e6c0a636e5a705932567a4c6d6c75644756734c6d4e766253397a5a3367765932567964476c6d61574e6864476c76626939324d6939775932746a636d772f593245390a63484a765932567a633239794d4230474131556444675157424253334b5969495a66795a7449432b4f4b7a4c365142446c5465384144414f42674e56485138420a4166384542414d434273417744415944565230544151482f42414977414443434164514743537147534962345451454e4151534341635577676748424d4234470a43697147534962345451454e415145454547462f622f39427666662b6c75427a75747a6d646d34776767466b42676f71686b69472b453042445145434d4949420a5644415142677371686b69472b4530424451454341514942447a415142677371686b69472b4530424451454341674942447a415142677371686b69472b4530420a4451454341774942416a415142677371686b69472b45304244514543424149424244415142677371686b69472b453042445145434251494241544152426773710a686b69472b4530424451454342674943414941774541594c4b6f5a496876684e4151304241676343415159774541594c4b6f5a496876684e41513042416767430a415141774541594c4b6f5a496876684e4151304241676b43415141774541594c4b6f5a496876684e4151304241676f43415141774541594c4b6f5a496876684e0a4151304241677343415141774541594c4b6f5a496876684e4151304241677743415141774541594c4b6f5a496876684e4151304241673043415141774541594c0a4b6f5a496876684e4151304241673443415141774541594c4b6f5a496876684e4151304241673843415141774541594c4b6f5a496876684e41513042416841430a415141774541594c4b6f5a496876684e415130424168454341516f774877594c4b6f5a496876684e4151304241684945454138504167514267415941414141410a41414141414141774541594b4b6f5a496876684e4151304241775143414141774641594b4b6f5a496876684e4151304242415147414a4275315141414d4138470a43697147534962345451454e4151554b41514177436759494b6f5a497a6a3045417749445341417752514968414b582b324343704b525652654d2b4d7543366a0a7477634d502b2b4645396667365a4f696d55464a55474478416941684d6a743258323651662b4247344965456f665547537070364f792b68494e704d48626d7a0a4f4a596279513d3d0a2d2d2d2d2d454e442043455254494649434154452d2d2d2d2d0a2d2d2d2d2d424547494e2043455254494649434154452d2d2d2d2d0a4d4949436c7a4343416a36674177494241674956414e446f71747031312f6b7553526559504873555a644456386c6c4e4d416f4743437147534d343942414d430a4d476778476a415942674e5642414d4d45556c756447567349464e48574342536232393049454e424d526f77474159445651514b4442464a626e526c624342440a62334a7762334a6864476c76626a45554d424947413155454277774c553246756447456751327868636d4578437a414a42674e564241674d416b4e424d5173770a435159445651514745774a56557a4165467730784f4441314d6a45784d4451314d4468614677307a4d7a41314d6a45784d4451314d4468614d484578497a41680a42674e5642414d4d476b6c756447567349464e48574342515130736755484a765932567a6332397949454e424d526f77474159445651514b4442464a626e526c0a6243424462334a7762334a6864476c76626a45554d424947413155454277774c553246756447456751327868636d4578437a414a42674e564241674d416b4e420a4d517377435159445651514745774a56557a425a4d424d4742797147534d34394167454743437147534d34394177454841304941424c39712b4e4d7032494f670a74646c31626b2f75575a352b5447516d38614369387a373866732b664b435133642b75447a586e56544154325a68444369667949754a77764e33774e427039690a484253534d4a4d4a72424f6a6762737767626777487759445652306a42426777466f4155496d554d316c71644e496e7a6737535655723951477a6b6e427177770a556759445652306642457377535442486f45576751345a426148523063484d364c79396a5a584a3061575a70593246305a584d7564484a316333526c5a484e6c0a636e5a705932567a4c6d6c75644756734c6d4e766253394a626e526c62464e4857464a76623352445153356a636d7777485159445652304f42425945464e446f0a71747031312f6b7553526559504873555a644456386c6c4e4d41344741315564447745422f77514541774942426a415342674e5648524d4241663845434441470a4151482f416745414d416f4743437147534d343942414d43413063414d45514349432f396a2b3834542b487a74564f2f734f5142574a6253642b2f327565784b0a342b6141306a6346424c63704169413364684d72463563443532743646714d764149706a385864476d79326265656c6a4c4a4b2b707a706352413d3d0a2d2d2d2d2d454e442043455254494649434154452d2d2d2d2d0a2d2d2d2d2d424547494e2043455254494649434154452d2d2d2d2d0a4d4949436a6a4343416a53674177494241674955496d554d316c71644e496e7a6737535655723951477a6b6e42717777436759494b6f5a497a6a3045417749770a614445614d4267474131554541777752535735305a5777675530645949464a766233516751304578476a415942674e5642416f4d45556c756447567349454e760a636e4276636d4630615739754d5251774567594456515148444174545957353059534244624746795954454c4d416b47413155454341774351304578437a414a0a42674e5642415954416c56544d423458445445344d4455794d5445774e4445784d566f5844544d7a4d4455794d5445774e4445784d466f77614445614d4267470a4131554541777752535735305a5777675530645949464a766233516751304578476a415942674e5642416f4d45556c756447567349454e76636e4276636d46300a615739754d5251774567594456515148444174545957353059534244624746795954454c4d416b47413155454341774351304578437a414a42674e56424159540a416c56544d466b77457759484b6f5a497a6a3043415159494b6f5a497a6a3044415163445167414543366e45774d4449595a4f6a2f69505773437a61454b69370a314f694f534c52466857476a626e42564a66566e6b59347533496a6b4459594c304d784f346d717379596a6c42616c54565978465032734a424b357a6c4b4f420a757a43427544416642674e5648534d4547444157674251695a517a575770303069664f44744a5653763141624f5363477244425342674e5648523845537a424a0a4d45656752614244686b466f64485277637a6f764c324e6c636e52705a6d6c6a5958526c63793530636e567a6447566b63325679646d6c6a5a584d75615735300a5a577775593239744c306c756447567355306459556d397664454e424c6d4e796244416442674e564851344546675155496d554d316c71644e496e7a673753560a55723951477a6b6e4271777744675944565230504151482f42415144416745474d42494741315564457745422f7751494d4159424166384341514577436759490a4b6f5a497a6a30454177494453414177525149675151732f30387279636450617543466b3855505158434d416c736c6f4265374e7761514754636470613045430a495143557438534776784b6d6a70634d2f7a3057503944766f3868326b3564753169574464426b416e2b306969413d3d0a2d2d2d2d2d454e442043455254494649434154452d2d2d2d2d0a00", + "quoteVersion": "sgx-quote-1" + }, + "1": { + "mrenclave": "9b4b6890a5fff10854e3ca4fa5af5801dae57a46bfef3f23749bf47a61a1b1d7", + "nodeId": "1", + "raw": "0100000002000000e811000000000000030002000000000005000a00939a7233f79c4ca9940a0db3957f06074b17f6b893ef49abff5c9b689576dc08000000000f0f0305ff80060000000000000000000000000000000000000000000000000000000000000000000000000000000000050000000000000007000000000000009b4b6890a5fff10854e3ca4fa5af5801dae57a46bfef3f23749bf47a61a1b1d700000000000000000000000000000000000000000000000000000000000000005bebf77a60c142b06ec46417957f4374b42102092d2ac7465daa3af9a62fcd7f000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000010001000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002a7c7f007fe7242cb20ad7d6eda114b47dfd92b1f615ae728a777852ce1377e2000000000000000000000000000000000000000000000000000000000000000034100000014d855131f932a590d06f9d6d6e0f2ade47054c7a9c5de61d38ccc2f35f4c00aa83ec2b3c3642af9aa050555a23c1272c1cdb0563a4e4264552a6a8514f5671378f81f331f54a8a2965275d64c061246d64c18df5b3383a498d3b5a4e997734bb35a09b0e8374bb039889dc168523251a90d8d96d921f697efb342a6534333c0f0f0305ff8006000000000000000000000000000000000000000000000000000000000000000000000000000000000015000000000000000700000000000000cdcadfb7db22ada5fd603455cde1bf9fa258fa5f284dcd6e0c63392f633a110500000000000000000000000000000000000000000000000000000000000000008c4f5775d796503e96137f77c68a829a0056ac8ded70140b081b094490c57bff000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000010005000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000004cb3dda245424884c47313c09366c2103703cbdef3a75f20316a2796d9243e6b0000000000000000000000000000000000000000000000000000000000000000326e8be8be9b1e8f3fb3a44d8743ca30d4cde23750294f51f282401adf08334ff280afdb1b6d912b39e2c7931837f2ac91f17689ca9cb943f5a491d60bb314332000000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f0500cc0d00002d2d2d2d2d424547494e2043455254494649434154452d2d2d2d2d0a4d494945674443434243616741774942416749555576735257764147614b502b724b36424449515776477948656a6777436759494b6f5a497a6a3045417749770a6354456a4d4345474131554541777761535735305a577767553064594946424453794251636d396a5a584e7a6233496751304578476a415942674e5642416f4d0a45556c756447567349454e76636e4276636d4630615739754d5251774567594456515148444174545957353059534244624746795954454c4d416b47413155450a4341774351304578437a414a42674e5642415954416c56544d423458445449774d4459784f4441774d5449304f466f58445449334d4459784f4441774d5449300a4f466f77634445694d434147413155454177775a535735305a5777675530645949464244537942445a584a3061575a70593246305a5445614d426747413155450a43677752535735305a577767513239796347397959585270623234784644415342674e564241634d43314e68626e526849454e7359584a684d517377435159440a5651514944414a445154454c4d416b474131554542684d4356564d775754415442676371686b6a4f5051494242676771686b6a4f50514d4242774e43414154570a663645447136324762714844326677574564656538645853645179694e665039493945594a59472b3770475a586b326173775370374f3876456d58425a52345a0a6b713075452f65687233435935793774323246786f3449436d7a434341706377487759445652306a42426777466f4155304f6971326e58582b53354a463567380a6578526c304e587957553077587759445652306642466777566a42556f464b6755495a4f6148523063484d364c79396863476b7564484a316333526c5a484e6c0a636e5a705932567a4c6d6c75644756734c6d4e766253397a5a3367765932567964476c6d61574e6864476c76626939324d6939775932746a636d772f593245390a63484a765932567a633239794d4230474131556444675157424253334b5969495a66795a7449432b4f4b7a4c365142446c5465384144414f42674e56485138420a4166384542414d434273417744415944565230544151482f42414977414443434164514743537147534962345451454e4151534341635577676748424d4234470a43697147534962345451454e415145454547462f622f39427666662b6c75427a75747a6d646d34776767466b42676f71686b69472b453042445145434d4949420a5644415142677371686b69472b4530424451454341514942447a415142677371686b69472b4530424451454341674942447a415142677371686b69472b4530420a4451454341774942416a415142677371686b69472b45304244514543424149424244415142677371686b69472b453042445145434251494241544152426773710a686b69472b4530424451454342674943414941774541594c4b6f5a496876684e4151304241676343415159774541594c4b6f5a496876684e41513042416767430a415141774541594c4b6f5a496876684e4151304241676b43415141774541594c4b6f5a496876684e4151304241676f43415141774541594c4b6f5a496876684e0a4151304241677343415141774541594c4b6f5a496876684e4151304241677743415141774541594c4b6f5a496876684e4151304241673043415141774541594c0a4b6f5a496876684e4151304241673443415141774541594c4b6f5a496876684e4151304241673843415141774541594c4b6f5a496876684e41513042416841430a415141774541594c4b6f5a496876684e415130424168454341516f774877594c4b6f5a496876684e4151304241684945454138504167514267415941414141410a41414141414141774541594b4b6f5a496876684e4151304241775143414141774641594b4b6f5a496876684e4151304242415147414a4275315141414d4138470a43697147534962345451454e4151554b41514177436759494b6f5a497a6a3045417749445341417752514968414b582b324343704b525652654d2b4d7543366a0a7477634d502b2b4645396667365a4f696d55464a55474478416941684d6a743258323651662b4247344965456f665547537070364f792b68494e704d48626d7a0a4f4a596279513d3d0a2d2d2d2d2d454e442043455254494649434154452d2d2d2d2d0a2d2d2d2d2d424547494e2043455254494649434154452d2d2d2d2d0a4d4949436c7a4343416a36674177494241674956414e446f71747031312f6b7553526559504873555a644456386c6c4e4d416f4743437147534d343942414d430a4d476778476a415942674e5642414d4d45556c756447567349464e48574342536232393049454e424d526f77474159445651514b4442464a626e526c624342440a62334a7762334a6864476c76626a45554d424947413155454277774c553246756447456751327868636d4578437a414a42674e564241674d416b4e424d5173770a435159445651514745774a56557a4165467730784f4441314d6a45784d4451314d4468614677307a4d7a41314d6a45784d4451314d4468614d484578497a41680a42674e5642414d4d476b6c756447567349464e48574342515130736755484a765932567a6332397949454e424d526f77474159445651514b4442464a626e526c0a6243424462334a7762334a6864476c76626a45554d424947413155454277774c553246756447456751327868636d4578437a414a42674e564241674d416b4e420a4d517377435159445651514745774a56557a425a4d424d4742797147534d34394167454743437147534d34394177454841304941424c39712b4e4d7032494f670a74646c31626b2f75575a352b5447516d38614369387a373866732b664b435133642b75447a586e56544154325a68444369667949754a77764e33774e427039690a484253534d4a4d4a72424f6a6762737767626777487759445652306a42426777466f4155496d554d316c71644e496e7a6737535655723951477a6b6e427177770a556759445652306642457377535442486f45576751345a426148523063484d364c79396a5a584a3061575a70593246305a584d7564484a316333526c5a484e6c0a636e5a705932567a4c6d6c75644756734c6d4e766253394a626e526c62464e4857464a76623352445153356a636d7777485159445652304f42425945464e446f0a71747031312f6b7553526559504873555a644456386c6c4e4d41344741315564447745422f77514541774942426a415342674e5648524d4241663845434441470a4151482f416745414d416f4743437147534d343942414d43413063414d45514349432f396a2b3834542b487a74564f2f734f5142574a6253642b2f327565784b0a342b6141306a6346424c63704169413364684d72463563443532743646714d764149706a385864476d79326265656c6a4c4a4b2b707a706352413d3d0a2d2d2d2d2d454e442043455254494649434154452d2d2d2d2d0a2d2d2d2d2d424547494e2043455254494649434154452d2d2d2d2d0a4d4949436a6a4343416a53674177494241674955496d554d316c71644e496e7a6737535655723951477a6b6e42717777436759494b6f5a497a6a3045417749770a614445614d4267474131554541777752535735305a5777675530645949464a766233516751304578476a415942674e5642416f4d45556c756447567349454e760a636e4276636d4630615739754d5251774567594456515148444174545957353059534244624746795954454c4d416b47413155454341774351304578437a414a0a42674e5642415954416c56544d423458445445344d4455794d5445774e4445784d566f5844544d7a4d4455794d5445774e4445784d466f77614445614d4267470a4131554541777752535735305a5777675530645949464a766233516751304578476a415942674e5642416f4d45556c756447567349454e76636e4276636d46300a615739754d5251774567594456515148444174545957353059534244624746795954454c4d416b47413155454341774351304578437a414a42674e56424159540a416c56544d466b77457759484b6f5a497a6a3043415159494b6f5a497a6a3044415163445167414543366e45774d4449595a4f6a2f69505773437a61454b69370a314f694f534c52466857476a626e42564a66566e6b59347533496a6b4459594c304d784f346d717379596a6c42616c54565978465032734a424b357a6c4b4f420a757a43427544416642674e5648534d4547444157674251695a517a575770303069664f44744a5653763141624f5363477244425342674e5648523845537a424a0a4d45656752614244686b466f64485277637a6f764c324e6c636e52705a6d6c6a5958526c63793530636e567a6447566b63325679646d6c6a5a584d75615735300a5a577775593239744c306c756447567355306459556d397664454e424c6d4e796244416442674e564851344546675155496d554d316c71644e496e7a673753560a55723951477a6b6e4271777744675944565230504151482f42415144416745474d42494741315564457745422f7751494d4159424166384341514577436759490a4b6f5a497a6a30454177494453414177525149675151732f30387279636450617543466b3855505158434d416c736c6f4265374e7761514754636470613045430a495143557438534776784b6d6a70634d2f7a3057503944766f3868326b3564753169574464426b416e2b306969413d3d0a2d2d2d2d2d454e442043455254494649434154452d2d2d2d2d0a00", + "quoteVersion": "sgx-quote-1" + } + } + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetLedgerEntry.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetLedgerEntry.json new file mode 100644 index 000000000000..92ec8e5a566d --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetLedgerEntry.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "transactionId": "2.15", + "ledgerUri": "myledger.confidentialledger.azure.com" + }, + "responses": { + "200": { + "body": { + "state": "Ready", + "entry": { + "contents": "Ledger entry contents at transaction id 2.15.", + "collectionId": "subledger:0", + "transactionId": "2.15" + } + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetLedgerUsers.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetLedgerUsers.json new file mode 100644 index 000000000000..45c8a57a926a --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetLedgerUsers.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com", + "userId": "AAD object id" + }, + "responses": { + "200": { + "body": { + "assignedRoles": [ + "Administrator", + "Reader" + ], + "userId": "AAD object id" + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetReceipt.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetReceipt.json new file mode 100644 index 000000000000..ab3ce2f4e25d --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetReceipt.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com", + "transactionId": "2.15" + }, + "responses": { + "200": { + "body": { + "applicationClaims": [ + { + "kind": "LedgerEntry", + "ledgerEntry": { + "protocol": "LedgerEntryV1", + "collectionId": "subledger:0", + "contents": "Ledger entry contents at transaction id 2.15", + "secretKey": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=" + } + } + ], + "receipt": { + "cert": "-----BEGIN CERTIFICATE-----\nMIIBwzCCAUmgAwIBAgIRAMRXRsojcLOzbz90rSp67xQwCgYIKoZIzj0EAwMwFjEU\nMBIGA1UEAwwLQ0NGIE5ldHdvcmswHhcNMjIxMTI1MTE1NzM1WhcNMjMwMjIzMTE1\nNzM0WjATMREwDwYDVQQDDAhDQ0YgTm9kZTB2MBAGByqGSM49AgEGBSuBBAAiA2IA\nBFjnt5PbiuXlBDdWWJvR1d0niMIzx6hxRCs06d8MUwG49UvdqRc8aY2eeCuoGupG\n9uWA3WBaZoe3QcqUr0+S+WLYXP0TYRx0xQncbKZgSWa3bcFNqaosw1KnjbLaSIRR\nJKNeMFwwCQYDVR0TBAIwADAdBgNVHQ4EFgQUHOauq1jxw2NJMh0UrzkrWi/Vuxkw\nHwYDVR0jBBgwFoAUSyn9seKhGp3n74by4boUVRXOpvcwDwYDVR0RBAgwBocEfwAA\nATAKBggqhkjOPQQDAwNoADBlAjBuhyVaon0EVXKUnO59acJVcfN8fYbz8keieiov\nOHqVqSCc60mdNGugn1kUmCKtHWYCMQDDMnOFtyeTfHPCo4n48nyoCHdaTVyS/XIF\n83P94iQITIiCX9ZDxf/eqc8rcEvm63A=\n-----END CERTIFICATE-----\n", + "leafComponents": { + "commitEvidence": "ce:2.15:3cc2bfd0e14c9fb8b3d4838d3dce19704ca83fa04720e044512f25581fc9b0a7", + "writeSetDigest": "f71b60aa93a6ae36bfcadaf852b2eb43e7f868bd95053c84dd4b67d11c05d516" + }, + "nodeId": "ff9bf39b7150510ad437977d7010aa733e718b407df755b52b961e4c3b2708fd", + "proof": [ + { + "left": "65e4256d7e7cbff2723de58dc1d8931e4683a328e720ba7c784a82b65d027b4a" + }, + { + "left": "ef24f237b9208cfa51cdfa56b84927adce7074f3b5502abc0a6111bbd1317438" + }, + { + "left": "067d74a552d2f96d236e8fe94ed40ffd8ae665f890d6b8721783a7795a1b3dec" + }, + { + "left": "1a64045485d3e9137978cb4de06a422a76738d36489d8efa829bbf7bdd262ac1" + } + ], + "serviceEndorsements": [], + "signature": "MGYCMQCYbEjjClnK63cpkb+LBM4XFugq99zPM8KLN9yKvXwV576mXd3fyUOrF84HJbAbO6gCMQCiebUALQkaSixwh4q3l3v+rd9pgBnH2HZpnby6vvJLGkYBDUAdR0kyYV5OEJva6N0=" + }, + "state": "Ready", + "transactionId": "2.15" + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetRuntimeOptions.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetRuntimeOptions.json new file mode 100644 index 000000000000..6e354702c2b2 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetRuntimeOptions.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview" + }, + "responses": { + "200": { + "description": "Runtime options for custom endpoint.", + "body": { + "max_heap_bytes": 1024, + "max_stack_bytes": 1024, + "max_execution_time_ms": 1200, + "log_exception_details": false, + "return_exception_details": false, + "max_cached_interpreters": 1024 + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetTransactionStatus.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetTransactionStatus.json new file mode 100644 index 000000000000..57ebe899b53b --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetTransactionStatus.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com", + "transactionId": "4.2" + }, + "responses": { + "200": { + "body": { + "state": "Committed", + "transactionId": "4.2" + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUser.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUser.json new file mode 100644 index 000000000000..23884ecf8143 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUser.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com", + "userId": "AAD object id" + }, + "responses": { + "200": { + "body": { + "assignedRole": "Administrator", + "userId": "AAD object id" + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUserDefinedEndpoint.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUserDefinedEndpoint.json new file mode 100644 index 000000000000..f2e5afe052e8 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUserDefinedEndpoint.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview" + }, + "responses": { + "200": { + "description": "The custom endpoint.", + "body": { + "metadata": { + "endpoints": { + "/content": { + "get": { + "forwarding_required": "always", + "authn_policies": [ + {} + ] + } + } + } + }, + "modules": { + "name": "test.js", + "module": "TESTJS" + } + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUserDefinedEndpointsModule.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUserDefinedEndpointsModule.json new file mode 100644 index 000000000000..31605205fee8 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUserDefinedEndpointsModule.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "module": "TESTJS" + }, + "responses": { + "200": { + "description": "The custom endpoint.", + "body": { + "name": "test.js", + "module": "TESTJS" + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUserDefinedRole.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUserDefinedRole.json new file mode 100644 index 000000000000..4947c9699328 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUserDefinedRole.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "roleName": "reader", + "api-version": "2024-08-22-preview" + }, + "responses": { + "200": { + "description": "Get user defined roles and actions", + "body": { + "roleName": "reader", + "roleActions": [ + "Microsoft.ConfidentialLedger/ledger/users/read" + ] + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListCollections.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListCollections.json new file mode 100644 index 000000000000..eb7b58123d82 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListCollections.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com" + }, + "responses": { + "200": { + "body": { + "collections": [ + { + "collectionId": "first" + }, + { + "collectionId": "second" + } + ] + }, + "nextLink": "<link>" + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListConsortiumMembers.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListConsortiumMembers.json new file mode 100644 index 000000000000..b18a75188df0 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListConsortiumMembers.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com" + }, + "responses": { + "200": { + "body": { + "members": [ + { + "certificate": "<PEM certificate>", + "id": "0" + } + ], + "nextLink": "<link>" + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListLedgerEntries.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListLedgerEntries.json new file mode 100644 index 000000000000..91a125b83dbc --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListLedgerEntries.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "fromTransactionId": "2.15", + "toTransactionId": "2.20", + "ledgerUri": "myledger.confidentialledger.azure.com" + }, + "responses": { + "200": { + "body": { + "state": "Ready", + "nextLink": "/app/transactions?fromTransactionId=3.15&toTransactionId=3.42&collectionId=0&api-version=0.1-preview", + "entries": [ + { + "contents": "Ledger entry contents at transaction id 2.15.", + "collectionId": "subledger:0", + "transactionId": "2.15" + } + ] + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListLedgerUsers.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListLedgerUsers.json new file mode 100644 index 000000000000..2d84285befea --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListLedgerUsers.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com" + }, + "responses": { + "200": { + "body": { + "ledgerUsers": [ + { + "assignedRoles": [ + "Administrator", + "Reader" + ], + "userId": "Certificate object id 1" + }, + { + "assignedRoles": [ + "Contributor", + "Reader" + ], + "userId": "AAD object id 2" + }, + { + "assignedRoles": [ + "Reader" + ], + "userId": "AAD object id 3" + } + ] + }, + "nextLink": "<link>" + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListUsers.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListUsers.json new file mode 100644 index 000000000000..e9e9ab082709 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListUsers.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com" + }, + "responses": { + "200": { + "body": { + "ledgerUsers": [ + { + "assignedRole": "Administrator", + "userId": "Certificate object id 1" + }, + { + "assignedRole": "Contributor", + "userId": "AAD object id 2" + }, + { + "assignedRole": "Reader", + "userId": "AAD object id 3" + } + ] + }, + "nextLink": "<link>" + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/PatchRuntimeOptions.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/PatchRuntimeOptions.json new file mode 100644 index 000000000000..afacdf2c7264 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/PatchRuntimeOptions.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "JSRuntimeOptions": { + "log_exception_details": false, + "max_execution_time_ms": 1200 + } + }, + "responses": { + "200": { + "description": "Runtime options for custom endpoint.", + "body": { + "max_heap_bytes": 1024, + "max_stack_bytes": 1024, + "max_execution_time_ms": 1200, + "log_exception_details": false, + "return_exception_details": false, + "max_cached_interpreters": 1024 + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/PatchUserDefinedRole.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/PatchUserDefinedRole.json new file mode 100644 index 000000000000..640552d1632e --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/PatchUserDefinedRole.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "role": { + "roleName": "administrator", + "roleActions": [ + "Microsoft.ConfidentialLedger/ledger/users/write" + ] + } + }, + "responses": { + "200": { + "description": "Created new user defined roles and actions" + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/PutUserDefinedRole.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/PutUserDefinedRole.json new file mode 100644 index 000000000000..640552d1632e --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/PutUserDefinedRole.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "role": { + "roleName": "administrator", + "roleActions": [ + "Microsoft.ConfidentialLedger/ledger/users/write" + ] + } + }, + "responses": { + "200": { + "description": "Created new user defined roles and actions" + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/identityservice.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/identityservice.json new file mode 100644 index 000000000000..c6ac389de4b1 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/identityservice.json @@ -0,0 +1,90 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-22-preview", + "title": "ConfidentialLedgerCertificateClient", + "description": "The ConfidentialLedgerCertificateClient is used to retrieve the TLS certificate required for connecting to a Confidential Ledger." + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "name": "endpoint", + "description": "The certificate endpoint (or \"Identity Service Endpoint\" in the Azure portal), for example https://identity.confidential-ledger.core.azure.com", + "required": true, + "type": "string", + "in": "path", + "format": "url", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/ledgerIdentity/{ledgerId}": { + "get": { + "operationId": "GetLedgerIdentity", + "x-ms-examples": { + "GetLedgerIdentity": { + "$ref": "./examples/identity/GetLedgerIdentity.json" + } + }, + "summary": "Gets identity information for a Confidential Ledger instance.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "in": "path", + "name": "ledgerId", + "description": "Id of the Confidential Ledger instance to get information for", + "type": "string", + "required": true + } + ], + "responses": { + "200": { + "description": "Returns ledger information.", + "schema": { + "$ref": "#/definitions/LedgerIdentityInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + } + }, + "definitions": { + "LedgerIdentityInformation": { + "description": "Contains the information about a Confidential Ledger.", + "required": [ + "ledgerTlsCertificate" + ], + "properties": { + "ledgerId": { + "description": "Id for the ledger.", + "type": "string", + "readOnly": true + }, + "ledgerTlsCertificate": { + "description": "PEM-encoded certificate used for TLS by the Confidential Ledger.", + "type": "string" + } + }, + "type": "object" + } + } +} diff --git a/specification/confidentialledger/data-plane/readme.md b/specification/confidentialledger/data-plane/readme.md index e97f24cebc38..33a35d78b5f6 100644 --- a/specification/confidentialledger/data-plane/readme.md +++ b/specification/confidentialledger/data-plane/readme.md @@ -12,7 +12,7 @@ Please look to the files `Microsoft.ConfidentialLedger/preview/2023-01-18-previe > see https://aka.ms/autorest ``` yaml -tag: package-2024-01-26-preview-identity +tag: package-2024-08-22-preview-ledger openapi-type: data-plane ``` @@ -139,4 +139,23 @@ These settings apply only when `--tag=package-2024-01-26-preview-identity` is sp ```yaml $(tag) == 'package-2024-01-26-preview-identity' input-file: - - Microsoft.ConfidentialLedger/preview/2024-01-26-preview/identityservice.json \ No newline at end of file + - Microsoft.ConfidentialLedger/preview/2024-01-26-preview/identityservice.json +``` + +### Tag: package-2024-08-22-preview-ledger + +These settings apply only when `--tag=package-2024-08-22-preview-ledger` is specified on the command line. + +```yaml $(tag) == 'package-2024-08-22-preview-ledger' +input-file: + - Microsoft.ConfidentialLedger/preview/2024-08-22-preview/confidentialledger.json +``` + +### Tag: package-2024-08-22-preview-identity + +These settings apply only when `--tag=package-2024-08-22-preview-identity` is specified on the command line. + +```yaml $(tag) == 'package-2024-08-22-preview-identity' +input-file: + - Microsoft.ConfidentialLedger/preview/2024-08-22-preview/identityservice.json +``` \ No newline at end of file From 153eaccf276a75629978a3238aef0a1d98ea3a4f Mon Sep 17 00:00:00 2001 From: sidsinghms <88089677+sidsinghms@users.noreply.github.com> Date: Thu, 3 Oct 2024 18:03:59 +0530 Subject: [PATCH 33/47] [SCVMM] Make the request body optional for VirtualMachineInstances/Stop (#30401) * Make the stop machine request body optional * [tsp compile] Update scvmm.json for 2023-10-07 * [tsp compile] Update scvmm.json for 2024-06-01 * Create sdk-suppressions.yaml --------- Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com> --- .../scvmm/ScVmm.Management/VirtualMachineInstance.tsp | 6 +++++- .../Microsoft.ScVmm/stable/2023-10-07/scvmm.json | 2 +- .../Microsoft.ScVmm/stable/2024-06-01/scvmm.json | 2 +- specification/scvmm/resource-manager/sdk-suppressions.yaml | 6 ++++++ 4 files changed, 13 insertions(+), 3 deletions(-) create mode 100644 specification/scvmm/resource-manager/sdk-suppressions.yaml diff --git a/specification/scvmm/ScVmm.Management/VirtualMachineInstance.tsp b/specification/scvmm/ScVmm.Management/VirtualMachineInstance.tsp index 74559c5c70f8..71ca59eb3ce5 100644 --- a/specification/scvmm/ScVmm.Management/VirtualMachineInstance.tsp +++ b/specification/scvmm/ScVmm.Management/VirtualMachineInstance.tsp @@ -106,7 +106,11 @@ interface VirtualMachineInstances { @summary("Implements the operation to stop a virtual machine.") stop is ArmResourceActionNoResponseContentAsync< VirtualMachineInstance, - StopVirtualMachineOptions + { + /** The content of the action request */ + @body + body?: StopVirtualMachineOptions; + } >; /** The operation to start a virtual machine instance. */ @summary("Implements the operation to start a virtual machine.") diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json index d53c2c453e9c..a47208794c03 100644 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json @@ -940,7 +940,7 @@ "name": "body", "in": "body", "description": "The content of the action request", - "required": true, + "required": false, "schema": { "$ref": "#/definitions/StopVirtualMachineOptions" } diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/scvmm.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/scvmm.json index a1043382dec9..0f5d03c0273c 100644 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/scvmm.json +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/scvmm.json @@ -940,7 +940,7 @@ "name": "body", "in": "body", "description": "The content of the action request", - "required": true, + "required": false, "schema": { "$ref": "#/definitions/StopVirtualMachineOptions" } diff --git a/specification/scvmm/resource-manager/sdk-suppressions.yaml b/specification/scvmm/resource-manager/sdk-suppressions.yaml new file mode 100644 index 000000000000..1ac7d2cd31f1 --- /dev/null +++ b/specification/scvmm/resource-manager/sdk-suppressions.yaml @@ -0,0 +1,6 @@ +suppressions: + azure-sdk-for-js: + - package: "@azure/arm-scvmm" + breaking-changes: + - Operation VirtualMachineInstances.beginStop has a new signature + - Operation VirtualMachineInstances.beginStopAndWait has a new signature \ No newline at end of file From 517a5700112b2ef165e4c6e1d58a46faf025f724 Mon Sep 17 00:00:00 2001 From: steve munk <33468793+stevemunk@users.noreply.github.com> Date: Thu, 3 Oct 2024 09:34:27 -0700 Subject: [PATCH 34/47] Change 'The asynchronous responses are stored for 14 days.' to 24 days. (#30831) * Change 'The asynchronous responses are stored for 14 days.' to 24 days. * Added TypeSpecRequirement suppression for Route v1. --- .../maps/data-plane/Route/preview/1.0/route.json | 8 ++++---- specification/maps/suppressions.yaml | 3 +++ 2 files changed, 7 insertions(+), 4 deletions(-) create mode 100644 specification/maps/suppressions.yaml diff --git a/specification/maps/data-plane/Route/preview/1.0/route.json b/specification/maps/data-plane/Route/preview/1.0/route.json index 301fe9e9d10e..92ae9d2a3e68 100644 --- a/specification/maps/data-plane/Route/preview/1.0/route.json +++ b/specification/maps/data-plane/Route/preview/1.0/route.json @@ -887,7 +887,7 @@ "/route/matrix/{format}": { "post": { "summary": "Use to get a route matrix showing the travel time and distance for all possible pairs in a list of origins and destinations, using an asynchronous request.", - "description": "\n\nThe `Post Route Matrix` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) request. To make a synchronous (sync) request, see [Post Route Matrix Sync](/rest/api/maps/route/post-route-matrix-sync). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nPOST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", + "description": "\n\nThe `Post Route Matrix` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) request. To make a synchronous (sync) request, see [Post Route Matrix Sync](/rest/api/maps/route/post-route-matrix-sync). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nPOST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **24** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", "operationId": "Route_PostRouteMatrix", "x-ms-client-name": "RequestRouteMatrix", "x-ms-long-running-operation": true, @@ -993,7 +993,7 @@ }, "get": { "summary": "Use to get a route matrix showing the travel time and distance for all possible pairs in a list of origins and destinations.", - "description": "\n\nThe `Get Route Matrix` API is an HTTP `GET` request that computes the travel time and distance for all possible pairs in a list of origins and destinations. Unlike the [Get Route Directions](/rest/api/maps/route/get-route-directions) API, which provide detailed route instructions, this API focuses on efficiency by giving you the cost (travel time and distance) of routing from each origin to every destination. For more information, see [Best practices for Azure Maps Route service](/azure/azure-maps/how-to-use-best-practices-for-routing).\n\nFor every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nGET https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nGET https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix GET request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a GET request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", + "description": "\n\nThe `Get Route Matrix` API is an HTTP `GET` request that computes the travel time and distance for all possible pairs in a list of origins and destinations. Unlike the [Get Route Directions](/rest/api/maps/route/get-route-directions) API, which provide detailed route instructions, this API focuses on efficiency by giving you the cost (travel time and distance) of routing from each origin to every destination. For more information, see [Best practices for Azure Maps Route service](/azure/azure-maps/how-to-use-best-practices-for-routing).\n\nFor every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nGET https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **24** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nGET https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix GET request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a GET request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", "operationId": "Route_GetRouteMatrix", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -1034,7 +1034,7 @@ "/route/matrix/sync/{format}": { "post": { "summary": "Use to get a route matrix showing the travel time and distance for all possible pairs in a list of origins and destinations, using a synchronous request.", - "description": "\n\nThe `Post Route Matrix Sync` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using a single synchronous (sync) request. To make an asynchronous (async) request, see [Post Route Matrix](/rest/api/maps/route/post-route-matrix). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nPOST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", + "description": "\n\nThe `Post Route Matrix Sync` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using a single synchronous (sync) request. To make an asynchronous (async) request, see [Post Route Matrix](/rest/api/maps/route/post-route-matrix). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nPOST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **24** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", "operationId": "Route_PostRouteMatrixSync", "x-ms-client-name": "RequestRouteMatrixSync", "x-ms-examples": { @@ -1659,7 +1659,7 @@ "/route/directions/batch/{format}": { "post": { "summary": "Use to send a batch of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API in a single asynchronous request.", - "description": "\n\nThe `Post Route Directions Batch` API is an HTTP `POST` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single asynchronous request. You can call `Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. To call the `Post Route Directions Batch` API in a synchronous request, see [Post Route Directions Batch Sync](/rest/api/maps/route/post-route-directions-batch-sync).\n\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex route requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **700** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Route Directions Batch `POST` request to Azure Maps.\n```\nPOST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}\n```\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n```\nGET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key} \n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _route directions_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 3 _route directions_ queries:\n\n\n```json\n{\n \"batchItems\": [\n { \"query\": \"?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false\" },\n { \"query\": \"?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest\" },\n { \"query\": \"?query=48.923159,-122.557362:32.621279,-116.840362\" }\n ]\n}\n```\n\nA _route directions_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _route directions_ [URI parameters](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#uri-parameters). The string values in the _route directions_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **700** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n \n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 1,\n \"totalRequests\": 2\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\": {\n \"routes\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"legs\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"points\": [\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.34892\n },\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.3485\n },\n {\n \"latitude\": 47.62095,\n \"longitude\": -122.3476\n }\n ]\n }\n ],\n \"sections\": [\n {\n \"startPointIndex\": 0,\n \"endPointIndex\": 40,\n \"sectionType\": \"TRAVEL_MODE\",\n \"travelMode\": \"bicycle\"\n }\n ]\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "description": "\n\nThe `Post Route Directions Batch` API is an HTTP `POST` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single asynchronous request. You can call `Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. To call the `Post Route Directions Batch` API in a synchronous request, see [Post Route Directions Batch Sync](/rest/api/maps/route/post-route-directions-batch-sync).\n\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex route requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **700** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **24** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Route Directions Batch `POST` request to Azure Maps.\n```\nPOST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}\n```\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n```\nGET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key} \n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _route directions_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 3 _route directions_ queries:\n\n\n```json\n{\n \"batchItems\": [\n { \"query\": \"?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false\" },\n { \"query\": \"?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest\" },\n { \"query\": \"?query=48.923159,-122.557362:32.621279,-116.840362\" }\n ]\n}\n```\n\nA _route directions_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _route directions_ [URI parameters](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#uri-parameters). The string values in the _route directions_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **700** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n \n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 1,\n \"totalRequests\": 2\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\": {\n \"routes\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"legs\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"points\": [\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.34892\n },\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.3485\n },\n {\n \"latitude\": 47.62095,\n \"longitude\": -122.3476\n }\n ]\n }\n ],\n \"sections\": [\n {\n \"startPointIndex\": 0,\n \"endPointIndex\": 40,\n \"sectionType\": \"TRAVEL_MODE\",\n \"travelMode\": \"bicycle\"\n }\n ]\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", "operationId": "Route_PostRouteDirectionsBatch", "x-ms-client-name": "RequestRouteDirectionsBatch", "x-ms-long-running-operation": true, diff --git a/specification/maps/suppressions.yaml b/specification/maps/suppressions.yaml new file mode 100644 index 000000000000..499e360ba175 --- /dev/null +++ b/specification/maps/suppressions.yaml @@ -0,0 +1,3 @@ +- tool: TypeSpecRequirement + path: ./data-plane/Route/preview/1.0/route.json + reason: Brownfield service not ready to migrate From ddabbe944a565418534a5953b6e6d5e06135a618 Mon Sep 17 00:00:00 2001 From: Mike Harder <mharder@microsoft.com> Date: Thu, 3 Oct 2024 10:19:58 -0700 Subject: [PATCH 35/47] [.npmrc] Restore trailing newline accidentally removed in #30290 (#30846) --- .npmrc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.npmrc b/.npmrc index 4fd021952d5a..b6f27f135954 100644 --- a/.npmrc +++ b/.npmrc @@ -1 +1 @@ -engine-strict=true \ No newline at end of file +engine-strict=true From 40c0d280afcf6fa543a0f3cb00b9f1e68b6599ba Mon Sep 17 00:00:00 2001 From: amber-ccc <v-xiongchen@microsoft.com> Date: Thu, 3 Oct 2024 12:27:58 -0700 Subject: [PATCH 36/47] - Converting Authoring Analyzeconversations of 2023-04-15-preview and 2023-04-01 version to Typespec. (#30499) * - initiated the first version of typespec. * - deleted testing swagger for authoring conversations - added testing json for authoring conversations 2023-04-15-preview * - added long running operations * - added a createOrUpdate operation with 201 response * - modified the operationId in SuccesfulCopyProjectAuthorization.json - compiled * - added SuccessfulGetDeploymentDeleteFromResourcesStatus.json - compiled * - modified model EvaluationResults - compiled * - fixed Swagger SpellCheck - compiled * - adjusted the map of map structure of ConfusionMatrix - compiled * - modified the map of map structure of IntentsEvaluationSummary - compiled * - add 2023-04-01 version information * - added testing json for 2023-04-01 - compiled * - changed all the Azure.Core.Paged to model definition of array and nextLink (String) * - modified the parameter name of some testing json of 2023-04-01 * - deleted the analyzeconversations-authoring folder under example of 2023-04-01 * - modified the name of models to add prefix ConversationAnalysisAuthoring - compiled * - add version 2023-04-15-preview to CustomConversationSummarization of ConversationalAnalysisAuthoringProjectKind - compiled * - changed the way of calling Azure.Core.Foundations.Error to definitions/error - compiled * - changed the appId type to uuid - compiled * - removed maxLength of projectName of ProjecteMetaData - compiled * - added version 2023-04-15-preview to storageInputContainerName of ProjectMetaData * - added Versions 2023_04_15_preview to some properties - compiled * - add Versions v2023_04_15_preview to ConversationalAnalysisAuthoringCreateDeploymentOptions.properties.assignedResourceIds - compiled * - used npx command to fix TypeSpec Validation errors * - fixed TypeSpec Validation - compiled * - made ConversationalAnalysisAuthoringCreateProjectOptions the request payload of the patch CreateProject operation, and made some of the properties optional - compiled * - fixed typespec validation in Language.AnalyzeConversations-authoring - compiled * - modified the titles of each testing json - compiled * - revert to the `main` version package-lock.json and package.json * - modified the title of testing json SuccessfulSwapDeployment - compiled * - used npx tsv command to fix TypeSpec Validation * - added resource template for ProjectMetaData - used ResourceAction and LongRunningResourceAction for Resource ProjectMetaData (Operation authorize-copy and copy) - compiled * - added child Resource ProjectDeployment - implemented Resource ProjectDeployment Template for getDeploymentsList - compiled * - added CopyProjectJobState as child Resource of ProjectMetaData - implemented CopyProjectJobState by ResourceRead - compiled * - completed all the LongRunningResourceAction for resource ProjectMetadata - compiled * - used resource template for resource ProjectDeployment (Child of ProjectMetadata) - used ResourceRead template for resource DeploymentJobState (Child of ProjectDeployment) - compiled * - added operation templates for resource ProjectTrainedModel - compiled * - added some JobState as children of ProjectTrainedModel - used ResourceRead Template for these JobState resource - compiled * - added Resource resources and used some of its resource template - compiled * - add resource "train/jobs" for TrainingJobState - used some resource template of TrainingJobState - compiled * - added DeploymentDeleteFromResourcesJobState and SwapDeploymentsJobState to fix duplicated DeploymentJobState resource issue - compiled * - added two more jobstate ExportProjectJobState and ImportProjectJobState as resource - used ResourceRead template for thess two resources - compiled * - modified the operation name copy to copyProject - added action("copy") for this - compiled * - used npx tsv command to resolve TypeSpec Validation * - removed the "read" for @visibility of JobState.jobId - compiled * - added @actionSeparator("/:") to solve the RemovedPath and AddedPath issue - compiled * - reverted protected files to main version * - removed all the "read" from @visibility in order to remove the readOnly properties in new swagger - compiled * - introduced the low-level LongRunning Operation to remove the status monitor in response - compiled * - removed all the FIXME of utcDateTime properties * - used npx tsv command to resolve TypeSpec Validation * - removed all the prefix of union and make the x-ms-enum same as old version - compiled * - gave concrete example to the uri in SuccessfulGetModelEvaluation testing json, trying to fix Swagger ModelValidation - compiled * - modified the namespace, adding Conversations at the end - compiled --- .../SuccessfulCancelTrainingJob.json | 2 + .../2023-04-01}/SuccessfulCreateProject.json | 2 + .../SuccessfulDeleteDeployment.json | 2 + .../2023-04-01}/SuccessfulDeleteModel.json | 2 + .../2023-04-01}/SuccessfulDeleteProject.json | 2 + .../2023-04-01}/SuccessfulDeployProject.json | 2 + .../2023-04-01}/SuccessfulExportProject.json | 2 + .../2023-04-01}/SuccessfulGetDeployment.json | 2 + .../SuccessfulGetDeploymentStatus.json | 2 + .../2023-04-01/SuccessfulGetExportResult.json | 36 + .../SuccessfulGetExportStatus.json | 2 + .../SuccessfulGetImportStatus.json | 2 + .../SuccessfulGetLoadSnapshotStatus.json | 2 + .../2023-04-01}/SuccessfulGetModel.json | 2 + .../SuccessfulGetModelEvaluation.json | 4 +- .../SuccessfulGetModelEvaluationSummary.json | 2 + .../2023-04-01}/SuccessfulGetProject.json | 2 + .../SuccessfulGetProjectDeletionStatus.json | 2 + .../SuccessfulGetSupportedLanguages.json | 2 + ...uccessfulGetSupportedPrebuiltEntities.json | 2 + ...fulGetSupportedTrainingConfigVersions.json | 2 + .../SuccessfulGetSwapDeploymentsStatus.json | 2 + .../2023-04-01}/SuccessfulGetTrainStatus.json | 2 + .../2023-04-01}/SuccessfulImportProject.json | 2 + .../SuccessfulListDeployments.json | 2 + .../2023-04-01}/SuccessfulListModels.json | 2 + .../2023-04-01}/SuccessfulListProjects.json | 2 + .../SuccessfulListTrainingJobs.json | 2 + .../2023-04-01}/SuccessfulLoadSnapshot.json | 2 + .../SuccessfulSwapDeployments.json | 2 + .../2023-04-01}/SuccessfulTrainProject.json | 2 + .../SuccessfulAssignDeploymentResources.json | 2 + .../SuccessfulCancelTrainingJob.json | 2 + .../SuccessfulCopyProject.json | 2 + .../SuccessfulCopyProjectAuthorization.json | 2 + .../SuccessfulCreateProject.json | 2 + .../SuccessfulDeleteDeployment.json | 2 + ...ccessfulDeleteDeploymentFromResources.json | 2 + .../SuccessfulDeleteModel.json | 2 + .../SuccessfulDeleteProject.json | 2 + .../SuccessfulDeployProject.json | 2 + .../SuccessfulEvaluationProject.json | 2 + .../SuccessfulExportProject.json | 2 + ...ulGetAssignDeploymentResourcesStatus.json} | 2 + .../SuccessfulGetCopyProjectStatus.json | 2 + .../SuccessfulGetDeployment.json | 2 + ...etDeploymentDeleteFromResourcesStatus.json | 24 + .../SuccessfulGetDeploymentStatus.json | 2 + .../SuccessfulGetEvaluationStatus.json | 2 + .../SuccessfulGetExportStatus.json | 2 + .../SuccessfulGetImportStatus.json | 2 + .../SuccessfulGetLoadSnapshotStatus.json | 2 + .../SuccessfulGetModel.json | 2 + .../SuccessfulGetModelEvaluation.json | 4 +- .../SuccessfulGetModelEvaluationSummary.json | 2 + .../SuccessfulGetProject.json | 2 + .../SuccessfulGetProjectDeletionStatus.json | 2 + .../SuccessfulGetSupportedLanguages.json | 2 + ...uccessfulGetSupportedPrebuiltEntities.json | 2 + ...fulGetSupportedTrainingConfigVersions.json | 2 + .../SuccessfulGetSwapDeploymentsStatus.json | 2 + .../SuccessfulGetTrainStatus.json | 2 + ...lGetUnassignDeploymentResourcesStatus.json | 23 + .../SuccessfulImportProject.json | 2 + ...essfulListAssignedResourceDeployments.json | 2 + .../SuccessfulListDeploymentResources.json | 2 + .../SuccessfulListDeployments.json | 2 + .../SuccessfulListModels.json | 2 + .../SuccessfulListProjects.json | 2 + .../SuccessfulListTrainingJobs.json | 2 + .../SuccessfulLoadSnapshot.json | 2 + .../SuccessfulSwapDeployments.json | 2 + .../SuccessfulTrainProject.json | 2 + ...SuccessfulUnassignDeploymentResources.json | 2 + .../main.tsp | 65 + .../models.tsp | 2061 +++++++ .../routes.tsp | 852 +++ .../tspconfig.yaml | 21 + .../analyzeconversations-authoring.json | 4955 ++++++++++------- .../SuccessfulAssignDeploymentResources.json | 31 + .../examples/SuccessfulCancelTrainingJob.json | 18 + .../examples/SuccessfulCopyProject.json | 25 + .../SuccessfulCopyProjectAuthorization.json | 27 + .../examples/SuccessfulCreateProject.json | 46 + .../examples/SuccessfulDeleteDeployment.json | 18 + ...ccessfulDeleteDeploymentFromResources.json | 23 + .../examples/SuccessfulDeleteModel.json | 14 + .../examples/SuccessfulDeleteProject.json | 17 + .../examples/SuccessfulDeployProject.json | 25 + .../examples/SuccessfulEvaluationProject.json | 23 + .../examples/SuccessfulExportProject.json | 18 + ...fulGetAssignDeploymentResourcesStatus.json | 23 + ...on => SuccessfulGetCopyProjectStatus.json} | 2 + .../examples/SuccessfulGetDeployment.json | 34 + ...etDeploymentDeleteFromResourcesStatus.json | 24 + .../SuccessfulGetDeploymentStatus.json | 24 + .../SuccessfulGetEvaluationStatus.json | 34 + .../examples/SuccessfulGetExportStatus.json | 24 + .../examples/SuccessfulGetImportStatus.json | 23 + .../SuccessfulGetLoadSnapshotStatus.json | 24 + .../examples/SuccessfulGetModel.json | 25 + .../SuccessfulGetModelEvaluation.json | 286 + .../SuccessfulGetModelEvaluationSummary.json | 528 ++ .../examples/SuccessfulGetProject.json | 26 + .../SuccessfulGetProjectDeletionStatus.json | 22 + .../SuccessfulGetSupportedLanguages.json | 400 ++ ...uccessfulGetSupportedPrebuiltEntities.json | 100 + ...fulGetSupportedTrainingConfigVersions.json | 24 + .../SuccessfulGetSwapDeploymentsStatus.json | 23 + .../examples/SuccessfulGetTrainStatus.json | 38 + ...lGetUnassignDeploymentResourcesStatus.json | 23 + .../examples/SuccessfulImportProject.json | 80 + ...essfulListAssignedResourceDeployments.json | 28 + .../SuccessfulListDeploymentResources.json | 27 + .../examples/SuccessfulListDeployments.json | 51 + .../examples/SuccessfulListModels.json | 38 + .../examples/SuccessfulListProjects.json | 37 + .../examples/SuccessfulListTrainingJobs.json | 92 + .../examples/SuccessfulLoadSnapshot.json | 18 + .../examples/SuccessfulSwapDeployments.json | 21 + .../examples/SuccessfulTrainProject.json | 27 + ...SuccessfulUnassignDeploymentResources.json | 23 + .../analyzeconversations-authoring.json | 3869 +++++++------ .../examples/SuccessfulCancelTrainingJob.json | 18 + .../examples/SuccessfulCreateProject.json | 46 + .../examples/SuccessfulDeleteDeployment.json | 18 + .../examples/SuccessfulDeleteModel.json | 14 + .../examples/SuccessfulDeleteProject.json | 17 + .../examples/SuccessfulDeployProject.json | 21 + .../examples/SuccessfulExportProject.json | 18 + .../examples/SuccessfulGetDeployment.json | 24 + .../SuccessfulGetDeploymentStatus.json | 24 + .../examples/SuccessfulGetExportStatus.json | 24 + .../examples/SuccessfulGetImportStatus.json | 23 + .../SuccessfulGetLoadSnapshotStatus.json | 24 + .../examples/SuccessfulGetModel.json | 25 + .../SuccessfulGetModelEvaluation.json | 286 + .../SuccessfulGetModelEvaluationSummary.json | 528 ++ .../examples/SuccessfulGetProject.json | 26 + .../SuccessfulGetProjectDeletionStatus.json | 22 + .../SuccessfulGetSupportedLanguages.json | 400 ++ ...uccessfulGetSupportedPrebuiltEntities.json | 100 + ...fulGetSupportedTrainingConfigVersions.json | 24 + .../SuccessfulGetSwapDeploymentsStatus.json | 23 + .../examples/SuccessfulGetTrainStatus.json | 38 + .../examples/SuccessfulImportProject.json | 80 + .../examples/SuccessfulListDeployments.json | 35 + .../examples/SuccessfulListModels.json | 38 + .../examples/SuccessfulListProjects.json | 37 + .../examples/SuccessfulListTrainingJobs.json | 92 + .../examples/SuccessfulLoadSnapshot.json | 18 + .../examples/SuccessfulSwapDeployments.json | 21 + .../examples/SuccessfulTrainProject.json | 27 + 153 files changed, 13011 insertions(+), 3566 deletions(-) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulCancelTrainingJob.json (81%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulCreateProject.json (92%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulDeleteDeployment.json (80%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulDeleteModel.json (68%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulDeleteProject.json (80%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulDeployProject.json (84%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulExportProject.json (82%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetDeployment.json (85%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetDeploymentStatus.json (84%) create mode 100644 specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetExportResult.json rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetExportStatus.json (87%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetImportStatus.json (84%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetLoadSnapshotStatus.json (83%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetModel.json (85%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetModelEvaluation.json (96%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetModelEvaluationSummary.json (99%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetProject.json (86%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetProjectDeletionStatus.json (81%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetSupportedLanguages.json (98%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetSupportedPrebuiltEntities.json (95%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetSupportedTrainingConfigVersions.json (75%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetSwapDeploymentsStatus.json (81%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetTrainStatus.json (90%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulImportProject.json (95%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulListDeployments.json (90%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulListModels.json (90%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulListProjects.json (90%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulListTrainingJobs.json (96%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulLoadSnapshot.json (82%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulSwapDeployments.json (83%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulTrainProject.json (87%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulAssignDeploymentResources.json (89%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulCancelTrainingJob.json (81%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulCopyProject.json (89%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulCopyProjectAuthorization.json (85%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulCreateProject.json (92%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulDeleteDeployment.json (81%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulDeleteDeploymentFromResources.json (83%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulDeleteModel.json (69%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulDeleteProject.json (80%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulDeployProject.json (89%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulEvaluationProject.json (84%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulExportProject.json (82%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetAssignDeploymentResourcesStatus.json} (79%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetCopyProjectStatus.json (83%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetDeployment.json (91%) create mode 100644 specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetDeploymentDeleteFromResourcesStatus.json rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetDeploymentStatus.json (84%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetEvaluationStatus.json (88%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetExportStatus.json (87%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetImportStatus.json (84%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetLoadSnapshotStatus.json (83%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetModel.json (85%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetModelEvaluation.json (96%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetModelEvaluationSummary.json (99%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetProject.json (87%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetProjectDeletionStatus.json (81%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetSupportedLanguages.json (98%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetSupportedPrebuiltEntities.json (95%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetSupportedTrainingConfigVersions.json (75%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetSwapDeploymentsStatus.json (82%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetTrainStatus.json (90%) create mode 100644 specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetUnassignDeploymentResourcesStatus.json rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulImportProject.json (95%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulListAssignedResourceDeployments.json (79%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulListDeploymentResources.json (85%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulListDeployments.json (94%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulListModels.json (90%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulListProjects.json (90%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulListTrainingJobs.json (96%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulLoadSnapshot.json (82%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulSwapDeployments.json (83%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulTrainProject.json (87%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulUnassignDeploymentResources.json (83%) create mode 100644 specification/cognitiveservices/Language.AnalyzeConversations-authoring/main.tsp create mode 100644 specification/cognitiveservices/Language.AnalyzeConversations-authoring/models.tsp create mode 100644 specification/cognitiveservices/Language.AnalyzeConversations-authoring/routes.tsp create mode 100644 specification/cognitiveservices/Language.AnalyzeConversations-authoring/tspconfig.yaml create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulAssignDeploymentResources.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCancelTrainingJob.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCopyProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCopyProjectAuthorization.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCreateProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteDeployment.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteDeploymentFromResources.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteModel.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeployProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulEvaluationProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulExportProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetAssignDeploymentResourcesStatus.json rename specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/{analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json => SuccessfulGetCopyProjectStatus.json} (83%) create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetDeployment.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetDeploymentDeleteFromResourcesStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetDeploymentStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetEvaluationStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetExportStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetImportStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetLoadSnapshotStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetModel.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetModelEvaluation.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetModelEvaluationSummary.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetProjectDeletionStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSupportedLanguages.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSupportedPrebuiltEntities.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSupportedTrainingConfigVersions.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSwapDeploymentsStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetTrainStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetUnassignDeploymentResourcesStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulImportProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListAssignedResourceDeployments.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListDeploymentResources.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListDeployments.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListModels.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListProjects.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListTrainingJobs.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulLoadSnapshot.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulSwapDeployments.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulTrainProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulUnassignDeploymentResources.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulCancelTrainingJob.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulCreateProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeleteDeployment.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeleteModel.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeleteProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeployProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulExportProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetDeployment.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetDeploymentStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetExportStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetImportStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetLoadSnapshotStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetModel.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetModelEvaluation.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetModelEvaluationSummary.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetProjectDeletionStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSupportedLanguages.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSupportedPrebuiltEntities.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSupportedTrainingConfigVersions.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSwapDeploymentsStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetTrainStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulImportProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListDeployments.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListModels.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListProjects.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListTrainingJobs.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulLoadSnapshot.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulSwapDeployments.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulTrainProject.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulCancelTrainingJob.json similarity index 81% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulCancelTrainingJob.json index 88fb6767655e..4a5adb1de3cf 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulCancelTrainingJob.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_CancelTrainingJob", + "title": "Successful Cancel Training Job", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulCreateProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulCreateProject.json similarity index 92% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulCreateProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulCreateProject.json index 98007ecafe72..eb8e9f98c34b 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulCreateProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulCreateProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_CreateProject", + "title": "Successful Create Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulDeleteDeployment.json similarity index 80% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulDeleteDeployment.json index 74ba10ef7f11..501a4d76422e 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulDeleteDeployment.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_DeleteDeployment", + "title": "Successful Delete Deployment", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulDeleteModel.json similarity index 68% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulDeleteModel.json index 7aaeb03f6752..d26273b5afc1 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulDeleteModel.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_DeleteTrainedModel", + "title": "Successful Delete Model", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulDeleteProject.json similarity index 80% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulDeleteProject.json index 86397edb0efc..a3acdc62663c 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulDeleteProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_DeleteProject", + "title": "Successful Delete Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulDeployProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulDeployProject.json similarity index 84% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulDeployProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulDeployProject.json index c115c10978e7..6126317b23a7 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulDeployProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulDeployProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_DeployProject", + "title": "Successful Deploy Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulExportProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulExportProject.json similarity index 82% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulExportProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulExportProject.json index 4c84fa0276a7..35a62393cb4b 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulExportProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulExportProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_Export", + "title": "Successful Export Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetDeployment.json similarity index 85% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetDeployment.json index e90d172ebf9c..67f138a743fc 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetDeployment.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetDeployment", + "title": "Successful Get Deployment", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetDeploymentStatus.json similarity index 84% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetDeploymentStatus.json index 6129720003e3..9b395ff4f3e3 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetDeploymentStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetDeploymentStatus", + "title": "Successful Get Deployment Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetExportResult.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetExportResult.json new file mode 100644 index 000000000000..7b018cb88759 --- /dev/null +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetExportResult.json @@ -0,0 +1,36 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetExportResult", + "title": "Successful Get Export Result", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "SampleProject", + "jobId": "job12345" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "projectFileVersion": "1.0.0", + "stringIndexType": "Utf16CodeUnit", + "metadata": { + "projectKind": "Conversation", + "projectName": "SampleProject", + "language": "en", + "settings": { + "confidenceThreshold": 0.8, + "normalizeCasing": true, + "augmentDiacritics": false + }, + "storageInputContainerName": "project-container", + "multilingual": false, + "description": "Sample project description" + }, + "assets": { + "projectKind": "Conversation" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetExportStatus.json similarity index 87% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetExportStatus.json index 8e3275eb0950..396fde0729d1 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetExportStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetExportStatus", + "title": "Successful Get Export Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetImportStatus.json similarity index 84% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetImportStatus.json index 0554591835a2..4b70711fba95 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetImportStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetImportStatus", + "title": "Successful Get Import Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetLoadSnapshotStatus.json similarity index 83% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetLoadSnapshotStatus.json index dc21261da3bb..52e7fb4e3bfe 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetLoadSnapshotStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetLoadSnapshotStatus", + "title": "Successful Get Load Snapshot Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetModel.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetModel.json similarity index 85% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetModel.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetModel.json index 30d7b001de6a..5bb2e9921127 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetModel.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetModel.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetTrainedModel", + "title": "Successful Get Model", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetModelEvaluation.json similarity index 96% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetModelEvaluation.json index 8dc4b6f88e33..4dd48dfb5cc2 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetModelEvaluation.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationResults", + "title": "Successful Get Model Evaluation", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", @@ -277,7 +279,7 @@ } } ], - "nextLink": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/models/model1/evaluation/result/?api-version=2023-04-01&top=2147483637&skip={maxpagesize}&maxpagesize={maxpagesize}" + "nextLink": "https://api.example.com/language/authoring/analyze-conversations/projects/EmailApp/models/model1/evaluation/result/?api-version=2023-04-01&top=2147483637&skip=100&maxpagesize=100" } } } diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetModelEvaluationSummary.json similarity index 99% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetModelEvaluationSummary.json index 8fb25eb99c9c..6daf3fcfb0b8 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetModelEvaluationSummary.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationSummary", + "title": "Successful Get Model Evaluation Summary", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetProject.json similarity index 86% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetProject.json index 50b53ae6415a..ae7d1bd2b688 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetProject", + "title": "Successful Get Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetProjectDeletionStatus.json similarity index 81% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetProjectDeletionStatus.json index 73c8d1cf0647..59061c1f7931 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetProjectDeletionStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetProjectDeletionStatus", + "title": "Successful Get Project Deletion Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetSupportedLanguages.json similarity index 98% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetSupportedLanguages.json index ed6b0478cdd7..545214c68df8 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetSupportedLanguages.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetSupportedLanguages", + "title": "Successful Get Supported Languages", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetSupportedPrebuiltEntities.json similarity index 95% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetSupportedPrebuiltEntities.json index 7e288d169478..9bea82d1eed2 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetSupportedPrebuiltEntities.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetSupportedPrebuiltEntities", + "title": "Successful Get Supported Prebuilt Entities", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetSupportedTrainingConfigVersions.json similarity index 75% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetSupportedTrainingConfigVersions.json index 06780f7fa92b..baf3e1d78dfc 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetSupportedTrainingConfigVersions.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_ListTrainingConfigVersions", + "title": "Successful Get Supported Training Config Versions", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetSwapDeploymentsStatus.json similarity index 81% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetSwapDeploymentsStatus.json index 0aac88c8d145..a904361d0a70 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetSwapDeploymentsStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetSwapDeploymentsStatus", + "title": "Successful Get Swap Deployments Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetTrainStatus.json similarity index 90% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetTrainStatus.json index 5f28035def5e..e95467f15ac6 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetTrainStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetTrainingStatus", + "title": "Successful Get Train Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulImportProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulImportProject.json similarity index 95% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulImportProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulImportProject.json index 61d70d484c59..3cf13bd844f8 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulImportProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulImportProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_Import", + "title": "Successful Import Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulListDeployments.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulListDeployments.json similarity index 90% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulListDeployments.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulListDeployments.json index c968d5123219..c92e5ebd7bfe 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulListDeployments.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulListDeployments.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_ListDeployments", + "title": "Successful List Deployments", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulListModels.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulListModels.json similarity index 90% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulListModels.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulListModels.json index 0a9e351e22bb..12bc75279ea3 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulListModels.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulListModels.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_ListTrainedModels", + "title": "Successful List Models", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulListProjects.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulListProjects.json similarity index 90% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulListProjects.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulListProjects.json index 8b52f2c1adce..b3e66b3d7364 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulListProjects.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulListProjects.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_ListProjects", + "title": "Successful List Projects", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulListTrainingJobs.json similarity index 96% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulListTrainingJobs.json index 5772f4670098..b601958cdf62 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulListTrainingJobs.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_ListTrainingJobs", + "title": "Successful List Training Jobs", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulLoadSnapshot.json similarity index 82% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulLoadSnapshot.json index 9409332d34df..b82ac165a0b8 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulLoadSnapshot.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_LoadSnapshot", + "title": "Successful Load Snapshot", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulSwapDeployments.json similarity index 83% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulSwapDeployments.json index 5ac2aa6d1bea..305893a716b8 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulSwapDeployments.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_SwapDeployments", + "title": "Successful Swap Deployments", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulTrainProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulTrainProject.json similarity index 87% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulTrainProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulTrainProject.json index a86428a5b7ea..74a43e3c0c8e 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulTrainProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulTrainProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_Train", + "title": "Successful Train Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulAssignDeploymentResources.json similarity index 89% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulAssignDeploymentResources.json index 4e7006c865d6..b8577067d66b 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulAssignDeploymentResources.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_AssignDeploymentResources", + "title": "Successful Assign Deployment Resources", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulCancelTrainingJob.json similarity index 81% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulCancelTrainingJob.json index c2176658ab8c..a87a5e05d24b 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulCancelTrainingJob.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_CancelTrainingJob", + "title": "Successful Cancel Training Job", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulCopyProject.json similarity index 89% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulCopyProject.json index 07cb874e9f07..3bffe749e1a3 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulCopyProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_CopyProject", + "title": "Successful Copy Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulCopyProjectAuthorization.json similarity index 85% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulCopyProjectAuthorization.json index 1edbbf55e89a..559d5a6cbc42 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulCopyProjectAuthorization.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_CopyProjectAuthorization", + "title": "Successful Copy Project Authorization", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCreateProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulCreateProject.json similarity index 92% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCreateProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulCreateProject.json index 86ead630d411..b97424b580db 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCreateProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulCreateProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_CreateProject", + "title": "Successful Create Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeleteDeployment.json similarity index 81% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeleteDeployment.json index 84b39ba95dec..f39bc67461ae 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeleteDeployment.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_DeleteDeployment", + "title": "Successful Delete Deployment", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeleteDeploymentFromResources.json similarity index 83% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeleteDeploymentFromResources.json index 461e83b08f4d..1b5cdb84bc8d 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeleteDeploymentFromResources.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_DeleteDeploymentFromResources", + "title": "Successful Delete Deployment From Resources", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeleteModel.json similarity index 69% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeleteModel.json index eeeb258682b5..9c02021b969c 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeleteModel.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_DeleteTrainedModel", + "title": "Successful Delete Model", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeleteProject.json similarity index 80% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeleteProject.json index 80f1824da7a3..38cc03250ae8 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeleteProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_DeleteProject", + "title": "Successful Delete Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeployProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeployProject.json similarity index 89% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeployProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeployProject.json index 3910787f949e..e50c76314cc4 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeployProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeployProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_DeployProject", + "title": "Successful Deploy Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulEvaluationProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulEvaluationProject.json similarity index 84% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulEvaluationProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulEvaluationProject.json index 7082ccfb9ac4..6671e82372c2 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulEvaluationProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulEvaluationProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_EvaluateModel", + "title": "Successful Evaluation Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulExportProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulExportProject.json similarity index 82% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulExportProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulExportProject.json index 161bd80214eb..c23a7eeefb98 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulExportProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulExportProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_Export", + "title": "Successful Export Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetAssignDeploymentResourcesStatus.json similarity index 79% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetAssignDeploymentResourcesStatus.json index aa6548d7266f..79fcbc9ccb39 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetAssignDeploymentResourcesStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetAssignDeploymentResourcesStatus", + "title": "Successful Get Assign Deployment Resources Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetCopyProjectStatus.json similarity index 83% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetCopyProjectStatus.json index aa6548d7266f..16ac708cf150 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetCopyProjectStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetCopyProjectStatus", + "title": "Successful Get Copy Project Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetDeployment.json similarity index 91% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetDeployment.json index 83e4c0a84d4b..a26e6fe5fad7 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetDeployment.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetDeployment", + "title": "Successful Get Deployment", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetDeploymentDeleteFromResourcesStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetDeploymentDeleteFromResourcesStatus.json new file mode 100644 index 000000000000..5d0b5e353b44 --- /dev/null +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetDeploymentDeleteFromResourcesStatus.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetDeploymentDeleteFromResourcesStatus", + "title": "Successful Get Deployment Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "deploymentName": "production", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetDeploymentStatus.json similarity index 84% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetDeploymentStatus.json index 78b5d9d10b94..d065933efcbc 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetDeploymentStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetDeploymentStatus", + "title": "Successful Get Deployment Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetEvaluationStatus.json similarity index 88% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetEvaluationStatus.json index 41883e8d6fad..42402bfff47f 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetEvaluationStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetEvaluationStatus", + "title": "Successful Get Evaluation Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetExportStatus.json similarity index 87% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetExportStatus.json index bc0548bdc831..c33e21494512 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetExportStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetExportStatus", + "title": "Successful Get Export Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetImportStatus.json similarity index 84% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetImportStatus.json index be17017d6851..0348df4ec820 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetImportStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetImportStatus", + "title": "Successful Get Import Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetLoadSnapshotStatus.json similarity index 83% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetLoadSnapshotStatus.json index f23c49aeb135..b462a1000dd2 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetLoadSnapshotStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetLoadSnapshotStatus", + "title": "Successful Get Load Snapshot Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModel.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetModel.json similarity index 85% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModel.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetModel.json index 8f39a1061ba8..f88377461b06 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModel.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetModel.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetTrainedModel", + "title": "Successful Get Model", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetModelEvaluation.json similarity index 96% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetModelEvaluation.json index 808a4b33a079..76875d700b52 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetModelEvaluation.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationResults", + "title": "Successful Get Model Evaluation", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", @@ -277,7 +279,7 @@ } } ], - "nextLink": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/models/model1/evaluation/result/?api-version=2023-04-15-preview&top=2147483637&skip={maxpagesize}&maxpagesize={maxpagesize}" + "nextLink": "https://api.example.com/language/authoring/analyze-conversations/projects/EmailApp/models/model1/evaluation/result/?api-version=2023-04-15-preview&top=2147483637&skip=100&maxpagesize=100" } } } diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetModelEvaluationSummary.json similarity index 99% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetModelEvaluationSummary.json index 02b7ff45d595..c72f475a6bb0 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetModelEvaluationSummary.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationSummary", + "title": "Successful Get Model Evaluation Summary", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetProject.json similarity index 87% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetProject.json index 54356dd6a1e8..a94bb114d32d 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetProject", + "title": "Successful Get Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetProjectDeletionStatus.json similarity index 81% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetProjectDeletionStatus.json index e19af641d407..811552fb4422 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetProjectDeletionStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetProjectDeletionStatus", + "title": "Successful Get Project Deletion Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetSupportedLanguages.json similarity index 98% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetSupportedLanguages.json index 9d3ff98c1179..7899bc7d77a7 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetSupportedLanguages.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetSupportedLanguages", + "title": "Successful Get Supported Languages", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetSupportedPrebuiltEntities.json similarity index 95% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetSupportedPrebuiltEntities.json index 085f8653624c..a1e8e439638e 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetSupportedPrebuiltEntities.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetSupportedPrebuiltEntities", + "title": "Successful Get Supported Prebuilt Entities", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetSupportedTrainingConfigVersions.json similarity index 75% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetSupportedTrainingConfigVersions.json index 3e529aa6e8cf..67633ed31525 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetSupportedTrainingConfigVersions.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_ListTrainingConfigVersions", + "title": "Successful Get Supported Training Config Versions", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetSwapDeploymentsStatus.json similarity index 82% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetSwapDeploymentsStatus.json index b253ab021bdd..5acc8e3f9682 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetSwapDeploymentsStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetSwapDeploymentsStatus", + "title": "Successful Get Swap Deployments Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetTrainStatus.json similarity index 90% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetTrainStatus.json index 38b0ff4f00e9..f906c7ce7db4 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetTrainStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetTrainingStatus", + "title": "Successful Get Train Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetUnassignDeploymentResourcesStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetUnassignDeploymentResourcesStatus.json new file mode 100644 index 000000000000..070f83815b28 --- /dev/null +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetUnassignDeploymentResourcesStatus.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetUnassignDeploymentResourcesStatus", + "title": "Successful Get Unassign Deployment Resources Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulImportProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulImportProject.json similarity index 95% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulImportProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulImportProject.json index 2401bf8e11fe..162fe542788a 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulImportProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulImportProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_Import", + "title": "Successful Import Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListAssignedResourceDeployments.json similarity index 79% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListAssignedResourceDeployments.json index 3624e3454baa..a6a825669663 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListAssignedResourceDeployments.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_ListAssignedResourceDeployments", + "title": "Successful List Assigned Resource Deployments", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListDeploymentResources.json similarity index 85% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListDeploymentResources.json index 844b5dc1abce..0d43121bc1b1 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListDeploymentResources.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_ListDeploymentResources", + "title": "Successful List Deployment Resources", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeployments.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListDeployments.json similarity index 94% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeployments.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListDeployments.json index 45d74c29ee23..5d285673c9d9 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeployments.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListDeployments.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_ListDeployments", + "title": "Successful List Deployments", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListModels.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListModels.json similarity index 90% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListModels.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListModels.json index ff63d8e11bee..b8f3ea2f2997 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListModels.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListModels.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_ListTrainedModels", + "title": "Successful List Models", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListProjects.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListProjects.json similarity index 90% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListProjects.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListProjects.json index c552715ef07a..78aaca5ce95d 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListProjects.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListProjects.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_ListProjects", + "title": "Successful List Projects", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListTrainingJobs.json similarity index 96% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListTrainingJobs.json index 52e1310e383e..b09d2909bb85 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListTrainingJobs.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_ListTrainingJobs", + "title": "Successful List Training Jobs", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulLoadSnapshot.json similarity index 82% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulLoadSnapshot.json index 46dc941317e6..56580a2abafb 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulLoadSnapshot.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_LoadSnapshot", + "title": "Successful Load Snapshot", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulSwapDeployments.json similarity index 83% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulSwapDeployments.json index 4a8d99eed7b3..c1a56e4c4962 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulSwapDeployments.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_SwapDeployments", + "title": "Successful Swap Deployments", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulTrainProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulTrainProject.json similarity index 87% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulTrainProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulTrainProject.json index b5ca19f3979f..cb70afa30274 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulTrainProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulTrainProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_Train", + "title": "Successful Train Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulUnassignDeploymentResources.json similarity index 83% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulUnassignDeploymentResources.json index 2148033164b5..d2d38edbbc3d 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulUnassignDeploymentResources.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_UnassignDeploymentResources", + "title": "Successful Unassign Deployment Resources", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/Language.AnalyzeConversations-authoring/main.tsp b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/main.tsp new file mode 100644 index 000000000000..5a78591767e3 --- /dev/null +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/main.tsp @@ -0,0 +1,65 @@ +/** + * PLEASE DO NOT REMOVE - USED FOR CONVERTER METRICS + * Generated by package: @autorest/openapi-to-typespec + * Version: 0.9.0 + * Date: 2024-09-10T19:37:44.296Z + */ +import "@typespec/rest"; +import "@typespec/http"; +import "./routes.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using TypeSpec.Versioning; +/** + * 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 <a + * href="https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview">https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview</a>. + */ +/** The language service conversations API is a suite of natural language processing (NLP) skills that can be used to analyze structured conversations (textual or spoken). The synchronous API in this suite accepts a request and mediates among multiple language projects, such as LUIS Generally Available, Question Answering, Conversational Language Understanding, and then calls the best candidate service to handle the request. At last, it returns a response with the candidate service's response as a payload.\n\n In some cases, this API needs to forward requests and responses between the caller and an upstream service. The asynchronous APIs in this suite enable tasks like Conversation Summarization and Conversational PII detection. */ +@useAuth( + ApiKeyAuth<ApiKeyLocation.header, "Ocp-Apim-Subscription-Key"> | OAuth2Auth<[ + { + type: OAuth2FlowType.authorizationCode, + authorizationUrl: "https://login.microsoftonline.com/common/oauth2/authorize", + tokenUrl: "https://login.microsoftonline.com/common/oauth2/token", + scopes: ["https://cognitiveservices.azure.com/.default"], + } + ]> +) +@service({ + title: "Microsoft Cognitive Language Service - Analyze Conversations Authoring", +}) +@versioned(Versions) +@server( + "{Endpoint}/language", + "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 <a href=\"https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview\">https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview</a>.", + { + /** + * Supported Cognitive Services endpoint (e.g., + * https://<resource-name>.api.cognitiveservices.azure.com). + */ + endpoint: string, + + Endpoint: string, + } +) +namespace Language.Authoring.Conversations; + +/** + * The available API versions. + */ +enum Versions { + /** Version 2023-04-01 */ + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + v2023_04_01: "2023-04-01", + + /** + * The 2023-04-15-preview API version. + */ + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + v2023_04_15_preview: "2023-04-15-preview", +} diff --git a/specification/cognitiveservices/Language.AnalyzeConversations-authoring/models.tsp b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/models.tsp new file mode 100644 index 000000000000..f950e7dce494 --- /dev/null +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/models.tsp @@ -0,0 +1,2061 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.Core.Traits; + +namespace Language.Authoring.Conversations; + +#suppress "@azure-tools/typespec-azure-core/documentation-required" +union ProjectKind { + string, + + /** + * A project to build natural language into apps, bots, and IoT devices. + */ + Conversation: "Conversation", + + /** + * A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project. + */ + Orchestration: "Orchestration", + + /** + * A project to build conversation summarization models which are able to summarize long conversations. + */ + @added(Versions.v2023_04_15_preview) + CustomConversationSummarization: "CustomConversationSummarization", +} + +/** + * Human-readable error code. + */ +#suppress "@azure-tools/typespec-azure-core/documentation-required" +union ErrorCode { + string, + InvalidRequest: "InvalidRequest", + InvalidArgument: "InvalidArgument", + Unauthorized: "Unauthorized", + Forbidden: "Forbidden", + NotFound: "NotFound", + ProjectNotFound: "ProjectNotFound", + OperationNotFound: "OperationNotFound", + AzureCognitiveSearchNotFound: "AzureCognitiveSearchNotFound", + AzureCognitiveSearchIndexNotFound: "AzureCognitiveSearchIndexNotFound", + TooManyRequests: "TooManyRequests", + AzureCognitiveSearchThrottling: "AzureCognitiveSearchThrottling", + AzureCognitiveSearchIndexLimitReached: "AzureCognitiveSearchIndexLimitReached", + InternalServerError: "InternalServerError", + ServiceUnavailable: "ServiceUnavailable", + Timeout: "Timeout", + QuotaExceeded: "QuotaExceeded", + Conflict: "Conflict", + Warning: "Warning", +} + +/** + * Human-readable error code. + */ +#suppress "@azure-tools/typespec-azure-core/documentation-required" +union InnerErrorCode { + string, + InvalidRequest: "InvalidRequest", + InvalidParameterValue: "InvalidParameterValue", + KnowledgeBaseNotFound: "KnowledgeBaseNotFound", + AzureCognitiveSearchNotFound: "AzureCognitiveSearchNotFound", + AzureCognitiveSearchThrottling: "AzureCognitiveSearchThrottling", + ExtractionFailure: "ExtractionFailure", + InvalidRequestBodyFormat: "InvalidRequestBodyFormat", + EmptyRequest: "EmptyRequest", + MissingInputDocuments: "MissingInputDocuments", + InvalidDocument: "InvalidDocument", + ModelVersionIncorrect: "ModelVersionIncorrect", + InvalidDocumentBatch: "InvalidDocumentBatch", + UnsupportedLanguageCode: "UnsupportedLanguageCode", + InvalidCountryHint: "InvalidCountryHint", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" +union ExportedProjectFormat { + string, + + /** + * Specifies the format for a conversational project. + */ + Conversation: "Conversation", + + /** + * Specifies the format for an application that was exported from LUIS. + */ + Luis: "Luis", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" +@clientName("StringIndexType", "csharp") +union StringIndexType { + string, + + /** + * The 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. + */ + Utf16CodeUnit: "Utf16CodeUnit", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" +union TrainingMode { + string, + + /** + * Trains using fine-tuned neural network transformer models. Can train + * multilingual projects. + */ + advanced: "advanced", + + /** + * Faster training times for quicker iterations. + */ + standard: "standard", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" +union EvaluationKind { + string, + + /** + * Split the data into training and test sets according to user-defined + * percentages. + */ + percentage: "percentage", + + /** + * Split the data according to the chosen dataset for every example in the data. + */ + manual: "manual", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" +@lroStatus +union JobStatus { + string, + notStarted: "notStarted", + running: "running", + + @lroSucceeded + succeeded: "succeeded", + + @lroFailed + failed: "failed", + + @lroCanceled + cancelled: "cancelled", + + cancelling: "cancelling", + partiallyCompleted: "partiallyCompleted", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" +union CompositionSetting { + string, + + /** + * When two or more components are found in the text and overlap, the component + * with the longest set of characters is returned. + */ + returnLongestOverlap: "returnLongestOverlap", + + /** + * All components must overlap at the exact same characters in the text for the + * entity to return. If one of the defined components is not matched or predicted, + * the entity will not return. + */ + requireExactOverlap: "requireExactOverlap", + + /** + * Every component's match or prediction is returned as a separate instance of the + * entity. + */ + separateComponents: "separateComponents", + + /** + * When two or more components are found in the text and overlap, the components' + * spans are merged together into one span combining all of them. + */ + combineComponents: "combineComponents", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" +@clientName("OrchestrationTargetProjectKind", "csharp") +union OrchestrationTargetProjectKind { + string, + Luis: "Luis", + Conversation: "Conversation", + QuestionAnswering: "QuestionAnswering", +} + +/** + * Represents a list of retrieved projects' metadata. + */ +@clientName("ProjectsMetadata", "csharp") +model ConversationalAnalysisAuthoringProjectsMetadata { + /** + * The list of projects. + */ + value: ConversationalAnalysisAuthoringProjectMetadata[]; + + /** + * The next page link. + */ + nextLink?: string; +} + +/** + * Represents the metadata of a project. + */ +@resource("authoring/analyze-conversations/projects") +@clientName("ProjectMetadata", "csharp") +model ConversationalAnalysisAuthoringProjectMetadata { + /** + * Represents the project creation datetime. + */ + createdDateTime: utcDateTime; + + /** + * Represents the project creation datetime. + */ + lastModifiedDateTime: utcDateTime; + + /** + * Represents the project last trained datetime. + */ + lastTrainedDateTime?: utcDateTime; + + /** + * Represents the project last deployed datetime. + */ + lastDeployedDateTime?: utcDateTime; + + /** + * Represents the project kind. + */ + @visibility("create", "read") + projectKind: ProjectKind; + + /** + * The project settings. + */ + @visibility("create", "read") + settings?: ConversationalAnalysisAuthoringProjectSettings; + + /** + * The storage container name in case of conversation summarization. + */ + @visibility("create", "read") + @added(Versions.v2023_04_15_preview) + storageInputContainerName?: string; + + /** + * The new project name. + */ + @key("projectName") + @visibility("create", "read") + @maxLength(100) + projectName: string; + + /** + * Whether the project would be used for multiple languages or not. + */ + @visibility("create", "read") + multilingual?: boolean; + + /** + * The project description. + */ + @visibility("create", "read") + description?: string; + + /** + * The project language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. + */ + @visibility("create", "read") + language: string; +} + +/** + * Represents the settings used to define the project behavior. + */ +@clientName("ProjectSettings", "csharp") +model ConversationalAnalysisAuthoringProjectSettings { + /** + * The threshold of the intent with the highest confidence, at which the prediction will automatically be changed to "None". The value of the threshold should be between 0 and 1 inclusive. + */ + confidenceThreshold: float32; +} + +/** + * Error response. + */ +@error +model ErrorResponse { + /** + * The error object. + */ + error: Error; +} + +/** + * The error object. + */ +model Error { + /** + * One of a server-defined set of error codes. + */ + code: ErrorCode; + + /** + * A human-readable representation of the error. + */ + message: string; + + /** + * The target of the error. + */ + target?: string; + + /** + * An array of details about specific errors that led to this reported error. + */ + details?: Error[]; + + /** + * An object containing more specific information than the current object about + * the error. + */ + innererror?: InnerErrorModel; +} + +/** + * 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. + */ +model InnerErrorModel { + /** + * One of a server-defined set of error codes. + */ + code: InnerErrorCode; + + /** + * Error message. + */ + message: string; + + /** + * Error details. + */ + details?: Record<string>; + + /** + * Error target. + */ + target?: string; + + /** + * An object containing more specific information than the current object about + * the error. + */ + innererror?: InnerErrorModel; +} + +/** + * Represents the options used to create or update a project. + */ +@clientName("CreateProjectOptions", "csharp") +model ConversationalAnalysisAuthoringCreateProjectOptions { + /** + * Represents the project kind. + */ + projectKind: ProjectKind; + + /** + * The project settings. + */ + settings?: ConversationalAnalysisAuthoringProjectSettings; + + /** + * The storage container name in case of conversation summarization. + */ + @added(Versions.v2023_04_15_preview) + storageInputContainerName?: string; + + /** + * The new project name. + */ + projectName: string; + + /** + * Whether the project would be used for multiple languages or not. + */ + multilingual?: boolean; + + /** + * The project description. + */ + description?: string; + + /** + * The project language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. + */ + language: string; +} + +/** + * Represents the options for authorizing a project copy to the current Azure resource. + */ +@added(Versions.v2023_04_15_preview) +@clientName("CopyAuthorizationOptions", "csharp") +model ConversationalAnalysisAuthoringCopyAuthorizationOptions { + /** + * Represents the project kind. + */ + projectKind: ProjectKind; + + /** + * The name of the storage container. + */ + storageInputContainerName?: string; + + /** + * Whether to allow an existing project to be overwritten using the resulting copy authorization. + */ + allowOverwrite?: boolean; +} + +/** + * Represents the options for copying an existing project to another Azure + * resource. + */ +@added(Versions.v2023_04_15_preview) +@clientName("CopyProjectOptions", "csharp") +model ConversationalAnalysisAuthoringCopyProjectOptions { + /** + * Represents the project kind. + */ + projectKind: ProjectKind; + + /** + * The project name to be copied-into. + */ + targetProjectName: string; + + /** + * The access token. + */ + accessToken: string; + + /** + * The expiration of the access token. + */ + expiresAt: utcDateTime; + + /** + * Represents the target Azure resource ID. + */ + targetResourceId: string; + + /** + * Represents the target Azure resource region. + */ + targetResourceRegion: string; +} + +/** + * Represents an exported project. + */ +@clientName("ExportedProject", "csharp") +model ConversationalAnalysisAuthoringExportedProject { + /** + * The version of the exported file. + */ + projectFileVersion: string; + + /** + * Specifies the method used to interpret string offsets. For additional + * information see https://aka.ms/text-analytics-offsets. + */ + stringIndexType: StringIndexType; + + /** + * Represents the project metadata. + */ + metadata: ConversationalAnalysisAuthoringCreateProjectOptions; + + /** + * Represents the project assets. + */ + assets?: ConversationalAnalysisAuthoringExportedProjectAssets; +} + +/** + * Represents the assets of an exported project. + */ +@discriminator("projectKind") +@clientName("ExportedProjectAssets", "csharp") +model ConversationalAnalysisAuthoringExportedProjectAssets { + /** + * The type of project containing the assets. + */ + projectKind: ProjectKind; +} + +/** + * Represents the options for starting a new training job. + */ +@clientName("TrainingJobOptions", "csharp") +model ConversationalAnalysisAuthoringTrainingJobOptions { + /** + * Represents the output model label. + */ + modelLabel: string; + + /** + * Represents training config version. By default, "latest" value is used which + * uses the latest released training config version. + */ + trainingConfigVersion?: string; + + /** + * Represents the mode of the training operation. + */ + trainingMode: TrainingMode; + + /** + * Represents the evaluation options. By default, the evaluation kind is + * percentage, with training split percentage as 80, and testing split percentage + * as 20. + */ + evaluationOptions?: ConversationalAnalysisAuthoringEvaluationOptions; +} + +/** + * Represents the options used running the evaluation. + */ +@clientName("EvaluationOptions", "csharp") +model ConversationalAnalysisAuthoringEvaluationOptions { + /** + * Represents the evaluation kind. By default, the evaluation kind is set to + * percentage. + */ + kind?: EvaluationKind; + + /** + * Represents the training dataset split percentage. Only needed in case the + * evaluation kind is percentage. + */ + trainingSplitPercentage?: int32; + + /** + * Represents the testing dataset split percentage. Only needed in case the + * evaluation kind is percentage. + */ + testingSplitPercentage?: int32; +} + +/** + * Represents the state of a copy job. + */ +@added(Versions.v2023_04_15_preview) +@clientName("CopyProjectJobState", "csharp") +@resource("copy/jobs") +@parentResource(ConversationalAnalysisAuthoringProjectMetadata) +model ConversationalAnalysisAuthoringCopyProjectJobState { + ...ConversationalAnalysisAuthoringJobState; +} + +/** + * Represents a job's state. + */ +@clientName("JobState", "csharp") +model ConversationalAnalysisAuthoringJobState { + /** + * The job ID. + */ + @key("jobId") + @visibility + jobId: string; + + /** + * The creation date time of the job. + */ + createdDateTime: utcDateTime; + + /** + * The last date time the job was updated. + */ + lastUpdatedDateTime: utcDateTime; + + /** + * The expiration date time of the job. + */ + expirationDateTime?: utcDateTime; + + /** + * The job status. + */ + status: JobStatus; + + /** + * The warnings that were encountered while executing the job. + */ + warnings?: Warning[]; + + /** + * The errors encountered while executing the job. + */ + errors?: Error[]; +} + +/** + * Represents a warning that was encountered while executing the request. + */ +model Warning { + /** + * The warning code. + */ + code: string; + + /** + * The warning message. + */ + message: string; +} + +/** + * Represents a list of retrieved deployments. + */ +@clientName("ProjectDeployments", "csharp") +model ConversationalAnalysisAuthoringProjectDeployments { + /** + * The list of retrieved deployments. + */ + value: ConversationalAnalysisAuthoringProjectDeployment[]; + + /** + * The next page link. + */ + nextLink?: string; +} + +/** + * Represents a project deployment. + */ +@clientName("ProjectDeployment", "csharp") +@resource("deployments") +@parentResource(ConversationalAnalysisAuthoringProjectMetadata) +model ConversationalAnalysisAuthoringProjectDeployment { + /** + * Represents deployment name. + */ + @key("deploymentName") + @visibility + deploymentName: string; + + /** + * Represents deployment modelId. + */ + modelId: string; + + /** + * Represents deployment last trained time. + */ + lastTrainedDateTime: utcDateTime; + + /** + * Represents deployment last deployed time. + */ + lastDeployedDateTime: utcDateTime; + + /** + * Represents deployment expiration date in the runtime. + */ + deploymentExpirationDate: plainDate; + + /** + * Represents model training config version. + */ + modelTrainingConfigVersion: string; + + /** + * Represents the metadata of the assigned Azure resources. + */ + @added(Versions.v2023_04_15_preview) + assignedResources: ConversationalAnalysisAuthoringDeploymentResource[]; +} + +/** + * Represents an Azure resource assigned to a deployment. + */ +@clientName("DeploymentResource", "csharp") +model ConversationalAnalysisAuthoringDeploymentResource { + /** + * Represents the Azure resource Id. + */ + resourceId: string; + + /** + * Represents the resource region. + */ + region: string; +} + +/** + * Represents the options for creating or updating a project deployment. + */ +@clientName("CreateDeploymentOptions", "csharp") +model ConversationalAnalysisAuthoringCreateDeploymentOptions { + /** + * Represents the trained model label. + */ + trainedModelLabel: string; + + /** + * Represents the resource IDs to be assigned to the deployment. + * If provided, the deployment will be rolled out to the resources + * provided here as well as the original resource in which the project is created. + */ + @added(Versions.v2023_04_15_preview) + assignedResourceIds?: string[]; +} + +/** + * Represents the options for deleting a project deployment. + */ +@clientName("DeleteDeploymentOptions", "csharp") +model ConversationalAnalysisAuthoringDeleteDeploymentOptions { + /** + * Represents the resource IDs to delete the deployment from. + * If not provided, the deployment will be rolled out from all the + * resources it is deployed to. + * If provided, it will delete the deployment only from the specified + * assigned resources, and leave it for the rest. + */ + assignedResourceIds?: string[]; +} + +/** + * Represents the state of a deployment job. + */ +@clientName("DeploymentJobState", "csharp") +@parentResource(ConversationalAnalysisAuthoringProjectDeployment) +@resource("jobs") +model ConversationalAnalysisAuthoringDeploymentJobState { + ...ConversationalAnalysisAuthoringJobState; +} + +/** + * Represents the state of an existing delete deployment from specific resources job. + */ +@clientName("DeploymentDeleteFromResourcesJobState", "csharp") +@parentResource(ConversationalAnalysisAuthoringProjectDeployment) +@resource("delete-from-resources/jobs") +model ConversationalAnalysisAuthoringDeploymentDeleteFromResourcesJobState { + ...ConversationalAnalysisAuthoringJobState; +} + +/** + * Represents the state of a deployment job. + */ +@clientName("SwapDeploymentsJobState", "csharp") +@parentResource(ConversationalAnalysisAuthoringProjectMetadata) +@resource("deployments/swap/jobs") +model ConversationalAnalysisAuthoringSwapDeploymentsJobState { + ...ConversationalAnalysisAuthoringJobState; +} + +/** + * Represents the options for swapping two deployments together. + */ +@clientName("SwapDeploymentsOptions", "csharp") +model ConversationalAnalysisAuthoringSwapDeploymentsOptions { + /** + * Represents the first deployment name. + */ + firstDeploymentName: string; + + /** + * Represents the second deployment name. + */ + secondDeploymentName: string; +} + +/** + * Represents the state of an export job. + */ +@clientName("ExportProjectJobState", "csharp") +@resource("export/jobs") +@parentResource(ConversationalAnalysisAuthoringProjectMetadata) +model ConversationalAnalysisAuthoringExportProjectJobState { + ...ConversationalAnalysisAuthoringJobState; + + /** + * The URL to use in order to download the exported project. + */ + resultUrl?: string; +} + +/** + * Represents the state of an import job. + */ +@clientName("ImportProjectJobState", "csharp") +@resource("import/jobs") +@parentResource(ConversationalAnalysisAuthoringProjectMetadata) +model ConversationalAnalysisAuthoringImportProjectJobState { + ...ConversationalAnalysisAuthoringJobState; +} + +/** + * Represents a list of retrieved trained models. + */ +@clientName("ProjectTrainedModels", "csharp") +model ConversationalAnalysisAuthoringProjectTrainedModels { + /** + * The list of trained models. + */ + value: ConversationalAnalysisAuthoringProjectTrainedModel[]; + + /** + * The next page link. + */ + nextLink?: string; +} + +/** + * Represents a trained model. + */ +@clientName("ProjectTrainedModel", "csharp") +@resource("models") +@parentResource(ConversationalAnalysisAuthoringProjectMetadata) +model ConversationalAnalysisAuthoringProjectTrainedModel { + /** + * The trained model label. + */ + @key("trainedModelLabel") + @visibility + label: string; + + /** + * The model ID. + */ + modelId: string; + + /** + * The last trained date time of the model. + */ + lastTrainedDateTime: utcDateTime; + + /** + * The duration of the model's last training request in seconds. + */ + lastTrainingDurationInSeconds: int32; + + /** + * The model expiration date. + */ + modelExpirationDate: plainDate; + + /** + * The model training config version. + */ + modelTrainingConfigVersion: string; + + /** + * The flag to indicate if the trained model has a snapshot ready. + */ + hasSnapshot: boolean; +} + +/** + * Represents the state of a evaluation job. + */ +@clientName("EvaluationJobState", "csharp") +@resource("evaluate/jobs") +@parentResource(ConversationalAnalysisAuthoringProjectTrainedModel) +model ConversationalAnalysisAuthoringEvaluationJobState { + ...ConversationalAnalysisAuthoringJobState; + + /** + * Represents evaluation task detailed result. + */ + result: ConversationalAnalysisAuthoringEvaluationJobResult; +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" +@clientName("EvaluationJobResult", "csharp") +model ConversationalAnalysisAuthoringEvaluationJobResult { + /** + * Represents the options used running the evaluation. + */ + evaluationOptions: ConversationalAnalysisAuthoringEvaluationOptions; + + /** + * Represents trained model label. + */ + modelLabel: string; + + /** + * Represents training config version. + */ + trainingConfigVersion: string; + + /** + * Represents progress percentage. + */ + percentComplete: int32; +} + +/** + * Represent a list of utterances' evaluation results. + */ +@clientName("EvaluationResults", "csharp") +model ConversationalAnalysisAuthoringEvaluationResults { + /** + * The utterances evaluation results. + */ + value: ConversationalAnalysisAuthoringUtteranceEvaluationResult[]; + + /** + * The next page link. + */ + nextLink: string; +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" +model StringIndexTypeQueryParameter { + /** + * Specifies the method used to interpret string offsets. For additional + * information see https://aka.ms/text-analytics-offsets. + */ + @query("stringIndexType") + stringIndexType: StringIndexType; +} + +/** + * Represents the evaluation result for an utterance. + */ +@clientName("UtteranceEvaluationResult", "csharp") +@resource("evaluation/result") +@parentResource(ConversationalAnalysisAuthoringProjectTrainedModel) +model ConversationalAnalysisAuthoringUtteranceEvaluationResult { + /** + * Represents the utterance text. + */ + @key + @visibility + text: string; + + /** + * Represents the utterance language. This is BCP-47 representation of a language. + * For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish + * etc. + */ + language: string; + + /** + * Represents the entities results for the utterance. + */ + entitiesResult: ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult; + + /** + * Represents the intents results for the utterance. + */ + intentsResult: ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult; +} + +/** + * Represents the comparison between the expected and predicted entities for an + * utterance. + */ +@clientName("UtteranceEntitiesEvaluationResult", "csharp") +model ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult { + /** + * Represents the expected entity labels. + */ + expectedEntities: ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult[]; + + /** + * Represents the predicted entity labels. + */ + predictedEntities: ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult[]; +} + +/** + * Represents the evaluation output of an entity label or prediction. + */ +@clientName("UtteranceEntityEvaluationResult", "csharp") +model ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult { + /** + * Represents the entity category. + */ + category: string; + + /** + * Represents the entity offset index relative to the original text. + */ + offset: int32; + + /** + * Represents the entity length. + */ + length: int32; +} + +/** + * Represents the comparison between the expected and the predicted intent for an + * utterance. + */ +@clientName("UtteranceIntentsEvaluationResult", "csharp") +model ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult { + /** + * Represents the utterance's expected intent. + */ + expectedIntent: string; + + /** + * Represents the utterance's predicted intent. + */ + predictedIntent: string; +} + +/** + * Represents the evaluation result summary. + */ +@clientName("EvaluationSummary", "csharp") +model ConversationalAnalysisAuthoringEvaluationSummary { + /** + * Contains the data related to entities evaluation. + */ + entitiesEvaluation: ConversationalAnalysisAuthoringEntitiesEvaluationSummary; + + /** + * Contains the data related to intents evaluation. + */ + intentsEvaluation: ConversationalAnalysisAuthoringIntentsEvaluationSummary; + + /** + * The options that were used while running the evaluation. + */ + evaluationOptions?: ConversationalAnalysisAuthoringEvaluationOptions; +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" +@clientName("ConfusionMatrix", "csharp") +model ConversationalAnalysisAuthoringConfusionMatrix + is Record<ConversationalAnalysisAuthoringConfusionMatrixRow>; + +#suppress "@azure-tools/typespec-azure-core/documentation-required" +@clientName("ConfusionMatrixRow", "csharp") +model ConversationalAnalysisAuthoringConfusionMatrixRow + is Record<ConversationalAnalysisAuthoringConfusionMatrixCell>; + +/** + * Represents the evaluation result summary for the project's entities. + */ +@clientName("EntitiesEvaluationSummary", "csharp") +model ConversationalAnalysisAuthoringEntitiesEvaluationSummary { + /** + * Represents the confusion matrix between two entities (the two entities can be + * the same). The matrix is between the entity that was labelled and the entity + * that was predicted. + */ + confusionMatrix: ConversationalAnalysisAuthoringConfusionMatrix; + + /** + * Represents the entities evaluation summary. + */ + entities: Record<ConversationalAnalysisAuthoringEntityEvaluationSummary>; + + /** + * Represents the micro F1. Expected value is a float between 0 and 1 inclusive. + */ + microF1: float32; + + /** + * Represents the micro precision. Expected value is a float between 0 and 1 + * inclusive. + */ + microPrecision: float32; + + /** + * Represents the micro recall. Expected value is a float between 0 and 1 + * inclusive. + */ + microRecall: float32; + + /** + * Represents the macro F1. Expected value is a float between 0 and 1 inclusive. + */ + macroF1: float32; + + /** + * Represents the macro precision. Expected value is a float between 0 and 1 + * inclusive. + */ + macroPrecision: float32; + + /** + * Represents the macro recall. Expected value is a float between 0 and 1 + * inclusive. + */ + macroRecall: float32; +} + +/** + * Represents a cell in a confusion matrix. + */ +@clientName("ConfusionMatrixCell", "csharp") +model ConversationalAnalysisAuthoringConfusionMatrixCell { + /** + * Represents normalized value in percentages. + */ + normalizedValue: float32; + + /** + * Represents raw value. + */ + rawValue: float32; +} + +/** + * Represents the evaluation result for an entity. + */ +@clientName("EntityEvaluationSummary", "csharp") +model ConversationalAnalysisAuthoringEntityEvaluationSummary { + /** + * Represents the model precision + */ + f1: float64; + + /** + * Represents the model recall + */ + precision: float64; + + /** + * Represents the model F1 score + */ + recall: float64; + + /** + * Represents the count of true positive + */ + truePositiveCount: int32; + + /** + * Represents the count of true negative + */ + trueNegativeCount: int32; + + /** + * Represents the count of false positive + */ + falsePositiveCount: int32; + + /** + * Represents the count of false negative + */ + falseNegativeCount: int32; +} + +/** + * Represents the evaluation summary for the project's intents. + */ +@clientName("IntentsEvaluationSummary", "csharp") +model ConversationalAnalysisAuthoringIntentsEvaluationSummary { + /** + * Represents the confusion matrix between two intents (the two intents can be the + * same). The matrix is between the intent that was labelled and the intent that + * was predicted. + */ + confusionMatrix: ConversationalAnalysisAuthoringConfusionMatrix; + + /** + * Represents the intents evaluation summary. + */ + intents: Record<ConversationalAnalysisAuthoringIntentEvaluationSummary>; + + /** + * Represents the micro F1. Expected value is a float between 0 and 1 inclusive. + */ + microF1: float32; + + /** + * Represents the micro precision. Expected value is a float between 0 and 1 + * inclusive. + */ + microPrecision: float32; + + /** + * Represents the micro recall. Expected value is a float between 0 and 1 + * inclusive. + */ + microRecall: float32; + + /** + * Represents the macro F1. Expected value is a float between 0 and 1 inclusive. + */ + macroF1: float32; + + /** + * Represents the macro precision. Expected value is a float between 0 and 1 + * inclusive. + */ + macroPrecision: float32; + + /** + * Represents the macro recall. Expected value is a float between 0 and 1 + * inclusive. + */ + macroRecall: float32; +} + +/** + * The evaluation summary for an intent. + */ +@clientName("IntentEvaluationSummary", "csharp") +model ConversationalAnalysisAuthoringIntentEvaluationSummary { + /** + * Represents the model precision + */ + f1: float64; + + /** + * Represents the model recall + */ + precision: float64; + + /** + * Represents the model F1 score + */ + recall: float64; + + /** + * Represents the count of true positive + */ + truePositiveCount: int32; + + /** + * Represents the count of true negative + */ + trueNegativeCount: int32; + + /** + * Represents the count of false positive + */ + falsePositiveCount: int32; + + /** + * Represents the count of false negative + */ + falseNegativeCount: int32; +} + +/** + * Represents the state of loading a snapshot job. + */ +@clientName("LoadSnapshotJobState", "csharp") +@resource("load-snapshot/jobs") +@parentResource(ConversationalAnalysisAuthoringProjectTrainedModel) +model ConversationalAnalysisAuthoringLoadSnapshotJobState { + ...ConversationalAnalysisAuthoringJobState; +} + +/** + * Represents the assigned deployment resources. + */ +@added(Versions.v2023_04_15_preview) +@clientName("AssignedDeploymentResources", "csharp") +model ConversationalAnalysisAuthoringAssignedDeploymentResources { + /** + * The list of assigned deployment resources. + */ + value: ConversationalAnalysisAuthoringAssignedDeploymentResource[]; + + /** + * The next page link. + */ + nextLink?: string; +} + +/** + * Represents the assigned deployment resource. + */ +@added(Versions.v2023_04_15_preview) +@clientName("AssignedDeploymentResource", "csharp") +@resource("resources") +@parentResource(ConversationalAnalysisAuthoringProjectMetadata) +model ConversationalAnalysisAuthoringAssignedDeploymentResource { + /** + * The resource ID. + */ + @key + @visibility + azureResourceId: string; + + /** + * The resource region. + */ + region: string; +} + +/** + * Represents the options for assigning Azure resources to a project. + */ +@added(Versions.v2023_04_15_preview) +@clientName("AssignDeploymentResourcesOptions", "csharp") +model ConversationalAnalysisAuthoringAssignDeploymentResourcesOptions { + /** + * Represents the metadata for the resources to be assigned. + */ + resourcesMetadata: ConversationalAnalysisAuthoringResourceMetadata[]; +} + +/** + * Represents metadata for the Azure resource.. + */ +@clientName("ResourceMetadata", "csharp") +model ConversationalAnalysisAuthoringResourceMetadata { + /** + * Represents the Azure resource ID. + */ + azureResourceId: string; + + /** + * Represents the Azure resource custom domain. + */ + customDomain: string; + + /** + * Represents the Azure resource region. + */ + region: string; +} + +/** + * Represents the options to unassign Azure resources from a project. + */ +@added(Versions.v2023_04_15_preview) +@clientName("UnassignDeploymentResourcesOptions", "csharp") +model ConversationalAnalysisAuthoringUnassignDeploymentResourcesOptions { + /** + * Represents the assigned resource IDs to be unassigned. + */ + assignedResourceIds: string[]; +} + +/** + * Represents the state of a deployment resources job. + */ +@added(Versions.v2023_04_15_preview) +@clientName("DeploymentResourcesJobState", "csharp") +@resource("resources/assign/jobs") +@parentResource(ConversationalAnalysisAuthoringProjectMetadata) +model ConversationalAnalysisAuthoringDeploymentResourcesJobState { + ...ConversationalAnalysisAuthoringJobState; +} + +/** + * Represents a list of retrieved training jobs. + */ +@clientName("TrainingJobs", "csharp") +model ConversationalAnalysisAuthoringTrainingJobs { + /** + * The list of jobs. + */ + value: ConversationalAnalysisAuthoringTrainingJobState[]; + + /** + * The next page link. + */ + nextLink?: string; +} + +/** + * Represents the state of a training job. + */ +@clientName("TrainingJobState", "csharp") +@resource("train/jobs") +@parentResource(ConversationalAnalysisAuthoringProjectMetadata) +model ConversationalAnalysisAuthoringTrainingJobState { + ...ConversationalAnalysisAuthoringJobState; + + /** + * Represents training tasks detailed result. + */ + result: ConversationalAnalysisAuthoringTrainingJobResult; +} + +/** + * Represents the output of a training job. + */ +@clientName("TrainingJobResult", "csharp") +model ConversationalAnalysisAuthoringTrainingJobResult { + /** + * Represents trained model label. + */ + modelLabel: string; + + /** + * Represents training config version. + */ + trainingConfigVersion: string; + + /** + * Represents the mode of the training operation. + */ + trainingMode?: TrainingMode; + + /** + * Represents the model training status. + */ + trainingStatus: ConversationalAnalysisAuthoringSubTrainingJobState; + + /** + * Represents model evaluation status. + */ + evaluationStatus?: ConversationalAnalysisAuthoringSubTrainingJobState; + + /** + * Represents the estimated end date time for training and evaluation. + */ + estimatedEndDateTime?: utcDateTime; +} + +/** + * Represents the detailed state of a training sub-operation. + */ +@clientName("SubTrainingJobState", "csharp") +model ConversationalAnalysisAuthoringSubTrainingJobState { + /** + * Represents progress percentage. + */ + percentComplete: int32; + + /** + * Represents the start date time. + */ + startDateTime?: utcDateTime; + + /** + * Represents the end date time. + */ + endDateTime?: utcDateTime; + + /** + * Represents the status of the sub-operation. + */ + status: JobStatus; +} + +/** + * Represents the state of a project deletion job. + */ +@clientName("ProjectDeletionJobState", "csharp") +model ConversationalAnalysisAuthoringProjectDeletionJobState { + ...ConversationalAnalysisAuthoringJobState; +} + +/** + * Represents the metadata for deployments assigned to a resource. + */ +@added(Versions.v2023_04_15_preview) +@clientName("AssignedResourceDeploymentsMetadata", "csharp") +model ConversationalAnalysisAuthoringAssignedResourceDeploymentsMetadata { + /** + * The list of retrieved assigned project deployments. + */ + value: ConversationalAnalysisAuthoringAssignedProjectDeploymentsMetadata[]; + + /** + * The next page link. + */ + nextLink?: string; +} + +/** + * Represents the metadata for assigned deployments for a project. + */ +@added(Versions.v2023_04_15_preview) +@clientName("AssignedProjectDeploymentsMetadata", "csharp") +model ConversationalAnalysisAuthoringAssignedProjectDeploymentsMetadata { + /** + * Represents the project name. + */ + projectName: string; + + /** + * Represents the resource region. + */ + deploymentsMetadata: ConversationalAnalysisAuthoringAssignedProjectDeploymentMetadata[]; +} + +/** + * Represents the metadata for an assigned deployment + */ +@added(Versions.v2023_04_15_preview) +@clientName("AssignedProjectDeploymentMetadata", "csharp") +model ConversationalAnalysisAuthoringAssignedProjectDeploymentMetadata { + /** + * Represents the deployment name. + */ + deploymentName: string; + + /** + * Represents deployment last deployed time. + */ + lastDeployedDateTime: utcDateTime; + + /** + * Represents deployment expiration date in the runtime. + */ + deploymentExpirationDate: plainDate; +} + +/** + * Represents a list of retrieved languages. + */ +@clientName("SupportedLanguages", "csharp") +model ConversationalAnalysisAuthoringSupportedLanguages { + /** + * The list of the languages. + */ + value: ConversationalAnalysisAuthoringSupportedLanguage[]; + + /** + * The next page link. + */ + nextLink?: string; +} +/** + * Represents a supported language. + */ +@clientName("SupportedLanguage", "csharp") +model ConversationalAnalysisAuthoringSupportedLanguage { + /** + * The language name. + */ + languageName: string; + + /** + * The language code. This is BCP-47 representation of a language. For example, + * "en" for English, "en-gb" for English (UK), "es" for Spanish etc. + */ + languageCode: string; +} + +/** + * Represents a list of the retrieved supported prebuilt entities. + */ +@clientName("PrebuiltEntities", "csharp") +model ConversationalAnalysisAuthoringPrebuiltEntities { + /** + * The supported prebuilt entities. + */ + value: ConversationalAnalysisAuthoringPrebuiltEntity[]; + + /** + * The next page link. + */ + nextLink?: string; +} + +/** + * Represents a supported prebuilt entity. + */ +@clientName("PrebuiltEntity", "csharp") +model ConversationalAnalysisAuthoringPrebuiltEntity { + /** + * The prebuilt entity category. + */ + category: string; + + /** + * The description. + */ + description: string; + + /** + * English examples for the entity. + */ + examples: string; +} + +/** + * Represents a list of training config versions. + */ +@clientName("TrainingConfigVersions", "csharp") +model ConversationalAnalysisAuthoringTrainingConfigVersions { + /** + * The list of the training config versions. + */ + value: ConversationalAnalysisAuthoringTrainingConfigVersion[]; + + /** + * The next page link. + */ + nextLink?: string; +} + +/** + * Represents a training config version. + */ +@clientName("TrainingConfigVersion", "csharp") +model ConversationalAnalysisAuthoringTrainingConfigVersion { + /** + * Represents the version of the config. + */ + trainingConfigVersion: string; + + /** + * Represents the training config version expiration date. + */ + modelExpirationDate: plainDate; +} + +/** + * Represents an entity with its components. + */ +@clientName("ConversationExportedEntity", "csharp") +model ConversationalAnalysisAuthoringConversationExportedEntity { + /** + * The category of the entity. + */ + category: string; + + /** + * The behavior to follow when the entity's components overlap with each other. + */ + compositionSetting?: CompositionSetting; + + /** + * The list component of the entity. + */ + list?: ConversationalAnalysisAuthoringExportedEntityList; + + /** + * The prebuilt entities components. + */ + prebuilts?: ConversationalAnalysisAuthoringExportedPrebuiltEntity[]; + + /** + * The regex component of the entity. + */ + regex?: ConversationalAnalysisAuthoringExportedEntityRegex; + + /** + * The required components. Allowed values are 'learned', 'list', 'prebuilts' and 'regex'. + */ + requiredComponents?: string[]; +} + +/** + * Represents a list component of an entity. + */ +@clientName("ExportedEntityList", "csharp") +model ConversationalAnalysisAuthoringExportedEntityList { + /** + * The sub-lists of the list component. + */ + sublists?: ConversationalAnalysisAuthoringExportedEntitySublist[]; +} + +/** + * Represents a sub-list inside a list component. + */ +@clientName("ExportedEntitySublist", "csharp") +model ConversationalAnalysisAuthoringExportedEntitySublist { + /** + * The key of the sub-list. + */ + listKey?: string; + + /** + * The phrases of that correspond to the sub-list. + */ + synonyms?: ConversationalAnalysisAuthoringExportedEntityListSynonym[]; +} + +/** + * Represents a list of synonyms inside a list component + */ +@clientName("ExportedEntityListSynonym", "csharp") +model ConversationalAnalysisAuthoringExportedEntityListSynonym { + /** + * Represents the language of the synonyms. This is BCP-47 representation of a + * language. For example, use "en" for English, "en-gb" for English (UK), "es" for + * Spanish etc. + */ + language?: string; + + /** + * The list of synonyms. + */ + values?: string[]; +} + +/** + * Represents an exported prebuilt entity component + */ +@clientName("ExportedPrebuiltEntity", "csharp") +model ConversationalAnalysisAuthoringExportedPrebuiltEntity { + /** + * The prebuilt entity category. + */ + category: string; +} + +/** + * Represents a regex component of an entity. + */ +@clientName("ExportedEntityRegex", "csharp") +model ConversationalAnalysisAuthoringExportedEntityRegex { + /** + * The regex expressions of the regex component. These expressions follow the .NET + * regex syntax. For reference, check here: + * https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions + */ + expressions?: ConversationalAnalysisAuthoringExportedEntityRegexExpression[]; +} + +/** + * Represents a regex expression inside a regex component. This expression follows + * the .NET regex syntax. For reference, check here: + * https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions + */ +@clientName("ExportedEntityRegexExpression", "csharp") +model ConversationalAnalysisAuthoringExportedEntityRegexExpression { + /** + * The key of the regex expression. + */ + regexKey?: string; + + /** + * Represents the language of the regex expression. This is BCP-47 representation + * of a language. For example, use "en" for English, "en-gb" for English (UK), + * "es" for Spanish etc. + */ + language?: string; + + /** + * The regex pattern. + */ + regexPattern?: string; +} + +/** + * Represents an exported intent of a conversational project. + */ +@clientName("ConversationExportedIntent", "csharp") +model ConversationalAnalysisAuthoringConversationExportedIntent { + /** + * The intent category. + */ + category: string; +} + +/** + * Represents the exported assets of a conversational project. + */ +@clientName("ConversationExportedProjectAssets", "csharp") +model ConversationalAnalysisAuthoringConversationExportedProjectAssets + extends ConversationalAnalysisAuthoringExportedProjectAssets { + /** + * The intents defined in the project. + */ + intents?: ConversationalAnalysisAuthoringConversationExportedIntent[]; + + /** + * The entities defined in the project. + */ + entities?: ConversationalAnalysisAuthoringConversationExportedEntity[]; + + /** + * The utterances defined in the project. + */ + utterances?: ConversationalAnalysisAuthoringConversationExportedUtterance[]; + + /** + * The type of project containing the assets. + */ + projectKind: "Conversation"; +} + +/** + * Represents an exported utterance for a conversational project. + */ +@clientName("ConversationExportedUtterance", "csharp") +model ConversationalAnalysisAuthoringConversationExportedUtterance { + /** + * Represents the entity labels of the utterance. + */ + entities?: ConversationalAnalysisAuthoringExportedUtteranceEntityLabel[]; + + /** + * The utterance text. + */ + text: string; + + /** + * Represents the utterance's language. This is BCP-47 representation of a + * language. For example, use "en" for English, "en-gb" for English (UK), "es" for + * Spanish etc. + */ + language?: string; + + /** + * The intent of the utterance. + */ + intent: string; + + /** + * The dataset for this utterance. Allowed values are 'Train' and 'Test'. + */ + dataset?: string; +} + +/** + * Represents an entity label for an utterance. + */ +@clientName("ExportedUtteranceEntityLabel", "csharp") +model ConversationalAnalysisAuthoringExportedUtteranceEntityLabel { + /** + * The category of the entity label. + */ + category: string; + + /** + * Start position for the entity text. + */ + offset: int32; + + /** + * Length for the entity text. + */ + length: int32; +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" +@clientName("ConversationSummarizationExportedProjectAssets", "csharp") +model ConversationalAnalysisAuthoringConversationSummarizationExportedProjectAssets { + /** + * Represents the conversations of the project. + */ + conversations?: ConversationalAnalysisAuthoringCustomConversationSummarizationConversation[]; +} + +/** + * Represents an exported conversation for a custom conversation summarization. + */ +#suppress "@azure-tools/typespec-azure-core/documentation-required" +@clientName("CustomConversationSummarizationConversation", "csharp") +model ConversationalAnalysisAuthoringCustomConversationSummarizationConversation { + summaryLocation?: string; + + /** + * Represents the conversation file location in the blob store container + * associated with the project. + */ + location: string; + + /** + * Represents the language. This is BCP-47 representation of a language. For + * example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. + */ + language?: string; + + /** + * The dataset for this conversation. Allowed values are 'Train' and 'Test'. + */ + dataset?: string; +} + +/** + * Defines the orchestration details for a Conversational project target. + */ +@clientName("ExportedConversationOrchestration", "csharp") +model ConversationalAnalysisAuthoringExportedConversationOrchestration { + /** + * The name of the targeted project. + */ + projectName: string; + + /** + * The name of the targeted deployment. + */ + deploymentName: string; +} + +/** + * Represents the orchestration options for a Conversational project target. + */ +@clientName("ExportedConversationOrchestrationOptions", "csharp") +model ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions + extends ConversationalAnalysisAuthoringExportedOrchestrationOptions { + /** + * The Conversational project target details. + */ + conversationOrchestration: ConversationalAnalysisAuthoringExportedConversationOrchestration; + + /** + * The kind of the target used in the orchestration flow. + */ + targetProjectKind: "Conversation"; +} + +/** + * Represents the options used to define the orchestration behavior of an intent. + */ +@discriminator("targetProjectKind") +@clientName("ExportedOrchestrationOptions", "csharp") +model ConversationalAnalysisAuthoringExportedOrchestrationOptions { + targetProjectKind: OrchestrationTargetProjectKind; +} + +/** + * Defines the orchestration details for a LUIS application target. + */ +@clientName("ExportedLuisOrchestration", "csharp") +model ConversationalAnalysisAuthoringExportedLuisOrchestration { + /** + * The LUIS application ID. + */ + appId: uuid; + + /** + * The targeted version Id. + */ + appVersion?: string; + + /** + * The targeted slot name. + */ + slotName?: string; +} + +/** + * Represents the orchestration options for a LUIS application target. + */ +@clientName("ExportedLuisOrchestrationOptions", "csharp") +model ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions + extends ConversationalAnalysisAuthoringExportedOrchestrationOptions { + /** + * The LUIS application target details. + */ + luisOrchestration: ConversationalAnalysisAuthoringExportedLuisOrchestration; + + /** + * The kind of the target used in the orchestration flow. + */ + targetProjectKind: "Luis"; +} + +/** + * Defines the orchestration details for a Question Answering project target. + */ +@clientName("ExportedQuestionAnsweringOrchestration", "csharp") +model ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration { + /** + * The name of the target project. + */ + projectName: string; +} + +/** + * Represents the orchestration options for a Question Answering project target. + */ +@clientName("ExportedQuestionAnsweringOrchestrationOptions", "csharp") +model ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions + extends ConversationalAnalysisAuthoringExportedOrchestrationOptions { + /** + * The Question Answering project details. + */ + questionAnsweringOrchestration: ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration; + + /** + * The kind of the target used in the orchestration flow. + */ + targetProjectKind: "QuestionAnswering"; +} + +/** + * Represents an exported intent for an orchestration project. + */ +@clientName("OrchestrationExportedIntent", "csharp") +model ConversationalAnalysisAuthoringOrchestrationExportedIntent { + /** + * Specifies the behavior of this intent in the orchestration flow. + */ + orchestration?: ConversationalAnalysisAuthoringExportedOrchestrationOptions; + + /** + * The intent category. + */ + category: string; +} + +/** + * Represents the assets of an orchestration project. + */ +@clientName("OrchestrationExportedProjectAssets", "csharp") +model ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets + extends ConversationalAnalysisAuthoringExportedProjectAssets { + /** + * Represents the intents of the project. + */ + intents?: ConversationalAnalysisAuthoringOrchestrationExportedIntent[]; + + /** + * Represents the utterances of the project. + */ + utterances?: ConversationalAnalysisAuthoringOrchestrationExportedUtterance[]; + + /** + * The type of project containing the assets. + */ + projectKind: "Orchestration"; +} + +/** + * Represents an utterance of an orchestration project. + */ +@clientName("OrchestrationExportedUtterance", "csharp") +model ConversationalAnalysisAuthoringOrchestrationExportedUtterance { + /** + * The utterance text. + */ + text: string; + + /** + * Represents the utterance's language. This is BCP-47 representation of a + * language. For example, use "en" for English, "en-gb" for English (UK), "es" for + * Spanish etc. + */ + language?: string; + + /** + * The intent of the utterance. + */ + intent: string; + + /** + * The dataset for this utterance. Allowed values are 'Train' and 'Test'. + */ + dataset?: string; +} diff --git a/specification/cognitiveservices/Language.AnalyzeConversations-authoring/routes.tsp b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/routes.tsp new file mode 100644 index 000000000000..4c0e4621b32f --- /dev/null +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/routes.tsp @@ -0,0 +1,852 @@ +import "@azure-tools/typespec-azure-core"; +import "@typespec/rest"; +import "./models.tsp"; +import "@typespec/http"; +import "@typespec/versioning"; +import "@azure-tools/typespec-client-generator-core"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.Core; +using Azure.Core.Traits; +using Azure.ClientGenerator.Core; +using TypeSpec.Versioning; + +namespace Language.Authoring.Conversations; + +alias ServiceTraits = NoRepeatableRequests & + NoConditionalRequests & + NoClientRequestId; + +alias languageOperations = ResourceOperations<ServiceTraits, ErrorResponse>; + +interface ConversationalAnalysisAuthoring { + /** + * Lists the existing projects. + */ + listProjects is languageOperations.ResourceList< + ConversationalAnalysisAuthoringProjectMetadata, + ListQueryParametersTrait<StandardListQueryParameters> + >; + + /** + * Gets the details of a project. + */ + getProject is languageOperations.ResourceRead<ConversationalAnalysisAuthoringProjectMetadata>; + + /** + * Creates a new project or updates an existing one. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Need to rename the body" + @createsOrUpdatesResource(ConversationalAnalysisAuthoringProjectMetadata) + @parameterVisibility + @patch + createProject is Foundations.ResourceOperation< + ConversationalAnalysisAuthoringProjectMetadata, + { + @doc("This request has a JSON Merge Patch body.") + @TypeSpec.Http.header("Content-Type") + contentType: "application/merge-patch+json"; + + /** The request body */ + @bodyRoot body: ConversationalAnalysisAuthoringCreateProjectOptions; + }, + Foundations.ResourceCreatedOrOkResponse<ConversationalAnalysisAuthoringProjectMetadata>, + {}, + ErrorResponse + >; + + /** + * Deletes a project. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}") + @delete + @pollingOperation(ConversationalAnalysisAuthoring.getProjectDeletionStatus) + deleteProject is Foundations.LongRunningOperation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + }, + AcceptedResponse, + {}, + ErrorResponse + >; + + /** + * Generates a copy project operation authorization to the current target Azure + * resource. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" + @post + @added(Versions.v2023_04_15_preview) + @actionSeparator("/:") + @action("authorize-copy") + copyProjectAuthorization is languageOperations.ResourceAction< + ConversationalAnalysisAuthoringProjectMetadata, + ConversationalAnalysisAuthoringCopyAuthorizationOptions, + ConversationalAnalysisAuthoringCopyProjectOptions + >; + + /** + * Copies an existing project to another Azure resource. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/:copy") + @post + @pollingOperation(ConversationalAnalysisAuthoring.getCopyProjectStatus) + @added(Versions.v2023_04_15_preview) + copyProject is Foundations.LongRunningOperation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The copy project info. + */ + @body + body: ConversationalAnalysisAuthoringCopyProjectOptions; + }, + AcceptedResponse, + {}, + ErrorResponse + >; + + /** + * Triggers a job to export a project's data. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/:export") + @post + @pollingOperation(ConversationalAnalysisAuthoring.getExportStatus) + export is Foundations.LongRunningOperation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The format of the exported project file to use. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" + @query("format") + ExportedProjectFormat?: ExportedProjectFormat; + + /** + * Specifies the method used to interpret string offsets. For additional + * information see https://aka.ms/text-analytics-offsets. + */ + @query("stringIndexType") + stringIndexType: StringIndexType; + + /** + * Kind of asset to export. + */ + @query("assetKind") + assetKind?: string; + + /** + * Trained model label to export. If the trainedModelLabel is null, the default behavior is to export the current working copy. + */ + @query("trainedModelLabel") + trainedModelLabel?: string; + }, + AcceptedResponse, + {}, + ErrorResponse + >; + + /** + * Triggers a job to import a project. If a project with the same name already + * exists, the data of that project is replaced. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/:import") + @post + @pollingOperation(ConversationalAnalysisAuthoring.getImportStatus) + `import` is Foundations.LongRunningOperation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The format of the exported project file to use. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" + @query("format") + ExportedProjectFormat?: ExportedProjectFormat; + + /** + * The project data to import. + */ + @body + body: ConversationalAnalysisAuthoringExportedProject; + }, + AcceptedResponse, + {}, + ErrorResponse + >; + + /** + * Triggers a training job for a project. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/:train") + @post + @pollingOperation(ConversationalAnalysisAuthoring.getTrainingStatus) + train is Foundations.LongRunningOperation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The training input parameters. + */ + @body + body: ConversationalAnalysisAuthoringTrainingJobOptions; + }, + AcceptedResponse, + {}, + ErrorResponse + >; + + /** + * Gets the status of an existing copy project job. + */ + @added(Versions.v2023_04_15_preview) + getCopyProjectStatus is languageOperations.ResourceRead<ConversationalAnalysisAuthoringCopyProjectJobState>; + + /** + * Lists the deployments belonging to a project. + */ + listDeployments is languageOperations.ResourceList< + ConversationalAnalysisAuthoringProjectDeployment, + ListQueryParametersTrait<StandardListQueryParameters> + >; + + /** + * Swaps two existing deployments with each other. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/deployments/:swap") + @post + @pollingOperation(ConversationalAnalysisAuthoring.getSwapDeploymentsStatus) + swapDeployments is Foundations.LongRunningOperation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The job object to swap two deployments. + */ + @body + body: ConversationalAnalysisAuthoringSwapDeploymentsOptions; + }, + AcceptedResponse, + {}, + ErrorResponse + >; + + /** + * Gets the details of a deployment. + */ + @get + getDeployment is languageOperations.ResourceRead<ConversationalAnalysisAuthoringProjectDeployment>; + + /** + * Creates a new deployment or replaces an existing one. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}") + @put + @pollingOperation(ConversationalAnalysisAuthoring.getDeploymentStatus) + deployProject is Foundations.LongRunningOperation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The name of the specific deployment of the project to use. + */ + @path + deploymentName: string; + + /** + * The new deployment info. + */ + @body + body: ConversationalAnalysisAuthoringCreateDeploymentOptions; + }, + AcceptedResponse, + {}, + ErrorResponse + >; + + /** + * Deletes a project deployment. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}") + @delete + @pollingOperation(ConversationalAnalysisAuthoring.getDeploymentStatus) + deleteDeployment is Foundations.LongRunningOperation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The name of the specific deployment of the project to use. + */ + @path + deploymentName: string; + }, + AcceptedResponse, + {}, + ErrorResponse + >; + + /** + * Deletes a project deployment from the specified assigned resources. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/:delete-from-resources") + @post + @pollingOperation( + ConversationalAnalysisAuthoring.getDeploymentDeleteFromResourcesStatus + ) + @added(Versions.v2023_04_15_preview) + deleteDeploymentFromResources is Foundations.LongRunningOperation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The name of the specific deployment of the project to use. + */ + @path + deploymentName: string; + + /** + * The options for deleting the deployment. + */ + @body + body: ConversationalAnalysisAuthoringDeleteDeploymentOptions; + }, + AcceptedResponse, + {}, + ErrorResponse + >; + + /** + * Gets the status of an existing delete deployment from specific resources job. + */ + @added(Versions.v2023_04_15_preview) + getDeploymentDeleteFromResourcesStatus is languageOperations.ResourceRead<ConversationalAnalysisAuthoringDeploymentDeleteFromResourcesJobState>; + + /** + * Gets the status of an existing deployment job. + */ + getDeploymentStatus is languageOperations.ResourceRead<ConversationalAnalysisAuthoringDeploymentJobState>; + + /** + * Gets the status of an existing swap deployment job. + */ + getSwapDeploymentsStatus is languageOperations.ResourceRead<ConversationalAnalysisAuthoringSwapDeploymentsJobState>; + + /** + * Gets the status of an export job. Once job completes, returns the project + * metadata, and assets. + */ + getExportStatus is languageOperations.ResourceRead<ConversationalAnalysisAuthoringExportProjectJobState>; + + /** + * Gets the status for an import. + */ + getImportStatus is languageOperations.ResourceRead<ConversationalAnalysisAuthoringImportProjectJobState>; + + /** + * Lists the trained models belonging to a project. + */ + listTrainedModels is languageOperations.ResourceList< + ConversationalAnalysisAuthoringProjectTrainedModel, + ListQueryParametersTrait<StandardListQueryParameters> + >; + + /** + * Gets the details of a trained model. + */ + getTrainedModel is languageOperations.ResourceRead<ConversationalAnalysisAuthoringProjectTrainedModel>; + + /** + * Deletes an existing trained model. + */ + deleteTrainedModel is languageOperations.ResourceDelete<ConversationalAnalysisAuthoringProjectTrainedModel>; + + /** + * Triggers evaluation operation on a trained model. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:evaluate") + @post + @pollingOperation(ConversationalAnalysisAuthoring.getEvaluationStatus) + @added(Versions.v2023_04_15_preview) + evaluateModel is Foundations.LongRunningOperation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The trained model label. + */ + @path + trainedModelLabel: string; + + /** + * The training input parameters. + */ + @body + body: ConversationalAnalysisAuthoringEvaluationOptions; + }, + AcceptedResponse, + {}, + ErrorResponse + >; + + /** + * Restores the snapshot of this trained model to be the current working directory + * of the project. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:load-snapshot") + @post + @pollingOperation(ConversationalAnalysisAuthoring.getLoadSnapshotStatus) + loadSnapshot is Foundations.LongRunningOperation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The trained model label. + */ + @path + trainedModelLabel: string; + }, + AcceptedResponse, + {}, + ErrorResponse + >; + + /** + * Gets the status for an evaluation job. + */ + @added(Versions.v2023_04_15_preview) + getEvaluationStatus is languageOperations.ResourceRead<ConversationalAnalysisAuthoringEvaluationJobState>; + + /** + * Gets the detailed results of the evaluation for a trained model. This includes + * the raw inference results for the data included in the evaluation process. + */ + getModelEvaluationResults is languageOperations.ResourceList< + ConversationalAnalysisAuthoringUtteranceEvaluationResult, + ListQueryParametersTrait<StandardListQueryParameters & + StringIndexTypeQueryParameter> + >; + + /** + * Gets the evaluation summary of a trained model. The summary includes high level + * performance measurements of the model e.g., F1, Precision, Recall, etc. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result") + @get + getModelEvaluationSummary is Foundations.Operation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The trained model label. + */ + @path + trainedModelLabel: string; + }, + ConversationalAnalysisAuthoringEvaluationSummary, + {}, + ErrorResponse + >; + + /** + * Gets the status for loading a snapshot. + */ + getLoadSnapshotStatus is languageOperations.ResourceRead<ConversationalAnalysisAuthoringLoadSnapshotJobState>; + + /** + * Lists the deployments resources assigned to the project. + */ + @added(Versions.v2023_04_15_preview) + listDeploymentResources is languageOperations.ResourceList< + ConversationalAnalysisAuthoringAssignedDeploymentResource, + ListQueryParametersTrait<StandardListQueryParameters> + >; + + /** + * Assign new Azure resources to a project to allow deploying new deployments to + * them. This API is available only via AAD authentication and not supported via + * subscription key authentication. For more details about AAD authentication, + * check here: + * https://learn.microsoft.com/en-us/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-azure-active-directory + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/resources/:assign") + @post + @pollingOperation( + ConversationalAnalysisAuthoring.getAssignDeploymentResourcesStatus + ) + @added(Versions.v2023_04_15_preview) + assignDeploymentResources is Foundations.LongRunningOperation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The new project resources info. + */ + @body + body: ConversationalAnalysisAuthoringAssignDeploymentResourcesOptions; + }, + AcceptedResponse, + {}, + ErrorResponse + >; + + /** + * Unassign resources from a project. This disallows deploying new deployments to + * these resources, and deletes existing deployments assigned to them. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/resources/:unassign") + @post + @pollingOperation( + ConversationalAnalysisAuthoring.getUnassignDeploymentResourcesStatus + ) + @added(Versions.v2023_04_15_preview) + unassignDeploymentResources is Foundations.LongRunningOperation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The info for the deployment resources to be deleted. + */ + @body + body: ConversationalAnalysisAuthoringUnassignDeploymentResourcesOptions; + }, + AcceptedResponse, + {}, + ErrorResponse + >; + + /** + * Gets the status of an existing assign deployment resources job. + */ + @added(Versions.v2023_04_15_preview) + getAssignDeploymentResourcesStatus is languageOperations.ResourceRead<ConversationalAnalysisAuthoringDeploymentResourcesJobState>; + + /** + * Gets the status of an existing unassign deployment resources job. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/resources/unassign/jobs/{jobId}") + @get + @added(Versions.v2023_04_15_preview) + getUnassignDeploymentResourcesStatus is Azure.Core.Foundations.Operation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The job ID. + */ + @path + jobId: string; + }, + ConversationalAnalysisAuthoringDeploymentResourcesJobState, + {}, + ErrorResponse + >; + + /** + * Lists the non-expired training jobs created for a project. + */ + listTrainingJobs is languageOperations.ResourceList< + ConversationalAnalysisAuthoringTrainingJobState, + ListQueryParametersTrait<StandardListQueryParameters> + >; + + /** + * Gets the status for a training job. + */ + getTrainingStatus is languageOperations.ResourceRead<ConversationalAnalysisAuthoringTrainingJobState>; + + /** + * Triggers a cancellation for a running training job. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}/:cancel") + @post + @pollingOperation(ConversationalAnalysisAuthoring.getTrainingStatus) + cancelTrainingJob is Foundations.LongRunningOperation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The job ID. + */ + @path + jobId: string; + }, + AcceptedResponse, + {}, + ErrorResponse + >; + + /** + * Gets the status for a project deletion job. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/global/deletion-jobs/{jobId}") + @get + getProjectDeletionStatus is Azure.Core.Foundations.Operation< + { + /** + * The job ID. + */ + @path + jobId: string; + }, + ConversationalAnalysisAuthoringProjectDeletionJobState, + {}, + ErrorResponse + >; + + /** + * Lists the deployments to which an Azure resource is assigned. This doesn't + * return deployments belonging to projects owned by this resource. It only + * returns deployments belonging to projects owned by other resources. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/global/deployments/resources") + @get + @added(Versions.v2023_04_15_preview) + listAssignedResourceDeployments is Azure.Core.Foundations.Operation< + { + /** + * The maximum number of resources to return from the collection. + */ + @query("top") + top?: int32; + + /** + * An offset into the collection of the first resource to be returned. + */ + @query("skip") + skip?: int32; + + /** + * The maximum number of resources to include in a single response. + */ + @query("maxpagesize") + maxpagesize?: int32; + }, + ConversationalAnalysisAuthoringAssignedResourceDeploymentsMetadata, + {}, + ErrorResponse + >; + + /** + * Lists the supported languages for the given project type. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/global/languages") + @get + getSupportedLanguages is Azure.Core.Foundations.Operation< + { + /** + * The project kind. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" + @query("projectKind") + ProjectKind: ProjectKind; + + /** + * The maximum number of resources to return from the collection. + */ + @query("top") + top?: int32; + + /** + * An offset into the collection of the first resource to be returned. + */ + @query("skip") + skip?: int32; + + /** + * The maximum number of resources to include in a single response. + */ + @query("maxpagesize") + maxpagesize?: int32; + }, + ConversationalAnalysisAuthoringSupportedLanguages, + {}, + ErrorResponse + >; + + /** + * Lists the supported prebuilt entities that can be used while creating composed + * entities. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/global/prebuilt-entities") + @get + getSupportedPrebuiltEntities is Azure.Core.Foundations.Operation< + { + /** + * The language to get supported prebuilt entities for. Required if multilingual + * is false. This is BCP-47 representation of a language. For example, use "en" + * for English, "en-gb" for English (UK), "es" for Spanish etc. + */ + @query("language") + language?: string; + + /** + * Whether to get the support prebuilt entities for multilingual or monolingual + * projects. If true, the language parameter is ignored. + */ + @query("multilingual") + multilingual?: string; + + /** + * The maximum number of resources to return from the collection. + */ + @query("top") + top?: int32; + + /** + * An offset into the collection of the first resource to be returned. + */ + @query("skip") + skip?: int32; + + /** + * The maximum number of resources to include in a single response. + */ + @query("maxpagesize") + maxpagesize?: int32; + }, + ConversationalAnalysisAuthoringPrebuiltEntities, + {}, + ErrorResponse + >; + + /** + * Lists the support training config version for a given project type. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/global/training-config-versions") + @get + listTrainingConfigVersions is Azure.Core.Foundations.Operation< + { + /** + * The project kind. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" + @query("projectKind") + ProjectKind: ProjectKind; + + /** + * The maximum number of resources to return from the collection. + */ + @query("top") + top?: int32; + + /** + * An offset into the collection of the first resource to be returned. + */ + @query("skip") + skip?: int32; + + /** + * The maximum number of resources to include in a single response. + */ + @query("maxpagesize") + maxpagesize?: int32; + }, + ConversationalAnalysisAuthoringTrainingConfigVersions, + {}, + ErrorResponse + >; +} diff --git a/specification/cognitiveservices/Language.AnalyzeConversations-authoring/tspconfig.yaml b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/tspconfig.yaml new file mode 100644 index 000000000000..3100367bac7a --- /dev/null +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/tspconfig.yaml @@ -0,0 +1,21 @@ +parameters: + "service-dir": + default: "sdk/cognitivelanguage/authoring/analyzeconversations" +emit: + - "@azure-tools/typespec-autorest" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/data-plane" +options: + "@azure-tools/typespec-autorest": + omit-unreachable-types: true + azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" + emitter-output-dir: "{project-root}/.." + output-file: "{azure-resource-provider-folder}/Language/{version-status}/{version}/analyzeconversations-authoring.json" + "@azure-tools/typespec-csharp": + package-dir: "Azure.AI.Language.Authoring.Analyzeconversations" + clear-output-folder: true + model-namespace: true + namespace: "Azure.AI.Language.Authoring.Analyzeconversations" + flavor: azure diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/analyzeconversations-authoring.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/analyzeconversations-authoring.json index 71303391acbd..2c7df6972a0a 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/analyzeconversations-authoring.json +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/analyzeconversations-authoring.json @@ -3,212 +3,239 @@ "info": { "title": "Microsoft Cognitive Language Service - Analyze Conversations Authoring", "version": "2023-04-15-preview", - "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 <a href=\"https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview\">https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview</a>." - }, - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default" + "description": "The language service API is a suite of natural language processing (NLP) skills\nbuilt with best-in-class Microsoft machine learning algorithms. The API can be\nused to analyze unstructured text for tasks such as sentiment analysis, key\nphrase extraction, language detection and question answering. Further\ndocumentation can be found in <a\nhref=\"https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview\">https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview</a>.The language service conversations API is a suite of natural language processing (NLP) skills that can be used to analyze structured conversations (textual or spoken). The synchronous API in this suite accepts a request and mediates among multiple language projects, such as LUIS Generally Available, Question Answering, Conversational Language Understanding, and then calls the best candidate service to handle the request. At last, it returns a response with the candidate service's response as a payload.\\n\\n In some cases, this API needs to forward requests and responses between the caller and an upstream service. The asynchronous APIs in this suite enable tasks like Conversation Summarization and Conversational PII detection.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" } - }, - "apim_key": { - "type": "apiKey", - "description": "A subscription key for a Language service resource.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } + ] }, - "security": [ - { - "AADToken": [ - "https://cognitiveservices.azure.com/.default" - ] - }, - { - "apim_key": [] - } + "schemes": [ + "https" ], "x-ms-parameterized-host": { "hostTemplate": "{Endpoint}/language", "useSchemePrefix": false, "parameters": [ { - "$ref": "common.json#/parameters/Endpoint" + "name": "endpoint", + "in": "path", + "description": "Supported Cognitive Services endpoint (e.g.,\nhttps://<resource-name>.api.cognitiveservices.azure.com).", + "required": true, + "type": "string" + }, + { + "name": "Endpoint", + "in": "path", + "required": true, + "type": "string" } ] }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "ApiKeyAuth": [] + }, + { + "OAuth2Auth": [ + "https://cognitiveservices.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + }, + "OAuth2Auth": { + "type": "oauth2", + "flow": "accessCode", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://cognitiveservices.azure.com/.default": "" + }, + "tokenUrl": "https://login.microsoftonline.com/common/oauth2/token" + } + }, + "tags": [], "paths": { "/authoring/analyze-conversations/projects": { "get": { - "description": "Lists the existing projects.", "operationId": "ConversationalAnalysisAuthoring_ListProjects", - "produces": [ - "application/json" - ], + "description": "Lists the existing projects.", "parameters": [ { - "$ref": "common.json#/parameters/TopParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/SkipParameter" + "$ref": "#/parameters/Azure.Core.TopQueryParameter" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" } ], "responses": { "200": { - "description": "The metadata of projects.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectsMetadata" + "$ref": "#/definitions/PagedConversationalAnalysisAuthoringProjectMetadata" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful List Projects": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListProjects.json" + "$ref": "./examples/SuccessfulListProjects.json" } }, "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" + "nextLinkName": "nextLink" } } }, "/authoring/analyze-conversations/projects/{projectName}": { - "patch": { - "description": "Creates a new project or updates an existing one.", - "operationId": "ConversationalAnalysisAuthoring_CreateProject", - "consumes": [ - "application/merge-patch+json" - ], - "produces": [ - "application/json" - ], + "get": { + "operationId": "ConversationalAnalysisAuthoring_GetProject", + "description": "Gets the details of a project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "in": "body", - "name": "body", - "description": "The project parameters.", + "name": "projectName", + "in": "path", + "description": "The new project name.", "required": true, - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateProjectOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" + "type": "string", + "maxLength": 100 } ], "responses": { "200": { - "description": "The metadata of the updated project, if it already exists.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" - } - }, - "201": { - "description": "The metadata of the created project.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Successful Create Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCreateProject.json" + "Successful Get Project": { + "$ref": "./examples/SuccessfulGetProject.json" } } }, - "get": { - "description": "Gets the details of a project.", - "operationId": "ConversationalAnalysisAuthoring_GetProject", - "produces": [ - "application/json" + "patch": { + "operationId": "ConversationalAnalysisAuthoring_CreateProject", + "description": "Creates a new project or updates an existing one.", + "consumes": [ + "application/merge-patch+json" ], "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "body", + "in": "body", + "description": "The request body", + "required": true, + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateProjectOptions" + } } ], "responses": { "200": { - "description": "The metadata of the project.", + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Successful Get Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProject.json" + "Successful Create Project": { + "$ref": "./examples/SuccessfulCreateProject.json" } } }, "delete": { - "description": "Deletes a project.", "operationId": "ConversationalAnalysisAuthoring_DeleteProject", - "produces": [ - "application/json" - ], + "description": "Deletes a project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Delete Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteProject.json" + "$ref": "./examples/SuccessfulDeleteProject.json" } }, "x-ms-long-running-operation": true @@ -216,99 +243,97 @@ }, "/authoring/analyze-conversations/projects/{projectName}/:authorize-copy": { "post": { - "description": "Generates a copy project operation authorization to the current target Azure resource.", "operationId": "ConversationalAnalysisAuthoring_CopyProjectAuthorization", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "description": "Generates a copy project operation authorization to the current target Azure\nresource.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "in": "body", "name": "body", - "description": "The copy project authorization info.", + "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringCopyAuthorizationOptions" } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { - "description": "Payload to send to source resource to initiate project copying.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringCopyProjectOptions" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Copy Project Authorization": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json" + "$ref": "./examples/SuccessfulCopyProjectAuthorization.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/:copy": { "post": { - "description": "Copies an existing project to another Azure resource.", "operationId": "ConversationalAnalysisAuthoring_CopyProject", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "description": "Copies an existing project to another Azure resource.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "in": "body", "name": "body", + "in": "body", "description": "The copy project info.", "required": true, "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringCopyProjectOptions" } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Copy Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCopyProject.json" + "$ref": "./examples/SuccessfulCopyProject.json" } }, "x-ms-long-running-operation": true @@ -316,59 +341,105 @@ }, "/authoring/analyze-conversations/projects/{projectName}/:export": { "post": { - "description": "Triggers a job to export a project's data.", "operationId": "ConversationalAnalysisAuthoring_Export", - "produces": [ - "application/json" - ], + "description": "Triggers a job to export a project's data.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringFormatQueryOptionalParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringStringIndexTypeQueryParameter" + "name": "format", + "in": "query", + "description": "The format of the exported project file to use.", + "required": false, + "type": "string", + "enum": [ + "Conversation", + "Luis" + ], + "x-ms-enum": { + "name": "ExportedProjectFormat", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "Specifies the format for a conversational project." + }, + { + "name": "Luis", + "value": "Luis", + "description": "Specifies the format for an application that was exported from LUIS." + } + ] + }, + "x-ms-client-name": "ExportedProjectFormat" + }, + { + "name": "stringIndexType", + "in": "query", + "description": "Specifies the method used to interpret string offsets. For additional\ninformation see https://aka.ms/text-analytics-offsets.", + "required": true, + "type": "string", + "enum": [ + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "The offset and length values will correspond to UTF-16 code units. Use this\noption if your application is written in a language that support Unicode, for\nexample Java, JavaScript." + } + ] + } }, { - "in": "query", "name": "assetKind", + "in": "query", "description": "Kind of asset to export.", - "type": "string", - "x-ms-parameter-location": "method" + "required": false, + "type": "string" }, { - "in": "query", "name": "trainedModelLabel", + "in": "query", "description": "Trained model label to export. If the trainedModelLabel is null, the default behavior is to export the current working copy.", - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" + "required": false, + "type": "string" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Export Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulExportProject.json" + "$ref": "./examples/SuccessfulExportProject.json" } }, "x-ms-long-running-operation": true @@ -376,54 +447,79 @@ }, "/authoring/analyze-conversations/projects/{projectName}/:import": { "post": { - "description": "Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.", "operationId": "ConversationalAnalysisAuthoring_Import", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "description": "Triggers a job to import a project. If a project with the same name already\nexists, the data of that project is replaced.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringFormatQueryOptionalParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "format", + "in": "query", + "description": "The format of the exported project file to use.", + "required": false, + "type": "string", + "enum": [ + "Conversation", + "Luis" + ], + "x-ms-enum": { + "name": "ExportedProjectFormat", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "Specifies the format for a conversational project." + }, + { + "name": "Luis", + "value": "Luis", + "description": "Specifies the format for an application that was exported from LUIS." + } + ] + }, + "x-ms-client-name": "ExportedProjectFormat" }, { - "in": "body", "name": "body", + "in": "body", "description": "The project data to import.", "required": true, "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProject" } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Import Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulImportProject.json" + "$ref": "./examples/SuccessfulImportProject.json" } }, "x-ms-long-running-operation": true @@ -431,51 +527,51 @@ }, "/authoring/analyze-conversations/projects/{projectName}/:train": { "post": { - "description": "Triggers a training job for a project.", "operationId": "ConversationalAnalysisAuthoring_Train", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "description": "Triggers a training job for a project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "in": "body", "name": "body", + "in": "body", "description": "The training input parameters.", "required": true, "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobOptions" } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Train Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulTrainProject.json" + "$ref": "./examples/SuccessfulTrainProject.json" } }, "x-ms-long-running-operation": true @@ -483,272 +579,244 @@ }, "/authoring/analyze-conversations/projects/{projectName}/copy/jobs/{jobId}": { "get": { - "description": "Gets the status of an existing copy project job.", "operationId": "ConversationalAnalysisAuthoring_GetCopyProjectStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status of an existing copy project job.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The status of the long running operation.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringCopyProjectJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Copy Project Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json" + "$ref": "./examples/SuccessfulGetCopyProjectStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/deployments": { "get": { - "description": "Lists the deployments belonging to a project.", "operationId": "ConversationalAnalysisAuthoring_ListDeployments", - "produces": [ - "application/json" - ], + "description": "Lists the deployments belonging to a project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/TopParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/SkipParameter" + "$ref": "#/parameters/Azure.Core.TopQueryParameter" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" } ], "responses": { "200": { - "description": "List of all deployments.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployments" + "$ref": "#/definitions/PagedConversationalAnalysisAuthoringProjectDeployment" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful List Deployments": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListDeployments.json" + "$ref": "./examples/SuccessfulListDeployments.json" } }, "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" + "nextLinkName": "nextLink" } } }, - "/authoring/analyze-conversations/projects/{projectName}/deployments/:swap": { - "post": { - "description": "Swaps two existing deployments with each other.", - "operationId": "ConversationalAnalysisAuthoring_SwapDeployments", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The job object to swap two deployments.", - "required": true, - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringSwapDeploymentsOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Swap Deployments": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json" - } - }, - "x-ms-long-running-operation": true - } - }, "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}": { "get": { - "description": "Gets the details of a deployment.", "operationId": "ConversationalAnalysisAuthoring_GetDeployment", - "produces": [ - "application/json" - ], + "description": "Gets the details of a deployment.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "deploymentName", + "in": "path", + "description": "Represents deployment name.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The Deployment info.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployment" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Deployment": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeployment.json" + "$ref": "./examples/SuccessfulGetDeployment.json" } } }, "put": { - "description": "Creates a new deployment or replaces an existing one.", "operationId": "ConversationalAnalysisAuthoring_DeployProject", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "description": "Creates a new deployment or replaces an existing one.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the specific deployment of the project to use.", + "required": true, + "type": "string" }, { - "in": "body", "name": "body", + "in": "body", "description": "The new deployment info.", "required": true, "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateDeploymentOptions" } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Deploy Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeployProject.json" + "$ref": "./examples/SuccessfulDeployProject.json" } }, "x-ms-long-running-operation": true }, "delete": { - "description": "Deletes a project deployment.", "operationId": "ConversationalAnalysisAuthoring_DeleteDeployment", - "produces": [ - "application/json" - ], + "description": "Deletes a project deployment.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "deploymentName", + "in": "path", + "description": "The name of the specific deployment of the project to use.", + "required": true, + "type": "string" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Delete Deployment": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json" + "$ref": "./examples/SuccessfulDeleteDeployment.json" } }, "x-ms-long-running-operation": true @@ -756,54 +824,58 @@ }, "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/:delete-from-resources": { "post": { - "description": "Deletes a project deployment from the specified assigned resources.", "operationId": "ConversationalAnalysisAuthoring_DeleteDeploymentFromResources", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "description": "Deletes a project deployment from the specified assigned resources.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the specific deployment of the project to use.", + "required": true, + "type": "string" }, { - "in": "body", "name": "body", + "in": "body", "description": "The options for deleting the deployment.", "required": true, "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringDeleteDeploymentOptions" } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Successful Delete Deployment": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json" + "Successful Delete Deployment From Resources": { + "$ref": "./examples/SuccessfulDeleteDeploymentFromResources.json" } }, "x-ms-long-running-operation": true @@ -811,377 +883,484 @@ }, "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/delete-from-resources/jobs/{jobId}": { "get": { - "description": "Gets the status of an existing delete deployment from specific resources job.", "operationId": "ConversationalAnalysisAuthoring_GetDeploymentDeleteFromResourcesStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status of an existing delete deployment from specific resources job.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "deploymentName", + "in": "path", + "description": "Represents deployment name.", + "required": true, + "type": "string" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The deployment job result.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentJobState" + "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentDeleteFromResourcesJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Successful Get Delete Deployment From Resources Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json" + "Successful Get Deployment Status": { + "$ref": "./examples/SuccessfulGetDeploymentDeleteFromResourcesStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { "get": { - "description": "Gets the status of an existing deployment job.", "operationId": "ConversationalAnalysisAuthoring_GetDeploymentStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status of an existing deployment job.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "deploymentName", + "in": "path", + "description": "Represents deployment name.", + "required": true, + "type": "string" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The deployment job result.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Deployment Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json" + "$ref": "./examples/SuccessfulGetDeploymentStatus.json" } } } }, + "/authoring/analyze-conversations/projects/{projectName}/deployments/:swap": { + "post": { + "operationId": "ConversationalAnalysisAuthoring_SwapDeployments", + "description": "Swaps two existing deployments with each other.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "body", + "in": "body", + "description": "The job object to swap two deployments.", + "required": true, + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringSwapDeploymentsOptions" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Swap Deployments": { + "$ref": "./examples/SuccessfulSwapDeployments.json" + } + }, + "x-ms-long-running-operation": true + } + }, "/authoring/analyze-conversations/projects/{projectName}/deployments/swap/jobs/{jobId}": { "get": { - "description": "Gets the status of an existing swap deployment job.", "operationId": "ConversationalAnalysisAuthoring_GetSwapDeploymentsStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status of an existing swap deployment job.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The swap deployment job result.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentJobState" + "$ref": "#/definitions/ConversationalAnalysisAuthoringSwapDeploymentsJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Swap Deployments Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json" + "$ref": "./examples/SuccessfulGetSwapDeploymentsStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/export/jobs/{jobId}": { "get": { - "description": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.", "operationId": "ConversationalAnalysisAuthoring_GetExportStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status of an export job. Once job completes, returns the project\nmetadata, and assets.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The status of the long running operation.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportProjectJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Export Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json" + "$ref": "./examples/SuccessfulGetExportStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/import/jobs/{jobId}": { "get": { - "description": "Gets the status for an import.", "operationId": "ConversationalAnalysisAuthoring_GetImportStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status for an import.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The details of the long running operation.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringImportProjectJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Import Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json" + "$ref": "./examples/SuccessfulGetImportStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/models": { "get": { - "description": "Lists the trained models belonging to a project.", "operationId": "ConversationalAnalysisAuthoring_ListTrainedModels", - "produces": [ - "application/json" - ], + "description": "Lists the trained models belonging to a project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/TopParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/SkipParameter" + "$ref": "#/parameters/Azure.Core.TopQueryParameter" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" } ], "responses": { "200": { - "description": "List of all trained models.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModels" + "$ref": "#/definitions/PagedConversationalAnalysisAuthoringProjectTrainedModel" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful List Models": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListModels.json" + "$ref": "./examples/SuccessfulListModels.json" } }, "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" + "nextLinkName": "nextLink" } } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}": { "get": { - "description": "Gets the details of a trained model.", "operationId": "ConversationalAnalysisAuthoring_GetTrainedModel", - "produces": [ - "application/json" - ], + "description": "Gets the details of a trained model.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "Trained model info", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModel" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Model": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModel.json" + "$ref": "./examples/SuccessfulGetModel.json" } } }, "delete": { - "description": "Deletes an existing trained model.", "operationId": "ConversationalAnalysisAuthoring_DeleteTrainedModel", - "produces": [ - "application/json" - ], + "description": "Deletes an existing trained model.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" } ], "responses": { "204": { - "description": "Deleted successfully." + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Delete Model": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteModel.json" + "$ref": "./examples/SuccessfulDeleteModel.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:evaluate": { "post": { - "description": "Triggers evaluation operation on a trained model.", "operationId": "ConversationalAnalysisAuthoring_EvaluateModel", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "description": "Triggers evaluation operation on a trained model.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" }, { - "in": "body", "name": "body", + "in": "body", "description": "The training input parameters.", "required": true, "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions" } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Successful Evaluation": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulEvaluationProject.json" + "Successful Evaluation Project": { + "$ref": "./examples/SuccessfulEvaluationProject.json" } }, "x-ms-long-running-operation": true @@ -1189,42 +1368,49 @@ }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:load-snapshot": { "post": { - "description": "Restores the snapshot of this trained model to be the current working directory of the project.", "operationId": "ConversationalAnalysisAuthoring_LoadSnapshot", - "produces": [ - "application/json" - ], + "description": "Restores the snapshot of this trained model to be the current working directory\nof the project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" } ], "responses": { "202": { - "description": "A successful call results in loading the working directory with the snapshot of the model provided.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Load Snapshot": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json" + "$ref": "./examples/SuccessfulLoadSnapshot.json" } }, "x-ms-long-running-operation": true @@ -1232,278 +1418,310 @@ }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluate/jobs/{jobId}": { "get": { - "description": "Gets the status for an evaluation job.", "operationId": "ConversationalAnalysisAuthoring_GetEvaluationStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status for an evaluation job.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The evaluation job result.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Evaluation Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json" + "$ref": "./examples/SuccessfulGetEvaluationStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/result": { "get": { - "description": "Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process.", "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationResults", - "produces": [ - "application/json" - ], + "description": "Gets the detailed results of the evaluation for a trained model. This includes\nthe raw inference results for the data included in the evaluation process.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringStringIndexTypeQueryParameter" + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" }, { - "$ref": "common.json#/parameters/TopParameter" + "$ref": "#/parameters/Azure.Core.TopQueryParameter" }, { - "$ref": "common.json#/parameters/SkipParameter" + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/StringIndexTypeQueryParameter" } ], "responses": { "200": { - "description": "List of the evaluation predictions.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationResults" + "$ref": "#/definitions/PagedConversationalAnalysisAuthoringUtteranceEvaluationResult" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Model Evaluation": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json" + "$ref": "./examples/SuccessfulGetModelEvaluation.json" } }, "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" + "nextLinkName": "nextLink" } } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { "get": { - "description": "Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc.", "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationSummary", - "produces": [ - "application/json" - ], + "description": "Gets the evaluation summary of a trained model. The summary includes high level\nperformance measurements of the model e.g., F1, Precision, Recall, etc.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "List of all evaluation results.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationSummary" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Model Evaluation Summary": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json" + "$ref": "./examples/SuccessfulGetModelEvaluationSummary.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/load-snapshot/jobs/{jobId}": { "get": { - "description": "Gets the status for loading a snapshot.", "operationId": "ConversationalAnalysisAuthoring_GetLoadSnapshotStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status for loading a snapshot.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The details of the long running operation.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringLoadSnapshotJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Load Snapshot Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json" + "$ref": "./examples/SuccessfulGetLoadSnapshotStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/resources": { "get": { - "description": "Lists the deployments resources assigned to the project.", "operationId": "ConversationalAnalysisAuthoring_ListDeploymentResources", - "produces": [ - "application/json" - ], + "description": "Lists the deployments resources assigned to the project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/TopParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/SkipParameter" + "$ref": "#/parameters/Azure.Core.TopQueryParameter" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" } ], "responses": { "200": { - "description": "The assigned deployment resources.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringAssignedDeploymentResources" + "$ref": "#/definitions/PagedConversationalAnalysisAuthoringAssignedDeploymentResource" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful List Deployment Resources": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json" + "$ref": "./examples/SuccessfulListDeploymentResources.json" } }, "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" + "nextLinkName": "nextLink" } } }, "/authoring/analyze-conversations/projects/{projectName}/resources/:assign": { "post": { - "description": "Assign new Azure resources to a project to allow deploying new deployments to them. This API is available only via AAD authentication and not supported via subscription key authentication. For more details about AAD authentication, check here: https://learn.microsoft.com/en-us/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-azure-active-directory", "operationId": "ConversationalAnalysisAuthoring_AssignDeploymentResources", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "description": "Assign new Azure resources to a project to allow deploying new deployments to\nthem. This API is available only via AAD authentication and not supported via\nsubscription key authentication. For more details about AAD authentication,\ncheck here:\nhttps://learn.microsoft.com/en-us/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-azure-active-directory", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "in": "body", "name": "body", + "in": "body", "description": "The new project resources info.", "required": true, "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringAssignDeploymentResourcesOptions" } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Assign Deployment Resources": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json" + "$ref": "./examples/SuccessfulAssignDeploymentResources.json" } }, "x-ms-long-running-operation": true @@ -1511,51 +1729,51 @@ }, "/authoring/analyze-conversations/projects/{projectName}/resources/:unassign": { "post": { - "description": "Unassign resources from a project. This disallows deploying new deployments to these resources, and deletes existing deployments assigned to them.", "operationId": "ConversationalAnalysisAuthoring_UnassignDeploymentResources", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "description": "Unassign resources from a project. This disallows deploying new deployments to\nthese resources, and deletes existing deployments assigned to them.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "in": "body", "name": "body", + "in": "body", "description": "The info for the deployment resources to be deleted.", "required": true, "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringUnassignDeploymentResourcesOptions" } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Unassign Deployment Resources": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json" + "$ref": "./examples/SuccessfulUnassignDeploymentResources.json" } }, "x-ms-long-running-operation": true @@ -1563,208 +1781,234 @@ }, "/authoring/analyze-conversations/projects/{projectName}/resources/assign/jobs/{jobId}": { "get": { - "description": "Gets the status of an existing assign deployment resources job.", "operationId": "ConversationalAnalysisAuthoring_GetAssignDeploymentResourcesStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status of an existing assign deployment resources job.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The assign deployment resources job result.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentResourcesJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Assign Deployment Resources Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json" + "$ref": "./examples/SuccessfulGetAssignDeploymentResourcesStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/resources/unassign/jobs/{jobId}": { "get": { - "description": "Gets the status of an existing unassign deployment resources job.", "operationId": "ConversationalAnalysisAuthoring_GetUnassignDeploymentResourcesStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status of an existing unassign deployment resources job.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The unassign deployment resources job result.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentResourcesJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Unassign Deployment Resources Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json" + "$ref": "./examples/SuccessfulGetUnassignDeploymentResourcesStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/train/jobs": { "get": { - "description": "Lists the non-expired training jobs created for a project.", "operationId": "ConversationalAnalysisAuthoring_ListTrainingJobs", - "produces": [ - "application/json" - ], + "description": "Lists the non-expired training jobs created for a project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/TopParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/SkipParameter" + "$ref": "#/parameters/Azure.Core.TopQueryParameter" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" } ], "responses": { "200": { - "description": "List of the training jobs.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobs" + "$ref": "#/definitions/PagedConversationalAnalysisAuthoringTrainingJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful List Training Jobs": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json" + "$ref": "./examples/SuccessfulListTrainingJobs.json" } }, "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" + "nextLinkName": "nextLink" } } }, "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}": { "get": { - "description": "Gets the status for a training job.", "operationId": "ConversationalAnalysisAuthoring_GetTrainingStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status for a training job.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The training job result.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Train Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json" + "$ref": "./examples/SuccessfulGetTrainStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}/:cancel": { "post": { - "description": "Triggers a cancellation for a running training job.", "operationId": "ConversationalAnalysisAuthoring_CancelTrainingJob", - "produces": [ - "application/json" - ], + "description": "Triggers a cancellation for a running training job.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the job cancellation.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Cancel Training Job": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json" + "$ref": "./examples/SuccessfulCancelTrainingJob.json" } }, "x-ms-long-running-operation": true @@ -1772,2486 +2016,3061 @@ }, "/authoring/analyze-conversations/projects/global/deletion-jobs/{jobId}": { "get": { - "description": "Gets the status for a project deletion job.", "operationId": "ConversationalAnalysisAuthoring_GetProjectDeletionStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status for a project deletion job.", "parameters": [ { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The project deletion job result.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeletionJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Project Deletion Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json" + "$ref": "./examples/SuccessfulGetProjectDeletionStatus.json" } } } }, "/authoring/analyze-conversations/projects/global/deployments/resources": { "get": { - "description": "Lists the deployments to which an Azure resource is assigned. This doesn't return deployments belonging to projects owned by this resource. It only returns deployments belonging to projects owned by other resources.", "operationId": "ConversationalAnalysisAuthoring_ListAssignedResourceDeployments", - "produces": [ - "application/json" - ], + "description": "Lists the deployments to which an Azure resource is assigned. This doesn't\nreturn deployments belonging to projects owned by this resource. It only\nreturns deployments belonging to projects owned by other resources.", "parameters": [ { - "$ref": "common.json#/parameters/TopParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/SkipParameter" + "name": "top", + "in": "query", + "description": "The maximum number of resources to return from the collection.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "name": "skip", + "in": "query", + "description": "An offset into the collection of the first resource to be returned.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "maxpagesize", + "in": "query", + "description": "The maximum number of resources to include in a single response.", + "required": false, + "type": "integer", + "format": "int32" } ], "responses": { "200": { - "description": "The assigned deployments metadata for the resource.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringAssignedResourceDeploymentsMetadata" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful List Assigned Resource Deployments": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json" + "$ref": "./examples/SuccessfulListAssignedResourceDeployments.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" } } }, "/authoring/analyze-conversations/projects/global/languages": { "get": { - "description": "Lists the supported languages for the given project type.", "operationId": "ConversationalAnalysisAuthoring_GetSupportedLanguages", - "produces": [ - "application/json" - ], + "description": "Lists the supported languages for the given project type.", "parameters": [ { - "$ref": "#/parameters/ConversationalAnalysisAuthoringProjectKindQueryParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" + "name": "projectKind", + "in": "query", + "description": "The project kind.", + "required": true, + "type": "string", + "enum": [ + "Conversation", + "Orchestration", + "CustomConversationSummarization" + ], + "x-ms-enum": { + "name": "ProjectKind", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "A project to build natural language into apps, bots, and IoT devices." + }, + { + "name": "Orchestration", + "value": "Orchestration", + "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." + }, + { + "name": "CustomConversationSummarization", + "value": "CustomConversationSummarization", + "description": "A project to build conversation summarization models which are able to summarize long conversations." + } + ] + }, + "x-ms-client-name": "ProjectKind" + }, + { + "name": "top", + "in": "query", + "description": "The maximum number of resources to return from the collection.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "name": "skip", + "in": "query", + "description": "An offset into the collection of the first resource to be returned.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "maxpagesize", + "in": "query", + "description": "The maximum number of resources to include in a single response.", + "required": false, + "type": "integer", + "format": "int32" } ], "responses": { "200": { - "description": "The list of supported languages.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringSupportedLanguages" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Successful Supported Languages": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json" + "Successful Get Supported Languages": { + "$ref": "./examples/SuccessfulGetSupportedLanguages.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" } } }, "/authoring/analyze-conversations/projects/global/prebuilt-entities": { "get": { - "description": "Lists the supported prebuilt entities that can be used while creating composed entities.", "operationId": "ConversationalAnalysisAuthoring_GetSupportedPrebuiltEntities", - "produces": [ - "application/json" - ], + "description": "Lists the supported prebuilt entities that can be used while creating composed\nentities.", "parameters": [ { - "in": "query", - "name": "language", - "description": "The language to get supported prebuilt entities for. Required if multilingual is false. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string", - "x-ms-parameter-location": "method" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { + "name": "language", "in": "query", - "name": "multilingual", - "description": "Whether to get the support prebuilt entities for multilingual or monolingual projects. If true, the language parameter is ignored.", - "type": "string", - "x-ms-parameter-location": "method" + "description": "The language to get supported prebuilt entities for. Required if multilingual\nis false. This is BCP-47 representation of a language. For example, use \"en\"\nfor English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "required": false, + "type": "string" }, { - "$ref": "common.json#/parameters/TopParameter" + "name": "multilingual", + "in": "query", + "description": "Whether to get the support prebuilt entities for multilingual or monolingual\nprojects. If true, the language parameter is ignored.", + "required": false, + "type": "string" }, { - "$ref": "common.json#/parameters/SkipParameter" + "name": "top", + "in": "query", + "description": "The maximum number of resources to return from the collection.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "name": "skip", + "in": "query", + "description": "An offset into the collection of the first resource to be returned.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "maxpagesize", + "in": "query", + "description": "The maximum number of resources to include in a single response.", + "required": false, + "type": "integer", + "format": "int32" } ], "responses": { "200": { - "description": "The list of supported prebuilt entities.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringPrebuiltEntities" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Supported Prebuilt Entities": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json" + "$ref": "./examples/SuccessfulGetSupportedPrebuiltEntities.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" } } }, "/authoring/analyze-conversations/projects/global/training-config-versions": { "get": { - "description": "Lists the support training config version for a given project type.", "operationId": "ConversationalAnalysisAuthoring_ListTrainingConfigVersions", - "produces": [ - "application/json" - ], + "description": "Lists the support training config version for a given project type.", "parameters": [ { - "$ref": "#/parameters/ConversationalAnalysisAuthoringProjectKindQueryParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/SkipParameter" + "name": "projectKind", + "in": "query", + "description": "The project kind.", + "required": true, + "type": "string", + "enum": [ + "Conversation", + "Orchestration", + "CustomConversationSummarization" + ], + "x-ms-enum": { + "name": "ProjectKind", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "A project to build natural language into apps, bots, and IoT devices." + }, + { + "name": "Orchestration", + "value": "Orchestration", + "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." + }, + { + "name": "CustomConversationSummarization", + "value": "CustomConversationSummarization", + "description": "A project to build conversation summarization models which are able to summarize long conversations." + } + ] + }, + "x-ms-client-name": "ProjectKind" + }, + { + "name": "top", + "in": "query", + "description": "The maximum number of resources to return from the collection.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "name": "skip", + "in": "query", + "description": "An offset into the collection of the first resource to be returned.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "maxpagesize", + "in": "query", + "description": "The maximum number of resources to include in a single response.", + "required": false, + "type": "integer", + "format": "int32" } ], "responses": { "200": { - "description": "List of config versions.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingConfigVersions" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Supported Training Config Versions": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json" + "$ref": "./examples/SuccessfulGetSupportedTrainingConfigVersions.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" } } } }, "definitions": { - "ConversationalAnalysisAuthoringAssignDeploymentResourcesOptions": { - "description": "Represents the options for assigning Azure resources to a project.", - "required": [ - "resourcesMetadata" + "Azure.Core.uuid": { + "type": "string", + "format": "uuid", + "description": "Universally Unique Identifier" + }, + "CompositionSetting": { + "type": "string", + "enum": [ + "returnLongestOverlap", + "requireExactOverlap", + "separateComponents", + "combineComponents" ], + "x-ms-enum": { + "name": "CompositionSetting", + "modelAsString": true, + "values": [ + { + "name": "returnLongestOverlap", + "value": "returnLongestOverlap", + "description": "When two or more components are found in the text and overlap, the component\nwith the longest set of characters is returned." + }, + { + "name": "requireExactOverlap", + "value": "requireExactOverlap", + "description": "All components must overlap at the exact same characters in the text for the\nentity to return. If one of the defined components is not matched or predicted,\nthe entity will not return." + }, + { + "name": "separateComponents", + "value": "separateComponents", + "description": "Every component's match or prediction is returned as a separate instance of the\nentity." + }, + { + "name": "combineComponents", + "value": "combineComponents", + "description": "When two or more components are found in the text and overlap, the components'\nspans are merged together into one span combining all of them." + } + ] + } + }, + "ConversationalAnalysisAuthoringAssignDeploymentResourcesOptions": { "type": "object", + "description": "Represents the options for assigning Azure resources to a project.", "properties": { "resourcesMetadata": { - "description": "Represents the metadata for the resources to be assigned.", "type": "array", + "description": "Represents the metadata for the resources to be assigned.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringResourceMetadata" - } + }, + "x-ms-identifiers": [] } }, - "x-ms-client-name": "AssignDeploymentResourcesOptions" + "required": [ + "resourcesMetadata" + ] }, "ConversationalAnalysisAuthoringAssignedDeploymentResource": { - "description": "Represents the assigned deployment resource.", - "required": [ - "azureResourceId", - "region" - ], "type": "object", + "description": "Represents the assigned deployment resource.", "properties": { "azureResourceId": { - "description": "The resource ID.", - "type": "string" + "type": "string", + "description": "The resource ID." }, "region": { - "description": "The resource region.", - "type": "string" - } - }, - "x-ms-client-name": "AssignedDeploymentResource" - }, - "ConversationalAnalysisAuthoringAssignedDeploymentResources": { - "description": "Represents the assigned deployment resources.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of assigned deployment resources.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringAssignedDeploymentResource" - } - }, - "nextLink": { - "description": "The next page link.", "type": "string", - "x-nullable": true + "description": "The resource region." } }, - "x-ms-client-name": "AssignedDeploymentResources" + "required": [ + "azureResourceId", + "region" + ] }, "ConversationalAnalysisAuthoringAssignedProjectDeploymentMetadata": { - "description": "Represents the metadata for an assigned deployment", - "required": [ - "deploymentName", - "lastDeployedDateTime", - "deploymentExpirationDate" - ], "type": "object", + "description": "Represents the metadata for an assigned deployment", "properties": { "deploymentName": { - "description": "Represents the deployment name.", - "type": "string" + "type": "string", + "description": "Represents the deployment name." }, "lastDeployedDateTime": { + "type": "string", "format": "date-time", - "description": "Represents deployment last deployed time.", - "type": "string" + "description": "Represents deployment last deployed time." }, "deploymentExpirationDate": { + "type": "string", "format": "date", - "description": "Represents deployment expiration date in the runtime.", - "type": "string" + "description": "Represents deployment expiration date in the runtime." } }, - "x-ms-client-name": "AssignedProjectDeploymentMetadata" + "required": [ + "deploymentName", + "lastDeployedDateTime", + "deploymentExpirationDate" + ] }, "ConversationalAnalysisAuthoringAssignedProjectDeploymentsMetadata": { - "description": "Represents the metadata for assigned deployments for a project.", - "required": [ - "projectName", - "deploymentsMetadata" - ], "type": "object", + "description": "Represents the metadata for assigned deployments for a project.", "properties": { "projectName": { - "description": "Represents the project name.", - "type": "string" + "type": "string", + "description": "Represents the project name." }, "deploymentsMetadata": { - "description": "Represents the resource region.", "type": "array", + "description": "Represents the resource region.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringAssignedProjectDeploymentMetadata" - } + }, + "x-ms-identifiers": [] } }, - "x-ms-client-name": "AssignedProjectDeploymentsMetadata" + "required": [ + "projectName", + "deploymentsMetadata" + ] }, "ConversationalAnalysisAuthoringAssignedResourceDeploymentsMetadata": { - "description": "Represents the metadata for deployments assigned to a resource.", - "required": [ - "value", - "nextLink" - ], "type": "object", + "description": "Represents the metadata for deployments assigned to a resource.", "properties": { "value": { - "description": "The list of retrieved assigned project deployments.", "type": "array", + "description": "The list of retrieved assigned project deployments.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringAssignedProjectDeploymentsMetadata" - } + }, + "x-ms-identifiers": [] }, "nextLink": { - "description": "The next page link.", "type": "string", - "x-nullable": true + "description": "The next page link." } }, - "x-ms-client-name": "AssignedResourceDeploymentsMetadata" - }, - "ConversationalAnalysisAuthoringCompositionSetting": { - "enum": [ - "returnLongestOverlap", - "requireExactOverlap", - "separateComponents", - "combineComponents" - ], - "type": "string", - "x-ms-enum": { - "name": "CompositionSetting", - "modelAsString": true, - "values": [ - { - "value": "returnLongestOverlap", - "description": "When two or more components are found in the text and overlap, the component with the longest set of characters is returned." - }, - { - "value": "requireExactOverlap", - "description": "All components must overlap at the exact same characters in the text for the entity to return. If one of the defined components is not matched or predicted, the entity will not return." - }, - { - "value": "separateComponents", - "description": "Every component's match or prediction is returned as a separate instance of the entity." - }, - { - "value": "combineComponents", - "description": "When two or more components are found in the text and overlap, the components' spans are merged together into one span combining all of them." - } - ] - }, - "x-ms-client-name": "CompositionSetting" + "required": [ + "value" + ] }, "ConversationalAnalysisAuthoringConfusionMatrix": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrixRow" - }, - "x-ms-client-name": "ConfusionMatrix" + } }, "ConversationalAnalysisAuthoringConfusionMatrixCell": { - "description": "Represents a cell in a confusion matrix.", - "required": [ - "normalizedValue", - "rawValue" - ], "type": "object", + "description": "Represents a cell in a confusion matrix.", "properties": { "normalizedValue": { + "type": "number", "format": "float", - "description": "Represents normalized value in percentages.", - "type": "number" + "description": "Represents normalized value in percentages." }, "rawValue": { + "type": "number", "format": "float", - "description": "Represents raw value.", - "type": "number" + "description": "Represents raw value." } }, - "x-ms-client-name": "ConfusionMatrixCell" + "required": [ + "normalizedValue", + "rawValue" + ] }, "ConversationalAnalysisAuthoringConfusionMatrixRow": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrixCell" - }, - "x-ms-client-name": "ConfusionMatrixRow" + } }, "ConversationalAnalysisAuthoringConversationExportedEntity": { - "description": "Represents an entity with its components.", - "required": [ - "category" - ], "type": "object", + "description": "Represents an entity with its components.", "properties": { "category": { - "description": "The category of the entity.", - "type": "string" + "type": "string", + "description": "The category of the entity." }, "compositionSetting": { - "description": "The behavior to follow when the entity's components overlap with each other.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringCompositionSetting" + "$ref": "#/definitions/CompositionSetting", + "description": "The behavior to follow when the entity's components overlap with each other." }, "list": { - "description": "The list component of the entity.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityList" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityList", + "description": "The list component of the entity." }, "prebuilts": { - "description": "The prebuilt entities components.", "type": "array", + "description": "The prebuilt entities components.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedPrebuiltEntity" - } + }, + "x-ms-identifiers": [] }, "regex": { - "description": "The regex component of the entity.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityRegex" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityRegex", + "description": "The regex component of the entity." }, "requiredComponents": { - "description": "The required components. Allowed values are 'learned', 'list', 'prebuilts' and 'regex'.", "type": "array", + "description": "The required components. Allowed values are 'learned', 'list', 'prebuilts' and 'regex'.", "items": { "type": "string" } } }, - "x-ms-client-name": "ConversationExportedEntity" - }, - "ConversationalAnalysisAuthoringConversationExportedIntent": { - "description": "Represents an exported intent of a conversational project.", "required": [ "category" - ], + ] + }, + "ConversationalAnalysisAuthoringConversationExportedIntent": { "type": "object", + "description": "Represents an exported intent of a conversational project.", "properties": { "category": { - "description": "The intent category.", - "type": "string" + "type": "string", + "description": "The intent category." } }, - "x-ms-client-name": "ConversationExportedIntent" + "required": [ + "category" + ] }, "ConversationalAnalysisAuthoringConversationExportedProjectAssets": { - "description": "Represents the exported assets of a conversational project.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" - } - ], + "description": "Represents the exported assets of a conversational project.", "properties": { "intents": { - "description": "The intents defined in the project.", "type": "array", + "description": "The intents defined in the project.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedIntent" - } + }, + "x-ms-identifiers": [] }, "entities": { - "description": "The entities defined in the project.", "type": "array", + "description": "The entities defined in the project.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedEntity" - } + }, + "x-ms-identifiers": [] }, "utterances": { - "description": "The utterances defined in the project.", "type": "array", + "description": "The utterances defined in the project.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedUtterance" - } + }, + "x-ms-identifiers": [] } }, - "x-ms-discriminator-value": "Conversation", - "x-ms-client-name": "ConversationExportedProjectAssets" + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" + } + ], + "x-ms-discriminator-value": "Conversation" }, "ConversationalAnalysisAuthoringConversationExportedUtterance": { - "description": "Represents an exported utterance for a conversational project.", - "required": [ - "text", - "intent" - ], "type": "object", + "description": "Represents an exported utterance for a conversational project.", "properties": { "entities": { - "description": "Represents the entity labels of the utterance.", "type": "array", + "description": "Represents the entity labels of the utterance.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedUtteranceEntityLabel" - } + }, + "x-ms-identifiers": [] }, "text": { - "description": "The utterance text.", - "type": "string" + "type": "string", + "description": "The utterance text." }, "language": { - "description": "Represents the utterance's language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "type": "string", + "description": "Represents the utterance's language. This is BCP-47 representation of a\nlanguage. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for\nSpanish etc." }, "intent": { - "description": "The intent of the utterance.", - "type": "string" + "type": "string", + "description": "The intent of the utterance." }, "dataset": { - "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'.", - "type": "string" - } - }, - "x-ms-client-name": "ConversationExportedUtterance" - }, - "ConversationalAnalysisAuthoringConversationSummarizationExportedProjectAssets": { - "type": "object", - "properties": { - "conversations": { - "description": "Represents the conversations of the project.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringCustomConversationSummarizationConversation" - } + "type": "string", + "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'." } }, - "x-ms-client-name": "ConversationSummarizationExportedProjectAssets" + "required": [ + "text", + "intent" + ] }, "ConversationalAnalysisAuthoringCopyAuthorizationOptions": { - "description": "Represents the options for authorizing a project copy to the current Azure resource.", - "required": [ - "projectKind" - ], "type": "object", + "description": "Represents the options for authorizing a project copy to the current Azure resource.", "properties": { "projectKind": { - "description": "Represents the project kind.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" + "$ref": "#/definitions/ProjectKind", + "description": "Represents the project kind." }, "storageInputContainerName": { - "description": "The name of the storage container.", - "type": "string" + "type": "string", + "description": "The name of the storage container." }, "allowOverwrite": { - "description": "Whether to allow an existing project to be overwritten using the resulting copy authorization.", - "type": "boolean" + "type": "boolean", + "description": "Whether to allow an existing project to be overwritten using the resulting copy authorization." } }, - "x-ms-client-name": "CopyAuthorizationOptions" + "required": [ + "projectKind" + ] }, "ConversationalAnalysisAuthoringCopyProjectJobState": { - "description": "Represents the state of a copy job.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "CopyProjectJobState" + "description": "Represents the state of a copy job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] }, "ConversationalAnalysisAuthoringCopyProjectOptions": { - "description": "Represents the options for copying an existing project to another Azure resource.", - "required": [ - "projectKind", - "targetProjectName", - "accessToken", - "expiresAt", - "targetResourceId", - "targetResourceRegion" - ], "type": "object", + "description": "Represents the options for copying an existing project to another Azure\nresource.", "properties": { "projectKind": { - "description": "Represents the project kind.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" + "$ref": "#/definitions/ProjectKind", + "description": "Represents the project kind." }, "targetProjectName": { - "description": "The project name to be copied-into.", - "type": "string" + "type": "string", + "description": "The project name to be copied-into." }, "accessToken": { - "description": "The access token.", - "type": "string" + "type": "string", + "description": "The access token." }, "expiresAt": { + "type": "string", "format": "date-time", - "description": "The expiration of the access token.", - "type": "string" + "description": "The expiration of the access token." }, "targetResourceId": { - "description": "Represents the target Azure resource ID.", - "type": "string" + "type": "string", + "description": "Represents the target Azure resource ID." }, "targetResourceRegion": { - "description": "Represents the target Azure resource region.", - "type": "string" + "type": "string", + "description": "Represents the target Azure resource region." } }, - "x-ms-client-name": "CopyProjectOptions" + "required": [ + "projectKind", + "targetProjectName", + "accessToken", + "expiresAt", + "targetResourceId", + "targetResourceRegion" + ] }, "ConversationalAnalysisAuthoringCreateDeploymentOptions": { - "description": "Represents the options for creating or updating a project deployment.", - "required": [ - "trainedModelLabel" - ], "type": "object", + "description": "Represents the options for creating or updating a project deployment.", "properties": { "trainedModelLabel": { - "description": "Represents the trained model label.", - "type": "string" + "type": "string", + "description": "Represents the trained model label." }, "assignedResourceIds": { - "description": "Represents the resource IDs to be assigned to the deployment.\n If provided, the deployment will be rolled out to the resources provided here as well as the original resource in which the project is created.", "type": "array", + "description": "Represents the resource IDs to be assigned to the deployment.\nIf provided, the deployment will be rolled out to the resources\nprovided here as well as the original resource in which the project is created.", "items": { "type": "string" } } }, - "x-ms-client-name": "CreateDeploymentOptions" + "required": [ + "trainedModelLabel" + ] }, "ConversationalAnalysisAuthoringCreateProjectOptions": { - "description": "Represents the options used to create or update a project.", - "required": [ - "projectKind", - "projectName", - "language" - ], "type": "object", + "description": "Represents the options used to create or update a project.", "properties": { "projectKind": { - "description": "Represents the project kind.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" + "$ref": "#/definitions/ProjectKind", + "description": "Represents the project kind." }, "settings": { - "description": "The project settings.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings" + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings", + "description": "The project settings." }, "storageInputContainerName": { - "description": "The storage container name in case of conversation summarization.", - "type": "string" + "type": "string", + "description": "The storage container name in case of conversation summarization." }, "projectName": { - "description": "The new project name.", - "type": "string" + "type": "string", + "description": "The new project name." }, "multilingual": { - "description": "Whether the project would be used for multiple languages or not.", - "type": "boolean" + "type": "boolean", + "description": "Whether the project would be used for multiple languages or not." }, "description": { - "description": "The project description.", - "type": "string" + "type": "string", + "description": "The project description." }, "language": { - "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "type": "string", + "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." } }, - "x-ms-client-name": "CreateProjectOptions" - }, - "ConversationalAnalysisAuthoringCustomConversationSummarizationConversation": { - "description": "Represents an exported conversation for a custom conversation summarization.", "required": [ - "location" - ], - "type": "object", - "properties": { - "summaryLocation": { - "type": "string" - }, - "location": { - "description": "Represents the conversation file location in the blob store container associated with the project.", - "type": "string" - }, - "language": { - "description": "Represents the language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "dataset": { - "description": "The dataset for this conversation. Allowed values are 'Train' and 'Test'.", - "type": "string" - } - }, - "x-ms-client-name": "CustomConversationSummarizationConversation" + "projectKind", + "projectName", + "language" + ] }, "ConversationalAnalysisAuthoringDeleteDeploymentOptions": { - "description": "Represents the options for deleting a project deployment.", "type": "object", + "description": "Represents the options for deleting a project deployment.", "properties": { "assignedResourceIds": { - "description": "Represents the resource IDs to delete the deployment from.\n If not provided, the deployment will be rolled out from all the resources it is deployed to.\n If provided, it will delete the deployment only from the specified assigned resources, and leave it for the rest.", "type": "array", + "description": "Represents the resource IDs to delete the deployment from.\nIf not provided, the deployment will be rolled out from all the\nresources it is deployed to.\nIf provided, it will delete the deployment only from the specified\nassigned resources, and leave it for the rest.", "items": { "type": "string" } } + } + }, + "ConversationalAnalysisAuthoringDeploymentDeleteFromResourcesJobState": { + "type": "object", + "description": "Represents the state of an existing delete deployment from specific resources job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] + } }, - "x-ms-client-name": "DeleteDeploymentOptions" + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] }, "ConversationalAnalysisAuthoringDeploymentJobState": { - "description": "Represents the state of a deployment job.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" + "description": "Represents the state of a deployment job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] } - ], - "x-ms-client-name": "DeploymentJobState" + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] }, "ConversationalAnalysisAuthoringDeploymentResource": { - "description": "Represents an Azure resource assigned to a deployment.", - "required": [ - "resourceId", - "region" - ], "type": "object", + "description": "Represents an Azure resource assigned to a deployment.", "properties": { "resourceId": { - "description": "Represents the Azure resource Id.", - "type": "string" + "type": "string", + "description": "Represents the Azure resource Id." }, "region": { - "description": "Represents the resource region.", - "type": "string" + "type": "string", + "description": "Represents the resource region." } }, - "x-ms-client-name": "DeploymentResource" + "required": [ + "resourceId", + "region" + ] }, "ConversationalAnalysisAuthoringDeploymentResourcesJobState": { - "description": "Represents the state of a deployment resources job.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" + "description": "Represents the state of a deployment resources job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] } - ], - "x-ms-client-name": "DeploymentResourcesJobState" + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] }, "ConversationalAnalysisAuthoringEntitiesEvaluationSummary": { - "description": "Represents the evaluation result summary for the project's entities.", - "required": [ - "confusionMatrix", - "entities", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ], "type": "object", + "description": "Represents the evaluation result summary for the project's entities.", "properties": { "confusionMatrix": { - "description": "Represents the confusion matrix between two entities (the two entities can be the same). The matrix is between the entity that was labelled and the entity that was predicted.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix" + "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix", + "description": "Represents the confusion matrix between two entities (the two entities can be\nthe same). The matrix is between the entity that was labelled and the entity\nthat was predicted." }, "entities": { - "description": "Represents the entities evaluation summary.", "type": "object", + "description": "Represents the entities evaluation summary.", "additionalProperties": { "$ref": "#/definitions/ConversationalAnalysisAuthoringEntityEvaluationSummary" } }, "microF1": { + "type": "number", "format": "float", - "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive.", - "type": "number" + "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive." }, "microPrecision": { + "type": "number", "format": "float", - "description": "Represents the micro precision. Expected value is a float between 0 and 1 inclusive.", - "type": "number" + "description": "Represents the micro precision. Expected value is a float between 0 and 1\ninclusive." }, "microRecall": { + "type": "number", "format": "float", - "description": "Represents the micro recall. Expected value is a float between 0 and 1 inclusive.", - "type": "number" + "description": "Represents the micro recall. Expected value is a float between 0 and 1\ninclusive." }, "macroF1": { + "type": "number", "format": "float", - "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive.", - "type": "number" + "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive." }, "macroPrecision": { + "type": "number", "format": "float", - "description": "Represents the macro precision. Expected value is a float between 0 and 1 inclusive.", - "type": "number" + "description": "Represents the macro precision. Expected value is a float between 0 and 1\ninclusive." }, "macroRecall": { + "type": "number", "format": "float", - "description": "Represents the macro recall. Expected value is a float between 0 and 1 inclusive.", - "type": "number" + "description": "Represents the macro recall. Expected value is a float between 0 and 1\ninclusive." } }, - "x-ms-client-name": "EntitiesEvaluationSummary" - }, - "ConversationalAnalysisAuthoringEntityEvaluationSummary": { - "description": "Represents the evaluation result for an entity.", "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ], + "confusionMatrix", + "entities", + "microF1", + "microPrecision", + "microRecall", + "macroF1", + "macroPrecision", + "macroRecall" + ] + }, + "ConversationalAnalysisAuthoringEntityEvaluationSummary": { "type": "object", + "description": "Represents the evaluation result for an entity.", "properties": { "f1": { + "type": "number", "format": "double", - "description": "Represents the model precision", - "type": "number" + "description": "Represents the model precision" }, "precision": { + "type": "number", "format": "double", - "description": "Represents the model recall", - "type": "number" + "description": "Represents the model recall" }, "recall": { + "type": "number", "format": "double", - "description": "Represents the model F1 score", - "type": "number" + "description": "Represents the model F1 score" }, "truePositiveCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of true positive", - "type": "integer" + "description": "Represents the count of true positive" }, "trueNegativeCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of true negative", - "type": "integer" + "description": "Represents the count of true negative" }, "falsePositiveCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of false positive", - "type": "integer" + "description": "Represents the count of false positive" }, "falseNegativeCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of false negative", - "type": "integer" + "description": "Represents the count of false negative" } }, - "x-ms-client-name": "EntityEvaluationSummary" + "required": [ + "f1", + "precision", + "recall", + "truePositiveCount", + "trueNegativeCount", + "falsePositiveCount", + "falseNegativeCount" + ] }, "ConversationalAnalysisAuthoringEvaluationJobResult": { - "required": [ - "evaluationOptions", - "modelLabel", - "trainingConfigVersion", - "percentComplete" - ], "type": "object", "properties": { "evaluationOptions": { - "description": "Represents the options used running the evaluation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions" + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions", + "description": "Represents the options used running the evaluation." }, "modelLabel": { - "description": "Represents trained model label.", - "type": "string" + "type": "string", + "description": "Represents trained model label." }, "trainingConfigVersion": { - "description": "Represents training config version.", - "type": "string" + "type": "string", + "description": "Represents training config version." }, "percentComplete": { + "type": "integer", "format": "int32", - "description": "Represents progress percentage.", - "type": "integer" + "description": "Represents progress percentage." } }, - "x-ms-client-name": "EvaluationJobResult" + "required": [ + "evaluationOptions", + "modelLabel", + "trainingConfigVersion", + "percentComplete" + ] }, "ConversationalAnalysisAuthoringEvaluationJobState": { - "description": "Represents the state of a evaluation job.", - "required": [ - "result" - ], "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], + "description": "Represents the state of a evaluation job.", "properties": { + "jobId": { + "type": "string", + "description": "The job ID." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] + }, "result": { - "description": "Represents evaluation task detailed result.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationJobResult" + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationJobResult", + "description": "Represents evaluation task detailed result." } }, - "x-ms-client-name": "EvaluationJobState" - }, - "ConversationalAnalysisAuthoringEvaluationKind": { - "enum": [ - "percentage", - "manual" - ], - "type": "string", - "x-ms-enum": { - "name": "EvaluationKind", - "modelAsString": true, - "values": [ - { - "value": "percentage", - "description": "Split the data into training and test sets according to user-defined percentages." - }, - { - "value": "manual", - "description": "Split the data according to the chosen dataset for every example in the data." - } - ] - }, - "x-ms-client-name": "EvaluationKind" + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status", + "result" + ] }, "ConversationalAnalysisAuthoringEvaluationOptions": { - "description": "Represents the options used running the evaluation.", "type": "object", + "description": "Represents the options used running the evaluation.", "properties": { "kind": { - "description": "Represents the evaluation kind. By default, the evaluation kind is set to percentage.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationKind" + "$ref": "#/definitions/EvaluationKind", + "description": "Represents the evaluation kind. By default, the evaluation kind is set to\npercentage." }, "trainingSplitPercentage": { + "type": "integer", "format": "int32", - "description": "Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage.", - "type": "integer" + "description": "Represents the training dataset split percentage. Only needed in case the\nevaluation kind is percentage." }, "testingSplitPercentage": { + "type": "integer", "format": "int32", - "description": "Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage.", - "type": "integer" + "description": "Represents the testing dataset split percentage. Only needed in case the\nevaluation kind is percentage." } - }, - "x-ms-client-name": "EvaluationOptions" + } }, - "ConversationalAnalysisAuthoringEvaluationResults": { - "description": "Represent a list of utterances' evaluation results.", - "required": [ - "value", - "nextLink" - ], + "ConversationalAnalysisAuthoringEvaluationSummary": { "type": "object", + "description": "Represents the evaluation result summary.", "properties": { - "value": { - "description": "The utterances evaluation results.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEvaluationResult" - } + "entitiesEvaluation": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringEntitiesEvaluationSummary", + "description": "Contains the data related to entities evaluation." }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true + "intentsEvaluation": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringIntentsEvaluationSummary", + "description": "Contains the data related to intents evaluation." + }, + "evaluationOptions": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions", + "description": "The options that were used while running the evaluation." } }, - "x-ms-client-name": "EvaluationResults" - }, - "ConversationalAnalysisAuthoringEvaluationSummary": { - "description": "Represents the evaluation result summary.", "required": [ "entitiesEvaluation", "intentsEvaluation" - ], + ] + }, + "ConversationalAnalysisAuthoringExportProjectJobState": { "type": "object", + "description": "Represents the state of an export job.", "properties": { - "entitiesEvaluation": { - "description": "Contains the data related to entities evaluation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEntitiesEvaluationSummary" + "jobId": { + "type": "string", + "description": "The job ID." }, - "intentsEvaluation": { - "description": "Contains the data related to intents evaluation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringIntentsEvaluationSummary" + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." }, - "evaluationOptions": { - "description": "The options that were used while running the evaluation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions" + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] + }, + "resultUrl": { + "type": "string", + "description": "The URL to use in order to download the exported project." } }, - "x-ms-client-name": "EvaluationSummary" + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] }, "ConversationalAnalysisAuthoringExportedConversationOrchestration": { - "description": "Defines the orchestration details for a Conversational project target.", - "required": [ - "projectName", - "deploymentName" - ], "type": "object", + "description": "Defines the orchestration details for a Conversational project target.", "properties": { "projectName": { - "description": "The name of the targeted project.", - "type": "string" + "type": "string", + "description": "The name of the targeted project." }, "deploymentName": { - "description": "The name of the targeted deployment.", - "type": "string" + "type": "string", + "description": "The name of the targeted deployment." } }, - "x-ms-client-name": "ExportedConversationOrchestration" + "required": [ + "projectName", + "deploymentName" + ] }, "ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions": { + "type": "object", "description": "Represents the orchestration options for a Conversational project target.", + "properties": { + "conversationOrchestration": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedConversationOrchestration", + "description": "The Conversational project target details." + } + }, "required": [ "conversationOrchestration" ], - "type": "object", "allOf": [ { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" } ], - "properties": { - "conversationOrchestration": { - "description": "The Conversational project target details.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedConversationOrchestration" - } - }, - "x-ms-discriminator-value": "Conversation", - "x-ms-client-name": "ExportedConversationOrchestrationOptions" + "x-ms-discriminator-value": "Conversation" }, "ConversationalAnalysisAuthoringExportedEntityList": { - "description": "Represents a list component of an entity.", "type": "object", + "description": "Represents a list component of an entity.", "properties": { "sublists": { - "description": "The sub-lists of the list component.", "type": "array", + "description": "The sub-lists of the list component.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntitySublist" - } + }, + "x-ms-identifiers": [] } - }, - "x-ms-client-name": "ExportedEntityList" + } }, "ConversationalAnalysisAuthoringExportedEntityListSynonym": { - "description": "Represents a list of synonyms inside a list component", "type": "object", + "description": "Represents a list of synonyms inside a list component", "properties": { "language": { - "description": "Represents the language of the synonyms. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "type": "string", + "description": "Represents the language of the synonyms. This is BCP-47 representation of a\nlanguage. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for\nSpanish etc." }, "values": { - "description": "The list of synonyms.", "type": "array", + "description": "The list of synonyms.", "items": { "type": "string" } } - }, - "x-ms-client-name": "ExportedEntityListSynonym" + } }, "ConversationalAnalysisAuthoringExportedEntityRegex": { - "description": "Represents a regex component of an entity.", "type": "object", + "description": "Represents a regex component of an entity.", "properties": { "expressions": { - "description": "The regex expressions of the regex component. These expressions follow the .NET regex syntax. For reference, check here: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions", "type": "array", + "description": "The regex expressions of the regex component. These expressions follow the .NET\nregex syntax. For reference, check here:\nhttps://learn.microsoft.com/dotnet/standard/base-types/regular-expressions", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityRegexExpression" - } + }, + "x-ms-identifiers": [] } - }, - "x-ms-client-name": "ExportedEntityRegex" + } }, "ConversationalAnalysisAuthoringExportedEntityRegexExpression": { - "description": "Represents a regex expression inside a regex component. This expression follows the .NET regex syntax. For reference, check here: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions", "type": "object", + "description": "Represents a regex expression inside a regex component. This expression follows\nthe .NET regex syntax. For reference, check here:\nhttps://learn.microsoft.com/dotnet/standard/base-types/regular-expressions", "properties": { "regexKey": { - "description": "The key of the regex expression.", - "type": "string" + "type": "string", + "description": "The key of the regex expression." }, "language": { - "description": "Represents the language of the regex expression. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "type": "string", + "description": "Represents the language of the regex expression. This is BCP-47 representation\nof a language. For example, use \"en\" for English, \"en-gb\" for English (UK),\n\"es\" for Spanish etc." }, "regexPattern": { - "description": "The regex pattern.", - "type": "string" + "type": "string", + "description": "The regex pattern." } - }, - "x-ms-client-name": "ExportedEntityRegexExpression" + } }, "ConversationalAnalysisAuthoringExportedEntitySublist": { - "description": "Represents a sub-list inside a list component.", "type": "object", + "description": "Represents a sub-list inside a list component.", "properties": { "listKey": { - "description": "The key of the sub-list.", - "type": "string" + "type": "string", + "description": "The key of the sub-list." }, "synonyms": { - "description": "The phrases of that correspond to the sub-list.", "type": "array", + "description": "The phrases of that correspond to the sub-list.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityListSynonym" - } + }, + "x-ms-identifiers": [] } - }, - "x-ms-client-name": "ExportedEntitySublist" + } }, "ConversationalAnalysisAuthoringExportedLuisOrchestration": { - "description": "Defines the orchestration details for a LUIS application target.", - "required": [ - "appId" - ], "type": "object", + "description": "Defines the orchestration details for a LUIS application target.", "properties": { "appId": { - "format": "uuid", - "description": "The LUIS application ID.", - "type": "string", - "example": "00000000-0000-0000-0000-000000000000" + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The LUIS application ID." }, "appVersion": { - "description": "The targeted version Id.", - "type": "string" + "type": "string", + "description": "The targeted version Id." }, "slotName": { - "description": "The targeted slot name.", - "type": "string" + "type": "string", + "description": "The targeted slot name." } }, - "x-ms-client-name": "ExportedLuisOrchestration" + "required": [ + "appId" + ] }, "ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions": { + "type": "object", "description": "Represents the orchestration options for a LUIS application target.", + "properties": { + "luisOrchestration": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedLuisOrchestration", + "description": "The LUIS application target details." + } + }, "required": [ "luisOrchestration" ], - "type": "object", "allOf": [ { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" } ], - "properties": { - "luisOrchestration": { - "description": "The LUIS application target details.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedLuisOrchestration" - } - }, - "x-ms-discriminator-value": "Luis", - "x-ms-client-name": "ExportedLuisOrchestrationOptions" + "x-ms-discriminator-value": "Luis" }, "ConversationalAnalysisAuthoringExportedOrchestrationOptions": { - "description": "Represents the options used to define the orchestration behavior of an intent.", - "required": [ - "targetProjectKind" - ], "type": "object", + "description": "Represents the options used to define the orchestration behavior of an intent.", "properties": { "targetProjectKind": { - "description": "The kind of the target used in the orchestration flow.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationTargetProjectKind" + "$ref": "#/definitions/OrchestrationTargetProjectKind" } }, "discriminator": "targetProjectKind", - "x-ms-client-name": "ExportedOrchestrationOptions" - }, - "ConversationalAnalysisAuthoringExportedPrebuiltEntity": { - "description": "Represents an exported prebuilt entity component", "required": [ - "category" - ], + "targetProjectKind" + ] + }, + "ConversationalAnalysisAuthoringExportedPrebuiltEntity": { "type": "object", + "description": "Represents an exported prebuilt entity component", "properties": { "category": { - "description": "The prebuilt entity category.", - "type": "string" + "type": "string", + "description": "The prebuilt entity category." } }, - "x-ms-client-name": "ExportedPrebuiltEntity" + "required": [ + "category" + ] }, "ConversationalAnalysisAuthoringExportedProject": { - "description": "Represents an exported project.", - "required": [ - "projectFileVersion", - "stringIndexType", - "metadata" - ], "type": "object", + "description": "Represents an exported project.", "properties": { "projectFileVersion": { - "description": "The version of the exported file.", - "type": "string" + "type": "string", + "description": "The version of the exported file." }, "stringIndexType": { - "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringStringIndexType" + "$ref": "#/definitions/StringIndexType", + "description": "Specifies the method used to interpret string offsets. For additional\ninformation see https://aka.ms/text-analytics-offsets." }, "metadata": { - "description": "Represents the project metadata.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateProjectOptions" + "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateProjectOptions", + "description": "Represents the project metadata." }, "assets": { - "description": "Represents the project assets.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets", + "description": "Represents the project assets." } }, - "x-ms-client-name": "ExportedProject" + "required": [ + "projectFileVersion", + "stringIndexType", + "metadata" + ] }, "ConversationalAnalysisAuthoringExportedProjectAssets": { - "description": "Represents the assets of an exported project.", - "required": [ - "projectKind" - ], "type": "object", + "description": "Represents the assets of an exported project.", "properties": { "projectKind": { - "description": "The type of project containing the assets.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" + "$ref": "#/definitions/ProjectKind", + "description": "The type of project containing the assets." } }, "discriminator": "projectKind", - "x-ms-client-name": "ExportedProjectAssets" - }, - "ConversationalAnalysisAuthoringExportedProjectFormat": { - "enum": [ - "Conversation", - "Luis" - ], - "type": "string", - "x-ms-enum": { - "name": "ExportedProjectFormat", - "modelAsString": true, - "values": [ - { - "value": "Conversation", - "description": "Specifies the format for a conversational project." - }, - { - "value": "Luis", - "description": "Specifies the format for an application that was exported from LUIS." - } - ] - }, - "x-ms-client-name": "ExportedProjectFormat" + "required": [ + "projectKind" + ] }, "ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration": { - "description": "Defines the orchestration details for a Question Answering project target.", - "required": [ - "projectName" - ], "type": "object", + "description": "Defines the orchestration details for a Question Answering project target.", "properties": { "projectName": { - "description": "The name of the target project.", - "type": "string" + "type": "string", + "description": "The name of the target project." } }, - "x-ms-client-name": "ExportedQuestionAnsweringOrchestration" + "required": [ + "projectName" + ] }, "ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions": { + "type": "object", "description": "Represents the orchestration options for a Question Answering project target.", + "properties": { + "questionAnsweringOrchestration": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration", + "description": "The Question Answering project details." + } + }, "required": [ "questionAnsweringOrchestration" ], - "type": "object", "allOf": [ { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" } ], - "properties": { - "questionAnsweringOrchestration": { - "description": "The Question Answering project details.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration" - } - }, - "x-ms-discriminator-value": "QuestionAnswering", - "x-ms-client-name": "ExportedQuestionAnsweringOrchestrationOptions" + "x-ms-discriminator-value": "QuestionAnswering" }, "ConversationalAnalysisAuthoringExportedUtteranceEntityLabel": { - "description": "Represents an entity label for an utterance.", - "required": [ - "category", - "offset", - "length" - ], "type": "object", + "description": "Represents an entity label for an utterance.", "properties": { "category": { - "description": "The category of the entity label.", - "type": "string" + "type": "string", + "description": "The category of the entity label." }, "offset": { + "type": "integer", "format": "int32", - "description": "Start position for the entity text.", - "type": "integer" + "description": "Start position for the entity text." }, "length": { + "type": "integer", "format": "int32", - "description": "Length for the entity text.", - "type": "integer" + "description": "Length for the entity text." } }, - "x-ms-client-name": "ExportedUtteranceEntityLabel" + "required": [ + "category", + "offset", + "length" + ] }, - "ConversationalAnalysisAuthoringExportProjectJobState": { - "description": "Represents the state of an export job.", + "ConversationalAnalysisAuthoringImportProjectJobState": { "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], + "description": "Represents the state of an import job.", "properties": { - "resultUrl": { - "description": "The URL to use in order to download the exported project.", - "type": "string" + "jobId": { + "type": "string", + "description": "The job ID." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] } }, - "x-ms-client-name": "ExportProjectJobState" - }, - "ConversationalAnalysisAuthoringImportProjectJobState": { - "description": "Represents the state of an import job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "ImportProjectJobState" + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] }, "ConversationalAnalysisAuthoringIntentEvaluationSummary": { - "description": "The evaluation summary for an intent.", - "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ], "type": "object", + "description": "The evaluation summary for an intent.", "properties": { "f1": { + "type": "number", "format": "double", - "description": "Represents the model precision", - "type": "number" + "description": "Represents the model precision" }, "precision": { + "type": "number", "format": "double", - "description": "Represents the model recall", - "type": "number" + "description": "Represents the model recall" }, "recall": { + "type": "number", "format": "double", - "description": "Represents the model F1 score", - "type": "number" + "description": "Represents the model F1 score" }, "truePositiveCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of true positive", - "type": "integer" + "description": "Represents the count of true positive" }, "trueNegativeCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of true negative", - "type": "integer" + "description": "Represents the count of true negative" }, "falsePositiveCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of false positive", - "type": "integer" + "description": "Represents the count of false positive" }, "falseNegativeCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of false negative", - "type": "integer" + "description": "Represents the count of false negative" } }, - "x-ms-client-name": "IntentEvaluationSummary" + "required": [ + "f1", + "precision", + "recall", + "truePositiveCount", + "trueNegativeCount", + "falsePositiveCount", + "falseNegativeCount" + ] }, "ConversationalAnalysisAuthoringIntentsEvaluationSummary": { - "description": "Represents the evaluation summary for the project's intents.", - "required": [ - "confusionMatrix", - "intents", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ], "type": "object", + "description": "Represents the evaluation summary for the project's intents.", "properties": { "confusionMatrix": { - "description": "Represents the confusion matrix between two intents (the two intents can be the same). The matrix is between the intent that was labelled and the intent that was predicted.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix" + "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix", + "description": "Represents the confusion matrix between two intents (the two intents can be the\nsame). The matrix is between the intent that was labelled and the intent that\nwas predicted." }, "intents": { - "description": "Represents the intents evaluation summary.", "type": "object", + "description": "Represents the intents evaluation summary.", "additionalProperties": { "$ref": "#/definitions/ConversationalAnalysisAuthoringIntentEvaluationSummary" } }, "microF1": { + "type": "number", "format": "float", - "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive.", - "type": "number" + "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive." }, "microPrecision": { + "type": "number", "format": "float", - "description": "Represents the micro precision. Expected value is a float between 0 and 1 inclusive.", - "type": "number" + "description": "Represents the micro precision. Expected value is a float between 0 and 1\ninclusive." }, "microRecall": { + "type": "number", "format": "float", - "description": "Represents the micro recall. Expected value is a float between 0 and 1 inclusive.", - "type": "number" + "description": "Represents the micro recall. Expected value is a float between 0 and 1\ninclusive." }, "macroF1": { + "type": "number", "format": "float", - "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive.", - "type": "number" + "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive." }, "macroPrecision": { + "type": "number", "format": "float", - "description": "Represents the macro precision. Expected value is a float between 0 and 1 inclusive.", - "type": "number" + "description": "Represents the macro precision. Expected value is a float between 0 and 1\ninclusive." }, "macroRecall": { + "type": "number", "format": "float", - "description": "Represents the macro recall. Expected value is a float between 0 and 1 inclusive.", - "type": "number" + "description": "Represents the macro recall. Expected value is a float between 0 and 1\ninclusive." } }, - "x-ms-client-name": "IntentsEvaluationSummary" - }, - "ConversationalAnalysisAuthoringJobState": { - "description": "Represents a job's state.", "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ], + "confusionMatrix", + "intents", + "microF1", + "microPrecision", + "microRecall", + "macroF1", + "macroPrecision", + "macroRecall" + ] + }, + "ConversationalAnalysisAuthoringLoadSnapshotJobState": { "type": "object", + "description": "Represents the state of loading a snapshot job.", "properties": { "jobId": { - "description": "The job ID.", - "type": "string" + "type": "string", + "description": "The job ID." }, "createdDateTime": { + "type": "string", "format": "date-time", - "description": "The creation date time of the job.", - "type": "string" + "description": "The creation date time of the job." }, "lastUpdatedDateTime": { + "type": "string", "format": "date-time", - "description": "The last date time the job was updated.", - "type": "string" + "description": "The last date time the job was updated." }, "expirationDateTime": { + "type": "string", "format": "date-time", - "description": "The expiration date time of the job.", - "type": "string" + "description": "The expiration date time of the job." }, "status": { - "description": "The job status.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" + "$ref": "#/definitions/JobStatus", + "description": "The job status." }, "warnings": { - "description": "The warnings that were encountered while executing the job.", "type": "array", + "description": "The warnings that were encountered while executing the job.", "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringWarning" - } + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] }, "errors": { - "description": "The errors encountered while executing the job.", "type": "array", + "description": "The errors encountered while executing the job.", "items": { - "$ref": "common.json#/definitions/Error" - } + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] } }, - "x-ms-client-name": "JobState" - }, - "ConversationalAnalysisAuthoringJobStatus": { - "enum": [ - "notStarted", - "running", - "succeeded", - "failed", - "cancelled", - "cancelling", - "partiallyCompleted" - ], - "type": "string", - "x-ms-enum": { - "name": "JobStatus", - "modelAsString": true - }, - "x-ms-client-name": "JobStatus" - }, - "ConversationalAnalysisAuthoringLoadSnapshotJobState": { - "description": "Represents the state of loading a snapshot job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "LoadSnapshotJobState" + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] }, "ConversationalAnalysisAuthoringOrchestrationExportedIntent": { - "description": "Represents an exported intent for an orchestration project.", - "required": [ - "category" - ], "type": "object", + "description": "Represents an exported intent for an orchestration project.", "properties": { "orchestration": { - "description": "Specifies the behavior of this intent in the orchestration flow.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions", + "description": "Specifies the behavior of this intent in the orchestration flow." }, "category": { - "description": "The intent category.", - "type": "string" + "type": "string", + "description": "The intent category." } }, - "x-ms-client-name": "OrchestrationExportedIntent" + "required": [ + "category" + ] }, "ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets": { - "description": "Represents the assets of an orchestration project.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" - } - ], + "description": "Represents the assets of an orchestration project.", "properties": { "intents": { - "description": "Represents the intents of the project.", "type": "array", + "description": "Represents the intents of the project.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationExportedIntent" - } + }, + "x-ms-identifiers": [] }, "utterances": { - "description": "Represents the utterances of the project.", "type": "array", + "description": "Represents the utterances of the project.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationExportedUtterance" - } + }, + "x-ms-identifiers": [] } }, - "x-ms-discriminator-value": "Orchestration", - "x-ms-client-name": "OrchestrationExportedProjectAssets" + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" + } + ], + "x-ms-discriminator-value": "Orchestration" }, "ConversationalAnalysisAuthoringOrchestrationExportedUtterance": { + "type": "object", "description": "Represents an utterance of an orchestration project.", - "required": [ - "text", - "intent" - ], - "type": "object", "properties": { "text": { - "description": "The utterance text.", - "type": "string" + "type": "string", + "description": "The utterance text." }, "language": { - "description": "Represents the utterance's language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "type": "string", + "description": "Represents the utterance's language. This is BCP-47 representation of a\nlanguage. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for\nSpanish etc." }, "intent": { - "description": "The intent of the utterance.", - "type": "string" + "type": "string", + "description": "The intent of the utterance." }, "dataset": { - "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'.", - "type": "string" + "type": "string", + "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'." } }, - "x-ms-client-name": "OrchestrationExportedUtterance" - }, - "ConversationalAnalysisAuthoringOrchestrationTargetProjectKind": { - "enum": [ - "Luis", - "Conversation", - "QuestionAnswering" - ], - "type": "string", - "x-ms-enum": { - "name": "OrchestrationTargetProjectKind", - "modelAsString": true - }, - "x-ms-client-name": "OrchestrationTargetProjectKind" + "required": [ + "text", + "intent" + ] }, "ConversationalAnalysisAuthoringPrebuiltEntities": { - "description": "Represents a list of the retrieved supported prebuilt entities.", - "required": [ - "value", - "nextLink" - ], "type": "object", + "description": "Represents a list of the retrieved supported prebuilt entities.", "properties": { "value": { - "description": "The supported prebuilt entities.", "type": "array", + "description": "The supported prebuilt entities.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringPrebuiltEntity" - } + }, + "x-ms-identifiers": [] }, "nextLink": { - "description": "The next page link.", "type": "string", - "x-nullable": true + "description": "The next page link." } }, - "x-ms-client-name": "PrebuiltEntities" + "required": [ + "value" + ] }, "ConversationalAnalysisAuthoringPrebuiltEntity": { - "description": "Represents a supported prebuilt entity.", - "required": [ - "category", - "description", - "examples" - ], "type": "object", + "description": "Represents a supported prebuilt entity.", "properties": { "category": { - "description": "The prebuilt entity category.", - "type": "string" + "type": "string", + "description": "The prebuilt entity category." }, "description": { - "description": "The description.", - "type": "string" + "type": "string", + "description": "The description." }, "examples": { - "description": "English examples for the entity.", - "type": "string" + "type": "string", + "description": "English examples for the entity." } }, - "x-ms-client-name": "PrebuiltEntity" + "required": [ + "category", + "description", + "examples" + ] }, "ConversationalAnalysisAuthoringProjectDeletionJobState": { - "description": "Represents the state of a project deletion job.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" + "description": "Represents the state of a project deletion job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] } - ], - "x-ms-client-name": "ProjectDeletionJobState" + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] }, "ConversationalAnalysisAuthoringProjectDeployment": { - "description": "Represents a project deployment.", - "required": [ - "deploymentName", - "modelId", - "lastTrainedDateTime", - "lastDeployedDateTime", - "deploymentExpirationDate", - "modelTrainingConfigVersion", - "assignedResources" - ], "type": "object", + "description": "Represents a project deployment.", "properties": { "deploymentName": { - "description": "Represents deployment name.", - "type": "string" + "type": "string", + "description": "Represents deployment name." }, "modelId": { - "description": "Represents deployment modelId.", - "type": "string" + "type": "string", + "description": "Represents deployment modelId." }, "lastTrainedDateTime": { + "type": "string", "format": "date-time", - "description": "Represents deployment last trained time.", - "type": "string" + "description": "Represents deployment last trained time." }, "lastDeployedDateTime": { + "type": "string", "format": "date-time", - "description": "Represents deployment last deployed time.", - "type": "string" + "description": "Represents deployment last deployed time." }, "deploymentExpirationDate": { + "type": "string", "format": "date", - "description": "Represents deployment expiration date in the runtime.", - "type": "string" + "description": "Represents deployment expiration date in the runtime." }, "modelTrainingConfigVersion": { - "description": "Represents model training config version.", - "type": "string" + "type": "string", + "description": "Represents model training config version." }, "assignedResources": { - "description": "Represents the metadata of the assigned Azure resources.", "type": "array", + "description": "Represents the metadata of the assigned Azure resources.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentResource" - } + }, + "x-ms-identifiers": [] } }, - "x-ms-client-name": "ProjectDeployment" - }, - "ConversationalAnalysisAuthoringProjectDeployments": { - "description": "Represents a list of retrieved deployments.", "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of retrieved deployments.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployment" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "ProjectDeployments" - }, - "ConversationalAnalysisAuthoringProjectKind": { - "enum": [ - "Conversation", - "Orchestration", - "CustomConversationSummarization" - ], - "type": "string", - "x-ms-enum": { - "name": "ProjectKind", - "modelAsString": true, - "values": [ - { - "value": "Conversation", - "description": "A project to build natural language into apps, bots, and IoT devices." - }, - { - "value": "Orchestration", - "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." - }, - { - "value": "CustomConversationSummarization", - "description": "A project to build conversation summarization models which are able to summarize long conversations." - } - ] - }, - "x-ms-client-name": "ProjectKind" + "deploymentName", + "modelId", + "lastTrainedDateTime", + "lastDeployedDateTime", + "deploymentExpirationDate", + "modelTrainingConfigVersion", + "assignedResources" + ] }, "ConversationalAnalysisAuthoringProjectMetadata": { - "description": "Represents the metadata of a project.", - "required": [ - "createdDateTime", - "lastModifiedDateTime", - "projectKind", - "projectName", - "language" - ], "type": "object", + "description": "Represents the metadata of a project.", "properties": { "createdDateTime": { + "type": "string", "format": "date-time", - "description": "Represents the project creation datetime.", - "type": "string" + "description": "Represents the project creation datetime." }, "lastModifiedDateTime": { + "type": "string", "format": "date-time", - "description": "Represents the project creation datetime.", - "type": "string" + "description": "Represents the project creation datetime." }, "lastTrainedDateTime": { + "type": "string", "format": "date-time", - "description": "Represents the project last trained datetime.", - "type": "string" + "description": "Represents the project last trained datetime." }, "lastDeployedDateTime": { + "type": "string", "format": "date-time", - "description": "Represents the project last deployed datetime.", - "type": "string" + "description": "Represents the project last deployed datetime." }, "projectKind": { + "$ref": "#/definitions/ProjectKind", "description": "Represents the project kind.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" + "x-ms-mutability": [ + "read", + "create" + ] }, "settings": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings", "description": "The project settings.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings" + "x-ms-mutability": [ + "read", + "create" + ] }, "storageInputContainerName": { + "type": "string", "description": "The storage container name in case of conversation summarization.", - "type": "string" + "x-ms-mutability": [ + "read", + "create" + ] }, "projectName": { + "type": "string", "description": "The new project name.", - "type": "string" + "maxLength": 100, + "x-ms-mutability": [ + "read", + "create" + ] }, "multilingual": { + "type": "boolean", "description": "Whether the project would be used for multiple languages or not.", - "type": "boolean" + "x-ms-mutability": [ + "read", + "create" + ] }, "description": { + "type": "string", "description": "The project description.", - "type": "string" + "x-ms-mutability": [ + "read", + "create" + ] }, "language": { + "type": "string", "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "x-ms-mutability": [ + "read", + "create" + ] } }, - "x-ms-client-name": "ProjectMetadata" + "required": [ + "createdDateTime", + "lastModifiedDateTime", + "projectKind", + "projectName", + "language" + ] }, "ConversationalAnalysisAuthoringProjectSettings": { - "description": "Represents the settings used to define the project behavior.", - "required": [ - "confidenceThreshold" - ], "type": "object", + "description": "Represents the settings used to define the project behavior.", "properties": { "confidenceThreshold": { + "type": "number", "format": "float", - "description": "The threshold of the intent with the highest confidence, at which the prediction will automatically be changed to \"None\". The value of the threshold should be between 0 and 1 inclusive.", - "type": "number" + "description": "The threshold of the intent with the highest confidence, at which the prediction will automatically be changed to \"None\". The value of the threshold should be between 0 and 1 inclusive." } }, - "x-ms-client-name": "ProjectSettings" - }, - "ConversationalAnalysisAuthoringProjectsMetadata": { - "description": "Represents a list of retrieved projects' metadata.", "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of projects.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "ProjectsMetadata" + "confidenceThreshold" + ] }, "ConversationalAnalysisAuthoringProjectTrainedModel": { - "description": "Represents a trained model.", - "required": [ - "label", - "modelId", - "lastTrainedDateTime", - "lastTrainingDurationInSeconds", - "modelExpirationDate", - "modelTrainingConfigVersion", - "hasSnapshot" - ], "type": "object", + "description": "Represents a trained model.", "properties": { "label": { - "description": "The trained model label.", - "type": "string" + "type": "string", + "description": "The trained model label." }, "modelId": { - "description": "The model ID.", - "type": "string" + "type": "string", + "description": "The model ID." }, "lastTrainedDateTime": { + "type": "string", "format": "date-time", - "description": "The last trained date time of the model.", - "type": "string" + "description": "The last trained date time of the model." }, "lastTrainingDurationInSeconds": { + "type": "integer", "format": "int32", - "description": "The duration of the model's last training request in seconds.", - "type": "integer" + "description": "The duration of the model's last training request in seconds." }, "modelExpirationDate": { + "type": "string", "format": "date", - "description": "The model expiration date.", - "type": "string" + "description": "The model expiration date." }, "modelTrainingConfigVersion": { - "description": "The model training config version.", - "type": "string" + "type": "string", + "description": "The model training config version." }, "hasSnapshot": { - "description": "The flag to indicate if the trained model has a snapshot ready.", - "type": "boolean" + "type": "boolean", + "description": "The flag to indicate if the trained model has a snapshot ready." } }, - "x-ms-client-name": "ProjectTrainedModel" - }, - "ConversationalAnalysisAuthoringProjectTrainedModels": { - "description": "Represents a list of retrieved trained models.", "required": [ - "value", - "nextLink" - ], + "label", + "modelId", + "lastTrainedDateTime", + "lastTrainingDurationInSeconds", + "modelExpirationDate", + "modelTrainingConfigVersion", + "hasSnapshot" + ] + }, + "ConversationalAnalysisAuthoringResourceMetadata": { "type": "object", + "description": "Represents metadata for the Azure resource..", "properties": { - "value": { - "description": "The list of trained models.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModel" - } + "azureResourceId": { + "type": "string", + "description": "Represents the Azure resource ID." }, - "nextLink": { - "description": "The next page link.", + "customDomain": { + "type": "string", + "description": "Represents the Azure resource custom domain." + }, + "region": { "type": "string", - "x-nullable": true + "description": "Represents the Azure resource region." } }, - "x-ms-client-name": "ProjectTrainedModels" - }, - "ConversationalAnalysisAuthoringResourceMetadata": { - "description": "Represents metadata for the Azure resource..", "required": [ "azureResourceId", "customDomain", "region" - ], + ] + }, + "ConversationalAnalysisAuthoringSubTrainingJobState": { "type": "object", + "description": "Represents the detailed state of a training sub-operation.", "properties": { - "azureResourceId": { - "description": "Represents the Azure resource ID.", - "type": "string" - }, - "customDomain": { - "description": "Represents the Azure resource custom domain.", - "type": "string" - }, - "region": { - "description": "Represents the Azure resource region.", - "type": "string" - } - }, - "x-ms-client-name": "ResourceMetadata" - }, - "ConversationalAnalysisAuthoringStringIndexType": { - "enum": [ - "Utf16CodeUnit" - ], - "type": "string", - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "value": "Utf16CodeUnit", - "description": "The 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." - } - ] - }, - "x-ms-client-name": "StringIndexType" - }, - "ConversationalAnalysisAuthoringSubTrainingJobState": { - "description": "Represents the detailed state of a training sub-operation.", - "required": [ - "percentComplete", - "status" - ], - "type": "object", - "properties": { - "percentComplete": { - "format": "int32", - "description": "Represents progress percentage.", - "type": "integer" + "percentComplete": { + "type": "integer", + "format": "int32", + "description": "Represents progress percentage." }, "startDateTime": { + "type": "string", "format": "date-time", - "description": "Represents the start date time.", - "type": "string" + "description": "Represents the start date time." }, "endDateTime": { + "type": "string", "format": "date-time", - "description": "Represents the end date time.", - "type": "string" + "description": "Represents the end date time." }, "status": { - "description": "Represents the status of the sub-operation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" + "$ref": "#/definitions/JobStatus", + "description": "Represents the status of the sub-operation." } }, - "x-ms-client-name": "SubTrainingJobState" + "required": [ + "percentComplete", + "status" + ] }, "ConversationalAnalysisAuthoringSupportedLanguage": { - "description": "Represents a supported language.", - "required": [ - "languageName", - "languageCode" - ], "type": "object", + "description": "Represents a supported language.", "properties": { "languageName": { - "description": "The language name.", - "type": "string" + "type": "string", + "description": "The language name." }, "languageCode": { - "description": "The language code. This is BCP-47 representation of a language. For example, \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "type": "string", + "description": "The language code. This is BCP-47 representation of a language. For example,\n\"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." } }, - "x-ms-client-name": "SupportedLanguage" + "required": [ + "languageName", + "languageCode" + ] }, "ConversationalAnalysisAuthoringSupportedLanguages": { - "description": "Represents a list of retrieved languages.", - "required": [ - "value", - "nextLink" - ], "type": "object", + "description": "Represents a list of retrieved languages.", "properties": { "value": { - "description": "The list of the languages.", "type": "array", + "description": "The list of the languages.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringSupportedLanguage" - } + }, + "x-ms-identifiers": [] }, "nextLink": { - "description": "The next page link.", "type": "string", - "x-nullable": true + "description": "The next page link." } }, - "x-ms-client-name": "SupportedLanguages" + "required": [ + "value" + ] }, - "ConversationalAnalysisAuthoringSwapDeploymentsOptions": { - "description": "Represents the options for swapping two deployments together.", + "ConversationalAnalysisAuthoringSwapDeploymentsJobState": { + "type": "object", + "description": "Represents the state of a deployment job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] + } + }, "required": [ - "firstDeploymentName", - "secondDeploymentName" - ], + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] + }, + "ConversationalAnalysisAuthoringSwapDeploymentsOptions": { "type": "object", + "description": "Represents the options for swapping two deployments together.", "properties": { "firstDeploymentName": { - "description": "Represents the first deployment name.", - "type": "string" + "type": "string", + "description": "Represents the first deployment name." }, "secondDeploymentName": { - "description": "Represents the second deployment name.", - "type": "string" + "type": "string", + "description": "Represents the second deployment name." } }, - "x-ms-client-name": "SwapDeploymentsOptions" + "required": [ + "firstDeploymentName", + "secondDeploymentName" + ] }, "ConversationalAnalysisAuthoringTrainingConfigVersion": { - "description": "Represents a training config version.", - "required": [ - "trainingConfigVersion", - "modelExpirationDate" - ], "type": "object", + "description": "Represents a training config version.", "properties": { "trainingConfigVersion": { - "description": "Represents the version of the config.", - "type": "string" + "type": "string", + "description": "Represents the version of the config." }, "modelExpirationDate": { + "type": "string", "format": "date", - "description": "Represents the training config version expiration date.", - "type": "string" + "description": "Represents the training config version expiration date." } }, - "x-ms-client-name": "TrainingConfigVersion" + "required": [ + "trainingConfigVersion", + "modelExpirationDate" + ] }, "ConversationalAnalysisAuthoringTrainingConfigVersions": { - "description": "Represents a list of training config versions.", - "required": [ - "value", - "nextLink" - ], "type": "object", + "description": "Represents a list of training config versions.", "properties": { "value": { - "description": "The list of the training config versions.", "type": "array", + "description": "The list of the training config versions.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingConfigVersion" - } + }, + "x-ms-identifiers": [] }, "nextLink": { - "description": "The next page link.", "type": "string", - "x-nullable": true + "description": "The next page link." } }, - "x-ms-client-name": "TrainingConfigVersions" + "required": [ + "value" + ] }, "ConversationalAnalysisAuthoringTrainingJobOptions": { - "description": "Represents the options for starting a new training job.", - "required": [ - "modelLabel", - "trainingMode" - ], "type": "object", + "description": "Represents the options for starting a new training job.", "properties": { "modelLabel": { - "description": "Represents the output model label.", - "type": "string" + "type": "string", + "description": "Represents the output model label." }, "trainingConfigVersion": { - "description": "Represents training config version. By default, \"latest\" value is used which uses the latest released training config version.", - "type": "string" + "type": "string", + "description": "Represents training config version. By default, \"latest\" value is used which\nuses the latest released training config version." }, "trainingMode": { - "description": "Represents the mode of the training operation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingMode" + "$ref": "#/definitions/TrainingMode", + "description": "Represents the mode of the training operation." }, "evaluationOptions": { - "description": "Represents the evaluation options. By default, the evaluation kind is percentage, with training split percentage as 80, and testing split percentage as 20.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions" + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions", + "description": "Represents the evaluation options. By default, the evaluation kind is\npercentage, with training split percentage as 80, and testing split percentage\nas 20." } }, - "x-ms-client-name": "TrainingJobOptions" - }, - "ConversationalAnalysisAuthoringTrainingJobResult": { - "description": "Represents the output of a training job.", "required": [ "modelLabel", - "trainingConfigVersion", - "trainingStatus" - ], + "trainingMode" + ] + }, + "ConversationalAnalysisAuthoringTrainingJobResult": { "type": "object", + "description": "Represents the output of a training job.", "properties": { "modelLabel": { - "description": "Represents trained model label.", - "type": "string" + "type": "string", + "description": "Represents trained model label." }, "trainingConfigVersion": { - "description": "Represents training config version.", - "type": "string" + "type": "string", + "description": "Represents training config version." }, "trainingMode": { - "description": "Represents the mode of the training operation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingMode" + "$ref": "#/definitions/TrainingMode", + "description": "Represents the mode of the training operation." }, "trainingStatus": { - "description": "Represents the model training status.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState" + "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState", + "description": "Represents the model training status." }, "evaluationStatus": { - "description": "Represents model evaluation status.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState" + "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState", + "description": "Represents model evaluation status." }, "estimatedEndDateTime": { + "type": "string", "format": "date-time", - "description": "Represents the estimated end date time for training and evaluation.", - "type": "string" + "description": "Represents the estimated end date time for training and evaluation." } }, - "x-ms-client-name": "TrainingJobResult" - }, - "ConversationalAnalysisAuthoringTrainingJobs": { - "description": "Represents a list of retrieved training jobs.", "required": [ - "value", - "nextLink" - ], + "modelLabel", + "trainingConfigVersion", + "trainingStatus" + ] + }, + "ConversationalAnalysisAuthoringTrainingJobState": { "type": "object", + "description": "Represents the state of a training job.", "properties": { - "value": { - "description": "The list of jobs.", + "jobId": { + "type": "string", + "description": "The job ID." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { "type": "array", + "description": "The warnings that were encountered while executing the job.", "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobState" - } + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] + }, + "result": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobResult", + "description": "Represents training tasks detailed result." } }, - "x-ms-client-name": "TrainingJobs" - }, - "ConversationalAnalysisAuthoringTrainingJobState": { - "description": "Represents the state of a training job.", "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status", "result" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "properties": { - "result": { - "description": "Represents training tasks detailed result.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobResult" - } - }, - "x-ms-client-name": "TrainingJobState" - }, - "ConversationalAnalysisAuthoringTrainingMode": { - "enum": [ - "advanced", - "standard" - ], - "type": "string", - "x-ms-enum": { - "name": "TrainingMode", - "modelAsString": true, - "values": [ - { - "value": "advanced", - "description": "Trains using fine-tuned neural network transformer models. Can train multilingual projects." - }, - { - "value": "standard", - "description": "Faster training times for quicker iterations." - } - ] - }, - "x-ms-client-name": "TrainingMode" + ] }, "ConversationalAnalysisAuthoringUnassignDeploymentResourcesOptions": { - "description": "Represents the options to unassign Azure resources from a project.", - "required": [ - "assignedResourceIds" - ], "type": "object", + "description": "Represents the options to unassign Azure resources from a project.", "properties": { "assignedResourceIds": { - "description": "Represents the assigned resource IDs to be unassigned.", "type": "array", + "description": "Represents the assigned resource IDs to be unassigned.", "items": { "type": "string" } } }, - "x-ms-client-name": "UnassignDeploymentResourcesOptions" + "required": [ + "assignedResourceIds" + ] }, "ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult": { - "description": "Represents the comparison between the expected and predicted entities for an utterance.", - "required": [ - "expectedEntities", - "predictedEntities" - ], "type": "object", + "description": "Represents the comparison between the expected and predicted entities for an\nutterance.", "properties": { "expectedEntities": { - "description": "Represents the expected entity labels.", "type": "array", + "description": "Represents the expected entity labels.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult" - } + }, + "x-ms-identifiers": [] }, "predictedEntities": { - "description": "Represents the predicted entity labels.", "type": "array", + "description": "Represents the predicted entity labels.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult" - } + }, + "x-ms-identifiers": [] } }, - "x-ms-client-name": "UtteranceEntitiesEvaluationResult" + "required": [ + "expectedEntities", + "predictedEntities" + ] }, "ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult": { + "type": "object", "description": "Represents the evaluation output of an entity label or prediction.", - "required": [ - "category", - "offset", - "length" - ], - "type": "object", "properties": { "category": { - "description": "Represents the entity category.", - "type": "string" + "type": "string", + "description": "Represents the entity category." }, "offset": { + "type": "integer", "format": "int32", - "description": "Represents the entity offset index relative to the original text.", - "type": "integer" + "description": "Represents the entity offset index relative to the original text." }, "length": { + "type": "integer", "format": "int32", - "description": "Represents the entity length.", - "type": "integer" + "description": "Represents the entity length." } }, - "x-ms-client-name": "UtteranceEntityEvaluationResult" + "required": [ + "category", + "offset", + "length" + ] }, "ConversationalAnalysisAuthoringUtteranceEvaluationResult": { - "description": "Represents the evaluation result for an utterance.", - "required": [ - "text", - "language", - "entitiesResult", - "intentsResult" - ], "type": "object", + "description": "Represents the evaluation result for an utterance.", "properties": { "text": { - "description": "Represents the utterance text.", - "type": "string" + "type": "string", + "description": "Represents the utterance text." }, "language": { - "description": "Represents the utterance language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "type": "string", + "description": "Represents the utterance language. This is BCP-47 representation of a language.\nFor example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish\netc." }, "entitiesResult": { - "description": "Represents the entities results for the utterance.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult" + "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult", + "description": "Represents the entities results for the utterance." }, "intentsResult": { - "description": "Represents the intents results for the utterance.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult" + "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult", + "description": "Represents the intents results for the utterance." } }, - "x-ms-client-name": "UtteranceEvaluationResult" + "required": [ + "text", + "language", + "entitiesResult", + "intentsResult" + ] }, "ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult": { - "description": "Represents the comparison between the expected and the predicted intent for an utterance.", - "required": [ - "expectedIntent", - "predictedIntent" - ], "type": "object", + "description": "Represents the comparison between the expected and the predicted intent for an\nutterance.", "properties": { "expectedIntent": { - "description": "Represents the utterance's expected intent.", - "type": "string" + "type": "string", + "description": "Represents the utterance's expected intent." }, "predictedIntent": { - "description": "Represents the utterance's predicted intent.", - "type": "string" + "type": "string", + "description": "Represents the utterance's predicted intent." } }, - "x-ms-client-name": "UtteranceIntentsEvaluationResult" + "required": [ + "expectedIntent", + "predictedIntent" + ] }, - "ConversationalAnalysisAuthoringWarning": { - "description": "Represents a warning that was encountered while executing the request.", + "Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "$ref": "#/definitions/ErrorCode", + "description": "One of a server-defined set of error codes." + }, + "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" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/InnerErrorModel", + "description": "An object containing more specific information than the current object about\nthe error." + } + }, "required": [ "code", "message" + ] + }, + "ErrorCode": { + "type": "string", + "description": "Human-readable error code.", + "enum": [ + "InvalidRequest", + "InvalidArgument", + "Unauthorized", + "Forbidden", + "NotFound", + "ProjectNotFound", + "OperationNotFound", + "AzureCognitiveSearchNotFound", + "AzureCognitiveSearchIndexNotFound", + "TooManyRequests", + "AzureCognitiveSearchThrottling", + "AzureCognitiveSearchIndexLimitReached", + "InternalServerError", + "ServiceUnavailable", + "Timeout", + "QuotaExceeded", + "Conflict", + "Warning" + ], + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true, + "values": [ + { + "name": "InvalidRequest", + "value": "InvalidRequest" + }, + { + "name": "InvalidArgument", + "value": "InvalidArgument" + }, + { + "name": "Unauthorized", + "value": "Unauthorized" + }, + { + "name": "Forbidden", + "value": "Forbidden" + }, + { + "name": "NotFound", + "value": "NotFound" + }, + { + "name": "ProjectNotFound", + "value": "ProjectNotFound" + }, + { + "name": "OperationNotFound", + "value": "OperationNotFound" + }, + { + "name": "AzureCognitiveSearchNotFound", + "value": "AzureCognitiveSearchNotFound" + }, + { + "name": "AzureCognitiveSearchIndexNotFound", + "value": "AzureCognitiveSearchIndexNotFound" + }, + { + "name": "TooManyRequests", + "value": "TooManyRequests" + }, + { + "name": "AzureCognitiveSearchThrottling", + "value": "AzureCognitiveSearchThrottling" + }, + { + "name": "AzureCognitiveSearchIndexLimitReached", + "value": "AzureCognitiveSearchIndexLimitReached" + }, + { + "name": "InternalServerError", + "value": "InternalServerError" + }, + { + "name": "ServiceUnavailable", + "value": "ServiceUnavailable" + }, + { + "name": "Timeout", + "value": "Timeout" + }, + { + "name": "QuotaExceeded", + "value": "QuotaExceeded" + }, + { + "name": "Conflict", + "value": "Conflict" + }, + { + "name": "Warning", + "value": "Warning" + } + ] + } + }, + "ErrorResponse": { + "type": "object", + "description": "Error response.", + "properties": { + "error": { + "$ref": "#/definitions/Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "EvaluationKind": { + "type": "string", + "enum": [ + "percentage", + "manual" + ], + "x-ms-enum": { + "name": "EvaluationKind", + "modelAsString": true, + "values": [ + { + "name": "percentage", + "value": "percentage", + "description": "Split the data into training and test sets according to user-defined\npercentages." + }, + { + "name": "manual", + "value": "manual", + "description": "Split the data according to the chosen dataset for every example in the data." + } + ] + } + }, + "InnerErrorCode": { + "type": "string", + "description": "Human-readable error code.", + "enum": [ + "InvalidRequest", + "InvalidParameterValue", + "KnowledgeBaseNotFound", + "AzureCognitiveSearchNotFound", + "AzureCognitiveSearchThrottling", + "ExtractionFailure", + "InvalidRequestBodyFormat", + "EmptyRequest", + "MissingInputDocuments", + "InvalidDocument", + "ModelVersionIncorrect", + "InvalidDocumentBatch", + "UnsupportedLanguageCode", + "InvalidCountryHint" ], + "x-ms-enum": { + "name": "InnerErrorCode", + "modelAsString": true, + "values": [ + { + "name": "InvalidRequest", + "value": "InvalidRequest" + }, + { + "name": "InvalidParameterValue", + "value": "InvalidParameterValue" + }, + { + "name": "KnowledgeBaseNotFound", + "value": "KnowledgeBaseNotFound" + }, + { + "name": "AzureCognitiveSearchNotFound", + "value": "AzureCognitiveSearchNotFound" + }, + { + "name": "AzureCognitiveSearchThrottling", + "value": "AzureCognitiveSearchThrottling" + }, + { + "name": "ExtractionFailure", + "value": "ExtractionFailure" + }, + { + "name": "InvalidRequestBodyFormat", + "value": "InvalidRequestBodyFormat" + }, + { + "name": "EmptyRequest", + "value": "EmptyRequest" + }, + { + "name": "MissingInputDocuments", + "value": "MissingInputDocuments" + }, + { + "name": "InvalidDocument", + "value": "InvalidDocument" + }, + { + "name": "ModelVersionIncorrect", + "value": "ModelVersionIncorrect" + }, + { + "name": "InvalidDocumentBatch", + "value": "InvalidDocumentBatch" + }, + { + "name": "UnsupportedLanguageCode", + "value": "UnsupportedLanguageCode" + }, + { + "name": "InvalidCountryHint", + "value": "InvalidCountryHint" + } + ] + } + }, + "InnerErrorModel": { "type": "object", + "description": "An object containing more specific information about the error. As per\nMicrosoft One API guidelines -\nhttps://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", "properties": { "code": { - "description": "The warning code.", - "type": "string" + "$ref": "#/definitions/InnerErrorCode", + "description": "One of a server-defined set of error codes." }, "message": { - "description": "The warning message.", - "type": "string" + "type": "string", + "description": "Error message." + }, + "details": { + "type": "object", + "description": "Error details.", + "additionalProperties": { + "type": "string" + } + }, + "target": { + "type": "string", + "description": "Error target." + }, + "innererror": { + "$ref": "#/definitions/InnerErrorModel", + "description": "An object containing more specific information than the current object about\nthe error." } }, - "x-ms-client-name": "Warning" - } - }, - "parameters": { - "ConversationalAnalysisAuthoringFormatQueryOptionalParameter": { - "in": "query", - "name": "format", - "description": "The format of the exported project file to use.", + "required": [ + "code", + "message" + ] + }, + "JobStatus": { "type": "string", "enum": [ - "Conversation", - "Luis" + "notStarted", + "running", + "succeeded", + "failed", + "cancelled", + "cancelling", + "partiallyCompleted" ], "x-ms-enum": { - "name": "ExportedProjectFormat", + "name": "JobStatus", "modelAsString": true, "values": [ { - "value": "Conversation", - "description": "Specifies the format for a conversational project." + "name": "notStarted", + "value": "notStarted" + }, + { + "name": "running", + "value": "running" + }, + { + "name": "succeeded", + "value": "succeeded" }, { - "value": "Luis", - "description": "Specifies the format for an application that was exported from LUIS." + "name": "failed", + "value": "failed" + }, + { + "name": "cancelled", + "value": "cancelled" + }, + { + "name": "cancelling", + "value": "cancelling" + }, + { + "name": "partiallyCompleted", + "value": "partiallyCompleted" } ] - }, - "x-ms-parameter-location": "method" + } }, - "ConversationalAnalysisAuthoringStringIndexTypeQueryParameter": { - "in": "query", - "name": "stringIndexType", - "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "required": true, + "OrchestrationTargetProjectKind": { "type": "string", "enum": [ - "Utf16CodeUnit" + "Luis", + "Conversation", + "QuestionAnswering" ], "x-ms-enum": { - "name": "StringIndexType", + "name": "OrchestrationTargetProjectKind", "modelAsString": true, "values": [ { - "value": "Utf16CodeUnit", - "description": "The 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." + "name": "Luis", + "value": "Luis" + }, + { + "name": "Conversation", + "value": "Conversation" + }, + { + "name": "QuestionAnswering", + "value": "QuestionAnswering" } ] + } + }, + "PagedConversationalAnalysisAuthoringAssignedDeploymentResource": { + "type": "object", + "description": "Paged collection of ConversationalAnalysisAuthoringAssignedDeploymentResource items", + "properties": { + "value": { + "type": "array", + "description": "The ConversationalAnalysisAuthoringAssignedDeploymentResource items on this page", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringAssignedDeploymentResource" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } }, - "x-ms-parameter-location": "method" + "required": [ + "value" + ] }, - "ConversationalAnalysisAuthoringJobIdPathParameter": { - "in": "path", - "name": "jobId", - "description": "The job ID.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" + "PagedConversationalAnalysisAuthoringProjectDeployment": { + "type": "object", + "description": "Paged collection of ConversationalAnalysisAuthoringProjectDeployment items", + "properties": { + "value": { + "type": "array", + "description": "The ConversationalAnalysisAuthoringProjectDeployment items on this page", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployment" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] }, - "ConversationalAnalysisAuthoringTrainedModelLabelPathParameter": { - "in": "path", - "name": "trainedModelLabel", - "description": "The trained model label.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" + "PagedConversationalAnalysisAuthoringProjectMetadata": { + "type": "object", + "description": "Paged collection of ConversationalAnalysisAuthoringProjectMetadata items", + "properties": { + "value": { + "type": "array", + "description": "The ConversationalAnalysisAuthoringProjectMetadata items on this page", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] }, - "ConversationalAnalysisAuthoringProjectKindQueryParameter": { - "in": "query", - "name": "projectKind", - "description": "The project kind.", - "required": true, + "PagedConversationalAnalysisAuthoringProjectTrainedModel": { + "type": "object", + "description": "Paged collection of ConversationalAnalysisAuthoringProjectTrainedModel items", + "properties": { + "value": { + "type": "array", + "description": "The ConversationalAnalysisAuthoringProjectTrainedModel items on this page", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModel" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedConversationalAnalysisAuthoringTrainingJobState": { + "type": "object", + "description": "Paged collection of ConversationalAnalysisAuthoringTrainingJobState items", + "properties": { + "value": { + "type": "array", + "description": "The ConversationalAnalysisAuthoringTrainingJobState items on this page", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobState" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedConversationalAnalysisAuthoringUtteranceEvaluationResult": { + "type": "object", + "description": "Paged collection of ConversationalAnalysisAuthoringUtteranceEvaluationResult items", + "properties": { + "value": { + "type": "array", + "description": "The ConversationalAnalysisAuthoringUtteranceEvaluationResult items on this page", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEvaluationResult" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ProjectKind": { "type": "string", "enum": [ "Conversation", @@ -4263,18 +5082,140 @@ "modelAsString": true, "values": [ { + "name": "Conversation", "value": "Conversation", "description": "A project to build natural language into apps, bots, and IoT devices." }, { + "name": "Orchestration", "value": "Orchestration", "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." }, { + "name": "CustomConversationSummarization", "value": "CustomConversationSummarization", "description": "A project to build conversation summarization models which are able to summarize long conversations." } ] + } + }, + "StringIndexType": { + "type": "string", + "enum": [ + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "The offset and length values will correspond to UTF-16 code units. Use this\noption if your application is written in a language that support Unicode, for\nexample Java, JavaScript." + } + ] + } + }, + "TrainingMode": { + "type": "string", + "enum": [ + "advanced", + "standard" + ], + "x-ms-enum": { + "name": "TrainingMode", + "modelAsString": true, + "values": [ + { + "name": "advanced", + "value": "advanced", + "description": "Trains using fine-tuned neural network transformer models. Can train\nmultilingual projects." + }, + { + "name": "standard", + "value": "standard", + "description": "Faster training times for quicker iterations." + } + ] + } + }, + "Warning": { + "type": "object", + "description": "Represents a warning that was encountered while executing the request.", + "properties": { + "code": { + "type": "string", + "description": "The warning code." + }, + "message": { + "type": "string", + "description": "The warning message." + } + }, + "required": [ + "code", + "message" + ] + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + }, + "Azure.Core.MaxPageSizeQueryParameter": { + "name": "maxpagesize", + "in": "query", + "description": "The maximum number of result items per page.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "Azure.Core.SkipQueryParameter": { + "name": "skip", + "in": "query", + "description": "The number of result items to skip.", + "required": false, + "type": "integer", + "format": "int32", + "default": 0, + "x-ms-parameter-location": "method" + }, + "Azure.Core.TopQueryParameter": { + "name": "top", + "in": "query", + "description": "The number of result items to return.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "StringIndexTypeQueryParameter": { + "name": "stringIndexType", + "in": "query", + "description": "Specifies the method used to interpret string offsets. For additional\ninformation see https://aka.ms/text-analytics-offsets.", + "required": true, + "type": "string", + "enum": [ + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "The offset and length values will correspond to UTF-16 code units. Use this\noption if your application is written in a language that support Unicode, for\nexample Java, JavaScript." + } + ] }, "x-ms-parameter-location": "method" } diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulAssignDeploymentResources.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulAssignDeploymentResources.json new file mode 100644 index 000000000000..b8577067d66b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulAssignDeploymentResources.json @@ -0,0 +1,31 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_AssignDeploymentResources", + "title": "Successful Assign Deployment Resources", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "body": { + "resourcesMetadata": [ + { + "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "customDomain": "lang-test-weu.cognitiveservices.azure.com", + "region": "westeurope" + }, + { + "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", + "customDomain": "lang-test-eus.cognitiveservices.azure.com", + "region": "eastus" + } + ] + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/resources/assign/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCancelTrainingJob.json new file mode 100644 index 000000000000..a87a5e05d24b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCancelTrainingJob.json @@ -0,0 +1,18 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_CancelTrainingJob", + "title": "Successful Cancel Training Job", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCopyProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCopyProject.json new file mode 100644 index 000000000000..3bffe749e1a3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCopyProject.json @@ -0,0 +1,25 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_CopyProject", + "title": "Successful Copy Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "body": { + "projectKind": "Conversation", + "targetProjectName": "EmailApp", + "accessToken": "103fcb47-b095-44c1-aedd-4024a5923275", + "expiresAt": "2023-04-18T13:53:03Z", + "targetResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "targetResourceRegion": "westeurope" + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/copy/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCopyProjectAuthorization.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCopyProjectAuthorization.json new file mode 100644 index 000000000000..559d5a6cbc42 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCopyProjectAuthorization.json @@ -0,0 +1,27 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_CopyProjectAuthorization", + "title": "Successful Copy Project Authorization", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "body": { + "projectKind": "Conversation", + "allowOverwrite": false + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "projectKind": "Conversation", + "targetProjectName": "EmailApp", + "accessToken": "103fcb47-b095-44c1-aedd-4024a5923275", + "expiresAt": "2023-04-18T13:53:03Z", + "targetResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "targetResourceRegion": "westeurope" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCreateProject.json new file mode 100644 index 000000000000..b97424b580db --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCreateProject.json @@ -0,0 +1,46 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_CreateProject", + "title": "Successful Create Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/merge-patch+json", + "api-version": "2023-04-15-preview", + "projectName": "myproject", + "body": { + "projectName": "myproject", + "language": "en", + "projectKind": "Conversation", + "description": "This is a sample conversation project.", + "multilingual": false + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + }, + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "lastTrainedDateTime": "2022-04-18T14:14:28Z", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteDeployment.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteDeployment.json new file mode 100644 index 000000000000..f39bc67461ae --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteDeployment.json @@ -0,0 +1,18 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_DeleteDeployment", + "title": "Successful Delete Deployment", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "deploymentName": "staging" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/staging/jobs/61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteDeploymentFromResources.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteDeploymentFromResources.json new file mode 100644 index 000000000000..1b5cdb84bc8d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteDeploymentFromResources.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_DeleteDeploymentFromResources", + "title": "Successful Delete Deployment From Resources", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "deploymentName": "staging", + "body": { + "assignedResourceIds": [ + "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu" + ] + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/staging/delete-from-resources/jobs/61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteModel.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteModel.json new file mode 100644 index 000000000000..9c02021b969c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteModel.json @@ -0,0 +1,14 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_DeleteTrainedModel", + "title": "Successful Delete Model", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model2" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteProject.json new file mode 100644 index 000000000000..38cc03250ae8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteProject.json @@ -0,0 +1,17 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_DeleteProject", + "title": "Successful Delete Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "myproject" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/global/deletion-jobs/129d3182-625d-496c-bcf9-43686e85160b_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeployProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeployProject.json new file mode 100644 index 000000000000..e50c76314cc4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeployProject.json @@ -0,0 +1,25 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_DeployProject", + "title": "Successful Deploy Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "deploymentName": "production", + "body": { + "trainedModelLabel": "29886710a2ae49259d62cffca977db66", + "assignedResourceIds": [ + "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus" + ] + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/production/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulEvaluationProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulEvaluationProject.json new file mode 100644 index 000000000000..6671e82372c2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulEvaluationProject.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_EvaluateModel", + "title": "Successful Evaluation Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1", + "body": { + "kind": "percentage", + "testingSplitPercentage": 20, + "trainingSplitPercentage": 80 + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/LoanAgreements/models/model1/evaluate/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulExportProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulExportProject.json new file mode 100644 index 000000000000..c23a7eeefb98 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulExportProject.json @@ -0,0 +1,18 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_Export", + "title": "Successful Export Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "stringIndexType": "Utf16CodeUnit" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetAssignDeploymentResourcesStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetAssignDeploymentResourcesStatus.json new file mode 100644 index 000000000000..79fcbc9ccb39 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetAssignDeploymentResourcesStatus.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetAssignDeploymentResourcesStatus", + "title": "Successful Get Assign Deployment Resources Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetCopyProjectStatus.json similarity index 83% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json rename to specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetCopyProjectStatus.json index aa6548d7266f..16ac708cf150 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetCopyProjectStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetCopyProjectStatus", + "title": "Successful Get Copy Project Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetDeployment.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetDeployment.json new file mode 100644 index 000000000000..a26e6fe5fad7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetDeployment.json @@ -0,0 +1,34 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetDeployment", + "title": "Successful Get Deployment", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "deploymentName": "staging" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "deploymentName": "staging", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", + "lastDeployedDateTime": "2022-04-18T15:53:04Z", + "deploymentExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-15-preview", + "assignedResources": [ + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "region": "westeurope" + }, + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", + "region": "eastus" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetDeploymentDeleteFromResourcesStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetDeploymentDeleteFromResourcesStatus.json new file mode 100644 index 000000000000..5d0b5e353b44 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetDeploymentDeleteFromResourcesStatus.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetDeploymentDeleteFromResourcesStatus", + "title": "Successful Get Deployment Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "deploymentName": "production", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetDeploymentStatus.json new file mode 100644 index 000000000000..d065933efcbc --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetDeploymentStatus.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetDeploymentStatus", + "title": "Successful Get Deployment Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "deploymentName": "production", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetEvaluationStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetEvaluationStatus.json new file mode 100644 index 000000000000..42402bfff47f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetEvaluationStatus.json @@ -0,0 +1,34 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetEvaluationStatus", + "title": "Successful Get Evaluation Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "result": { + "evaluationOptions": { + "kind": "percentage", + "trainingSplitPercentage": 60, + "testingSplitPercentage": 40 + }, + "modelLabel": "model1", + "trainingConfigVersion": "2022-05-01", + "percentComplete": 30 + }, + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:45:48Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "running" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetExportStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetExportStatus.json new file mode 100644 index 000000000000..c33e21494512 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetExportStatus.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetExportStatus", + "title": "Successful Get Export Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "resultUrl": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000/result?api-version=2023-04-15-preview", + "jobId": "c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000", + "createdDateTime": "2022-04-18T15:23:07Z", + "lastUpdatedDateTime": "2022-04-18T15:23:08Z", + "expirationDateTime": "2022-04-25T15:23:07Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetImportStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetImportStatus.json new file mode 100644 index 000000000000..0348df4ec820 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetImportStatus.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetImportStatus", + "title": "Successful Get Import Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000", + "createdDateTime": "2022-04-18T15:17:20Z", + "lastUpdatedDateTime": "2022-04-18T15:17:22Z", + "expirationDateTime": "2022-04-25T15:17:20Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetLoadSnapshotStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetLoadSnapshotStatus.json new file mode 100644 index 000000000000..b462a1000dd2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetLoadSnapshotStatus.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetLoadSnapshotStatus", + "title": "Successful Get Load Snapshot Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:45:48Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "running" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetModel.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetModel.json new file mode 100644 index 000000000000..f88377461b06 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetModel.json @@ -0,0 +1,25 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetTrainedModel", + "title": "Successful Get Model", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "label": "model1", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49Z", + "lastTrainingDurationInSeconds": 186, + "modelExpirationDate": "2022-10-28", + "modelTrainingConfigVersion": "2022-05-01", + "hasSnapshot": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetModelEvaluation.json new file mode 100644 index 000000000000..76875d700b52 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetModelEvaluation.json @@ -0,0 +1,286 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationResults", + "title": "Successful Get Model Evaluation", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1", + "stringIndexType": "Utf16CodeUnit", + "maxpagesize": 10 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "text": "send the email", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [], + "predictedEntities": [] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "send a mail to daniel", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 15, + "length": 6 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 15, + "length": 6 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "i forgot to add an important part to that email to james . please set it up to edit", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 51, + "length": 5 + } + ], + "predictedEntities": [ + { + "category": "Category", + "offset": 19, + "length": 9 + }, + { + "category": "ContactName", + "offset": 51, + "length": 5 + } + ] + }, + "intentsResult": { + "expectedIntent": "AddMore", + "predictedIntent": "AddMore" + } + }, + { + "text": "send email to a and tian", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 14, + "length": 1 + }, + { + "category": "ContactName", + "offset": 20, + "length": 4 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 14, + "length": 1 + }, + { + "category": "ContactName", + "offset": 20, + "length": 4 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "send thomas an email", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 5, + "length": 6 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 5, + "length": 6 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "i need to add more to the email message i am sending to vincent", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 56, + "length": 7 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 56, + "length": 7 + } + ] + }, + "intentsResult": { + "expectedIntent": "AddMore", + "predictedIntent": "AddMore" + } + }, + { + "text": "send an email to lily roth and abc123@microsoft.com", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 17, + "length": 9 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 17, + "length": 9 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "i need to add something else to my email to cheryl", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 44, + "length": 6 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 44, + "length": 6 + } + ] + }, + "intentsResult": { + "expectedIntent": "AddMore", + "predictedIntent": "AddMore" + } + }, + { + "text": "send an email to larry , joseph and billy larkson", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 17, + "length": 5 + }, + { + "category": "ContactName", + "offset": 25, + "length": 6 + }, + { + "category": "ContactName", + "offset": 36, + "length": 13 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 17, + "length": 5 + }, + { + "category": "ContactName", + "offset": 25, + "length": 6 + }, + { + "category": "ContactName", + "offset": 36, + "length": 13 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "send mail to dorothy", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 13, + "length": 7 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 13, + "length": 7 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + } + ], + "nextLink": "https://api.example.com/language/authoring/analyze-conversations/projects/EmailApp/models/model1/evaluation/result/?api-version=2023-04-15-preview&top=2147483637&skip=100&maxpagesize=100" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetModelEvaluationSummary.json new file mode 100644 index 000000000000..c72f475a6bb0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetModelEvaluationSummary.json @@ -0,0 +1,528 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationSummary", + "title": "Successful Get Model Evaluation Summary", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "entitiesEvaluation": { + "confusionMatrix": { + "Attachment": { + "Attachment": { + "normalizedValue": 100.0, + "rawValue": 3.0 + } + }, + "Category": { + "Category": { + "normalizedValue": 91.666664, + "rawValue": 11.0 + }, + "$none": { + "normalizedValue": 8.333333, + "rawValue": 1.0 + } + }, + "ContactName": { + "ContactName": { + "normalizedValue": 91.666664, + "rawValue": 22.0 + }, + "SenderName": { + "normalizedValue": 4.1666665, + "rawValue": 1.0 + }, + "$none": { + "normalizedValue": 4.1666665, + "rawValue": 1.0 + } + }, + "Date": { + "Date": { + "normalizedValue": 100.0, + "rawValue": 2.0 + } + }, + "EmailSubject": { + "EmailSubject": { + "normalizedValue": 93.33333, + "rawValue": 9.333334 + }, + "$none": { + "normalizedValue": 6.6666665, + "rawValue": 0.6666667 + } + }, + "FromRelationshipName": { + "FromRelationshipName": { + "normalizedValue": 100.0, + "rawValue": 1.0 + } + }, + "Line": { + "Line": { + "normalizedValue": 100.0, + "rawValue": 2.0 + } + }, + "Message": { + "Message": { + "normalizedValue": 81.2063, + "rawValue": 6.496504 + }, + "EmailSubject": { + "normalizedValue": 7.43007, + "rawValue": 0.5944056 + }, + "$none": { + "normalizedValue": 9.120047, + "rawValue": 0.7296037 + }, + "Date": { + "normalizedValue": 2.2435899, + "rawValue": 0.17948718 + } + }, + "OrderReference": { + "OrderReference": { + "normalizedValue": 100.0, + "rawValue": 17.0 + } + }, + "PositionReference": { + "$none": { + "normalizedValue": 100.0, + "rawValue": 1.0 + } + }, + "RelationshipName": { + "RelationshipName": { + "normalizedValue": 66.666664, + "rawValue": 2.0 + }, + "$none": { + "normalizedValue": 33.333332, + "rawValue": 1.0 + } + }, + "SearchTexts": { + "SearchTexts": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "SenderName": { + "SenderName": { + "normalizedValue": 88.888885, + "rawValue": 8.0 + }, + "ContactName": { + "normalizedValue": 11.111111, + "rawValue": 1.0 + } + }, + "Time": { + "$none": { + "normalizedValue": 100.0, + "rawValue": 2.0 + } + }, + "$none": { + "$none": { + "normalizedValue": 99.739265, + "rawValue": 162.575 + }, + "Category": { + "normalizedValue": 0.2607362, + "rawValue": 0.425 + } + } + }, + "entities": { + "ContactName": { + "f1": 0.9361702799797058, + "precision": 0.95652174949646, + "recall": 0.9166666865348816, + "truePositiveCount": 22, + "trueNegativeCount": 0, + "falsePositiveCount": 1, + "falseNegativeCount": 2 + }, + "Category": { + "f1": 0.8799999952316284, + "precision": 0.8461538553237915, + "recall": 0.9166666865348816, + "truePositiveCount": 11, + "trueNegativeCount": 0, + "falsePositiveCount": 2, + "falseNegativeCount": 1 + }, + "SenderName": { + "f1": 0.8888888955116272, + "precision": 0.8888888955116272, + "recall": 0.8888888955116272, + "truePositiveCount": 8, + "trueNegativeCount": 0, + "falsePositiveCount": 1, + "falseNegativeCount": 1 + }, + "EmailSubject": { + "f1": 0.8181817531585693, + "precision": 0.75, + "recall": 0.8999999761581421, + "truePositiveCount": 9, + "trueNegativeCount": 0, + "falsePositiveCount": 3, + "falseNegativeCount": 1 + }, + "Message": { + "f1": 0.75, + "precision": 0.75, + "recall": 0.75, + "truePositiveCount": 6, + "trueNegativeCount": 0, + "falsePositiveCount": 2, + "falseNegativeCount": 2 + }, + "Date": { + "f1": 0.800000011920929, + "precision": 0.6666666865348816, + "recall": 1.0, + "truePositiveCount": 2, + "trueNegativeCount": 0, + "falsePositiveCount": 1, + "falseNegativeCount": 0 + }, + "OrderReference": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 17, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "SearchTexts": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Attachment": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 3, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "RelationshipName": { + "f1": 0.800000011920929, + "precision": 1.0, + "recall": 0.6666666865348816, + "truePositiveCount": 2, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 1 + }, + "Line": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 2, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Time": { + "f1": 0.0, + "precision": 0.0, + "recall": 0.0, + "truePositiveCount": 0, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 2 + }, + "FromRelationshipName": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 1, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "PositionReference": { + "f1": 0.0, + "precision": 0.0, + "recall": 0.0, + "truePositiveCount": 0, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 1 + } + }, + "microF1": 0.8923077, + "microPrecision": 0.8969072, + "microRecall": 0.8877551, + "macroF1": 0.7766601, + "macroPrecision": 0.7755879, + "macroRecall": 0.78849214 + }, + "intentsEvaluation": { + "confusionMatrix": { + "AddFlag": { + "AddFlag": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "AddMore": { + "AddMore": { + "normalizedValue": 100.0, + "rawValue": 17.0 + } + }, + "Cancel": { + "Cancel": { + "normalizedValue": 100.0, + "rawValue": 9.0 + } + }, + "CheckMessages": { + "CheckMessages": { + "normalizedValue": 100.0, + "rawValue": 9.0 + } + }, + "Confirm": { + "Confirm": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "Delete": { + "Delete": { + "normalizedValue": 100.0, + "rawValue": 5.0 + } + }, + "Forward": { + "Forward": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "None": { + "None": { + "normalizedValue": 100.0, + "rawValue": 1.0 + } + }, + "QueryLastText": { + "QueryLastText": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "ReadAloud": { + "ReadAloud": { + "normalizedValue": 100.0, + "rawValue": 16.0 + } + }, + "Reply": { + "Reply": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "SearchMessages": { + "SearchMessages": { + "normalizedValue": 100.0, + "rawValue": 9.0 + } + }, + "SendEmail": { + "SendEmail": { + "normalizedValue": 100.0, + "rawValue": 20.0 + } + }, + "ShowNext": { + "ShowNext": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "ShowPrevious": { + "ShowPrevious": { + "normalizedValue": 100.0, + "rawValue": 3.0 + } + } + }, + "intents": { + "AddMore": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 17, + "trueNegativeCount": 104, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Cancel": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 9, + "trueNegativeCount": 112, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "SendEmail": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 20, + "trueNegativeCount": 101, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "CheckMessages": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 9, + "trueNegativeCount": 112, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "AddFlag": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Reply": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "ReadAloud": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 16, + "trueNegativeCount": 105, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "QueryLastText": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "SearchMessages": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 9, + "trueNegativeCount": 112, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Delete": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 5, + "trueNegativeCount": 116, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Forward": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Confirm": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 117, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "ShowNext": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 117, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "ShowPrevious": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 3, + "trueNegativeCount": 118, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "None": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 1, + "trueNegativeCount": 120, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + } + }, + "microF1": 1.0, + "microPrecision": 1.0, + "microRecall": 1.0, + "macroF1": 1.0, + "macroPrecision": 1.0, + "macroRecall": 1.0 + }, + "evaluationOptions": { + "kind": "percentage", + "trainingSplitPercentage": 80, + "testingSplitPercentage": 20 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetProject.json new file mode 100644 index 000000000000..a94bb114d32d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetProject.json @@ -0,0 +1,26 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetProject", + "title": "Successful Get Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "myproject" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "lastTrainedDateTime": "2022-04-18T14:14:28Z", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetProjectDeletionStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetProjectDeletionStatus.json new file mode 100644 index 000000000000..811552fb4422 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetProjectDeletionStatus.json @@ -0,0 +1,22 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetProjectDeletionStatus", + "title": "Successful Get Project Deletion Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000", + "createdDateTime": "2022-04-18T14:02:34Z", + "lastUpdatedDateTime": "2022-04-18T14:02:34Z", + "expirationDateTime": "2022-04-25T14:02:34Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSupportedLanguages.json new file mode 100644 index 000000000000..7899bc7d77a7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSupportedLanguages.json @@ -0,0 +1,400 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetSupportedLanguages", + "title": "Successful Get Supported Languages", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectKind": "Conversation" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "languageName": "English", + "languageCode": "en" + }, + { + "languageName": "English", + "languageCode": "en-us" + }, + { + "languageName": "English (UK)", + "languageCode": "en-gb" + }, + { + "languageName": "French", + "languageCode": "fr" + }, + { + "languageName": "Italian", + "languageCode": "it" + }, + { + "languageName": "Spanish", + "languageCode": "es" + }, + { + "languageName": "German", + "languageCode": "de" + }, + { + "languageName": "Portuguese (Brazil)", + "languageCode": "pt-br" + }, + { + "languageName": "Portuguese (Portugal)", + "languageCode": "pt-pt" + }, + { + "languageName": "Chinese (Simplified)", + "languageCode": "zh-hans" + }, + { + "languageName": "Japanese", + "languageCode": "ja" + }, + { + "languageName": "Korean", + "languageCode": "ko" + }, + { + "languageName": "Dutch", + "languageCode": "nl" + }, + { + "languageName": "Hindi", + "languageCode": "hi" + }, + { + "languageName": "Turkish", + "languageCode": "tr" + }, + { + "languageName": "Gujarati", + "languageCode": "gu" + }, + { + "languageName": "Marathi", + "languageCode": "mr" + }, + { + "languageName": "Tamil", + "languageCode": "ta" + }, + { + "languageName": "Telugu", + "languageCode": "te" + }, + { + "languageName": "Zulu", + "languageCode": "zu" + }, + { + "languageName": "Afrikaans", + "languageCode": "af" + }, + { + "languageName": "Amharic", + "languageCode": "am" + }, + { + "languageName": "Arabic", + "languageCode": "ar" + }, + { + "languageName": "Assamese", + "languageCode": "as" + }, + { + "languageName": "Azerbaijani", + "languageCode": "az" + }, + { + "languageName": "Belarusian", + "languageCode": "be" + }, + { + "languageName": "Bulgarian", + "languageCode": "bg" + }, + { + "languageName": "Breton", + "languageCode": "br" + }, + { + "languageName": "Bosnian", + "languageCode": "bs" + }, + { + "languageName": "Catalan", + "languageCode": "ca" + }, + { + "languageName": "Czech", + "languageCode": "cs" + }, + { + "languageName": "Welsh", + "languageCode": "cy" + }, + { + "languageName": "Danish", + "languageCode": "da" + }, + { + "languageName": "Greek", + "languageCode": "el" + }, + { + "languageName": "Esperanto", + "languageCode": "eo" + }, + { + "languageName": "Estonian", + "languageCode": "et" + }, + { + "languageName": "Basque", + "languageCode": "eu" + }, + { + "languageName": "Persian", + "languageCode": "fa" + }, + { + "languageName": "Finnish", + "languageCode": "fi" + }, + { + "languageName": "Western Frisian", + "languageCode": "fy" + }, + { + "languageName": "Irish", + "languageCode": "ga" + }, + { + "languageName": "Scottish Gaelic", + "languageCode": "gd" + }, + { + "languageName": "Galician", + "languageCode": "gl" + }, + { + "languageName": "Hausa", + "languageCode": "ha" + }, + { + "languageName": "Hebrew", + "languageCode": "he" + }, + { + "languageName": "Croatian", + "languageCode": "hr" + }, + { + "languageName": "Hungarian", + "languageCode": "hu" + }, + { + "languageName": "Armenian", + "languageCode": "hy" + }, + { + "languageName": "Indonesian", + "languageCode": "id" + }, + { + "languageName": "Javanese", + "languageCode": "jv" + }, + { + "languageName": "Georgian", + "languageCode": "ka" + }, + { + "languageName": "Kazakh", + "languageCode": "kk" + }, + { + "languageName": "Khmer", + "languageCode": "km" + }, + { + "languageName": "Kannada", + "languageCode": "kn" + }, + { + "languageName": "Kurdish (Kurmanji)", + "languageCode": "ku" + }, + { + "languageName": "Kyrgyz", + "languageCode": "ky" + }, + { + "languageName": "Latin", + "languageCode": "la" + }, + { + "languageName": "Lao", + "languageCode": "lo" + }, + { + "languageName": "Lithuanian", + "languageCode": "lt" + }, + { + "languageName": "Latvian", + "languageCode": "lv" + }, + { + "languageName": "Malagasy", + "languageCode": "mg" + }, + { + "languageName": "Macedonian", + "languageCode": "mk" + }, + { + "languageName": "Malayalam", + "languageCode": "ml" + }, + { + "languageName": "Mongolian", + "languageCode": "mn" + }, + { + "languageName": "Malay", + "languageCode": "ms" + }, + { + "languageName": "Burmese", + "languageCode": "my" + }, + { + "languageName": "Nepali", + "languageCode": "ne" + }, + { + "languageName": "Norwegian (Bokmal)", + "languageCode": "nb" + }, + { + "languageName": "Odia", + "languageCode": "or" + }, + { + "languageName": "Punjabi", + "languageCode": "pa" + }, + { + "languageName": "Polish", + "languageCode": "pl" + }, + { + "languageName": "Pashto", + "languageCode": "ps" + }, + { + "languageName": "Romanian", + "languageCode": "ro" + }, + { + "languageName": "Russian", + "languageCode": "ru" + }, + { + "languageName": "Sanskrit", + "languageCode": "sa" + }, + { + "languageName": "Sindhi", + "languageCode": "sd" + }, + { + "languageName": "Sinhala", + "languageCode": "si" + }, + { + "languageName": "Slovak", + "languageCode": "sk" + }, + { + "languageName": "Slovenian", + "languageCode": "sl" + }, + { + "languageName": "Somali", + "languageCode": "so" + }, + { + "languageName": "Albanian", + "languageCode": "sq" + }, + { + "languageName": "Serbian", + "languageCode": "sr" + }, + { + "languageName": "Sundanese", + "languageCode": "su" + }, + { + "languageName": "Swedish", + "languageCode": "sv" + }, + { + "languageName": "Swahili", + "languageCode": "sw" + }, + { + "languageName": "Thai", + "languageCode": "th" + }, + { + "languageName": "Filipino", + "languageCode": "tl" + }, + { + "languageName": "Uyghur", + "languageCode": "ug" + }, + { + "languageName": "Ukrainian", + "languageCode": "uk" + }, + { + "languageName": "Urdu", + "languageCode": "ur" + }, + { + "languageName": "Uzbek", + "languageCode": "uz" + }, + { + "languageName": "Vietnamese", + "languageCode": "vi" + }, + { + "languageName": "Xhosa", + "languageCode": "xh" + }, + { + "languageName": "Yiddish", + "languageCode": "yi" + }, + { + "languageName": "Chinese (Traditional)", + "languageCode": "zh-hant" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSupportedPrebuiltEntities.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSupportedPrebuiltEntities.json new file mode 100644 index 000000000000..a1e8e439638e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSupportedPrebuiltEntities.json @@ -0,0 +1,100 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetSupportedPrebuiltEntities", + "title": "Successful Get Supported Prebuilt Entities", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "language": "en" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "category": "Person.Name", + "description": "Name of an individual", + "examples": "john, Sam, Lisa" + }, + { + "category": "General.Event", + "description": "Important events", + "examples": "World War two, Covid 19" + }, + { + "category": "General.Organization", + "description": "Companies and corporations", + "examples": "Microsoft, Amazon" + }, + { + "category": "Choice.Boolean", + "description": "boolean choice", + "examples": "yes, no, agreed" + }, + { + "category": "Quantity.Age", + "description": "Age of a person or thing", + "examples": "10-month-old, 19 years old, 58 year-old" + }, + { + "category": "Quantity.NumberRange", + "description": "a numeric interval", + "examples": "between 25 and 35, 25-35" + }, + { + "category": "Quantity.Number", + "description": "A cardinal number in numeric or text form", + "examples": "ten, forty two, 3.141, 10K" + }, + { + "category": "Quantity.Percentage", + "description": "A percentage, using the symbol % or the word \"percent\"", + "examples": "10%, 5.6 percent" + }, + { + "category": "Quantity.Ordinal", + "description": "An ordinal number in numeric or text form", + "examples": "first, second, tenth, 1st, 2nd, 10th" + }, + { + "category": "Quantity.Dimension", + "description": "Spacial dimensions, including length, distance, area, and volume", + "examples": "2 miles, 650 square kilometres, 9,350 feet" + }, + { + "category": "Quantity.Temperature", + "description": "A temperature in celsius or fahrenheit", + "examples": "32F, 34 degrees celsius, 2 deg C" + }, + { + "category": "Quantity.Currency", + "description": "Monetary amounts, including currency", + "examples": "1000.00 US dollars, £20.00, $ 67.5 B" + }, + { + "category": "DateTime", + "description": "exact date values", + "examples": "May 11th" + }, + { + "category": "Email", + "description": "Email addresses", + "examples": "user@example.net, user_name@example.com, user.Name12@example.net" + }, + { + "category": "Phone Number", + "description": "US phone numbers", + "examples": "123-456-7890, +1 123 456 789, (123)456-789" + }, + { + "category": "URL", + "description": "Websites URLs and links", + "examples": "www.example.com, http://example.net?name=my_name&age=10" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSupportedTrainingConfigVersions.json new file mode 100644 index 000000000000..67633ed31525 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSupportedTrainingConfigVersions.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_ListTrainingConfigVersions", + "title": "Successful Get Supported Training Config Versions", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectKind": "Conversation" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "trainingConfigVersion": "2022-05-01", + "modelExpirationDate": "2022-10-28" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSwapDeploymentsStatus.json new file mode 100644 index 000000000000..5acc8e3f9682 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSwapDeploymentsStatus.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetSwapDeploymentsStatus", + "title": "Successful Get Swap Deployments Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000", + "createdDateTime": "2022-04-18T16:09:50Z", + "lastUpdatedDateTime": "2022-04-18T16:09:58Z", + "expirationDateTime": "2022-04-25T16:09:50Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetTrainStatus.json new file mode 100644 index 000000000000..f906c7ce7db4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetTrainStatus.json @@ -0,0 +1,38 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetTrainingStatus", + "title": "Successful Get Train Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "result": { + "modelLabel": "model1", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "standard", + "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z", + "trainingStatus": { + "percentComplete": 3, + "startDateTime": "2022-04-18T15:45:06.8190649Z", + "status": "running" + }, + "evaluationStatus": { + "percentComplete": 0, + "status": "notStarted" + } + }, + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:45:48Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "running" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetUnassignDeploymentResourcesStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetUnassignDeploymentResourcesStatus.json new file mode 100644 index 000000000000..070f83815b28 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetUnassignDeploymentResourcesStatus.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetUnassignDeploymentResourcesStatus", + "title": "Successful Get Unassign Deployment Resources Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulImportProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulImportProject.json new file mode 100644 index 000000000000..162fe542788a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulImportProject.json @@ -0,0 +1,80 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_Import", + "title": "Successful Import Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "body": { + "projectFileVersion": "2022-05-01", + "stringIndexType": "Utf16CodeUnit", + "metadata": { + "projectKind": "Conversation", + "settings": { + "confidenceThreshold": 0.7 + }, + "projectName": "EmailApp", + "multilingual": true, + "description": "Trying out CLU", + "language": "en-us" + }, + "assets": { + "projectKind": "Conversation", + "intents": [ + { + "category": "Read" + }, + { + "category": "Delete" + } + ], + "entities": [ + { + "category": "Sender" + }, + { + "category": "Number", + "regex": { + "expressions": [ + { + "regexKey": "UK Phone numbers", + "language": "en-us", + "regexPattern": "/^\\(?([0-9]{3})\\)?[-.\\s]?([0-9]{3})[-.\\s]?([0-9]{4})$/" + } + ] + } + } + ], + "utterances": [ + { + "text": "Open Blake's email", + "dataset": "Train", + "intent": "Read", + "entities": [ + { + "category": "Sender", + "offset": 5, + "length": 5 + } + ] + }, + { + "text": "Delete last email", + "language": "en-gb", + "dataset": "Test", + "intent": "Delete", + "entities": [] + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListAssignedResourceDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListAssignedResourceDeployments.json new file mode 100644 index 000000000000..a6a825669663 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListAssignedResourceDeployments.json @@ -0,0 +1,28 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_ListAssignedResourceDeployments", + "title": "Successful List Assigned Resource Deployments", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "projectName": "Booking", + "deploymentsMetadata": [ + { + "deploymentName": "staging", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", + "deploymentExpirationDate": "2023-10-28" + } + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListDeploymentResources.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListDeploymentResources.json new file mode 100644 index 000000000000..0d43121bc1b1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListDeploymentResources.json @@ -0,0 +1,27 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_ListDeploymentResources", + "title": "Successful List Deployment Resources", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "region": "westeurope" + }, + { + "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", + "region": "eastus" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListDeployments.json new file mode 100644 index 000000000000..5d285673c9d9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListDeployments.json @@ -0,0 +1,51 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_ListDeployments", + "title": "Successful List Deployments", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "deploymentName": "production", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", + "lastDeployedDateTime": "2022-04-18T16:03:51Z", + "deploymentExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-01", + "assignedResources": [ + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "region": "westeurope" + }, + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", + "region": "eastus" + } + ] + }, + { + "deploymentName": "staging", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", + "lastDeployedDateTime": "2022-04-18T15:53:04Z", + "deploymentExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-01", + "assignedResources": [ + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "region": "westeurope" + } + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListModels.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListModels.json new file mode 100644 index 000000000000..b8f3ea2f2997 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListModels.json @@ -0,0 +1,38 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_ListTrainedModels", + "title": "Successful List Models", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "label": "model1", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49Z", + "lastTrainingDurationInSeconds": 186, + "modelExpirationDate": "2022-10-28", + "modelTrainingConfigVersion": "2022-05-01", + "hasSnapshot": true + }, + { + "label": "model2", + "modelId": "model2-20220418T052522-c63bd244dd9e4bf8adec1a7129968c99", + "lastTrainedDateTime": "2022-04-18T17:25:22Z", + "lastTrainingDurationInSeconds": 192, + "modelExpirationDate": "2022-10-28", + "modelTrainingConfigVersion": "2022-05-01", + "hasSnapshot": true + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListProjects.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListProjects.json new file mode 100644 index 000000000000..78aaca5ce95d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListProjects.json @@ -0,0 +1,37 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_ListProjects", + "title": "Successful List Projects", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "createdDateTime": "2022-04-18T14:03:16Z", + "lastModifiedDateTime": "2022-04-18T14:03:16Z", + "projectKind": "Conversation", + "projectName": "myproject1", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + }, + { + "createdDateTime": "2022-04-18T14:03:12Z", + "lastModifiedDateTime": "2022-04-18T14:03:12Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListTrainingJobs.json new file mode 100644 index 000000000000..b09d2909bb85 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListTrainingJobs.json @@ -0,0 +1,92 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_ListTrainingJobs", + "title": "Successful List Training Jobs", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "result": { + "modelLabel": "model1", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "advanced", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T15:45:06.8190649Z", + "endDateTime": "2022-04-18T15:47:19.2639682Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T15:47:19.2734976Z", + "endDateTime": "2022-04-18T15:47:23.8378892Z", + "status": "succeeded" + } + }, + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:47:50Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "succeeded" + }, + { + "result": { + "modelLabel": "model2", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "standard", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:22:39.3663023Z", + "endDateTime": "2022-04-18T17:24:51.9440947Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:24:51.9571747Z", + "endDateTime": "2022-04-18T17:24:58.1427823Z", + "status": "succeeded" + } + }, + "jobId": "9145f93f-6f37-418c-8527-d2ded84cece0_637858368000000000", + "createdDateTime": "2022-04-18T17:22:11Z", + "lastUpdatedDateTime": "2022-04-18T17:25:23Z", + "expirationDateTime": "2022-04-25T17:22:11Z", + "status": "succeeded" + }, + { + "result": { + "modelLabel": "model2", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "standard", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:44:41.388358Z", + "endDateTime": "2022-04-18T17:50:29.5675101Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:50:29.5808461Z", + "endDateTime": "2022-04-18T17:50:35.3482185Z", + "status": "succeeded" + } + }, + "jobId": "ee23c900-354d-4b6d-96e1-8197db2bd5f7_637858368000000000", + "createdDateTime": "2022-04-18T17:44:04Z", + "lastUpdatedDateTime": "2022-04-18T17:51:11Z", + "expirationDateTime": "2022-04-25T17:44:04Z", + "status": "succeeded" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulLoadSnapshot.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulLoadSnapshot.json new file mode 100644 index 000000000000..56580a2abafb --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulLoadSnapshot.json @@ -0,0 +1,18 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_LoadSnapshot", + "title": "Successful Load Snapshot", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/models/model1/load-snapshot/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulSwapDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulSwapDeployments.json new file mode 100644 index 000000000000..c1a56e4c4962 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulSwapDeployments.json @@ -0,0 +1,21 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_SwapDeployments", + "title": "Successful Swap Deployments", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "body": { + "firstDeploymentName": "production", + "secondDeploymentName": "staging" + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/swap/jobs/c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulTrainProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulTrainProject.json new file mode 100644 index 000000000000..cb70afa30274 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulTrainProject.json @@ -0,0 +1,27 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_Train", + "title": "Successful Train Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "body": { + "modelLabel": "model1", + "trainingMode": "standard", + "trainingConfigVersion": "latest", + "evaluationOptions": { + "kind": "percentage", + "testingSplitPercentage": 20, + "trainingSplitPercentage": 80 + } + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulUnassignDeploymentResources.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulUnassignDeploymentResources.json new file mode 100644 index 000000000000..d2d38edbbc3d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulUnassignDeploymentResources.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_UnassignDeploymentResources", + "title": "Successful Unassign Deployment Resources", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "deploymentName": "production", + "body": { + "assignedResourceIds": [ + "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu" + ] + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/resources/unassign/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/analyzeconversations-authoring.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/analyzeconversations-authoring.json index 78906d295c9a..29e06dce5769 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/analyzeconversations-authoring.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/analyzeconversations-authoring.json @@ -3,212 +3,239 @@ "info": { "title": "Microsoft Cognitive Language Service - Analyze Conversations Authoring", "version": "2023-04-01", - "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 <a href=\"https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview\">https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview</a>." - }, - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default" + "description": "The language service API is a suite of natural language processing (NLP) skills\nbuilt with best-in-class Microsoft machine learning algorithms. The API can be\nused to analyze unstructured text for tasks such as sentiment analysis, key\nphrase extraction, language detection and question answering. Further\ndocumentation can be found in <a\nhref=\"https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview\">https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview</a>.The language service conversations API is a suite of natural language processing (NLP) skills that can be used to analyze structured conversations (textual or spoken). The synchronous API in this suite accepts a request and mediates among multiple language projects, such as LUIS Generally Available, Question Answering, Conversational Language Understanding, and then calls the best candidate service to handle the request. At last, it returns a response with the candidate service's response as a payload.\\n\\n In some cases, this API needs to forward requests and responses between the caller and an upstream service. The asynchronous APIs in this suite enable tasks like Conversation Summarization and Conversational PII detection.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" } - }, - "apim_key": { - "type": "apiKey", - "description": "A subscription key for a Language service resource.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } + ] }, - "security": [ - { - "AADToken": [ - "https://cognitiveservices.azure.com/.default" - ] - }, - { - "apim_key": [] - } + "schemes": [ + "https" ], "x-ms-parameterized-host": { "hostTemplate": "{Endpoint}/language", "useSchemePrefix": false, "parameters": [ { - "$ref": "common.json#/parameters/Endpoint" + "name": "endpoint", + "in": "path", + "description": "Supported Cognitive Services endpoint (e.g.,\nhttps://<resource-name>.api.cognitiveservices.azure.com).", + "required": true, + "type": "string" + }, + { + "name": "Endpoint", + "in": "path", + "required": true, + "type": "string" } ] }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "ApiKeyAuth": [] + }, + { + "OAuth2Auth": [ + "https://cognitiveservices.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + }, + "OAuth2Auth": { + "type": "oauth2", + "flow": "accessCode", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://cognitiveservices.azure.com/.default": "" + }, + "tokenUrl": "https://login.microsoftonline.com/common/oauth2/token" + } + }, + "tags": [], "paths": { "/authoring/analyze-conversations/projects": { "get": { - "description": "Lists the existing projects.", "operationId": "ConversationalAnalysisAuthoring_ListProjects", - "produces": [ - "application/json" - ], + "description": "Lists the existing projects.", "parameters": [ { - "$ref": "common.json#/parameters/TopParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/SkipParameter" + "$ref": "#/parameters/Azure.Core.TopQueryParameter" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" } ], "responses": { "200": { - "description": "The metadata of projects.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectsMetadata" + "$ref": "#/definitions/PagedConversationalAnalysisAuthoringProjectMetadata" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful List Projects": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListProjects.json" + "$ref": "./examples/SuccessfulListProjects.json" } }, "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" + "nextLinkName": "nextLink" } } }, "/authoring/analyze-conversations/projects/{projectName}": { - "patch": { - "description": "Creates a new project or updates an existing one.", - "operationId": "ConversationalAnalysisAuthoring_CreateProject", - "consumes": [ - "application/merge-patch+json" - ], - "produces": [ - "application/json" - ], + "get": { + "operationId": "ConversationalAnalysisAuthoring_GetProject", + "description": "Gets the details of a project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "in": "body", - "name": "body", - "description": "The project parameters.", + "name": "projectName", + "in": "path", + "description": "The new project name.", "required": true, - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateProjectOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" + "type": "string", + "maxLength": 100 } ], "responses": { "200": { - "description": "The metadata of the updated project, if it already exists.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" - } - }, - "201": { - "description": "The metadata of the created project.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Successful Create Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCreateProject.json" + "Successful Get Project": { + "$ref": "./examples/SuccessfulGetProject.json" } } }, - "get": { - "description": "Gets the details of a project.", - "operationId": "ConversationalAnalysisAuthoring_GetProject", - "produces": [ - "application/json" + "patch": { + "operationId": "ConversationalAnalysisAuthoring_CreateProject", + "description": "Creates a new project or updates an existing one.", + "consumes": [ + "application/merge-patch+json" ], "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "body", + "in": "body", + "description": "The request body", + "required": true, + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateProjectOptions" + } } ], "responses": { "200": { - "description": "The metadata of the project.", + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Successful Get Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProject.json" + "Successful Create Project": { + "$ref": "./examples/SuccessfulCreateProject.json" } } }, "delete": { - "description": "Deletes a project.", "operationId": "ConversationalAnalysisAuthoring_DeleteProject", - "produces": [ - "application/json" - ], + "description": "Deletes a project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Delete Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteProject.json" + "$ref": "./examples/SuccessfulDeleteProject.json" } }, "x-ms-long-running-operation": true @@ -216,59 +243,105 @@ }, "/authoring/analyze-conversations/projects/{projectName}/:export": { "post": { - "description": "Triggers a job to export a project's data.", "operationId": "ConversationalAnalysisAuthoring_Export", - "produces": [ - "application/json" - ], + "description": "Triggers a job to export a project's data.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringFormatQueryOptionalParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringStringIndexTypeQueryParameter" + "name": "format", + "in": "query", + "description": "The format of the exported project file to use.", + "required": false, + "type": "string", + "enum": [ + "Conversation", + "Luis" + ], + "x-ms-enum": { + "name": "ExportedProjectFormat", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "Specifies the format for a conversational project." + }, + { + "name": "Luis", + "value": "Luis", + "description": "Specifies the format for an application that was exported from LUIS." + } + ] + }, + "x-ms-client-name": "ExportedProjectFormat" + }, + { + "name": "stringIndexType", + "in": "query", + "description": "Specifies the method used to interpret string offsets. For additional\ninformation see https://aka.ms/text-analytics-offsets.", + "required": true, + "type": "string", + "enum": [ + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "The offset and length values will correspond to UTF-16 code units. Use this\noption if your application is written in a language that support Unicode, for\nexample Java, JavaScript." + } + ] + } }, { - "in": "query", "name": "assetKind", + "in": "query", "description": "Kind of asset to export.", - "type": "string", - "x-ms-parameter-location": "method" + "required": false, + "type": "string" }, { - "in": "query", "name": "trainedModelLabel", + "in": "query", "description": "Trained model label to export. If the trainedModelLabel is null, the default behavior is to export the current working copy.", - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" + "required": false, + "type": "string" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Export Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulExportProject.json" + "$ref": "./examples/SuccessfulExportProject.json" } }, "x-ms-long-running-operation": true @@ -276,54 +349,79 @@ }, "/authoring/analyze-conversations/projects/{projectName}/:import": { "post": { - "description": "Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.", "operationId": "ConversationalAnalysisAuthoring_Import", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "description": "Triggers a job to import a project. If a project with the same name already\nexists, the data of that project is replaced.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringFormatQueryOptionalParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "format", + "in": "query", + "description": "The format of the exported project file to use.", + "required": false, + "type": "string", + "enum": [ + "Conversation", + "Luis" + ], + "x-ms-enum": { + "name": "ExportedProjectFormat", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "Specifies the format for a conversational project." + }, + { + "name": "Luis", + "value": "Luis", + "description": "Specifies the format for an application that was exported from LUIS." + } + ] + }, + "x-ms-client-name": "ExportedProjectFormat" }, { - "in": "body", "name": "body", + "in": "body", "description": "The project data to import.", "required": true, "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProject" } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Import Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulImportProject.json" + "$ref": "./examples/SuccessfulImportProject.json" } }, "x-ms-long-running-operation": true @@ -331,51 +429,51 @@ }, "/authoring/analyze-conversations/projects/{projectName}/:train": { "post": { - "description": "Triggers a training job for a project.", "operationId": "ConversationalAnalysisAuthoring_Train", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "description": "Triggers a training job for a project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "in": "body", "name": "body", + "in": "body", "description": "The training input parameters.", "required": true, "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobOptions" } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Train Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulTrainProject.json" + "$ref": "./examples/SuccessfulTrainProject.json" } }, "x-ms-long-running-operation": true @@ -383,233 +481,199 @@ }, "/authoring/analyze-conversations/projects/{projectName}/deployments": { "get": { - "description": "Lists the deployments belonging to a project.", "operationId": "ConversationalAnalysisAuthoring_ListDeployments", - "produces": [ - "application/json" - ], + "description": "Lists the deployments belonging to a project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/TopParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/SkipParameter" + "$ref": "#/parameters/Azure.Core.TopQueryParameter" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" } ], "responses": { "200": { - "description": "List of all deployments.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployments" + "$ref": "#/definitions/PagedConversationalAnalysisAuthoringProjectDeployment" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful List Deployments": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListDeployments.json" + "$ref": "./examples/SuccessfulListDeployments.json" } }, "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" + "nextLinkName": "nextLink" } } }, - "/authoring/analyze-conversations/projects/{projectName}/deployments/:swap": { - "post": { - "description": "Swaps two existing deployments with each other.", - "operationId": "ConversationalAnalysisAuthoring_SwapDeployments", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The job object to swap two deployments.", - "required": true, - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringSwapDeploymentsOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Swap Deployments": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json" - } - }, - "x-ms-long-running-operation": true - } - }, "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}": { "get": { - "description": "Gets the details of a deployment.", "operationId": "ConversationalAnalysisAuthoring_GetDeployment", - "produces": [ - "application/json" - ], + "description": "Gets the details of a deployment.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "deploymentName", + "in": "path", + "description": "Represents deployment name.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The Deployment info.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployment" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Deployment": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeployment.json" + "$ref": "./examples/SuccessfulGetDeployment.json" } } }, "put": { - "description": "Creates a new deployment or replaces an existing one.", "operationId": "ConversationalAnalysisAuthoring_DeployProject", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "description": "Creates a new deployment or replaces an existing one.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the specific deployment of the project to use.", + "required": true, + "type": "string" }, { - "in": "body", "name": "body", + "in": "body", "description": "The new deployment info.", "required": true, "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateDeploymentOptions" } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Deploy Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeployProject.json" + "$ref": "./examples/SuccessfulDeployProject.json" } }, "x-ms-long-running-operation": true }, "delete": { - "description": "Deletes a project deployment.", "operationId": "ConversationalAnalysisAuthoring_DeleteDeployment", - "produces": [ - "application/json" - ], + "description": "Deletes a project deployment.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "deploymentName", + "in": "path", + "description": "The name of the specific deployment of the project to use.", + "required": true, + "type": "string" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Delete Deployment": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json" + "$ref": "./examples/SuccessfulDeleteDeployment.json" } }, "x-ms-long-running-operation": true @@ -617,323 +681,423 @@ }, "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { "get": { - "description": "Gets the status of an existing deployment job.", "operationId": "ConversationalAnalysisAuthoring_GetDeploymentStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status of an existing deployment job.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "deploymentName", + "in": "path", + "description": "Represents deployment name.", + "required": true, + "type": "string" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The deployment job result.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Deployment Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json" + "$ref": "./examples/SuccessfulGetDeploymentStatus.json" } } } }, - "/authoring/analyze-conversations/projects/{projectName}/deployments/swap/jobs/{jobId}": { - "get": { - "description": "Gets the status of an existing swap deployment job.", - "operationId": "ConversationalAnalysisAuthoring_GetSwapDeploymentsStatus", - "produces": [ - "application/json" - ], + "/authoring/analyze-conversations/projects/{projectName}/deployments/:swap": { + "post": { + "operationId": "ConversationalAnalysisAuthoring_SwapDeployments", + "description": "Swaps two existing deployments with each other.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "body", + "in": "body", + "description": "The job object to swap two deployments.", + "required": true, + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringSwapDeploymentsOptions" + } } ], "responses": { - "200": { - "description": "The swap deployment job result.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentJobState" + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Successful Get Swap Deployments Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json" + "Successful Swap Deployments": { + "$ref": "./examples/SuccessfulSwapDeployments.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/deployments/swap/jobs/{jobId}": { + "get": { + "operationId": "ConversationalAnalysisAuthoring_GetSwapDeploymentsStatus", + "description": "Gets the status of an existing swap deployment job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringSwapDeploymentsJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Swap Deployments Status": { + "$ref": "./examples/SuccessfulGetSwapDeploymentsStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/export/jobs/{jobId}": { "get": { - "description": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.", "operationId": "ConversationalAnalysisAuthoring_GetExportStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status of an export job. Once job completes, returns the project\nmetadata, and assets.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The status of the long running operation.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportProjectJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Export Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json" + "$ref": "./examples/SuccessfulGetExportStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/import/jobs/{jobId}": { "get": { - "description": "Gets the status for an import.", "operationId": "ConversationalAnalysisAuthoring_GetImportStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status for an import.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The details of the long running operation.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringImportProjectJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Import Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json" + "$ref": "./examples/SuccessfulGetImportStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/models": { "get": { - "description": "Lists the trained models belonging to a project.", "operationId": "ConversationalAnalysisAuthoring_ListTrainedModels", - "produces": [ - "application/json" - ], + "description": "Lists the trained models belonging to a project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/TopParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/SkipParameter" + "$ref": "#/parameters/Azure.Core.TopQueryParameter" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" } ], "responses": { "200": { - "description": "List of all trained models.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModels" + "$ref": "#/definitions/PagedConversationalAnalysisAuthoringProjectTrainedModel" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful List Models": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListModels.json" + "$ref": "./examples/SuccessfulListModels.json" } }, "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" + "nextLinkName": "nextLink" } } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}": { "get": { - "description": "Gets the details of a trained model.", "operationId": "ConversationalAnalysisAuthoring_GetTrainedModel", - "produces": [ - "application/json" - ], + "description": "Gets the details of a trained model.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "Trained model info", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModel" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Model": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModel.json" + "$ref": "./examples/SuccessfulGetModel.json" } } }, "delete": { - "description": "Deletes an existing trained model.", "operationId": "ConversationalAnalysisAuthoring_DeleteTrainedModel", - "produces": [ - "application/json" - ], + "description": "Deletes an existing trained model.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" } ], "responses": { "204": { - "description": "Deleted successfully." + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Delete Model": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteModel.json" + "$ref": "./examples/SuccessfulDeleteModel.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:load-snapshot": { "post": { - "description": "Restores the snapshot of this trained model to be the current working directory of the project.", "operationId": "ConversationalAnalysisAuthoring_LoadSnapshot", - "produces": [ - "application/json" - ], + "description": "Restores the snapshot of this trained model to be the current working directory\nof the project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" } ], "responses": { "202": { - "description": "A successful call results in loading the working directory with the snapshot of the model provided.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Load Snapshot": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json" + "$ref": "./examples/SuccessfulLoadSnapshot.json" } }, "x-ms-long-running-operation": true @@ -941,266 +1105,301 @@ }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/result": { "get": { - "description": "Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process.", "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationResults", - "produces": [ - "application/json" - ], + "description": "Gets the detailed results of the evaluation for a trained model. This includes\nthe raw inference results for the data included in the evaluation process.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringStringIndexTypeQueryParameter" + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" }, { - "$ref": "common.json#/parameters/TopParameter" + "$ref": "#/parameters/Azure.Core.TopQueryParameter" }, { - "$ref": "common.json#/parameters/SkipParameter" + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/StringIndexTypeQueryParameter" } ], "responses": { "200": { - "description": "List of the evaluation predictions.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationResults" + "$ref": "#/definitions/PagedConversationalAnalysisAuthoringUtteranceEvaluationResult" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Model Evaluation": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json" + "$ref": "./examples/SuccessfulGetModelEvaluation.json" } }, "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" + "nextLinkName": "nextLink" } } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { "get": { - "description": "Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc.", "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationSummary", - "produces": [ - "application/json" - ], + "description": "Gets the evaluation summary of a trained model. The summary includes high level\nperformance measurements of the model e.g., F1, Precision, Recall, etc.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "List of all evaluation results.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationSummary" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Model Evaluation Summary": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json" + "$ref": "./examples/SuccessfulGetModelEvaluationSummary.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/load-snapshot/jobs/{jobId}": { "get": { - "description": "Gets the status for loading a snapshot.", "operationId": "ConversationalAnalysisAuthoring_GetLoadSnapshotStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status for loading a snapshot.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The details of the long running operation.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringLoadSnapshotJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Load Snapshot Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json" + "$ref": "./examples/SuccessfulGetLoadSnapshotStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/train/jobs": { "get": { - "description": "Lists the non-expired training jobs created for a project.", "operationId": "ConversationalAnalysisAuthoring_ListTrainingJobs", - "produces": [ - "application/json" - ], + "description": "Lists the non-expired training jobs created for a project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/TopParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/SkipParameter" + "$ref": "#/parameters/Azure.Core.TopQueryParameter" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" } ], "responses": { "200": { - "description": "List of the training jobs.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobs" + "$ref": "#/definitions/PagedConversationalAnalysisAuthoringTrainingJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful List Training Jobs": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json" + "$ref": "./examples/SuccessfulListTrainingJobs.json" } }, "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" + "nextLinkName": "nextLink" } } }, "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}": { "get": { - "description": "Gets the status for a training job.", "operationId": "ConversationalAnalysisAuthoring_GetTrainingStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status for a training job.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The training job result.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Train Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json" + "$ref": "./examples/SuccessfulGetTrainStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}/:cancel": { "post": { - "description": "Triggers a cancellation for a running training job.", "operationId": "ConversationalAnalysisAuthoring_CancelTrainingJob", - "produces": [ - "application/json" - ], + "description": "Triggers a cancellation for a running training job.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the job cancellation.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Cancel Training Job": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json" + "$ref": "./examples/SuccessfulCancelTrainingJob.json" } }, "x-ms-long-running-operation": true @@ -1208,2003 +1407,2498 @@ }, "/authoring/analyze-conversations/projects/global/deletion-jobs/{jobId}": { "get": { - "description": "Gets the status for a project deletion job.", "operationId": "ConversationalAnalysisAuthoring_GetProjectDeletionStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status for a project deletion job.", "parameters": [ { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The project deletion job result.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeletionJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Project Deletion Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json" + "$ref": "./examples/SuccessfulGetProjectDeletionStatus.json" } } } }, "/authoring/analyze-conversations/projects/global/languages": { "get": { - "description": "Lists the supported languages for the given project type.", "operationId": "ConversationalAnalysisAuthoring_GetSupportedLanguages", - "produces": [ - "application/json" - ], + "description": "Lists the supported languages for the given project type.", "parameters": [ { - "$ref": "#/parameters/ConversationalAnalysisAuthoringProjectKindQueryParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/SkipParameter" + "name": "projectKind", + "in": "query", + "description": "The project kind.", + "required": true, + "type": "string", + "enum": [ + "Conversation", + "Orchestration" + ], + "x-ms-enum": { + "name": "ProjectKind", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "A project to build natural language into apps, bots, and IoT devices." + }, + { + "name": "Orchestration", + "value": "Orchestration", + "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." + } + ] + }, + "x-ms-client-name": "ProjectKind" + }, + { + "name": "top", + "in": "query", + "description": "The maximum number of resources to return from the collection.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "name": "skip", + "in": "query", + "description": "An offset into the collection of the first resource to be returned.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "maxpagesize", + "in": "query", + "description": "The maximum number of resources to include in a single response.", + "required": false, + "type": "integer", + "format": "int32" } ], "responses": { "200": { - "description": "The list of supported languages.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringSupportedLanguages" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Successful Supported Languages": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json" + "Successful Get Supported Languages": { + "$ref": "./examples/SuccessfulGetSupportedLanguages.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" } } }, "/authoring/analyze-conversations/projects/global/prebuilt-entities": { "get": { - "description": "Lists the supported prebuilt entities that can be used while creating composed entities.", "operationId": "ConversationalAnalysisAuthoring_GetSupportedPrebuiltEntities", - "produces": [ - "application/json" - ], + "description": "Lists the supported prebuilt entities that can be used while creating composed\nentities.", "parameters": [ { - "in": "query", - "name": "language", - "description": "The language to get supported prebuilt entities for. Required if multilingual is false. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string", - "x-ms-parameter-location": "method" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { + "name": "language", "in": "query", - "name": "multilingual", - "description": "Whether to get the support prebuilt entities for multilingual or monolingual projects. If true, the language parameter is ignored.", - "type": "string", - "x-ms-parameter-location": "method" + "description": "The language to get supported prebuilt entities for. Required if multilingual\nis false. This is BCP-47 representation of a language. For example, use \"en\"\nfor English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "required": false, + "type": "string" }, { - "$ref": "common.json#/parameters/TopParameter" + "name": "multilingual", + "in": "query", + "description": "Whether to get the support prebuilt entities for multilingual or monolingual\nprojects. If true, the language parameter is ignored.", + "required": false, + "type": "string" }, { - "$ref": "common.json#/parameters/SkipParameter" + "name": "top", + "in": "query", + "description": "The maximum number of resources to return from the collection.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "name": "skip", + "in": "query", + "description": "An offset into the collection of the first resource to be returned.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "maxpagesize", + "in": "query", + "description": "The maximum number of resources to include in a single response.", + "required": false, + "type": "integer", + "format": "int32" } ], "responses": { "200": { - "description": "The list of supported prebuilt entities.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringPrebuiltEntities" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Supported Prebuilt Entities": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json" + "$ref": "./examples/SuccessfulGetSupportedPrebuiltEntities.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" } } }, "/authoring/analyze-conversations/projects/global/training-config-versions": { "get": { - "description": "Lists the support training config version for a given project type.", "operationId": "ConversationalAnalysisAuthoring_ListTrainingConfigVersions", - "produces": [ - "application/json" - ], + "description": "Lists the support training config version for a given project type.", "parameters": [ { - "$ref": "#/parameters/ConversationalAnalysisAuthoringProjectKindQueryParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/SkipParameter" + "name": "projectKind", + "in": "query", + "description": "The project kind.", + "required": true, + "type": "string", + "enum": [ + "Conversation", + "Orchestration" + ], + "x-ms-enum": { + "name": "ProjectKind", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "A project to build natural language into apps, bots, and IoT devices." + }, + { + "name": "Orchestration", + "value": "Orchestration", + "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." + } + ] + }, + "x-ms-client-name": "ProjectKind" + }, + { + "name": "top", + "in": "query", + "description": "The maximum number of resources to return from the collection.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "name": "skip", + "in": "query", + "description": "An offset into the collection of the first resource to be returned.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "maxpagesize", + "in": "query", + "description": "The maximum number of resources to include in a single response.", + "required": false, + "type": "integer", + "format": "int32" } ], "responses": { "200": { - "description": "List of config versions.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingConfigVersions" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Supported Training Config Versions": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json" + "$ref": "./examples/SuccessfulGetSupportedTrainingConfigVersions.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" } } } }, "definitions": { - "ConversationalAnalysisAuthoringCompositionSetting": { + "Azure.Core.uuid": { + "type": "string", + "format": "uuid", + "description": "Universally Unique Identifier" + }, + "CompositionSetting": { + "type": "string", "enum": [ "returnLongestOverlap", "requireExactOverlap", "separateComponents", "combineComponents" ], - "type": "string", "x-ms-enum": { "name": "CompositionSetting", "modelAsString": true, "values": [ { + "name": "returnLongestOverlap", "value": "returnLongestOverlap", - "description": "When two or more components are found in the text and overlap, the component with the longest set of characters is returned." + "description": "When two or more components are found in the text and overlap, the component\nwith the longest set of characters is returned." }, { + "name": "requireExactOverlap", "value": "requireExactOverlap", - "description": "All components must overlap at the exact same characters in the text for the entity to return. If one of the defined components is not matched or predicted, the entity will not return." + "description": "All components must overlap at the exact same characters in the text for the\nentity to return. If one of the defined components is not matched or predicted,\nthe entity will not return." }, { + "name": "separateComponents", "value": "separateComponents", - "description": "Every component's match or prediction is returned as a separate instance of the entity." + "description": "Every component's match or prediction is returned as a separate instance of the\nentity." }, { + "name": "combineComponents", "value": "combineComponents", - "description": "When two or more components are found in the text and overlap, the components' spans are merged together into one span combining all of them." + "description": "When two or more components are found in the text and overlap, the components'\nspans are merged together into one span combining all of them." } ] - }, - "x-ms-client-name": "CompositionSetting" + } }, "ConversationalAnalysisAuthoringConfusionMatrix": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrixRow" - }, - "x-ms-client-name": "ConfusionMatrix" + } }, "ConversationalAnalysisAuthoringConfusionMatrixCell": { - "description": "Represents a cell in a confusion matrix.", - "required": [ - "normalizedValue", - "rawValue" - ], "type": "object", + "description": "Represents a cell in a confusion matrix.", "properties": { "normalizedValue": { + "type": "number", "format": "float", - "description": "Represents normalized value in percentages.", - "type": "number" + "description": "Represents normalized value in percentages." }, "rawValue": { + "type": "number", "format": "float", - "description": "Represents raw value.", - "type": "number" + "description": "Represents raw value." } }, - "x-ms-client-name": "ConfusionMatrixCell" + "required": [ + "normalizedValue", + "rawValue" + ] }, "ConversationalAnalysisAuthoringConfusionMatrixRow": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrixCell" - }, - "x-ms-client-name": "ConfusionMatrixRow" + } }, "ConversationalAnalysisAuthoringConversationExportedEntity": { - "description": "Represents an entity with its components.", - "required": [ - "category" - ], "type": "object", + "description": "Represents an entity with its components.", "properties": { "category": { - "description": "The category of the entity.", - "type": "string" + "type": "string", + "description": "The category of the entity." }, "compositionSetting": { - "description": "The behavior to follow when the entity's components overlap with each other.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringCompositionSetting" + "$ref": "#/definitions/CompositionSetting", + "description": "The behavior to follow when the entity's components overlap with each other." }, "list": { - "description": "The list component of the entity.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityList" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityList", + "description": "The list component of the entity." }, "prebuilts": { - "description": "The prebuilt entities components.", "type": "array", + "description": "The prebuilt entities components.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedPrebuiltEntity" - } + }, + "x-ms-identifiers": [] }, "regex": { - "description": "The regex component of the entity.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityRegex" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityRegex", + "description": "The regex component of the entity." }, "requiredComponents": { - "description": "The required components. Allowed values are 'learned', 'list', 'prebuilts' and 'regex'.", "type": "array", + "description": "The required components. Allowed values are 'learned', 'list', 'prebuilts' and 'regex'.", "items": { "type": "string" } } }, - "x-ms-client-name": "ConversationExportedEntity" - }, - "ConversationalAnalysisAuthoringConversationExportedIntent": { - "description": "Represents an exported intent of a conversational project.", "required": [ "category" - ], + ] + }, + "ConversationalAnalysisAuthoringConversationExportedIntent": { "type": "object", + "description": "Represents an exported intent of a conversational project.", "properties": { "category": { - "description": "The intent category.", - "type": "string" + "type": "string", + "description": "The intent category." } }, - "x-ms-client-name": "ConversationExportedIntent" + "required": [ + "category" + ] }, "ConversationalAnalysisAuthoringConversationExportedProjectAssets": { - "description": "Represents the exported assets of a conversational project.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" - } - ], + "description": "Represents the exported assets of a conversational project.", "properties": { "intents": { - "description": "The intents defined in the project.", "type": "array", + "description": "The intents defined in the project.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedIntent" - } + }, + "x-ms-identifiers": [] }, "entities": { - "description": "The entities defined in the project.", "type": "array", + "description": "The entities defined in the project.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedEntity" - } + }, + "x-ms-identifiers": [] }, "utterances": { - "description": "The utterances defined in the project.", "type": "array", + "description": "The utterances defined in the project.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedUtterance" - } + }, + "x-ms-identifiers": [] } }, - "x-ms-discriminator-value": "Conversation", - "x-ms-client-name": "ConversationExportedProjectAssets" + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" + } + ], + "x-ms-discriminator-value": "Conversation" }, "ConversationalAnalysisAuthoringConversationExportedUtterance": { - "description": "Represents an exported utterance for a conversational project.", - "required": [ - "text", - "intent" - ], "type": "object", + "description": "Represents an exported utterance for a conversational project.", "properties": { "entities": { - "description": "Represents the entity labels of the utterance.", "type": "array", + "description": "Represents the entity labels of the utterance.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedUtteranceEntityLabel" - } + }, + "x-ms-identifiers": [] }, "text": { - "description": "The utterance text.", - "type": "string" + "type": "string", + "description": "The utterance text." }, "language": { - "description": "Represents the utterance's language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "type": "string", + "description": "Represents the utterance's language. This is BCP-47 representation of a\nlanguage. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for\nSpanish etc." }, "intent": { - "description": "The intent of the utterance.", - "type": "string" + "type": "string", + "description": "The intent of the utterance." }, "dataset": { - "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'.", - "type": "string" + "type": "string", + "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'." } }, - "x-ms-client-name": "ConversationExportedUtterance" + "required": [ + "text", + "intent" + ] }, "ConversationalAnalysisAuthoringCreateDeploymentOptions": { - "description": "Represents the options for creating or updating a project deployment.", - "required": [ - "trainedModelLabel" - ], "type": "object", + "description": "Represents the options for creating or updating a project deployment.", "properties": { "trainedModelLabel": { - "description": "Represents the trained model label.", - "type": "string" + "type": "string", + "description": "Represents the trained model label." } }, - "x-ms-client-name": "CreateDeploymentOptions" + "required": [ + "trainedModelLabel" + ] }, "ConversationalAnalysisAuthoringCreateProjectOptions": { + "type": "object", "description": "Represents the options used to create or update a project.", - "required": [ - "projectKind", - "projectName", - "language" - ], - "type": "object", "properties": { "projectKind": { - "description": "Represents the project kind.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" + "$ref": "#/definitions/ProjectKind", + "description": "Represents the project kind." }, "settings": { - "description": "The project settings.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings" + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings", + "description": "The project settings." }, "projectName": { - "description": "The new project name.", - "type": "string" + "type": "string", + "description": "The new project name." }, "multilingual": { - "description": "Whether the project would be used for multiple languages or not.", - "type": "boolean" + "type": "boolean", + "description": "Whether the project would be used for multiple languages or not." }, "description": { - "description": "The project description.", - "type": "string" + "type": "string", + "description": "The project description." }, "language": { - "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "type": "string", + "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." } }, - "x-ms-client-name": "CreateProjectOptions" + "required": [ + "projectKind", + "projectName", + "language" + ] }, "ConversationalAnalysisAuthoringDeploymentJobState": { - "description": "Represents the state of a deployment job.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" + "description": "Represents the state of a deployment job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] } - ], - "x-ms-client-name": "DeploymentJobState" + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] }, "ConversationalAnalysisAuthoringEntitiesEvaluationSummary": { - "description": "Represents the evaluation result summary for the project's entities.", - "required": [ - "confusionMatrix", - "entities", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ], "type": "object", + "description": "Represents the evaluation result summary for the project's entities.", "properties": { "confusionMatrix": { - "description": "Represents the confusion matrix between two entities (the two entities can be the same). The matrix is between the entity that was labelled and the entity that was predicted.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix" + "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix", + "description": "Represents the confusion matrix between two entities (the two entities can be\nthe same). The matrix is between the entity that was labelled and the entity\nthat was predicted." }, "entities": { - "description": "Represents the entities evaluation summary.", "type": "object", + "description": "Represents the entities evaluation summary.", "additionalProperties": { "$ref": "#/definitions/ConversationalAnalysisAuthoringEntityEvaluationSummary" } }, "microF1": { + "type": "number", "format": "float", - "description": "Represents the micro F1", - "type": "number" + "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive." }, "microPrecision": { + "type": "number", "format": "float", - "description": "Represents the micro precision", - "type": "number" + "description": "Represents the micro precision. Expected value is a float between 0 and 1\ninclusive." }, "microRecall": { + "type": "number", "format": "float", - "description": "Represents the micro recall", - "type": "number" + "description": "Represents the micro recall. Expected value is a float between 0 and 1\ninclusive." }, "macroF1": { + "type": "number", "format": "float", - "description": "Represents the macro F1", - "type": "number" + "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive." }, "macroPrecision": { + "type": "number", "format": "float", - "description": "Represents the macro precision", - "type": "number" + "description": "Represents the macro precision. Expected value is a float between 0 and 1\ninclusive." }, "macroRecall": { + "type": "number", "format": "float", - "description": "Represents the macro recall", - "type": "number" + "description": "Represents the macro recall. Expected value is a float between 0 and 1\ninclusive." } }, - "x-ms-client-name": "EntitiesEvaluationSummary" + "required": [ + "confusionMatrix", + "entities", + "microF1", + "microPrecision", + "microRecall", + "macroF1", + "macroPrecision", + "macroRecall" + ] }, "ConversationalAnalysisAuthoringEntityEvaluationSummary": { - "description": "Represents the evaluation result for an entity.", - "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ], "type": "object", + "description": "Represents the evaluation result for an entity.", "properties": { "f1": { + "type": "number", "format": "double", - "description": "Represents the model precision", - "type": "number" + "description": "Represents the model precision" }, "precision": { + "type": "number", "format": "double", - "description": "Represents the model recall", - "type": "number" + "description": "Represents the model recall" }, "recall": { + "type": "number", "format": "double", - "description": "Represents the model F1 score", - "type": "number" + "description": "Represents the model F1 score" }, "truePositiveCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of true positive", - "type": "integer" + "description": "Represents the count of true positive" }, "trueNegativeCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of true negative", - "type": "integer" + "description": "Represents the count of true negative" }, "falsePositiveCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of false positive", - "type": "integer" + "description": "Represents the count of false positive" }, "falseNegativeCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of false negative", - "type": "integer" + "description": "Represents the count of false negative" } }, - "x-ms-client-name": "EntityEvaluationSummary" - }, - "ConversationalAnalysisAuthoringEvaluationKind": { - "enum": [ - "percentage", - "manual" - ], - "type": "string", - "x-ms-enum": { - "name": "EvaluationKind", - "modelAsString": true, - "values": [ - { - "value": "percentage", - "description": "Split the data into training and test sets according to user-defined percentages." - }, - { - "value": "manual", - "description": "Split the data according to the chosen dataset for every example in the data." - } - ] - }, - "x-ms-client-name": "EvaluationKind" + "required": [ + "f1", + "precision", + "recall", + "truePositiveCount", + "trueNegativeCount", + "falsePositiveCount", + "falseNegativeCount" + ] }, "ConversationalAnalysisAuthoringEvaluationOptions": { - "description": "Represents the options used running the evaluation.", "type": "object", + "description": "Represents the options used running the evaluation.", "properties": { "kind": { - "description": "Represents the evaluation kind. By default, the evaluation kind is set to percentage.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationKind" + "$ref": "#/definitions/EvaluationKind", + "description": "Represents the evaluation kind. By default, the evaluation kind is set to\npercentage." }, "trainingSplitPercentage": { + "type": "integer", "format": "int32", - "description": "Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage.", - "type": "integer" + "description": "Represents the training dataset split percentage. Only needed in case the\nevaluation kind is percentage." }, "testingSplitPercentage": { + "type": "integer", "format": "int32", - "description": "Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage.", - "type": "integer" + "description": "Represents the testing dataset split percentage. Only needed in case the\nevaluation kind is percentage." } - }, - "x-ms-client-name": "EvaluationOptions" + } }, - "ConversationalAnalysisAuthoringEvaluationResults": { - "description": "Represent a list of utterances' evaluation results.", - "required": [ - "value", - "nextLink" - ], + "ConversationalAnalysisAuthoringEvaluationSummary": { "type": "object", + "description": "Represents the evaluation result summary.", "properties": { - "value": { - "description": "The utterances evaluation results.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEvaluationResult" - } + "entitiesEvaluation": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringEntitiesEvaluationSummary", + "description": "Contains the data related to entities evaluation." }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true + "intentsEvaluation": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringIntentsEvaluationSummary", + "description": "Contains the data related to intents evaluation." + }, + "evaluationOptions": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions", + "description": "The options that were used while running the evaluation." } }, - "x-ms-client-name": "EvaluationResults" - }, - "ConversationalAnalysisAuthoringEvaluationSummary": { - "description": "Represents the evaluation result summary.", "required": [ "entitiesEvaluation", "intentsEvaluation" - ], + ] + }, + "ConversationalAnalysisAuthoringExportProjectJobState": { "type": "object", + "description": "Represents the state of an export job.", "properties": { - "entitiesEvaluation": { - "description": "Contains the data related to entities evaluation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEntitiesEvaluationSummary" + "jobId": { + "type": "string", + "description": "The job ID." }, - "intentsEvaluation": { - "description": "Contains the data related to intents evaluation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringIntentsEvaluationSummary" + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." }, - "evaluationOptions": { - "description": "The options that were used while running the evaluation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions" + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] + }, + "resultUrl": { + "type": "string", + "description": "The URL to use in order to download the exported project." } }, - "x-ms-client-name": "EvaluationSummary" + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] }, "ConversationalAnalysisAuthoringExportedConversationOrchestration": { - "description": "Defines the orchestration details for a Conversational project target.", - "required": [ - "projectName", - "deploymentName" - ], "type": "object", + "description": "Defines the orchestration details for a Conversational project target.", "properties": { "projectName": { - "description": "The name of the targeted project.", - "type": "string" + "type": "string", + "description": "The name of the targeted project." }, "deploymentName": { - "description": "The name of the targeted deployment.", - "type": "string" + "type": "string", + "description": "The name of the targeted deployment." } }, - "x-ms-client-name": "ExportedConversationOrchestration" + "required": [ + "projectName", + "deploymentName" + ] }, "ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions": { + "type": "object", "description": "Represents the orchestration options for a Conversational project target.", + "properties": { + "conversationOrchestration": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedConversationOrchestration", + "description": "The Conversational project target details." + } + }, "required": [ "conversationOrchestration" ], - "type": "object", "allOf": [ { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" } ], - "properties": { - "conversationOrchestration": { - "description": "The Conversational project target details.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedConversationOrchestration" - } - }, - "x-ms-discriminator-value": "Conversation", - "x-ms-client-name": "ExportedConversationOrchestrationOptions" + "x-ms-discriminator-value": "Conversation" }, "ConversationalAnalysisAuthoringExportedEntityList": { - "description": "Represents a list component of an entity.", "type": "object", + "description": "Represents a list component of an entity.", "properties": { "sublists": { - "description": "The sub-lists of the list component.", "type": "array", + "description": "The sub-lists of the list component.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntitySublist" - } + }, + "x-ms-identifiers": [] } - }, - "x-ms-client-name": "ExportedEntityList" + } }, "ConversationalAnalysisAuthoringExportedEntityListSynonym": { - "description": "Represents a list of synonyms inside a list component", "type": "object", + "description": "Represents a list of synonyms inside a list component", "properties": { "language": { - "description": "Represents the language of the synonyms. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "type": "string", + "description": "Represents the language of the synonyms. This is BCP-47 representation of a\nlanguage. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for\nSpanish etc." }, "values": { - "description": "The list of synonyms.", "type": "array", + "description": "The list of synonyms.", "items": { "type": "string" } } - }, - "x-ms-client-name": "ExportedEntityListSynonym" + } }, "ConversationalAnalysisAuthoringExportedEntityRegex": { - "description": "Represents a regex component of an entity.", "type": "object", + "description": "Represents a regex component of an entity.", "properties": { "expressions": { - "description": "The regex expressions of the regex component. These expressions follow the .NET regex syntax. For reference, check here: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions", "type": "array", + "description": "The regex expressions of the regex component. These expressions follow the .NET\nregex syntax. For reference, check here:\nhttps://learn.microsoft.com/dotnet/standard/base-types/regular-expressions", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityRegexExpression" - } + }, + "x-ms-identifiers": [] } - }, - "x-ms-client-name": "ExportedEntityRegex" + } }, "ConversationalAnalysisAuthoringExportedEntityRegexExpression": { - "description": "Represents a regex expression inside a regex component. This expression follows the .NET regex syntax. For reference, check here: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions", "type": "object", + "description": "Represents a regex expression inside a regex component. This expression follows\nthe .NET regex syntax. For reference, check here:\nhttps://learn.microsoft.com/dotnet/standard/base-types/regular-expressions", "properties": { "regexKey": { - "description": "The key of the regex expression.", - "type": "string" + "type": "string", + "description": "The key of the regex expression." }, "language": { - "description": "Represents the language of the regex expression. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "type": "string", + "description": "Represents the language of the regex expression. This is BCP-47 representation\nof a language. For example, use \"en\" for English, \"en-gb\" for English (UK),\n\"es\" for Spanish etc." }, "regexPattern": { - "description": "The regex pattern.", - "type": "string" + "type": "string", + "description": "The regex pattern." } - }, - "x-ms-client-name": "ExportedEntityRegexExpression" + } }, "ConversationalAnalysisAuthoringExportedEntitySublist": { - "description": "Represents a sub-list inside a list component.", "type": "object", + "description": "Represents a sub-list inside a list component.", "properties": { "listKey": { - "description": "The key of the sub-list.", - "type": "string" + "type": "string", + "description": "The key of the sub-list." }, "synonyms": { - "description": "The phrases of that correspond to the sub-list.", "type": "array", + "description": "The phrases of that correspond to the sub-list.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityListSynonym" - } + }, + "x-ms-identifiers": [] } - }, - "x-ms-client-name": "ExportedEntitySublist" + } }, "ConversationalAnalysisAuthoringExportedLuisOrchestration": { - "description": "Defines the orchestration details for a LUIS application target.", - "required": [ - "appId" - ], "type": "object", + "description": "Defines the orchestration details for a LUIS application target.", "properties": { "appId": { - "format": "uuid", - "description": "The LUIS application ID.", - "type": "string", - "example": "00000000-0000-0000-0000-000000000000" + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The LUIS application ID." }, "appVersion": { - "description": "The targeted version Id.", - "type": "string" + "type": "string", + "description": "The targeted version Id." }, "slotName": { - "description": "The targeted slot name.", - "type": "string" + "type": "string", + "description": "The targeted slot name." } }, - "x-ms-client-name": "ExportedLuisOrchestration" - }, - "ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions": { + "required": [ + "appId" + ] + }, + "ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions": { + "type": "object", "description": "Represents the orchestration options for a LUIS application target.", + "properties": { + "luisOrchestration": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedLuisOrchestration", + "description": "The LUIS application target details." + } + }, "required": [ "luisOrchestration" ], - "type": "object", "allOf": [ { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" } ], - "properties": { - "luisOrchestration": { - "description": "The LUIS application target details.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedLuisOrchestration" - } - }, - "x-ms-discriminator-value": "Luis", - "x-ms-client-name": "ExportedLuisOrchestrationOptions" + "x-ms-discriminator-value": "Luis" }, "ConversationalAnalysisAuthoringExportedOrchestrationOptions": { - "description": "Represents the options used to define the orchestration behavior of an intent.", - "required": [ - "targetProjectKind" - ], "type": "object", + "description": "Represents the options used to define the orchestration behavior of an intent.", "properties": { "targetProjectKind": { - "description": "The kind of the target used in the orchestration flow.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationTargetProjectKind" + "$ref": "#/definitions/OrchestrationTargetProjectKind" } }, "discriminator": "targetProjectKind", - "x-ms-client-name": "ExportedOrchestrationOptions" + "required": [ + "targetProjectKind" + ] }, "ConversationalAnalysisAuthoringExportedPrebuiltEntity": { - "description": "Represents an exported prebuilt entity component", - "required": [ - "category" - ], "type": "object", + "description": "Represents an exported prebuilt entity component", "properties": { "category": { - "description": "The prebuilt entity category.", - "type": "string" + "type": "string", + "description": "The prebuilt entity category." } }, - "x-ms-client-name": "ExportedPrebuiltEntity" + "required": [ + "category" + ] }, "ConversationalAnalysisAuthoringExportedProject": { - "description": "Represents an exported project.", - "required": [ - "projectFileVersion", - "stringIndexType", - "metadata" - ], "type": "object", + "description": "Represents an exported project.", "properties": { "projectFileVersion": { - "description": "The version of the exported file.", - "type": "string" + "type": "string", + "description": "The version of the exported file." }, "stringIndexType": { - "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringStringIndexType" + "$ref": "#/definitions/StringIndexType", + "description": "Specifies the method used to interpret string offsets. For additional\ninformation see https://aka.ms/text-analytics-offsets." }, "metadata": { - "description": "Represents the project metadata.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateProjectOptions" + "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateProjectOptions", + "description": "Represents the project metadata." }, "assets": { - "description": "Represents the project assets.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets", + "description": "Represents the project assets." } }, - "x-ms-client-name": "ExportedProject" + "required": [ + "projectFileVersion", + "stringIndexType", + "metadata" + ] }, "ConversationalAnalysisAuthoringExportedProjectAssets": { - "description": "Represents the assets of an exported project.", - "required": [ - "projectKind" - ], "type": "object", + "description": "Represents the assets of an exported project.", "properties": { "projectKind": { - "description": "The type of project containing the assets.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" + "$ref": "#/definitions/ProjectKind", + "description": "The type of project containing the assets." } }, "discriminator": "projectKind", - "x-ms-client-name": "ExportedProjectAssets" - }, - "ConversationalAnalysisAuthoringExportedProjectFormat": { - "enum": [ - "Conversation", - "Luis" - ], - "type": "string", - "x-ms-enum": { - "name": "ExportedProjectFormat", - "modelAsString": true, - "values": [ - { - "value": "Conversation", - "description": "Specifies the format for a conversational project." - }, - { - "value": "Luis", - "description": "Specifies the format for an application that was exported from LUIS." - } - ] - }, - "x-ms-client-name": "ExportedProjectFormat" + "required": [ + "projectKind" + ] }, "ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration": { - "description": "Defines the orchestration details for a Question Answering project target.", - "required": [ - "projectName" - ], "type": "object", + "description": "Defines the orchestration details for a Question Answering project target.", "properties": { "projectName": { - "description": "The name of the target project.", - "type": "string" + "type": "string", + "description": "The name of the target project." } }, - "x-ms-client-name": "ExportedQuestionAnsweringOrchestration" + "required": [ + "projectName" + ] }, "ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions": { + "type": "object", "description": "Represents the orchestration options for a Question Answering project target.", + "properties": { + "questionAnsweringOrchestration": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration", + "description": "The Question Answering project details." + } + }, "required": [ "questionAnsweringOrchestration" ], - "type": "object", "allOf": [ { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" } ], - "properties": { - "questionAnsweringOrchestration": { - "description": "The Question Answering project details.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration" - } - }, - "x-ms-discriminator-value": "QuestionAnswering", - "x-ms-client-name": "ExportedQuestionAnsweringOrchestrationOptions" + "x-ms-discriminator-value": "QuestionAnswering" }, "ConversationalAnalysisAuthoringExportedUtteranceEntityLabel": { - "description": "Represents an entity label for an utterance.", - "required": [ - "category", - "offset", - "length" - ], "type": "object", + "description": "Represents an entity label for an utterance.", "properties": { "category": { - "description": "The category of the entity label.", - "type": "string" + "type": "string", + "description": "The category of the entity label." }, "offset": { + "type": "integer", "format": "int32", - "description": "Start position for the entity text.", - "type": "integer" + "description": "Start position for the entity text." }, "length": { + "type": "integer", "format": "int32", - "description": "Length for the entity text.", - "type": "integer" + "description": "Length for the entity text." } }, - "x-ms-client-name": "ExportedUtteranceEntityLabel" + "required": [ + "category", + "offset", + "length" + ] }, - "ConversationalAnalysisAuthoringExportProjectJobState": { - "description": "Represents the state of an export job.", + "ConversationalAnalysisAuthoringImportProjectJobState": { "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], + "description": "Represents the state of an import job.", "properties": { - "resultUrl": { - "description": "The URL to use in order to download the exported project.", - "type": "string" + "jobId": { + "type": "string", + "description": "The job ID." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] } }, - "x-ms-client-name": "ExportProjectJobState" - }, - "ConversationalAnalysisAuthoringImportProjectJobState": { - "description": "Represents the state of an import job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "ImportProjectJobState" + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] }, "ConversationalAnalysisAuthoringIntentEvaluationSummary": { - "description": "The evaluation summary for an intent.", - "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ], "type": "object", + "description": "The evaluation summary for an intent.", "properties": { "f1": { + "type": "number", "format": "double", - "description": "Represents the model precision", - "type": "number" + "description": "Represents the model precision" }, "precision": { + "type": "number", "format": "double", - "description": "Represents the model recall", - "type": "number" + "description": "Represents the model recall" }, "recall": { + "type": "number", "format": "double", - "description": "Represents the model F1 score", - "type": "number" + "description": "Represents the model F1 score" }, "truePositiveCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of true positive", - "type": "integer" + "description": "Represents the count of true positive" }, "trueNegativeCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of true negative", - "type": "integer" + "description": "Represents the count of true negative" }, "falsePositiveCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of false positive", - "type": "integer" + "description": "Represents the count of false positive" }, "falseNegativeCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of false negative", - "type": "integer" + "description": "Represents the count of false negative" } }, - "x-ms-client-name": "IntentEvaluationSummary" + "required": [ + "f1", + "precision", + "recall", + "truePositiveCount", + "trueNegativeCount", + "falsePositiveCount", + "falseNegativeCount" + ] }, "ConversationalAnalysisAuthoringIntentsEvaluationSummary": { - "description": "Represents the evaluation summary for the project's intents.", - "required": [ - "confusionMatrix", - "intents", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ], "type": "object", + "description": "Represents the evaluation summary for the project's intents.", "properties": { "confusionMatrix": { - "description": "Represents the confusion matrix between two intents (the two intents can be the same). The matrix is between the intent that was labelled and the intent that was predicted.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix" + "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix", + "description": "Represents the confusion matrix between two intents (the two intents can be the\nsame). The matrix is between the intent that was labelled and the intent that\nwas predicted." }, "intents": { - "description": "Represents the intents evaluation summary.", "type": "object", + "description": "Represents the intents evaluation summary.", "additionalProperties": { "$ref": "#/definitions/ConversationalAnalysisAuthoringIntentEvaluationSummary" } }, "microF1": { + "type": "number", "format": "float", - "description": "Represents the micro F1", - "type": "number" + "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive." }, "microPrecision": { + "type": "number", "format": "float", - "description": "Represents the micro precision", - "type": "number" + "description": "Represents the micro precision. Expected value is a float between 0 and 1\ninclusive." }, "microRecall": { + "type": "number", "format": "float", - "description": "Represents the micro recall", - "type": "number" + "description": "Represents the micro recall. Expected value is a float between 0 and 1\ninclusive." }, "macroF1": { + "type": "number", "format": "float", - "description": "Represents the macro F1", - "type": "number" + "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive." }, "macroPrecision": { + "type": "number", "format": "float", - "description": "Represents the macro precision", - "type": "number" + "description": "Represents the macro precision. Expected value is a float between 0 and 1\ninclusive." }, "macroRecall": { + "type": "number", "format": "float", - "description": "Represents the macro recall", - "type": "number" + "description": "Represents the macro recall. Expected value is a float between 0 and 1\ninclusive." } }, - "x-ms-client-name": "IntentsEvaluationSummary" - }, - "ConversationalAnalysisAuthoringJobState": { - "description": "Represents a job's state.", "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ], + "confusionMatrix", + "intents", + "microF1", + "microPrecision", + "microRecall", + "macroF1", + "macroPrecision", + "macroRecall" + ] + }, + "ConversationalAnalysisAuthoringLoadSnapshotJobState": { "type": "object", + "description": "Represents the state of loading a snapshot job.", "properties": { "jobId": { - "description": "The job ID.", - "type": "string" + "type": "string", + "description": "The job ID." }, "createdDateTime": { + "type": "string", "format": "date-time", - "description": "The creation date time of the job.", - "type": "string" + "description": "The creation date time of the job." }, "lastUpdatedDateTime": { + "type": "string", "format": "date-time", - "description": "The last date time the job was updated.", - "type": "string" + "description": "The last date time the job was updated." }, "expirationDateTime": { + "type": "string", "format": "date-time", - "description": "The expiration date time of the job.", - "type": "string" + "description": "The expiration date time of the job." }, "status": { - "description": "The job status.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" + "$ref": "#/definitions/JobStatus", + "description": "The job status." }, "warnings": { - "description": "The warnings that were encountered while executing the job.", "type": "array", + "description": "The warnings that were encountered while executing the job.", "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringWarning" - } + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] }, "errors": { - "description": "The errors encountered while executing the job.", "type": "array", + "description": "The errors encountered while executing the job.", "items": { - "$ref": "common.json#/definitions/Error" - } + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] } }, - "x-ms-client-name": "JobState" - }, - "ConversationalAnalysisAuthoringJobStatus": { - "enum": [ - "notStarted", - "running", - "succeeded", - "failed", - "cancelled", - "cancelling", - "partiallyCompleted" - ], - "type": "string", - "x-ms-enum": { - "name": "JobStatus", - "modelAsString": true - }, - "x-ms-client-name": "JobStatus" - }, - "ConversationalAnalysisAuthoringLoadSnapshotJobState": { - "description": "Represents the state of loading a snapshot job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "LoadSnapshotJobState" + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] }, "ConversationalAnalysisAuthoringOrchestrationExportedIntent": { - "description": "Represents an exported intent for an orchestration project.", - "required": [ - "category" - ], "type": "object", + "description": "Represents an exported intent for an orchestration project.", "properties": { "orchestration": { - "description": "Specifies the behavior of this intent in the orchestration flow.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions", + "description": "Specifies the behavior of this intent in the orchestration flow." }, "category": { - "description": "The intent category.", - "type": "string" + "type": "string", + "description": "The intent category." } }, - "x-ms-client-name": "OrchestrationExportedIntent" + "required": [ + "category" + ] }, "ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets": { - "description": "Represents the assets of an orchestration project.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" - } - ], + "description": "Represents the assets of an orchestration project.", "properties": { "intents": { - "description": "Represents the intents of the project.", "type": "array", + "description": "Represents the intents of the project.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationExportedIntent" - } + }, + "x-ms-identifiers": [] }, "utterances": { - "description": "Represents the utterances of the project.", "type": "array", + "description": "Represents the utterances of the project.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationExportedUtterance" - } + }, + "x-ms-identifiers": [] } }, - "x-ms-discriminator-value": "Orchestration", - "x-ms-client-name": "OrchestrationExportedProjectAssets" + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" + } + ], + "x-ms-discriminator-value": "Orchestration" }, "ConversationalAnalysisAuthoringOrchestrationExportedUtterance": { - "description": "Represents an utterance of an orchestration project.", - "required": [ - "text", - "intent" - ], "type": "object", + "description": "Represents an utterance of an orchestration project.", "properties": { "text": { - "description": "The utterance text.", - "type": "string" + "type": "string", + "description": "The utterance text." }, "language": { - "description": "Represents the utterance's language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "type": "string", + "description": "Represents the utterance's language. This is BCP-47 representation of a\nlanguage. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for\nSpanish etc." }, "intent": { - "description": "The intent of the utterance.", - "type": "string" + "type": "string", + "description": "The intent of the utterance." }, "dataset": { - "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'.", - "type": "string" + "type": "string", + "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'." } }, - "x-ms-client-name": "OrchestrationExportedUtterance" - }, - "ConversationalAnalysisAuthoringOrchestrationTargetProjectKind": { - "enum": [ - "Luis", - "Conversation", - "QuestionAnswering" - ], - "type": "string", - "x-ms-enum": { - "name": "OrchestrationTargetProjectKind", - "modelAsString": true - }, - "x-ms-client-name": "OrchestrationTargetProjectKind" + "required": [ + "text", + "intent" + ] }, "ConversationalAnalysisAuthoringPrebuiltEntities": { - "description": "Represents a list of the retrieved supported prebuilt entities.", - "required": [ - "value", - "nextLink" - ], "type": "object", + "description": "Represents a list of the retrieved supported prebuilt entities.", "properties": { "value": { - "description": "The supported prebuilt entities.", "type": "array", + "description": "The supported prebuilt entities.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringPrebuiltEntity" - } + }, + "x-ms-identifiers": [] }, "nextLink": { - "description": "The next page link.", "type": "string", - "x-nullable": true + "description": "The next page link." } }, - "x-ms-client-name": "PrebuiltEntities" + "required": [ + "value" + ] }, "ConversationalAnalysisAuthoringPrebuiltEntity": { - "description": "Represents a supported prebuilt entity.", - "required": [ - "category", - "description", - "examples" - ], "type": "object", + "description": "Represents a supported prebuilt entity.", "properties": { "category": { - "description": "The prebuilt entity category.", - "type": "string" + "type": "string", + "description": "The prebuilt entity category." }, "description": { - "description": "The description.", - "type": "string" + "type": "string", + "description": "The description." }, "examples": { - "description": "English examples for the entity.", - "type": "string" + "type": "string", + "description": "English examples for the entity." } }, - "x-ms-client-name": "PrebuiltEntity" + "required": [ + "category", + "description", + "examples" + ] }, "ConversationalAnalysisAuthoringProjectDeletionJobState": { - "description": "Represents the state of a project deletion job.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" + "description": "Represents the state of a project deletion job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] } - ], - "x-ms-client-name": "ProjectDeletionJobState" + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] }, "ConversationalAnalysisAuthoringProjectDeployment": { - "description": "Represents a project deployment.", - "required": [ - "deploymentName", - "modelId", - "lastTrainedDateTime", - "lastDeployedDateTime", - "deploymentExpirationDate", - "modelTrainingConfigVersion" - ], "type": "object", + "description": "Represents a project deployment.", "properties": { "deploymentName": { - "description": "Represents deployment name.", - "type": "string" + "type": "string", + "description": "Represents deployment name." }, "modelId": { - "description": "Represents deployment modelId.", - "type": "string" + "type": "string", + "description": "Represents deployment modelId." }, "lastTrainedDateTime": { + "type": "string", "format": "date-time", - "description": "Represents deployment last trained time.", - "type": "string" + "description": "Represents deployment last trained time." }, "lastDeployedDateTime": { + "type": "string", "format": "date-time", - "description": "Represents deployment last deployed time.", - "type": "string" + "description": "Represents deployment last deployed time." }, "deploymentExpirationDate": { + "type": "string", "format": "date", - "description": "Represents deployment expiration date in the runtime.", - "type": "string" + "description": "Represents deployment expiration date in the runtime." }, "modelTrainingConfigVersion": { - "description": "Represents model training config version.", - "type": "string" - } - }, - "x-ms-client-name": "ProjectDeployment" - }, - "ConversationalAnalysisAuthoringProjectDeployments": { - "description": "Represents a list of retrieved deployments.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of retrieved deployments.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployment" - } - }, - "nextLink": { - "description": "The next page link.", "type": "string", - "x-nullable": true + "description": "Represents model training config version." } }, - "x-ms-client-name": "ProjectDeployments" - }, - "ConversationalAnalysisAuthoringProjectKind": { - "enum": [ - "Conversation", - "Orchestration" - ], - "type": "string", - "x-ms-enum": { - "name": "ProjectKind", - "modelAsString": true, - "values": [ - { - "value": "Conversation", - "description": "A project to build natural language into apps, bots, and IoT devices." - }, - { - "value": "Orchestration", - "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." - } - ] - }, - "x-ms-client-name": "ProjectKind" + "required": [ + "deploymentName", + "modelId", + "lastTrainedDateTime", + "lastDeployedDateTime", + "deploymentExpirationDate", + "modelTrainingConfigVersion" + ] }, "ConversationalAnalysisAuthoringProjectMetadata": { - "description": "Represents the metadata of a project.", - "required": [ - "createdDateTime", - "lastModifiedDateTime", - "projectKind", - "projectName", - "language" - ], "type": "object", + "description": "Represents the metadata of a project.", "properties": { "createdDateTime": { + "type": "string", "format": "date-time", - "description": "Represents the project creation datetime.", - "type": "string" + "description": "Represents the project creation datetime." }, "lastModifiedDateTime": { + "type": "string", "format": "date-time", - "description": "Represents the project creation datetime.", - "type": "string" + "description": "Represents the project creation datetime." }, "lastTrainedDateTime": { + "type": "string", "format": "date-time", - "description": "Represents the project last trained datetime.", - "type": "string" + "description": "Represents the project last trained datetime." }, "lastDeployedDateTime": { + "type": "string", "format": "date-time", - "description": "Represents the project last deployed datetime.", - "type": "string" + "description": "Represents the project last deployed datetime." }, "projectKind": { + "$ref": "#/definitions/ProjectKind", "description": "Represents the project kind.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" + "x-ms-mutability": [ + "read", + "create" + ] }, "settings": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings", "description": "The project settings.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings" + "x-ms-mutability": [ + "read", + "create" + ] }, "projectName": { + "type": "string", "description": "The new project name.", - "type": "string" + "maxLength": 100, + "x-ms-mutability": [ + "read", + "create" + ] }, "multilingual": { + "type": "boolean", "description": "Whether the project would be used for multiple languages or not.", - "type": "boolean" + "x-ms-mutability": [ + "read", + "create" + ] }, "description": { + "type": "string", "description": "The project description.", - "type": "string" + "x-ms-mutability": [ + "read", + "create" + ] }, "language": { + "type": "string", "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "x-ms-mutability": [ + "read", + "create" + ] } }, - "x-ms-client-name": "ProjectMetadata" + "required": [ + "createdDateTime", + "lastModifiedDateTime", + "projectKind", + "projectName", + "language" + ] }, "ConversationalAnalysisAuthoringProjectSettings": { - "description": "Represents the settings used to define the project behavior.", - "required": [ - "confidenceThreshold" - ], "type": "object", + "description": "Represents the settings used to define the project behavior.", "properties": { "confidenceThreshold": { + "type": "number", "format": "float", - "description": "The threshold of the intent with the highest confidence, at which the prediction will automatically be changed to \"None\". The value of the threshold should be between 0 and 1 inclusive.", - "type": "number" + "description": "The threshold of the intent with the highest confidence, at which the prediction will automatically be changed to \"None\". The value of the threshold should be between 0 and 1 inclusive." } }, - "x-ms-client-name": "ProjectSettings" - }, - "ConversationalAnalysisAuthoringProjectsMetadata": { - "description": "Represents a list of retrieved projects' metadata.", "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of projects.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "ProjectsMetadata" + "confidenceThreshold" + ] }, "ConversationalAnalysisAuthoringProjectTrainedModel": { - "description": "Represents a trained model.", - "required": [ - "label", - "modelId", - "lastTrainedDateTime", - "lastTrainingDurationInSeconds", - "modelExpirationDate", - "modelTrainingConfigVersion", - "hasSnapshot" - ], "type": "object", + "description": "Represents a trained model.", "properties": { "label": { - "description": "The trained model label.", - "type": "string" + "type": "string", + "description": "The trained model label." }, "modelId": { - "description": "The model ID.", - "type": "string" + "type": "string", + "description": "The model ID." }, "lastTrainedDateTime": { + "type": "string", "format": "date-time", - "description": "The last trained date time of the model.", - "type": "string" + "description": "The last trained date time of the model." }, "lastTrainingDurationInSeconds": { + "type": "integer", "format": "int32", - "description": "The duration of the model's last training request in seconds.", - "type": "integer" + "description": "The duration of the model's last training request in seconds." }, "modelExpirationDate": { + "type": "string", "format": "date", - "description": "The model expiration date.", - "type": "string" + "description": "The model expiration date." }, "modelTrainingConfigVersion": { - "description": "The model training config version.", - "type": "string" + "type": "string", + "description": "The model training config version." }, "hasSnapshot": { - "description": "The flag to indicate if the trained model has a snapshot ready.", - "type": "boolean" + "type": "boolean", + "description": "The flag to indicate if the trained model has a snapshot ready." } }, - "x-ms-client-name": "ProjectTrainedModel" - }, - "ConversationalAnalysisAuthoringProjectTrainedModels": { - "description": "Represents a list of retrieved trained models.", "required": [ - "value", - "nextLink" - ], + "label", + "modelId", + "lastTrainedDateTime", + "lastTrainingDurationInSeconds", + "modelExpirationDate", + "modelTrainingConfigVersion", + "hasSnapshot" + ] + }, + "ConversationalAnalysisAuthoringSubTrainingJobState": { "type": "object", + "description": "Represents the detailed state of a training sub-operation.", "properties": { - "value": { - "description": "The list of retrieved jobs.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModel" - } + "percentComplete": { + "type": "integer", + "format": "int32", + "description": "Represents progress percentage." }, - "nextLink": { - "description": "The next page link.", + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "Represents the start date time." + }, + "endDateTime": { "type": "string", - "x-nullable": true + "format": "date-time", + "description": "Represents the end date time." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "Represents the status of the sub-operation." } }, - "x-ms-client-name": "ProjectTrainedModels" - }, - "ConversationalAnalysisAuthoringStringIndexType": { - "enum": [ - "Utf16CodeUnit" - ], - "type": "string", - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "value": "Utf16CodeUnit", - "description": "The 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." - } - ] - }, - "x-ms-client-name": "StringIndexType" - }, - "ConversationalAnalysisAuthoringSubTrainingJobState": { - "description": "Represents the detailed state of a training sub-operation.", "required": [ "percentComplete", "status" - ], - "type": "object", - "properties": { - "percentComplete": { - "format": "int32", - "description": "Represents progress percentage.", - "type": "integer" - }, - "startDateTime": { - "format": "date-time", - "description": "Represents the start date time.", - "type": "string" - }, - "endDateTime": { - "format": "date-time", - "description": "Represents the end date time.", - "type": "string" - }, - "status": { - "description": "Represents the status of the sub-operation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" - } - }, - "x-ms-client-name": "SubTrainingJobState" + ] }, "ConversationalAnalysisAuthoringSupportedLanguage": { - "description": "Represents a supported language.", - "required": [ - "languageName", - "languageCode" - ], "type": "object", + "description": "Represents a supported language.", "properties": { "languageName": { - "description": "The language name.", - "type": "string" + "type": "string", + "description": "The language name." }, "languageCode": { - "description": "The language code. This is BCP-47 representation of a language. For example, \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "type": "string", + "description": "The language code. This is BCP-47 representation of a language. For example,\n\"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." } }, - "x-ms-client-name": "SupportedLanguage" + "required": [ + "languageName", + "languageCode" + ] }, "ConversationalAnalysisAuthoringSupportedLanguages": { - "description": "Represents a list of retrieved languages.", - "required": [ - "value", - "nextLink" - ], "type": "object", + "description": "Represents a list of retrieved languages.", "properties": { "value": { - "description": "The list of the languages.", "type": "array", + "description": "The list of the languages.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringSupportedLanguage" - } + }, + "x-ms-identifiers": [] }, "nextLink": { - "description": "The next page link.", "type": "string", - "x-nullable": true + "description": "The next page link." } }, - "x-ms-client-name": "SupportedLanguages" + "required": [ + "value" + ] }, - "ConversationalAnalysisAuthoringSwapDeploymentsOptions": { - "description": "Represents the options for swapping two deployments together.", + "ConversationalAnalysisAuthoringSwapDeploymentsJobState": { + "type": "object", + "description": "Represents the state of a deployment job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] + } + }, "required": [ - "firstDeploymentName", - "secondDeploymentName" - ], + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] + }, + "ConversationalAnalysisAuthoringSwapDeploymentsOptions": { "type": "object", + "description": "Represents the options for swapping two deployments together.", "properties": { "firstDeploymentName": { - "description": "Represents the first deployment name.", - "type": "string" + "type": "string", + "description": "Represents the first deployment name." }, "secondDeploymentName": { - "description": "Represents the second deployment name.", - "type": "string" + "type": "string", + "description": "Represents the second deployment name." } }, - "x-ms-client-name": "SwapDeploymentsOptions" + "required": [ + "firstDeploymentName", + "secondDeploymentName" + ] }, "ConversationalAnalysisAuthoringTrainingConfigVersion": { - "description": "Represents a training config version.", - "required": [ - "trainingConfigVersion", - "modelExpirationDate" - ], "type": "object", + "description": "Represents a training config version.", "properties": { "trainingConfigVersion": { - "description": "Represents the version of the config.", - "type": "string" + "type": "string", + "description": "Represents the version of the config." }, "modelExpirationDate": { + "type": "string", "format": "date", - "description": "Represents the training config version expiration date.", - "type": "string" + "description": "Represents the training config version expiration date." } }, - "x-ms-client-name": "TrainingConfigVersion" + "required": [ + "trainingConfigVersion", + "modelExpirationDate" + ] }, "ConversationalAnalysisAuthoringTrainingConfigVersions": { - "description": "Represents a list of training config versions.", - "required": [ - "value", - "nextLink" - ], "type": "object", + "description": "Represents a list of training config versions.", "properties": { "value": { - "description": "The list of the training config versions.", "type": "array", + "description": "The list of the training config versions.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingConfigVersion" - } + }, + "x-ms-identifiers": [] }, "nextLink": { - "description": "The next page link.", "type": "string", - "x-nullable": true + "description": "The next page link." } }, - "x-ms-client-name": "TrainingConfigVersions" + "required": [ + "value" + ] }, "ConversationalAnalysisAuthoringTrainingJobOptions": { - "description": "Represents the options for starting a new training job.", - "required": [ - "modelLabel", - "trainingMode" - ], "type": "object", + "description": "Represents the options for starting a new training job.", "properties": { "modelLabel": { - "description": "Represents the output model label.", - "type": "string" + "type": "string", + "description": "Represents the output model label." }, "trainingConfigVersion": { - "description": "Represents training config version. By default, \"latest\" value is used which uses the latest released training config version.", - "type": "string" + "type": "string", + "description": "Represents training config version. By default, \"latest\" value is used which\nuses the latest released training config version." }, "trainingMode": { - "description": "Represents the mode of the training operation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingMode" + "$ref": "#/definitions/TrainingMode", + "description": "Represents the mode of the training operation." }, "evaluationOptions": { - "description": "Represents the evaluation options. By default, the evaluation kind is percentage, with training split percentage as 80, and testing split percentage as 20.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions" + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions", + "description": "Represents the evaluation options. By default, the evaluation kind is\npercentage, with training split percentage as 80, and testing split percentage\nas 20." } }, - "x-ms-client-name": "TrainingJobOptions" - }, - "ConversationalAnalysisAuthoringTrainingJobResult": { - "description": "Represents the output of a training job.", "required": [ "modelLabel", - "trainingConfigVersion", - "trainingStatus" - ], + "trainingMode" + ] + }, + "ConversationalAnalysisAuthoringTrainingJobResult": { "type": "object", + "description": "Represents the output of a training job.", "properties": { "modelLabel": { - "description": "Represents trained model label.", - "type": "string" + "type": "string", + "description": "Represents trained model label." }, "trainingConfigVersion": { - "description": "Represents training config version.", - "type": "string" + "type": "string", + "description": "Represents training config version." }, "trainingMode": { - "description": "Represents the mode of the training operation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingMode" + "$ref": "#/definitions/TrainingMode", + "description": "Represents the mode of the training operation." }, "trainingStatus": { - "description": "Represents the model training status.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState" + "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState", + "description": "Represents the model training status." }, "evaluationStatus": { - "description": "Represents model evaluation status.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState" + "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState", + "description": "Represents model evaluation status." }, "estimatedEndDateTime": { + "type": "string", "format": "date-time", - "description": "Represents the estimated end date time for training and evaluation.", - "type": "string" + "description": "Represents the estimated end date time for training and evaluation." } }, - "x-ms-client-name": "TrainingJobResult" - }, - "ConversationalAnalysisAuthoringTrainingJobs": { - "description": "Represents a list of retrieved training jobs.", "required": [ - "value", - "nextLink" - ], + "modelLabel", + "trainingConfigVersion", + "trainingStatus" + ] + }, + "ConversationalAnalysisAuthoringTrainingJobState": { "type": "object", + "description": "Represents the state of a training job.", "properties": { - "value": { - "description": "The list of jobs.", + "jobId": { + "type": "string", + "description": "The job ID." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { "type": "array", + "description": "The warnings that were encountered while executing the job.", "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobState" - } + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] + }, + "result": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobResult", + "description": "Represents training tasks detailed result." } }, - "x-ms-client-name": "TrainingJobs" - }, - "ConversationalAnalysisAuthoringTrainingJobState": { - "description": "Represents the state of a training job.", "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status", "result" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "properties": { - "result": { - "description": "Represents training tasks detailed result.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobResult" - } - }, - "x-ms-client-name": "TrainingJobState" - }, - "ConversationalAnalysisAuthoringTrainingMode": { - "enum": [ - "advanced", - "standard" - ], - "type": "string", - "x-ms-enum": { - "name": "TrainingMode", - "modelAsString": true, - "values": [ - { - "value": "advanced", - "description": "Trains using fine-tuned neural network transformer models. Can train multilingual projects." - }, - { - "value": "standard", - "description": "Faster training times for quicker iterations." - } - ] - }, - "x-ms-client-name": "TrainingMode" + ] }, "ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult": { - "description": "Represents the comparison between the expected and predicted entities for an utterance.", - "required": [ - "expectedEntities", - "predictedEntities" - ], "type": "object", + "description": "Represents the comparison between the expected and predicted entities for an\nutterance.", "properties": { "expectedEntities": { - "description": "Represents the expected entity labels.", "type": "array", + "description": "Represents the expected entity labels.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult" - } + }, + "x-ms-identifiers": [] }, "predictedEntities": { - "description": "Represents the predicted entity labels.", "type": "array", + "description": "Represents the predicted entity labels.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult" - } + }, + "x-ms-identifiers": [] } }, - "x-ms-client-name": "UtteranceEntitiesEvaluationResult" + "required": [ + "expectedEntities", + "predictedEntities" + ] }, "ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult": { - "description": "Represents the evaluation output of an entity label or prediction.", - "required": [ - "category", - "offset", - "length" - ], "type": "object", + "description": "Represents the evaluation output of an entity label or prediction.", "properties": { "category": { - "description": "Represents the entity category.", - "type": "string" + "type": "string", + "description": "Represents the entity category." }, "offset": { + "type": "integer", "format": "int32", - "description": "Represents the entity offset index relative to the original text.", - "type": "integer" + "description": "Represents the entity offset index relative to the original text." }, "length": { + "type": "integer", "format": "int32", - "description": "Represents the entity length.", - "type": "integer" + "description": "Represents the entity length." } }, - "x-ms-client-name": "UtteranceEntityEvaluationResult" + "required": [ + "category", + "offset", + "length" + ] }, "ConversationalAnalysisAuthoringUtteranceEvaluationResult": { + "type": "object", "description": "Represents the evaluation result for an utterance.", - "required": [ - "text", - "language", - "entitiesResult", - "intentsResult" - ], - "type": "object", "properties": { "text": { - "description": "Represents the utterance text.", - "type": "string" + "type": "string", + "description": "Represents the utterance text." }, "language": { - "description": "Represents the utterance language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "type": "string", + "description": "Represents the utterance language. This is BCP-47 representation of a language.\nFor example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish\netc." }, "entitiesResult": { - "description": "Represents the entities results for the utterance.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult" + "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult", + "description": "Represents the entities results for the utterance." }, "intentsResult": { - "description": "Represents the intents results for the utterance.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult" + "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult", + "description": "Represents the intents results for the utterance." } }, - "x-ms-client-name": "UtteranceEvaluationResult" + "required": [ + "text", + "language", + "entitiesResult", + "intentsResult" + ] }, "ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult": { - "description": "Represents the comparison between the expected and the predicted intent for an utterance.", - "required": [ - "expectedIntent", - "predictedIntent" - ], "type": "object", + "description": "Represents the comparison between the expected and the predicted intent for an\nutterance.", "properties": { "expectedIntent": { - "description": "Represents the utterance's expected intent.", - "type": "string" + "type": "string", + "description": "Represents the utterance's expected intent." }, "predictedIntent": { - "description": "Represents the utterance's predicted intent.", - "type": "string" + "type": "string", + "description": "Represents the utterance's predicted intent." } }, - "x-ms-client-name": "UtteranceIntentsEvaluationResult" + "required": [ + "expectedIntent", + "predictedIntent" + ] }, - "ConversationalAnalysisAuthoringWarning": { - "description": "Represents a warning that was encountered while executing the request.", + "Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "$ref": "#/definitions/ErrorCode", + "description": "One of a server-defined set of error codes." + }, + "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" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/InnerErrorModel", + "description": "An object containing more specific information than the current object about\nthe error." + } + }, "required": [ "code", "message" + ] + }, + "ErrorCode": { + "type": "string", + "description": "Human-readable error code.", + "enum": [ + "InvalidRequest", + "InvalidArgument", + "Unauthorized", + "Forbidden", + "NotFound", + "ProjectNotFound", + "OperationNotFound", + "AzureCognitiveSearchNotFound", + "AzureCognitiveSearchIndexNotFound", + "TooManyRequests", + "AzureCognitiveSearchThrottling", + "AzureCognitiveSearchIndexLimitReached", + "InternalServerError", + "ServiceUnavailable", + "Timeout", + "QuotaExceeded", + "Conflict", + "Warning" ], + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true, + "values": [ + { + "name": "InvalidRequest", + "value": "InvalidRequest" + }, + { + "name": "InvalidArgument", + "value": "InvalidArgument" + }, + { + "name": "Unauthorized", + "value": "Unauthorized" + }, + { + "name": "Forbidden", + "value": "Forbidden" + }, + { + "name": "NotFound", + "value": "NotFound" + }, + { + "name": "ProjectNotFound", + "value": "ProjectNotFound" + }, + { + "name": "OperationNotFound", + "value": "OperationNotFound" + }, + { + "name": "AzureCognitiveSearchNotFound", + "value": "AzureCognitiveSearchNotFound" + }, + { + "name": "AzureCognitiveSearchIndexNotFound", + "value": "AzureCognitiveSearchIndexNotFound" + }, + { + "name": "TooManyRequests", + "value": "TooManyRequests" + }, + { + "name": "AzureCognitiveSearchThrottling", + "value": "AzureCognitiveSearchThrottling" + }, + { + "name": "AzureCognitiveSearchIndexLimitReached", + "value": "AzureCognitiveSearchIndexLimitReached" + }, + { + "name": "InternalServerError", + "value": "InternalServerError" + }, + { + "name": "ServiceUnavailable", + "value": "ServiceUnavailable" + }, + { + "name": "Timeout", + "value": "Timeout" + }, + { + "name": "QuotaExceeded", + "value": "QuotaExceeded" + }, + { + "name": "Conflict", + "value": "Conflict" + }, + { + "name": "Warning", + "value": "Warning" + } + ] + } + }, + "ErrorResponse": { "type": "object", + "description": "Error response.", + "properties": { + "error": { + "$ref": "#/definitions/Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "EvaluationKind": { + "type": "string", + "enum": [ + "percentage", + "manual" + ], + "x-ms-enum": { + "name": "EvaluationKind", + "modelAsString": true, + "values": [ + { + "name": "percentage", + "value": "percentage", + "description": "Split the data into training and test sets according to user-defined\npercentages." + }, + { + "name": "manual", + "value": "manual", + "description": "Split the data according to the chosen dataset for every example in the data." + } + ] + } + }, + "InnerErrorCode": { + "type": "string", + "description": "Human-readable error code.", + "enum": [ + "InvalidRequest", + "InvalidParameterValue", + "KnowledgeBaseNotFound", + "AzureCognitiveSearchNotFound", + "AzureCognitiveSearchThrottling", + "ExtractionFailure", + "InvalidRequestBodyFormat", + "EmptyRequest", + "MissingInputDocuments", + "InvalidDocument", + "ModelVersionIncorrect", + "InvalidDocumentBatch", + "UnsupportedLanguageCode", + "InvalidCountryHint" + ], + "x-ms-enum": { + "name": "InnerErrorCode", + "modelAsString": true, + "values": [ + { + "name": "InvalidRequest", + "value": "InvalidRequest" + }, + { + "name": "InvalidParameterValue", + "value": "InvalidParameterValue" + }, + { + "name": "KnowledgeBaseNotFound", + "value": "KnowledgeBaseNotFound" + }, + { + "name": "AzureCognitiveSearchNotFound", + "value": "AzureCognitiveSearchNotFound" + }, + { + "name": "AzureCognitiveSearchThrottling", + "value": "AzureCognitiveSearchThrottling" + }, + { + "name": "ExtractionFailure", + "value": "ExtractionFailure" + }, + { + "name": "InvalidRequestBodyFormat", + "value": "InvalidRequestBodyFormat" + }, + { + "name": "EmptyRequest", + "value": "EmptyRequest" + }, + { + "name": "MissingInputDocuments", + "value": "MissingInputDocuments" + }, + { + "name": "InvalidDocument", + "value": "InvalidDocument" + }, + { + "name": "ModelVersionIncorrect", + "value": "ModelVersionIncorrect" + }, + { + "name": "InvalidDocumentBatch", + "value": "InvalidDocumentBatch" + }, + { + "name": "UnsupportedLanguageCode", + "value": "UnsupportedLanguageCode" + }, + { + "name": "InvalidCountryHint", + "value": "InvalidCountryHint" + } + ] + } + }, + "InnerErrorModel": { + "type": "object", + "description": "An object containing more specific information about the error. As per\nMicrosoft One API guidelines -\nhttps://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", "properties": { "code": { - "description": "The warning code.", - "type": "string" + "$ref": "#/definitions/InnerErrorCode", + "description": "One of a server-defined set of error codes." }, "message": { - "description": "The warning message.", - "type": "string" + "type": "string", + "description": "Error message." + }, + "details": { + "type": "object", + "description": "Error details.", + "additionalProperties": { + "type": "string" + } + }, + "target": { + "type": "string", + "description": "Error target." + }, + "innererror": { + "$ref": "#/definitions/InnerErrorModel", + "description": "An object containing more specific information than the current object about\nthe error." } }, - "x-ms-client-name": "Warning" - } - }, - "parameters": { - "ConversationalAnalysisAuthoringFormatQueryOptionalParameter": { - "in": "query", - "name": "format", - "description": "The format of the exported project file to use.", + "required": [ + "code", + "message" + ] + }, + "JobStatus": { "type": "string", "enum": [ + "notStarted", + "running", + "succeeded", + "failed", + "cancelled", + "cancelling", + "partiallyCompleted" + ], + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true, + "values": [ + { + "name": "notStarted", + "value": "notStarted" + }, + { + "name": "running", + "value": "running" + }, + { + "name": "succeeded", + "value": "succeeded" + }, + { + "name": "failed", + "value": "failed" + }, + { + "name": "cancelled", + "value": "cancelled" + }, + { + "name": "cancelling", + "value": "cancelling" + }, + { + "name": "partiallyCompleted", + "value": "partiallyCompleted" + } + ] + } + }, + "OrchestrationTargetProjectKind": { + "type": "string", + "enum": [ + "Luis", "Conversation", - "Luis" + "QuestionAnswering" ], "x-ms-enum": { - "name": "ExportedProjectFormat", + "name": "OrchestrationTargetProjectKind", "modelAsString": true, "values": [ { - "value": "Conversation", - "description": "Specifies the format for a conversational project." + "name": "Luis", + "value": "Luis" }, { - "value": "Luis", - "description": "Specifies the format for an application that was exported from LUIS." + "name": "Conversation", + "value": "Conversation" + }, + { + "name": "QuestionAnswering", + "value": "QuestionAnswering" } ] + } + }, + "PagedConversationalAnalysisAuthoringProjectDeployment": { + "type": "object", + "description": "Paged collection of ConversationalAnalysisAuthoringProjectDeployment items", + "properties": { + "value": { + "type": "array", + "description": "The ConversationalAnalysisAuthoringProjectDeployment items on this page", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployment" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } }, - "x-ms-parameter-location": "method" + "required": [ + "value" + ] }, - "ConversationalAnalysisAuthoringStringIndexTypeQueryParameter": { - "in": "query", - "name": "stringIndexType", - "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "required": true, + "PagedConversationalAnalysisAuthoringProjectMetadata": { + "type": "object", + "description": "Paged collection of ConversationalAnalysisAuthoringProjectMetadata items", + "properties": { + "value": { + "type": "array", + "description": "The ConversationalAnalysisAuthoringProjectMetadata items on this page", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedConversationalAnalysisAuthoringProjectTrainedModel": { + "type": "object", + "description": "Paged collection of ConversationalAnalysisAuthoringProjectTrainedModel items", + "properties": { + "value": { + "type": "array", + "description": "The ConversationalAnalysisAuthoringProjectTrainedModel items on this page", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModel" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedConversationalAnalysisAuthoringTrainingJobState": { + "type": "object", + "description": "Paged collection of ConversationalAnalysisAuthoringTrainingJobState items", + "properties": { + "value": { + "type": "array", + "description": "The ConversationalAnalysisAuthoringTrainingJobState items on this page", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobState" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedConversationalAnalysisAuthoringUtteranceEvaluationResult": { + "type": "object", + "description": "Paged collection of ConversationalAnalysisAuthoringUtteranceEvaluationResult items", + "properties": { + "value": { + "type": "array", + "description": "The ConversationalAnalysisAuthoringUtteranceEvaluationResult items on this page", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEvaluationResult" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ProjectKind": { + "type": "string", + "enum": [ + "Conversation", + "Orchestration" + ], + "x-ms-enum": { + "name": "ProjectKind", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "A project to build natural language into apps, bots, and IoT devices." + }, + { + "name": "Orchestration", + "value": "Orchestration", + "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." + } + ] + } + }, + "StringIndexType": { "type": "string", "enum": [ "Utf16CodeUnit" @@ -3214,50 +3908,111 @@ "modelAsString": true, "values": [ { + "name": "Utf16CodeUnit", "value": "Utf16CodeUnit", - "description": "The 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." + "description": "The offset and length values will correspond to UTF-16 code units. Use this\noption if your application is written in a language that support Unicode, for\nexample Java, JavaScript." } ] - }, - "x-ms-parameter-location": "method" + } }, - "ConversationalAnalysisAuthoringJobIdPathParameter": { - "in": "path", - "name": "jobId", - "description": "The job ID.", - "required": true, + "TrainingMode": { "type": "string", - "x-ms-parameter-location": "method" + "enum": [ + "advanced", + "standard" + ], + "x-ms-enum": { + "name": "TrainingMode", + "modelAsString": true, + "values": [ + { + "name": "advanced", + "value": "advanced", + "description": "Trains using fine-tuned neural network transformer models. Can train\nmultilingual projects." + }, + { + "name": "standard", + "value": "standard", + "description": "Faster training times for quicker iterations." + } + ] + } }, - "ConversationalAnalysisAuthoringTrainedModelLabelPathParameter": { - "in": "path", - "name": "trainedModelLabel", - "description": "The trained model label.", + "Warning": { + "type": "object", + "description": "Represents a warning that was encountered while executing the request.", + "properties": { + "code": { + "type": "string", + "description": "The warning code." + }, + "message": { + "type": "string", + "description": "The warning message." + } + }, + "required": [ + "code", + "message" + ] + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", "required": true, "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + }, + "Azure.Core.MaxPageSizeQueryParameter": { + "name": "maxpagesize", + "in": "query", + "description": "The maximum number of result items per page.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "Azure.Core.SkipQueryParameter": { + "name": "skip", + "in": "query", + "description": "The number of result items to skip.", + "required": false, + "type": "integer", + "format": "int32", + "default": 0, "x-ms-parameter-location": "method" }, - "ConversationalAnalysisAuthoringProjectKindQueryParameter": { + "Azure.Core.TopQueryParameter": { + "name": "top", "in": "query", - "name": "projectKind", - "description": "The project kind.", + "description": "The number of result items to return.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "StringIndexTypeQueryParameter": { + "name": "stringIndexType", + "in": "query", + "description": "Specifies the method used to interpret string offsets. For additional\ninformation see https://aka.ms/text-analytics-offsets.", "required": true, "type": "string", "enum": [ - "Conversation", - "Orchestration" + "Utf16CodeUnit" ], "x-ms-enum": { - "name": "ProjectKind", + "name": "StringIndexType", "modelAsString": true, "values": [ { - "value": "Conversation", - "description": "A project to build natural language into apps, bots, and IoT devices." - }, - { - "value": "Orchestration", - "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "The offset and length values will correspond to UTF-16 code units. Use this\noption if your application is written in a language that support Unicode, for\nexample Java, JavaScript." } ] }, diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulCancelTrainingJob.json new file mode 100644 index 000000000000..4a5adb1de3cf --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulCancelTrainingJob.json @@ -0,0 +1,18 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_CancelTrainingJob", + "title": "Successful Cancel Training Job", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulCreateProject.json new file mode 100644 index 000000000000..eb8e9f98c34b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulCreateProject.json @@ -0,0 +1,46 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_CreateProject", + "title": "Successful Create Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/merge-patch+json", + "api-version": "2023-04-01", + "projectName": "myproject", + "body": { + "projectName": "myproject", + "language": "en", + "projectKind": "Conversation", + "description": "This is a sample conversation project.", + "multilingual": false + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + }, + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "lastTrainedDateTime": "2022-04-18T14:14:28Z", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeleteDeployment.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeleteDeployment.json new file mode 100644 index 000000000000..501a4d76422e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeleteDeployment.json @@ -0,0 +1,18 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_DeleteDeployment", + "title": "Successful Delete Deployment", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "deploymentName": "staging" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/staging/jobs/61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000?api-version=2023-04-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeleteModel.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeleteModel.json new file mode 100644 index 000000000000..d26273b5afc1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeleteModel.json @@ -0,0 +1,14 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_DeleteTrainedModel", + "title": "Successful Delete Model", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "trainedModelLabel": "model2" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeleteProject.json new file mode 100644 index 000000000000..a3acdc62663c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeleteProject.json @@ -0,0 +1,17 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_DeleteProject", + "title": "Successful Delete Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "myproject" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/global/deletion-jobs/129d3182-625d-496c-bcf9-43686e85160b_637858368000000000?api-version=2023-04-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeployProject.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeployProject.json new file mode 100644 index 000000000000..6126317b23a7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeployProject.json @@ -0,0 +1,21 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_DeployProject", + "title": "Successful Deploy Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "deploymentName": "production", + "body": { + "trainedModelLabel": "29886710a2ae49259d62cffca977db66" + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/production/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2023-04-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulExportProject.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulExportProject.json new file mode 100644 index 000000000000..35a62393cb4b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulExportProject.json @@ -0,0 +1,18 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_Export", + "title": "Successful Export Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "stringIndexType": "Utf16CodeUnit" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetDeployment.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetDeployment.json new file mode 100644 index 000000000000..67f138a743fc --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetDeployment.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetDeployment", + "title": "Successful Get Deployment", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "deploymentName": "staging" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "deploymentName": "staging", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", + "lastDeployedDateTime": "2022-04-18T15:53:04Z", + "deploymentExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetDeploymentStatus.json new file mode 100644 index 000000000000..9b395ff4f3e3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetDeploymentStatus.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetDeploymentStatus", + "title": "Successful Get Deployment Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "deploymentName": "production", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetExportStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetExportStatus.json new file mode 100644 index 000000000000..396fde0729d1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetExportStatus.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetExportStatus", + "title": "Successful Get Export Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "resultUrl": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000/result?api-version=2023-04-01", + "jobId": "c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000", + "createdDateTime": "2022-04-18T15:23:07Z", + "lastUpdatedDateTime": "2022-04-18T15:23:08Z", + "expirationDateTime": "2022-04-25T15:23:07Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetImportStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetImportStatus.json new file mode 100644 index 000000000000..4b70711fba95 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetImportStatus.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetImportStatus", + "title": "Successful Get Import Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000", + "createdDateTime": "2022-04-18T15:17:20Z", + "lastUpdatedDateTime": "2022-04-18T15:17:22Z", + "expirationDateTime": "2022-04-25T15:17:20Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetLoadSnapshotStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetLoadSnapshotStatus.json new file mode 100644 index 000000000000..52e7fb4e3bfe --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetLoadSnapshotStatus.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetLoadSnapshotStatus", + "title": "Successful Get Load Snapshot Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "trainedModelLabel": "model1", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:45:48Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "running" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetModel.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetModel.json new file mode 100644 index 000000000000..5bb2e9921127 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetModel.json @@ -0,0 +1,25 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetTrainedModel", + "title": "Successful Get Model", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "trainedModelLabel": "model1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "label": "model1", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49Z", + "lastTrainingDurationInSeconds": 186, + "modelExpirationDate": "2022-10-28", + "modelTrainingConfigVersion": "2022-05-01", + "hasSnapshot": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetModelEvaluation.json new file mode 100644 index 000000000000..4dd48dfb5cc2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetModelEvaluation.json @@ -0,0 +1,286 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationResults", + "title": "Successful Get Model Evaluation", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "trainedModelLabel": "model1", + "stringIndexType": "Utf16CodeUnit", + "maxpagesize": 10 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "text": "send the email", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [], + "predictedEntities": [] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "send a mail to daniel", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 15, + "length": 6 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 15, + "length": 6 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "i forgot to add an important part to that email to james . please set it up to edit", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 51, + "length": 5 + } + ], + "predictedEntities": [ + { + "category": "Category", + "offset": 19, + "length": 9 + }, + { + "category": "ContactName", + "offset": 51, + "length": 5 + } + ] + }, + "intentsResult": { + "expectedIntent": "AddMore", + "predictedIntent": "AddMore" + } + }, + { + "text": "send email to a and tian", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 14, + "length": 1 + }, + { + "category": "ContactName", + "offset": 20, + "length": 4 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 14, + "length": 1 + }, + { + "category": "ContactName", + "offset": 20, + "length": 4 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "send thomas an email", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 5, + "length": 6 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 5, + "length": 6 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "i need to add more to the email message i am sending to vincent", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 56, + "length": 7 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 56, + "length": 7 + } + ] + }, + "intentsResult": { + "expectedIntent": "AddMore", + "predictedIntent": "AddMore" + } + }, + { + "text": "send an email to lily roth and abc123@microsoft.com", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 17, + "length": 9 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 17, + "length": 9 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "i need to add something else to my email to cheryl", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 44, + "length": 6 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 44, + "length": 6 + } + ] + }, + "intentsResult": { + "expectedIntent": "AddMore", + "predictedIntent": "AddMore" + } + }, + { + "text": "send an email to larry , joseph and billy larkson", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 17, + "length": 5 + }, + { + "category": "ContactName", + "offset": 25, + "length": 6 + }, + { + "category": "ContactName", + "offset": 36, + "length": 13 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 17, + "length": 5 + }, + { + "category": "ContactName", + "offset": 25, + "length": 6 + }, + { + "category": "ContactName", + "offset": 36, + "length": 13 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "send mail to dorothy", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 13, + "length": 7 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 13, + "length": 7 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + } + ], + "nextLink": "https://api.example.com/language/authoring/analyze-conversations/projects/EmailApp/models/model1/evaluation/result/?api-version=2023-04-01&top=2147483637&skip=100&maxpagesize=100" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetModelEvaluationSummary.json new file mode 100644 index 000000000000..6daf3fcfb0b8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetModelEvaluationSummary.json @@ -0,0 +1,528 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationSummary", + "title": "Successful Get Model Evaluation Summary", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "trainedModelLabel": "model1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "entitiesEvaluation": { + "confusionMatrix": { + "Attachment": { + "Attachment": { + "normalizedValue": 100.0, + "rawValue": 3.0 + } + }, + "Category": { + "Category": { + "normalizedValue": 91.666664, + "rawValue": 11.0 + }, + "$none": { + "normalizedValue": 8.333333, + "rawValue": 1.0 + } + }, + "ContactName": { + "ContactName": { + "normalizedValue": 91.666664, + "rawValue": 22.0 + }, + "SenderName": { + "normalizedValue": 4.1666665, + "rawValue": 1.0 + }, + "$none": { + "normalizedValue": 4.1666665, + "rawValue": 1.0 + } + }, + "Date": { + "Date": { + "normalizedValue": 100.0, + "rawValue": 2.0 + } + }, + "EmailSubject": { + "EmailSubject": { + "normalizedValue": 93.33333, + "rawValue": 9.333334 + }, + "$none": { + "normalizedValue": 6.6666665, + "rawValue": 0.6666667 + } + }, + "FromRelationshipName": { + "FromRelationshipName": { + "normalizedValue": 100.0, + "rawValue": 1.0 + } + }, + "Line": { + "Line": { + "normalizedValue": 100.0, + "rawValue": 2.0 + } + }, + "Message": { + "Message": { + "normalizedValue": 81.2063, + "rawValue": 6.496504 + }, + "EmailSubject": { + "normalizedValue": 7.43007, + "rawValue": 0.5944056 + }, + "$none": { + "normalizedValue": 9.120047, + "rawValue": 0.7296037 + }, + "Date": { + "normalizedValue": 2.2435899, + "rawValue": 0.17948718 + } + }, + "OrderReference": { + "OrderReference": { + "normalizedValue": 100.0, + "rawValue": 17.0 + } + }, + "PositionReference": { + "$none": { + "normalizedValue": 100.0, + "rawValue": 1.0 + } + }, + "RelationshipName": { + "RelationshipName": { + "normalizedValue": 66.666664, + "rawValue": 2.0 + }, + "$none": { + "normalizedValue": 33.333332, + "rawValue": 1.0 + } + }, + "SearchTexts": { + "SearchTexts": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "SenderName": { + "SenderName": { + "normalizedValue": 88.888885, + "rawValue": 8.0 + }, + "ContactName": { + "normalizedValue": 11.111111, + "rawValue": 1.0 + } + }, + "Time": { + "$none": { + "normalizedValue": 100.0, + "rawValue": 2.0 + } + }, + "$none": { + "$none": { + "normalizedValue": 99.739265, + "rawValue": 162.575 + }, + "Category": { + "normalizedValue": 0.2607362, + "rawValue": 0.425 + } + } + }, + "entities": { + "ContactName": { + "f1": 0.9361702799797058, + "precision": 0.95652174949646, + "recall": 0.9166666865348816, + "truePositiveCount": 22, + "trueNegativeCount": 0, + "falsePositiveCount": 1, + "falseNegativeCount": 2 + }, + "Category": { + "f1": 0.8799999952316284, + "precision": 0.8461538553237915, + "recall": 0.9166666865348816, + "truePositiveCount": 11, + "trueNegativeCount": 0, + "falsePositiveCount": 2, + "falseNegativeCount": 1 + }, + "SenderName": { + "f1": 0.8888888955116272, + "precision": 0.8888888955116272, + "recall": 0.8888888955116272, + "truePositiveCount": 8, + "trueNegativeCount": 0, + "falsePositiveCount": 1, + "falseNegativeCount": 1 + }, + "EmailSubject": { + "f1": 0.8181817531585693, + "precision": 0.75, + "recall": 0.8999999761581421, + "truePositiveCount": 9, + "trueNegativeCount": 0, + "falsePositiveCount": 3, + "falseNegativeCount": 1 + }, + "Message": { + "f1": 0.75, + "precision": 0.75, + "recall": 0.75, + "truePositiveCount": 6, + "trueNegativeCount": 0, + "falsePositiveCount": 2, + "falseNegativeCount": 2 + }, + "Date": { + "f1": 0.800000011920929, + "precision": 0.6666666865348816, + "recall": 1.0, + "truePositiveCount": 2, + "trueNegativeCount": 0, + "falsePositiveCount": 1, + "falseNegativeCount": 0 + }, + "OrderReference": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 17, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "SearchTexts": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Attachment": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 3, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "RelationshipName": { + "f1": 0.800000011920929, + "precision": 1.0, + "recall": 0.6666666865348816, + "truePositiveCount": 2, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 1 + }, + "Line": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 2, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Time": { + "f1": 0.0, + "precision": 0.0, + "recall": 0.0, + "truePositiveCount": 0, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 2 + }, + "FromRelationshipName": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 1, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "PositionReference": { + "f1": 0.0, + "precision": 0.0, + "recall": 0.0, + "truePositiveCount": 0, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 1 + } + }, + "microF1": 0.8923077, + "microPrecision": 0.8969072, + "microRecall": 0.8877551, + "macroF1": 0.7766601, + "macroPrecision": 0.7755879, + "macroRecall": 0.78849214 + }, + "intentsEvaluation": { + "confusionMatrix": { + "AddFlag": { + "AddFlag": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "AddMore": { + "AddMore": { + "normalizedValue": 100.0, + "rawValue": 17.0 + } + }, + "Cancel": { + "Cancel": { + "normalizedValue": 100.0, + "rawValue": 9.0 + } + }, + "CheckMessages": { + "CheckMessages": { + "normalizedValue": 100.0, + "rawValue": 9.0 + } + }, + "Confirm": { + "Confirm": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "Delete": { + "Delete": { + "normalizedValue": 100.0, + "rawValue": 5.0 + } + }, + "Forward": { + "Forward": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "None": { + "None": { + "normalizedValue": 100.0, + "rawValue": 1.0 + } + }, + "QueryLastText": { + "QueryLastText": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "ReadAloud": { + "ReadAloud": { + "normalizedValue": 100.0, + "rawValue": 16.0 + } + }, + "Reply": { + "Reply": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "SearchMessages": { + "SearchMessages": { + "normalizedValue": 100.0, + "rawValue": 9.0 + } + }, + "SendEmail": { + "SendEmail": { + "normalizedValue": 100.0, + "rawValue": 20.0 + } + }, + "ShowNext": { + "ShowNext": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "ShowPrevious": { + "ShowPrevious": { + "normalizedValue": 100.0, + "rawValue": 3.0 + } + } + }, + "intents": { + "AddMore": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 17, + "trueNegativeCount": 104, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Cancel": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 9, + "trueNegativeCount": 112, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "SendEmail": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 20, + "trueNegativeCount": 101, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "CheckMessages": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 9, + "trueNegativeCount": 112, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "AddFlag": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Reply": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "ReadAloud": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 16, + "trueNegativeCount": 105, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "QueryLastText": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "SearchMessages": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 9, + "trueNegativeCount": 112, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Delete": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 5, + "trueNegativeCount": 116, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Forward": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Confirm": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 117, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "ShowNext": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 117, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "ShowPrevious": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 3, + "trueNegativeCount": 118, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "None": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 1, + "trueNegativeCount": 120, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + } + }, + "microF1": 1.0, + "microPrecision": 1.0, + "microRecall": 1.0, + "macroF1": 1.0, + "macroPrecision": 1.0, + "macroRecall": 1.0 + }, + "evaluationOptions": { + "kind": "percentage", + "trainingSplitPercentage": 80, + "testingSplitPercentage": 20 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetProject.json new file mode 100644 index 000000000000..ae7d1bd2b688 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetProject.json @@ -0,0 +1,26 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetProject", + "title": "Successful Get Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "myproject" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "lastTrainedDateTime": "2022-04-18T14:14:28Z", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetProjectDeletionStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetProjectDeletionStatus.json new file mode 100644 index 000000000000..59061c1f7931 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetProjectDeletionStatus.json @@ -0,0 +1,22 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetProjectDeletionStatus", + "title": "Successful Get Project Deletion Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000", + "createdDateTime": "2022-04-18T14:02:34Z", + "lastUpdatedDateTime": "2022-04-18T14:02:34Z", + "expirationDateTime": "2022-04-25T14:02:34Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSupportedLanguages.json new file mode 100644 index 000000000000..545214c68df8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSupportedLanguages.json @@ -0,0 +1,400 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetSupportedLanguages", + "title": "Successful Get Supported Languages", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectKind": "Conversation" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "languageName": "English", + "languageCode": "en" + }, + { + "languageName": "English", + "languageCode": "en-us" + }, + { + "languageName": "English (UK)", + "languageCode": "en-gb" + }, + { + "languageName": "French", + "languageCode": "fr" + }, + { + "languageName": "Italian", + "languageCode": "it" + }, + { + "languageName": "Spanish", + "languageCode": "es" + }, + { + "languageName": "German", + "languageCode": "de" + }, + { + "languageName": "Portuguese (Brazil)", + "languageCode": "pt-br" + }, + { + "languageName": "Portuguese (Portugal)", + "languageCode": "pt-pt" + }, + { + "languageName": "Chinese (Simplified)", + "languageCode": "zh-hans" + }, + { + "languageName": "Japanese", + "languageCode": "ja" + }, + { + "languageName": "Korean", + "languageCode": "ko" + }, + { + "languageName": "Dutch", + "languageCode": "nl" + }, + { + "languageName": "Hindi", + "languageCode": "hi" + }, + { + "languageName": "Turkish", + "languageCode": "tr" + }, + { + "languageName": "Gujarati", + "languageCode": "gu" + }, + { + "languageName": "Marathi", + "languageCode": "mr" + }, + { + "languageName": "Tamil", + "languageCode": "ta" + }, + { + "languageName": "Telugu", + "languageCode": "te" + }, + { + "languageName": "Zulu", + "languageCode": "zu" + }, + { + "languageName": "Afrikaans", + "languageCode": "af" + }, + { + "languageName": "Amharic", + "languageCode": "am" + }, + { + "languageName": "Arabic", + "languageCode": "ar" + }, + { + "languageName": "Assamese", + "languageCode": "as" + }, + { + "languageName": "Azerbaijani", + "languageCode": "az" + }, + { + "languageName": "Belarusian", + "languageCode": "be" + }, + { + "languageName": "Bulgarian", + "languageCode": "bg" + }, + { + "languageName": "Breton", + "languageCode": "br" + }, + { + "languageName": "Bosnian", + "languageCode": "bs" + }, + { + "languageName": "Catalan", + "languageCode": "ca" + }, + { + "languageName": "Czech", + "languageCode": "cs" + }, + { + "languageName": "Welsh", + "languageCode": "cy" + }, + { + "languageName": "Danish", + "languageCode": "da" + }, + { + "languageName": "Greek", + "languageCode": "el" + }, + { + "languageName": "Esperanto", + "languageCode": "eo" + }, + { + "languageName": "Estonian", + "languageCode": "et" + }, + { + "languageName": "Basque", + "languageCode": "eu" + }, + { + "languageName": "Persian", + "languageCode": "fa" + }, + { + "languageName": "Finnish", + "languageCode": "fi" + }, + { + "languageName": "Western Frisian", + "languageCode": "fy" + }, + { + "languageName": "Irish", + "languageCode": "ga" + }, + { + "languageName": "Scottish Gaelic", + "languageCode": "gd" + }, + { + "languageName": "Galician", + "languageCode": "gl" + }, + { + "languageName": "Hausa", + "languageCode": "ha" + }, + { + "languageName": "Hebrew", + "languageCode": "he" + }, + { + "languageName": "Croatian", + "languageCode": "hr" + }, + { + "languageName": "Hungarian", + "languageCode": "hu" + }, + { + "languageName": "Armenian", + "languageCode": "hy" + }, + { + "languageName": "Indonesian", + "languageCode": "id" + }, + { + "languageName": "Javanese", + "languageCode": "jv" + }, + { + "languageName": "Georgian", + "languageCode": "ka" + }, + { + "languageName": "Kazakh", + "languageCode": "kk" + }, + { + "languageName": "Khmer", + "languageCode": "km" + }, + { + "languageName": "Kannada", + "languageCode": "kn" + }, + { + "languageName": "Kurdish (Kurmanji)", + "languageCode": "ku" + }, + { + "languageName": "Kyrgyz", + "languageCode": "ky" + }, + { + "languageName": "Latin", + "languageCode": "la" + }, + { + "languageName": "Lao", + "languageCode": "lo" + }, + { + "languageName": "Lithuanian", + "languageCode": "lt" + }, + { + "languageName": "Latvian", + "languageCode": "lv" + }, + { + "languageName": "Malagasy", + "languageCode": "mg" + }, + { + "languageName": "Macedonian", + "languageCode": "mk" + }, + { + "languageName": "Malayalam", + "languageCode": "ml" + }, + { + "languageName": "Mongolian", + "languageCode": "mn" + }, + { + "languageName": "Malay", + "languageCode": "ms" + }, + { + "languageName": "Burmese", + "languageCode": "my" + }, + { + "languageName": "Nepali", + "languageCode": "ne" + }, + { + "languageName": "Norwegian (Bokmal)", + "languageCode": "nb" + }, + { + "languageName": "Odia", + "languageCode": "or" + }, + { + "languageName": "Punjabi", + "languageCode": "pa" + }, + { + "languageName": "Polish", + "languageCode": "pl" + }, + { + "languageName": "Pashto", + "languageCode": "ps" + }, + { + "languageName": "Romanian", + "languageCode": "ro" + }, + { + "languageName": "Russian", + "languageCode": "ru" + }, + { + "languageName": "Sanskrit", + "languageCode": "sa" + }, + { + "languageName": "Sindhi", + "languageCode": "sd" + }, + { + "languageName": "Sinhala", + "languageCode": "si" + }, + { + "languageName": "Slovak", + "languageCode": "sk" + }, + { + "languageName": "Slovenian", + "languageCode": "sl" + }, + { + "languageName": "Somali", + "languageCode": "so" + }, + { + "languageName": "Albanian", + "languageCode": "sq" + }, + { + "languageName": "Serbian", + "languageCode": "sr" + }, + { + "languageName": "Sundanese", + "languageCode": "su" + }, + { + "languageName": "Swedish", + "languageCode": "sv" + }, + { + "languageName": "Swahili", + "languageCode": "sw" + }, + { + "languageName": "Thai", + "languageCode": "th" + }, + { + "languageName": "Filipino", + "languageCode": "tl" + }, + { + "languageName": "Uyghur", + "languageCode": "ug" + }, + { + "languageName": "Ukrainian", + "languageCode": "uk" + }, + { + "languageName": "Urdu", + "languageCode": "ur" + }, + { + "languageName": "Uzbek", + "languageCode": "uz" + }, + { + "languageName": "Vietnamese", + "languageCode": "vi" + }, + { + "languageName": "Xhosa", + "languageCode": "xh" + }, + { + "languageName": "Yiddish", + "languageCode": "yi" + }, + { + "languageName": "Chinese (Traditional)", + "languageCode": "zh-hant" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSupportedPrebuiltEntities.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSupportedPrebuiltEntities.json new file mode 100644 index 000000000000..9bea82d1eed2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSupportedPrebuiltEntities.json @@ -0,0 +1,100 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetSupportedPrebuiltEntities", + "title": "Successful Get Supported Prebuilt Entities", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "language": "en" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "category": "Person.Name", + "description": "Name of an individual", + "examples": "john, Sam, Lisa" + }, + { + "category": "General.Event", + "description": "Important events", + "examples": "World War two, Covid 19" + }, + { + "category": "General.Organization", + "description": "Companies and corporations", + "examples": "Microsoft, Amazon" + }, + { + "category": "Choice.Boolean", + "description": "boolean choice", + "examples": "yes, no, agreed" + }, + { + "category": "Quantity.Age", + "description": "Age of a person or thing", + "examples": "10-month-old, 19 years old, 58 year-old" + }, + { + "category": "Quantity.NumberRange", + "description": "a numeric interval", + "examples": "between 25 and 35, 25-35" + }, + { + "category": "Quantity.Number", + "description": "A cardinal number in numeric or text form", + "examples": "ten, forty two, 3.141, 10K" + }, + { + "category": "Quantity.Percentage", + "description": "A percentage, using the symbol % or the word \"percent\"", + "examples": "10%, 5.6 percent" + }, + { + "category": "Quantity.Ordinal", + "description": "An ordinal number in numeric or text form", + "examples": "first, second, tenth, 1st, 2nd, 10th" + }, + { + "category": "Quantity.Dimension", + "description": "Spacial dimensions, including length, distance, area, and volume", + "examples": "2 miles, 650 square kilometres, 9,350 feet" + }, + { + "category": "Quantity.Temperature", + "description": "A temperature in celsius or fahrenheit", + "examples": "32F, 34 degrees celsius, 2 deg C" + }, + { + "category": "Quantity.Currency", + "description": "Monetary amounts, including currency", + "examples": "1000.00 US dollars, £20.00, $ 67.5 B" + }, + { + "category": "DateTime", + "description": "exact date values", + "examples": "May 11th" + }, + { + "category": "Email", + "description": "Email addresses", + "examples": "user@example.net, user_name@example.com, user.Name12@example.net" + }, + { + "category": "Phone Number", + "description": "US phone numbers", + "examples": "123-456-7890, +1 123 456 789, (123)456-789" + }, + { + "category": "URL", + "description": "Websites URLs and links", + "examples": "www.example.com, http://example.net?name=my_name&age=10" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSupportedTrainingConfigVersions.json new file mode 100644 index 000000000000..baf3e1d78dfc --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSupportedTrainingConfigVersions.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_ListTrainingConfigVersions", + "title": "Successful Get Supported Training Config Versions", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectKind": "Conversation" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "trainingConfigVersion": "2022-05-01", + "modelExpirationDate": "2022-10-28" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSwapDeploymentsStatus.json new file mode 100644 index 000000000000..a904361d0a70 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSwapDeploymentsStatus.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetSwapDeploymentsStatus", + "title": "Successful Get Swap Deployments Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000", + "createdDateTime": "2022-04-18T16:09:50Z", + "lastUpdatedDateTime": "2022-04-18T16:09:58Z", + "expirationDateTime": "2022-04-25T16:09:50Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetTrainStatus.json new file mode 100644 index 000000000000..e95467f15ac6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetTrainStatus.json @@ -0,0 +1,38 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetTrainingStatus", + "title": "Successful Get Train Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "result": { + "modelLabel": "model1", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "standard", + "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z", + "trainingStatus": { + "percentComplete": 3, + "startDateTime": "2022-04-18T15:45:06.8190649Z", + "status": "running" + }, + "evaluationStatus": { + "percentComplete": 0, + "status": "notStarted" + } + }, + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:45:48Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "running" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulImportProject.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulImportProject.json new file mode 100644 index 000000000000..3cf13bd844f8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulImportProject.json @@ -0,0 +1,80 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_Import", + "title": "Successful Import Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "body": { + "projectFileVersion": "2022-05-01", + "stringIndexType": "Utf16CodeUnit", + "metadata": { + "projectKind": "Conversation", + "settings": { + "confidenceThreshold": 0.7 + }, + "projectName": "EmailApp", + "multilingual": true, + "description": "Trying out CLU", + "language": "en-us" + }, + "assets": { + "projectKind": "Conversation", + "intents": [ + { + "category": "Read" + }, + { + "category": "Delete" + } + ], + "entities": [ + { + "category": "Sender" + }, + { + "category": "Number", + "regex": { + "expressions": [ + { + "regexKey": "UK Phone numbers", + "language": "en-us", + "regexPattern": "/^\\(?([0-9]{3})\\)?[-.\\s]?([0-9]{3})[-.\\s]?([0-9]{4})$/" + } + ] + } + } + ], + "utterances": [ + { + "text": "Open Blake's email", + "dataset": "Train", + "intent": "Read", + "entities": [ + { + "category": "Sender", + "offset": 5, + "length": 5 + } + ] + }, + { + "text": "Delete last email", + "language": "en-gb", + "dataset": "Test", + "intent": "Delete", + "entities": [] + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListDeployments.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListDeployments.json new file mode 100644 index 000000000000..c92e5ebd7bfe --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListDeployments.json @@ -0,0 +1,35 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_ListDeployments", + "title": "Successful List Deployments", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "deploymentName": "production", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", + "lastDeployedDateTime": "2022-04-18T16:03:51Z", + "deploymentExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-01" + }, + { + "deploymentName": "staging", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", + "lastDeployedDateTime": "2022-04-18T15:53:04Z", + "deploymentExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-01" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListModels.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListModels.json new file mode 100644 index 000000000000..12bc75279ea3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListModels.json @@ -0,0 +1,38 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_ListTrainedModels", + "title": "Successful List Models", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "label": "model1", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49Z", + "lastTrainingDurationInSeconds": 186, + "modelExpirationDate": "2022-10-28", + "modelTrainingConfigVersion": "2022-05-01", + "hasSnapshot": true + }, + { + "label": "model2", + "modelId": "model2-20220418T052522-c63bd244dd9e4bf8adec1a7129968c99", + "lastTrainedDateTime": "2022-04-18T17:25:22Z", + "lastTrainingDurationInSeconds": 192, + "modelExpirationDate": "2022-10-28", + "modelTrainingConfigVersion": "2022-05-01", + "hasSnapshot": true + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListProjects.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListProjects.json new file mode 100644 index 000000000000..b3e66b3d7364 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListProjects.json @@ -0,0 +1,37 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_ListProjects", + "title": "Successful List Projects", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "createdDateTime": "2022-04-18T14:03:16Z", + "lastModifiedDateTime": "2022-04-18T14:03:16Z", + "projectKind": "Conversation", + "projectName": "myproject1", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + }, + { + "createdDateTime": "2022-04-18T14:03:12Z", + "lastModifiedDateTime": "2022-04-18T14:03:12Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListTrainingJobs.json new file mode 100644 index 000000000000..b601958cdf62 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListTrainingJobs.json @@ -0,0 +1,92 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_ListTrainingJobs", + "title": "Successful List Training Jobs", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "result": { + "modelLabel": "model1", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "advanced", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T15:45:06.8190649Z", + "endDateTime": "2022-04-18T15:47:19.2639682Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T15:47:19.2734976Z", + "endDateTime": "2022-04-18T15:47:23.8378892Z", + "status": "succeeded" + } + }, + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:47:50Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "succeeded" + }, + { + "result": { + "modelLabel": "model2", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "standard", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:22:39.3663023Z", + "endDateTime": "2022-04-18T17:24:51.9440947Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:24:51.9571747Z", + "endDateTime": "2022-04-18T17:24:58.1427823Z", + "status": "succeeded" + } + }, + "jobId": "9145f93f-6f37-418c-8527-d2ded84cece0_637858368000000000", + "createdDateTime": "2022-04-18T17:22:11Z", + "lastUpdatedDateTime": "2022-04-18T17:25:23Z", + "expirationDateTime": "2022-04-25T17:22:11Z", + "status": "succeeded" + }, + { + "result": { + "modelLabel": "model2", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "standard", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:44:41.388358Z", + "endDateTime": "2022-04-18T17:50:29.5675101Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:50:29.5808461Z", + "endDateTime": "2022-04-18T17:50:35.3482185Z", + "status": "succeeded" + } + }, + "jobId": "ee23c900-354d-4b6d-96e1-8197db2bd5f7_637858368000000000", + "createdDateTime": "2022-04-18T17:44:04Z", + "lastUpdatedDateTime": "2022-04-18T17:51:11Z", + "expirationDateTime": "2022-04-25T17:44:04Z", + "status": "succeeded" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulLoadSnapshot.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulLoadSnapshot.json new file mode 100644 index 000000000000..b82ac165a0b8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulLoadSnapshot.json @@ -0,0 +1,18 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_LoadSnapshot", + "title": "Successful Load Snapshot", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "trainedModelLabel": "model1" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/models/model1/load-snapshot/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulSwapDeployments.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulSwapDeployments.json new file mode 100644 index 000000000000..305893a716b8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulSwapDeployments.json @@ -0,0 +1,21 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_SwapDeployments", + "title": "Successful Swap Deployments", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "body": { + "firstDeploymentName": "production", + "secondDeploymentName": "staging" + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/swap/jobs/c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000?api-version=2023-04-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulTrainProject.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulTrainProject.json new file mode 100644 index 000000000000..74a43e3c0c8e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulTrainProject.json @@ -0,0 +1,27 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_Train", + "title": "Successful Train Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "body": { + "modelLabel": "model1", + "trainingMode": "standard", + "trainingConfigVersion": "latest", + "evaluationOptions": { + "kind": "percentage", + "testingSplitPercentage": 20, + "trainingSplitPercentage": 80 + } + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01" + } + } + } +} From 7596e3abde9662228a9291d3cb62ad5a7fb7d083 Mon Sep 17 00:00:00 2001 From: Chinonso Chukwuogor <nonsochukwuogor@gmail.com> Date: Thu, 3 Oct 2024 14:06:01 -0700 Subject: [PATCH 37/47] AIO M3 preview (#30429) * Remove service name default * no change * add new type * tsv * move to auth * format changes * add non-empty * chnge back * push readme * fix * fix examples * 9-15 * tsv * non-empty string * get rid of components * schema registry id * components examples * Case * schema registry id * schema registry id * fix surpression * fix sub id * changed * schema reg ref * schemaref * fix schema ref * Instance update * format * add batching * Revert "add batching" This reverts commit 3f67f9489407d6ff794bbac841b64b9500b36e76. * remove otel config --------- Co-authored-by: John Lian <jlian@users.noreply.github.com> --- ...Authentication_CreateOrUpdate_Complex.json | 180 + ...ication_CreateOrUpdate_MaximumSet_Gen.json | 168 + ...rAuthentication_Delete_MaximumSet_Gen.json | 20 + ...okerAuthentication_Get_MaximumSet_Gen.json | 69 + ...on_ListByResourceGroup_MaximumSet_Gen.json | 73 + ...rAuthorization_CreateOrUpdate_Complex.json | 243 + ...ization_CreateOrUpdate_MaximumSet_Gen.json | 189 + ...erAuthorization_CreateOrUpdate_Simple.json | 186 + ...erAuthorization_Delete_MaximumSet_Gen.json | 20 + ...rokerAuthorization_Get_MaximumSet_Gen.json | 76 + ...on_ListByResourceGroup_MaximumSet_Gen.json | 80 + ...BrokerListener_CreateOrUpdate_Complex.json | 182 + ...istener_CreateOrUpdate_MaximumSet_Gen.json | 186 + .../BrokerListener_CreateOrUpdate_Simple.json | 88 + .../BrokerListener_Delete_MaximumSet_Gen.json | 20 + .../BrokerListener_Get_MaximumSet_Gen.json | 75 + ...er_ListByResourceGroup_MaximumSet_Gen.json | 79 + .../Broker_CreateOrUpdate_Complex.json | 122 + .../Broker_CreateOrUpdate_MaximumSet_Gen.json | 500 ++ .../Broker_CreateOrUpdate_Minimal.json | 357 + .../Broker_CreateOrUpdate_Simple.json | 371 + .../Broker_Delete_MaximumSet_Gen.json | 19 + .../Broker_Get_MaximumSet_Gen.json | 179 + ...er_ListByResourceGroup_MaximumSet_Gen.json | 183 + ...ataflowEndpoint_CreateOrUpdate_ADLSv2.json | 98 + .../DataflowEndpoint_CreateOrUpdate_ADX.json | 107 + .../DataflowEndpoint_CreateOrUpdate_AIO.json | 110 + ...flowEndpoint_CreateOrUpdate_EventGrid.json | 101 + ...aflowEndpoint_CreateOrUpdate_EventHub.json | 104 + ...ataflowEndpoint_CreateOrUpdate_Fabric.json | 107 + ...DataflowEndpoint_CreateOrUpdate_Kafka.json | 149 + ...wEndpoint_CreateOrUpdate_LocalStorage.json | 80 + .../DataflowEndpoint_CreateOrUpdate_MQTT.json | 128 + ...ndpoint_CreateOrUpdate_MaximumSet_Gen.json | 476 ++ ...ataflowEndpoint_Delete_MaximumSet_Gen.json | 19 + .../DataflowEndpoint_Get_MaximumSet_Gen.json | 171 + ...nt_ListByResourceGroup_MaximumSet_Gen.json | 175 + ...Profile_CreateOrUpdate_MaximumSet_Gen.json | 95 + ...ataflowProfile_CreateOrUpdate_Minimal.json | 71 + .../DataflowProfile_CreateOrUpdate_Multi.json | 71 + ...DataflowProfile_Delete_MaximumSet_Gen.json | 19 + .../DataflowProfile_Get_MaximumSet_Gen.json | 44 + ...le_ListByResourceGroup_MaximumSet_Gen.json | 48 + ...eateOrUpdate_ComplexContextualization.json | 222 + ...taflow_CreateOrUpdate_ComplexEventHub.json | 255 + ...Dataflow_CreateOrUpdate_FilterToTopic.json | 210 + ...ataflow_CreateOrUpdate_MaximumSet_Gen.json | 237 + ...taflow_CreateOrUpdate_SimpleEventGrid.json | 132 + .../Dataflow_CreateOrUpdate_SimpleFabric.json | 153 + .../Dataflow_Delete_MaximumSet_Gen.json | 20 + .../Dataflow_Get_MaximumSet_Gen.json | 92 + ..._ListByProfileResource_MaximumSet_Gen.json | 96 + ...nstance_CreateOrUpdate_MaximumSet_Gen.json | 103 + .../Instance_Delete_MaximumSet_Gen.json | 18 + .../Instance_Get_MaximumSet_Gen.json | 47 + ...ce_ListByResourceGroup_MaximumSet_Gen.json | 51 + ...nce_ListBySubscription_MaximumSet_Gen.json | 50 + .../Instance_Update_MaximumSet_Gen.json | 54 + .../Operations_List_MaximumSet_Gen.json | 28 + .../IoTOperations.Management/main.tsp | 4 +- .../IoTOperations.Management/models/base.tsp | 36 +- .../models/broker/brokers.tsp | 3 - .../models/broker/listeners.tsp | 2 +- .../models/dataflows/dataflowEndpoints.tsp | 4 +- .../models/dataflows/dataflows.tsp | 4 +- .../models/instance.tsp | 64 +- ...Authentication_CreateOrUpdate_Complex.json | 180 + ...ication_CreateOrUpdate_MaximumSet_Gen.json | 168 + ...rAuthentication_Delete_MaximumSet_Gen.json | 20 + ...okerAuthentication_Get_MaximumSet_Gen.json | 69 + ...on_ListByResourceGroup_MaximumSet_Gen.json | 73 + ...rAuthorization_CreateOrUpdate_Complex.json | 243 + ...ization_CreateOrUpdate_MaximumSet_Gen.json | 189 + ...erAuthorization_CreateOrUpdate_Simple.json | 186 + ...erAuthorization_Delete_MaximumSet_Gen.json | 20 + ...rokerAuthorization_Get_MaximumSet_Gen.json | 76 + ...on_ListByResourceGroup_MaximumSet_Gen.json | 80 + ...BrokerListener_CreateOrUpdate_Complex.json | 182 + ...istener_CreateOrUpdate_MaximumSet_Gen.json | 186 + .../BrokerListener_CreateOrUpdate_Simple.json | 88 + .../BrokerListener_Delete_MaximumSet_Gen.json | 20 + .../BrokerListener_Get_MaximumSet_Gen.json | 75 + ...er_ListByResourceGroup_MaximumSet_Gen.json | 79 + .../Broker_CreateOrUpdate_Complex.json | 122 + .../Broker_CreateOrUpdate_MaximumSet_Gen.json | 500 ++ .../Broker_CreateOrUpdate_Minimal.json | 357 + .../Broker_CreateOrUpdate_Simple.json | 371 + .../Broker_Delete_MaximumSet_Gen.json | 19 + .../examples/Broker_Get_MaximumSet_Gen.json | 179 + ...er_ListByResourceGroup_MaximumSet_Gen.json | 183 + ...ataflowEndpoint_CreateOrUpdate_ADLSv2.json | 98 + .../DataflowEndpoint_CreateOrUpdate_ADX.json | 107 + .../DataflowEndpoint_CreateOrUpdate_AIO.json | 110 + ...flowEndpoint_CreateOrUpdate_EventGrid.json | 101 + ...aflowEndpoint_CreateOrUpdate_EventHub.json | 104 + ...ataflowEndpoint_CreateOrUpdate_Fabric.json | 107 + ...DataflowEndpoint_CreateOrUpdate_Kafka.json | 149 + ...wEndpoint_CreateOrUpdate_LocalStorage.json | 80 + .../DataflowEndpoint_CreateOrUpdate_MQTT.json | 128 + ...ndpoint_CreateOrUpdate_MaximumSet_Gen.json | 476 ++ ...ataflowEndpoint_Delete_MaximumSet_Gen.json | 19 + .../DataflowEndpoint_Get_MaximumSet_Gen.json | 171 + ...nt_ListByResourceGroup_MaximumSet_Gen.json | 175 + ...Profile_CreateOrUpdate_MaximumSet_Gen.json | 95 + ...ataflowProfile_CreateOrUpdate_Minimal.json | 71 + .../DataflowProfile_CreateOrUpdate_Multi.json | 71 + ...DataflowProfile_Delete_MaximumSet_Gen.json | 19 + .../DataflowProfile_Get_MaximumSet_Gen.json | 44 + ...le_ListByResourceGroup_MaximumSet_Gen.json | 48 + ...eateOrUpdate_ComplexContextualization.json | 222 + ...taflow_CreateOrUpdate_ComplexEventHub.json | 255 + ...Dataflow_CreateOrUpdate_FilterToTopic.json | 210 + ...ataflow_CreateOrUpdate_MaximumSet_Gen.json | 237 + ...taflow_CreateOrUpdate_SimpleEventGrid.json | 132 + .../Dataflow_CreateOrUpdate_SimpleFabric.json | 153 + .../Dataflow_Delete_MaximumSet_Gen.json | 20 + .../examples/Dataflow_Get_MaximumSet_Gen.json | 92 + ..._ListByProfileResource_MaximumSet_Gen.json | 96 + ...nstance_CreateOrUpdate_MaximumSet_Gen.json | 103 + .../Instance_Delete_MaximumSet_Gen.json | 18 + .../examples/Instance_Get_MaximumSet_Gen.json | 47 + ...ce_ListByResourceGroup_MaximumSet_Gen.json | 51 + ...nce_ListBySubscription_MaximumSet_Gen.json | 50 + .../Instance_Update_MaximumSet_Gen.json | 54 + .../Operations_List_MaximumSet_Gen.json | 28 + .../2024-09-15-preview/iotoperations.json | 6569 +++++++++++++++++ .../iotoperations/resource-manager/readme.md | 11 +- 127 files changed, 21814 insertions(+), 95 deletions(-) create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_CreateOrUpdate_Complex.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_CreateOrUpdate_Complex.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_CreateOrUpdate_Simple.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_CreateOrUpdate_Complex.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_CreateOrUpdate_Simple.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_Complex.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_Minimal.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_Simple.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_ADLSv2.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_ADX.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_AIO.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_EventGrid.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_EventHub.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_Fabric.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_Kafka.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_LocalStorage.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_MQTT.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_CreateOrUpdate_Minimal.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_CreateOrUpdate_Multi.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_ComplexContextualization.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_ComplexEventHub.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_FilterToTopic.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_SimpleEventGrid.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_SimpleFabric.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_ListByProfileResource_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_Update_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Operations_List_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_CreateOrUpdate_Complex.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_CreateOrUpdate_Complex.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_CreateOrUpdate_Simple.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_CreateOrUpdate_Complex.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_CreateOrUpdate_Simple.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_Complex.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_Minimal.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_Simple.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_ADLSv2.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_ADX.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_AIO.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_EventGrid.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_EventHub.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_Fabric.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_Kafka.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_LocalStorage.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_MQTT.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_CreateOrUpdate_Minimal.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_CreateOrUpdate_Multi.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_ComplexContextualization.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_ComplexEventHub.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_FilterToTopic.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_SimpleEventGrid.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_SimpleFabric.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_ListByProfileResource_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_Update_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Operations_List_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/iotoperations.json diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_CreateOrUpdate_Complex.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_CreateOrUpdate_Complex.json new file mode 100644 index 000000000000..99df45a1ca21 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_CreateOrUpdate_Complex.json @@ -0,0 +1,180 @@ +{ + "title": "BrokerAuthentication_CreateOrUpdate_Complex", + "operationId": "BrokerAuthentication_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authenticationName": "resource-name123", + "resource": { + "properties": { + "authenticationMethods": [ + { + "method": "ServiceAccountToken", + "serviceAccountTokenSettings": { + "audiences": [ + "aio-internal" + ] + } + }, + { + "method": "X509", + "x509Settings": { + "trustedClientCaCert": "my-ca", + "authorizationAttributes": { + "root": { + "subject": "CN = Contoso Root CA Cert, OU = Engineering, C = US", + "attributes": { + "organization": "contoso" + } + }, + "intermediate": { + "subject": "CN = Contoso Intermediate CA", + "attributes": { + "city": "seattle", + "foo": "bar" + } + }, + "smart-fan": { + "subject": "CN = smart-fan", + "attributes": { + "building": "17" + } + } + } + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "authenticationMethods": [ + { + "method": "ServiceAccountToken", + "serviceAccountTokenSettings": { + "audiences": [ + "aio-internal" + ] + } + }, + { + "method": "X509", + "x509Settings": { + "trustedClientCaCert": "my-ca", + "authorizationAttributes": { + "root": { + "subject": "CN = Contoso Root CA Cert, OU = Engineering, C = US", + "attributes": { + "organization": "contoso" + } + }, + "intermediate": { + "subject": "CN = Contoso Intermediate CA", + "attributes": { + "city": "seattle", + "foo": "bar" + } + }, + "smart-fan": { + "subject": "CN = smart-fan", + "attributes": { + "building": "17" + } + } + } + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authentications/resource-name123", + "name": "lwucizfvtsdpx", + "type": "kvtilkgcxanlfozrd", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "authenticationMethods": [ + { + "method": "ServiceAccountToken", + "serviceAccountTokenSettings": { + "audiences": [ + "aio-internal" + ] + } + }, + { + "method": "X509", + "x509Settings": { + "trustedClientCaCert": "my-ca", + "authorizationAttributes": { + "root": { + "subject": "CN = Contoso Root CA Cert, OU = Engineering, C = US", + "attributes": { + "organization": "contoso" + } + }, + "intermediate": { + "subject": "CN = Contoso Intermediate CA", + "attributes": { + "city": "seattle", + "foo": "bar" + } + }, + "smart-fan": { + "subject": "CN = smart-fan", + "attributes": { + "building": "17" + } + } + } + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authentications/resource-name123", + "name": "lwucizfvtsdpx", + "type": "kvtilkgcxanlfozrd", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..56d2d89e12ab --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,168 @@ +{ + "title": "BrokerAuthentication_CreateOrUpdate", + "operationId": "BrokerAuthentication_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authenticationName": "resource-name123", + "resource": { + "properties": { + "authenticationMethods": [ + { + "method": "Custom", + "customSettings": { + "auth": { + "x509": { + "secretRef": "secret-name" + } + }, + "caCertConfigMap": "pdecudefqyolvncbus", + "endpoint": "https://www.example.com", + "headers": { + "key8518": "bwityjy" + } + }, + "serviceAccountTokenSettings": { + "audiences": [ + "jqyhyqatuydg" + ] + }, + "x509Settings": { + "authorizationAttributes": { + "key3384": { + "attributes": { + "key186": "ucpajramsz" + }, + "subject": "jpgwctfeixitptfgfnqhua" + } + }, + "trustedClientCaCert": "vlctsqddl" + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "authenticationMethods": [ + { + "method": "Custom", + "customSettings": { + "auth": { + "x509": { + "secretRef": "secret-name" + } + }, + "caCertConfigMap": "pdecudefqyolvncbus", + "endpoint": "https://www.example.com", + "headers": { + "key8518": "bwityjy" + } + }, + "serviceAccountTokenSettings": { + "audiences": [ + "jqyhyqatuydg" + ] + }, + "x509Settings": { + "authorizationAttributes": { + "key3384": { + "attributes": { + "key186": "ucpajramsz" + }, + "subject": "jpgwctfeixitptfgfnqhua" + } + }, + "trustedClientCaCert": "vlctsqddl" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authentications/resource-name123", + "name": "lwucizfvtsdpx", + "type": "kvtilkgcxanlfozrd", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "authenticationMethods": [ + { + "method": "Custom", + "customSettings": { + "auth": { + "x509": { + "secretRef": "secret-name" + } + }, + "caCertConfigMap": "pdecudefqyolvncbus", + "endpoint": "https://www.example.com", + "headers": { + "key8518": "bwityjy" + } + }, + "serviceAccountTokenSettings": { + "audiences": [ + "jqyhyqatuydg" + ] + }, + "x509Settings": { + "authorizationAttributes": { + "key3384": { + "attributes": { + "key186": "ucpajramsz" + }, + "subject": "jpgwctfeixitptfgfnqhua" + } + }, + "trustedClientCaCert": "vlctsqddl" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authentications/resource-name123", + "name": "lwucizfvtsdpx", + "type": "kvtilkgcxanlfozrd", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_Delete_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..2e8c7aa364f3 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "BrokerAuthentication_Delete", + "operationId": "BrokerAuthentication_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authenticationName": "resource-name123" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_Get_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..533d1b8f9a3a --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_Get_MaximumSet_Gen.json @@ -0,0 +1,69 @@ +{ + "title": "BrokerAuthentication_Get", + "operationId": "BrokerAuthentication_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authenticationName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "properties": { + "authenticationMethods": [ + { + "method": "Custom", + "customSettings": { + "auth": { + "x509": { + "secretRef": "secret-name" + } + }, + "caCertConfigMap": "pdecudefqyolvncbus", + "endpoint": "https://www.example.com", + "headers": { + "key8518": "bwityjy" + } + }, + "serviceAccountTokenSettings": { + "audiences": [ + "jqyhyqatuydg" + ] + }, + "x509Settings": { + "authorizationAttributes": { + "key3384": { + "attributes": { + "key186": "ucpajramsz" + }, + "subject": "jpgwctfeixitptfgfnqhua" + } + }, + "trustedClientCaCert": "vlctsqddl" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authentications/resource-name123", + "name": "lwucizfvtsdpx", + "type": "kvtilkgcxanlfozrd", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_ListByResourceGroup_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..8037bfab1583 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "title": "BrokerAuthentication_ListByResourceGroup", + "operationId": "BrokerAuthentication_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "authenticationMethods": [ + { + "method": "Custom", + "customSettings": { + "auth": { + "x509": { + "secretRef": "secret-name" + } + }, + "caCertConfigMap": "pdecudefqyolvncbus", + "endpoint": "https://www.example.com", + "headers": { + "key8518": "bwityjy" + } + }, + "serviceAccountTokenSettings": { + "audiences": [ + "jqyhyqatuydg" + ] + }, + "x509Settings": { + "authorizationAttributes": { + "key3384": { + "attributes": { + "key186": "ucpajramsz" + }, + "subject": "jpgwctfeixitptfgfnqhua" + } + }, + "trustedClientCaCert": "vlctsqddl" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authentications/resource-name123", + "name": "lwucizfvtsdpx", + "type": "kvtilkgcxanlfozrd", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_CreateOrUpdate_Complex.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_CreateOrUpdate_Complex.json new file mode 100644 index 000000000000..74ccc622f5c2 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_CreateOrUpdate_Complex.json @@ -0,0 +1,243 @@ +{ + "title": "BrokerAuthorization_CreateOrUpdate_Complex", + "operationId": "BrokerAuthorization_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authorizationName": "resource-name123", + "resource": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "principals": { + "usernames": [ + "temperature-sensor", + "humidity-sensor" + ], + "attributes": [ + { + "building": "17", + "organization": "contoso" + } + ] + }, + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "{principal.attributes.building}*" + ] + }, + { + "method": "Publish", + "topics": [ + "sensors/{principal.attributes.building}/{principal.clientId}/telemetry/*" + ] + }, + { + "method": "Subscribe", + "topics": [ + "commands/{principal.attributes.organization}" + ] + } + ], + "stateStoreResources": [ + { + "method": "Read", + "keyType": "Pattern", + "keys": [ + "myreadkey", + "myotherkey?", + "mynumerickeysuffix[0-9]", + "clients:{principal.clientId}:*" + ] + }, + { + "method": "ReadWrite", + "keyType": "Binary", + "keys": [ + "MTE2IDEwMSAxMTUgMTE2" + ] + } + ] + } + ] + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "principals": { + "usernames": [ + "temperature-sensor", + "humidity-sensor" + ], + "attributes": [ + { + "building": "17", + "organization": "contoso" + } + ] + }, + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "{principal.attributes.building}*" + ] + }, + { + "method": "Publish", + "topics": [ + "sensors/{principal.attributes.building}/{principal.clientId}/telemetry/*" + ] + }, + { + "method": "Subscribe", + "topics": [ + "commands/{principal.attributes.organization}" + ] + } + ], + "stateStoreResources": [ + { + "method": "Read", + "keyType": "Pattern", + "keys": [ + "myreadkey", + "myotherkey?", + "mynumerickeysuffix[0-9]", + "clients:{principal.clientId}:*" + ] + }, + { + "method": "ReadWrite", + "keyType": "Binary", + "keys": [ + "MTE2IDEwMSAxMTUgMTE2" + ] + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "principals": { + "usernames": [ + "temperature-sensor", + "humidity-sensor" + ], + "attributes": [ + { + "building": "17", + "organization": "contoso" + } + ] + }, + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "{principal.attributes.building}*" + ] + }, + { + "method": "Publish", + "topics": [ + "sensors/{principal.attributes.building}/{principal.clientId}/telemetry/*" + ] + }, + { + "method": "Subscribe", + "topics": [ + "commands/{principal.attributes.organization}" + ] + } + ], + "stateStoreResources": [ + { + "method": "Read", + "keyType": "Pattern", + "keys": [ + "myreadkey", + "myotherkey?", + "mynumerickeysuffix[0-9]", + "clients:{principal.clientId}:*" + ] + }, + { + "method": "ReadWrite", + "keyType": "Binary", + "keys": [ + "MTE2IDEwMSAxMTUgMTE2" + ] + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..13af93f825f8 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,189 @@ +{ + "title": "BrokerAuthorization_CreateOrUpdate", + "operationId": "BrokerAuthorization_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authorizationName": "resource-name123", + "resource": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "nlc" + ], + "topics": [ + "wvuca" + ] + } + ], + "principals": { + "attributes": [ + { + "key5526": "nydhzdhbldygqcn" + } + ], + "clientIds": [ + "smopeaeddsygz" + ], + "usernames": [ + "iozngyqndrteikszkbasinzdjtm" + ] + }, + "stateStoreResources": [ + { + "keyType": "Pattern", + "keys": [ + "tkounsqtwvzyaklxjqoerpu" + ], + "method": "Read" + } + ] + } + ] + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "nlc" + ], + "topics": [ + "wvuca" + ] + } + ], + "principals": { + "attributes": [ + { + "key5526": "nydhzdhbldygqcn" + } + ], + "clientIds": [ + "smopeaeddsygz" + ], + "usernames": [ + "iozngyqndrteikszkbasinzdjtm" + ] + }, + "stateStoreResources": [ + { + "keyType": "Pattern", + "keys": [ + "tkounsqtwvzyaklxjqoerpu" + ], + "method": "Read" + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "nlc" + ], + "topics": [ + "wvuca" + ] + } + ], + "principals": { + "attributes": [ + { + "key5526": "nydhzdhbldygqcn" + } + ], + "clientIds": [ + "smopeaeddsygz" + ], + "usernames": [ + "iozngyqndrteikszkbasinzdjtm" + ] + }, + "stateStoreResources": [ + { + "keyType": "Pattern", + "keys": [ + "tkounsqtwvzyaklxjqoerpu" + ], + "method": "Read" + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_CreateOrUpdate_Simple.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_CreateOrUpdate_Simple.json new file mode 100644 index 000000000000..3c5e60f84d3b --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_CreateOrUpdate_Simple.json @@ -0,0 +1,186 @@ +{ + "title": "BrokerAuthorization_CreateOrUpdate_Simple", + "operationId": "BrokerAuthorization_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authorizationName": "resource-name123", + "resource": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "principals": { + "clientIds": [ + "my-client-id" + ], + "attributes": [ + { + "floor": "floor1", + "site": "site1" + } + ] + }, + "brokerResources": [ + { + "method": "Connect" + }, + { + "method": "Subscribe", + "topics": [ + "topic", + "topic/with/wildcard/#" + ] + } + ], + "stateStoreResources": [ + { + "method": "ReadWrite", + "keyType": "Pattern", + "keys": [ + "*" + ] + } + ] + } + ] + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "principals": { + "clientIds": [ + "my-client-id" + ], + "attributes": [ + { + "floor": "floor1", + "site": "site1" + } + ] + }, + "brokerResources": [ + { + "method": "Connect" + }, + { + "method": "Subscribe", + "topics": [ + "topic", + "topic/with/wildcard/#" + ] + } + ], + "stateStoreResources": [ + { + "method": "ReadWrite", + "keyType": "Pattern", + "keys": [ + "*" + ] + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "principals": { + "clientIds": [ + "my-client-id" + ], + "attributes": [ + { + "floor": "floor1", + "site": "site1" + } + ] + }, + "brokerResources": [ + { + "method": "Connect" + }, + { + "method": "Subscribe", + "topics": [ + "topic", + "topic/with/wildcard/#" + ] + } + ], + "stateStoreResources": [ + { + "method": "ReadWrite", + "keyType": "Pattern", + "keys": [ + "*" + ] + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_Delete_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..9576e1bff109 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "BrokerAuthorization_Delete", + "operationId": "BrokerAuthorization_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authorizationName": "resource-name123" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_Get_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..1e1df47ac23a --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_Get_MaximumSet_Gen.json @@ -0,0 +1,76 @@ +{ + "title": "BrokerAuthorization_Get", + "operationId": "BrokerAuthorization_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authorizationName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "nlc" + ], + "topics": [ + "wvuca" + ] + } + ], + "principals": { + "attributes": [ + { + "key5526": "nydhzdhbldygqcn" + } + ], + "clientIds": [ + "smopeaeddsygz" + ], + "usernames": [ + "iozngyqndrteikszkbasinzdjtm" + ] + }, + "stateStoreResources": [ + { + "keyType": "Pattern", + "keys": [ + "tkounsqtwvzyaklxjqoerpu" + ], + "method": "Read" + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_ListByResourceGroup_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..44ef2bacbea2 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,80 @@ +{ + "title": "BrokerAuthorization_ListByResourceGroup", + "operationId": "BrokerAuthorization_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "nlc" + ], + "topics": [ + "wvuca" + ] + } + ], + "principals": { + "attributes": [ + { + "key5526": "nydhzdhbldygqcn" + } + ], + "clientIds": [ + "smopeaeddsygz" + ], + "usernames": [ + "iozngyqndrteikszkbasinzdjtm" + ] + }, + "stateStoreResources": [ + { + "keyType": "Pattern", + "keys": [ + "tkounsqtwvzyaklxjqoerpu" + ], + "method": "Read" + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_CreateOrUpdate_Complex.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_CreateOrUpdate_Complex.json new file mode 100644 index 000000000000..fab5938b5e49 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_CreateOrUpdate_Complex.json @@ -0,0 +1,182 @@ +{ + "title": "BrokerListener_CreateOrUpdate_Complex", + "operationId": "BrokerListener_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "listenerName": "resource-name123", + "resource": { + "properties": { + "serviceType": "LoadBalancer", + "ports": [ + { + "port": 8080, + "authenticationRef": "example-authentication", + "protocol": "WebSockets" + }, + { + "port": 8443, + "authenticationRef": "example-authentication", + "protocol": "WebSockets", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "name": "example-issuer", + "kind": "Issuer" + } + } + } + }, + { + "port": 1883, + "authenticationRef": "example-authentication" + }, + { + "port": 8883, + "authenticationRef": "example-authentication", + "tls": { + "mode": "Manual", + "manual": { + "secretRef": "example-secret" + } + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "serviceType": "LoadBalancer", + "ports": [ + { + "port": 8080, + "authenticationRef": "example-authentication", + "protocol": "WebSockets" + }, + { + "port": 8443, + "authenticationRef": "example-authentication", + "protocol": "WebSockets", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "name": "example-issuer", + "kind": "Issuer" + } + } + } + }, + { + "port": 1883, + "authenticationRef": "example-authentication" + }, + { + "port": 8883, + "authenticationRef": "example-authentication", + "tls": { + "mode": "Manual", + "manual": { + "secretRef": "example-secret" + } + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "serviceType": "LoadBalancer", + "ports": [ + { + "port": 8080, + "authenticationRef": "example-authentication", + "protocol": "WebSockets" + }, + { + "port": 8443, + "authenticationRef": "example-authentication", + "protocol": "WebSockets", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "name": "example-issuer", + "kind": "Issuer" + } + } + } + }, + { + "port": 1883, + "authenticationRef": "example-authentication" + }, + { + "port": 8883, + "authenticationRef": "example-authentication", + "tls": { + "mode": "Manual", + "manual": { + "secretRef": "example-secret" + } + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..673225b32522 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,186 @@ +{ + "title": "BrokerListener_CreateOrUpdate", + "operationId": "BrokerListener_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "listenerName": "resource-name123", + "resource": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "ports": [ + { + "authenticationRef": "tjvdroaqqy", + "authorizationRef": "inxhvxnwswyrvt", + "nodePort": 7281, + "port": 1268, + "protocol": "Mqtt", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "duration": "qmpeffoksron", + "secretName": "oagi", + "renewBefore": "hutno", + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "kind": "Issuer", + "name": "ocwoqpgucvjrsuudtjhb" + }, + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + }, + "san": { + "dns": [ + "xhvmhrrhgfsapocjeebqtnzarlj" + ], + "ip": [ + "zbgugfzcgsmegevzktsnibyuyp" + ] + } + }, + "manual": { + "secretRef": "secret-name" + } + } + } + ], + "serviceType": "ClusterIp" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "ports": [ + { + "authenticationRef": "tjvdroaqqy", + "authorizationRef": "inxhvxnwswyrvt", + "nodePort": 7281, + "port": 1268, + "protocol": "Mqtt", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "duration": "qmpeffoksron", + "secretName": "oagi", + "renewBefore": "hutno", + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "kind": "Issuer", + "name": "ocwoqpgucvjrsuudtjhb" + }, + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + }, + "san": { + "dns": [ + "xhvmhrrhgfsapocjeebqtnzarlj" + ], + "ip": [ + "zbgugfzcgsmegevzktsnibyuyp" + ] + } + }, + "manual": { + "secretRef": "secret-name" + } + } + } + ], + "serviceType": "ClusterIp", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "ports": [ + { + "authenticationRef": "tjvdroaqqy", + "authorizationRef": "inxhvxnwswyrvt", + "nodePort": 7281, + "port": 1268, + "protocol": "Mqtt", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "duration": "qmpeffoksron", + "secretName": "oagi", + "renewBefore": "hutno", + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "kind": "Issuer", + "name": "ocwoqpgucvjrsuudtjhb" + }, + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + }, + "san": { + "dns": [ + "xhvmhrrhgfsapocjeebqtnzarlj" + ], + "ip": [ + "zbgugfzcgsmegevzktsnibyuyp" + ] + } + }, + "manual": { + "secretRef": "secret-name" + } + } + } + ], + "serviceType": "ClusterIp", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_CreateOrUpdate_Simple.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_CreateOrUpdate_Simple.json new file mode 100644 index 000000000000..70613eca4838 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_CreateOrUpdate_Simple.json @@ -0,0 +1,88 @@ +{ + "title": "BrokerListener_CreateOrUpdate_Simple", + "operationId": "BrokerListener_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "listenerName": "resource-name123", + "resource": { + "properties": { + "ports": [ + { + "port": 1883 + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "serviceType": "LoadBalancer", + "ports": [ + { + "port": 1883 + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "serviceType": "LoadBalancer", + "ports": [ + { + "port": 1883 + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_Delete_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..2eae4091f973 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "BrokerListener_Delete", + "operationId": "BrokerListener_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "listenerName": "resource-name123" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_Get_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..e0142b23e6b9 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_Get_MaximumSet_Gen.json @@ -0,0 +1,75 @@ +{ + "title": "BrokerListener_Get", + "operationId": "BrokerListener_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "listenerName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "ports": [ + { + "authenticationRef": "tjvdroaqqy", + "authorizationRef": "inxhvxnwswyrvt", + "nodePort": 7281, + "port": 1268, + "protocol": "Mqtt", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "duration": "qmpeffoksron", + "secretName": "oagi", + "renewBefore": "hutno", + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "kind": "Issuer", + "name": "ocwoqpgucvjrsuudtjhb" + }, + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + }, + "san": { + "dns": [ + "xhvmhrrhgfsapocjeebqtnzarlj" + ], + "ip": [ + "zbgugfzcgsmegevzktsnibyuyp" + ] + } + }, + "manual": { + "secretRef": "secret-name" + } + } + } + ], + "serviceType": "ClusterIp", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_ListByResourceGroup_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..d8eaf998413a --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,79 @@ +{ + "title": "BrokerListener_ListByResourceGroup", + "operationId": "BrokerListener_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "ports": [ + { + "authenticationRef": "tjvdroaqqy", + "authorizationRef": "inxhvxnwswyrvt", + "nodePort": 7281, + "port": 1268, + "protocol": "Mqtt", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "duration": "qmpeffoksron", + "secretName": "oagi", + "renewBefore": "hutno", + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "kind": "Issuer", + "name": "ocwoqpgucvjrsuudtjhb" + }, + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + }, + "san": { + "dns": [ + "xhvmhrrhgfsapocjeebqtnzarlj" + ], + "ip": [ + "zbgugfzcgsmegevzktsnibyuyp" + ] + } + }, + "manual": { + "secretRef": "secret-name" + } + } + } + ], + "serviceType": "ClusterIp", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_Complex.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_Complex.json new file mode 100644 index 000000000000..8f9965aa69f7 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_Complex.json @@ -0,0 +1,122 @@ +{ + "title": "Broker_CreateOrUpdate_Complex", + "operationId": "Broker_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "resource": { + "properties": { + "cardinality": { + "backendChain": { + "partitions": 2, + "redundancyFactor": 2, + "workers": 2 + }, + "frontend": { + "replicas": 2, + "workers": 2 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "50M" + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Medium" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "cardinality": { + "backendChain": { + "partitions": 2, + "redundancyFactor": 2, + "workers": 2 + }, + "frontend": { + "replicas": 2, + "workers": 2 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "50M" + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Medium", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "cardinality": { + "backendChain": { + "partitions": 2, + "redundancyFactor": 2, + "workers": 2 + }, + "frontend": { + "replicas": 2, + "workers": 2 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "50M" + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Medium", + "provisioningState": "Accepted" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..1a9202c793fc --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,500 @@ +{ + "title": "Broker_CreateOrUpdate", + "operationId": "Broker_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "resource": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_Minimal.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_Minimal.json new file mode 100644 index 000000000000..db21f2f9961d --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_Minimal.json @@ -0,0 +1,357 @@ +{ + "title": "Broker_CreateOrUpdate_Minimal", + "operationId": "Broker_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "resource": { + "properties": { + "memoryProfile": "Tiny" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_Simple.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_Simple.json new file mode 100644 index 000000000000..e163401612c6 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_Simple.json @@ -0,0 +1,371 @@ +{ + "title": "Broker_CreateOrUpdate_Simple", + "operationId": "Broker_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "resource": { + "properties": { + "cardinality": { + "backendChain": { + "partitions": 2, + "redundancyFactor": 2, + "workers": 2 + }, + "frontend": { + "replicas": 2, + "workers": 2 + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Low" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_Delete_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..8cc056cc7fbd --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "Broker_Delete", + "operationId": "Broker_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_Get_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..170aa26bcd86 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_Get_MaximumSet_Gen.json @@ -0,0 +1,179 @@ +{ + "title": "Broker_Get", + "operationId": "Broker_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_ListByResourceGroup_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..1c1a1bf57ec5 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,183 @@ +{ + "title": "Broker_ListByResourceGroup", + "operationId": "Broker_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_ADLSv2.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_ADLSv2.json new file mode 100644 index 000000000000..3b8475111cd2 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_ADLSv2.json @@ -0,0 +1,98 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_ADLSv2", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "adlsv2-endpoint", + "resource": { + "properties": { + "endpointType": "DataLakeStorage", + "dataLakeStorageSettings": { + "host": "example.blob.core.windows.net", + "authentication": { + "method": "AccessToken", + "accessTokenSettings": { + "secretRef": "my-secret" + } + } + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "DataLakeStorage", + "dataLakeStorageSettings": { + "host": "example.blob.core.windows.net", + "authentication": { + "method": "AccessToken", + "accessTokenSettings": { + "secretRef": "my-secret" + } + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "DataLakeStorage", + "dataLakeStorageSettings": { + "host": "example.blob.core.windows.net", + "authentication": { + "method": "AccessToken", + "accessTokenSettings": { + "secretRef": "my-secret" + } + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_ADX.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_ADX.json new file mode 100644 index 000000000000..db63d70425bb --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_ADX.json @@ -0,0 +1,107 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_ADX", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "adx-endpoint", + "resource": { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "host": "example.westeurope.kusto.windows.net", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "database": "example-database", + "batching": { + "latencySeconds": 9312, + "maxMessages": 9028 + } + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "host": "example.westeurope.kusto.windows.net", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "database": "example-database", + "batching": { + "latencySeconds": 9312, + "maxMessages": 9028 + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "host": "example.westeurope.kusto.windows.net", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "database": "example-database", + "batching": { + "latencySeconds": 9312, + "maxMessages": 9028 + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_AIO.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_AIO.json new file mode 100644 index 000000000000..18cef846e282 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_AIO.json @@ -0,0 +1,110 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_AIO", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "aio-builtin-broker-endpoint", + "resource": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "aio-broker:18883", + "authentication": { + "method": "Kubernetes", + "serviceAccountTokenSettings": { + "audience": "aio-internal" + } + }, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "aio-ca-trust-bundle-test-only" + } + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "aio-broker:18883", + "authentication": { + "method": "Kubernetes", + "serviceAccountTokenSettings": { + "audience": "aio-internal" + } + }, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "aio-ca-trust-bundle-test-only" + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "aio-broker:18883", + "authentication": { + "method": "Kubernetes", + "serviceAccountTokenSettings": { + "audience": "aio-internal" + } + }, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "aio-ca-trust-bundle-test-only" + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_EventGrid.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_EventGrid.json new file mode 100644 index 000000000000..09a2283578b4 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_EventGrid.json @@ -0,0 +1,101 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_EventGrid", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "event-grid-endpoint", + "resource": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "example.westeurope-1.ts.eventgrid.azure.net:8883", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "tls": { + "mode": "Enabled" + } + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "example.westeurope-1.ts.eventgrid.azure.net:8883", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "tls": { + "mode": "Enabled" + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "example.westeurope-1.ts.eventgrid.azure.net:8883", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "tls": { + "mode": "Enabled" + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_EventHub.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_EventHub.json new file mode 100644 index 000000000000..f6730880e2b6 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_EventHub.json @@ -0,0 +1,104 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_EventHub", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "event-hub-endpoint", + "resource": { + "properties": { + "endpointType": "Kafka", + "kafkaSettings": { + "host": "example.servicebus.windows.net:9093", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "tls": { + "mode": "Enabled" + }, + "consumerGroupId": "aiodataflows" + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "Kafka", + "kafkaSettings": { + "host": "example.servicebus.windows.net:9093", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "tls": { + "mode": "Enabled" + }, + "consumerGroupId": "aiodataflows" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "Kafka", + "kafkaSettings": { + "host": "example.servicebus.windows.net:9093", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "tls": { + "mode": "Enabled" + }, + "consumerGroupId": "aiodataflows" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_Fabric.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_Fabric.json new file mode 100644 index 000000000000..d4393e8da225 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_Fabric.json @@ -0,0 +1,107 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_Fabric", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "fabric-endpoint", + "resource": { + "properties": { + "endpointType": "FabricOneLake", + "fabricOneLakeSettings": { + "host": "onelake.dfs.fabric.microsoft.com", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "names": { + "workspaceName": "example-workspace", + "lakehouseName": "example-lakehouse" + }, + "oneLakePathType": "Tables" + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "FabricOneLake", + "fabricOneLakeSettings": { + "host": "onelake.dfs.fabric.microsoft.com", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "names": { + "workspaceName": "example-workspace", + "lakehouseName": "example-lakehouse" + }, + "oneLakePathType": "Tables" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "FabricOneLake", + "fabricOneLakeSettings": { + "host": "onelake.dfs.fabric.microsoft.com", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "names": { + "workspaceName": "example-workspace", + "lakehouseName": "example-lakehouse" + }, + "oneLakePathType": "Tables" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_Kafka.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_Kafka.json new file mode 100644 index 000000000000..34ea2ac53f03 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_Kafka.json @@ -0,0 +1,149 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_Kafka", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "generic-kafka-endpoint", + "resource": { + "properties": { + "endpointType": "Kafka", + "kafkaSettings": { + "host": "example.kafka.local:9093", + "authentication": { + "method": "Sasl", + "saslSettings": { + "saslType": "Plain", + "secretRef": "my-secret" + } + }, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "ca-certificates" + }, + "consumerGroupId": "dataflows", + "compression": "Gzip", + "batching": { + "mode": "Enabled", + "latencyMs": 5, + "maxBytes": 1000000, + "maxMessages": 100000 + }, + "partitionStrategy": "Default", + "kafkaAcks": "All", + "copyMqttProperties": "Enabled", + "cloudEventAttributes": "Propagate" + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "Kafka", + "kafkaSettings": { + "host": "example.kafka.local:9093", + "authentication": { + "method": "Sasl", + "saslSettings": { + "saslType": "Plain", + "secretRef": "my-secret" + } + }, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "ca-certificates" + }, + "consumerGroupId": "dataflows", + "compression": "Gzip", + "batching": { + "mode": "Enabled", + "latencyMs": 5, + "maxBytes": 1000000, + "maxMessages": 100000 + }, + "partitionStrategy": "Default", + "kafkaAcks": "All", + "copyMqttProperties": "Enabled", + "cloudEventAttributes": "Propagate" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "Kafka", + "kafkaSettings": { + "host": "example.kafka.local:9093", + "authentication": { + "method": "Sasl", + "saslSettings": { + "saslType": "Plain", + "secretRef": "my-secret" + } + }, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "ca-certificates" + }, + "consumerGroupId": "dataflows", + "compression": "Gzip", + "batching": { + "mode": "Enabled", + "latencyMs": 5, + "maxBytes": 1000000, + "maxMessages": 100000 + }, + "partitionStrategy": "Default", + "kafkaAcks": "All", + "copyMqttProperties": "Enabled", + "cloudEventAttributes": "Propagate" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_LocalStorage.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_LocalStorage.json new file mode 100644 index 000000000000..6c498588c715 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_LocalStorage.json @@ -0,0 +1,80 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_LocalStorage", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "local-storage-endpoint", + "resource": { + "properties": { + "endpointType": "LocalStorage", + "localStorageSettings": { + "persistentVolumeClaimRef": "example-pvc" + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "LocalStorage", + "localStorageSettings": { + "persistentVolumeClaimRef": "example-pvc" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "LocalStorage", + "localStorageSettings": { + "persistentVolumeClaimRef": "example-pvc" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_MQTT.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_MQTT.json new file mode 100644 index 000000000000..b420b27e3664 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_MQTT.json @@ -0,0 +1,128 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_MQTT", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "generic-mqtt-broker-endpoint", + "resource": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "example.broker.local:1883", + "authentication": { + "method": "X509Certificate", + "x509CertificateSettings": { + "secretRef": "example-secret" + } + }, + "tls": { + "mode": "Disabled" + }, + "clientIdPrefix": "factory-gateway", + "retain": "Keep", + "sessionExpirySeconds": 3600, + "qos": 1, + "protocol": "WebSockets", + "maxInflightMessages": 100, + "keepAliveSeconds": 60 + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "example.broker.local:1883", + "authentication": { + "method": "X509Certificate", + "x509CertificateSettings": { + "secretRef": "example-secret" + } + }, + "tls": { + "mode": "Disabled" + }, + "clientIdPrefix": "factory-gateway", + "retain": "Keep", + "sessionExpirySeconds": 3600, + "qos": 1, + "protocol": "WebSockets", + "maxInflightMessages": 100, + "keepAliveSeconds": 60 + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "example.broker.local:1883", + "authentication": { + "method": "X509Certificate", + "x509CertificateSettings": { + "secretRef": "example-secret" + } + }, + "tls": { + "mode": "Disabled" + }, + "clientIdPrefix": "factory-gateway", + "retain": "Keep", + "sessionExpirySeconds": 3600, + "qos": 1, + "protocol": "WebSockets", + "maxInflightMessages": 100, + "keepAliveSeconds": 60 + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..1fe7b32d00a5 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,476 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "resource-name123", + "resource": { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "database": "yqcdpjsifm", + "host": "<cluster>.<region>.kusto.windows.net", + "batching": { + "latencySeconds": 9312, + "maxMessages": 9028 + } + }, + "dataLakeStorageSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "accessTokenSettings": { + "secretRef": "sevriyphcvnlrnfudqzejecwa" + }, + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "host": "<account>.blob.core.windows.net", + "batching": { + "latencySeconds": 9312, + "maxMessages": 9028 + } + }, + "fabricOneLakeSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "names": { + "lakehouseName": "wpeathi", + "workspaceName": "nwgmitkbljztgms" + }, + "oneLakePathType": "Files", + "host": "https://<host>.fabric.microsoft.com", + "batching": { + "latencySeconds": 9312, + "maxMessages": 9028 + } + }, + "kafkaSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "saslSettings": { + "saslType": "Plain", + "secretRef": "visyxoztqnylvbyokhtmpdkwes" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "consumerGroupId": "ukkzcjiyenhxokat", + "host": "pwcqfiqclcgneolpewnyavoulbip", + "batching": { + "mode": "Enabled", + "latencyMs": 3679, + "maxBytes": 8887, + "maxMessages": 2174 + }, + "copyMqttProperties": "Enabled", + "compression": "None", + "kafkaAcks": "Zero", + "partitionStrategy": "Default", + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "localStorageSettings": { + "persistentVolumeClaimRef": "jjwqwvd" + }, + "mqttSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "serviceAccountTokenSettings": { + "audience": "ejbklrbxgjaqleoycgpje" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "clientIdPrefix": "kkljsdxdirfhwxtkavldekeqhv", + "host": "nyhnxqnbspstctl", + "protocol": "Mqtt", + "keepAliveSeconds": 0, + "retain": "Keep", + "maxInflightMessages": 0, + "qos": 1, + "sessionExpirySeconds": 0, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "database": "yqcdpjsifm", + "host": "<cluster>.<region>.kusto.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "dataLakeStorageSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "accessTokenSettings": { + "secretRef": "sevriyphcvnlrnfudqzejecwa" + }, + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "host": "<account>.blob.core.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "fabricOneLakeSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "names": { + "lakehouseName": "wpeathi", + "workspaceName": "nwgmitkbljztgms" + }, + "oneLakePathType": "Files", + "host": "https://<host>.fabric.microsoft.com", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "kafkaSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "saslSettings": { + "saslType": "Plain", + "secretRef": "visyxoztqnylvbyokhtmpdkwes" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "consumerGroupId": "ukkzcjiyenhxokat", + "host": "pwcqfiqclcgneolpewnyavoulbip", + "batching": { + "mode": "Enabled", + "latencyMs": 3679, + "maxBytes": 8887, + "maxMessages": 2174 + }, + "copyMqttProperties": "Enabled", + "compression": "None", + "kafkaAcks": "Zero", + "partitionStrategy": "Default", + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "localStorageSettings": { + "persistentVolumeClaimRef": "jjwqwvd" + }, + "mqttSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "serviceAccountTokenSettings": { + "audience": "ejbklrbxgjaqleoycgpje" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "clientIdPrefix": "kkljsdxdirfhwxtkavldekeqhv", + "host": "nyhnxqnbspstctl", + "protocol": "Mqtt", + "keepAliveSeconds": 0, + "retain": "Keep", + "maxInflightMessages": 0, + "qos": 1, + "sessionExpirySeconds": 0, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "database": "yqcdpjsifm", + "host": "<cluster>.<region>.kusto.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "dataLakeStorageSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "accessTokenSettings": { + "secretRef": "sevriyphcvnlrnfudqzejecwa" + }, + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "host": "<account>.blob.core.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "fabricOneLakeSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "names": { + "lakehouseName": "wpeathi", + "workspaceName": "nwgmitkbljztgms" + }, + "oneLakePathType": "Files", + "host": "https://<host>.fabric.microsoft.com", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "kafkaSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "saslSettings": { + "saslType": "Plain", + "secretRef": "visyxoztqnylvbyokhtmpdkwes" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "consumerGroupId": "ukkzcjiyenhxokat", + "host": "pwcqfiqclcgneolpewnyavoulbip", + "batching": { + "mode": "Enabled", + "latencyMs": 3679, + "maxBytes": 8887, + "maxMessages": 2174 + }, + "copyMqttProperties": "Enabled", + "compression": "None", + "kafkaAcks": "Zero", + "partitionStrategy": "Default", + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "localStorageSettings": { + "persistentVolumeClaimRef": "jjwqwvd" + }, + "mqttSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "serviceAccountTokenSettings": { + "audience": "ejbklrbxgjaqleoycgpje" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "clientIdPrefix": "kkljsdxdirfhwxtkavldekeqhv", + "host": "nyhnxqnbspstctl", + "protocol": "Mqtt", + "keepAliveSeconds": 0, + "retain": "Keep", + "maxInflightMessages": 0, + "qos": 1, + "sessionExpirySeconds": 0, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_Delete_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..a67f12a1e4da --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "DataflowEndpoint_Delete", + "operationId": "DataflowEndpoint_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "resource-name123" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_Get_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..be8c1f8d0ac3 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_Get_MaximumSet_Gen.json @@ -0,0 +1,171 @@ +{ + "title": "DataflowEndpoint_Get", + "operationId": "DataflowEndpoint_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "database": "yqcdpjsifm", + "host": "<cluster>.<region>.kusto.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "dataLakeStorageSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "accessTokenSettings": { + "secretRef": "sevriyphcvnlrnfudqzejecwa" + }, + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "host": "<account>.blob.core.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "fabricOneLakeSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "names": { + "lakehouseName": "wpeathi", + "workspaceName": "nwgmitkbljztgms" + }, + "oneLakePathType": "Files", + "host": "https://<host>.fabric.microsoft.com", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "kafkaSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "saslSettings": { + "saslType": "Plain", + "secretRef": "visyxoztqnylvbyokhtmpdkwes" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "consumerGroupId": "ukkzcjiyenhxokat", + "host": "pwcqfiqclcgneolpewnyavoulbip", + "batching": { + "mode": "Enabled", + "latencyMs": 3679, + "maxBytes": 8887, + "maxMessages": 2174 + }, + "copyMqttProperties": "Enabled", + "compression": "None", + "kafkaAcks": "Zero", + "partitionStrategy": "Default", + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "localStorageSettings": { + "persistentVolumeClaimRef": "jjwqwvd" + }, + "mqttSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "serviceAccountTokenSettings": { + "audience": "ejbklrbxgjaqleoycgpje" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "clientIdPrefix": "kkljsdxdirfhwxtkavldekeqhv", + "host": "nyhnxqnbspstctl", + "protocol": "Mqtt", + "keepAliveSeconds": 0, + "retain": "Keep", + "maxInflightMessages": 0, + "qos": 1, + "sessionExpirySeconds": 0, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_ListByResourceGroup_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..f9b75de4d82e --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,175 @@ +{ + "title": "DataflowEndpoint_ListByResourceGroup", + "operationId": "DataflowEndpoint_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "database": "yqcdpjsifm", + "host": "<cluster>.<region>.kusto.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "dataLakeStorageSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "accessTokenSettings": { + "secretRef": "sevriyphcvnlrnfudqzejecwa" + }, + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "host": "<account>.blob.core.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "fabricOneLakeSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "names": { + "lakehouseName": "wpeathi", + "workspaceName": "nwgmitkbljztgms" + }, + "oneLakePathType": "Files", + "host": "https://<host>.fabric.microsoft.com", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "kafkaSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "saslSettings": { + "saslType": "Plain", + "secretRef": "visyxoztqnylvbyokhtmpdkwes" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "consumerGroupId": "ukkzcjiyenhxokat", + "host": "pwcqfiqclcgneolpewnyavoulbip", + "batching": { + "mode": "Enabled", + "latencyMs": 3679, + "maxBytes": 8887, + "maxMessages": 2174 + }, + "copyMqttProperties": "Enabled", + "compression": "None", + "kafkaAcks": "Zero", + "partitionStrategy": "Default", + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "localStorageSettings": { + "persistentVolumeClaimRef": "jjwqwvd" + }, + "mqttSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "serviceAccountTokenSettings": { + "audience": "ejbklrbxgjaqleoycgpje" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "clientIdPrefix": "kkljsdxdirfhwxtkavldekeqhv", + "host": "nyhnxqnbspstctl", + "protocol": "Mqtt", + "keepAliveSeconds": 0, + "retain": "Keep", + "maxInflightMessages": 0, + "qos": 1, + "sessionExpirySeconds": 0, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..2a8a90c8ec9e --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,95 @@ +{ + "title": "DataflowProfile_CreateOrUpdate", + "operationId": "DataflowProfile_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "resource": { + "properties": { + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + } + }, + "instanceCount": 14 + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + } + }, + "instanceCount": 14, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + } + }, + "instanceCount": 14, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_CreateOrUpdate_Minimal.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_CreateOrUpdate_Minimal.json new file mode 100644 index 000000000000..8a08b7c71f41 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_CreateOrUpdate_Minimal.json @@ -0,0 +1,71 @@ +{ + "title": "DataflowProfile_CreateOrUpdate_Minimal", + "operationId": "DataflowProfile_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "aio-dataflowprofile", + "resource": { + "properties": { + "instanceCount": 1 + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "instanceCount": 1, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "instanceCount": 1, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_CreateOrUpdate_Multi.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_CreateOrUpdate_Multi.json new file mode 100644 index 000000000000..1358bf219347 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_CreateOrUpdate_Multi.json @@ -0,0 +1,71 @@ +{ + "title": "DataflowProfile_CreateOrUpdate_Multi", + "operationId": "DataflowProfile_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "aio-dataflowprofile", + "resource": { + "properties": { + "instanceCount": 3 + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "instanceCount": 3, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "instanceCount": 3, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_Delete_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..92c5a7d32c78 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "DataflowProfile_Delete", + "operationId": "DataflowProfile_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_Get_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..992da0ba07f8 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_Get_MaximumSet_Gen.json @@ -0,0 +1,44 @@ +{ + "title": "DataflowProfile_Get", + "operationId": "DataflowProfile_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "properties": { + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + } + }, + "instanceCount": 14, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_ListByResourceGroup_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..8e7d80009c85 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "DataflowProfile_ListByResourceGroup", + "operationId": "DataflowProfile_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + } + }, + "instanceCount": 14, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_ComplexContextualization.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_ComplexContextualization.json new file mode 100644 index 000000000000..6706efedf55b --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_ComplexContextualization.json @@ -0,0 +1,222 @@ +{ + "title": "Dataflow_CreateOrUpdate_ComplexContextualization", + "operationId": "Dataflow_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "aio-to-adx-contexualized", + "resource": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "map": [ + { + "inputs": [ + "*" + ], + "output": "*" + }, + { + "inputs": [ + "$context(quality).*" + ], + "output": "enriched.*" + } + ], + "datasets": [ + { + "key": "quality", + "inputs": [ + "$source.country", + "$context.country" + ], + "expression": "$1 == $2" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "adx-endpoint", + "dataDestination": "mytable" + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "map": [ + { + "inputs": [ + "*" + ], + "output": "*" + }, + { + "inputs": [ + "$context(quality).*" + ], + "output": "enriched.*" + } + ], + "datasets": [ + { + "key": "quality", + "inputs": [ + "$source.country", + "$context.country" + ], + "expression": "$1 == $2" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "adx-endpoint", + "dataDestination": "mytable" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "map": [ + { + "inputs": [ + "*" + ], + "output": "*" + }, + { + "inputs": [ + "$context(quality).*" + ], + "output": "enriched.*" + } + ], + "datasets": [ + { + "key": "quality", + "inputs": [ + "$source.country", + "$context.country" + ], + "expression": "$1 == $2" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "adx-endpoint", + "dataDestination": "mytable" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_ComplexEventHub.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_ComplexEventHub.json new file mode 100644 index 000000000000..e10915972919 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_ComplexEventHub.json @@ -0,0 +1,255 @@ +{ + "title": "Dataflow_CreateOrUpdate_ComplexEventHub", + "operationId": "Dataflow_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "aio-to-event-hub-transformed", + "resource": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "builtInTransformationSettings": { + "filter": [ + { + "inputs": [ + "temperature.Value", + "\"Tag 10\".Value" + ], + "expression": "$1 > 9000 && $2 >= 8000" + } + ], + "map": [ + { + "inputs": [ + "*" + ], + "output": "*" + }, + { + "inputs": [ + "temperature.Value", + "\"Tag 10\".Value" + ], + "expression": "($1+$2)/2", + "output": "AvgTemp.Value" + }, + { + "inputs": [], + "expression": "true", + "output": "dataflow-processed" + }, + { + "inputs": [ + "temperature.SourceTimestamp" + ], + "expression": "", + "output": "" + }, + { + "inputs": [ + "\"Tag 10\"" + ], + "expression": "", + "output": "pressure" + }, + { + "inputs": [ + "temperature.Value" + ], + "expression": "cToF($1)", + "output": "temperatureF.Value" + }, + { + "inputs": [ + "\"Tag 10\".Value" + ], + "expression": "scale ($1,0,10,0,100)", + "output": "\"Scale Tag 10\".Value" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "event-hub-endpoint", + "dataDestination": "myuniqueeventhub" + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "map": [ + { + "inputs": [ + "*" + ], + "output": "*" + }, + { + "inputs": [ + "$context(quality).*" + ], + "output": "enriched.*" + } + ], + "datasets": [ + { + "key": "quality", + "inputs": [ + "$source.country", + "$context.country" + ], + "expression": "$1 == $2" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "adx-endpoint", + "dataDestination": "mytable" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "map": [ + { + "inputs": [ + "*" + ], + "output": "*" + }, + { + "inputs": [ + "$context(quality).*" + ], + "output": "enriched.*" + } + ], + "datasets": [ + { + "key": "quality", + "inputs": [ + "$source.country", + "$context.country" + ], + "expression": "$1 == $2" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "adx-endpoint", + "dataDestination": "mytable" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_FilterToTopic.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_FilterToTopic.json new file mode 100644 index 000000000000..3ff5c1c6c7f3 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_FilterToTopic.json @@ -0,0 +1,210 @@ +{ + "title": "Dataflow_CreateOrUpdate_FilterToTopic", + "operationId": "Dataflow_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "mqtt-filter-to-topic", + "resource": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "filter": [ + { + "type": "Filter", + "description": "filter-datapoint", + "inputs": [ + "temperature.Value", + "\"Tag 10\".Value" + ], + "expression": "$1 > 9000 && $2 >= 8000" + } + ], + "map": [ + { + "type": "PassThrough", + "inputs": [ + "*" + ], + "output": "*" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataDestination": "data/filtered/thermostat" + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "filter": [ + { + "type": "Filter", + "description": "filter-datapoint", + "inputs": [ + "temperature.Value", + "\"Tag 10\".Value" + ], + "expression": "$1 > 9000 && $2 >= 8000" + } + ], + "map": [ + { + "type": "PassThrough", + "inputs": [ + "*" + ], + "output": "*" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataDestination": "data/filtered/thermostat" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "filter": [ + { + "type": "Filter", + "description": "filter-datapoint", + "inputs": [ + "temperature.Value", + "\"Tag 10\".Value" + ], + "expression": "$1 > 9000 && $2 >= 8000" + } + ], + "map": [ + { + "type": "PassThrough", + "inputs": [ + "*" + ], + "output": "*" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataDestination": "data/filtered/thermostat" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..9d4a894ae46b --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,237 @@ +{ + "title": "Dataflow_CreateOrUpdate", + "operationId": "Dataflow_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "resource-name123", + "resource": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "knnafvkwoeakm", + "sourceSettings": { + "endpointRef": "iixotodhvhkkfcfyrkoveslqig", + "assetRef": "zayyykwmckaocywdkohmu", + "serializationFormat": "Json", + "schemaRef": "pknmdzqll", + "dataSources": [ + "chkkpymxhp" + ] + }, + "builtInTransformationSettings": { + "serializationFormat": "Delta", + "schemaRef": "mcdc", + "datasets": [ + { + "key": "qsfqcgxaxnhfumrsdsokwyv", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "schemaRef": "n", + "inputs": [ + "mosffpsslifkq" + ], + "expression": "aatbwomvflemsxialv" + } + ], + "filter": [ + { + "type": "Filter", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "sxmjkbntgb" + ], + "expression": "n" + } + ], + "map": [ + { + "type": "NewProperties", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "xsbxuk" + ], + "expression": "txoiltogsarwkzalsphvlmt", + "output": "nvgtmkfl" + } + ] + }, + "destinationSettings": { + "endpointRef": "kybkchnzimerguekuvqlqiqdvvrt", + "dataDestination": "cbrh" + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "knnafvkwoeakm", + "sourceSettings": { + "endpointRef": "iixotodhvhkkfcfyrkoveslqig", + "assetRef": "zayyykwmckaocywdkohmu", + "serializationFormat": "Json", + "schemaRef": "pknmdzqll", + "dataSources": [ + "chkkpymxhp" + ] + }, + "builtInTransformationSettings": { + "serializationFormat": "Delta", + "schemaRef": "mcdc", + "datasets": [ + { + "key": "qsfqcgxaxnhfumrsdsokwyv", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "schemaRef": "n", + "inputs": [ + "mosffpsslifkq" + ], + "expression": "aatbwomvflemsxialv" + } + ], + "filter": [ + { + "type": "Filter", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "sxmjkbntgb" + ], + "expression": "n" + } + ], + "map": [ + { + "type": "NewProperties", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "xsbxuk" + ], + "expression": "txoiltogsarwkzalsphvlmt", + "output": "nvgtmkfl" + } + ] + }, + "destinationSettings": { + "endpointRef": "kybkchnzimerguekuvqlqiqdvvrt", + "dataDestination": "cbrh" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "knnafvkwoeakm", + "sourceSettings": { + "endpointRef": "iixotodhvhkkfcfyrkoveslqig", + "assetRef": "zayyykwmckaocywdkohmu", + "serializationFormat": "Json", + "schemaRef": "pknmdzqll", + "dataSources": [ + "chkkpymxhp" + ] + }, + "builtInTransformationSettings": { + "serializationFormat": "Delta", + "schemaRef": "mcdc", + "datasets": [ + { + "key": "qsfqcgxaxnhfumrsdsokwyv", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "schemaRef": "n", + "inputs": [ + "mosffpsslifkq" + ], + "expression": "aatbwomvflemsxialv" + } + ], + "filter": [ + { + "type": "Filter", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "sxmjkbntgb" + ], + "expression": "n" + } + ], + "map": [ + { + "type": "NewProperties", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "xsbxuk" + ], + "expression": "txoiltogsarwkzalsphvlmt", + "output": "nvgtmkfl" + } + ] + }, + "destinationSettings": { + "endpointRef": "kybkchnzimerguekuvqlqiqdvvrt", + "dataDestination": "cbrh" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_SimpleEventGrid.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_SimpleEventGrid.json new file mode 100644 index 000000000000..73a3038d8527 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_SimpleEventGrid.json @@ -0,0 +1,132 @@ +{ + "title": "Dataflow_CreateOrUpdate_SimpleEventGrid", + "operationId": "Dataflow_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "aio-to-event-grid", + "resource": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "thermostats/+/telemetry/temperature/#" + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "event-grid-endpoint", + "dataDestination": "factory/telemetry" + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "thermostats/+/telemetry/temperature/#" + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "event-grid-endpoint", + "dataDestination": "factory/telemetry" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "thermostats/+/telemetry/temperature/#" + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "event-grid-endpoint", + "dataDestination": "factory/telemetry" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_SimpleFabric.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_SimpleFabric.json new file mode 100644 index 000000000000..f4f3e6a89ecb --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_SimpleFabric.json @@ -0,0 +1,153 @@ +{ + "title": "Dataflow_CreateOrUpdate_SimpleFabric", + "operationId": "Dataflow_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "aio-to-fabric", + "resource": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "builtInTransformationSettings": { + "serializationFormat": "Parquet", + "schemaRef": "aio-sr://exampleNamespace/exmapleParquetSchema:1.0.0" + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "fabric-endpoint", + "dataDestination": "telemetryTable" + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "builtInTransformationSettings": { + "serializationFormat": "Parquet", + "schemaRef": "aio-sr://exampleNamespace/exmapleParquetSchema:1.0.0" + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "fabric-endpoint", + "dataDestination": "telemetryTable" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "builtInTransformationSettings": { + "serializationFormat": "Parquet", + "schemaRef": "aio-sr://exampleNamespace/exmapleParquetSchema:1.0.0" + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "fabric-endpoint", + "dataDestination": "telemetryTable" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_Delete_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..8617fc9681eb --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "Dataflow_Delete", + "operationId": "Dataflow_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "resource-name123" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_Get_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..6daa2b11a21d --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_Get_MaximumSet_Gen.json @@ -0,0 +1,92 @@ +{ + "title": "Dataflow_Get", + "operationId": "Dataflow_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "knnafvkwoeakm", + "sourceSettings": { + "endpointRef": "iixotodhvhkkfcfyrkoveslqig", + "assetRef": "zayyykwmckaocywdkohmu", + "serializationFormat": "Json", + "schemaRef": "pknmdzqll", + "dataSources": [ + "chkkpymxhp" + ] + }, + "builtInTransformationSettings": { + "serializationFormat": "Delta", + "schemaRef": "mcdc", + "datasets": [ + { + "key": "qsfqcgxaxnhfumrsdsokwyv", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "schemaRef": "n", + "inputs": [ + "mosffpsslifkq" + ], + "expression": "aatbwomvflemsxialv" + } + ], + "filter": [ + { + "type": "Filter", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "sxmjkbntgb" + ], + "expression": "n" + } + ], + "map": [ + { + "type": "NewProperties", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "xsbxuk" + ], + "expression": "txoiltogsarwkzalsphvlmt", + "output": "nvgtmkfl" + } + ] + }, + "destinationSettings": { + "endpointRef": "kybkchnzimerguekuvqlqiqdvvrt", + "dataDestination": "cbrh" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_ListByProfileResource_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_ListByProfileResource_MaximumSet_Gen.json new file mode 100644 index 000000000000..d38f51c50759 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_ListByProfileResource_MaximumSet_Gen.json @@ -0,0 +1,96 @@ +{ + "title": "Dataflow_ListByProfileResource", + "operationId": "Dataflow_ListByProfileResource", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "knnafvkwoeakm", + "sourceSettings": { + "endpointRef": "iixotodhvhkkfcfyrkoveslqig", + "assetRef": "zayyykwmckaocywdkohmu", + "serializationFormat": "Json", + "schemaRef": "pknmdzqll", + "dataSources": [ + "chkkpymxhp" + ] + }, + "builtInTransformationSettings": { + "serializationFormat": "Delta", + "schemaRef": "mcdc", + "datasets": [ + { + "key": "qsfqcgxaxnhfumrsdsokwyv", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "schemaRef": "n", + "inputs": [ + "mosffpsslifkq" + ], + "expression": "aatbwomvflemsxialv" + } + ], + "filter": [ + { + "type": "Filter", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "sxmjkbntgb" + ], + "expression": "n" + } + ], + "map": [ + { + "type": "NewProperties", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "xsbxuk" + ], + "expression": "txoiltogsarwkzalsphvlmt", + "output": "nvgtmkfl" + } + ] + }, + "destinationSettings": { + "endpointRef": "kybkchnzimerguekuvqlqiqdvvrt", + "dataDestination": "cbrh" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..ac7583a4acb2 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,103 @@ +{ + "title": "Instance_CreateOrUpdate", + "operationId": "Instance_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "aio-instance", + "resource": { + "properties": { + "schemaRegistryRef": { + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123" + }, + "description": "kpqtgocs" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "location": "xvewadyhycrjpu" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "schemaRegistryRef": { + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123" + }, + "description": "kpqtgocs", + "provisioningState": "Succeeded", + "version": "vjjbmunthiphfmekvxgxcxkzdwjti" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "4a6e4195-75b8-4685-aa0c-0b5704779327", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "tags": {}, + "location": "xvewadyhycrjpu", + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "schemaRegistryRef": { + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123" + }, + "description": "kpqtgocs", + "provisioningState": "Succeeded", + "version": "vjjbmunthiphfmekvxgxcxkzdwjti" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "4a6e4195-75b8-4685-aa0c-0b5704779327", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "tags": {}, + "location": "xvewadyhycrjpu", + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_Delete_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..0b63d7261b0b --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "Instance_Delete", + "operationId": "Instance_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "aio-instance" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_Get_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..03f4b416dda5 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_Get_MaximumSet_Gen.json @@ -0,0 +1,47 @@ +{ + "title": "Instance_Get", + "operationId": "Instance_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "aio-instance" + }, + "responses": { + "200": { + "body": { + "properties": { + "schemaRegistryRef": { + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123" + }, + "description": "rlfvvnnhcypp", + "provisioningState": "Succeeded", + "version": "vjjbmunthiphfmekvxgxcxkzdwjti" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "4a6e4195-75b8-4685-aa0c-0b5704779327", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "tags": {}, + "location": "xvewadyhycrjpu", + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_ListByResourceGroup_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..c4bedfb0b6ce --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,51 @@ +{ + "title": "Instance_ListByResourceGroup", + "operationId": "Instance_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "version": "vjjbmunthiphfmekvxgxcxkzdwjti", + "schemaRegistryRef": { + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123" + }, + "description": "vmujggxdvxk" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "identity": { + "principalId": "4a6e4195-75b8-4685-aa0c-0b5704779327", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec", + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "location": "xvewadyhycrjpu", + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_ListBySubscription_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..7229d3116831 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,50 @@ +{ + "title": "Instance_ListBySubscription", + "operationId": "Instance_ListBySubscription", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "version": "vjjbmunthiphfmekvxgxcxkzdwjti", + "schemaRegistryRef": { + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123" + }, + "description": "empgqmbhvklcqlyahmdsjemlep" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "identity": { + "principalId": "4a6e4195-75b8-4685-aa0c-0b5704779327", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec", + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "location": "xvewadyhycrjpu", + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_Update_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..406c4a22b316 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_Update_MaximumSet_Gen.json @@ -0,0 +1,54 @@ +{ + "title": "Instance_Update", + "operationId": "Instance_Update", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "aio-instance", + "properties": { + "tags": {}, + "identity": { + "type": "None", + "userAssignedIdentities": {} + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "schemaRegistryRef": { + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123" + }, + "description": "wwihkapmgjbyrtyaj", + "provisioningState": "Succeeded", + "version": "vjjbmunthiphfmekvxgxcxkzdwjti" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "4a6e4195-75b8-4685-aa0c-0b5704779327", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "tags": {}, + "location": "xvewadyhycrjpu", + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Operations_List_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..0429eca83eed --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-09-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "xzxqfusky", + "isDataAction": true, + "display": { + "provider": "lrveskajtuwf", + "resource": "d", + "operation": "icuckgobartrrgmirax", + "description": "dsbfnxzvnoqdm" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/main.tsp b/specification/iotoperations/IoTOperations.Management/main.tsp index d0f76ba18550..33037af05c59 100644 --- a/specification/iotoperations/IoTOperations.Management/main.tsp +++ b/specification/iotoperations/IoTOperations.Management/main.tsp @@ -33,10 +33,10 @@ namespace Microsoft.IoTOperations; /** Api versions */ enum Versions { - /** 2024-08-15-preview version */ + /** 2024-09-15-preview version */ @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) - `2024-08-15-preview`, + `2024-09-15-preview`, } interface Operations extends Azure.ResourceManager.Operations {} diff --git a/specification/iotoperations/IoTOperations.Management/models/base.tsp b/specification/iotoperations/IoTOperations.Management/models/base.tsp index 6bc94b68d6cd..736cb2878627 100644 --- a/specification/iotoperations/IoTOperations.Management/models/base.tsp +++ b/specification/iotoperations/IoTOperations.Management/models/base.tsp @@ -4,6 +4,10 @@ using Azure.ResourceManager; namespace Microsoft.IoTOperations; +@doc("A string with a minimum length of 1.") +@minLength(1) +scalar NonEmptyString extends string; + @doc("Extended location is an extension of Azure locations. They provide a way to use their Azure ARC enabled Kubernetes clusters as target locations for deploying Azure services instances.") model ExtendedLocation { @doc("The name of the extended location.") @@ -52,37 +56,12 @@ union OperationalMode { @doc("Diagnostic Log properties") model DiagnosticsLogs { - @doc("The open telemetry export configuration.") - opentelemetryExportConfig?: OpenTelemetryLogExportConfig; - @doc("The log level. Examples - 'debug', 'info', 'warn', 'error', 'trace'.") level?: string = "info"; } -@doc("OpenTelemetry Log Export Configuration properties") -model OpenTelemetryLogExportConfig { - ...OpenTelemetryExportConfig; - - @doc("The log level. Examples - 'debug', 'info', 'warn', 'error', 'trace'.") - level?: string = "error"; -} - -@doc("OpenTelemetry Export Configuration properties") -model OpenTelemetryExportConfig { - @doc("The open telemetry collector endpoint to export to.") - otlpGrpcEndpoint: string; - - @doc("How often to export the metrics to the open telemetry collector.") - @minValue(1) - @maxValue(300) - intervalSeconds?: int32 = 30; -} - @doc("Diagnostic Metrics properties") model Metrics { - @doc("The open telemetry export configuration.") - opentelemetryExportConfig?: OpenTelemetryExportConfig; - @doc("The prometheus port to expose the metrics.") @minValue(0) @maxValue(65535) @@ -243,3 +222,10 @@ union ServiceAccountTokenMethod { @doc("ServiceAccountToken Option") ServiceAccountToken: ServiceAccountToken, } + +scalar SchemaRegistryID + extends Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.DeviceRegistry/schemaRegistries", + } + ]>; diff --git a/specification/iotoperations/IoTOperations.Management/models/broker/brokers.tsp b/specification/iotoperations/IoTOperations.Management/models/broker/brokers.tsp index a3cd53d8af7f..7f2cd7e7265f 100644 --- a/specification/iotoperations/IoTOperations.Management/models/broker/brokers.tsp +++ b/specification/iotoperations/IoTOperations.Management/models/broker/brokers.tsp @@ -145,9 +145,6 @@ model Traces { @doc("The toggle to enable/disable traces.") mode?: OperationalMode = OperationalMode.Enabled; - @doc("The open telemetry export configuration.") - opentelemetryExportConfig?: OpenTelemetryExportConfig; - @doc("The cache size in megabytes.") @minValue(1) @maxValue(128) diff --git a/specification/iotoperations/IoTOperations.Management/models/broker/listeners.tsp b/specification/iotoperations/IoTOperations.Management/models/broker/listeners.tsp index 9f4b43cccfdf..e53eb67b5ef8 100644 --- a/specification/iotoperations/IoTOperations.Management/models/broker/listeners.tsp +++ b/specification/iotoperations/IoTOperations.Management/models/broker/listeners.tsp @@ -33,7 +33,7 @@ model BrokerListenerResource is ProxyResource<BrokerListenerProperties> { @doc("Defines a Broker listener. A listener is a collection of ports on which the broker accepts connections from clients.") model BrokerListenerProperties { @doc("Kubernetes Service name of this listener.") - serviceName?: string = "aio-mq-dmqtt-frontend"; + serviceName?: string; @doc("Ports on which this listener accepts client connections.") @OpenAPI.extension("x-ms-identifiers", ["port"]) diff --git a/specification/iotoperations/IoTOperations.Management/models/dataflows/dataflowEndpoints.tsp b/specification/iotoperations/IoTOperations.Management/models/dataflows/dataflowEndpoints.tsp index ab49733743ad..253af812af74 100644 --- a/specification/iotoperations/IoTOperations.Management/models/dataflows/dataflowEndpoints.tsp +++ b/specification/iotoperations/IoTOperations.Management/models/dataflows/dataflowEndpoints.tsp @@ -329,7 +329,7 @@ model DataflowEndpointLocalStorage { @doc("Broker endpoint properties") model DataflowEndpointMqtt { - @doc("authentication properties. DEFAULT: kubernetes.audience=aio-mq-internal. NOTE - Enum field only property is allowed") + @doc("authentication properties. DEFAULT: kubernetes.audience=aio-internal. NOTE - Enum field only property is allowed") authentication: DataflowEndpointMqttAuthentication; @doc("Client ID prefix. Client ID generated by the dataflow is <prefix>-TBD. Optional; no prefix if omitted.") @@ -375,7 +375,7 @@ model DataflowEndpointMqttAuthentication { ...ManagedIdentity; - @doc("Kubernetes service account token authentication. Default audience if not set is aio-mq-internal") + @doc("Kubernetes service account token authentication. Default audience if not set is aio-internal") serviceAccountTokenSettings?: DataflowEndpointAuthenticationServiceAccountToken; @doc("X.509 certificate authentication.") diff --git a/specification/iotoperations/IoTOperations.Management/models/dataflows/dataflows.tsp b/specification/iotoperations/IoTOperations.Management/models/dataflows/dataflows.tsp index bc12024292e7..4d84a7f82da8 100644 --- a/specification/iotoperations/IoTOperations.Management/models/dataflows/dataflows.tsp +++ b/specification/iotoperations/IoTOperations.Management/models/dataflows/dataflows.tsp @@ -212,7 +212,7 @@ model DataflowDestinationOperationSettings { endpointRef: string; @doc("Destination location, can be a topic or table name. Supports dynamic values with $topic, $systemProperties, $userProperties, $payload, $context, and $subscription.") - dataDestination: string; + dataDestination: NonEmptyString; } @doc("Dataflow Source Operation properties") @@ -230,5 +230,5 @@ model DataflowSourceOperationSettings { schemaRef?: string; @doc("List of source locations. Can be Broker or Kafka topics. Supports wildcards # and +.") - dataSources: string[]; + dataSources: NonEmptyString[]; } diff --git a/specification/iotoperations/IoTOperations.Management/models/instance.tsp b/specification/iotoperations/IoTOperations.Management/models/instance.tsp index de89df9f4ae9..1626412c71f6 100644 --- a/specification/iotoperations/IoTOperations.Management/models/instance.tsp +++ b/specification/iotoperations/IoTOperations.Management/models/instance.tsp @@ -52,65 +52,11 @@ model InstanceProperties { version?: string; @doc("The reference to the Schema Registry for this AIO Instance.") - @pattern("^[a-z0-9][a-z0-9-]*[a-z0-9]$") - schemaRegistryNamespace: string; - - @doc("The configuration for components of the AIO Instance.") - components?: Components = #{}; -} - -@doc("The configuration for components of the AIO Instance.") -model Components { - @doc("The properties of the ADR instance.") - adr?: AdrProperties = #{ state: OperationalMode.Enabled }; - - @doc("The properties of the AKRI instance.") - akri?: AkriInstanceProperties = #{ state: OperationalMode.Enabled }; - - @doc("The properties of the connectors instance.") - connectors?: ConnectorInstanceProperties = #{ - state: OperationalMode.Enabled, - }; - - @doc("The properties of the dataflows instance.") - dataflows?: DataflowInstanceProperties = #{ state: OperationalMode.Enabled }; - - @doc("The properties of the device provisioning instance.") - schemaRegistry?: SchemaRegistryInstanceProperties = #{ - state: OperationalMode.Enabled, - }; -} - -@doc("The properties of an ADR instance.") -model AdrProperties { - @doc("This determines if the ADR service is enabled.") - @visibility("create", "read") - state: OperationalMode; -} -@doc("The properties of an AKRI instance.") -model AkriInstanceProperties { - @doc("This determines if the AKRI service is enabled.") - @visibility("create", "read") - state: OperationalMode; -} - -@doc("The properties of a Connector instance.") -model ConnectorInstanceProperties { - @doc("This determines if the Connector service is enabled.") - @visibility("create", "read") - state: OperationalMode; -} - -@doc("The properties of an Dataflow instance.") -model DataflowInstanceProperties { - @doc("This determines if the Dataflow service is enabled.") - @visibility("create", "read") - state: OperationalMode; + schemaRegistryRef: SchemaRegistryRef; } -@doc("The properties of a Schema Registry instance.") -model SchemaRegistryInstanceProperties { - @doc("This determines if the Schema Registry service is enabled.") - @visibility("create", "read") - state: OperationalMode; +@doc("The reference to the Schema Registry for this AIO Instance.") +model SchemaRegistryRef { + @doc("The resource ID of the Schema Registry.") + resourceId: SchemaRegistryID; } diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_CreateOrUpdate_Complex.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_CreateOrUpdate_Complex.json new file mode 100644 index 000000000000..99df45a1ca21 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_CreateOrUpdate_Complex.json @@ -0,0 +1,180 @@ +{ + "title": "BrokerAuthentication_CreateOrUpdate_Complex", + "operationId": "BrokerAuthentication_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authenticationName": "resource-name123", + "resource": { + "properties": { + "authenticationMethods": [ + { + "method": "ServiceAccountToken", + "serviceAccountTokenSettings": { + "audiences": [ + "aio-internal" + ] + } + }, + { + "method": "X509", + "x509Settings": { + "trustedClientCaCert": "my-ca", + "authorizationAttributes": { + "root": { + "subject": "CN = Contoso Root CA Cert, OU = Engineering, C = US", + "attributes": { + "organization": "contoso" + } + }, + "intermediate": { + "subject": "CN = Contoso Intermediate CA", + "attributes": { + "city": "seattle", + "foo": "bar" + } + }, + "smart-fan": { + "subject": "CN = smart-fan", + "attributes": { + "building": "17" + } + } + } + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "authenticationMethods": [ + { + "method": "ServiceAccountToken", + "serviceAccountTokenSettings": { + "audiences": [ + "aio-internal" + ] + } + }, + { + "method": "X509", + "x509Settings": { + "trustedClientCaCert": "my-ca", + "authorizationAttributes": { + "root": { + "subject": "CN = Contoso Root CA Cert, OU = Engineering, C = US", + "attributes": { + "organization": "contoso" + } + }, + "intermediate": { + "subject": "CN = Contoso Intermediate CA", + "attributes": { + "city": "seattle", + "foo": "bar" + } + }, + "smart-fan": { + "subject": "CN = smart-fan", + "attributes": { + "building": "17" + } + } + } + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authentications/resource-name123", + "name": "lwucizfvtsdpx", + "type": "kvtilkgcxanlfozrd", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "authenticationMethods": [ + { + "method": "ServiceAccountToken", + "serviceAccountTokenSettings": { + "audiences": [ + "aio-internal" + ] + } + }, + { + "method": "X509", + "x509Settings": { + "trustedClientCaCert": "my-ca", + "authorizationAttributes": { + "root": { + "subject": "CN = Contoso Root CA Cert, OU = Engineering, C = US", + "attributes": { + "organization": "contoso" + } + }, + "intermediate": { + "subject": "CN = Contoso Intermediate CA", + "attributes": { + "city": "seattle", + "foo": "bar" + } + }, + "smart-fan": { + "subject": "CN = smart-fan", + "attributes": { + "building": "17" + } + } + } + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authentications/resource-name123", + "name": "lwucizfvtsdpx", + "type": "kvtilkgcxanlfozrd", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..56d2d89e12ab --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,168 @@ +{ + "title": "BrokerAuthentication_CreateOrUpdate", + "operationId": "BrokerAuthentication_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authenticationName": "resource-name123", + "resource": { + "properties": { + "authenticationMethods": [ + { + "method": "Custom", + "customSettings": { + "auth": { + "x509": { + "secretRef": "secret-name" + } + }, + "caCertConfigMap": "pdecudefqyolvncbus", + "endpoint": "https://www.example.com", + "headers": { + "key8518": "bwityjy" + } + }, + "serviceAccountTokenSettings": { + "audiences": [ + "jqyhyqatuydg" + ] + }, + "x509Settings": { + "authorizationAttributes": { + "key3384": { + "attributes": { + "key186": "ucpajramsz" + }, + "subject": "jpgwctfeixitptfgfnqhua" + } + }, + "trustedClientCaCert": "vlctsqddl" + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "authenticationMethods": [ + { + "method": "Custom", + "customSettings": { + "auth": { + "x509": { + "secretRef": "secret-name" + } + }, + "caCertConfigMap": "pdecudefqyolvncbus", + "endpoint": "https://www.example.com", + "headers": { + "key8518": "bwityjy" + } + }, + "serviceAccountTokenSettings": { + "audiences": [ + "jqyhyqatuydg" + ] + }, + "x509Settings": { + "authorizationAttributes": { + "key3384": { + "attributes": { + "key186": "ucpajramsz" + }, + "subject": "jpgwctfeixitptfgfnqhua" + } + }, + "trustedClientCaCert": "vlctsqddl" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authentications/resource-name123", + "name": "lwucizfvtsdpx", + "type": "kvtilkgcxanlfozrd", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "authenticationMethods": [ + { + "method": "Custom", + "customSettings": { + "auth": { + "x509": { + "secretRef": "secret-name" + } + }, + "caCertConfigMap": "pdecudefqyolvncbus", + "endpoint": "https://www.example.com", + "headers": { + "key8518": "bwityjy" + } + }, + "serviceAccountTokenSettings": { + "audiences": [ + "jqyhyqatuydg" + ] + }, + "x509Settings": { + "authorizationAttributes": { + "key3384": { + "attributes": { + "key186": "ucpajramsz" + }, + "subject": "jpgwctfeixitptfgfnqhua" + } + }, + "trustedClientCaCert": "vlctsqddl" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authentications/resource-name123", + "name": "lwucizfvtsdpx", + "type": "kvtilkgcxanlfozrd", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_Delete_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..2e8c7aa364f3 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "BrokerAuthentication_Delete", + "operationId": "BrokerAuthentication_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authenticationName": "resource-name123" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_Get_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..533d1b8f9a3a --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_Get_MaximumSet_Gen.json @@ -0,0 +1,69 @@ +{ + "title": "BrokerAuthentication_Get", + "operationId": "BrokerAuthentication_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authenticationName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "properties": { + "authenticationMethods": [ + { + "method": "Custom", + "customSettings": { + "auth": { + "x509": { + "secretRef": "secret-name" + } + }, + "caCertConfigMap": "pdecudefqyolvncbus", + "endpoint": "https://www.example.com", + "headers": { + "key8518": "bwityjy" + } + }, + "serviceAccountTokenSettings": { + "audiences": [ + "jqyhyqatuydg" + ] + }, + "x509Settings": { + "authorizationAttributes": { + "key3384": { + "attributes": { + "key186": "ucpajramsz" + }, + "subject": "jpgwctfeixitptfgfnqhua" + } + }, + "trustedClientCaCert": "vlctsqddl" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authentications/resource-name123", + "name": "lwucizfvtsdpx", + "type": "kvtilkgcxanlfozrd", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_ListByResourceGroup_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..8037bfab1583 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "title": "BrokerAuthentication_ListByResourceGroup", + "operationId": "BrokerAuthentication_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "authenticationMethods": [ + { + "method": "Custom", + "customSettings": { + "auth": { + "x509": { + "secretRef": "secret-name" + } + }, + "caCertConfigMap": "pdecudefqyolvncbus", + "endpoint": "https://www.example.com", + "headers": { + "key8518": "bwityjy" + } + }, + "serviceAccountTokenSettings": { + "audiences": [ + "jqyhyqatuydg" + ] + }, + "x509Settings": { + "authorizationAttributes": { + "key3384": { + "attributes": { + "key186": "ucpajramsz" + }, + "subject": "jpgwctfeixitptfgfnqhua" + } + }, + "trustedClientCaCert": "vlctsqddl" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authentications/resource-name123", + "name": "lwucizfvtsdpx", + "type": "kvtilkgcxanlfozrd", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_CreateOrUpdate_Complex.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_CreateOrUpdate_Complex.json new file mode 100644 index 000000000000..74ccc622f5c2 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_CreateOrUpdate_Complex.json @@ -0,0 +1,243 @@ +{ + "title": "BrokerAuthorization_CreateOrUpdate_Complex", + "operationId": "BrokerAuthorization_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authorizationName": "resource-name123", + "resource": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "principals": { + "usernames": [ + "temperature-sensor", + "humidity-sensor" + ], + "attributes": [ + { + "building": "17", + "organization": "contoso" + } + ] + }, + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "{principal.attributes.building}*" + ] + }, + { + "method": "Publish", + "topics": [ + "sensors/{principal.attributes.building}/{principal.clientId}/telemetry/*" + ] + }, + { + "method": "Subscribe", + "topics": [ + "commands/{principal.attributes.organization}" + ] + } + ], + "stateStoreResources": [ + { + "method": "Read", + "keyType": "Pattern", + "keys": [ + "myreadkey", + "myotherkey?", + "mynumerickeysuffix[0-9]", + "clients:{principal.clientId}:*" + ] + }, + { + "method": "ReadWrite", + "keyType": "Binary", + "keys": [ + "MTE2IDEwMSAxMTUgMTE2" + ] + } + ] + } + ] + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "principals": { + "usernames": [ + "temperature-sensor", + "humidity-sensor" + ], + "attributes": [ + { + "building": "17", + "organization": "contoso" + } + ] + }, + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "{principal.attributes.building}*" + ] + }, + { + "method": "Publish", + "topics": [ + "sensors/{principal.attributes.building}/{principal.clientId}/telemetry/*" + ] + }, + { + "method": "Subscribe", + "topics": [ + "commands/{principal.attributes.organization}" + ] + } + ], + "stateStoreResources": [ + { + "method": "Read", + "keyType": "Pattern", + "keys": [ + "myreadkey", + "myotherkey?", + "mynumerickeysuffix[0-9]", + "clients:{principal.clientId}:*" + ] + }, + { + "method": "ReadWrite", + "keyType": "Binary", + "keys": [ + "MTE2IDEwMSAxMTUgMTE2" + ] + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "principals": { + "usernames": [ + "temperature-sensor", + "humidity-sensor" + ], + "attributes": [ + { + "building": "17", + "organization": "contoso" + } + ] + }, + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "{principal.attributes.building}*" + ] + }, + { + "method": "Publish", + "topics": [ + "sensors/{principal.attributes.building}/{principal.clientId}/telemetry/*" + ] + }, + { + "method": "Subscribe", + "topics": [ + "commands/{principal.attributes.organization}" + ] + } + ], + "stateStoreResources": [ + { + "method": "Read", + "keyType": "Pattern", + "keys": [ + "myreadkey", + "myotherkey?", + "mynumerickeysuffix[0-9]", + "clients:{principal.clientId}:*" + ] + }, + { + "method": "ReadWrite", + "keyType": "Binary", + "keys": [ + "MTE2IDEwMSAxMTUgMTE2" + ] + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..13af93f825f8 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,189 @@ +{ + "title": "BrokerAuthorization_CreateOrUpdate", + "operationId": "BrokerAuthorization_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authorizationName": "resource-name123", + "resource": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "nlc" + ], + "topics": [ + "wvuca" + ] + } + ], + "principals": { + "attributes": [ + { + "key5526": "nydhzdhbldygqcn" + } + ], + "clientIds": [ + "smopeaeddsygz" + ], + "usernames": [ + "iozngyqndrteikszkbasinzdjtm" + ] + }, + "stateStoreResources": [ + { + "keyType": "Pattern", + "keys": [ + "tkounsqtwvzyaklxjqoerpu" + ], + "method": "Read" + } + ] + } + ] + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "nlc" + ], + "topics": [ + "wvuca" + ] + } + ], + "principals": { + "attributes": [ + { + "key5526": "nydhzdhbldygqcn" + } + ], + "clientIds": [ + "smopeaeddsygz" + ], + "usernames": [ + "iozngyqndrteikszkbasinzdjtm" + ] + }, + "stateStoreResources": [ + { + "keyType": "Pattern", + "keys": [ + "tkounsqtwvzyaklxjqoerpu" + ], + "method": "Read" + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "nlc" + ], + "topics": [ + "wvuca" + ] + } + ], + "principals": { + "attributes": [ + { + "key5526": "nydhzdhbldygqcn" + } + ], + "clientIds": [ + "smopeaeddsygz" + ], + "usernames": [ + "iozngyqndrteikszkbasinzdjtm" + ] + }, + "stateStoreResources": [ + { + "keyType": "Pattern", + "keys": [ + "tkounsqtwvzyaklxjqoerpu" + ], + "method": "Read" + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_CreateOrUpdate_Simple.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_CreateOrUpdate_Simple.json new file mode 100644 index 000000000000..3c5e60f84d3b --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_CreateOrUpdate_Simple.json @@ -0,0 +1,186 @@ +{ + "title": "BrokerAuthorization_CreateOrUpdate_Simple", + "operationId": "BrokerAuthorization_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authorizationName": "resource-name123", + "resource": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "principals": { + "clientIds": [ + "my-client-id" + ], + "attributes": [ + { + "floor": "floor1", + "site": "site1" + } + ] + }, + "brokerResources": [ + { + "method": "Connect" + }, + { + "method": "Subscribe", + "topics": [ + "topic", + "topic/with/wildcard/#" + ] + } + ], + "stateStoreResources": [ + { + "method": "ReadWrite", + "keyType": "Pattern", + "keys": [ + "*" + ] + } + ] + } + ] + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "principals": { + "clientIds": [ + "my-client-id" + ], + "attributes": [ + { + "floor": "floor1", + "site": "site1" + } + ] + }, + "brokerResources": [ + { + "method": "Connect" + }, + { + "method": "Subscribe", + "topics": [ + "topic", + "topic/with/wildcard/#" + ] + } + ], + "stateStoreResources": [ + { + "method": "ReadWrite", + "keyType": "Pattern", + "keys": [ + "*" + ] + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "principals": { + "clientIds": [ + "my-client-id" + ], + "attributes": [ + { + "floor": "floor1", + "site": "site1" + } + ] + }, + "brokerResources": [ + { + "method": "Connect" + }, + { + "method": "Subscribe", + "topics": [ + "topic", + "topic/with/wildcard/#" + ] + } + ], + "stateStoreResources": [ + { + "method": "ReadWrite", + "keyType": "Pattern", + "keys": [ + "*" + ] + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_Delete_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..9576e1bff109 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "BrokerAuthorization_Delete", + "operationId": "BrokerAuthorization_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authorizationName": "resource-name123" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_Get_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..1e1df47ac23a --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_Get_MaximumSet_Gen.json @@ -0,0 +1,76 @@ +{ + "title": "BrokerAuthorization_Get", + "operationId": "BrokerAuthorization_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authorizationName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "nlc" + ], + "topics": [ + "wvuca" + ] + } + ], + "principals": { + "attributes": [ + { + "key5526": "nydhzdhbldygqcn" + } + ], + "clientIds": [ + "smopeaeddsygz" + ], + "usernames": [ + "iozngyqndrteikszkbasinzdjtm" + ] + }, + "stateStoreResources": [ + { + "keyType": "Pattern", + "keys": [ + "tkounsqtwvzyaklxjqoerpu" + ], + "method": "Read" + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_ListByResourceGroup_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..44ef2bacbea2 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,80 @@ +{ + "title": "BrokerAuthorization_ListByResourceGroup", + "operationId": "BrokerAuthorization_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "nlc" + ], + "topics": [ + "wvuca" + ] + } + ], + "principals": { + "attributes": [ + { + "key5526": "nydhzdhbldygqcn" + } + ], + "clientIds": [ + "smopeaeddsygz" + ], + "usernames": [ + "iozngyqndrteikszkbasinzdjtm" + ] + }, + "stateStoreResources": [ + { + "keyType": "Pattern", + "keys": [ + "tkounsqtwvzyaklxjqoerpu" + ], + "method": "Read" + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_CreateOrUpdate_Complex.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_CreateOrUpdate_Complex.json new file mode 100644 index 000000000000..fab5938b5e49 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_CreateOrUpdate_Complex.json @@ -0,0 +1,182 @@ +{ + "title": "BrokerListener_CreateOrUpdate_Complex", + "operationId": "BrokerListener_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "listenerName": "resource-name123", + "resource": { + "properties": { + "serviceType": "LoadBalancer", + "ports": [ + { + "port": 8080, + "authenticationRef": "example-authentication", + "protocol": "WebSockets" + }, + { + "port": 8443, + "authenticationRef": "example-authentication", + "protocol": "WebSockets", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "name": "example-issuer", + "kind": "Issuer" + } + } + } + }, + { + "port": 1883, + "authenticationRef": "example-authentication" + }, + { + "port": 8883, + "authenticationRef": "example-authentication", + "tls": { + "mode": "Manual", + "manual": { + "secretRef": "example-secret" + } + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "serviceType": "LoadBalancer", + "ports": [ + { + "port": 8080, + "authenticationRef": "example-authentication", + "protocol": "WebSockets" + }, + { + "port": 8443, + "authenticationRef": "example-authentication", + "protocol": "WebSockets", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "name": "example-issuer", + "kind": "Issuer" + } + } + } + }, + { + "port": 1883, + "authenticationRef": "example-authentication" + }, + { + "port": 8883, + "authenticationRef": "example-authentication", + "tls": { + "mode": "Manual", + "manual": { + "secretRef": "example-secret" + } + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "serviceType": "LoadBalancer", + "ports": [ + { + "port": 8080, + "authenticationRef": "example-authentication", + "protocol": "WebSockets" + }, + { + "port": 8443, + "authenticationRef": "example-authentication", + "protocol": "WebSockets", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "name": "example-issuer", + "kind": "Issuer" + } + } + } + }, + { + "port": 1883, + "authenticationRef": "example-authentication" + }, + { + "port": 8883, + "authenticationRef": "example-authentication", + "tls": { + "mode": "Manual", + "manual": { + "secretRef": "example-secret" + } + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..673225b32522 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,186 @@ +{ + "title": "BrokerListener_CreateOrUpdate", + "operationId": "BrokerListener_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "listenerName": "resource-name123", + "resource": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "ports": [ + { + "authenticationRef": "tjvdroaqqy", + "authorizationRef": "inxhvxnwswyrvt", + "nodePort": 7281, + "port": 1268, + "protocol": "Mqtt", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "duration": "qmpeffoksron", + "secretName": "oagi", + "renewBefore": "hutno", + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "kind": "Issuer", + "name": "ocwoqpgucvjrsuudtjhb" + }, + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + }, + "san": { + "dns": [ + "xhvmhrrhgfsapocjeebqtnzarlj" + ], + "ip": [ + "zbgugfzcgsmegevzktsnibyuyp" + ] + } + }, + "manual": { + "secretRef": "secret-name" + } + } + } + ], + "serviceType": "ClusterIp" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "ports": [ + { + "authenticationRef": "tjvdroaqqy", + "authorizationRef": "inxhvxnwswyrvt", + "nodePort": 7281, + "port": 1268, + "protocol": "Mqtt", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "duration": "qmpeffoksron", + "secretName": "oagi", + "renewBefore": "hutno", + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "kind": "Issuer", + "name": "ocwoqpgucvjrsuudtjhb" + }, + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + }, + "san": { + "dns": [ + "xhvmhrrhgfsapocjeebqtnzarlj" + ], + "ip": [ + "zbgugfzcgsmegevzktsnibyuyp" + ] + } + }, + "manual": { + "secretRef": "secret-name" + } + } + } + ], + "serviceType": "ClusterIp", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "ports": [ + { + "authenticationRef": "tjvdroaqqy", + "authorizationRef": "inxhvxnwswyrvt", + "nodePort": 7281, + "port": 1268, + "protocol": "Mqtt", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "duration": "qmpeffoksron", + "secretName": "oagi", + "renewBefore": "hutno", + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "kind": "Issuer", + "name": "ocwoqpgucvjrsuudtjhb" + }, + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + }, + "san": { + "dns": [ + "xhvmhrrhgfsapocjeebqtnzarlj" + ], + "ip": [ + "zbgugfzcgsmegevzktsnibyuyp" + ] + } + }, + "manual": { + "secretRef": "secret-name" + } + } + } + ], + "serviceType": "ClusterIp", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_CreateOrUpdate_Simple.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_CreateOrUpdate_Simple.json new file mode 100644 index 000000000000..70613eca4838 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_CreateOrUpdate_Simple.json @@ -0,0 +1,88 @@ +{ + "title": "BrokerListener_CreateOrUpdate_Simple", + "operationId": "BrokerListener_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "listenerName": "resource-name123", + "resource": { + "properties": { + "ports": [ + { + "port": 1883 + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "serviceType": "LoadBalancer", + "ports": [ + { + "port": 1883 + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "serviceType": "LoadBalancer", + "ports": [ + { + "port": 1883 + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_Delete_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..2eae4091f973 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "BrokerListener_Delete", + "operationId": "BrokerListener_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "listenerName": "resource-name123" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_Get_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..e0142b23e6b9 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_Get_MaximumSet_Gen.json @@ -0,0 +1,75 @@ +{ + "title": "BrokerListener_Get", + "operationId": "BrokerListener_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "listenerName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "ports": [ + { + "authenticationRef": "tjvdroaqqy", + "authorizationRef": "inxhvxnwswyrvt", + "nodePort": 7281, + "port": 1268, + "protocol": "Mqtt", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "duration": "qmpeffoksron", + "secretName": "oagi", + "renewBefore": "hutno", + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "kind": "Issuer", + "name": "ocwoqpgucvjrsuudtjhb" + }, + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + }, + "san": { + "dns": [ + "xhvmhrrhgfsapocjeebqtnzarlj" + ], + "ip": [ + "zbgugfzcgsmegevzktsnibyuyp" + ] + } + }, + "manual": { + "secretRef": "secret-name" + } + } + } + ], + "serviceType": "ClusterIp", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_ListByResourceGroup_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..d8eaf998413a --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,79 @@ +{ + "title": "BrokerListener_ListByResourceGroup", + "operationId": "BrokerListener_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "ports": [ + { + "authenticationRef": "tjvdroaqqy", + "authorizationRef": "inxhvxnwswyrvt", + "nodePort": 7281, + "port": 1268, + "protocol": "Mqtt", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "duration": "qmpeffoksron", + "secretName": "oagi", + "renewBefore": "hutno", + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "kind": "Issuer", + "name": "ocwoqpgucvjrsuudtjhb" + }, + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + }, + "san": { + "dns": [ + "xhvmhrrhgfsapocjeebqtnzarlj" + ], + "ip": [ + "zbgugfzcgsmegevzktsnibyuyp" + ] + } + }, + "manual": { + "secretRef": "secret-name" + } + } + } + ], + "serviceType": "ClusterIp", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_Complex.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_Complex.json new file mode 100644 index 000000000000..8f9965aa69f7 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_Complex.json @@ -0,0 +1,122 @@ +{ + "title": "Broker_CreateOrUpdate_Complex", + "operationId": "Broker_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "resource": { + "properties": { + "cardinality": { + "backendChain": { + "partitions": 2, + "redundancyFactor": 2, + "workers": 2 + }, + "frontend": { + "replicas": 2, + "workers": 2 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "50M" + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Medium" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "cardinality": { + "backendChain": { + "partitions": 2, + "redundancyFactor": 2, + "workers": 2 + }, + "frontend": { + "replicas": 2, + "workers": 2 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "50M" + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Medium", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "cardinality": { + "backendChain": { + "partitions": 2, + "redundancyFactor": 2, + "workers": 2 + }, + "frontend": { + "replicas": 2, + "workers": 2 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "50M" + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Medium", + "provisioningState": "Accepted" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..1a9202c793fc --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,500 @@ +{ + "title": "Broker_CreateOrUpdate", + "operationId": "Broker_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "resource": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_Minimal.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_Minimal.json new file mode 100644 index 000000000000..db21f2f9961d --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_Minimal.json @@ -0,0 +1,357 @@ +{ + "title": "Broker_CreateOrUpdate_Minimal", + "operationId": "Broker_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "resource": { + "properties": { + "memoryProfile": "Tiny" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_Simple.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_Simple.json new file mode 100644 index 000000000000..e163401612c6 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_Simple.json @@ -0,0 +1,371 @@ +{ + "title": "Broker_CreateOrUpdate_Simple", + "operationId": "Broker_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "resource": { + "properties": { + "cardinality": { + "backendChain": { + "partitions": 2, + "redundancyFactor": 2, + "workers": 2 + }, + "frontend": { + "replicas": 2, + "workers": 2 + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Low" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_Delete_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..8cc056cc7fbd --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "Broker_Delete", + "operationId": "Broker_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_Get_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..170aa26bcd86 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_Get_MaximumSet_Gen.json @@ -0,0 +1,179 @@ +{ + "title": "Broker_Get", + "operationId": "Broker_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_ListByResourceGroup_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..1c1a1bf57ec5 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,183 @@ +{ + "title": "Broker_ListByResourceGroup", + "operationId": "Broker_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_ADLSv2.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_ADLSv2.json new file mode 100644 index 000000000000..3b8475111cd2 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_ADLSv2.json @@ -0,0 +1,98 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_ADLSv2", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "adlsv2-endpoint", + "resource": { + "properties": { + "endpointType": "DataLakeStorage", + "dataLakeStorageSettings": { + "host": "example.blob.core.windows.net", + "authentication": { + "method": "AccessToken", + "accessTokenSettings": { + "secretRef": "my-secret" + } + } + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "DataLakeStorage", + "dataLakeStorageSettings": { + "host": "example.blob.core.windows.net", + "authentication": { + "method": "AccessToken", + "accessTokenSettings": { + "secretRef": "my-secret" + } + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "DataLakeStorage", + "dataLakeStorageSettings": { + "host": "example.blob.core.windows.net", + "authentication": { + "method": "AccessToken", + "accessTokenSettings": { + "secretRef": "my-secret" + } + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_ADX.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_ADX.json new file mode 100644 index 000000000000..db63d70425bb --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_ADX.json @@ -0,0 +1,107 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_ADX", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "adx-endpoint", + "resource": { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "host": "example.westeurope.kusto.windows.net", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "database": "example-database", + "batching": { + "latencySeconds": 9312, + "maxMessages": 9028 + } + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "host": "example.westeurope.kusto.windows.net", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "database": "example-database", + "batching": { + "latencySeconds": 9312, + "maxMessages": 9028 + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "host": "example.westeurope.kusto.windows.net", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "database": "example-database", + "batching": { + "latencySeconds": 9312, + "maxMessages": 9028 + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_AIO.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_AIO.json new file mode 100644 index 000000000000..18cef846e282 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_AIO.json @@ -0,0 +1,110 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_AIO", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "aio-builtin-broker-endpoint", + "resource": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "aio-broker:18883", + "authentication": { + "method": "Kubernetes", + "serviceAccountTokenSettings": { + "audience": "aio-internal" + } + }, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "aio-ca-trust-bundle-test-only" + } + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "aio-broker:18883", + "authentication": { + "method": "Kubernetes", + "serviceAccountTokenSettings": { + "audience": "aio-internal" + } + }, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "aio-ca-trust-bundle-test-only" + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "aio-broker:18883", + "authentication": { + "method": "Kubernetes", + "serviceAccountTokenSettings": { + "audience": "aio-internal" + } + }, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "aio-ca-trust-bundle-test-only" + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_EventGrid.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_EventGrid.json new file mode 100644 index 000000000000..09a2283578b4 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_EventGrid.json @@ -0,0 +1,101 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_EventGrid", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "event-grid-endpoint", + "resource": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "example.westeurope-1.ts.eventgrid.azure.net:8883", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "tls": { + "mode": "Enabled" + } + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "example.westeurope-1.ts.eventgrid.azure.net:8883", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "tls": { + "mode": "Enabled" + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "example.westeurope-1.ts.eventgrid.azure.net:8883", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "tls": { + "mode": "Enabled" + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_EventHub.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_EventHub.json new file mode 100644 index 000000000000..f6730880e2b6 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_EventHub.json @@ -0,0 +1,104 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_EventHub", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "event-hub-endpoint", + "resource": { + "properties": { + "endpointType": "Kafka", + "kafkaSettings": { + "host": "example.servicebus.windows.net:9093", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "tls": { + "mode": "Enabled" + }, + "consumerGroupId": "aiodataflows" + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "Kafka", + "kafkaSettings": { + "host": "example.servicebus.windows.net:9093", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "tls": { + "mode": "Enabled" + }, + "consumerGroupId": "aiodataflows" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "Kafka", + "kafkaSettings": { + "host": "example.servicebus.windows.net:9093", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "tls": { + "mode": "Enabled" + }, + "consumerGroupId": "aiodataflows" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_Fabric.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_Fabric.json new file mode 100644 index 000000000000..d4393e8da225 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_Fabric.json @@ -0,0 +1,107 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_Fabric", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "fabric-endpoint", + "resource": { + "properties": { + "endpointType": "FabricOneLake", + "fabricOneLakeSettings": { + "host": "onelake.dfs.fabric.microsoft.com", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "names": { + "workspaceName": "example-workspace", + "lakehouseName": "example-lakehouse" + }, + "oneLakePathType": "Tables" + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "FabricOneLake", + "fabricOneLakeSettings": { + "host": "onelake.dfs.fabric.microsoft.com", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "names": { + "workspaceName": "example-workspace", + "lakehouseName": "example-lakehouse" + }, + "oneLakePathType": "Tables" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "FabricOneLake", + "fabricOneLakeSettings": { + "host": "onelake.dfs.fabric.microsoft.com", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "names": { + "workspaceName": "example-workspace", + "lakehouseName": "example-lakehouse" + }, + "oneLakePathType": "Tables" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_Kafka.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_Kafka.json new file mode 100644 index 000000000000..34ea2ac53f03 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_Kafka.json @@ -0,0 +1,149 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_Kafka", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "generic-kafka-endpoint", + "resource": { + "properties": { + "endpointType": "Kafka", + "kafkaSettings": { + "host": "example.kafka.local:9093", + "authentication": { + "method": "Sasl", + "saslSettings": { + "saslType": "Plain", + "secretRef": "my-secret" + } + }, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "ca-certificates" + }, + "consumerGroupId": "dataflows", + "compression": "Gzip", + "batching": { + "mode": "Enabled", + "latencyMs": 5, + "maxBytes": 1000000, + "maxMessages": 100000 + }, + "partitionStrategy": "Default", + "kafkaAcks": "All", + "copyMqttProperties": "Enabled", + "cloudEventAttributes": "Propagate" + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "Kafka", + "kafkaSettings": { + "host": "example.kafka.local:9093", + "authentication": { + "method": "Sasl", + "saslSettings": { + "saslType": "Plain", + "secretRef": "my-secret" + } + }, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "ca-certificates" + }, + "consumerGroupId": "dataflows", + "compression": "Gzip", + "batching": { + "mode": "Enabled", + "latencyMs": 5, + "maxBytes": 1000000, + "maxMessages": 100000 + }, + "partitionStrategy": "Default", + "kafkaAcks": "All", + "copyMqttProperties": "Enabled", + "cloudEventAttributes": "Propagate" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "Kafka", + "kafkaSettings": { + "host": "example.kafka.local:9093", + "authentication": { + "method": "Sasl", + "saslSettings": { + "saslType": "Plain", + "secretRef": "my-secret" + } + }, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "ca-certificates" + }, + "consumerGroupId": "dataflows", + "compression": "Gzip", + "batching": { + "mode": "Enabled", + "latencyMs": 5, + "maxBytes": 1000000, + "maxMessages": 100000 + }, + "partitionStrategy": "Default", + "kafkaAcks": "All", + "copyMqttProperties": "Enabled", + "cloudEventAttributes": "Propagate" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_LocalStorage.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_LocalStorage.json new file mode 100644 index 000000000000..6c498588c715 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_LocalStorage.json @@ -0,0 +1,80 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_LocalStorage", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "local-storage-endpoint", + "resource": { + "properties": { + "endpointType": "LocalStorage", + "localStorageSettings": { + "persistentVolumeClaimRef": "example-pvc" + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "LocalStorage", + "localStorageSettings": { + "persistentVolumeClaimRef": "example-pvc" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "LocalStorage", + "localStorageSettings": { + "persistentVolumeClaimRef": "example-pvc" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_MQTT.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_MQTT.json new file mode 100644 index 000000000000..b420b27e3664 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_MQTT.json @@ -0,0 +1,128 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_MQTT", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "generic-mqtt-broker-endpoint", + "resource": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "example.broker.local:1883", + "authentication": { + "method": "X509Certificate", + "x509CertificateSettings": { + "secretRef": "example-secret" + } + }, + "tls": { + "mode": "Disabled" + }, + "clientIdPrefix": "factory-gateway", + "retain": "Keep", + "sessionExpirySeconds": 3600, + "qos": 1, + "protocol": "WebSockets", + "maxInflightMessages": 100, + "keepAliveSeconds": 60 + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "example.broker.local:1883", + "authentication": { + "method": "X509Certificate", + "x509CertificateSettings": { + "secretRef": "example-secret" + } + }, + "tls": { + "mode": "Disabled" + }, + "clientIdPrefix": "factory-gateway", + "retain": "Keep", + "sessionExpirySeconds": 3600, + "qos": 1, + "protocol": "WebSockets", + "maxInflightMessages": 100, + "keepAliveSeconds": 60 + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "example.broker.local:1883", + "authentication": { + "method": "X509Certificate", + "x509CertificateSettings": { + "secretRef": "example-secret" + } + }, + "tls": { + "mode": "Disabled" + }, + "clientIdPrefix": "factory-gateway", + "retain": "Keep", + "sessionExpirySeconds": 3600, + "qos": 1, + "protocol": "WebSockets", + "maxInflightMessages": 100, + "keepAliveSeconds": 60 + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..1fe7b32d00a5 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,476 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "resource-name123", + "resource": { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "database": "yqcdpjsifm", + "host": "<cluster>.<region>.kusto.windows.net", + "batching": { + "latencySeconds": 9312, + "maxMessages": 9028 + } + }, + "dataLakeStorageSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "accessTokenSettings": { + "secretRef": "sevriyphcvnlrnfudqzejecwa" + }, + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "host": "<account>.blob.core.windows.net", + "batching": { + "latencySeconds": 9312, + "maxMessages": 9028 + } + }, + "fabricOneLakeSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "names": { + "lakehouseName": "wpeathi", + "workspaceName": "nwgmitkbljztgms" + }, + "oneLakePathType": "Files", + "host": "https://<host>.fabric.microsoft.com", + "batching": { + "latencySeconds": 9312, + "maxMessages": 9028 + } + }, + "kafkaSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "saslSettings": { + "saslType": "Plain", + "secretRef": "visyxoztqnylvbyokhtmpdkwes" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "consumerGroupId": "ukkzcjiyenhxokat", + "host": "pwcqfiqclcgneolpewnyavoulbip", + "batching": { + "mode": "Enabled", + "latencyMs": 3679, + "maxBytes": 8887, + "maxMessages": 2174 + }, + "copyMqttProperties": "Enabled", + "compression": "None", + "kafkaAcks": "Zero", + "partitionStrategy": "Default", + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "localStorageSettings": { + "persistentVolumeClaimRef": "jjwqwvd" + }, + "mqttSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "serviceAccountTokenSettings": { + "audience": "ejbklrbxgjaqleoycgpje" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "clientIdPrefix": "kkljsdxdirfhwxtkavldekeqhv", + "host": "nyhnxqnbspstctl", + "protocol": "Mqtt", + "keepAliveSeconds": 0, + "retain": "Keep", + "maxInflightMessages": 0, + "qos": 1, + "sessionExpirySeconds": 0, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "database": "yqcdpjsifm", + "host": "<cluster>.<region>.kusto.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "dataLakeStorageSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "accessTokenSettings": { + "secretRef": "sevriyphcvnlrnfudqzejecwa" + }, + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "host": "<account>.blob.core.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "fabricOneLakeSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "names": { + "lakehouseName": "wpeathi", + "workspaceName": "nwgmitkbljztgms" + }, + "oneLakePathType": "Files", + "host": "https://<host>.fabric.microsoft.com", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "kafkaSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "saslSettings": { + "saslType": "Plain", + "secretRef": "visyxoztqnylvbyokhtmpdkwes" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "consumerGroupId": "ukkzcjiyenhxokat", + "host": "pwcqfiqclcgneolpewnyavoulbip", + "batching": { + "mode": "Enabled", + "latencyMs": 3679, + "maxBytes": 8887, + "maxMessages": 2174 + }, + "copyMqttProperties": "Enabled", + "compression": "None", + "kafkaAcks": "Zero", + "partitionStrategy": "Default", + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "localStorageSettings": { + "persistentVolumeClaimRef": "jjwqwvd" + }, + "mqttSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "serviceAccountTokenSettings": { + "audience": "ejbklrbxgjaqleoycgpje" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "clientIdPrefix": "kkljsdxdirfhwxtkavldekeqhv", + "host": "nyhnxqnbspstctl", + "protocol": "Mqtt", + "keepAliveSeconds": 0, + "retain": "Keep", + "maxInflightMessages": 0, + "qos": 1, + "sessionExpirySeconds": 0, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "database": "yqcdpjsifm", + "host": "<cluster>.<region>.kusto.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "dataLakeStorageSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "accessTokenSettings": { + "secretRef": "sevriyphcvnlrnfudqzejecwa" + }, + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "host": "<account>.blob.core.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "fabricOneLakeSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "names": { + "lakehouseName": "wpeathi", + "workspaceName": "nwgmitkbljztgms" + }, + "oneLakePathType": "Files", + "host": "https://<host>.fabric.microsoft.com", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "kafkaSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "saslSettings": { + "saslType": "Plain", + "secretRef": "visyxoztqnylvbyokhtmpdkwes" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "consumerGroupId": "ukkzcjiyenhxokat", + "host": "pwcqfiqclcgneolpewnyavoulbip", + "batching": { + "mode": "Enabled", + "latencyMs": 3679, + "maxBytes": 8887, + "maxMessages": 2174 + }, + "copyMqttProperties": "Enabled", + "compression": "None", + "kafkaAcks": "Zero", + "partitionStrategy": "Default", + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "localStorageSettings": { + "persistentVolumeClaimRef": "jjwqwvd" + }, + "mqttSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "serviceAccountTokenSettings": { + "audience": "ejbklrbxgjaqleoycgpje" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "clientIdPrefix": "kkljsdxdirfhwxtkavldekeqhv", + "host": "nyhnxqnbspstctl", + "protocol": "Mqtt", + "keepAliveSeconds": 0, + "retain": "Keep", + "maxInflightMessages": 0, + "qos": 1, + "sessionExpirySeconds": 0, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_Delete_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..a67f12a1e4da --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "DataflowEndpoint_Delete", + "operationId": "DataflowEndpoint_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "resource-name123" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_Get_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..be8c1f8d0ac3 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_Get_MaximumSet_Gen.json @@ -0,0 +1,171 @@ +{ + "title": "DataflowEndpoint_Get", + "operationId": "DataflowEndpoint_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "database": "yqcdpjsifm", + "host": "<cluster>.<region>.kusto.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "dataLakeStorageSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "accessTokenSettings": { + "secretRef": "sevriyphcvnlrnfudqzejecwa" + }, + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "host": "<account>.blob.core.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "fabricOneLakeSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "names": { + "lakehouseName": "wpeathi", + "workspaceName": "nwgmitkbljztgms" + }, + "oneLakePathType": "Files", + "host": "https://<host>.fabric.microsoft.com", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "kafkaSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "saslSettings": { + "saslType": "Plain", + "secretRef": "visyxoztqnylvbyokhtmpdkwes" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "consumerGroupId": "ukkzcjiyenhxokat", + "host": "pwcqfiqclcgneolpewnyavoulbip", + "batching": { + "mode": "Enabled", + "latencyMs": 3679, + "maxBytes": 8887, + "maxMessages": 2174 + }, + "copyMqttProperties": "Enabled", + "compression": "None", + "kafkaAcks": "Zero", + "partitionStrategy": "Default", + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "localStorageSettings": { + "persistentVolumeClaimRef": "jjwqwvd" + }, + "mqttSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "serviceAccountTokenSettings": { + "audience": "ejbklrbxgjaqleoycgpje" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "clientIdPrefix": "kkljsdxdirfhwxtkavldekeqhv", + "host": "nyhnxqnbspstctl", + "protocol": "Mqtt", + "keepAliveSeconds": 0, + "retain": "Keep", + "maxInflightMessages": 0, + "qos": 1, + "sessionExpirySeconds": 0, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_ListByResourceGroup_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..f9b75de4d82e --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,175 @@ +{ + "title": "DataflowEndpoint_ListByResourceGroup", + "operationId": "DataflowEndpoint_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "database": "yqcdpjsifm", + "host": "<cluster>.<region>.kusto.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "dataLakeStorageSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "accessTokenSettings": { + "secretRef": "sevriyphcvnlrnfudqzejecwa" + }, + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "host": "<account>.blob.core.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "fabricOneLakeSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "names": { + "lakehouseName": "wpeathi", + "workspaceName": "nwgmitkbljztgms" + }, + "oneLakePathType": "Files", + "host": "https://<host>.fabric.microsoft.com", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "kafkaSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "saslSettings": { + "saslType": "Plain", + "secretRef": "visyxoztqnylvbyokhtmpdkwes" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "consumerGroupId": "ukkzcjiyenhxokat", + "host": "pwcqfiqclcgneolpewnyavoulbip", + "batching": { + "mode": "Enabled", + "latencyMs": 3679, + "maxBytes": 8887, + "maxMessages": 2174 + }, + "copyMqttProperties": "Enabled", + "compression": "None", + "kafkaAcks": "Zero", + "partitionStrategy": "Default", + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "localStorageSettings": { + "persistentVolumeClaimRef": "jjwqwvd" + }, + "mqttSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "serviceAccountTokenSettings": { + "audience": "ejbklrbxgjaqleoycgpje" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "clientIdPrefix": "kkljsdxdirfhwxtkavldekeqhv", + "host": "nyhnxqnbspstctl", + "protocol": "Mqtt", + "keepAliveSeconds": 0, + "retain": "Keep", + "maxInflightMessages": 0, + "qos": 1, + "sessionExpirySeconds": 0, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..2a8a90c8ec9e --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,95 @@ +{ + "title": "DataflowProfile_CreateOrUpdate", + "operationId": "DataflowProfile_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "resource": { + "properties": { + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + } + }, + "instanceCount": 14 + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + } + }, + "instanceCount": 14, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + } + }, + "instanceCount": 14, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_CreateOrUpdate_Minimal.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_CreateOrUpdate_Minimal.json new file mode 100644 index 000000000000..8a08b7c71f41 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_CreateOrUpdate_Minimal.json @@ -0,0 +1,71 @@ +{ + "title": "DataflowProfile_CreateOrUpdate_Minimal", + "operationId": "DataflowProfile_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "aio-dataflowprofile", + "resource": { + "properties": { + "instanceCount": 1 + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "instanceCount": 1, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "instanceCount": 1, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_CreateOrUpdate_Multi.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_CreateOrUpdate_Multi.json new file mode 100644 index 000000000000..1358bf219347 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_CreateOrUpdate_Multi.json @@ -0,0 +1,71 @@ +{ + "title": "DataflowProfile_CreateOrUpdate_Multi", + "operationId": "DataflowProfile_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "aio-dataflowprofile", + "resource": { + "properties": { + "instanceCount": 3 + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "instanceCount": 3, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "instanceCount": 3, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_Delete_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..92c5a7d32c78 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "DataflowProfile_Delete", + "operationId": "DataflowProfile_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_Get_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..992da0ba07f8 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_Get_MaximumSet_Gen.json @@ -0,0 +1,44 @@ +{ + "title": "DataflowProfile_Get", + "operationId": "DataflowProfile_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "properties": { + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + } + }, + "instanceCount": 14, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_ListByResourceGroup_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..8e7d80009c85 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "DataflowProfile_ListByResourceGroup", + "operationId": "DataflowProfile_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + } + }, + "instanceCount": 14, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_ComplexContextualization.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_ComplexContextualization.json new file mode 100644 index 000000000000..6706efedf55b --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_ComplexContextualization.json @@ -0,0 +1,222 @@ +{ + "title": "Dataflow_CreateOrUpdate_ComplexContextualization", + "operationId": "Dataflow_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "aio-to-adx-contexualized", + "resource": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "map": [ + { + "inputs": [ + "*" + ], + "output": "*" + }, + { + "inputs": [ + "$context(quality).*" + ], + "output": "enriched.*" + } + ], + "datasets": [ + { + "key": "quality", + "inputs": [ + "$source.country", + "$context.country" + ], + "expression": "$1 == $2" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "adx-endpoint", + "dataDestination": "mytable" + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "map": [ + { + "inputs": [ + "*" + ], + "output": "*" + }, + { + "inputs": [ + "$context(quality).*" + ], + "output": "enriched.*" + } + ], + "datasets": [ + { + "key": "quality", + "inputs": [ + "$source.country", + "$context.country" + ], + "expression": "$1 == $2" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "adx-endpoint", + "dataDestination": "mytable" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "map": [ + { + "inputs": [ + "*" + ], + "output": "*" + }, + { + "inputs": [ + "$context(quality).*" + ], + "output": "enriched.*" + } + ], + "datasets": [ + { + "key": "quality", + "inputs": [ + "$source.country", + "$context.country" + ], + "expression": "$1 == $2" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "adx-endpoint", + "dataDestination": "mytable" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_ComplexEventHub.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_ComplexEventHub.json new file mode 100644 index 000000000000..e10915972919 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_ComplexEventHub.json @@ -0,0 +1,255 @@ +{ + "title": "Dataflow_CreateOrUpdate_ComplexEventHub", + "operationId": "Dataflow_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "aio-to-event-hub-transformed", + "resource": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "builtInTransformationSettings": { + "filter": [ + { + "inputs": [ + "temperature.Value", + "\"Tag 10\".Value" + ], + "expression": "$1 > 9000 && $2 >= 8000" + } + ], + "map": [ + { + "inputs": [ + "*" + ], + "output": "*" + }, + { + "inputs": [ + "temperature.Value", + "\"Tag 10\".Value" + ], + "expression": "($1+$2)/2", + "output": "AvgTemp.Value" + }, + { + "inputs": [], + "expression": "true", + "output": "dataflow-processed" + }, + { + "inputs": [ + "temperature.SourceTimestamp" + ], + "expression": "", + "output": "" + }, + { + "inputs": [ + "\"Tag 10\"" + ], + "expression": "", + "output": "pressure" + }, + { + "inputs": [ + "temperature.Value" + ], + "expression": "cToF($1)", + "output": "temperatureF.Value" + }, + { + "inputs": [ + "\"Tag 10\".Value" + ], + "expression": "scale ($1,0,10,0,100)", + "output": "\"Scale Tag 10\".Value" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "event-hub-endpoint", + "dataDestination": "myuniqueeventhub" + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "map": [ + { + "inputs": [ + "*" + ], + "output": "*" + }, + { + "inputs": [ + "$context(quality).*" + ], + "output": "enriched.*" + } + ], + "datasets": [ + { + "key": "quality", + "inputs": [ + "$source.country", + "$context.country" + ], + "expression": "$1 == $2" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "adx-endpoint", + "dataDestination": "mytable" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "map": [ + { + "inputs": [ + "*" + ], + "output": "*" + }, + { + "inputs": [ + "$context(quality).*" + ], + "output": "enriched.*" + } + ], + "datasets": [ + { + "key": "quality", + "inputs": [ + "$source.country", + "$context.country" + ], + "expression": "$1 == $2" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "adx-endpoint", + "dataDestination": "mytable" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_FilterToTopic.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_FilterToTopic.json new file mode 100644 index 000000000000..3ff5c1c6c7f3 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_FilterToTopic.json @@ -0,0 +1,210 @@ +{ + "title": "Dataflow_CreateOrUpdate_FilterToTopic", + "operationId": "Dataflow_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "mqtt-filter-to-topic", + "resource": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "filter": [ + { + "type": "Filter", + "description": "filter-datapoint", + "inputs": [ + "temperature.Value", + "\"Tag 10\".Value" + ], + "expression": "$1 > 9000 && $2 >= 8000" + } + ], + "map": [ + { + "type": "PassThrough", + "inputs": [ + "*" + ], + "output": "*" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataDestination": "data/filtered/thermostat" + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "filter": [ + { + "type": "Filter", + "description": "filter-datapoint", + "inputs": [ + "temperature.Value", + "\"Tag 10\".Value" + ], + "expression": "$1 > 9000 && $2 >= 8000" + } + ], + "map": [ + { + "type": "PassThrough", + "inputs": [ + "*" + ], + "output": "*" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataDestination": "data/filtered/thermostat" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "filter": [ + { + "type": "Filter", + "description": "filter-datapoint", + "inputs": [ + "temperature.Value", + "\"Tag 10\".Value" + ], + "expression": "$1 > 9000 && $2 >= 8000" + } + ], + "map": [ + { + "type": "PassThrough", + "inputs": [ + "*" + ], + "output": "*" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataDestination": "data/filtered/thermostat" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..9d4a894ae46b --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,237 @@ +{ + "title": "Dataflow_CreateOrUpdate", + "operationId": "Dataflow_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "resource-name123", + "resource": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "knnafvkwoeakm", + "sourceSettings": { + "endpointRef": "iixotodhvhkkfcfyrkoveslqig", + "assetRef": "zayyykwmckaocywdkohmu", + "serializationFormat": "Json", + "schemaRef": "pknmdzqll", + "dataSources": [ + "chkkpymxhp" + ] + }, + "builtInTransformationSettings": { + "serializationFormat": "Delta", + "schemaRef": "mcdc", + "datasets": [ + { + "key": "qsfqcgxaxnhfumrsdsokwyv", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "schemaRef": "n", + "inputs": [ + "mosffpsslifkq" + ], + "expression": "aatbwomvflemsxialv" + } + ], + "filter": [ + { + "type": "Filter", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "sxmjkbntgb" + ], + "expression": "n" + } + ], + "map": [ + { + "type": "NewProperties", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "xsbxuk" + ], + "expression": "txoiltogsarwkzalsphvlmt", + "output": "nvgtmkfl" + } + ] + }, + "destinationSettings": { + "endpointRef": "kybkchnzimerguekuvqlqiqdvvrt", + "dataDestination": "cbrh" + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "knnafvkwoeakm", + "sourceSettings": { + "endpointRef": "iixotodhvhkkfcfyrkoveslqig", + "assetRef": "zayyykwmckaocywdkohmu", + "serializationFormat": "Json", + "schemaRef": "pknmdzqll", + "dataSources": [ + "chkkpymxhp" + ] + }, + "builtInTransformationSettings": { + "serializationFormat": "Delta", + "schemaRef": "mcdc", + "datasets": [ + { + "key": "qsfqcgxaxnhfumrsdsokwyv", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "schemaRef": "n", + "inputs": [ + "mosffpsslifkq" + ], + "expression": "aatbwomvflemsxialv" + } + ], + "filter": [ + { + "type": "Filter", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "sxmjkbntgb" + ], + "expression": "n" + } + ], + "map": [ + { + "type": "NewProperties", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "xsbxuk" + ], + "expression": "txoiltogsarwkzalsphvlmt", + "output": "nvgtmkfl" + } + ] + }, + "destinationSettings": { + "endpointRef": "kybkchnzimerguekuvqlqiqdvvrt", + "dataDestination": "cbrh" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "knnafvkwoeakm", + "sourceSettings": { + "endpointRef": "iixotodhvhkkfcfyrkoveslqig", + "assetRef": "zayyykwmckaocywdkohmu", + "serializationFormat": "Json", + "schemaRef": "pknmdzqll", + "dataSources": [ + "chkkpymxhp" + ] + }, + "builtInTransformationSettings": { + "serializationFormat": "Delta", + "schemaRef": "mcdc", + "datasets": [ + { + "key": "qsfqcgxaxnhfumrsdsokwyv", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "schemaRef": "n", + "inputs": [ + "mosffpsslifkq" + ], + "expression": "aatbwomvflemsxialv" + } + ], + "filter": [ + { + "type": "Filter", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "sxmjkbntgb" + ], + "expression": "n" + } + ], + "map": [ + { + "type": "NewProperties", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "xsbxuk" + ], + "expression": "txoiltogsarwkzalsphvlmt", + "output": "nvgtmkfl" + } + ] + }, + "destinationSettings": { + "endpointRef": "kybkchnzimerguekuvqlqiqdvvrt", + "dataDestination": "cbrh" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_SimpleEventGrid.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_SimpleEventGrid.json new file mode 100644 index 000000000000..73a3038d8527 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_SimpleEventGrid.json @@ -0,0 +1,132 @@ +{ + "title": "Dataflow_CreateOrUpdate_SimpleEventGrid", + "operationId": "Dataflow_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "aio-to-event-grid", + "resource": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "thermostats/+/telemetry/temperature/#" + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "event-grid-endpoint", + "dataDestination": "factory/telemetry" + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "thermostats/+/telemetry/temperature/#" + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "event-grid-endpoint", + "dataDestination": "factory/telemetry" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "thermostats/+/telemetry/temperature/#" + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "event-grid-endpoint", + "dataDestination": "factory/telemetry" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_SimpleFabric.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_SimpleFabric.json new file mode 100644 index 000000000000..f4f3e6a89ecb --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_SimpleFabric.json @@ -0,0 +1,153 @@ +{ + "title": "Dataflow_CreateOrUpdate_SimpleFabric", + "operationId": "Dataflow_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "aio-to-fabric", + "resource": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "builtInTransformationSettings": { + "serializationFormat": "Parquet", + "schemaRef": "aio-sr://exampleNamespace/exmapleParquetSchema:1.0.0" + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "fabric-endpoint", + "dataDestination": "telemetryTable" + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "builtInTransformationSettings": { + "serializationFormat": "Parquet", + "schemaRef": "aio-sr://exampleNamespace/exmapleParquetSchema:1.0.0" + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "fabric-endpoint", + "dataDestination": "telemetryTable" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "builtInTransformationSettings": { + "serializationFormat": "Parquet", + "schemaRef": "aio-sr://exampleNamespace/exmapleParquetSchema:1.0.0" + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "fabric-endpoint", + "dataDestination": "telemetryTable" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_Delete_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..8617fc9681eb --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "Dataflow_Delete", + "operationId": "Dataflow_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "resource-name123" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_Get_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..6daa2b11a21d --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_Get_MaximumSet_Gen.json @@ -0,0 +1,92 @@ +{ + "title": "Dataflow_Get", + "operationId": "Dataflow_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "knnafvkwoeakm", + "sourceSettings": { + "endpointRef": "iixotodhvhkkfcfyrkoveslqig", + "assetRef": "zayyykwmckaocywdkohmu", + "serializationFormat": "Json", + "schemaRef": "pknmdzqll", + "dataSources": [ + "chkkpymxhp" + ] + }, + "builtInTransformationSettings": { + "serializationFormat": "Delta", + "schemaRef": "mcdc", + "datasets": [ + { + "key": "qsfqcgxaxnhfumrsdsokwyv", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "schemaRef": "n", + "inputs": [ + "mosffpsslifkq" + ], + "expression": "aatbwomvflemsxialv" + } + ], + "filter": [ + { + "type": "Filter", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "sxmjkbntgb" + ], + "expression": "n" + } + ], + "map": [ + { + "type": "NewProperties", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "xsbxuk" + ], + "expression": "txoiltogsarwkzalsphvlmt", + "output": "nvgtmkfl" + } + ] + }, + "destinationSettings": { + "endpointRef": "kybkchnzimerguekuvqlqiqdvvrt", + "dataDestination": "cbrh" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_ListByProfileResource_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_ListByProfileResource_MaximumSet_Gen.json new file mode 100644 index 000000000000..d38f51c50759 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_ListByProfileResource_MaximumSet_Gen.json @@ -0,0 +1,96 @@ +{ + "title": "Dataflow_ListByProfileResource", + "operationId": "Dataflow_ListByProfileResource", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "knnafvkwoeakm", + "sourceSettings": { + "endpointRef": "iixotodhvhkkfcfyrkoveslqig", + "assetRef": "zayyykwmckaocywdkohmu", + "serializationFormat": "Json", + "schemaRef": "pknmdzqll", + "dataSources": [ + "chkkpymxhp" + ] + }, + "builtInTransformationSettings": { + "serializationFormat": "Delta", + "schemaRef": "mcdc", + "datasets": [ + { + "key": "qsfqcgxaxnhfumrsdsokwyv", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "schemaRef": "n", + "inputs": [ + "mosffpsslifkq" + ], + "expression": "aatbwomvflemsxialv" + } + ], + "filter": [ + { + "type": "Filter", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "sxmjkbntgb" + ], + "expression": "n" + } + ], + "map": [ + { + "type": "NewProperties", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "xsbxuk" + ], + "expression": "txoiltogsarwkzalsphvlmt", + "output": "nvgtmkfl" + } + ] + }, + "destinationSettings": { + "endpointRef": "kybkchnzimerguekuvqlqiqdvvrt", + "dataDestination": "cbrh" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..ac7583a4acb2 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,103 @@ +{ + "title": "Instance_CreateOrUpdate", + "operationId": "Instance_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "aio-instance", + "resource": { + "properties": { + "schemaRegistryRef": { + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123" + }, + "description": "kpqtgocs" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "location": "xvewadyhycrjpu" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "schemaRegistryRef": { + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123" + }, + "description": "kpqtgocs", + "provisioningState": "Succeeded", + "version": "vjjbmunthiphfmekvxgxcxkzdwjti" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "4a6e4195-75b8-4685-aa0c-0b5704779327", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "tags": {}, + "location": "xvewadyhycrjpu", + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "schemaRegistryRef": { + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123" + }, + "description": "kpqtgocs", + "provisioningState": "Succeeded", + "version": "vjjbmunthiphfmekvxgxcxkzdwjti" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "4a6e4195-75b8-4685-aa0c-0b5704779327", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "tags": {}, + "location": "xvewadyhycrjpu", + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_Delete_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..0b63d7261b0b --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "Instance_Delete", + "operationId": "Instance_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "aio-instance" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_Get_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..03f4b416dda5 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_Get_MaximumSet_Gen.json @@ -0,0 +1,47 @@ +{ + "title": "Instance_Get", + "operationId": "Instance_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "aio-instance" + }, + "responses": { + "200": { + "body": { + "properties": { + "schemaRegistryRef": { + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123" + }, + "description": "rlfvvnnhcypp", + "provisioningState": "Succeeded", + "version": "vjjbmunthiphfmekvxgxcxkzdwjti" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "4a6e4195-75b8-4685-aa0c-0b5704779327", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "tags": {}, + "location": "xvewadyhycrjpu", + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_ListByResourceGroup_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..c4bedfb0b6ce --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,51 @@ +{ + "title": "Instance_ListByResourceGroup", + "operationId": "Instance_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "version": "vjjbmunthiphfmekvxgxcxkzdwjti", + "schemaRegistryRef": { + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123" + }, + "description": "vmujggxdvxk" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "identity": { + "principalId": "4a6e4195-75b8-4685-aa0c-0b5704779327", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec", + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "location": "xvewadyhycrjpu", + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_ListBySubscription_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..7229d3116831 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,50 @@ +{ + "title": "Instance_ListBySubscription", + "operationId": "Instance_ListBySubscription", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "version": "vjjbmunthiphfmekvxgxcxkzdwjti", + "schemaRegistryRef": { + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123" + }, + "description": "empgqmbhvklcqlyahmdsjemlep" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "identity": { + "principalId": "4a6e4195-75b8-4685-aa0c-0b5704779327", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec", + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "location": "xvewadyhycrjpu", + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_Update_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..406c4a22b316 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_Update_MaximumSet_Gen.json @@ -0,0 +1,54 @@ +{ + "title": "Instance_Update", + "operationId": "Instance_Update", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "aio-instance", + "properties": { + "tags": {}, + "identity": { + "type": "None", + "userAssignedIdentities": {} + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "schemaRegistryRef": { + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123" + }, + "description": "wwihkapmgjbyrtyaj", + "provisioningState": "Succeeded", + "version": "vjjbmunthiphfmekvxgxcxkzdwjti" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "4a6e4195-75b8-4685-aa0c-0b5704779327", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "tags": {}, + "location": "xvewadyhycrjpu", + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Operations_List_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..0429eca83eed --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-09-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "xzxqfusky", + "isDataAction": true, + "display": { + "provider": "lrveskajtuwf", + "resource": "d", + "operation": "icuckgobartrrgmirax", + "description": "dsbfnxzvnoqdm" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/iotoperations.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/iotoperations.json new file mode 100644 index 000000000000..98bff7afc2e1 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/iotoperations.json @@ -0,0 +1,6569 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.IoTOperations management service.", + "version": "2024-09-15-preview", + "description": "Microsoft.IoTOperations Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "Instance" + }, + { + "name": "Broker" + }, + { + "name": "BrokerListener" + }, + { + "name": "BrokerAuthentication" + }, + { + "name": "BrokerAuthorization" + }, + { + "name": "DataflowProfile" + }, + { + "name": "Dataflow" + }, + { + "name": "DataflowEndpoint" + } + ], + "paths": { + "/providers/Microsoft.IoTOperations/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTOperations/instances": { + "get": { + "operationId": "Instance_ListBySubscription", + "tags": [ + "Instance" + ], + "description": "List InstanceResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InstanceResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Instance_ListBySubscription": { + "$ref": "./examples/Instance_ListBySubscription_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances": { + "get": { + "operationId": "Instance_ListByResourceGroup", + "tags": [ + "Instance" + ], + "description": "List InstanceResource resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InstanceResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Instance_ListByResourceGroup": { + "$ref": "./examples/Instance_ListByResourceGroup_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}": { + "get": { + "operationId": "Instance_Get", + "tags": [ + "Instance" + ], + "description": "Get a InstanceResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InstanceResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Instance_Get": { + "$ref": "./examples/Instance_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "Instance_CreateOrUpdate", + "tags": [ + "Instance" + ], + "description": "Create a InstanceResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/InstanceResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'InstanceResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/InstanceResource" + } + }, + "201": { + "description": "Resource 'InstanceResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/InstanceResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Instance_CreateOrUpdate": { + "$ref": "./examples/Instance_CreateOrUpdate_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Instance_Update", + "tags": [ + "Instance" + ], + "description": "Update a InstanceResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/InstancePatchModel" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InstanceResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Instance_Update": { + "$ref": "./examples/Instance_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "Instance_Delete", + "tags": [ + "Instance" + ], + "description": "Delete a InstanceResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Instance_Delete": { + "$ref": "./examples/Instance_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers": { + "get": { + "operationId": "Broker_ListByResourceGroup", + "tags": [ + "Broker" + ], + "description": "List BrokerResource resources by InstanceResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/BrokerResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Broker_ListByResourceGroup": { + "$ref": "./examples/Broker_ListByResourceGroup_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}": { + "get": { + "operationId": "Broker_Get", + "tags": [ + "Broker" + ], + "description": "Get a BrokerResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/BrokerResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Broker_Get": { + "$ref": "./examples/Broker_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "Broker_CreateOrUpdate", + "tags": [ + "Broker" + ], + "description": "Create a BrokerResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/BrokerResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'BrokerResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/BrokerResource" + } + }, + "201": { + "description": "Resource 'BrokerResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/BrokerResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Broker_CreateOrUpdate": { + "$ref": "./examples/Broker_CreateOrUpdate_MaximumSet_Gen.json" + }, + "Broker_CreateOrUpdate_Complex": { + "$ref": "./examples/Broker_CreateOrUpdate_Complex.json" + }, + "Broker_CreateOrUpdate_Minimal": { + "$ref": "./examples/Broker_CreateOrUpdate_Minimal.json" + }, + "Broker_CreateOrUpdate_Simple": { + "$ref": "./examples/Broker_CreateOrUpdate_Simple.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Broker_Delete", + "tags": [ + "Broker" + ], + "description": "Delete a BrokerResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Broker_Delete": { + "$ref": "./examples/Broker_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authentications": { + "get": { + "operationId": "BrokerAuthentication_ListByResourceGroup", + "tags": [ + "BrokerAuthentication" + ], + "description": "List BrokerAuthenticationResource resources by BrokerResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/BrokerAuthenticationResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BrokerAuthentication_ListByResourceGroup": { + "$ref": "./examples/BrokerAuthentication_ListByResourceGroup_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authentications/{authenticationName}": { + "get": { + "operationId": "BrokerAuthentication_Get", + "tags": [ + "BrokerAuthentication" + ], + "description": "Get a BrokerAuthenticationResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "authenticationName", + "in": "path", + "description": "Name of Instance broker authentication resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/BrokerAuthenticationResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BrokerAuthentication_Get": { + "$ref": "./examples/BrokerAuthentication_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "BrokerAuthentication_CreateOrUpdate", + "tags": [ + "BrokerAuthentication" + ], + "description": "Create a BrokerAuthenticationResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "authenticationName", + "in": "path", + "description": "Name of Instance broker authentication resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/BrokerAuthenticationResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'BrokerAuthenticationResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/BrokerAuthenticationResource" + } + }, + "201": { + "description": "Resource 'BrokerAuthenticationResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/BrokerAuthenticationResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BrokerAuthentication_CreateOrUpdate": { + "$ref": "./examples/BrokerAuthentication_CreateOrUpdate_MaximumSet_Gen.json" + }, + "BrokerAuthentication_CreateOrUpdate_Complex": { + "$ref": "./examples/BrokerAuthentication_CreateOrUpdate_Complex.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "BrokerAuthentication_Delete", + "tags": [ + "BrokerAuthentication" + ], + "description": "Delete a BrokerAuthenticationResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "authenticationName", + "in": "path", + "description": "Name of Instance broker authentication resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BrokerAuthentication_Delete": { + "$ref": "./examples/BrokerAuthentication_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authorizations": { + "get": { + "operationId": "BrokerAuthorization_ListByResourceGroup", + "tags": [ + "BrokerAuthorization" + ], + "description": "List BrokerAuthorizationResource resources by BrokerResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/BrokerAuthorizationResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BrokerAuthorization_ListByResourceGroup": { + "$ref": "./examples/BrokerAuthorization_ListByResourceGroup_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authorizations/{authorizationName}": { + "get": { + "operationId": "BrokerAuthorization_Get", + "tags": [ + "BrokerAuthorization" + ], + "description": "Get a BrokerAuthorizationResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "authorizationName", + "in": "path", + "description": "Name of Instance broker authorization resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/BrokerAuthorizationResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BrokerAuthorization_Get": { + "$ref": "./examples/BrokerAuthorization_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "BrokerAuthorization_CreateOrUpdate", + "tags": [ + "BrokerAuthorization" + ], + "description": "Create a BrokerAuthorizationResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "authorizationName", + "in": "path", + "description": "Name of Instance broker authorization resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/BrokerAuthorizationResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'BrokerAuthorizationResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/BrokerAuthorizationResource" + } + }, + "201": { + "description": "Resource 'BrokerAuthorizationResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/BrokerAuthorizationResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BrokerAuthorization_CreateOrUpdate": { + "$ref": "./examples/BrokerAuthorization_CreateOrUpdate_MaximumSet_Gen.json" + }, + "BrokerAuthorization_CreateOrUpdate_Complex": { + "$ref": "./examples/BrokerAuthorization_CreateOrUpdate_Complex.json" + }, + "BrokerAuthorization_CreateOrUpdate_Simple": { + "$ref": "./examples/BrokerAuthorization_CreateOrUpdate_Simple.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "BrokerAuthorization_Delete", + "tags": [ + "BrokerAuthorization" + ], + "description": "Delete a BrokerAuthorizationResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "authorizationName", + "in": "path", + "description": "Name of Instance broker authorization resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BrokerAuthorization_Delete": { + "$ref": "./examples/BrokerAuthorization_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/listeners": { + "get": { + "operationId": "BrokerListener_ListByResourceGroup", + "tags": [ + "BrokerListener" + ], + "description": "List BrokerListenerResource resources by BrokerResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/BrokerListenerResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BrokerListener_ListByResourceGroup": { + "$ref": "./examples/BrokerListener_ListByResourceGroup_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/listeners/{listenerName}": { + "get": { + "operationId": "BrokerListener_Get", + "tags": [ + "BrokerListener" + ], + "description": "Get a BrokerListenerResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "listenerName", + "in": "path", + "description": "Name of Instance broker listener resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/BrokerListenerResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BrokerListener_Get": { + "$ref": "./examples/BrokerListener_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "BrokerListener_CreateOrUpdate", + "tags": [ + "BrokerListener" + ], + "description": "Create a BrokerListenerResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "listenerName", + "in": "path", + "description": "Name of Instance broker listener resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/BrokerListenerResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'BrokerListenerResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/BrokerListenerResource" + } + }, + "201": { + "description": "Resource 'BrokerListenerResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/BrokerListenerResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BrokerListener_CreateOrUpdate": { + "$ref": "./examples/BrokerListener_CreateOrUpdate_MaximumSet_Gen.json" + }, + "BrokerListener_CreateOrUpdate_Complex": { + "$ref": "./examples/BrokerListener_CreateOrUpdate_Complex.json" + }, + "BrokerListener_CreateOrUpdate_Simple": { + "$ref": "./examples/BrokerListener_CreateOrUpdate_Simple.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "BrokerListener_Delete", + "tags": [ + "BrokerListener" + ], + "description": "Delete a BrokerListenerResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "listenerName", + "in": "path", + "description": "Name of Instance broker listener resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BrokerListener_Delete": { + "$ref": "./examples/BrokerListener_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/dataflowEndpoints": { + "get": { + "operationId": "DataflowEndpoint_ListByResourceGroup", + "tags": [ + "DataflowEndpoint" + ], + "description": "List DataflowEndpointResource resources by InstanceResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DataflowEndpointResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DataflowEndpoint_ListByResourceGroup": { + "$ref": "./examples/DataflowEndpoint_ListByResourceGroup_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/dataflowEndpoints/{dataflowEndpointName}": { + "get": { + "operationId": "DataflowEndpoint_Get", + "tags": [ + "DataflowEndpoint" + ], + "description": "Get a DataflowEndpointResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "dataflowEndpointName", + "in": "path", + "description": "Name of Instance dataflowEndpoint resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DataflowEndpointResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DataflowEndpoint_Get": { + "$ref": "./examples/DataflowEndpoint_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "DataflowEndpoint_CreateOrUpdate", + "tags": [ + "DataflowEndpoint" + ], + "description": "Create a DataflowEndpointResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "dataflowEndpointName", + "in": "path", + "description": "Name of Instance dataflowEndpoint resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DataflowEndpointResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'DataflowEndpointResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/DataflowEndpointResource" + } + }, + "201": { + "description": "Resource 'DataflowEndpointResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/DataflowEndpointResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DataflowEndpoint_CreateOrUpdate": { + "$ref": "./examples/DataflowEndpoint_CreateOrUpdate_MaximumSet_Gen.json" + }, + "DataflowEndpoint_CreateOrUpdate_ADLSv2": { + "$ref": "./examples/DataflowEndpoint_CreateOrUpdate_ADLSv2.json" + }, + "DataflowEndpoint_CreateOrUpdate_ADX": { + "$ref": "./examples/DataflowEndpoint_CreateOrUpdate_ADX.json" + }, + "DataflowEndpoint_CreateOrUpdate_AIO": { + "$ref": "./examples/DataflowEndpoint_CreateOrUpdate_AIO.json" + }, + "DataflowEndpoint_CreateOrUpdate_EventGrid": { + "$ref": "./examples/DataflowEndpoint_CreateOrUpdate_EventGrid.json" + }, + "DataflowEndpoint_CreateOrUpdate_EventHub": { + "$ref": "./examples/DataflowEndpoint_CreateOrUpdate_EventHub.json" + }, + "DataflowEndpoint_CreateOrUpdate_Fabric": { + "$ref": "./examples/DataflowEndpoint_CreateOrUpdate_Fabric.json" + }, + "DataflowEndpoint_CreateOrUpdate_Kafka": { + "$ref": "./examples/DataflowEndpoint_CreateOrUpdate_Kafka.json" + }, + "DataflowEndpoint_CreateOrUpdate_LocalStorage": { + "$ref": "./examples/DataflowEndpoint_CreateOrUpdate_LocalStorage.json" + }, + "DataflowEndpoint_CreateOrUpdate_MQTT": { + "$ref": "./examples/DataflowEndpoint_CreateOrUpdate_MQTT.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "DataflowEndpoint_Delete", + "tags": [ + "DataflowEndpoint" + ], + "description": "Delete a DataflowEndpointResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "dataflowEndpointName", + "in": "path", + "description": "Name of Instance dataflowEndpoint resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DataflowEndpoint_Delete": { + "$ref": "./examples/DataflowEndpoint_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/dataflowProfiles": { + "get": { + "operationId": "DataflowProfile_ListByResourceGroup", + "tags": [ + "DataflowProfile" + ], + "description": "List DataflowProfileResource resources by InstanceResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DataflowProfileResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DataflowProfile_ListByResourceGroup": { + "$ref": "./examples/DataflowProfile_ListByResourceGroup_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/dataflowProfiles/{dataflowProfileName}": { + "get": { + "operationId": "DataflowProfile_Get", + "tags": [ + "DataflowProfile" + ], + "description": "Get a DataflowProfileResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "dataflowProfileName", + "in": "path", + "description": "Name of Instance dataflowProfile resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DataflowProfileResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DataflowProfile_Get": { + "$ref": "./examples/DataflowProfile_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "DataflowProfile_CreateOrUpdate", + "tags": [ + "DataflowProfile" + ], + "description": "Create a DataflowProfileResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "dataflowProfileName", + "in": "path", + "description": "Name of Instance dataflowProfile resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DataflowProfileResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'DataflowProfileResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/DataflowProfileResource" + } + }, + "201": { + "description": "Resource 'DataflowProfileResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/DataflowProfileResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DataflowProfile_CreateOrUpdate": { + "$ref": "./examples/DataflowProfile_CreateOrUpdate_MaximumSet_Gen.json" + }, + "DataflowProfile_CreateOrUpdate_Minimal": { + "$ref": "./examples/DataflowProfile_CreateOrUpdate_Minimal.json" + }, + "DataflowProfile_CreateOrUpdate_Multi": { + "$ref": "./examples/DataflowProfile_CreateOrUpdate_Multi.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "DataflowProfile_Delete", + "tags": [ + "DataflowProfile" + ], + "description": "Delete a DataflowProfileResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "dataflowProfileName", + "in": "path", + "description": "Name of Instance dataflowProfile resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DataflowProfile_Delete": { + "$ref": "./examples/DataflowProfile_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/dataflowProfiles/{dataflowProfileName}/dataflows": { + "get": { + "operationId": "Dataflow_ListByProfileResource", + "tags": [ + "Dataflow" + ], + "description": "List DataflowResource resources by DataflowProfileResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "dataflowProfileName", + "in": "path", + "description": "Name of Instance dataflowProfile resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DataflowResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Dataflow_ListByProfileResource": { + "$ref": "./examples/Dataflow_ListByProfileResource_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/dataflowProfiles/{dataflowProfileName}/dataflows/{dataflowName}": { + "get": { + "operationId": "Dataflow_Get", + "tags": [ + "Dataflow" + ], + "description": "Get a DataflowResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "dataflowProfileName", + "in": "path", + "description": "Name of Instance dataflowProfile resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "dataflowName", + "in": "path", + "description": "Name of Instance dataflowProfile dataflow resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DataflowResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Dataflow_Get": { + "$ref": "./examples/Dataflow_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "Dataflow_CreateOrUpdate", + "tags": [ + "Dataflow" + ], + "description": "Create a DataflowResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "dataflowProfileName", + "in": "path", + "description": "Name of Instance dataflowProfile resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "dataflowName", + "in": "path", + "description": "Name of Instance dataflowProfile dataflow resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DataflowResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'DataflowResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/DataflowResource" + } + }, + "201": { + "description": "Resource 'DataflowResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/DataflowResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Dataflow_CreateOrUpdate": { + "$ref": "./examples/Dataflow_CreateOrUpdate_MaximumSet_Gen.json" + }, + "Dataflow_CreateOrUpdate_ComplexContextualization": { + "$ref": "./examples/Dataflow_CreateOrUpdate_ComplexContextualization.json" + }, + "Dataflow_CreateOrUpdate_ComplexEventHub": { + "$ref": "./examples/Dataflow_CreateOrUpdate_ComplexEventHub.json" + }, + "Dataflow_CreateOrUpdate_FilterToTopic": { + "$ref": "./examples/Dataflow_CreateOrUpdate_FilterToTopic.json" + }, + "Dataflow_CreateOrUpdate_SimpleEventGrid": { + "$ref": "./examples/Dataflow_CreateOrUpdate_SimpleEventGrid.json" + }, + "Dataflow_CreateOrUpdate_SimpleFabric": { + "$ref": "./examples/Dataflow_CreateOrUpdate_SimpleFabric.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Dataflow_Delete", + "tags": [ + "Dataflow" + ], + "description": "Delete a DataflowResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "dataflowProfileName", + "in": "path", + "description": "Name of Instance dataflowProfile resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "dataflowName", + "in": "path", + "description": "Name of Instance dataflowProfile dataflow resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Dataflow_Delete": { + "$ref": "./examples/Dataflow_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AccessTokenMethod": { + "type": "string", + "description": "Access Token Method", + "enum": [ + "AccessToken" + ], + "x-ms-enum": { + "name": "AccessTokenMethod", + "modelAsString": true, + "values": [ + { + "name": "AccessToken", + "value": "AccessToken", + "description": "AccessToken Option" + } + ] + } + }, + "AdvancedSettings": { + "type": "object", + "description": "Broker Advanced Settings", + "properties": { + "clients": { + "$ref": "#/definitions/ClientConfig", + "description": "Configurations related to All Clients." + }, + "encryptInternalTraffic": { + "type": "string", + "description": "The setting to enable or disable encryption of internal Traffic.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "OperationalMode", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled is equivalent to True" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled is equivalent to False." + } + ] + } + }, + "internalCerts": { + "$ref": "#/definitions/CertManagerCertOptions", + "description": "Certificate rotation and private key configuration." + } + } + }, + "AnonymousMethod": { + "type": "string", + "description": "x509 Certificate Method", + "enum": [ + "Anonymous" + ], + "x-ms-enum": { + "name": "AnonymousMethod", + "modelAsString": true, + "values": [ + { + "name": "Anonymous", + "value": "Anonymous", + "description": "Anonymous Option" + } + ] + } + }, + "AuthorizationConfig": { + "type": "object", + "description": "Broker AuthorizationConfig properties", + "properties": { + "cache": { + "type": "string", + "description": "Enable caching of the authorization rules.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "OperationalMode", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled is equivalent to True" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled is equivalent to False." + } + ] + } + }, + "rules": { + "type": "array", + "description": "The authorization rules to follow. If no rule is set, but Authorization Resource is used that would mean DenyAll.", + "items": { + "$ref": "#/definitions/AuthorizationRule" + }, + "x-ms-identifiers": [] + } + } + }, + "AuthorizationRule": { + "type": "object", + "description": "AuthorizationConfig Rule Properties", + "properties": { + "brokerResources": { + "type": "array", + "description": "Give access to Broker methods and topics.", + "items": { + "$ref": "#/definitions/BrokerResourceRule" + }, + "x-ms-identifiers": [] + }, + "principals": { + "$ref": "#/definitions/PrincipalDefinition", + "description": "Give access to clients based on the following properties." + }, + "stateStoreResources": { + "type": "array", + "description": "Give access to state store resources.", + "items": { + "$ref": "#/definitions/StateStoreResourceRule" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "brokerResources", + "principals" + ] + }, + "BackendChain": { + "type": "object", + "description": "Desired properties of the backend instances of the broker", + "properties": { + "partitions": { + "type": "integer", + "format": "int32", + "description": "The desired number of physical backend partitions.", + "minimum": 1, + "maximum": 16 + }, + "redundancyFactor": { + "type": "integer", + "format": "int32", + "description": "The desired numbers of backend replicas (pods) in a physical partition.", + "minimum": 1, + "maximum": 5 + }, + "workers": { + "type": "integer", + "format": "int32", + "description": "Number of logical backend workers per replica (pod).", + "default": 1, + "minimum": 1, + "maximum": 16 + } + }, + "required": [ + "partitions", + "redundancyFactor" + ] + }, + "BatchingConfiguration": { + "type": "object", + "description": "Batching configuration", + "properties": { + "latencySeconds": { + "type": "integer", + "format": "int32", + "description": "Batching latency in seconds.", + "default": 60, + "minimum": 0, + "maximum": 65535 + }, + "maxMessages": { + "type": "integer", + "format": "int32", + "description": "Maximum number of messages in a batch.", + "default": 100000, + "minimum": 0, + "maximum": 4294967295 + } + } + }, + "BrokerAuthenticationMethod": { + "type": "string", + "description": "Broker Authentication Mode", + "enum": [ + "Custom", + "ServiceAccountToken", + "X509" + ], + "x-ms-enum": { + "name": "BrokerAuthenticationMethod", + "modelAsString": true, + "values": [ + { + "name": "Custom", + "value": "Custom", + "description": "Custom authentication configuration." + }, + { + "name": "ServiceAccountToken", + "value": "ServiceAccountToken", + "description": "ServiceAccountToken authentication configuration." + }, + { + "name": "X509", + "value": "X509", + "description": "X.509 authentication configuration." + } + ] + } + }, + "BrokerAuthenticationProperties": { + "type": "object", + "description": "BrokerAuthentication Resource properties", + "properties": { + "authenticationMethods": { + "type": "array", + "description": "Defines a set of Broker authentication methods to be used on `BrokerListeners`. For each array element one authenticator type supported.", + "items": { + "$ref": "#/definitions/BrokerAuthenticatorMethods" + }, + "x-ms-identifiers": [] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + }, + "required": [ + "authenticationMethods" + ] + }, + "BrokerAuthenticationResource": { + "type": "object", + "description": "Instance broker authentication resource", + "properties": { + "properties": { + "$ref": "#/definitions/BrokerAuthenticationProperties", + "description": "The resource-specific properties for this resource." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "Edge location of the resource.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "extendedLocation" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "BrokerAuthenticationResourceListResult": { + "type": "object", + "description": "The response of a BrokerAuthenticationResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The BrokerAuthenticationResource items on this page", + "items": { + "$ref": "#/definitions/BrokerAuthenticationResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "BrokerAuthenticatorCustomAuth": { + "type": "object", + "description": "Custom Authentication properties", + "properties": { + "x509": { + "$ref": "#/definitions/X509ManualCertificate", + "description": "X509 Custom Auth type details." + } + }, + "required": [ + "x509" + ] + }, + "BrokerAuthenticatorMethodCustom": { + "type": "object", + "description": "Custom method for BrokerAuthentication", + "properties": { + "auth": { + "$ref": "#/definitions/BrokerAuthenticatorCustomAuth", + "description": "Optional authentication needed for authenticating with the custom authentication server." + }, + "caCertConfigMap": { + "type": "string", + "description": "Optional CA certificate for validating the custom authentication server's certificate." + }, + "endpoint": { + "type": "string", + "format": "uri", + "description": "Endpoint of the custom authentication server. Must be an HTTPS endpoint.", + "pattern": "^https://.*$" + }, + "headers": { + "type": "object", + "description": "Additional HTTP headers to pass to the custom authentication server.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "endpoint" + ] + }, + "BrokerAuthenticatorMethodSat": { + "type": "object", + "description": "Service Account Token for BrokerAuthentication", + "properties": { + "audiences": { + "type": "array", + "description": "List of allowed audience.", + "items": { + "type": "string" + } + } + }, + "required": [ + "audiences" + ] + }, + "BrokerAuthenticatorMethodX509": { + "type": "object", + "description": "X509 for BrokerAuthentication.", + "properties": { + "authorizationAttributes": { + "type": "object", + "description": "X509 authorization attributes properties.", + "additionalProperties": { + "$ref": "#/definitions/BrokerAuthenticatorMethodX509Attributes" + } + }, + "trustedClientCaCert": { + "type": "string", + "description": "Name of the trusted client ca cert resource.", + "default": "client-ca" + } + } + }, + "BrokerAuthenticatorMethodX509Attributes": { + "type": "object", + "description": "BrokerAuthenticatorMethodX509Attributes properties.", + "properties": { + "attributes": { + "type": "object", + "description": "Attributes object.", + "additionalProperties": { + "type": "string" + } + }, + "subject": { + "type": "string", + "description": "Subject of the X509 attribute." + } + }, + "required": [ + "attributes", + "subject" + ] + }, + "BrokerAuthenticatorMethods": { + "type": "object", + "description": "Set of broker authentication policies. Only one method is supported for each entry.", + "properties": { + "method": { + "$ref": "#/definitions/BrokerAuthenticationMethod", + "description": "Custom authentication configuration." + }, + "customSettings": { + "$ref": "#/definitions/BrokerAuthenticatorMethodCustom", + "description": "Custom authentication configuration." + }, + "serviceAccountTokenSettings": { + "$ref": "#/definitions/BrokerAuthenticatorMethodSat", + "description": "ServiceAccountToken authentication configuration." + }, + "x509Settings": { + "$ref": "#/definitions/BrokerAuthenticatorMethodX509", + "description": "X.509 authentication configuration." + } + }, + "required": [ + "method" + ] + }, + "BrokerAuthorizationProperties": { + "type": "object", + "description": "BrokerAuthorization Resource properties", + "properties": { + "authorizationPolicies": { + "$ref": "#/definitions/AuthorizationConfig", + "description": "The list of authorization policies supported by the Authorization Resource." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + }, + "required": [ + "authorizationPolicies" + ] + }, + "BrokerAuthorizationResource": { + "type": "object", + "description": "Instance broker authorizations resource", + "properties": { + "properties": { + "$ref": "#/definitions/BrokerAuthorizationProperties", + "description": "The resource-specific properties for this resource." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "Edge location of the resource.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "extendedLocation" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "BrokerAuthorizationResourceListResult": { + "type": "object", + "description": "The response of a BrokerAuthorizationResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The BrokerAuthorizationResource items on this page", + "items": { + "$ref": "#/definitions/BrokerAuthorizationResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "BrokerDiagnostics": { + "type": "object", + "description": "Broker Diagnostic Setting properties", + "properties": { + "logs": { + "$ref": "#/definitions/DiagnosticsLogs", + "description": "Diagnostic log settings for the resource." + }, + "metrics": { + "$ref": "#/definitions/Metrics", + "description": "The metrics settings for the resource." + }, + "selfCheck": { + "$ref": "#/definitions/SelfCheck", + "description": "The self check properties." + }, + "traces": { + "$ref": "#/definitions/Traces", + "description": "The trace properties." + } + } + }, + "BrokerListenerProperties": { + "type": "object", + "description": "Defines a Broker listener. A listener is a collection of ports on which the broker accepts connections from clients.", + "properties": { + "serviceName": { + "type": "string", + "description": "Kubernetes Service name of this listener." + }, + "ports": { + "type": "array", + "description": "Ports on which this listener accepts client connections.", + "items": { + "$ref": "#/definitions/ListenerPort" + }, + "x-ms-identifiers": [ + "port" + ] + }, + "serviceType": { + "type": "string", + "description": "Kubernetes Service type of this listener.", + "default": "ClusterIp", + "enum": [ + "ClusterIp", + "LoadBalancer", + "NodePort" + ], + "x-ms-enum": { + "name": "ServiceType", + "modelAsString": true, + "values": [ + { + "name": "ClusterIp", + "value": "ClusterIp", + "description": "Cluster IP Service." + }, + { + "name": "LoadBalancer", + "value": "LoadBalancer", + "description": "Load Balancer Service." + }, + { + "name": "NodePort", + "value": "NodePort", + "description": "Node Port Service." + } + ] + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + }, + "required": [ + "ports" + ] + }, + "BrokerListenerResource": { + "type": "object", + "description": "Instance broker resource", + "properties": { + "properties": { + "$ref": "#/definitions/BrokerListenerProperties", + "description": "The resource-specific properties for this resource." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "Edge location of the resource.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "extendedLocation" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "BrokerListenerResourceListResult": { + "type": "object", + "description": "The response of a BrokerListenerResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The BrokerListenerResource items on this page", + "items": { + "$ref": "#/definitions/BrokerListenerResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "BrokerMemoryProfile": { + "type": "string", + "description": "The memory profile settings of the Broker", + "enum": [ + "Tiny", + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "BrokerMemoryProfile", + "modelAsString": true, + "values": [ + { + "name": "Tiny", + "value": "Tiny", + "description": "Tiny memory profile." + }, + { + "name": "Low", + "value": "Low", + "description": "Low memory profile." + }, + { + "name": "Medium", + "value": "Medium", + "description": "Medium memory profile." + }, + { + "name": "High", + "value": "High", + "description": "High memory profile." + } + ] + } + }, + "BrokerProperties": { + "type": "object", + "description": "Broker Resource properties", + "properties": { + "advanced": { + "$ref": "#/definitions/AdvancedSettings", + "description": "Advanced settings of Broker.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cardinality": { + "$ref": "#/definitions/Cardinality", + "description": "The cardinality details of the broker.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "diagnostics": { + "$ref": "#/definitions/BrokerDiagnostics", + "description": "Spec defines the desired identities of Broker diagnostics settings." + }, + "diskBackedMessageBuffer": { + "$ref": "#/definitions/DiskBackedMessageBuffer", + "description": "Settings of Disk Backed Message Buffer.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "generateResourceLimits": { + "$ref": "#/definitions/GenerateResourceLimits", + "description": "This setting controls whether Kubernetes CPU resource limits are requested. Increasing the number of replicas or workers proportionally increases the amount of CPU resources requested. If this setting is enabled and there are insufficient CPU resources, an error will be emitted.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "memoryProfile": { + "type": "string", + "description": "Memory profile of Broker.", + "default": "Medium", + "enum": [ + "Tiny", + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "BrokerMemoryProfile", + "modelAsString": true, + "values": [ + { + "name": "Tiny", + "value": "Tiny", + "description": "Tiny memory profile." + }, + { + "name": "Low", + "value": "Low", + "description": "Low memory profile." + }, + { + "name": "Medium", + "value": "Medium", + "description": "Medium memory profile." + }, + { + "name": "High", + "value": "High", + "description": "High memory profile." + } + ] + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "BrokerProtocolType": { + "type": "string", + "description": "Broker Protocol types", + "enum": [ + "Mqtt", + "WebSockets" + ], + "x-ms-enum": { + "name": "BrokerProtocolType", + "modelAsString": true, + "values": [ + { + "name": "Mqtt", + "value": "Mqtt", + "description": "protocol broker" + }, + { + "name": "WebSockets", + "value": "WebSockets", + "description": "protocol websocket" + } + ] + } + }, + "BrokerResource": { + "type": "object", + "description": "Instance broker resource", + "properties": { + "properties": { + "$ref": "#/definitions/BrokerProperties", + "description": "The resource-specific properties for this resource." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "Edge location of the resource.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "extendedLocation" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "BrokerResourceDefinitionMethods": { + "type": "string", + "description": "BrokerResourceDefinitionMethods methods allowed", + "enum": [ + "Connect", + "Publish", + "Subscribe" + ], + "x-ms-enum": { + "name": "BrokerResourceDefinitionMethods", + "modelAsString": true, + "values": [ + { + "name": "Connect", + "value": "Connect", + "description": "Allowed Connecting to Broker" + }, + { + "name": "Publish", + "value": "Publish", + "description": "Allowed Publishing to Broker" + }, + { + "name": "Subscribe", + "value": "Subscribe", + "description": "Allowed Subscribing to Broker" + } + ] + } + }, + "BrokerResourceListResult": { + "type": "object", + "description": "The response of a BrokerResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The BrokerResource items on this page", + "items": { + "$ref": "#/definitions/BrokerResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "BrokerResourceRule": { + "type": "object", + "description": "Broker Resource Rule properties. This defines the objects that represent the actions or topics, such as - method.Connect, method.Publish, etc.", + "properties": { + "method": { + "$ref": "#/definitions/BrokerResourceDefinitionMethods", + "description": "Give access for a Broker method (i.e., Connect, Subscribe, or Publish)." + }, + "clientIds": { + "type": "array", + "description": "A list of client IDs that match the clients. The client IDs are case-sensitive and must match the client IDs provided by the clients during connection. This subfield may be set if the method is Connect.", + "default": [], + "items": { + "type": "string" + } + }, + "topics": { + "type": "array", + "description": "A list of topics or topic patterns that match the topics that the clients can publish or subscribe to. This subfield is required if the method is Publish or Subscribe.", + "default": [], + "items": { + "type": "string" + } + } + }, + "required": [ + "method" + ] + }, + "Cardinality": { + "type": "object", + "description": "Cardinality properties", + "properties": { + "backendChain": { + "$ref": "#/definitions/BackendChain", + "description": "The backend broker desired properties" + }, + "frontend": { + "$ref": "#/definitions/Frontend", + "description": "The frontend desired properties" + } + }, + "required": [ + "backendChain", + "frontend" + ] + }, + "CertManagerCertOptions": { + "type": "object", + "description": "Cert Manager Cert properties", + "properties": { + "duration": { + "type": "string", + "description": "Lifetime of certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes." + }, + "renewBefore": { + "type": "string", + "description": "When to begin renewing certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes." + }, + "privateKey": { + "$ref": "#/definitions/CertManagerPrivateKey", + "description": "Configuration of certificate private key." + } + }, + "required": [ + "duration", + "renewBefore", + "privateKey" + ] + }, + "CertManagerCertificateSpec": { + "type": "object", + "description": "Automatic TLS server certificate management with cert-manager", + "properties": { + "duration": { + "type": "string", + "description": "Lifetime of certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes." + }, + "secretName": { + "type": "string", + "description": "Secret for storing server certificate. Any existing data will be overwritten. This is a reference to the secret through an identifying name, not the secret itself." + }, + "renewBefore": { + "type": "string", + "description": "When to begin renewing certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes." + }, + "issuerRef": { + "$ref": "#/definitions/CertManagerIssuerRef", + "description": "cert-manager issuerRef." + }, + "privateKey": { + "$ref": "#/definitions/CertManagerPrivateKey", + "description": "Type of certificate private key." + }, + "san": { + "$ref": "#/definitions/SanForCert", + "description": "Additional Subject Alternative Names (SANs) to include in the certificate." + } + }, + "required": [ + "issuerRef" + ] + }, + "CertManagerIssuerKind": { + "type": "string", + "description": "CertManagerIssuerKind properties", + "enum": [ + "Issuer", + "ClusterIssuer" + ], + "x-ms-enum": { + "name": "CertManagerIssuerKind", + "modelAsString": true, + "values": [ + { + "name": "Issuer", + "value": "Issuer", + "description": "Issuer kind." + }, + { + "name": "ClusterIssuer", + "value": "ClusterIssuer", + "description": "ClusterIssuer kind." + } + ] + } + }, + "CertManagerIssuerRef": { + "type": "object", + "description": "Cert-Manager issuerRef properties", + "properties": { + "group": { + "type": "string", + "description": "group of issuer.", + "default": "cert-manager.io" + }, + "kind": { + "$ref": "#/definitions/CertManagerIssuerKind", + "description": "kind of issuer (Issuer or ClusterIssuer)." + }, + "name": { + "type": "string", + "description": "name of issuer." + } + }, + "required": [ + "group", + "kind", + "name" + ] + }, + "CertManagerPrivateKey": { + "type": "object", + "description": "Cert Manager private key properties", + "properties": { + "algorithm": { + "$ref": "#/definitions/PrivateKeyAlgorithm", + "description": "algorithm for private key." + }, + "rotationPolicy": { + "$ref": "#/definitions/PrivateKeyRotationPolicy", + "description": "cert-manager private key rotationPolicy." + } + }, + "required": [ + "algorithm", + "rotationPolicy" + ] + }, + "ClientConfig": { + "type": "object", + "description": "The settings of Client Config.", + "properties": { + "maxSessionExpirySeconds": { + "type": "integer", + "format": "int32", + "description": "Upper bound of Session Expiry Interval, in seconds.", + "minimum": 1, + "maximum": 4294967295 + }, + "maxMessageExpirySeconds": { + "type": "integer", + "format": "int32", + "description": "Upper bound of Message Expiry Interval, in seconds.", + "minimum": 1, + "maximum": 4294967295 + }, + "maxPacketSizeBytes": { + "type": "integer", + "format": "int32", + "description": "Max message size for a packet in Bytes.", + "minimum": 1, + "maximum": 268435456 + }, + "subscriberQueueLimit": { + "$ref": "#/definitions/SubscriberQueueLimit", + "description": "The limit on the number of queued messages for a subscriber." + }, + "maxReceiveMaximum": { + "type": "integer", + "format": "int32", + "description": "Upper bound of Receive Maximum that a client can request in the CONNECT packet.", + "minimum": 1, + "maximum": 65535 + }, + "maxKeepAliveSeconds": { + "type": "integer", + "format": "int32", + "description": "Upper bound of a client's Keep Alive, in seconds.", + "minimum": 0, + "maximum": 65535 + } + } + }, + "CloudEventAttributeType": { + "type": "string", + "description": "How to map events to the cloud.", + "enum": [ + "Propagate", + "CreateOrRemap" + ], + "x-ms-enum": { + "name": "CloudEventAttributeType", + "modelAsString": true, + "values": [ + { + "name": "Propagate", + "value": "Propagate", + "description": "Propagate type" + }, + { + "name": "CreateOrRemap", + "value": "CreateOrRemap", + "description": "CreateOrRemap type" + } + ] + } + }, + "DataExplorerAuthMethod": { + "$ref": "#/definitions/ManagedIdentityMethod", + "x-nullable": false + }, + "DataLakeStorageAuthMethod": { + "type": "string", + "description": "DataflowEndpoint Data Lake Storage Authentication Method properties", + "enum": [ + "SystemAssignedManagedIdentity", + "UserAssignedManagedIdentity", + "AccessToken" + ], + "x-ms-enum": { + "name": "DataLakeStorageAuthMethod", + "modelAsString": true, + "values": [ + { + "name": "SystemAssignedManagedIdentity", + "value": "SystemAssignedManagedIdentity", + "description": "SystemAssignedManagedIdentity type" + }, + { + "name": "UserAssignedManagedIdentity", + "value": "UserAssignedManagedIdentity", + "description": "UserAssignedManagedIdentity type" + }, + { + "name": "AccessToken", + "value": "AccessToken", + "description": "AccessToken Option" + } + ] + } + }, + "DataflowBuiltInTransformationDataset": { + "type": "object", + "description": "Dataflow BuiltIn Transformation dataset properties", + "properties": { + "key": { + "type": "string", + "description": "The key of the dataset.", + "maxLength": 64 + }, + "description": { + "type": "string", + "description": "A user provided optional description of the dataset.", + "maxLength": 256 + }, + "schemaRef": { + "type": "string", + "description": "The reference to the schema that describes the dataset. Allowed: JSON Schema/draft-7." + }, + "inputs": { + "type": "array", + "description": "List of fields for enriching from the Broker State Store.", + "items": { + "type": "string" + } + }, + "expression": { + "type": "string", + "description": "Condition to enrich data from Broker State Store. Example: $1 < 0 || $1 > $2 (Assuming inputs section $1 and $2 are provided)" + } + }, + "required": [ + "key", + "inputs" + ] + }, + "DataflowBuiltInTransformationFilter": { + "type": "object", + "description": "Dataflow BuiltIn Transformation filter properties", + "properties": { + "type": { + "type": "string", + "description": "The type of dataflow operation.", + "default": "Filter", + "enum": [ + "Filter" + ], + "x-ms-enum": { + "name": "FilterType", + "modelAsString": true, + "values": [ + { + "name": "Filter", + "value": "Filter", + "description": "Filter type" + } + ] + } + }, + "description": { + "type": "string", + "description": "A user provided optional description of the filter.", + "maxLength": 256 + }, + "inputs": { + "type": "array", + "description": "List of fields for filtering in JSON path expression.", + "items": { + "type": "string" + } + }, + "expression": { + "type": "string", + "description": "Condition to filter data. Can reference input fields with {n} where n is the index of the input field starting from 1. Example: $1 < 0 || $1 > $2 (Assuming inputs section $1 and $2 are provided)" + } + }, + "required": [ + "inputs", + "expression" + ] + }, + "DataflowBuiltInTransformationMap": { + "type": "object", + "description": "Dataflow BuiltIn Transformation map properties", + "properties": { + "type": { + "$ref": "#/definitions/DataflowMappingType", + "description": "Type of transformation." + }, + "description": { + "type": "string", + "description": "A user provided optional description of the mapping function.", + "maxLength": 256 + }, + "inputs": { + "type": "array", + "description": "List of fields for mapping in JSON path expression.", + "items": { + "type": "string" + } + }, + "expression": { + "type": "string", + "description": "Modify the inputs field(s) to the final output field. Example: $1 * 2.2 (Assuming inputs section $1 is provided)" + }, + "output": { + "type": "string", + "description": "Where and how the input fields to be organized in the output record." + } + }, + "required": [ + "inputs", + "output" + ] + }, + "DataflowBuiltInTransformationSettings": { + "type": "object", + "description": "Dataflow BuiltIn Transformation properties", + "properties": { + "serializationFormat": { + "type": "string", + "description": "Serialization format. Optional; defaults to JSON. Allowed value JSON Schema/draft-7, Parquet. Default: Json", + "default": "Json", + "enum": [ + "Delta", + "Json", + "Parquet" + ], + "x-ms-enum": { + "name": "TransformationSerializationFormat", + "modelAsString": true, + "values": [ + { + "name": "Delta", + "value": "Delta", + "description": "Delta Format" + }, + { + "name": "Json", + "value": "Json", + "description": "JSON Format" + }, + { + "name": "Parquet", + "value": "Parquet", + "description": "Parquet Format" + } + ] + } + }, + "schemaRef": { + "type": "string", + "description": "Reference to the schema that describes the output of the transformation." + }, + "datasets": { + "type": "array", + "description": "Enrich data from Broker State Store. Dataset references a key in Broker State Store.", + "default": [], + "maxItems": 1, + "items": { + "$ref": "#/definitions/DataflowBuiltInTransformationDataset" + }, + "x-ms-identifiers": [] + }, + "filter": { + "type": "array", + "description": "Filters input record or datapoints based on condition.", + "default": [], + "items": { + "$ref": "#/definitions/DataflowBuiltInTransformationFilter" + }, + "x-ms-identifiers": [] + }, + "map": { + "type": "array", + "description": "Maps input to output message.", + "default": [], + "items": { + "$ref": "#/definitions/DataflowBuiltInTransformationMap" + }, + "x-ms-identifiers": [] + } + } + }, + "DataflowDestinationOperationSettings": { + "type": "object", + "description": "Dataflow Destination Operation properties", + "properties": { + "endpointRef": { + "type": "string", + "description": "Reference to the Endpoint CR. Can be of Broker, Kafka, Fabric, ADLS, ADX type." + }, + "dataDestination": { + "$ref": "#/definitions/NonEmptyString", + "description": "Destination location, can be a topic or table name. Supports dynamic values with $topic, $systemProperties, $userProperties, $payload, $context, and $subscription." + } + }, + "required": [ + "endpointRef", + "dataDestination" + ] + }, + "DataflowEndpointAuthenticationAccessToken": { + "type": "object", + "description": "DataflowEndpoint Authentication Access Token properties", + "properties": { + "secretRef": { + "type": "string", + "description": "Token secret name." + } + }, + "required": [ + "secretRef" + ] + }, + "DataflowEndpointAuthenticationSasl": { + "type": "object", + "description": "DataflowEndpoint Authentication Sasl properties", + "properties": { + "saslType": { + "$ref": "#/definitions/DataflowEndpointAuthenticationSaslType", + "description": "Type of SASL authentication. Can be PLAIN, SCRAM-SHA-256, or SCRAM-SHA-512." + }, + "secretRef": { + "type": "string", + "description": "Token secret name." + } + }, + "required": [ + "saslType", + "secretRef" + ] + }, + "DataflowEndpointAuthenticationSaslType": { + "type": "string", + "description": "DataflowEndpoint Authentication Sasl Type properties", + "enum": [ + "Plain", + "ScramSha256", + "ScramSha512" + ], + "x-ms-enum": { + "name": "DataflowEndpointAuthenticationSaslType", + "modelAsString": true, + "values": [ + { + "name": "Plain", + "value": "Plain", + "description": "PLAIN Type" + }, + { + "name": "ScramSha256", + "value": "ScramSha256", + "description": "SCRAM_SHA_256 Type" + }, + { + "name": "ScramSha512", + "value": "ScramSha512", + "description": "SCRAM_SHA_512 Type" + } + ] + } + }, + "DataflowEndpointAuthenticationServiceAccountToken": { + "type": "object", + "description": "Service Account Token for BrokerAuthentication", + "properties": { + "audience": { + "type": "string", + "description": "Audience of the service account. Optional, defaults to the broker internal service account audience." + } + }, + "required": [ + "audience" + ] + }, + "DataflowEndpointAuthenticationSystemAssignedManagedIdentity": { + "type": "object", + "description": "DataflowEndpoint Authentication SystemAssignedManagedIdentity properties", + "properties": { + "audience": { + "type": "string", + "description": "Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration." + } + } + }, + "DataflowEndpointAuthenticationUserAssignedManagedIdentity": { + "type": "object", + "description": "DataflowEndpoint Authentication UserAssignedManagedIdentity properties", + "properties": { + "clientId": { + "type": "string", + "description": "Client ID for the user-assigned managed identity." + }, + "scope": { + "type": "string", + "description": "Resource identifier (application ID URI) of the resource, affixed with the .default suffix." + }, + "tenantId": { + "type": "string", + "description": "Tenant ID." + } + }, + "required": [ + "clientId", + "tenantId" + ] + }, + "DataflowEndpointAuthenticationX509": { + "type": "object", + "description": "DataflowEndpoint Authentication X509 properties", + "properties": { + "secretRef": { + "type": "string", + "description": "Secret reference of the X.509 certificate." + } + }, + "required": [ + "secretRef" + ] + }, + "DataflowEndpointDataExplorer": { + "type": "object", + "description": "Azure Data Explorer endpoint properties", + "properties": { + "authentication": { + "$ref": "#/definitions/DataflowEndpointDataExplorerAuthentication", + "description": "Authentication configuration. NOTE - only authentication property is allowed per entry." + }, + "database": { + "type": "string", + "description": "Database name." + }, + "host": { + "type": "string", + "description": "Host of the Azure Data Explorer in the form of <cluster>.<region>.kusto.windows.net .", + "pattern": ".+\\..+\\.kusto\\.windows\\.net" + }, + "batching": { + "$ref": "#/definitions/BatchingConfiguration", + "description": "Azure Data Explorer endpoint batching configuration." + } + }, + "required": [ + "authentication", + "database", + "host" + ] + }, + "DataflowEndpointDataExplorerAuthentication": { + "type": "object", + "description": "Azure Data Explorer Authentication properties. NOTE - only authentication property is allowed per entry.", + "properties": { + "method": { + "$ref": "#/definitions/DataExplorerAuthMethod", + "description": "Mode of Authentication." + }, + "systemAssignedManagedIdentitySettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationSystemAssignedManagedIdentity", + "description": "System-assigned managed identity authentication." + }, + "userAssignedManagedIdentitySettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationUserAssignedManagedIdentity", + "description": "User-assigned managed identity authentication." + } + }, + "required": [ + "method" + ] + }, + "DataflowEndpointDataLakeStorage": { + "type": "object", + "description": "Azure Data Lake endpoint properties", + "properties": { + "authentication": { + "$ref": "#/definitions/DataflowEndpointDataLakeStorageAuthentication", + "description": "Authentication configuration. NOTE - only authentication property is allowed per entry." + }, + "host": { + "type": "string", + "description": "Host of the Azure Data Lake in the form of <account>.blob.core.windows.net .", + "pattern": ".+\\.blob\\.core\\.windows\\.net" + }, + "batching": { + "$ref": "#/definitions/BatchingConfiguration", + "description": "Azure Data Lake endpoint batching configuration." + } + }, + "required": [ + "authentication", + "host" + ] + }, + "DataflowEndpointDataLakeStorageAuthentication": { + "type": "object", + "description": "Azure Data Lake endpoint Authentication properties. NOTE Enum - Only one method is supported for one entry", + "properties": { + "method": { + "$ref": "#/definitions/DataLakeStorageAuthMethod", + "description": "Mode of Authentication." + }, + "accessTokenSettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationAccessToken", + "description": "SAS token authentication." + }, + "systemAssignedManagedIdentitySettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationSystemAssignedManagedIdentity", + "description": "System-assigned managed identity authentication." + }, + "userAssignedManagedIdentitySettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationUserAssignedManagedIdentity", + "description": "User-assigned managed identity authentication." + } + }, + "required": [ + "method" + ] + }, + "DataflowEndpointFabricOneLake": { + "type": "object", + "description": "Microsoft Fabric endpoint properties", + "properties": { + "authentication": { + "$ref": "#/definitions/DataflowEndpointFabricOneLakeAuthentication", + "description": "Authentication configuration. NOTE - only one authentication property is allowed per entry." + }, + "names": { + "$ref": "#/definitions/DataflowEndpointFabricOneLakeNames", + "description": "Names of the workspace and lakehouse." + }, + "oneLakePathType": { + "$ref": "#/definitions/DataflowEndpointFabricPathType", + "description": "Type of location of the data in the workspace. Can be either tables or files." + }, + "host": { + "type": "string", + "description": "Host of the Microsoft Fabric in the form of https://<host>.fabric.microsoft.com.", + "pattern": ".+\\.fabric\\.microsoft\\.com" + }, + "batching": { + "$ref": "#/definitions/BatchingConfiguration", + "description": "Batching configuration." + } + }, + "required": [ + "authentication", + "names", + "oneLakePathType", + "host" + ] + }, + "DataflowEndpointFabricOneLakeAuthentication": { + "type": "object", + "description": "Microsoft Fabric endpoint. Authentication properties. NOTE - Only one method is supported for one entry", + "properties": { + "method": { + "$ref": "#/definitions/FabricOneLakeAuthMethod", + "description": "Mode of Authentication." + }, + "systemAssignedManagedIdentitySettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationSystemAssignedManagedIdentity", + "description": "System-assigned managed identity authentication." + }, + "userAssignedManagedIdentitySettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationUserAssignedManagedIdentity", + "description": "User-assigned managed identity authentication." + } + }, + "required": [ + "method" + ] + }, + "DataflowEndpointFabricOneLakeNames": { + "type": "object", + "description": "Microsoft Fabric endpoint Names properties", + "properties": { + "lakehouseName": { + "type": "string", + "description": "Lakehouse name." + }, + "workspaceName": { + "type": "string", + "description": "Workspace name." + } + }, + "required": [ + "lakehouseName", + "workspaceName" + ] + }, + "DataflowEndpointFabricPathType": { + "type": "string", + "description": "DataflowEndpoint Fabric Path Type properties", + "enum": [ + "Files", + "Tables" + ], + "x-ms-enum": { + "name": "DataflowEndpointFabricPathType", + "modelAsString": true, + "values": [ + { + "name": "Files", + "value": "Files", + "description": "FILES Type" + }, + { + "name": "Tables", + "value": "Tables", + "description": "TABLES Type" + } + ] + } + }, + "DataflowEndpointKafka": { + "type": "object", + "description": "Kafka endpoint properties", + "properties": { + "authentication": { + "$ref": "#/definitions/DataflowEndpointKafkaAuthentication", + "description": "Authentication configuration. NOTE - only authentication property is allowed per entry." + }, + "consumerGroupId": { + "type": "string", + "description": "Consumer group ID." + }, + "host": { + "type": "string", + "description": "Kafka endpoint host." + }, + "batching": { + "$ref": "#/definitions/DataflowEndpointKafkaBatching", + "description": "Batching configuration." + }, + "copyMqttProperties": { + "type": "string", + "description": "Copy Broker properties. No effect if the endpoint is used as a source or if the dataflow doesn't have an Broker source.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "OperationalMode", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled is equivalent to True" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled is equivalent to False." + } + ] + } + }, + "compression": { + "type": "string", + "description": "Compression. Can be none, gzip, lz4, or snappy. No effect if the endpoint is used as a source.", + "default": "None", + "enum": [ + "None", + "Gzip", + "Snappy", + "Lz4" + ], + "x-ms-enum": { + "name": "DataflowEndpointKafkaCompression", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "NONE Option" + }, + { + "name": "Gzip", + "value": "Gzip", + "description": "Gzip Option" + }, + { + "name": "Snappy", + "value": "Snappy", + "description": "SNAPPY Option" + }, + { + "name": "Lz4", + "value": "Lz4", + "description": "LZ4 Option" + } + ] + } + }, + "kafkaAcks": { + "type": "string", + "description": "Kafka acks. Can be all, one, or zero. No effect if the endpoint is used as a source.", + "default": "All", + "enum": [ + "Zero", + "One", + "All" + ], + "x-ms-enum": { + "name": "DataflowEndpointKafkaAcks", + "modelAsString": true, + "values": [ + { + "name": "Zero", + "value": "Zero", + "description": "ZERO Option" + }, + { + "name": "One", + "value": "One", + "description": "ONE Option" + }, + { + "name": "All", + "value": "All", + "description": "ALL Option" + } + ] + } + }, + "partitionStrategy": { + "type": "string", + "description": "Partition handling strategy. Can be default or static. No effect if the endpoint is used as a source.", + "default": "Default", + "enum": [ + "Default", + "Static", + "Topic", + "Property" + ], + "x-ms-enum": { + "name": "DataflowEndpointKafkaPartitionStrategy", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "Default: Assigns messages to random partitions, using a round-robin algorithm." + }, + { + "name": "Static", + "value": "Static", + "description": "Static: Assigns messages to a fixed partition number that's derived from the instance ID of the dataflow." + }, + { + "name": "Topic", + "value": "Topic", + "description": "TOPIC Option" + }, + { + "name": "Property", + "value": "Property", + "description": "PROPERTY Option" + } + ] + } + }, + "tls": { + "$ref": "#/definitions/TlsProperties", + "description": "TLS configuration." + }, + "cloudEventAttributes": { + "$ref": "#/definitions/CloudEventAttributeType", + "description": "Cloud event mapping config." + } + }, + "required": [ + "authentication", + "host" + ] + }, + "DataflowEndpointKafkaAcks": { + "type": "string", + "description": "DataflowEndpoint Kafka Acks properties", + "enum": [ + "Zero", + "One", + "All" + ], + "x-ms-enum": { + "name": "DataflowEndpointKafkaAcks", + "modelAsString": true, + "values": [ + { + "name": "Zero", + "value": "Zero", + "description": "ZERO Option" + }, + { + "name": "One", + "value": "One", + "description": "ONE Option" + }, + { + "name": "All", + "value": "All", + "description": "ALL Option" + } + ] + } + }, + "DataflowEndpointKafkaAuthentication": { + "type": "object", + "description": "Kafka endpoint Authentication properties. NOTE - only authentication property is allowed per entry", + "properties": { + "method": { + "$ref": "#/definitions/KafkaAuthMethod", + "description": "Mode of Authentication." + }, + "systemAssignedManagedIdentitySettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationSystemAssignedManagedIdentity", + "description": "System-assigned managed identity authentication." + }, + "userAssignedManagedIdentitySettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationUserAssignedManagedIdentity", + "description": "User-assigned managed identity authentication." + }, + "saslSettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationSasl", + "description": "SASL authentication." + }, + "x509CertificateSettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationX509", + "description": "X.509 certificate authentication." + } + }, + "required": [ + "method" + ] + }, + "DataflowEndpointKafkaBatching": { + "type": "object", + "description": "Kafka endpoint Batching properties", + "properties": { + "mode": { + "type": "string", + "description": "Mode for batching.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "OperationalMode", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled is equivalent to True" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled is equivalent to False." + } + ] + } + }, + "latencyMs": { + "type": "integer", + "format": "int32", + "description": "Batching latency in milliseconds.", + "default": 5, + "minimum": 0, + "maximum": 65535 + }, + "maxBytes": { + "type": "integer", + "format": "int32", + "description": "Maximum number of bytes in a batch.", + "default": 1000000, + "minimum": 0, + "maximum": 4294967295 + }, + "maxMessages": { + "type": "integer", + "format": "int32", + "description": "Maximum number of messages in a batch.", + "default": 100000, + "minimum": 0, + "maximum": 4294967295 + } + } + }, + "DataflowEndpointKafkaCompression": { + "type": "string", + "description": "Kafka endpoint Compression properties", + "enum": [ + "None", + "Gzip", + "Snappy", + "Lz4" + ], + "x-ms-enum": { + "name": "DataflowEndpointKafkaCompression", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "NONE Option" + }, + { + "name": "Gzip", + "value": "Gzip", + "description": "Gzip Option" + }, + { + "name": "Snappy", + "value": "Snappy", + "description": "SNAPPY Option" + }, + { + "name": "Lz4", + "value": "Lz4", + "description": "LZ4 Option" + } + ] + } + }, + "DataflowEndpointKafkaPartitionStrategy": { + "type": "string", + "description": "DataflowEndpoint Kafka Partition Strategy properties", + "enum": [ + "Default", + "Static", + "Topic", + "Property" + ], + "x-ms-enum": { + "name": "DataflowEndpointKafkaPartitionStrategy", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "Default: Assigns messages to random partitions, using a round-robin algorithm." + }, + { + "name": "Static", + "value": "Static", + "description": "Static: Assigns messages to a fixed partition number that's derived from the instance ID of the dataflow." + }, + { + "name": "Topic", + "value": "Topic", + "description": "TOPIC Option" + }, + { + "name": "Property", + "value": "Property", + "description": "PROPERTY Option" + } + ] + } + }, + "DataflowEndpointLocalStorage": { + "type": "object", + "description": "Local persistent volume endpoint properties", + "properties": { + "persistentVolumeClaimRef": { + "type": "string", + "description": "Persistent volume claim name." + } + }, + "required": [ + "persistentVolumeClaimRef" + ] + }, + "DataflowEndpointMqtt": { + "type": "object", + "description": "Broker endpoint properties", + "properties": { + "authentication": { + "$ref": "#/definitions/DataflowEndpointMqttAuthentication", + "description": "authentication properties. DEFAULT: kubernetes.audience=aio-internal. NOTE - Enum field only property is allowed" + }, + "clientIdPrefix": { + "type": "string", + "description": "Client ID prefix. Client ID generated by the dataflow is <prefix>-TBD. Optional; no prefix if omitted." + }, + "host": { + "type": "string", + "description": "Host of the Broker in the form of <hostname>:<port>. Optional; connects to Broker if omitted." + }, + "protocol": { + "type": "string", + "description": "Enable or disable websockets.", + "default": "Mqtt", + "enum": [ + "Mqtt", + "WebSockets" + ], + "x-ms-enum": { + "name": "BrokerProtocolType", + "modelAsString": true, + "values": [ + { + "name": "Mqtt", + "value": "Mqtt", + "description": "protocol broker" + }, + { + "name": "WebSockets", + "value": "WebSockets", + "description": "protocol websocket" + } + ] + } + }, + "keepAliveSeconds": { + "type": "integer", + "format": "int32", + "description": "Broker KeepAlive for connection in seconds.", + "default": 60, + "minimum": 0 + }, + "retain": { + "type": "string", + "description": "Whether or not to keep the retain setting.", + "default": "Keep", + "enum": [ + "Keep", + "Never" + ], + "x-ms-enum": { + "name": "MqttRetainType", + "modelAsString": true, + "values": [ + { + "name": "Keep", + "value": "Keep", + "description": "Retain the messages." + }, + { + "name": "Never", + "value": "Never", + "description": "Never retain messages." + } + ] + } + }, + "maxInflightMessages": { + "type": "integer", + "format": "int32", + "description": "The max number of messages to keep in flight. For subscribe, this is the receive maximum. For publish, this is the maximum number of messages to send before waiting for an ack.", + "default": 100, + "minimum": 0 + }, + "qos": { + "type": "integer", + "format": "int32", + "description": "Qos for Broker connection.", + "default": 1, + "minimum": 0, + "maximum": 1 + }, + "sessionExpirySeconds": { + "type": "integer", + "format": "int32", + "description": "Session expiry in seconds.", + "default": 3600, + "minimum": 0 + }, + "tls": { + "$ref": "#/definitions/TlsProperties", + "description": "TLS configuration." + }, + "cloudEventAttributes": { + "$ref": "#/definitions/CloudEventAttributeType", + "description": "Cloud event mapping config." + } + }, + "required": [ + "authentication" + ] + }, + "DataflowEndpointMqttAuthentication": { + "type": "object", + "description": "Mqtt endpoint Authentication properties. NOTE - only authentication property is allowed per entry.", + "properties": { + "method": { + "$ref": "#/definitions/MqttAuthMethod", + "description": "Mode of Authentication." + }, + "systemAssignedManagedIdentitySettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationSystemAssignedManagedIdentity", + "description": "System-assigned managed identity authentication." + }, + "userAssignedManagedIdentitySettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationUserAssignedManagedIdentity", + "description": "User-assigned managed identity authentication." + }, + "serviceAccountTokenSettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationServiceAccountToken", + "description": "Kubernetes service account token authentication. Default audience if not set is aio-internal" + }, + "x509CertificateSettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationX509", + "description": "X.509 certificate authentication." + } + }, + "required": [ + "method" + ] + }, + "DataflowEndpointProperties": { + "type": "object", + "description": "DataflowEndpoint Resource properties. NOTE - Only one type of endpoint is supported for one Resource", + "properties": { + "endpointType": { + "$ref": "#/definitions/EndpointType", + "description": "Endpoint Type." + }, + "dataExplorerSettings": { + "$ref": "#/definitions/DataflowEndpointDataExplorer", + "description": "Azure Data Explorer endpoint." + }, + "dataLakeStorageSettings": { + "$ref": "#/definitions/DataflowEndpointDataLakeStorage", + "description": "Azure Data Lake endpoint." + }, + "fabricOneLakeSettings": { + "$ref": "#/definitions/DataflowEndpointFabricOneLake", + "description": "Microsoft Fabric endpoint." + }, + "kafkaSettings": { + "$ref": "#/definitions/DataflowEndpointKafka", + "description": "Kafka endpoint." + }, + "localStorageSettings": { + "$ref": "#/definitions/DataflowEndpointLocalStorage", + "description": "Local persistent volume endpoint." + }, + "mqttSettings": { + "$ref": "#/definitions/DataflowEndpointMqtt", + "description": "Broker endpoint." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + }, + "required": [ + "endpointType" + ] + }, + "DataflowEndpointResource": { + "type": "object", + "description": "Instance dataflowEndpoint resource", + "properties": { + "properties": { + "$ref": "#/definitions/DataflowEndpointProperties", + "description": "The resource-specific properties for this resource." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "Edge location of the resource.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "extendedLocation" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DataflowEndpointResourceListResult": { + "type": "object", + "description": "The response of a DataflowEndpointResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DataflowEndpointResource items on this page", + "items": { + "$ref": "#/definitions/DataflowEndpointResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DataflowMappingType": { + "type": "string", + "description": "Dataflow type mapping properties", + "enum": [ + "NewProperties", + "Rename", + "Compute", + "PassThrough", + "BuiltInFunction" + ], + "x-ms-enum": { + "name": "DataflowMappingType", + "modelAsString": true, + "values": [ + { + "name": "NewProperties", + "value": "NewProperties", + "description": "New Properties type" + }, + { + "name": "Rename", + "value": "Rename", + "description": "Rename type" + }, + { + "name": "Compute", + "value": "Compute", + "description": "Compute type" + }, + { + "name": "PassThrough", + "value": "PassThrough", + "description": "Pass-through type" + }, + { + "name": "BuiltInFunction", + "value": "BuiltInFunction", + "description": "Built in function type" + } + ] + } + }, + "DataflowOperation": { + "type": "object", + "description": "Dataflow Operation properties. NOTE - One only method is allowed to be used for one entry.", + "properties": { + "operationType": { + "$ref": "#/definitions/OperationType", + "description": "Type of operation." + }, + "name": { + "type": "string", + "description": "Optional user provided name of the transformation.", + "maxLength": 64 + }, + "sourceSettings": { + "$ref": "#/definitions/DataflowSourceOperationSettings", + "description": "Source configuration." + }, + "builtInTransformationSettings": { + "$ref": "#/definitions/DataflowBuiltInTransformationSettings", + "description": "Built In Transformation configuration." + }, + "destinationSettings": { + "$ref": "#/definitions/DataflowDestinationOperationSettings", + "description": "Destination configuration." + } + }, + "required": [ + "operationType" + ] + }, + "DataflowProfileProperties": { + "type": "object", + "description": "DataflowProfile Resource properties", + "properties": { + "diagnostics": { + "$ref": "#/definitions/ProfileDiagnostics", + "description": "Spec defines the desired identities of NBC diagnostics settings." + }, + "instanceCount": { + "type": "integer", + "format": "int32", + "description": "To manually scale the dataflow profile, specify the maximum number of instances you want to run.", + "default": 1, + "minimum": 1, + "maximum": 20 + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "DataflowProfileResource": { + "type": "object", + "description": "Instance dataflowProfile resource", + "properties": { + "properties": { + "$ref": "#/definitions/DataflowProfileProperties", + "description": "The resource-specific properties for this resource." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "Edge location of the resource.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "extendedLocation" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DataflowProfileResourceListResult": { + "type": "object", + "description": "The response of a DataflowProfileResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DataflowProfileResource items on this page", + "items": { + "$ref": "#/definitions/DataflowProfileResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DataflowProperties": { + "type": "object", + "description": "Dataflow Resource properties", + "properties": { + "mode": { + "type": "string", + "description": "Mode for Dataflow. Optional; defaults to Enabled.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "OperationalMode", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled is equivalent to True" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled is equivalent to False." + } + ] + } + }, + "operations": { + "type": "array", + "description": "List of operations including source and destination references as well as transformation.", + "items": { + "$ref": "#/definitions/DataflowOperation" + }, + "x-ms-identifiers": [] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + }, + "required": [ + "operations" + ] + }, + "DataflowResource": { + "type": "object", + "description": "Instance dataflowProfile dataflow resource", + "properties": { + "properties": { + "$ref": "#/definitions/DataflowProperties", + "description": "The resource-specific properties for this resource." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "Edge location of the resource.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "extendedLocation" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DataflowResourceListResult": { + "type": "object", + "description": "The response of a DataflowResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DataflowResource items on this page", + "items": { + "$ref": "#/definitions/DataflowResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DataflowSourceOperationSettings": { + "type": "object", + "description": "Dataflow Source Operation properties", + "properties": { + "endpointRef": { + "type": "string", + "description": "Reference to the Dataflow Endpoint resource. Can only be of Broker and Kafka type." + }, + "assetRef": { + "type": "string", + "description": "Reference to the resource in Azure Device Registry where the data in the endpoint originates from." + }, + "serializationFormat": { + "type": "string", + "description": "Content is a JSON Schema. Allowed: JSON Schema/draft-7.", + "default": "Json", + "enum": [ + "Json" + ], + "x-ms-enum": { + "name": "SourceSerializationFormat", + "modelAsString": true, + "values": [ + { + "name": "Json", + "value": "Json", + "description": "JSON Format" + } + ] + } + }, + "schemaRef": { + "type": "string", + "description": "Schema CR reference. Data will be deserialized according to the schema, and dropped if it doesn't match." + }, + "dataSources": { + "type": "array", + "description": "List of source locations. Can be Broker or Kafka topics. Supports wildcards # and +.", + "items": { + "$ref": "#/definitions/NonEmptyString" + } + } + }, + "required": [ + "endpointRef", + "dataSources" + ] + }, + "DiagnosticsLogs": { + "type": "object", + "description": "Diagnostic Log properties", + "properties": { + "level": { + "type": "string", + "description": "The log level. Examples - 'debug', 'info', 'warn', 'error', 'trace'.", + "default": "info" + } + } + }, + "DiskBackedMessageBuffer": { + "type": "object", + "description": "DiskBackedMessageBuffer properties", + "properties": { + "maxSize": { + "type": "string", + "description": "The max size of the message buffer on disk. If a PVC template is specified using one of ephemeralVolumeClaimSpec or persistentVolumeClaimSpec, then this size is used as the request and limit sizes of that template. If neither ephemeralVolumeClaimSpec nor persistentVolumeClaimSpec are specified, then an emptyDir volume is mounted with this size as its limit. See <https://kubernetes.io/docs/concepts/storage/volumes/#emptydir> for details.", + "pattern": "^[0-9]+[KMGTPE]$" + }, + "ephemeralVolumeClaimSpec": { + "$ref": "#/definitions/VolumeClaimSpec", + "description": "Use the specified persistent volume claim template to mount a \"generic ephemeral volume\" for the message buffer. See <https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes> for details." + }, + "persistentVolumeClaimSpec": { + "$ref": "#/definitions/VolumeClaimSpec", + "description": "Use the specified persistent volume claim template to mount a persistent volume for the message buffer." + } + }, + "required": [ + "maxSize" + ] + }, + "EndpointType": { + "type": "string", + "description": "DataflowEndpoint Type properties", + "enum": [ + "DataExplorer", + "DataLakeStorage", + "FabricOneLake", + "Kafka", + "LocalStorage", + "Mqtt" + ], + "x-ms-enum": { + "name": "EndpointType", + "modelAsString": true, + "values": [ + { + "name": "DataExplorer", + "value": "DataExplorer", + "description": "Azure Data Explorer Type" + }, + { + "name": "DataLakeStorage", + "value": "DataLakeStorage", + "description": "Azure Data Lake Type" + }, + { + "name": "FabricOneLake", + "value": "FabricOneLake", + "description": "Microsoft Fabric Type" + }, + { + "name": "Kafka", + "value": "Kafka", + "description": "Kafka Type" + }, + { + "name": "LocalStorage", + "value": "LocalStorage", + "description": "Local Storage Type" + }, + { + "name": "Mqtt", + "value": "Mqtt", + "description": "Broker Type" + } + ] + } + }, + "ExtendedLocation": { + "type": "object", + "description": "Extended location is an extension of Azure locations. They provide a way to use their Azure ARC enabled Kubernetes clusters as target locations for deploying Azure services instances.", + "properties": { + "name": { + "type": "string", + "description": "The name of the extended location." + }, + "type": { + "$ref": "#/definitions/ExtendedLocationType", + "description": "Type of ExtendedLocation." + } + }, + "required": [ + "name", + "type" + ] + }, + "ExtendedLocationType": { + "type": "string", + "description": "The enum defining type of ExtendedLocation accepted.", + "enum": [ + "CustomLocation" + ], + "x-ms-enum": { + "name": "ExtendedLocationType", + "modelAsString": true, + "values": [ + { + "name": "CustomLocation", + "value": "CustomLocation", + "description": "CustomLocation type" + } + ] + } + }, + "FabricOneLakeAuthMethod": { + "$ref": "#/definitions/ManagedIdentityMethod", + "x-nullable": false + }, + "FilterType": { + "type": "string", + "description": "Filter Type properties", + "enum": [ + "Filter" + ], + "x-ms-enum": { + "name": "FilterType", + "modelAsString": true, + "values": [ + { + "name": "Filter", + "value": "Filter", + "description": "Filter type" + } + ] + } + }, + "Frontend": { + "type": "object", + "description": "The desired properties of the frontend instances of the Broker", + "properties": { + "replicas": { + "type": "integer", + "format": "int32", + "description": "The desired number of frontend instances (pods).", + "minimum": 1, + "maximum": 16 + }, + "workers": { + "type": "integer", + "format": "int32", + "description": "Number of logical frontend workers per instance (pod).", + "default": 2, + "minimum": 1, + "maximum": 16 + } + }, + "required": [ + "replicas" + ] + }, + "GenerateResourceLimits": { + "type": "object", + "description": "GenerateResourceLimits properties", + "properties": { + "cpu": { + "type": "string", + "description": "The toggle to enable/disable cpu resource limits.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "OperationalMode", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled is equivalent to True" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled is equivalent to False." + } + ] + } + } + } + }, + "InstancePatchModel": { + "type": "object", + "description": "The Instance update model.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + } + }, + "InstanceProperties": { + "type": "object", + "description": "The properties of the Instance resource.", + "properties": { + "description": { + "type": "string", + "description": "Detailed description of the Instance." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "The Azure IoT Operations version.", + "readOnly": true + }, + "schemaRegistryRef": { + "$ref": "#/definitions/SchemaRegistryRef", + "description": "The reference to the Schema Registry for this AIO Instance." + } + }, + "required": [ + "schemaRegistryRef" + ] + }, + "InstanceResource": { + "type": "object", + "description": "A Instance resource is a logical container for a set of child resources.", + "properties": { + "properties": { + "$ref": "#/definitions/InstanceProperties", + "description": "The resource-specific properties for this resource." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "Edge location of the resource.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "required": [ + "extendedLocation" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "InstanceResourceListResult": { + "type": "object", + "description": "The response of a InstanceResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The InstanceResource items on this page", + "items": { + "$ref": "#/definitions/InstanceResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "KafkaAuthMethod": { + "type": "string", + "description": "DataflowEndpoint Kafka Authentication Method properties", + "enum": [ + "SystemAssignedManagedIdentity", + "UserAssignedManagedIdentity", + "Sasl", + "X509Certificate", + "Anonymous" + ], + "x-ms-enum": { + "name": "KafkaAuthMethod", + "modelAsString": true, + "values": [ + { + "name": "SystemAssignedManagedIdentity", + "value": "SystemAssignedManagedIdentity", + "description": "SystemAssignedManagedIdentity type" + }, + { + "name": "UserAssignedManagedIdentity", + "value": "UserAssignedManagedIdentity", + "description": "UserAssignedManagedIdentity type" + }, + { + "name": "Sasl", + "value": "Sasl", + "description": "Sasl Option" + }, + { + "name": "X509Certificate", + "value": "X509Certificate", + "description": "x509Certificate Option" + }, + { + "name": "Anonymous", + "value": "Anonymous", + "description": "Anonymous Option" + } + ] + } + }, + "KubernetesReference": { + "type": "object", + "description": "Kubernetes reference", + "properties": { + "apiGroup": { + "type": "string", + "description": "APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required." + }, + "kind": { + "type": "string", + "description": "Kind is the type of resource being referenced" + }, + "name": { + "type": "string", + "description": "Name is the name of resource being referenced" + }, + "namespace": { + "type": "string", + "description": "Namespace is the namespace of the resource being referenced. This field is required when the resource has a namespace." + } + }, + "required": [ + "kind", + "name" + ] + }, + "ListenerPort": { + "type": "object", + "description": "Defines a TCP port on which a `BrokerListener` listens.", + "properties": { + "authenticationRef": { + "type": "string", + "description": "Reference to client authentication settings. Omit to disable authentication." + }, + "authorizationRef": { + "type": "string", + "description": "Reference to client authorization settings. Omit to disable authorization." + }, + "nodePort": { + "type": "integer", + "format": "int32", + "description": "Kubernetes node port. Only relevant when this port is associated with a `NodePort` listener.", + "minimum": 0, + "maximum": 65535 + }, + "port": { + "type": "integer", + "format": "int32", + "description": "TCP port for accepting client connections.", + "minimum": 0, + "maximum": 65535 + }, + "protocol": { + "type": "string", + "description": "Protocol to use for client connections.", + "default": "Mqtt", + "enum": [ + "Mqtt", + "WebSockets" + ], + "x-ms-enum": { + "name": "BrokerProtocolType", + "modelAsString": true, + "values": [ + { + "name": "Mqtt", + "value": "Mqtt", + "description": "protocol broker" + }, + { + "name": "WebSockets", + "value": "WebSockets", + "description": "protocol websocket" + } + ] + } + }, + "tls": { + "$ref": "#/definitions/TlsCertMethod", + "description": "TLS server certificate settings for this port. Omit to disable TLS." + } + }, + "required": [ + "port" + ] + }, + "LocalKubernetesReference": { + "type": "object", + "description": "Kubernetes reference", + "properties": { + "apiGroup": { + "type": "string", + "description": "APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required." + }, + "kind": { + "type": "string", + "description": "Kind is the type of resource being referenced" + }, + "name": { + "type": "string", + "description": "Name is the name of resource being referenced" + } + }, + "required": [ + "kind", + "name" + ] + }, + "ManagedIdentity": { + "type": "object", + "description": "System and Use Assigned Managed Identity properties", + "properties": { + "systemAssignedManagedIdentitySettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationSystemAssignedManagedIdentity", + "description": "System-assigned managed identity authentication." + }, + "userAssignedManagedIdentitySettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationUserAssignedManagedIdentity", + "description": "User-assigned managed identity authentication." + } + } + }, + "ManagedIdentityMethod": { + "type": "string", + "description": "Managed Identity Method", + "enum": [ + "SystemAssignedManagedIdentity", + "UserAssignedManagedIdentity" + ], + "x-ms-enum": { + "name": "ManagedIdentityMethod", + "modelAsString": true, + "values": [ + { + "name": "SystemAssignedManagedIdentity", + "value": "SystemAssignedManagedIdentity", + "description": "SystemAssignedManagedIdentity type" + }, + { + "name": "UserAssignedManagedIdentity", + "value": "UserAssignedManagedIdentity", + "description": "UserAssignedManagedIdentity type" + } + ] + } + }, + "MetricProperties": { + "type": "object", + "description": "Metric properties", + "properties": { + "logs": { + "$ref": "#/definitions/DiagnosticsLogs", + "description": "Diagnostic log settings for the resource." + }, + "metrics": { + "$ref": "#/definitions/Metrics", + "description": "The metrics settings for the resource." + } + } + }, + "Metrics": { + "type": "object", + "description": "Diagnostic Metrics properties", + "properties": { + "prometheusPort": { + "type": "integer", + "format": "int32", + "description": "The prometheus port to expose the metrics.", + "default": 9600, + "minimum": 0, + "maximum": 65535 + } + } + }, + "MqttAuthMethod": { + "type": "string", + "description": "DataflowEndpoint Mqtt Authentication Method properties", + "enum": [ + "SystemAssignedManagedIdentity", + "UserAssignedManagedIdentity", + "ServiceAccountToken", + "X509Certificate", + "Anonymous" + ], + "x-ms-enum": { + "name": "MqttAuthMethod", + "modelAsString": true, + "values": [ + { + "name": "SystemAssignedManagedIdentity", + "value": "SystemAssignedManagedIdentity", + "description": "SystemAssignedManagedIdentity type" + }, + { + "name": "UserAssignedManagedIdentity", + "value": "UserAssignedManagedIdentity", + "description": "UserAssignedManagedIdentity type" + }, + { + "name": "ServiceAccountToken", + "value": "ServiceAccountToken", + "description": "ServiceAccountToken Option" + }, + { + "name": "X509Certificate", + "value": "X509Certificate", + "description": "x509Certificate Option" + }, + { + "name": "Anonymous", + "value": "Anonymous", + "description": "Anonymous Option" + } + ] + } + }, + "MqttRetainType": { + "type": "string", + "description": "Broker Retain types", + "enum": [ + "Keep", + "Never" + ], + "x-ms-enum": { + "name": "MqttRetainType", + "modelAsString": true, + "values": [ + { + "name": "Keep", + "value": "Keep", + "description": "Retain the messages." + }, + { + "name": "Never", + "value": "Never", + "description": "Never retain messages." + } + ] + } + }, + "NonEmptyString": { + "type": "string", + "description": "A string with a minimum length of 1.", + "minLength": 1 + }, + "OperationType": { + "type": "string", + "description": "Dataflow Operation Type properties", + "enum": [ + "Source", + "Destination", + "BuiltInTransformation" + ], + "x-ms-enum": { + "name": "OperationType", + "modelAsString": true, + "values": [ + { + "name": "Source", + "value": "Source", + "description": "Dataflow Source Operation" + }, + { + "name": "Destination", + "value": "Destination", + "description": "Dataflow Destination Operation" + }, + { + "name": "BuiltInTransformation", + "value": "BuiltInTransformation", + "description": "Dataflow BuiltIn Transformation Operation" + } + ] + } + }, + "OperationalMode": { + "type": "string", + "description": "Mode properties", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "OperationalMode", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled is equivalent to True" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled is equivalent to False." + } + ] + } + }, + "OperatorValues": { + "type": "string", + "description": "Valid operators are In, NotIn, Exists and DoesNotExist.", + "enum": [ + "In", + "NotIn", + "Exists", + "DoesNotExist" + ], + "x-ms-enum": { + "name": "OperatorValues", + "modelAsString": true, + "values": [ + { + "name": "In", + "value": "In", + "description": "In operator." + }, + { + "name": "NotIn", + "value": "NotIn", + "description": "NotIn operator." + }, + { + "name": "Exists", + "value": "Exists", + "description": "Exists operator." + }, + { + "name": "DoesNotExist", + "value": "DoesNotExist", + "description": "DoesNotExist operator." + } + ] + } + }, + "PrincipalDefinition": { + "type": "object", + "description": "PrincipalDefinition properties of Rule", + "properties": { + "attributes": { + "type": "array", + "description": "A list of key-value pairs that match the attributes of the clients. The attributes are case-sensitive and must match the attributes provided by the clients during authentication.", + "default": [], + "items": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "x-ms-identifiers": [] + }, + "clientIds": { + "type": "array", + "description": "A list of client IDs that match the clients. The client IDs are case-sensitive and must match the client IDs provided by the clients during connection.", + "default": [], + "items": { + "type": "string" + } + }, + "usernames": { + "type": "array", + "description": "A list of usernames that match the clients. The usernames are case-sensitive and must match the usernames provided by the clients during authentication.", + "default": [], + "items": { + "type": "string" + } + } + } + }, + "PrivateKeyAlgorithm": { + "type": "string", + "description": "Private key algorithm types.", + "enum": [ + "Ec256", + "Ec384", + "Ec521", + "Ed25519", + "Rsa2048", + "Rsa4096", + "Rsa8192" + ], + "x-ms-enum": { + "name": "PrivateKeyAlgorithm", + "modelAsString": true, + "values": [ + { + "name": "Ec256", + "value": "Ec256", + "description": "Algorithm - ec256." + }, + { + "name": "Ec384", + "value": "Ec384", + "description": "Algorithm - ec384." + }, + { + "name": "Ec521", + "value": "Ec521", + "description": "Algorithm - ec521." + }, + { + "name": "Ed25519", + "value": "Ed25519", + "description": "Algorithm - ed25519." + }, + { + "name": "Rsa2048", + "value": "Rsa2048", + "description": "Algorithm - rsa2048." + }, + { + "name": "Rsa4096", + "value": "Rsa4096", + "description": "Algorithm - rsa4096." + }, + { + "name": "Rsa8192", + "value": "Rsa8192", + "description": "Algorithm - rsa8192." + } + ] + } + }, + "PrivateKeyRotationPolicy": { + "type": "string", + "description": "Private key rotation policy.", + "enum": [ + "Always", + "Never" + ], + "x-ms-enum": { + "name": "PrivateKeyRotationPolicy", + "modelAsString": true, + "values": [ + { + "name": "Always", + "value": "Always", + "description": "Rotation Policy - Always." + }, + { + "name": "Never", + "value": "Never", + "description": "Rotation Policy - Never." + } + ] + } + }, + "ProfileDiagnostics": { + "type": "object", + "description": "DataflowProfile Diagnostics properties", + "properties": { + "logs": { + "$ref": "#/definitions/DiagnosticsLogs", + "description": "Diagnostic log settings for the resource." + }, + "metrics": { + "$ref": "#/definitions/Metrics", + "description": "The metrics settings for the resource." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The enum defining status of resource.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Updating", + "Deleting", + "Accepted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Resource is getting provisioned." + }, + { + "name": "Updating", + "value": "Updating", + "description": "Resource is Updating." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Resource is Deleting." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Resource has been Accepted." + } + ] + }, + "readOnly": true + }, + "SanForCert": { + "type": "object", + "description": "Subject Alternative Names (SANs) for certificate.", + "properties": { + "dns": { + "type": "array", + "description": "DNS SANs.", + "default": [], + "items": { + "type": "string" + } + }, + "ip": { + "type": "array", + "description": "IP address SANs.", + "default": [], + "items": { + "type": "string" + } + } + }, + "required": [ + "dns", + "ip" + ] + }, + "SaslMethod": { + "type": "string", + "description": "Sasl Method", + "enum": [ + "Sasl" + ], + "x-ms-enum": { + "name": "SaslMethod", + "modelAsString": true, + "values": [ + { + "name": "Sasl", + "value": "Sasl", + "description": "Sasl Option" + } + ] + } + }, + "SchemaRegistryID": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.DeviceRegistry/schemaRegistries" + } + ] + } + }, + "SchemaRegistryRef": { + "type": "object", + "description": "The reference to the Schema Registry for this AIO Instance.", + "properties": { + "resourceId": { + "$ref": "#/definitions/SchemaRegistryID", + "description": "The resource ID of the Schema Registry." + } + }, + "required": [ + "resourceId" + ] + }, + "SelfCheck": { + "type": "object", + "description": "Broker Diagnostic Self check properties", + "properties": { + "mode": { + "type": "string", + "description": "The toggle to enable/disable self check.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "OperationalMode", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled is equivalent to True" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled is equivalent to False." + } + ] + } + }, + "intervalSeconds": { + "type": "integer", + "format": "int32", + "description": "The self check interval.", + "default": 30, + "minimum": 30, + "maximum": 300 + }, + "timeoutSeconds": { + "type": "integer", + "format": "int32", + "description": "The timeout for self check.", + "default": 15, + "minimum": 5, + "maximum": 120 + } + } + }, + "SelfTracing": { + "type": "object", + "description": "Diagnostic Self tracing properties", + "properties": { + "mode": { + "type": "string", + "description": "The toggle to enable/disable self tracing.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "OperationalMode", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled is equivalent to True" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled is equivalent to False." + } + ] + } + }, + "intervalSeconds": { + "type": "integer", + "format": "int32", + "description": "The self tracing interval.", + "default": 30, + "minimum": 1, + "maximum": 300 + } + } + }, + "ServiceAccountTokenMethod": { + "type": "string", + "description": "Service Account Token Method", + "enum": [ + "ServiceAccountToken" + ], + "x-ms-enum": { + "name": "ServiceAccountTokenMethod", + "modelAsString": true, + "values": [ + { + "name": "ServiceAccountToken", + "value": "ServiceAccountToken", + "description": "ServiceAccountToken Option" + } + ] + } + }, + "ServiceType": { + "type": "string", + "description": "Kubernetes Service Types supported by Listener", + "enum": [ + "ClusterIp", + "LoadBalancer", + "NodePort" + ], + "x-ms-enum": { + "name": "ServiceType", + "modelAsString": true, + "values": [ + { + "name": "ClusterIp", + "value": "ClusterIp", + "description": "Cluster IP Service." + }, + { + "name": "LoadBalancer", + "value": "LoadBalancer", + "description": "Load Balancer Service." + }, + { + "name": "NodePort", + "value": "NodePort", + "description": "Node Port Service." + } + ] + } + }, + "SourceSerializationFormat": { + "type": "string", + "description": "Serialization Format properties", + "enum": [ + "Json" + ], + "x-ms-enum": { + "name": "SourceSerializationFormat", + "modelAsString": true, + "values": [ + { + "name": "Json", + "value": "Json", + "description": "JSON Format" + } + ] + } + }, + "StateStoreResourceDefinitionMethods": { + "type": "string", + "description": "StateStoreResourceDefinitionMethods methods allowed", + "enum": [ + "Read", + "Write", + "ReadWrite" + ], + "x-ms-enum": { + "name": "StateStoreResourceDefinitionMethods", + "modelAsString": true, + "values": [ + { + "name": "Read", + "value": "Read", + "description": "Get/KeyNotify from Store" + }, + { + "name": "Write", + "value": "Write", + "description": "Set/Delete in Store" + }, + { + "name": "ReadWrite", + "value": "ReadWrite", + "description": "Allowed all operations on Store - Get/KeyNotify/Set/Delete" + } + ] + } + }, + "StateStoreResourceKeyTypes": { + "type": "string", + "description": "StateStoreResourceKeyTypes properties", + "enum": [ + "Pattern", + "String", + "Binary" + ], + "x-ms-enum": { + "name": "StateStoreResourceKeyTypes", + "modelAsString": true, + "values": [ + { + "name": "Pattern", + "value": "Pattern", + "description": "Key type - pattern" + }, + { + "name": "String", + "value": "String", + "description": "Key type - string" + }, + { + "name": "Binary", + "value": "Binary", + "description": "Key type - binary" + } + ] + } + }, + "StateStoreResourceRule": { + "type": "object", + "description": "State Store Resource Rule properties.", + "properties": { + "keyType": { + "$ref": "#/definitions/StateStoreResourceKeyTypes", + "description": "Allowed keyTypes pattern, string, binary. The key type used for matching, for example pattern tries to match the key to a glob-style pattern and string checks key is equal to value provided in keys." + }, + "keys": { + "type": "array", + "description": "Give access to state store keys for the corresponding principals defined. When key type is pattern set glob-style pattern (e.g., '*', 'clients/*').", + "items": { + "type": "string" + } + }, + "method": { + "$ref": "#/definitions/StateStoreResourceDefinitionMethods", + "description": "Give access for `Read`, `Write` and `ReadWrite` access level." + } + }, + "required": [ + "keyType", + "keys", + "method" + ] + }, + "SubscriberMessageDropStrategy": { + "type": "string", + "description": "The enum defining strategies for dropping messages from the subscriber queue.", + "enum": [ + "None", + "DropOldest" + ], + "x-ms-enum": { + "name": "SubscriberMessageDropStrategy", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "Messages are never dropped." + }, + { + "name": "DropOldest", + "value": "DropOldest", + "description": "The oldest message is dropped." + } + ] + } + }, + "SubscriberQueueLimit": { + "type": "object", + "description": "The settings of Subscriber Queue Limit.", + "properties": { + "length": { + "type": "integer", + "format": "int64", + "description": "The maximum length of the queue before messages start getting dropped.", + "minimum": 1 + }, + "strategy": { + "type": "string", + "description": "The strategy to use for dropping messages from the queue.", + "default": "None", + "enum": [ + "None", + "DropOldest" + ], + "x-ms-enum": { + "name": "SubscriberMessageDropStrategy", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "Messages are never dropped." + }, + { + "name": "DropOldest", + "value": "DropOldest", + "description": "The oldest message is dropped." + } + ] + } + } + } + }, + "TlsCertMethod": { + "type": "object", + "description": "Collection of different TLS types, NOTE- Enum at a time only one of them needs to be supported", + "properties": { + "mode": { + "$ref": "#/definitions/TlsCertMethodMode", + "description": "Mode of TLS server certificate management." + }, + "certManagerCertificateSpec": { + "$ref": "#/definitions/CertManagerCertificateSpec", + "description": "Option 1 - Automatic TLS server certificate management with cert-manager." + }, + "manual": { + "$ref": "#/definitions/X509ManualCertificate", + "description": "Option 2 - Manual TLS server certificate management through a defined secret." + } + }, + "required": [ + "mode" + ] + }, + "TlsCertMethodMode": { + "type": "string", + "description": "Broker Authentication Mode", + "enum": [ + "Automatic", + "Manual" + ], + "x-ms-enum": { + "name": "TlsCertMethodMode", + "modelAsString": true, + "values": [ + { + "name": "Automatic", + "value": "Automatic", + "description": "Automatic TLS server certificate configuration." + }, + { + "name": "Manual", + "value": "Manual", + "description": "Manual TLS server certificate configuration." + } + ] + } + }, + "TlsProperties": { + "type": "object", + "description": "Tls properties", + "properties": { + "mode": { + "type": "string", + "description": "Mode for TLS.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "OperationalMode", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled is equivalent to True" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled is equivalent to False." + } + ] + } + }, + "trustedCaCertificateConfigMapRef": { + "type": "string", + "description": "Trusted CA certificate config map." + } + } + }, + "Traces": { + "type": "object", + "description": "Broker Diagnostic Trace properties", + "properties": { + "mode": { + "type": "string", + "description": "The toggle to enable/disable traces.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "OperationalMode", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled is equivalent to True" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled is equivalent to False." + } + ] + } + }, + "cacheSizeMegabytes": { + "type": "integer", + "format": "int32", + "description": "The cache size in megabytes.", + "default": 16, + "minimum": 1, + "maximum": 128 + }, + "selfTracing": { + "$ref": "#/definitions/SelfTracing", + "description": "The self tracing properties." + }, + "spanChannelCapacity": { + "type": "integer", + "format": "int32", + "description": "The span channel capacity.", + "default": 1000, + "minimum": 1000, + "maximum": 100000 + } + } + }, + "TransformationSerializationFormat": { + "type": "string", + "description": "Transformation Format properties", + "enum": [ + "Delta", + "Json", + "Parquet" + ], + "x-ms-enum": { + "name": "TransformationSerializationFormat", + "modelAsString": true, + "values": [ + { + "name": "Delta", + "value": "Delta", + "description": "Delta Format" + }, + { + "name": "Json", + "value": "Json", + "description": "JSON Format" + }, + { + "name": "Parquet", + "value": "Parquet", + "description": "Parquet Format" + } + ] + } + }, + "VolumeClaimResourceRequirements": { + "type": "object", + "description": "VolumeClaimResourceRequirements properties", + "properties": { + "limits": { + "type": "object", + "description": "Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", + "additionalProperties": { + "type": "string" + } + }, + "requests": { + "type": "object", + "description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VolumeClaimSpec": { + "type": "object", + "description": "VolumeClaimSpec properties", + "properties": { + "volumeName": { + "type": "string", + "description": "VolumeName is the binding reference to the PersistentVolume backing this claim." + }, + "volumeMode": { + "type": "string", + "description": "volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is a beta feature." + }, + "storageClassName": { + "type": "string", + "description": "Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1" + }, + "accessModes": { + "type": "array", + "description": "AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "dataSource": { + "$ref": "#/definitions/LocalKubernetesReference", + "description": "This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field." + }, + "dataSourceRef": { + "$ref": "#/definitions/KubernetesReference", + "description": "Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled." + }, + "resources": { + "$ref": "#/definitions/VolumeClaimResourceRequirements", + "description": "Resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources" + }, + "selector": { + "$ref": "#/definitions/VolumeClaimSpecSelector", + "description": "A label query over volumes to consider for binding." + } + } + }, + "VolumeClaimSpecSelector": { + "type": "object", + "description": "VolumeClaimSpecSelector properties", + "properties": { + "matchExpressions": { + "type": "array", + "description": "MatchExpressions is a list of label selector requirements. The requirements are ANDed.", + "items": { + "$ref": "#/definitions/VolumeClaimSpecSelectorMatchExpressions" + }, + "x-ms-identifiers": [] + }, + "matchLabels": { + "type": "object", + "description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VolumeClaimSpecSelectorMatchExpressions": { + "type": "object", + "description": "VolumeClaimSpecSelectorMatchExpressions properties", + "properties": { + "key": { + "type": "string", + "description": "key is the label key that the selector applies to." + }, + "operator": { + "$ref": "#/definitions/OperatorValues", + "description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist." + }, + "values": { + "type": "array", + "description": "values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.", + "items": { + "type": "string" + } + } + }, + "required": [ + "key", + "operator" + ] + }, + "X509ManualCertificate": { + "type": "object", + "description": "X509 Certificate Authentication properties.", + "properties": { + "secretRef": { + "type": "string", + "description": "Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself." + } + }, + "required": [ + "secretRef" + ] + }, + "x509CertificateMethod": { + "type": "string", + "description": "x509 Certificate Method", + "enum": [ + "X509Certificate" + ], + "x-ms-enum": { + "name": "x509CertificateMethod", + "modelAsString": true, + "values": [ + { + "name": "X509Certificate", + "value": "X509Certificate", + "description": "x509Certificate Option" + } + ] + } + } + }, + "parameters": {} +} diff --git a/specification/iotoperations/resource-manager/readme.md b/specification/iotoperations/resource-manager/readme.md index 6335d57f3037..6deadd255fd2 100644 --- a/specification/iotoperations/resource-manager/readme.md +++ b/specification/iotoperations/resource-manager/readme.md @@ -59,7 +59,7 @@ These are the global settings for the IoTOperations. ```yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2024-08-15-preview +tag: package-2024-09-15-preview ``` ### Tag: package-2024-07-01-preview @@ -78,4 +78,13 @@ These settings apply only when `--tag=package-2024-08-15-preview` is specified o ```yaml $(tag) == 'package-2024-08-15-preview' input-file: - Microsoft.IoTOperations/preview/2024-08-15-preview/iotoperations.json +``` + +### Tag: package-2024-09-15-preview + +These settings apply only when `--tag=package-2024-09-15-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-09-15-preview' +input-file: + - Microsoft.IoTOperations/preview/2024-09-15-preview/iotoperations.json ``` \ No newline at end of file From cde2129d0ef2d15d5bae2eebc0017931ad84c5e7 Mon Sep 17 00:00:00 2001 From: Ben Broderick Phillips <bebroder@microsoft.com> Date: Thu, 3 Oct 2024 17:06:48 -0400 Subject: [PATCH 38/47] Remove out of date codeowners (#30848) --- .github/CODEOWNERS | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 93f36b82c2c7..f3c6ce1ab338 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -111,7 +111,7 @@ /specification/deviceregistry/ @marcodalessandro @rohankhandelwal @riteshrao # PRLabel: %Device Update -/specification/deviceupdate/data-plane/ @mikekistler @Azure/api-stewardship-board +/specification/deviceupdate/data-plane/ @Azure/api-stewardship-board /specification/documentdb/ @dmakwana @@ -142,7 +142,7 @@ /specification/keyvault/ @heaths @randallilama @jlichwa # PRLabel: %Load Test Service -/specification/loadtestservice/data-plane/ @mikekistler @Azure/api-stewardship-board +/specification/loadtestservice/data-plane/ @Azure/api-stewardship-board # PRLabel: %Logic App /specification/logic/ @pankajsn @tonytang-microsoft-com @@ -182,7 +182,7 @@ /specification/powerbidedicated/ @tarostok # PRLabel: %Purview -/specification/purview/data-plane @mikekistler @Azure/api-stewardship-board +/specification/purview/data-plane @Azure/api-stewardship-board # PRLabel: %PostgreSQL /specification/postgresql/** @Azure/azure-sdk-write-postgresql @@ -288,4 +288,4 @@ /.github/ @weshaggard @mikeharder @benbp /eng/ @weshaggard @mikeharder @benbp /scripts/ @weshaggard @mikeharder -/.github/CODEOWNERS @Azure/azure-sdk-eng \ No newline at end of file +/.github/CODEOWNERS @Azure/azure-sdk-eng From 95f6074e38ff3934182cf43b0ea86d3c031b777b Mon Sep 17 00:00:00 2001 From: nasc17 <69922333+nasc17@users.noreply.github.com> Date: Thu, 3 Oct 2024 17:19:56 -0400 Subject: [PATCH 39/47] Review request for Microsoft.DBforPostgreSQL to add stable release of version 2024-08-01 (#30737) * 20240801 copied from previous 20240301preview * Update api version within files * Update readme * Quota Usages not for GA * Update description of configuraiton properties * Update title to PostgreSQLServerManagementClient and add to suppression path * remove where clause in readme suppresions --- .../stable/2024-08-01/Administrators.json | 406 ++++ .../stable/2024-08-01/Backups.json | 315 +++ .../stable/2024-08-01/Capabilities.json | 587 +++++ .../2024-08-01/CheckNameAvailability.json | 155 ++ .../stable/2024-08-01/Configuration.json | 395 +++ .../stable/2024-08-01/Databases.json | 317 +++ .../stable/2024-08-01/FirewallRules.json | 323 +++ .../stable/2024-08-01/FlexibleServers.json | 1211 +++++++++ .../LongTermRetentionOperation.json | 524 ++++ .../stable/2024-08-01/Migrations.json | 1296 ++++++++++ .../stable/2024-08-01/Operations.json | 164 ++ .../stable/2024-08-01/PrivateDnsZone.json | 77 + .../PrivateEndpointConnections.json | 270 +++ .../2024-08-01/PrivateLinkResources.json | 155 ++ .../stable/2024-08-01/Replicas.json | 83 + .../stable/2024-08-01/ServerLogs.json | 148 ++ .../2024-08-01/ServerStartStopRestart.json | 229 ++ .../stable/2024-08-01/ThreatProtection.json | 280 +++ .../stable/2024-08-01/VirtualEndpoints.json | 403 +++ .../stable/2024-08-01/VirtualNetwork.json | 142 ++ .../2024-08-01/examples/AdministratorAdd.json | 43 + .../examples/AdministratorDelete.json | 19 + .../2024-08-01/examples/AdministratorGet.json | 24 + .../examples/AdministratorsListByServer.json | 36 + .../2024-08-01/examples/BackupCreate.json | 36 + .../2024-08-01/examples/BackupDelete.json | 18 + .../stable/2024-08-01/examples/BackupGet.json | 23 + .../examples/BackupListByServer.json | 126 + .../examples/CapabilitiesByLocation.json | 2153 ++++++++++++++++ .../CheckMigrationNameAvailability.json | 23 + .../examples/CheckNameAvailability.json | 20 + .../CheckNameAvailabilityLocationBased.json | 21 + .../2024-08-01/examples/ConfigurationGet.json | 26 + .../examples/ConfigurationListByServer.json | 1902 +++++++++++++++ .../examples/ConfigurationUpdate.json | 53 + .../2024-08-01/examples/DatabaseCreate.json | 45 + .../2024-08-01/examples/DatabaseDelete.json | 19 + .../2024-08-01/examples/DatabaseGet.json | 22 + .../examples/DatabasesListByServer.json | 34 + .../examples/FirewallRuleCreate.json | 45 + .../examples/FirewallRuleDelete.json | 19 + .../2024-08-01/examples/FirewallRuleGet.json | 22 + .../examples/FirewallRuleListByServer.json | 35 + .../examples/GetPrivateDnsZoneSuffix.json | 11 + .../examples/LogFilesListByServer.json | 28 + .../examples/LongTermRetentionBackup.json | 39 + .../LongTermRetentionOperationGet.json | 28 + ...ongTermRetentionOperationListByServer.json | 31 + .../examples/LongTermRetentionPreBackup.json | 22 + .../examples/Migrations_Cancel.json | 59 + .../examples/Migrations_Create.json | 104 + ...te_Other_SourceTypes_Validate_Migrate.json | 107 + .../Migrations_Create_Validate_Only.json | 100 + .../Migrations_Create_With_Other_Users.json | 101 + ...s_Create_With_PrivateEndpoint_Servers.json | 104 + .../Migrations_Create_With_Roles.json | 102 + .../examples/Migrations_Delete.json | 14 + .../2024-08-01/examples/Migrations_Get.json | 62 + ...nWithSuccessfulValidationAndMigration.json | 100 + ...ccessfulValidationButMigrationFailure.json | 98 + ...MigrationWithSuccessfulValidationOnly.json | 82 + ...ns_GetMigrationWithValidationFailures.json | 198 ++ .../Migrations_ListByTargetServer.json | 65 + .../examples/Migrations_Update.json | 67 + .../2024-08-01/examples/OperationList.json | 176 ++ .../PrivateEndpointConnectionDelete.json | 18 + .../PrivateEndpointConnectionGet.json | 32 + .../PrivateEndpointConnectionList.json | 54 + .../PrivateEndpointConnectionUpdate.json | 67 + .../examples/PrivateLinkResourcesGet.json | 27 + .../examples/PrivateLinkResourcesList.json | 30 + ...romoteReplicaAsForcedStandaloneServer.json | 85 + .../PromoteReplicaAsForcedSwitchover.json | 85 + ...omoteReplicaAsPlannedStandaloneServer.json | 85 + .../PromoteReplicaAsPlannedSwitchover.json | 85 + .../examples/ReplicasListByServer.json | 75 + .../examples/ServerCapabilities.json | 2154 +++++++++++++++++ .../2024-08-01/examples/ServerCreate.json | 158 ++ ...teGeoRestoreWithDataEncryptionEnabled.json | 179 ++ .../ServerCreatePointInTimeRestore.json | 127 + .../examples/ServerCreateReplica.json | 180 ++ .../examples/ServerCreateReviveDropped.json | 125 + .../ServerCreateWithAadAuthEnabled.json | 165 ++ ...ServerCreateWithDataEncryptionEnabled.json | 194 ++ .../2024-08-01/examples/ServerDelete.json | 18 + .../stable/2024-08-01/examples/ServerGet.json | 61 + .../ServerGetWithPrivateEndpoints.json | 82 + .../examples/ServerGetWithVnet.json | 64 + .../2024-08-01/examples/ServerList.json | 102 + .../examples/ServerListByResourceGroup.json | 105 + .../2024-08-01/examples/ServerRestart.json | 17 + .../examples/ServerRestartWithFailover.json | 21 + .../2024-08-01/examples/ServerStart.json | 17 + .../2024-08-01/examples/ServerStop.json | 17 + ...hreatProtectionSettingsCreateOrUpdate.json | 39 + .../ServerThreatProtectionSettingsGet.json | 22 + ...rThreatProtectionSettingsListByServer.json | 25 + .../2024-08-01/examples/ServerUpdate.json | 91 + .../ServerUpdateWithAadAuthEnabled.json | 97 + ...erUpdateWithCustomerMaintenanceWindow.json | 84 + ...ServerUpdateWithDataEncryptionEnabled.json | 123 + .../ServerUpdateWithMajorVersionUpgrade.json | 79 + .../examples/VirtualEndpointCreate.json | 63 + .../examples/VirtualEndpointDelete.json | 22 + .../examples/VirtualEndpointUpdate.json | 46 + .../examples/VirtualEndpointsGet.json | 28 + .../VirtualEndpointsListByServer.json | 31 + .../examples/VirtualNetworkSubnetUsage.json | 28 + .../postgresql/resource-manager/readme.md | 58 +- 109 files changed, 19204 insertions(+), 3 deletions(-) create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Administrators.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Backups.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Capabilities.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/CheckNameAvailability.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Configuration.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Databases.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/FirewallRules.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/FlexibleServers.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/LongTermRetentionOperation.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Migrations.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Operations.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateDnsZone.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateEndpointConnections.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateLinkResources.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Replicas.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/ServerLogs.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/ServerStartStopRestart.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/ThreatProtection.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/VirtualEndpoints.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/VirtualNetwork.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorAdd.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorDelete.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorsListByServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupCreate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupDelete.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupListByServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CapabilitiesByLocation.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CheckMigrationNameAvailability.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CheckNameAvailability.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CheckNameAvailabilityLocationBased.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ConfigurationGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ConfigurationListByServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ConfigurationUpdate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabaseCreate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabaseDelete.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabaseGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabasesListByServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleCreate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleDelete.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleListByServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/GetPrivateDnsZoneSuffix.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LogFilesListByServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionBackup.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionOperationGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionOperationListByServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionPreBackup.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Cancel.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_Other_SourceTypes_Validate_Migrate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_Validate_Only.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_With_Other_Users.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_With_PrivateEndpoint_Servers.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_With_Roles.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Delete.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Get.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithSuccessfulValidationAndMigration.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithSuccessfulValidationButMigrationFailure.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithSuccessfulValidationOnly.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithValidationFailures.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_ListByTargetServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Update.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/OperationList.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionDelete.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionList.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionUpdate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateLinkResourcesGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateLinkResourcesList.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsForcedStandaloneServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsForcedSwitchover.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsPlannedStandaloneServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsPlannedSwitchover.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ReplicasListByServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCapabilities.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateGeoRestoreWithDataEncryptionEnabled.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreatePointInTimeRestore.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateReplica.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateReviveDropped.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateWithAadAuthEnabled.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateWithDataEncryptionEnabled.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerDelete.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerGetWithPrivateEndpoints.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerGetWithVnet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerList.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerListByResourceGroup.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerRestart.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerRestartWithFailover.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerStart.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerStop.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerThreatProtectionSettingsCreateOrUpdate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerThreatProtectionSettingsGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerThreatProtectionSettingsListByServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithAadAuthEnabled.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithCustomerMaintenanceWindow.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithDataEncryptionEnabled.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithMajorVersionUpgrade.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointCreate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointDelete.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointUpdate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointsGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointsListByServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualNetworkSubnetUsage.json diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Administrators.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Administrators.json new file mode 100644 index 000000000000..1b558e897af8 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Administrators.json @@ -0,0 +1,406 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "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.DBforPostgreSQL/flexibleServers/{serverName}/administrators/{objectId}": { + "put": { + "tags": [ + "Administrators" + ], + "operationId": "Administrators_Create", + "x-ms-examples": { + "Adds an Active DIrectory Administrator for the server": { + "$ref": "./examples/AdministratorAdd.json" + } + }, + "description": "Creates a new server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/ObjectIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ActiveDirectoryAdministratorAdd" + }, + "description": "The required parameters for adding an active directory administrator for a server." + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ActiveDirectoryAdministrator" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ActiveDirectoryAdministrator" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Administrators" + ], + "operationId": "Administrators_Delete", + "x-ms-examples": { + "AdministratorDelete": { + "$ref": "./examples/AdministratorDelete.json" + } + }, + "description": "Deletes an Active Directory Administrator associated with the server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/ObjectIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Administrators" + ], + "operationId": "Administrators_Get", + "x-ms-examples": { + "ServerGet": { + "$ref": "./examples/AdministratorGet.json" + } + }, + "description": "Gets information about a server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/ObjectIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ActiveDirectoryAdministrator" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/administrators": { + "get": { + "tags": [ + "Administrators" + ], + "operationId": "Administrators_ListByServer", + "x-ms-examples": { + "AdministratorsListByServer": { + "$ref": "./examples/AdministratorsListByServer.json" + } + }, + "description": "List all the AAD administrators for a given server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AdministratorListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ActiveDirectoryAdministratorAdd": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AdministratorPropertiesForAdd", + "x-ms-client-flatten": true, + "description": "Properties of the active directory administrator." + } + }, + "description": "Represents an Active Directory administrator." + }, + "AdministratorPropertiesForAdd": { + "type": "object", + "properties": { + "principalType": { + "type": "string", + "description": "The principal type used to represent the type of Active Directory Administrator.", + "enum": [ + "Unknown", + "User", + "Group", + "ServicePrincipal" + ], + "x-ms-enum": { + "name": "PrincipalType", + "modelAsString": true + }, + "x-ms-mutability": [ + "create", + "update", + "read" + ] + }, + "principalName": { + "type": "string", + "description": "Active Directory administrator principal name.", + "x-ms-mutability": [ + "create", + "update", + "read" + ] + }, + "tenantId": { + "type": "string", + "description": "The tenantId of the Active Directory administrator.", + "x-ms-mutability": [ + "create", + "update" + ] + } + }, + "description": "The properties of an Active Directory administrator." + }, + "AdministratorProperties": { + "type": "object", + "properties": { + "principalType": { + "type": "string", + "description": "The principal type used to represent the type of Active Directory Administrator.", + "enum": [ + "Unknown", + "User", + "Group", + "ServicePrincipal" + ], + "x-ms-enum": { + "name": "PrincipalType", + "modelAsString": true + }, + "x-ms-mutability": [ + "create", + "update", + "read" + ] + }, + "principalName": { + "type": "string", + "description": "Active Directory administrator principal name.", + "x-ms-mutability": [ + "create", + "update", + "read" + ] + }, + "objectId": { + "type": "string", + "description": "The objectId of the Active Directory administrator.", + "x-ms-mutability": [ + "create", + "update", + "read" + ] + }, + "tenantId": { + "type": "string", + "description": "The tenantId of the Active Directory administrator.", + "x-ms-mutability": [ + "create", + "update", + "read" + ] + } + }, + "description": "The properties of an Active Directory administrator." + }, + "ActiveDirectoryAdministrator": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AdministratorProperties", + "x-ms-client-flatten": true, + "description": "Properties of the active directory administrator." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "required": [ + "properties" + ], + "description": "Represents an Active Directory administrator." + }, + "AdministratorListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ActiveDirectoryAdministrator" + }, + "description": "The list of active directory administrators" + }, + "nextLink": { + "description": "The link used to get the next page of active directory.", + "type": "string" + } + }, + "description": "A list of active directory administrators." + } + }, + "parameters": { + "ObjectIdParameter": { + "name": "objectId", + "in": "path", + "required": true, + "type": "string", + "description": "Guid of the objectId for the administrator.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Backups.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Backups.json new file mode 100644 index 000000000000..177e1d45d15d --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Backups.json @@ -0,0 +1,315 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "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.DBforPostgreSQL/flexibleServers/{serverName}/backups/{backupName}": { + "put": { + "tags": [ + "Backups" + ], + "operationId": "Backups_Create", + "x-ms-examples": { + "Create a new Backup for a flexible server": { + "$ref": "./examples/BackupCreate.json" + } + }, + "description": "Create a specific backup for PostgreSQL flexible server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/BackupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerBackup" + } + }, + "201": { + "description": "Successfully created backup", + "schema": { + "$ref": "#/definitions/ServerBackup" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Backups" + ], + "operationId": "Backups_Delete", + "x-ms-examples": { + "Delete a specific backup": { + "$ref": "./examples/BackupDelete.json" + } + }, + "description": "Deletes a specific backup.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/BackupNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Backups" + ], + "operationId": "Backups_Get", + "x-ms-examples": { + "Get a backup for a server": { + "$ref": "./examples/BackupGet.json" + } + }, + "description": "Get specific backup for a given server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/BackupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerBackup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/backups": { + "get": { + "tags": [ + "Backups" + ], + "operationId": "Backups_ListByServer", + "x-ms-examples": { + "List backups for a server": { + "$ref": "./examples/BackupListByServer.json" + } + }, + "description": "List all the backups for a given server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerBackupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ServerBackupProperties": { + "type": "object", + "properties": { + "backupType": { + "type": "string", + "description": "Backup type.", + "enum": [ + "Full", + "Customer On-Demand" + ], + "x-ms-enum": { + "name": "Origin", + "modelAsString": true + } + }, + "completedTime": { + "type": "string", + "format": "date-time", + "description": "Backup completed time (ISO8601 format)." + }, + "source": { + "type": "string", + "description": "Backup source" + } + }, + "description": "The properties of a server backup." + }, + "ServerBackup": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ServerBackupProperties", + "x-ms-client-flatten": true, + "description": "The properties of a server backup." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "description": "Server backup properties" + }, + "ServerBackupListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServerBackup" + }, + "description": "The list of backups of a server." + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of server backups." + } + }, + "parameters": { + "BackupNameParameter": { + "name": "backupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the backup.", + "minLength": 1, + "pattern": "^[-\\w\\._]+$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Capabilities.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Capabilities.json new file mode 100644 index 000000000000..a41aac1fc41e --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Capabilities.json @@ -0,0 +1,587 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "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.DBforPostgreSQL/locations/{locationName}/capabilities": { + "get": { + "tags": [ + "LocationBasedCapabilities" + ], + "operationId": "LocationBasedCapabilities_Execute", + "x-ms-examples": { + "CapabilitiesList": { + "$ref": "./examples/CapabilitiesByLocation.json" + } + }, + "description": "Get capabilities at specified location in a given subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/LocationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapabilitiesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/capabilities": { + "get": { + "tags": [ + "FlexibleServerCapabilities" + ], + "operationId": "ServerCapabilities_List", + "x-ms-examples": { + "ServerCapabilitiesList": { + "$ref": "./examples/ServerCapabilities.json" + } + }, + "description": "Get capabilities for a flexible server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapabilitiesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "StorageTierCapability": { + "type": "object", + "description": "Represents capability of a storage tier", + "properties": { + "name": { + "type": "string", + "description": "Name to represent Storage tier capability", + "readOnly": true + }, + "iops": { + "type": "integer", + "format": "int32", + "description": "Supported IOPS for this storage tier", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../types/common-types.json#/definitions/CapabilityBase" + } + ] + }, + "StorageMbCapability": { + "type": "object", + "properties": { + "supportedIops": { + "type": "integer", + "format": "int32", + "description": "Supported IOPS", + "readOnly": true + }, + "supportedMaximumIops": { + "type": "integer", + "format": "int32", + "description": "Maximum IOPS supported by this #Vcores or PremiumV2_LRS Storage Size", + "readOnly": true + }, + "storageSizeMb": { + "type": "integer", + "format": "int64", + "description": "Storage size in MB", + "readOnly": true + }, + "maximumStorageSizeMb": { + "type": "integer", + "format": "int64", + "description": "Maximum value of Storage size in MB", + "readOnly": true + }, + "supportedThroughput": { + "type": "integer", + "format": "int32", + "description": "Values of throughput in MB/s", + "readOnly": true + }, + "supportedMaximumThroughput": { + "type": "integer", + "format": "int32", + "description": "Maximum values of throughput in MB/s", + "readOnly": true + }, + "defaultIopsTier": { + "type": "string", + "description": "Default tier for IOPS", + "readOnly": true + }, + "supportedIopsTiers": { + "type": "array", + "description": "List of available options to upgrade the storage performance", + "items": { + "$ref": "#/definitions/StorageTierCapability" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../types/common-types.json#/definitions/CapabilityBase" + } + ], + "description": "storage size in MB capability" + }, + "ServerSkuCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Sku name", + "readOnly": true + }, + "vCores": { + "type": "integer", + "format": "int32", + "description": "Supported vCores", + "readOnly": true + }, + "supportedIops": { + "type": "integer", + "format": "int32", + "description": "Supported IOPS", + "readOnly": true + }, + "supportedMemoryPerVcoreMb": { + "type": "integer", + "format": "int64", + "description": "Supported memory per vCore in MB", + "readOnly": true + }, + "supportedZones": { + "type": "array", + "description": "List of supported Availability Zones. E.g. \"1\", \"2\", \"3\"", + "items": { + "type": "string" + }, + "readOnly": true + }, + "supportedHaMode": { + "type": "array", + "items": { + "type": "string", + "description": "HA mode supported for a server.", + "enum": [ + "SameZone", + "ZoneRedundant" + ], + "x-ms-enum": { + "name": "HaMode", + "modelAsString": true + } + }, + "description": "Supported high availability mode", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../types/common-types.json#/definitions/CapabilityBase" + } + ], + "description": "Sku capability" + }, + "ServerVersion": { + "type": "string", + "description": "The version of a server.", + "enum": [ + "16", + "15", + "14", + "13", + "12", + "11" + ], + "x-ms-enum": { + "name": "ServerVersion", + "modelAsString": true + } + }, + "ServerVersionCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Server version", + "readOnly": true + }, + "supportedVersionsToUpgrade": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Supported servers versions to upgrade", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../types/common-types.json#/definitions/CapabilityBase" + } + ], + "description": "Server version capabilities." + }, + "StorageEditionCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Storage edition name", + "readOnly": true + }, + "defaultStorageSizeMb": { + "type": "integer", + "format": "int64", + "description": "Default storage size in MB for storage edition", + "readOnly": true + }, + "supportedStorageMb": { + "type": "array", + "description": "Flexible server supported storage range in MB", + "items": { + "$ref": "#/definitions/StorageMbCapability" + }, + "x-ms-identifiers": [ + "storageSizeMb" + ], + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../types/common-types.json#/definitions/CapabilityBase" + } + ], + "description": "Storage edition capability" + }, + "FastProvisioningEditionCapability": { + "type": "object", + "description": "Represents capability of a fast provisioning edition", + "properties": { + "supportedTier": { + "type": "string", + "description": "Fast provisioning supported tier name", + "readOnly": true + }, + "supportedSku": { + "type": "string", + "description": "Fast provisioning supported sku name", + "readOnly": true + }, + "supportedStorageGb": { + "type": "integer", + "format": "int32", + "description": "Fast provisioning supported storage in Gb", + "readOnly": true + }, + "supportedServerVersions": { + "type": "string", + "description": "Fast provisioning supported version", + "readOnly": true + }, + "serverCount": { + "type": "integer", + "description": "Count of servers in cache matching the spec", + "format": "int32", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../types/common-types.json#/definitions/CapabilityBase" + } + ] + }, + "FlexibleServerEditionCapability": { + "type": "object", + "allOf": [ + { + "$ref": "../../../types/common-types.json#/definitions/CapabilityBase" + } + ], + "properties": { + "name": { + "type": "string", + "description": "Server edition name", + "readOnly": true + }, + "defaultSkuName": { + "type": "string", + "description": "Default sku name for the server edition", + "readOnly": true + }, + "supportedStorageEditions": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageEditionCapability" + }, + "description": "The list of editions supported by this server edition.", + "readOnly": true, + "x-ms-identifiers": [ + "name" + ] + }, + "supportedServerSkus": { + "type": "array", + "description": "List of supported server SKUs.", + "items": { + "$ref": "#/definitions/ServerSkuCapability" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + } + }, + "description": "Flexible server edition capabilities." + }, + "FlexibleServerCapability": { + "type": "object", + "allOf": [ + { + "$ref": "../../../types/common-types.json#/definitions/CapabilityBase" + } + ], + "properties": { + "name": { + "type": "string", + "description": "Name of flexible servers capability" + }, + "supportedServerEditions": { + "type": "array", + "items": { + "$ref": "#/definitions/FlexibleServerEditionCapability" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true, + "description": "List of supported flexible server editions" + }, + "supportedServerVersions": { + "type": "array", + "items": { + "$ref": "#/definitions/ServerVersionCapability" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of server versions supported for this capability.", + "readOnly": true + }, + "fastProvisioningSupported": { + "type": "string", + "description": "Gets a value indicating whether fast provisioning is supported. \"Enabled\" means fast provisioning is supported. \"Disabled\" stands for fast provisioning is not supported.", + "readOnly": true, + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "fastProvisioningSupportedEnum", + "modelAsString": true + } + }, + "supportedFastProvisioningEditions": { + "type": "array", + "description": "List of supported server editions for fast provisioning", + "items": { + "$ref": "#/definitions/FastProvisioningEditionCapability" + }, + "x-ms-identifiers": [ + "supportedSku" + ], + "readOnly": true + }, + "geoBackupSupported": { + "type": "string", + "description": "Determines if geo-backup is supported in this region. \"Enabled\" means geo-backup is supported. \"Disabled\" stands for geo-back is not supported.", + "readOnly": true, + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "geoBackupSupportedEnum", + "modelAsString": true + } + }, + "zoneRedundantHaSupported": { + "type": "string", + "description": "A value indicating whether Zone Redundant HA is supported in this region. \"Enabled\" means zone redundant HA is supported. \"Disabled\" stands for zone redundant HA is not supported.", + "readOnly": true, + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "zoneRedundantHaSupportedEnum", + "modelAsString": true + } + }, + "zoneRedundantHaAndGeoBackupSupported": { + "type": "string", + "description": "A value indicating whether Zone Redundant HA and Geo-backup is supported in this region. \"Enabled\" means zone redundant HA and geo-backup is supported. \"Disabled\" stands for zone redundant HA and geo-backup is not supported.", + "readOnly": true, + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "zoneRedundantHaAndGeoBackupSupportedEnum", + "modelAsString": true + } + }, + "storageAutoGrowthSupported": { + "type": "string", + "description": "A value indicating whether storage auto-grow is supported in this region. \"Enabled\" means storage auto-grow is supported. \"Disabled\" stands for storage auto-grow is not supported.", + "readOnly": true, + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "storageAutoGrowthSupportedEnum", + "modelAsString": true + } + }, + "onlineResizeSupported": { + "type": "string", + "description": "A value indicating whether online resize is supported in this region for the given subscription. \"Enabled\" means storage online resize is supported. \"Disabled\" means storage online resize is not supported.", + "readOnly": true, + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "onlineResizeSupportedEnum", + "modelAsString": true + } + }, + "restricted": { + "type": "string", + "description": "A value indicating whether this region is restricted. \"Enabled\" means region is restricted. \"Disabled\" stands for region is not restricted.", + "readOnly": true, + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "restrictedEnum", + "modelAsString": true + } + } + }, + "description": "Capability for the PostgreSQL server" + }, + "CapabilitiesListResult": { + "type": "object", + "properties": { + "value": { + "description": "A list of supported capabilities.", + "type": "array", + "items": { + "$ref": "#/definitions/FlexibleServerCapability" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + }, + "description": "Capability for the PostgreSQL server" + } + }, + "parameters": {} +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/CheckNameAvailability.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/CheckNameAvailability.json new file mode 100644 index 000000000000..b8d61cc81504 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/CheckNameAvailability.json @@ -0,0 +1,155 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "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.DBforPostgreSQL/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailability" + ], + "operationId": "CheckNameAvailability_Execute", + "x-ms-examples": { + "NameAvailability": { + "$ref": "./examples/CheckNameAvailability.json" + } + }, + "description": "Check the availability of name for resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "nameAvailabilityRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityRequest" + }, + "description": "The required parameters for checking if resource name is available." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NameAvailability" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/locations/{locationName}/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailability" + ], + "operationId": "CheckNameAvailabilityWithLocation_Execute", + "x-ms-examples": { + "NameAvailability": { + "$ref": "./examples/CheckNameAvailabilityLocationBased.json" + } + }, + "description": "Check the availability of name for resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/LocationNameParameter" + }, + { + "name": "nameAvailabilityRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityRequest" + }, + "description": "The required parameters for checking if resource name is available." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NameAvailability" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "NameAvailability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "name of the PostgreSQL server.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "type of the server", + "readOnly": true + } + }, + "description": "Represents a resource name availability.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityResponse" + } + ] + } + }, + "parameters": {} +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Configuration.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Configuration.json new file mode 100644 index 000000000000..97116aad59f7 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Configuration.json @@ -0,0 +1,395 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "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.DBforPostgreSQL/flexibleServers/{serverName}/configurations": { + "get": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_ListByServer", + "x-ms-examples": { + "ConfigurationList": { + "$ref": "./examples/ConfigurationListByServer.json" + } + }, + "description": "List all the configurations in a given server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/configurations/{configurationName}": { + "get": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Get", + "x-ms-examples": { + "ConfigurationGet": { + "$ref": "./examples/ConfigurationGet.json" + } + }, + "description": "Gets information about a configuration of server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Update", + "x-ms-examples": { + "Update a user configuration": { + "$ref": "./examples/ConfigurationUpdate.json" + } + }, + "description": "Updates a configuration of a server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationForUpdate" + }, + "description": "The required parameters for updating a server configuration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "put": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Put", + "x-ms-examples": { + "Update a user configuration": { + "$ref": "./examples/ConfigurationUpdate.json" + } + }, + "description": "Updates a configuration of a server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Configuration" + }, + "description": "The required parameters for updating a server configuration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "ConfigurationProperties": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "Value of the configuration. Required to update the configuration." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "Description of the configuration." + }, + "defaultValue": { + "type": "string", + "readOnly": true, + "description": "Default value of the configuration." + }, + "dataType": { + "type": "string", + "readOnly": true, + "description": "Data type of the configuration.", + "enum": [ + "Boolean", + "Numeric", + "Integer", + "Enumeration" + ], + "x-ms-enum": { + "name": "ConfigurationDataType", + "modelAsString": true + } + }, + "allowedValues": { + "type": "string", + "readOnly": true, + "description": "Allowed values of the configuration." + }, + "source": { + "type": "string", + "description": "Source of the configuration. Required to update the configuration." + }, + "isDynamicConfig": { + "type": "boolean", + "readOnly": true, + "description": "Configuration dynamic or static." + }, + "isReadOnly": { + "type": "boolean", + "readOnly": true, + "description": "Configuration read-only or not." + }, + "isConfigPendingRestart": { + "type": "boolean", + "readOnly": true, + "description": "Configuration is pending restart or not." + }, + "unit": { + "type": "string", + "readOnly": true, + "description": "Configuration unit." + }, + "documentationLink": { + "type": "string", + "readOnly": true, + "description": "Configuration documentation link." + } + }, + "description": "The properties of a configuration." + }, + "Configuration": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ConfigurationProperties", + "x-ms-client-flatten": true, + "description": "The properties of a configuration." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "description": "Represents a Configuration." + }, + "ConfigurationForUpdate": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ConfigurationProperties", + "x-ms-client-flatten": true, + "description": "The properties of a configuration." + } + }, + "description": "Represents a Configuration." + }, + "ConfigurationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Configuration" + }, + "description": "The list of server configurations." + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of server configurations." + } + }, + "parameters": { + "ConfigurationNameParameter": { + "name": "configurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the server configuration.", + "minLength": 1, + "pattern": "^[-\\w\\._]+$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Databases.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Databases.json new file mode 100644 index 000000000000..c95fce456bae --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Databases.json @@ -0,0 +1,317 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "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.DBforPostgreSQL/flexibleServers/{serverName}/databases/{databaseName}": { + "put": { + "tags": [ + "Databases" + ], + "operationId": "Databases_Create", + "x-ms-examples": { + "Create a database": { + "$ref": "./examples/DatabaseCreate.json" + } + }, + "description": "Creates a new database or updates an existing database.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Database" + }, + "description": "The required parameters for creating or updating a database." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Databases" + ], + "operationId": "Databases_Delete", + "x-ms-examples": { + "Delete a database": { + "$ref": "./examples/DatabaseDelete.json" + } + }, + "description": "Deletes a database.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Databases" + ], + "operationId": "Databases_Get", + "x-ms-examples": { + "Get a database": { + "$ref": "./examples/DatabaseGet.json" + } + }, + "description": "Gets information about a database.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/databases": { + "get": { + "tags": [ + "Databases" + ], + "operationId": "Databases_ListByServer", + "x-ms-examples": { + "List databases in a server": { + "$ref": "./examples/DatabasesListByServer.json" + } + }, + "description": "List all the databases in a given server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DatabaseListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "DatabaseProperties": { + "type": "object", + "properties": { + "charset": { + "type": "string", + "description": "The charset of the database.", + "pattern": "^[a-zA-Z]+\\w*$" + }, + "collation": { + "type": "string", + "description": "The collation of the database.", + "pattern": "^[a-zA-Z\\-]+([. ]|\\w)*$" + } + }, + "description": "The properties of a database." + }, + "Database": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/DatabaseProperties", + "x-ms-client-flatten": true, + "description": "The properties of a database." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "description": "Represents a Database." + }, + "DatabaseListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Database" + }, + "description": "The list of databases housed in a server" + }, + "nextLink": { + "description": "The link used to get the next page of databases.", + "type": "string", + "format": "uri" + } + }, + "description": "A List of databases." + } + }, + "parameters": { + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database.", + "minLength": 1, + "pattern": "^[-\\w\\._]+$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/FirewallRules.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/FirewallRules.json new file mode 100644 index 000000000000..0717265eca1c --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/FirewallRules.json @@ -0,0 +1,323 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "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.DBforPostgreSQL/flexibleServers/{serverName}/firewallRules/{firewallRuleName}": { + "put": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_CreateOrUpdate", + "x-ms-examples": { + "FirewallRuleCreate": { + "$ref": "./examples/FirewallRuleCreate.json" + } + }, + "description": "Creates a new firewall rule or updates an existing firewall rule.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/FirewallRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FirewallRule" + }, + "description": "The required parameters for creating or updating a firewall rule." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_Delete", + "x-ms-examples": { + "FirewallRuleDelete": { + "$ref": "./examples/FirewallRuleDelete.json" + } + }, + "description": "Deletes a PostgreSQL server firewall rule.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/FirewallRuleNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_Get", + "x-ms-examples": { + "FirewallRuleList": { + "$ref": "./examples/FirewallRuleGet.json" + } + }, + "description": "List all the firewall rules in a given server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/FirewallRuleNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/firewallRules": { + "get": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_ListByServer", + "x-ms-examples": { + "FirewallRuleList": { + "$ref": "./examples/FirewallRuleListByServer.json" + } + }, + "description": "List all the firewall rules in a given PostgreSQL server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FirewallRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "FirewallRuleProperties": { + "type": "object", + "properties": { + "startIpAddress": { + "type": "string", + "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$", + "description": "The start IP address of the server firewall rule. Must be IPv4 format." + }, + "endIpAddress": { + "type": "string", + "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$", + "description": "The end IP address of the server firewall rule. Must be IPv4 format." + } + }, + "required": [ + "startIpAddress", + "endIpAddress" + ], + "description": "The properties of a server firewall rule." + }, + "FirewallRule": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FirewallRuleProperties", + "x-ms-client-flatten": true, + "description": "The properties of a firewall rule." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "required": [ + "properties" + ], + "description": "Represents a server firewall rule." + }, + "FirewallRuleListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FirewallRule" + }, + "description": "The list of firewall rules in a server." + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of firewall rules." + } + }, + "parameters": { + "FirewallRuleNameParameter": { + "name": "firewallRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the server firewall rule.", + "minLength": 1, + "pattern": "^[-\\w\\._]+$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/FlexibleServers.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/FlexibleServers.json new file mode 100644 index 000000000000..6248c0441bd2 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/FlexibleServers.json @@ -0,0 +1,1211 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "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.DBforPostgreSQL/flexibleServers/{serverName}": { + "put": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Create", + "x-ms-examples": { + "Create a new server": { + "$ref": "./examples/ServerCreate.json" + }, + "Create a new server with active directory authentication enabled": { + "$ref": "./examples/ServerCreateWithAadAuthEnabled.json" + }, + "ServerCreateWithDataEncryptionEnabled": { + "$ref": "./examples/ServerCreateWithDataEncryptionEnabled.json" + }, + "Create a database as a point in time restore": { + "$ref": "./examples/ServerCreatePointInTimeRestore.json" + }, + "Create a database as a geo-restore in geo-paired location": { + "$ref": "./examples/ServerCreateGeoRestoreWithDataEncryptionEnabled.json" + }, + "ServerCreateReplica": { + "$ref": "./examples/ServerCreateReplica.json" + }, + "ServerCreateReviveDropped": { + "$ref": "./examples/ServerCreateReviveDropped.json" + } + }, + "description": "Creates a new server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Server" + }, + "description": "The required parameters for creating or updating a server." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Update", + "x-ms-examples": { + "ServerUpdate": { + "$ref": "./examples/ServerUpdate.json" + }, + "ServerUpdateWithAadAuthEnabled": { + "$ref": "./examples/ServerUpdateWithAadAuthEnabled.json" + }, + "ServerUpdateWithDataEncryptionEnabled": { + "$ref": "./examples/ServerUpdateWithDataEncryptionEnabled.json" + }, + "ServerUpdateWithCustomerMaintenanceWindow": { + "$ref": "./examples/ServerUpdateWithCustomerMaintenanceWindow.json" + }, + "ServerUpdateWithMajorVersionUpgrade": { + "$ref": "./examples/ServerUpdateWithMajorVersionUpgrade.json" + }, + "Promote a replica server as a Standalone server as planned, i.e. it will wait for replication to complete.": { + "$ref": "./examples/PromoteReplicaAsPlannedStandaloneServer.json" + }, + "Promote a replica server as a Standalone server as forced, i.e. it will promote a replica server immediately without waiting for primary and replica to be in sync.": { + "$ref": "./examples/PromoteReplicaAsForcedStandaloneServer.json" + }, + "SwitchOver a replica server as planned, i.e. it will wait for replication to complete before promoting replica as Primary and original primary as replica.": { + "$ref": "./examples/PromoteReplicaAsPlannedSwitchover.json" + }, + "SwitchOver a replica server as forced, i.e. it will replica as Primary and original primary as replica immediately without waiting for primary and replica to be in sync.": { + "$ref": "./examples/PromoteReplicaAsForcedSwitchover.json" + } + }, + "description": "Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServerForUpdate" + }, + "description": "The required parameters for updating a server." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Delete", + "x-ms-examples": { + "ServerDelete": { + "$ref": "./examples/ServerDelete.json" + } + }, + "description": "Deletes a server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Get", + "x-ms-examples": { + "ServerGet": { + "$ref": "./examples/ServerGet.json" + }, + "ServerGetWithVnet": { + "$ref": "./examples/ServerGetWithVnet.json" + }, + "ServerGetWithPrivateEndpoints": { + "$ref": "./examples/ServerGetWithPrivateEndpoints.json" + } + }, + "description": "Gets information about a server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers": { + "get": { + "tags": [ + "Servers" + ], + "operationId": "Servers_ListByResourceGroup", + "x-ms-examples": { + "ServerListByResourceGroup": { + "$ref": "./examples/ServerListByResourceGroup.json" + } + }, + "description": "List all the servers in a given resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/flexibleServers": { + "get": { + "tags": [ + "Servers" + ], + "operationId": "Servers_List", + "x-ms-examples": { + "ServerList": { + "$ref": "./examples/ServerList.json" + } + }, + "description": "List all the servers in a given subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ServerVersion": { + "type": "string", + "description": "The version of a server.", + "enum": [ + "16", + "15", + "14", + "13", + "12", + "11" + ], + "x-ms-enum": { + "name": "ServerVersion", + "modelAsString": true + } + }, + "Replica": { + "type": "object", + "description": "Replica properties of a server", + "properties": { + "role": { + "$ref": "#/definitions/ReplicationRole", + "description": "Used to indicate role of the server in replication set." + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "Replicas allowed for a server.", + "readOnly": true + }, + "replicationState": { + "type": "string", + "enum": [ + "Active", + "Catchup", + "Provisioning", + "Updating", + "Broken", + "Reconfiguring" + ], + "x-ms-enum": { + "name": "ReplicationState", + "modelAsString": true + }, + "description": "Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring", + "readOnly": true + }, + "promoteMode": { + "type": "string", + "description": "Sets the promote mode for a replica server. This is a write only property.", + "enum": [ + "standalone", + "switchover" + ], + "x-ms-enum": { + "name": "ReadReplicaPromoteMode", + "modelAsString": true + }, + "x-ms-mutability": [ + "update" + ] + }, + "promoteOption": { + "type": "string", + "description": "Sets the promote options for a replica server. This is a write only property.", + "enum": [ + "planned", + "forced" + ], + "x-ms-enum": { + "name": "ReplicationPromoteOption", + "modelAsString": true + }, + "x-ms-mutability": [ + "update" + ] + } + } + }, + "ServerProperties": { + "type": "object", + "properties": { + "administratorLogin": { + "type": "string", + "description": "The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "administratorLoginPassword": { + "type": "string", + "description": "The administrator login password (required for server creation).", + "x-ms-secret": true, + "format": "password", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "version": { + "$ref": "#/definitions/ServerVersion", + "description": "PostgreSQL Server version." + }, + "minorVersion": { + "type": "string", + "description": "The minor version of the server.", + "readOnly": true + }, + "state": { + "type": "string", + "description": "A state of a server that is visible to user.", + "readOnly": true, + "enum": [ + "Ready", + "Dropping", + "Disabled", + "Starting", + "Stopping", + "Stopped", + "Updating" + ], + "x-ms-enum": { + "name": "ServerState", + "modelAsString": true + } + }, + "fullyQualifiedDomainName": { + "type": "string", + "description": "The fully qualified domain name of a server.", + "readOnly": true + }, + "storage": { + "$ref": "#/definitions/Storage", + "default": null, + "description": "Storage properties of a server." + }, + "authConfig": { + "$ref": "#/definitions/AuthConfig", + "default": null, + "description": "AuthConfig properties of a server." + }, + "dataEncryption": { + "$ref": "#/definitions/DataEncryption", + "default": null, + "description": "Data encryption properties of a server." + }, + "backup": { + "$ref": "#/definitions/Backup", + "default": null, + "description": "Backup properties of a server." + }, + "network": { + "$ref": "#/definitions/Network", + "default": null, + "description": "Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server." + }, + "highAvailability": { + "$ref": "#/definitions/HighAvailability", + "default": null, + "description": "High availability properties of a server." + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "default": null, + "description": "Maintenance window properties of a server.", + "x-ms-mutability": [ + "update", + "read" + ] + }, + "sourceServerResourceId": { + "type": "string", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + ] + }, + "description": "The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'Replica' or 'ReviveDropped'. This property is returned only for Replica server", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "pointInTimeUTC": { + "type": "string", + "format": "date-time", + "description": "Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'ReviveDropped'.", + "x-ms-mutability": [ + "create" + ] + }, + "availabilityZone": { + "type": "string", + "default": "", + "description": "availability zone information of the server.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "replicationRole": { + "$ref": "#/definitions/ReplicationRole", + "description": "Replication role of the server" + }, + "replicaCapacity": { + "type": "integer", + "format": "int32", + "description": "Replicas allowed for a server.", + "readOnly": true + }, + "replica": { + "$ref": "#/definitions/Replica", + "description": "Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "createMode": { + "type": "string", + "description": "The mode to create a new PostgreSQL server.", + "enum": [ + "Default", + "Create", + "Update", + "PointInTimeRestore", + "GeoRestore", + "Replica", + "ReviveDropped" + ], + "x-ms-enum": { + "name": "CreateMode", + "modelAsString": true + }, + "x-ms-mutability": [ + "create", + "update" + ] + }, + "privateEndpointConnections": { + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "description": "List of private endpoint connections associated with the specified resource.", + "readOnly": true + } + }, + "description": "The properties of a server." + }, + "Server": { + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU (pricing tier) of the server." + }, + "identity": { + "$ref": "#/definitions/UserAssignedIdentity", + "description": "Describes the identity of the application." + }, + "properties": { + "$ref": "#/definitions/ServerProperties", + "x-ms-client-flatten": true, + "description": "Properties of the server." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "Represents a server." + }, + "ServerPropertiesForUpdate": { + "type": "object", + "properties": { + "administratorLogin": { + "type": "string", + "description": "The administrator's login name of a server. Can only be specified when the server is trying to switch to password authentication and does not have default administrator login.", + "x-ms-mutability": [ + "update", + "read" + ] + }, + "administratorLoginPassword": { + "type": "string", + "x-ms-secret": true, + "format": "password", + "description": "The password of the administrator login.", + "x-ms-mutability": [ + "update" + ] + }, + "version": { + "$ref": "#/definitions/ServerVersion", + "description": "PostgreSQL Server version. Version 16 is currently not supported for MVU." + }, + "storage": { + "$ref": "#/definitions/Storage", + "default": null, + "description": "Storage properties of a server." + }, + "backup": { + "$ref": "#/definitions/Backup", + "default": null, + "description": "Backup properties of a server." + }, + "highAvailability": { + "$ref": "#/definitions/HighAvailability", + "default": null, + "description": "High availability properties of a server." + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "default": null, + "description": "Maintenance window properties of a server.", + "x-ms-mutability": [ + "update", + "read" + ] + }, + "authConfig": { + "$ref": "#/definitions/AuthConfig", + "default": null, + "description": "AuthConfig properties of a server." + }, + "dataEncryption": { + "$ref": "#/definitions/DataEncryption", + "default": null, + "description": "Data encryption properties of a server." + }, + "createMode": { + "type": "string", + "description": "The mode to update a new PostgreSQL server.", + "enum": [ + "Default", + "Update" + ], + "x-ms-enum": { + "name": "CreateModeForUpdate", + "modelAsString": true + }, + "x-ms-mutability": [ + "update" + ] + }, + "replicationRole": { + "$ref": "#/definitions/ReplicationRole", + "description": "Replication role of the server" + }, + "replica": { + "$ref": "#/definitions/Replica", + "description": "Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "network": { + "$ref": "#/definitions/Network", + "default": null, + "description": "Network properties of a server. These are required to be passed only in case if server is a private access server." + } + } + }, + "ServerForUpdate": { + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU (pricing tier) of the server." + }, + "identity": { + "$ref": "#/definitions/UserAssignedIdentity", + "description": "Describes the identity of the application." + }, + "properties": { + "$ref": "#/definitions/ServerPropertiesForUpdate", + "x-ms-client-flatten": true, + "description": "Properties of the server." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-specific metadata in the form of key-value pairs." + } + }, + "description": "Represents a server to be updated." + }, + "ServerListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Server" + }, + "description": "The list of flexible servers" + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of servers." + }, + "Sku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3." + }, + "tier": { + "type": "string", + "description": "The tier of the particular SKU, e.g. Burstable.", + "enum": [ + "Burstable", + "GeneralPurpose", + "MemoryOptimized" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + } + }, + "required": [ + "name", + "tier" + ], + "description": "Sku information related properties of a server." + }, + "Storage": { + "type": "object", + "properties": { + "storageSizeGB": { + "type": "integer", + "format": "int32", + "description": "Max storage allowed for a server." + }, + "autoGrow": { + "type": "string", + "description": "Flag to enable / disable Storage Auto grow for flexible server.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "StorageAutoGrow", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "Name of storage tier for IOPS.", + "enum": [ + "P1", + "P2", + "P3", + "P4", + "P6", + "P10", + "P15", + "P20", + "P30", + "P40", + "P50", + "P60", + "P70", + "P80" + ], + "x-ms-enum": { + "name": "AzureManagedDiskPerformanceTiers", + "modelAsString": true + } + }, + "iops": { + "type": "integer", + "format": "int32", + "description": "Storage tier IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS" + }, + "throughput": { + "type": "integer", + "format": "int32", + "description": "Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS" + }, + "type": { + "type": "string", + "enum": [ + "Premium_LRS", + "PremiumV2_LRS" + ], + "x-ms-enum": { + "name": "StorageType", + "modelAsString": true + }, + "description": "Storage type for the server. Allowed values are Premium_LRS and PremiumV2_LRS, and default is Premium_LRS if not specified" + } + }, + "description": "Storage properties of a server" + }, + "AuthConfig": { + "type": "object", + "properties": { + "activeDirectoryAuth": { + "type": "string", + "description": "If Enabled, Azure Active Directory authentication is enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "activeDirectoryAuthEnum", + "modelAsString": true + } + }, + "passwordAuth": { + "type": "string", + "default": "Enabled", + "description": "If Enabled, Password authentication is enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "passwordAuthEnum", + "modelAsString": true + } + }, + "tenantId": { + "type": "string", + "default": "", + "description": "Tenant id of the server." + } + }, + "description": "Authentication configuration properties of a server" + }, + "DataEncryption": { + "type": "object", + "properties": { + "primaryKeyURI": { + "type": "string", + "description": "URI for the key in keyvault for data encryption of the primary server." + }, + "primaryUserAssignedIdentityId": { + "type": "string", + "description": "Resource Id for the User assigned identity to be used for data encryption of the primary server." + }, + "geoBackupKeyURI": { + "type": "string", + "description": "URI for the key in keyvault for data encryption for geo-backup of server." + }, + "geoBackupUserAssignedIdentityId": { + "type": "string", + "description": "Resource Id for the User assigned identity to be used for data encryption for geo-backup of server." + }, + "type": { + "type": "string", + "description": "Data encryption type to depict if it is System Managed vs Azure Key vault.", + "enum": [ + "SystemManaged", + "AzureKeyVault" + ], + "x-ms-enum": { + "name": "ArmServerKeyType", + "modelAsString": true + } + }, + "primaryEncryptionKeyStatus": { + "type": "string", + "description": "Primary encryption key status for Data encryption enabled server.", + "x-ms-mutability": [ + "read" + ], + "enum": [ + "Valid", + "Invalid" + ], + "x-ms-enum": { + "name": "keyStatusEnum", + "modelAsString": true + } + }, + "geoBackupEncryptionKeyStatus": { + "type": "string", + "description": "Geo-backup encryption key status for Data encryption enabled server.", + "x-ms-mutability": [ + "read" + ], + "enum": [ + "Valid", + "Invalid" + ], + "x-ms-enum": { + "name": "keyStatusEnum", + "modelAsString": true + } + } + }, + "description": "Data encryption properties of a server" + }, + "UserIdentity": { + "description": "Describes a single user-assigned identity associated with the application.", + "type": "object", + "properties": { + "principalId": { + "type": "string", + "description": "the object identifier of the Service Principal which this identity represents." + }, + "clientId": { + "type": "string", + "description": "the client identifier of the Service Principal which this identity represents." + } + } + }, + "UserAssignedIdentityMap": { + "type": "object", + "description": "Defines a map that contains user assigned identities.", + "additionalProperties": { + "$ref": "#/definitions/UserIdentity" + } + }, + "UserAssignedIdentity": { + "type": "object", + "properties": { + "userAssignedIdentities": { + "$ref": "#/definitions/UserAssignedIdentityMap", + "description": "represents user assigned identities map." + }, + "type": { + "type": "string", + "description": "the types of identities associated with this resource; currently restricted to 'None and UserAssigned'", + "enum": [ + "None", + "UserAssigned" + ], + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": true + } + }, + "tenantId": { + "type": "string", + "description": "Tenant id of the server.", + "readOnly": true + } + }, + "required": [ + "type" + ], + "description": "Information describing the identities associated with this application." + }, + "ReplicationRole": { + "type": "string", + "description": "Used to indicate role of the server in replication set.", + "enum": [ + "None", + "Primary", + "AsyncReplica", + "GeoAsyncReplica" + ], + "x-ms-enum": { + "name": "ReplicationRole", + "modelAsString": true + } + }, + "Backup": { + "type": "object", + "properties": { + "backupRetentionDays": { + "type": "integer", + "format": "int32", + "default": 7, + "description": "Backup retention days for the server." + }, + "geoRedundantBackup": { + "type": "string", + "default": "Disabled", + "description": "A value indicating whether Geo-Redundant backup is enabled on the server.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "GeoRedundantBackupEnum", + "modelAsString": true + }, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "earliestRestoreDate": { + "type": "string", + "format": "date-time", + "description": "The earliest restore point time (ISO8601 format) for server.", + "readOnly": true + } + }, + "description": "Backup properties of a server" + }, + "Network": { + "type": "object", + "properties": { + "publicNetworkAccess": { + "type": "string", + "description": "public network access is enabled or not", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ServerPublicNetworkAccessState", + "modelAsString": true + } + }, + "delegatedSubnetResourceId": { + "type": "string", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "description": "Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone." + }, + "privateDnsZoneArmResourceId": { + "type": "string", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/privateDnsZones" + } + ] + }, + "description": "Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone." + } + }, + "description": "Network properties of a server." + }, + "HighAvailability": { + "type": "object", + "properties": { + "mode": { + "type": "string", + "default": "Disabled", + "description": "The HA mode for the server.", + "enum": [ + "Disabled", + "ZoneRedundant", + "SameZone" + ], + "x-ms-enum": { + "name": "HighAvailabilityMode", + "modelAsString": true + } + }, + "state": { + "type": "string", + "description": "A state of a HA server that is visible to user.", + "enum": [ + "NotEnabled", + "CreatingStandby", + "ReplicatingData", + "FailingOver", + "Healthy", + "RemovingStandby" + ], + "x-ms-enum": { + "name": "ServerHAState", + "modelAsString": true + }, + "readOnly": true + }, + "standbyAvailabilityZone": { + "type": "string", + "default": "", + "description": "availability zone information of the standby." + } + }, + "description": "High availability properties of a server" + }, + "MaintenanceWindow": { + "type": "object", + "description": "Maintenance window properties of a server.", + "properties": { + "customWindow": { + "type": "string", + "default": "Disabled", + "description": "indicates whether custom window is enabled or disabled" + }, + "startHour": { + "type": "integer", + "format": "int32", + "default": 0, + "description": "start hour for maintenance window" + }, + "startMinute": { + "type": "integer", + "format": "int32", + "default": 0, + "description": "start minute for maintenance window" + }, + "dayOfWeek": { + "type": "integer", + "format": "int32", + "default": 0, + "description": "day of week for maintenance window" + } + } + } + }, + "parameters": {} +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/LongTermRetentionOperation.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/LongTermRetentionOperation.json new file mode 100644 index 000000000000..7fca5b14d9bb --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/LongTermRetentionOperation.json @@ -0,0 +1,524 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "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.DBforPostgreSQL/flexibleServers/{serverName}/ltrPreBackup": { + "post": { + "description": "PreBackup operation performs all the checks that are needed for the subsequent long term retention backup operation to succeed.", + "tags": [ + "LongTermRetentionBackup" + ], + "operationId": "FlexibleServer_TriggerLtrPreBackup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/LtrPreBackupRequest" + } + } + ], + "responses": { + "200": { + "description": "Ok. API finished synchronously with Success.", + "schema": { + "$ref": "#/definitions/LtrPreBackupResponse" + }, + "headers": { + "x-ms-request-id": { + "description": "A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging.", + "type": "string" + } + } + }, + "default": { + "description": "Error Scenario 4xx/5xx", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "description": "ErrorCode string in the event of a failure.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Sample_Prebackup": { + "$ref": "./examples/LongTermRetentionPreBackup.json" + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/startLtrBackup": { + "post": { + "description": "Start the Long Term Retention Backup operation", + "tags": [ + "LongTermRetentionBackup" + ], + "operationId": "FlexibleServer_StartLtrBackup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/LtrBackupRequest" + } + } + ], + "responses": { + "200": { + "description": "Ok. API finished synchronously with Success.", + "schema": { + "$ref": "#/definitions/LtrBackupResponse" + }, + "headers": { + "x-ms-request-id": { + "description": "A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging.", + "type": "string" + } + } + }, + "202": { + "description": "Accepted.", + "headers": { + "Retry-After": { + "description": "The number of seconds to wait before checking the status of the asynchronous operation.", + "type": "integer", + "format": "int32" + }, + "x-ms-request-id": { + "description": "A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging.", + "type": "string" + }, + "Location": { + "description": "URL to retrieve the final result after operation completes.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL for checking the ongoing status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error Scenario 4xx/5xx", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "description": "ErrorCode string in the event of a failure.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Sample_ExecuteBackup": { + "$ref": "./examples/LongTermRetentionBackup.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/ltrBackupOperations/{backupName}": { + "get": { + "tags": [ + "LongTermRetentionBackup" + ], + "operationId": "ltrBackupOperations_Get", + "x-ms-examples": { + "Sample": { + "$ref": "./examples/LongTermRetentionOperationGet.json" + } + }, + "description": "Gets the result of the give long term retention backup operation for the flexible server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/BackupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LtrServerBackupOperation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/ltrBackupOperations": { + "get": { + "tags": [ + "LongTermRetentionBackup" + ], + "operationId": "ltrBackupOperations_ListByServer", + "x-ms-examples": { + "Sample List of Long Tern Retention Operations by Flexible Server": { + "$ref": "./examples/LongTermRetentionOperationListByServer.json" + } + }, + "description": "Gets the result of the give long term retention backup operations for the flexible server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LtrServerBackupOperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "BackupRequestBase": { + "description": "BackupRequestBase is the base for all backup request.", + "required": [ + "backupSettings" + ], + "type": "object", + "properties": { + "backupSettings": { + "$ref": "#/definitions/BackupSettings", + "description": "Backup Settings" + } + } + }, + "LtrBackupRequest": { + "description": "The request that is made for a long term retention backup.", + "type": "object", + "properties": { + "targetDetails": { + "$ref": "#/definitions/BackupStoreDetails", + "description": "Backup store detail for target server" + } + }, + "allOf": [ + { + "$ref": "#/definitions/BackupRequestBase" + } + ], + "required": [ + "targetDetails" + ] + }, + "LtrPreBackupRequest": { + "description": "A request that is made for pre-backup.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupRequestBase" + } + ] + }, + "BackupSettings": { + "description": "The settings for the long term backup.", + "type": "object", + "required": [ + "backupName" + ], + "properties": { + "backupName": { + "type": "string", + "description": "Backup Name for the current backup" + } + } + }, + "BackupStoreDetails": { + "description": "Details about the target where the backup content will be stored.", + "required": [ + "sasUriList" + ], + "type": "object", + "properties": { + "sasUriList": { + "description": "List of SAS uri of storage containers where backup data is to be streamed/copied.", + "type": "array", + "items": { + "type": "string", + "description": "SAS URI of Azure Storage Account Container.", + "x-ms-secret": true + } + } + } + }, + "LtrPreBackupResponseProperties": { + "description": "Response for the pre-backup request.", + "type": "object", + "required": [ + "numberOfContainers" + ], + "properties": { + "numberOfContainers": { + "format": "int32", + "description": "Number of storage containers the plugin will use during backup. More than one containers may be used for size limitations, parallelism, or redundancy etc.", + "type": "integer" + } + } + }, + "LtrBackupOperationResponseProperties": { + "description": "Response for the backup request.", + "type": "object", + "required": [ + "status", + "startTime" + ], + "properties": { + "datasourceSizeInBytes": { + "format": "int64", + "description": "Size of datasource in bytes", + "type": "integer" + }, + "dataTransferredInBytes": { + "format": "int64", + "description": "Data transferred in bytes", + "type": "integer" + }, + "backupName": { + "description": "Name of Backup operation", + "type": "string" + }, + "backupMetadata": { + "description": "Metadata to be stored in RP. Store everything that will be required to perform a successful restore using this Recovery point. e.g. Versions, DataFormat etc", + "type": "string" + }, + "status": { + "description": "Service-set extensible enum indicating the status of operation", + "enum": [ + "Running", + "Cancelled", + "Failed", + "Succeeded" + ], + "type": "string", + "x-ms-enum": { + "name": "ExecutionStatus", + "modelAsString": true + } + }, + "startTime": { + "description": "Start time of the operation.", + "format": "date-time", + "type": "string" + }, + "endTime": { + "description": "End time of the operation.", + "format": "date-time", + "type": "string" + }, + "percentComplete": { + "description": "PercentageCompleted", + "format": "double", + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "errorCode": { + "readOnly": true, + "type": "string", + "description": "The error code." + }, + "errorMessage": { + "readOnly": true, + "type": "string", + "description": "The error message." + } + } + }, + "LtrBackupResponse": { + "description": "Response for the LTR backup API call", + "type": "object", + "properties": { + "properties": { + "description": "Long Term Retention Backup Operation Resource Properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/LtrBackupOperationResponseProperties" + } + } + }, + "LtrServerBackupOperation": { + "description": "Response for the LTR backup Operation API call", + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "properties": { + "description": "Long Term Retention Backup Operation Resource Properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/LtrBackupOperationResponseProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "LtrServerBackupOperationList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LtrServerBackupOperation" + }, + "description": "The list of long term retention server backup operations" + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of long term retention backup operations for server." + }, + "LtrPreBackupResponse": { + "description": "Response for the LTR pre-backup API call", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "properties": { + "description": "Additional Properties for the pre backup response", + "x-ms-client-flatten": true, + "$ref": "#/definitions/LtrPreBackupResponseProperties" + } + } + } + }, + "parameters": { + "BackupNameParameter": { + "name": "backupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the backup.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Migrations.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Migrations.json new file mode 100644 index 000000000000..7f3e2460d0b4 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Migrations.json @@ -0,0 +1,1296 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "description": "Azure Active Directory OAuth2 Flow", + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{targetDbServerName}/migrations/{migrationName}": { + "put": { + "tags": [ + "Migrations" + ], + "operationId": "Migrations_Create", + "x-ms-examples": { + "Migrations_Create": { + "$ref": "./examples/Migrations_Create.json" + }, + "Migrations Create by passing user names": { + "$ref": "./examples/Migrations_Create_With_Other_Users.json" + }, + "Migrations Create with roles": { + "$ref": "./examples/Migrations_Create_With_Roles.json" + }, + "Migrations Create with private endpoint": { + "$ref": "./examples/Migrations_Create_With_PrivateEndpoint_Servers.json" + }, + "Create Migration with other source types for Validate and Migrate": { + "$ref": "./examples/Migrations_Create_Other_SourceTypes_Validate_Migrate.json" + }, + "Create Pre-migration Validation": { + "$ref": "./examples/Migrations_Create_Validate_Only.json" + } + }, + "description": "Creates a new migration.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TargetDbServerSubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TargetDbServerResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TargetDbServerNameParameter" + }, + { + "$ref": "#/parameters/MigrationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MigrationResource" + }, + "description": "The required parameters for creating a migration." + } + ], + "responses": { + "200": { + "description": "Successfully set or update the Migration for a server", + "schema": { + "$ref": "#/definitions/MigrationResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/MigrationResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Migrations" + ], + "operationId": "Migrations_Get", + "x-ms-examples": { + "Migrations_Get": { + "$ref": "./examples/Migrations_Get.json" + }, + "Migrations_GetMigrationWithValidationFailures": { + "$ref": "./examples/Migrations_GetMigrationWithValidationFailures.json" + }, + "Migrations_GetMigrationWithSuccessfulValidationOnly": { + "$ref": "./examples/Migrations_GetMigrationWithSuccessfulValidationOnly.json" + }, + "Migrations_GetMigrationWithSuccessfulValidationButMigrationFailure": { + "$ref": "./examples/Migrations_GetMigrationWithSuccessfulValidationButMigrationFailure.json" + }, + "Migrations_GetMigrationWithSuccessfulValidationAndMigration": { + "$ref": "./examples/Migrations_GetMigrationWithSuccessfulValidationAndMigration.json" + } + }, + "description": "Gets details of a migration.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TargetDbServerSubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TargetDbServerResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TargetDbServerNameParameter" + }, + { + "$ref": "#/parameters/MigrationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Migrations" + ], + "operationId": "Migrations_Update", + "x-ms-examples": { + "Migrations_Update": { + "$ref": "./examples/Migrations_Update.json" + }, + "Cancel migration": { + "$ref": "./examples/Migrations_Cancel.json" + } + }, + "description": "Updates an existing migration. The request body can contain one to many of the mutable properties present in the migration definition. Certain property updates initiate migration state transitions.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TargetDbServerSubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TargetDbServerResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TargetDbServerNameParameter" + }, + { + "$ref": "#/parameters/MigrationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MigrationResourceForPatch" + }, + "description": "The required parameters for updating a migration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Migrations" + ], + "operationId": "Migrations_Delete", + "x-ms-examples": { + "Migrations_Delete": { + "$ref": "./examples/Migrations_Delete.json" + } + }, + "description": "Deletes a migration.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TargetDbServerSubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TargetDbServerResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TargetDbServerNameParameter" + }, + { + "$ref": "#/parameters/MigrationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{targetDbServerName}/migrations": { + "get": { + "tags": [ + "Migrations" + ], + "operationId": "Migrations_ListByTargetServer", + "x-ms-examples": { + "Migrations_ListByTargetServer": { + "$ref": "./examples/Migrations_ListByTargetServer.json" + } + }, + "description": "List all the migrations on a given target server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TargetDbServerSubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TargetDbServerResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TargetDbServerNameParameter" + }, + { + "$ref": "#/parameters/MigrationListFilter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MigrationResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{targetDbServerName}/checkMigrationNameAvailability": { + "post": { + "summary": "Check migration name validity and availability", + "description": "This method checks whether a proposed migration name is valid and available.", + "tags": [ + "Custom operation", + "POST" + ], + "operationId": "CheckMigrationNameAvailability", + "x-ms-examples": { + "CheckMigrationNameAvailability": { + "$ref": "./examples/CheckMigrationNameAvailability.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TargetDbServerSubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TargetDbServerResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TargetDbServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MigrationNameAvailabilityResource" + }, + "description": "The required parameters for checking if a migration name is available." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationNameAvailabilityResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "MigrationResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/MigrationResourceProperties", + "description": "Migration resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "Represents a migration resource." + }, + "MigrationResourceProperties": { + "type": "object", + "properties": { + "migrationId": { + "type": "string", + "readOnly": true, + "description": "ID for migration, a GUID." + }, + "currentStatus": { + "$ref": "#/definitions/MigrationStatus", + "readOnly": true, + "description": "Current status of migration" + }, + "migrationInstanceResourceId": { + "type": "string", + "format": "arm-id", + "description": "ResourceId of the private endpoint migration instance" + }, + "migrationMode": { + "$ref": "#/definitions/MigrationMode", + "description": "There are two types of migration modes Online and Offline" + }, + "migrationOption": { + "$ref": "#/definitions/MigrationOption", + "description": "This indicates the supported Migration option for the migration" + }, + "sourceType": { + "$ref": "#/definitions/SourceType", + "description": "migration source server type : OnPremises, AWS, GCP, AzureVM, PostgreSQLSingleServer, AWS_RDS, AWS_AURORA, AWS_EC2, GCP_CloudSQL, GCP_AlloyDB, GCP_Compute, or EDB" + }, + "sslMode": { + "$ref": "#/definitions/SslMode", + "description": "SSL modes for migration. Default SSL mode for PostgreSQLSingleServer is VerifyFull and Prefer for other source types" + }, + "sourceDbServerMetadata": { + "$ref": "#/definitions/DbServerMetadata", + "readOnly": true, + "description": "Metadata of the source database server" + }, + "targetDbServerMetadata": { + "$ref": "#/definitions/DbServerMetadata", + "readOnly": true, + "description": "Metadata of the target database server" + }, + "sourceDbServerResourceId": { + "type": "string", + "description": "ResourceId of the source database server in case the sourceType is PostgreSQLSingleServer. For other source types this should be ipaddress:port@username or hostname:port@username" + }, + "sourceDbServerFullyQualifiedDomainName": { + "type": "string", + "description": "Source server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection" + }, + "targetDbServerResourceId": { + "type": "string", + "readOnly": true, + "description": "ResourceId of the source database server" + }, + "targetDbServerFullyQualifiedDomainName": { + "type": "string", + "description": "Target server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection" + }, + "secretParameters": { + "$ref": "#/definitions/MigrationSecretParameters", + "description": "Migration secret parameters" + }, + "dbsToMigrate": { + "maxItems": 50, + "type": "array", + "items": { + "type": "string" + }, + "description": "Number of databases to migrate", + "x-ms-identifiers": [] + }, + "setupLogicalReplicationOnSourceDbIfNeeded": { + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "LogicalReplicationOnSourceDbEnum", + "modelAsString": true + }, + "description": "Indicates whether to setup LogicalReplicationOnSourceDb, if needed" + }, + "overwriteDbsInTarget": { + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "OverwriteDbsInTargetEnum", + "modelAsString": true + }, + "description": "Indicates whether the databases on the target server can be overwritten, if already present. If set to False, the migration workflow will wait for a confirmation, if it detects that the database already exists." + }, + "migrationWindowStartTimeInUtc": { + "format": "date-time", + "type": "string", + "description": "Start time in UTC for migration window" + }, + "migrationWindowEndTimeInUtc": { + "format": "date-time", + "type": "string", + "description": "End time in UTC for migration window" + }, + "migrateRoles": { + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "MigrateRolesEnum", + "modelAsString": true + }, + "description": "To migrate roles and permissions we need to send this flag as True" + }, + "startDataMigration": { + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "StartDataMigrationEnum", + "modelAsString": true + }, + "description": "Indicates whether the data migration should start right away" + }, + "triggerCutover": { + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "TriggerCutoverEnum", + "modelAsString": true + }, + "description": "To trigger cutover for entire migration we need to send this flag as True" + }, + "dbsToTriggerCutoverOn": { + "type": "array", + "items": { + "type": "string" + }, + "description": "When you want to trigger cutover for specific databases send triggerCutover flag as True and database names in this array", + "x-ms-identifiers": [] + }, + "cancel": { + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "CancelEnum", + "modelAsString": true + }, + "description": "To trigger cancel for entire migration we need to send this flag as True" + }, + "dbsToCancelMigrationOn": { + "type": "array", + "items": { + "type": "string" + }, + "description": "When you want to trigger cancel for specific databases send cancel flag as True and database names in this array", + "x-ms-identifiers": [] + } + }, + "description": "Migration resource properties." + }, + "MigrationResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MigrationResource" + }, + "readOnly": true, + "description": "A list of migration resources.", + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The link used to get the next page of migrations.", + "type": "string", + "readOnly": true + } + }, + "description": "A list of migration resources." + }, + "MigrationResourceForPatch": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/MigrationResourcePropertiesForPatch", + "description": "Migration resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-specific metadata in the form of key-value pairs." + } + }, + "description": "Represents a migration resource for patch." + }, + "MigrationResourcePropertiesForPatch": { + "type": "object", + "properties": { + "sourceDbServerResourceId": { + "type": "string", + "description": "ResourceId of the source database server" + }, + "sourceDbServerFullyQualifiedDomainName": { + "type": "string", + "description": "Source server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection" + }, + "targetDbServerFullyQualifiedDomainName": { + "type": "string", + "description": "Target server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection" + }, + "secretParameters": { + "$ref": "#/definitions/MigrationSecretParameters", + "description": "Migration secret parameters" + }, + "dbsToMigrate": { + "maxItems": 50, + "type": "array", + "items": { + "type": "string" + }, + "description": "Number of databases to migrate", + "x-ms-identifiers": [] + }, + "setupLogicalReplicationOnSourceDbIfNeeded": { + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "LogicalReplicationOnSourceDbEnum", + "modelAsString": true + }, + "description": "Indicates whether to setup LogicalReplicationOnSourceDb, if needed" + }, + "overwriteDbsInTarget": { + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "OverwriteDbsInTargetEnum", + "modelAsString": true + }, + "description": "Indicates whether the databases on the target server can be overwritten, if already present. If set to False, the migration workflow will wait for a confirmation, if it detects that the database already exists." + }, + "migrationWindowStartTimeInUtc": { + "format": "date-time", + "type": "string", + "description": "Start time in UTC for migration window" + }, + "migrateRoles": { + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "MigrateRolesEnum", + "modelAsString": true + }, + "description": "To migrate roles and permissions we need to send this flag as True" + }, + "startDataMigration": { + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "StartDataMigrationEnum", + "modelAsString": true + }, + "description": "Indicates whether the data migration should start right away" + }, + "triggerCutover": { + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "TriggerCutoverEnum", + "modelAsString": true + }, + "description": "To trigger cutover for entire migration we need to send this flag as True" + }, + "dbsToTriggerCutoverOn": { + "type": "array", + "items": { + "type": "string" + }, + "description": "When you want to trigger cutover for specific databases send triggerCutover flag as True and database names in this array", + "x-ms-identifiers": [] + }, + "cancel": { + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "CancelEnum", + "modelAsString": true + }, + "description": "To trigger cancel for entire migration we need to send this flag as True" + }, + "dbsToCancelMigrationOn": { + "type": "array", + "items": { + "type": "string" + }, + "description": "When you want to trigger cancel for specific databases send cancel flag as True and database names in this array", + "x-ms-identifiers": [] + }, + "migrationMode": { + "$ref": "#/definitions/MigrationMode", + "description": "There are two types of migration modes Online and Offline" + } + }, + "description": "Migration resource properties for patch." + }, + "MigrationSecretParameters": { + "required": [ + "adminCredentials" + ], + "type": "object", + "properties": { + "adminCredentials": { + "x-ms-secret": true, + "x-ms-external": true, + "$ref": "#/definitions/AdminCredentials", + "description": "Admin credentials for source and target servers" + }, + "sourceServerUsername": { + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ], + "description": "Gets or sets the username for the source server. This user need not be an admin." + }, + "targetServerUsername": { + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ], + "description": "Gets or sets the username for the target server. This user need not be an admin." + } + }, + "description": "Migration secret parameters." + }, + "AdminCredentials": { + "type": "object", + "required": [ + "sourceServerPassword", + "targetServerPassword" + ], + "properties": { + "sourceServerPassword": { + "type": "string", + "x-ms-secret": true, + "x-ms-external": true, + "x-ms-mutability": [ + "create", + "update" + ], + "description": "Password for source server." + }, + "targetServerPassword": { + "type": "string", + "x-ms-secret": true, + "x-ms-external": true, + "x-ms-mutability": [ + "create", + "update" + ], + "description": "Password for target server." + } + }, + "description": "Server admin credentials." + }, + "DbServerMetadata": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Location of database server", + "x-ms-mutability": [ + "read" + ], + "readOnly": true + }, + "version": { + "type": "string", + "description": "Version for database engine" + }, + "storageMb": { + "format": "int32", + "type": "integer", + "description": "Storage size in MB for database server" + }, + "sku": { + "$ref": "#/definitions/ServerSku", + "description": "SKU for the database server. This object is empty for PG single server" + } + }, + "description": "Database server metadata." + }, + "MigrationDetailsLevel": { + "enum": [ + "Default", + "Summary", + "Full" + ], + "type": "string", + "description": "Migration details level.", + "x-ms-enum": { + "name": "MigrationDetailsLevel", + "modelAsString": true + } + }, + "MigrationMode": { + "enum": [ + "Offline", + "Online" + ], + "type": "string", + "description": "There are two types of migration modes Online and Offline", + "x-ms-enum": { + "name": "MigrationMode", + "modelAsString": true + } + }, + "MigrationOption": { + "enum": [ + "Validate", + "Migrate", + "ValidateAndMigrate" + ], + "type": "string", + "description": "Supported types of migration request include Validate, Migrate and ValidateAndMigrate", + "x-ms-enum": { + "name": "MigrationOption", + "modelAsString": true + } + }, + "MigrationState": { + "enum": [ + "InProgress", + "WaitingForUserAction", + "Canceled", + "Failed", + "Succeeded", + "ValidationFailed", + "CleaningUp" + ], + "type": "string", + "description": "Migration state.", + "x-ms-enum": { + "name": "MigrationState", + "modelAsString": true + } + }, + "MigrationStatus": { + "type": "object", + "properties": { + "state": { + "$ref": "#/definitions/MigrationState", + "readOnly": true, + "description": "State of migration" + }, + "error": { + "type": "string", + "readOnly": true, + "description": "Error message, if any, for the migration state" + }, + "currentSubStateDetails": { + "$ref": "#/definitions/MigrationSubStateDetails", + "readOnly": true, + "description": "Current Migration sub state details." + } + }, + "description": "Migration status." + }, + "MigrationSubState": { + "enum": [ + "PerformingPreRequisiteSteps", + "WaitingForLogicalReplicationSetupRequestOnSourceDB", + "WaitingForDBsToMigrateSpecification", + "WaitingForTargetDBOverwriteConfirmation", + "WaitingForDataMigrationScheduling", + "WaitingForDataMigrationWindow", + "MigratingData", + "WaitingForCutoverTrigger", + "CompletingMigration", + "Completed", + "CancelingRequestedDBMigrations", + "ValidationInProgress" + ], + "type": "string", + "description": "Migration sub state.", + "x-ms-enum": { + "name": "MigrationSubState", + "modelAsString": true + } + }, + "MigrationSubStateDetails": { + "type": "object", + "properties": { + "currentSubState": { + "$ref": "#/definitions/MigrationSubState", + "readOnly": true + }, + "dbDetails": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/DbMigrationStatus" + } + }, + "validationDetails": { + "$ref": "#/definitions/ValidationDetails" + } + }, + "description": "Migration sub state details." + }, + "DbMigrationStatus": { + "type": "object", + "description": "Migration status of an individual database", + "properties": { + "databaseName": { + "type": "string", + "description": "Name of the database" + }, + "migrationState": { + "type": "string", + "description": "Migration db state of an individual database", + "enum": [ + "InProgress", + "WaitingForCutoverTrigger", + "Failed", + "Canceled", + "Succeeded", + "Canceling" + ], + "x-ms-enum": { + "name": "MigrationDbState", + "modelAsString": true + } + }, + "migrationOperation": { + "type": "string", + "description": "Migration operation of an individual database" + }, + "startedOn": { + "type": "string", + "format": "date-time", + "description": "Start date-time of a migration state" + }, + "endedOn": { + "type": "string", + "format": "date-time", + "description": "End date-time of a migration state" + }, + "fullLoadQueuedTables": { + "format": "int32", + "type": "integer", + "description": "Number of tables queued for the migration of a DB" + }, + "fullLoadErroredTables": { + "format": "int32", + "type": "integer", + "description": "Number of tables errored out during the migration of a DB" + }, + "fullLoadLoadingTables": { + "format": "int32", + "type": "integer", + "description": "Number of tables loading during the migration of a DB" + }, + "fullLoadCompletedTables": { + "format": "int32", + "type": "integer", + "description": "Number of tables loaded during the migration of a DB" + }, + "cdcUpdateCounter": { + "format": "int32", + "type": "integer", + "description": "CDC update counter" + }, + "cdcDeleteCounter": { + "format": "int32", + "type": "integer", + "description": "CDC delete counter" + }, + "cdcInsertCounter": { + "format": "int32", + "type": "integer", + "description": "CDC insert counter" + }, + "appliedChanges": { + "format": "int32", + "type": "integer", + "description": "CDC applied changes counter" + }, + "incomingChanges": { + "format": "int32", + "type": "integer", + "description": "CDC incoming changes counter" + }, + "latency": { + "format": "int32", + "type": "integer", + "description": "Lag in seconds between source and target during online phase" + }, + "message": { + "type": "string", + "description": "Error message, if any, for the migration state" + } + } + }, + "ValidationDetails": { + "type": "object", + "description": "Details for the validation for migration", + "properties": { + "status": { + "$ref": "#/definitions/ValidationState" + }, + "validationStartTimeInUtc": { + "type": "string", + "format": "date-time", + "description": "Validation Start date-time in UTC" + }, + "validationEndTimeInUtc": { + "type": "string", + "format": "date-time", + "description": "Validation End date-time in UTC" + }, + "serverLevelValidationDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/ValidationSummaryItem" + }, + "description": "Details of server level validations", + "x-ms-identifiers": [] + }, + "dbLevelValidationDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/DbLevelValidationStatus" + }, + "description": "Details of server level validations", + "x-ms-identifiers": [ + "databaseName" + ] + } + } + }, + "DbLevelValidationStatus": { + "type": "object", + "description": "Validation status summary for an individual database", + "properties": { + "databaseName": { + "type": "string", + "description": "Name of the database" + }, + "startedOn": { + "type": "string", + "format": "date-time", + "description": "Start date-time of a database level validation" + }, + "endedOn": { + "type": "string", + "format": "date-time", + "description": "End date-time of a database level validation" + }, + "summary": { + "type": "array", + "items": { + "$ref": "#/definitions/ValidationSummaryItem" + }, + "description": "Summary of database level validations", + "x-ms-identifiers": [] + } + } + }, + "ValidationSummaryItem": { + "type": "object", + "description": "Validation summary object", + "properties": { + "type": { + "type": "string", + "description": "Validation type" + }, + "state": { + "$ref": "#/definitions/ValidationState" + }, + "messages": { + "type": "array", + "items": { + "$ref": "#/definitions/ValidationMessage" + }, + "description": "Validation messages", + "x-ms-identifiers": [] + } + } + }, + "ValidationMessage": { + "type": "object", + "description": "Validation message object", + "properties": { + "state": { + "$ref": "#/definitions/ValidationState", + "description": "Severity of validation message" + }, + "message": { + "type": "string", + "description": "Validation message string" + } + } + }, + "ValidationState": { + "type": "string", + "description": "Validation status for migration", + "enum": [ + "Failed", + "Succeeded", + "Warning" + ], + "x-ms-enum": { + "name": "ValidationState", + "modelAsString": true + } + }, + "SourceType": { + "enum": [ + "OnPremises", + "AWS", + "GCP", + "AzureVM", + "PostgreSQLSingleServer", + "AWS_RDS", + "AWS_AURORA", + "AWS_EC2", + "GCP_CloudSQL", + "GCP_AlloyDB", + "GCP_Compute", + "EDB" + ], + "type": "string", + "description": "Migration source server type : OnPremises, AWS, GCP, AzureVM, PostgreSQLSingleServer, AWS_RDS, AWS_AURORA, AWS_EC2, GCP_CloudSQL, GCP_AlloyDB, GCP_Compute, or EDB", + "x-ms-enum": { + "name": "SourceType", + "modelAsString": true + } + }, + "SslMode": { + "enum": [ + "Prefer", + "Require", + "VerifyCA", + "VerifyFull" + ], + "type": "string", + "description": "Supported SSL modes for migration. VerifyFull is the recommended SSL mode for Single server migration. Prefer, Require are recommended SSL modes for other source types", + "x-ms-enum": { + "name": "SslMode", + "modelAsString": true + } + }, + "ServerSku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3." + }, + "tier": { + "type": "string", + "description": "The tier of the particular SKU, e.g. Burstable.", + "enum": [ + "Burstable", + "GeneralPurpose", + "MemoryOptimized" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + } + }, + "description": "Sku information related properties of a server." + }, + "MigrationNameAvailabilityReason": { + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "description": "Migration name availability reason.", + "x-ms-enum": { + "name": "MigrationNameAvailabilityReason", + "modelAsString": true + } + }, + "MigrationNameAvailabilityResource": { + "required": [ + "name", + "type" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The resource name to verify." + }, + "type": { + "type": "string", + "description": "The type of the resource." + }, + "nameAvailable": { + "type": "boolean", + "description": "Indicates whether the resource name is available.", + "readOnly": true + }, + "reason": { + "$ref": "#/definitions/MigrationNameAvailabilityReason", + "description": "Migration name availability reason", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Migration name availability message.", + "readOnly": true + } + }, + "description": "Represents a migration name's availability." + } + }, + "parameters": { + "TargetDbServerSubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription ID of the target database server.", + "pattern": "([a-z0-9]){8,8}[-]([a-z0-9]){4,4}[-]([a-z0-9]){4,4}[-]([a-z0-9]){4,4}[-]([a-z0-9]){12,12}", + "x-ms-parameter-location": "method" + }, + "TargetDbServerResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the target database server.", + "pattern": "^[-a-z0-9A-Z._()]+[^.]$", + "x-ms-parameter-location": "method" + }, + "TargetDbServerNameParameter": { + "name": "targetDbServerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the target database server.", + "pattern": "([-a-z0-9]){3,63}", + "x-ms-parameter-location": "method" + }, + "MigrationNameParameter": { + "name": "migrationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the migration.", + "pattern": "^[a-z][a-z0-9]*$", + "x-ms-parameter-location": "method" + }, + "MigrationListFilter": { + "name": "migrationListFilter", + "in": "query", + "required": false, + "enum": [ + "Active", + "All" + ], + "type": "string", + "description": "Migration list filter. Retrieves either active migrations or all migrations.", + "x-ms-enum": { + "name": "MigrationListFilter", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Operations.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Operations.json new file mode 100644 index 000000000000..01d625da13f3 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Operations.json @@ -0,0 +1,164 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "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.DBforPostgreSQL/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "OperationList": { + "$ref": "./examples/OperationList.json" + } + }, + "description": "Lists all of the available REST API operations.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "OperationDisplay": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "readOnly": true, + "description": "Operation resource provider name." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "Resource on which the operation is performed." + }, + "operation": { + "type": "string", + "readOnly": true, + "description": "Localized friendly name for the operation." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "Operation description." + } + }, + "description": "Display metadata associated with the operation." + }, + "Operation": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the operation being performed on this particular object." + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "readOnly": true, + "description": "The localized display information for this particular operation or action." + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "origin": { + "type": "string", + "readOnly": true, + "description": "The intended executor of the operation.", + "enum": [ + "NotSpecified", + "user", + "system" + ], + "x-ms-enum": { + "name": "OperationOrigin", + "modelAsString": true + } + }, + "properties": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "readOnly": true, + "x-ms-client-flatten": false, + "description": "Additional descriptions for the operation." + } + }, + "description": "REST API operation definition." + }, + "OperationListResult": { + "description": "A list of resource provider operations.", + "type": "object", + "properties": { + "value": { + "description": "Collection of available operation details", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "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" + } + } + } + }, + "parameters": {} +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateDnsZone.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateDnsZone.json new file mode 100644 index 000000000000..8a8e8ea82d6d --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateDnsZone.json @@ -0,0 +1,77 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-01", + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model." + }, + "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.DBforPostgreSQL/getPrivateDnsZoneSuffix": { + "post": { + "tags": [ + "GetPrivateDnsZoneSuffix" + ], + "operationId": "GetPrivateDnsZoneSuffix_Execute", + "x-ms-examples": { + "GetPrivateDnsZoneSuffix": { + "$ref": "./examples/GetPrivateDnsZoneSuffix.json" + } + }, + "description": "Get private DNS zone suffix in the cloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateDnsZoneSuffix" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "PrivateDnsZoneSuffix": { + "type": "string", + "description": "Represents a resource name availability." + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateEndpointConnections.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateEndpointConnections.json new file mode 100644 index 000000000000..def9b6815c9b --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateEndpointConnections.json @@ -0,0 +1,270 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "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.DBforPostgreSQL/flexibleServers/{serverName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Gets a private endpoint connection.", + "operationId": "PrivateEndpointConnections_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/PrivateEndpointConnectionNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a specified private endpoint connection.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/PrivateEndpointConnectionGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Approve or reject a private endpoint connection with a given name.", + "operationId": "PrivateEndpointConnection_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "description": "The required parameters for updating private endpoint connection." + } + ], + "responses": { + "200": { + "description": "Successfully approved or rejected private endpoint connection.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "Successfully approved or rejected private endpoint connection.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Approve or reject a private endpoint connection with a given name.": { + "$ref": "./examples/PrivateEndpointConnectionUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Deletes a private endpoint connection with a given name.", + "operationId": "PrivateEndpointConnection_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/PrivateEndpointConnectionNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Deletes a private endpoint connection with a given name.": { + "$ref": "./examples/PrivateEndpointConnectionDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Gets all private endpoint connections on a server.", + "operationId": "PrivateEndpointConnections_ListByServer", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private endpoint connections.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets list of private endpoint connections on a server.": { + "$ref": "./examples/PrivateEndpointConnectionList.json" + } + } + } + } + }, + "definitions": { + "PrivateEndpointConnectionListResult": { + "description": "A list of private endpoint connections.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "nextLink": { + "description": "The URL to get the next set of results.", + "type": "string", + "format": "uri", + "readOnly": true + } + } + } + }, + "parameters": {} +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateLinkResources.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateLinkResources.json new file mode 100644 index 000000000000..9e188d7a5e44 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateLinkResources.json @@ -0,0 +1,155 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "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.DBforPostgreSQL/flexibleServers/{serverName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "description": "Gets the private link resources for PostgreSQL server.", + "operationId": "PrivateLinkResources_ListByServer", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets private link resources for PostgreSQL.": { + "$ref": "./examples/PrivateLinkResourcesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/privateLinkResources/{groupName}": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "description": "Gets a private link resource for PostgreSQL server.", + "operationId": "PrivateLinkResources_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "name": "groupName", + "in": "path", + "description": "The name of the private link resource.", + "required": true, + "type": "string", + "pattern": "^.*$" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets a private link resource for PostgreSQL.": { + "$ref": "./examples/PrivateLinkResourcesGet.json" + } + } + } + } + }, + "definitions": { + "PrivateLinkResourceListResult": { + "description": "A list of private link resources", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateLinkResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": {} +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Replicas.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Replicas.json new file mode 100644 index 000000000000..89ea828d91f7 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Replicas.json @@ -0,0 +1,83 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "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.DBforPostgreSQL/flexibleServers/{serverName}/replicas": { + "get": { + "tags": [ + "Replicas" + ], + "operationId": "Replicas_ListByServer", + "x-ms-examples": { + "ReplicasListByServer": { + "$ref": "./examples/ReplicasListByServer.json" + } + }, + "description": "List all the replicas for a given server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./FlexibleServers.json#/definitions/ServerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/ServerLogs.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/ServerLogs.json new file mode 100644 index 000000000000..35221ee855db --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/ServerLogs.json @@ -0,0 +1,148 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "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.DBforPostgreSQL/flexibleServers/{serverName}/logFiles": { + "get": { + "tags": [ + "LogFiles" + ], + "operationId": "LogFiles_ListByServer", + "x-ms-examples": { + "List all server log files for a server": { + "$ref": "./examples/LogFilesListByServer.json" + } + }, + "description": "List all the server log files in a given server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogFileListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "LogFileProperties": { + "type": "object", + "properties": { + "createdTime": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp of the log file." + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "description": "Last modified timestamp of the log file." + }, + "sizeInKb": { + "type": "integer", + "format": "int64", + "description": "The size in kb of the logFile." + }, + "type": { + "type": "string", + "description": "Type of the log file." + }, + "url": { + "type": "string", + "description": "The url to download the log file from." + } + }, + "description": "The properties of a logFile." + }, + "LogFile": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/LogFileProperties", + "x-ms-client-flatten": true, + "description": "The properties of a logFile." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "description": "Represents a logFile." + }, + "LogFileListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LogFile" + }, + "description": "The list of logFiles in a server" + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A List of logFiles." + } + }, + "parameters": {} +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/ServerStartStopRestart.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/ServerStartStopRestart.json new file mode 100644 index 000000000000..edffb5872aba --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/ServerStartStopRestart.json @@ -0,0 +1,229 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "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.DBforPostgreSQL/flexibleServers/{serverName}/restart": { + "post": { + "tags": [ + "ServerRestart" + ], + "operationId": "Servers_Restart", + "x-ms-examples": { + "ServerRestart": { + "$ref": "./examples/ServerRestart.json" + }, + "ServerRestartWithFailover": { + "$ref": "./examples/ServerRestartWithFailover.json" + } + }, + "description": "Restarts a server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "schema": { + "$ref": "#/definitions/RestartParameter" + }, + "description": "The parameters for restarting a server." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/start": { + "post": { + "tags": [ + "ServerStart" + ], + "operationId": "Servers_Start", + "x-ms-examples": { + "ServerStart": { + "$ref": "./examples/ServerStart.json" + } + }, + "description": "Starts a server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/stop": { + "post": { + "tags": [ + "ServerStop" + ], + "operationId": "Servers_Stop", + "x-ms-examples": { + "ServerStop": { + "$ref": "./examples/ServerStop.json" + } + }, + "description": "Stops a server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "RestartParameter": { + "type": "object", + "properties": { + "restartWithFailover": { + "type": "boolean", + "description": "Indicates whether to restart the server with failover." + }, + "failoverMode": { + "type": "string", + "description": "Failover mode.", + "enum": [ + "PlannedFailover", + "ForcedFailover", + "PlannedSwitchover", + "ForcedSwitchover" + ], + "x-ms-enum": { + "name": "FailoverMode", + "modelAsString": true + } + } + }, + "description": "Represents server restart parameters." + } + }, + "parameters": {} +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/ThreatProtection.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/ThreatProtection.json new file mode 100644 index 000000000000..63e17023e7b7 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/ThreatProtection.json @@ -0,0 +1,280 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, administrators, log files, configurations, migrations, advanced threat protection settings with new business model.", + "version": "2024-08-01" + }, + "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.DBforPostgreSQL/flexibleServers/{serverName}/advancedThreatProtectionSettings": { + "get": { + "tags": [ + "AdvancedThreatProtectionSettings" + ], + "description": "Get a list of server's Threat Protection state.", + "operationId": "ServerThreatProtectionSettings_ListByServer", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the server threat detection policy.", + "schema": { + "$ref": "#/definitions/ServerThreatProtectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation of advanced threat protection on the flexible server failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a server's Advanced Threat Protection settings": { + "$ref": "./examples/ServerThreatProtectionSettingsListByServer.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/advancedThreatProtectionSettings/{threatProtectionName}": { + "get": { + "tags": [ + "AdvancedThreatProtectionSettings" + ], + "description": "Get a server's Advanced Threat Protection settings.", + "operationId": "ServerThreatProtectionSettings_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/ThreatProtectionNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the server advanced threat protection settings.", + "schema": { + "$ref": "#/definitions/ServerThreatProtectionSettingsModel" + } + }, + "default": { + "description": "Error response describing why the operation of threat protection on the flexible server failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a server's Threat Protection settings": { + "$ref": "./examples/ServerThreatProtectionSettingsGet.json" + } + } + }, + "put": { + "tags": [ + "AdvancedThreatProtectionSettings" + ], + "description": "Creates or updates a server's Advanced Threat Protection settings.", + "operationId": "ServerThreatProtectionSettings_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/ThreatProtectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The Advanced Threat Protection state for the flexible server.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerThreatProtectionSettingsModel" + } + } + ], + "responses": { + "200": { + "description": "Successfully set or update the server Threat Protection settings.", + "schema": { + "$ref": "#/definitions/ServerThreatProtectionSettingsModel" + } + }, + "default": { + "description": "Error response describing why the operation of setting Threat Protection failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + }, + "201": { + "description": "Successfully created the server Threat Protection settings.", + "schema": { + "$ref": "#/definitions/ServerThreatProtectionSettingsModel" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Update a server's Threat Protection settings": { + "$ref": "./examples/ServerThreatProtectionSettingsCreateOrUpdate.json" + } + } + } + } + }, + "definitions": { + "ServerThreatProtectionProperties": { + "description": "Properties of server Threat Protection state.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "state": { + "description": "Specifies the state of the Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific server.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "ThreatProtectionState", + "modelAsString": false + } + }, + "creationTime": { + "format": "date-time", + "description": "Specifies the UTC creation time of the policy.", + "type": "string", + "readOnly": true + } + } + }, + "ServerThreatProtectionSettingsModel": { + "description": "Server's Advanced Threat Protection settings.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ServerThreatProtectionProperties", + "description": "Advanced Threat Protection properties.", + "x-ms-client-flatten": true + } + } + }, + "ServerThreatProtectionListResult": { + "description": "A list of the server's Advanced Threat Protection settings.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ServerThreatProtectionSettingsModel" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "ThreatProtectionNameParameter": { + "name": "threatProtectionName", + "in": "path", + "description": "The name of the Threat Protection state.", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "ThreatProtectionName", + "modelAsString": true + }, + "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/VirtualEndpoints.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/VirtualEndpoints.json new file mode 100644 index 000000000000..5795994b6d8f --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/VirtualEndpoints.json @@ -0,0 +1,403 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "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.DBforPostgreSQL/flexibleServers/{serverName}/virtualendpoints/{virtualEndpointName}": { + "put": { + "tags": [ + "VirtualEndpoints" + ], + "operationId": "VirtualEndpoints_Create", + "x-ms-examples": { + "Create a new virtual endpoint for a flexible server": { + "$ref": "./examples/VirtualEndpointCreate.json" + } + }, + "description": "Creates a new virtual endpoint for PostgreSQL flexible server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/VirtualEndpointNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualEndpointResource" + }, + "description": "The required parameters for creating or updating virtual endpoints." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualEndpointResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualEndpointResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "VirtualEndpoints" + ], + "operationId": "VirtualEndpoints_Update", + "x-ms-examples": { + "Update a virtual endpoint for a server to update the ": { + "$ref": "./examples/VirtualEndpointUpdate.json" + } + }, + "description": "Updates an existing virtual endpoint. The request body can contain one to many of the properties present in the normal virtual endpoint definition.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/VirtualEndpointNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualEndpointResourceForPatch" + }, + "description": "The required parameters for updating a server." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualEndpointResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "VirtualEndpoints" + ], + "operationId": "VirtualEndpoints_Delete", + "x-ms-examples": { + "Delete a virtual endpoint": { + "$ref": "./examples/VirtualEndpointDelete.json" + } + }, + "description": "Deletes a virtual endpoint.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/VirtualEndpointNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "VirtualEndpoints" + ], + "operationId": "VirtualEndpoints_Get", + "x-ms-examples": { + "Get a virtual endpoint": { + "$ref": "./examples/VirtualEndpointsGet.json" + } + }, + "description": "Gets information about a virtual endpoint.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/VirtualEndpointNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualEndpointResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/virtualendpoints": { + "get": { + "tags": [ + "VirtualEndpoints" + ], + "operationId": "VirtualEndpoints_ListByServer", + "x-ms-examples": { + "VirtualEndpointListByServer": { + "$ref": "./examples/VirtualEndpointsListByServer.json" + } + }, + "description": "List all the servers in a given resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualEndpointsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "VirtualEndpointResourceProperties": { + "type": "object", + "properties": { + "endpointType": { + "type": "string", + "description": "The endpoint type for the virtual endpoint.", + "enum": [ + "ReadWrite" + ], + "x-ms-enum": { + "name": "VirtualEndpointType", + "modelAsString": true + } + }, + "members": { + "type": "array", + "items": { + "type": "string", + "description": "Member for the virtual endpoint." + }, + "description": "List of members for a virtual endpoint" + }, + "virtualEndpoints": { + "type": "array", + "items": { + "type": "string", + "description": "Virtual endpoint for a server." + }, + "description": "List of virtual endpoints for a server", + "readOnly": true + } + }, + "description": "The properties of a virtual endpoint." + }, + "VirtualEndpointResource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/VirtualEndpointResourceForPatch" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "description": "Represents a virtual endpoint for a server." + }, + "VirtualEndpointResourceForPatch": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualEndpointResourceProperties", + "x-ms-client-flatten": true, + "description": "Properties of the virtual endpoint resource." + } + }, + "description": "Represents a virtual endpoint for a server." + }, + "VirtualEndpointsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualEndpointResource" + }, + "description": "The list of virtual endpoints" + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of virtual endpoints." + } + }, + "parameters": { + "VirtualEndpointNameParameter": { + "name": "virtualEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual endpoint.", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]{0,62}(?<!-)$", + "minLength": 3, + "maxLength": 63, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/VirtualNetwork.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/VirtualNetwork.json new file mode 100644 index 000000000000..ea74116c1885 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/VirtualNetwork.json @@ -0,0 +1,142 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "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.DBforPostgreSQL/locations/{locationName}/checkVirtualNetworkSubnetUsage": { + "post": { + "tags": [ + "VirtualNetworkSubnetUsage" + ], + "operationId": "VirtualNetworkSubnetUsage_Execute", + "x-ms-examples": { + "VirtualNetworkSubnetUsageList": { + "$ref": "./examples/VirtualNetworkSubnetUsage.json" + } + }, + "description": "Get virtual network subnet usage for a given vNet resource id.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/LocationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkSubnetUsageParameter" + }, + "description": "The required parameters for creating or updating a server." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualNetworkSubnetUsageResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "VirtualNetworkSubnetUsageParameter": { + "type": "object", + "properties": { + "virtualNetworkArmResourceId": { + "type": "string", + "description": "Virtual network resource id." + } + }, + "description": "Virtual network subnet usage parameter" + }, + "VirtualNetworkSubnetUsageResult": { + "type": "object", + "properties": { + "delegatedSubnetsUsage": { + "type": "array", + "items": { + "$ref": "#/definitions/DelegatedSubnetUsage" + }, + "readOnly": true, + "x-ms-identifiers": [ + "subnetName" + ] + }, + "location": { + "type": "string", + "readOnly": true, + "description": "location of the delegated subnet usage" + }, + "subscriptionId": { + "type": "string", + "readOnly": true, + "description": "subscriptionId of the delegated subnet usage" + } + }, + "description": "Virtual network subnet usage data." + }, + "DelegatedSubnetUsage": { + "type": "object", + "properties": { + "subnetName": { + "type": "string", + "readOnly": true, + "description": "Name of the delegated subnet for which IP addresses are in use" + }, + "usage": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Number of IP addresses used by the delegated subnet" + } + }, + "description": "Delegated subnet usage data." + } + }, + "parameters": {} +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorAdd.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorAdd.json new file mode 100644 index 000000000000..a534fb4567e6 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorAdd.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "objectId": "oooooooo-oooo-oooo-oooo-oooooooooooo", + "parameters": { + "properties": { + "tenantId": "tttttttt-tttt-tttt-tttt-tttttttttttt", + "principalType": "User", + "principalName": "testuser1@microsoft.com" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "principalType": "User", + "principalName": "testuser1@microsoft.com", + "objectId": "oooooooo-oooo-oooo-oooo-oooooooooooo" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/administrators/oooooooo-oooo-oooo-oooo-oooooooooooo", + "name": "testuser1@microsoft.com", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/administrators" + } + }, + "201": { + "body": { + "properties": { + "principalType": "User", + "principalName": "testuser1@microsoft.com", + "objectId": "oooooooo-oooo-oooo-oooo-oooooooooooo" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/administrators/oooooooo-oooo-oooo-oooo-oooooooooooo", + "name": "testuser1@microsoft.com", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/administrators" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorDelete.json new file mode 100644 index 000000000000..0887c138a662 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "objectId": "oooooooo-oooo-oooo-oooo-oooooooooooo" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + }, + "204": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorGet.json new file mode 100644 index 000000000000..caac178f3a67 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "serverName": "pgtestsvc1", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "objectId": "oooooooo-oooo-oooo-oooo-oooooooooooo" + }, + "responses": { + "200": { + "body": { + "properties": { + "principalType": "User", + "principalName": "testuer1@microsoft.com", + "objectId": "oooooooo-oooo-oooo-oooo-oooooooooooo", + "tenantId": "tttttttt-tttt-tttt-tttt-tttttttttttt" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1/administrators/oooooooo-oooo-oooo-oooo-oooooooooooo", + "name": "testuser1@microsoft.com", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/administrators" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorsListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorsListByServer.json new file mode 100644 index 000000000000..ee0bd6ba8efe --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorsListByServer.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "serverName": "pgtestsvc1", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "principalType": "User", + "principalName": "testuer1@microsoft.com", + "objectId": "oooooooo-oooo-oooo-oooo-oooooooooooo", + "tenantId": "tttttttt-tttt-tttt-tttt-tttttttttttt" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1/administrators/oooooooo-oooo-oooo-oooo-oooooooooooo", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/administrators" + }, + { + "properties": { + "principalType": "Group", + "principalName": "testgroup1@microsoft.com", + "objectId": "gggggggg-gggg-gggg-gggg-gggggggggggg", + "tenantId": "tttttttt-tttt-tttt-tttt-tttttttttttt" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1/administrators/gggggggg-gggg-gggg-gggg-gggggggggggg", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/administrators" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupCreate.json new file mode 100644 index 000000000000..75a019877eba --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupCreate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "backupName": "backup_20210615T160516", + "serverName": "postgresqltestserver", + "resourceGroupName": "TestGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "properties": { + "backupType": "Customer On-Demand", + "source": "Customer Initiated", + "completedTime": "2021-06-15T16:05:19.902522+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestserver/backups/backup_20210615T160516", + "name": "backup_20210615T160516", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/backups" + } + }, + "201": { + "body": { + "properties": { + "backupType": "Customer On-Demand", + "source": "Customer Initiated", + "completedTime": "2021-06-15T16:05:19.902522+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestserver/backups/backup_20210615T160516", + "name": "backup_20210615T160516", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/backups" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupDelete.json new file mode 100644 index 000000000000..d814e23ead0c --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "backupName": "backup_20210615T160516", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + }, + "204": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupGet.json new file mode 100644 index 000000000000..c15882d0a1a0 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "backupName": "daily_20210615T160516", + "serverName": "postgresqltestserver", + "resourceGroupName": "TestGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "properties": { + "backupType": "Full", + "source": "Automatic", + "completedTime": "2021-06-15T16:05:19.902522+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestserver/backups/daily_20210615T160516", + "name": "daily_20210615T160516", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/backups" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupListByServer.json new file mode 100644 index 000000000000..5baf3cd77779 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupListByServer.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "serverName": "postgresqltestserver", + "resourceGroupName": "TestGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "backupType": "Full", + "source": "Automatic", + "completedTime": "2021-06-15T16:05:19.902522+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestserver/backups/daily_20210615T160516", + "name": "daily_20210615T160516", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "Full", + "source": "Automatic", + "completedTime": "2021-06-16T16:05:23.9243453+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestserver/backups/daily_20210616T160520", + "name": "daily_20210616T160520", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "Full", + "source": "Automatic", + "completedTime": "2021-06-17T16:05:28.1247488+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestserver/backups/daily_20210617T160525", + "name": "daily_20210617T160525", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "Full", + "source": "Automatic", + "completedTime": "2021-06-18T16:05:32.2736701+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestserver/backups/daily_20210618T160529", + "name": "daily_20210618T160529", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "Full", + "source": "Automatic", + "completedTime": "2021-06-19T16:05:36.8603354+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestserver/backups/daily_20210619T160533", + "name": "daily_20210619T160533", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "Full", + "source": "Automatic", + "completedTime": "2021-06-20T16:05:41.9200138+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestserver/backups/daily_20210620T160538", + "name": "daily_20210620T160538", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "Full", + "source": "Automatic", + "completedTime": "2021-06-21T16:05:48.8528447+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestserver/backups/daily_20210621T160543", + "name": "daily_20210621T160543", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "Full", + "source": "Automatic", + "completedTime": "2021-06-22T16:08:06.3121688+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestserver/backups/daily_20210622T160803", + "name": "daily_20210622T160803", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "Full", + "source": "Automatic", + "completedTime": "2021-06-22T21:08:10.5057354+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestserver/backups/daily_20210622T210807", + "name": "daily_20210622T210807", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "Full", + "source": "Automatic", + "completedTime": "2021-06-23T21:24:16.9401531+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestserver/backups/daily_20210623T212413", + "name": "daily_20210623T212413", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "Full", + "source": "Automatic", + "completedTime": "2021-06-24T06:13:31.4962137+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestserver/backups/daily_20210624T061328", + "name": "daily_20210624T061328", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/backups" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CapabilitiesByLocation.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CapabilitiesByLocation.json new file mode 100644 index 000000000000..e0bd505c0dc4 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CapabilitiesByLocation.json @@ -0,0 +1,2153 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "locationName": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "FlexibleServerCapabilities", + "supportedServerEditions": [ + { + "name": "Burstable", + "defaultSkuName": "Standard_B1ms", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "defaultStorageSizeMb": 32768, + "supportedStorageMb": [ + { + "supportedIops": 120, + "storageSizeMb": 32768, + "defaultIopsTier": "P4", + "supportedIopsTiers": [ + { + "name": "P4", + "iops": 120 + }, + { + "name": "P6", + "iops": 240 + }, + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 240, + "storageSizeMb": 65536, + "defaultIopsTier": "P6", + "supportedIopsTiers": [ + { + "name": "P6", + "iops": 240 + }, + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 500, + "storageSizeMb": 131072, + "defaultIopsTier": "P10", + "supportedIopsTiers": [ + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 1100, + "storageSizeMb": 262144, + "defaultIopsTier": "P15", + "supportedIopsTiers": [ + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 2300, + "storageSizeMb": 524288, + "defaultIopsTier": "P20", + "supportedIopsTiers": [ + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 5000, + "storageSizeMb": 1048576, + "defaultIopsTier": "P30", + "supportedIopsTiers": [ + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 2097152, + "defaultIopsTier": "P40", + "supportedIopsTiers": [ + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 4193280, + "defaultIopsTier": "P50", + "supportedIopsTiers": [ + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 4194304, + "defaultIopsTier": "P50", + "supportedIopsTiers": [ + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 16000, + "storageSizeMb": 8388608, + "defaultIopsTier": "P60", + "supportedIopsTiers": [ + { + "name": "P60", + "iops": 16000 + }, + { + "name": "P70", + "iops": 18000 + }, + { + "name": "P80", + "iops": 20000 + } + ] + }, + { + "supportedIops": 18000, + "storageSizeMb": 16777216, + "defaultIopsTier": "P70", + "supportedIopsTiers": [ + { + "name": "P70", + "iops": 18000 + }, + { + "name": "P80", + "iops": 20000 + } + ] + }, + { + "supportedIops": 20000, + "storageSizeMb": 33553408, + "defaultIopsTier": "P80", + "supportedIopsTiers": [ + { + "name": "P80", + "iops": 20000 + } + ] + } + ] + }, + { + "name": "ManagedDiskV2", + "defaultStorageSizeMb": 32768, + "supportedStorageMb": [ + { + "supportedIops": 3000, + "supportedMaximumIops": 80000, + "storageSizeMb": 32768, + "maximumStorageSizeMb": 67108864, + "supportedThroughput": 125, + "supportedMaximumThroughput": 1200, + "defaultIopsTier": "None", + "supportedIopsTiers": [ + { + "name": "None", + "iops": 0 + } + ] + } + ] + } + ], + "supportedServerSkus": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMb": 2048, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMb": 2048, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_B2ms", + "vCores": 2, + "supportedIops": 1920, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_B4ms", + "vCores": 4, + "supportedIops": 2880, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_B8ms", + "vCores": 8, + "supportedIops": 4320, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_B12ms", + "vCores": 12, + "supportedIops": 4320, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_B16ms", + "vCores": 16, + "supportedIops": 4320, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_B20ms", + "vCores": 20, + "supportedIops": 4320, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + } + ] + }, + { + "name": "GeneralPurpose", + "defaultSkuName": "Standard_D4ads_v5", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "defaultStorageSizeMb": 65536, + "supportedStorageMb": [ + { + "supportedIops": 120, + "storageSizeMb": 32768, + "defaultIopsTier": "P4", + "supportedIopsTiers": [ + { + "name": "P4", + "iops": 120 + }, + { + "name": "P6", + "iops": 240 + }, + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 240, + "storageSizeMb": 65536, + "defaultIopsTier": "P6", + "supportedIopsTiers": [ + { + "name": "P6", + "iops": 240 + }, + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 500, + "storageSizeMb": 131072, + "defaultIopsTier": "P10", + "supportedIopsTiers": [ + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 1100, + "storageSizeMb": 262144, + "defaultIopsTier": "P15", + "supportedIopsTiers": [ + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 2300, + "storageSizeMb": 524288, + "defaultIopsTier": "P20", + "supportedIopsTiers": [ + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 5000, + "storageSizeMb": 1048576, + "defaultIopsTier": "P30", + "supportedIopsTiers": [ + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 2097152, + "defaultIopsTier": "P40", + "supportedIopsTiers": [ + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 4193280, + "defaultIopsTier": "P50", + "supportedIopsTiers": [ + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 4194304, + "defaultIopsTier": "P50", + "supportedIopsTiers": [ + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 16000, + "storageSizeMb": 8388608, + "defaultIopsTier": "P60", + "supportedIopsTiers": [ + { + "name": "P60", + "iops": 16000 + }, + { + "name": "P70", + "iops": 18000 + }, + { + "name": "P80", + "iops": 20000 + } + ] + }, + { + "supportedIops": 18000, + "storageSizeMb": 16777216, + "defaultIopsTier": "P70", + "supportedIopsTiers": [ + { + "name": "P70", + "iops": 18000 + }, + { + "name": "P80", + "iops": 20000 + } + ] + }, + { + "supportedIops": 20000, + "storageSizeMb": 33553408, + "defaultIopsTier": "P80", + "supportedIopsTiers": [ + { + "name": "P80", + "iops": 20000 + } + ] + } + ] + }, + { + "name": "ManagedDiskV2", + "defaultStorageSizeMb": 65536, + "supportedStorageMb": [ + { + "supportedIops": 3000, + "supportedMaximumIops": 80000, + "storageSizeMb": 32768, + "maximumStorageSizeMb": 67108864, + "supportedThroughput": 125, + "supportedMaximumThroughput": 1200, + "defaultIopsTier": "None", + "supportedIopsTiers": [ + { + "name": "None", + "iops": 0 + } + ] + } + ] + } + ], + "supportedServerSkus": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D2ads_v5", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D4ads_v5", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D8ads_v5", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D16ads_v5", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D32ads_v5", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D48ads_v5", + "vCores": 48, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D64ads_v5", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D96ads_v5", + "vCores": 96, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D2ds_v5", + "vCores": 2, + "supportedIops": 3750, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D4ds_v5", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D8ds_v5", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D16ds_v5", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D32ds_v5", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D48ds_v5", + "vCores": 48, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D64ds_v5", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D96ds_v5", + "vCores": 96, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + } + ] + }, + { + "name": "MemoryOptimized", + "defaultSkuName": "Standard_E4ads_v5", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "defaultStorageSizeMb": 131072, + "supportedStorageMb": [ + { + "supportedIops": 120, + "storageSizeMb": 32768, + "defaultIopsTier": "P4", + "supportedIopsTiers": [ + { + "name": "P4", + "iops": 120 + }, + { + "name": "P6", + "iops": 240 + }, + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 240, + "storageSizeMb": 65536, + "defaultIopsTier": "P6", + "supportedIopsTiers": [ + { + "name": "P6", + "iops": 240 + }, + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 500, + "storageSizeMb": 131072, + "defaultIopsTier": "P10", + "supportedIopsTiers": [ + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 1100, + "storageSizeMb": 262144, + "defaultIopsTier": "P15", + "supportedIopsTiers": [ + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 2300, + "storageSizeMb": 524288, + "defaultIopsTier": "P20", + "supportedIopsTiers": [ + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 5000, + "storageSizeMb": 1048576, + "defaultIopsTier": "P30", + "supportedIopsTiers": [ + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 2097152, + "defaultIopsTier": "P40", + "supportedIopsTiers": [ + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 4193280, + "defaultIopsTier": "P50", + "supportedIopsTiers": [ + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 4194304, + "defaultIopsTier": "P50", + "supportedIopsTiers": [ + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 16000, + "storageSizeMb": 8388608, + "defaultIopsTier": "P60", + "supportedIopsTiers": [ + { + "name": "P60", + "iops": 16000 + }, + { + "name": "P70", + "iops": 18000 + }, + { + "name": "P80", + "iops": 20000 + } + ] + }, + { + "supportedIops": 18000, + "storageSizeMb": 16777216, + "defaultIopsTier": "P70", + "supportedIopsTiers": [ + { + "name": "P70", + "iops": 18000 + }, + { + "name": "P80", + "iops": 20000 + } + ] + }, + { + "supportedIops": 20000, + "storageSizeMb": 33553408, + "defaultIopsTier": "P80", + "supportedIopsTiers": [ + { + "name": "P80", + "iops": 20000 + } + ] + } + ] + }, + { + "name": "ManagedDiskV2", + "defaultStorageSizeMb": 131072, + "supportedStorageMb": [ + { + "supportedIops": 3000, + "supportedMaximumIops": 80000, + "storageSizeMb": 32768, + "maximumStorageSizeMb": 67108864, + "supportedThroughput": 125, + "supportedMaximumThroughput": 1200, + "defaultIopsTier": "None", + "supportedIopsTiers": [ + { + "name": "None", + "iops": 0 + } + ] + } + ] + } + ], + "supportedServerSkus": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 32000, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 6912, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 32000, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 6912, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E2ads_v5", + "vCores": 2, + "supportedIops": 3750, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E4ads_v5", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E8ads_v5", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E16ads_v5", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E20ads_v5", + "vCores": 20, + "supportedIops": 32000, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E32ads_v5", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E48ads_v5", + "vCores": 48, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E64ads_v5", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E96ads_v5", + "vCores": 96, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 7168, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E2ds_v5", + "vCores": 2, + "supportedIops": 3750, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E4ds_v5", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E8ds_v5", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E16ds_v5", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E20ds_v5", + "vCores": 20, + "supportedIops": 32000, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E32ds_v5", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E48ds_v5", + "vCores": 48, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E64ds_v5", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E96ds_v5", + "vCores": 96, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 7168, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + } + ] + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVersionsToUpgrade": [ + "12", + "13", + "14", + "15", + "16" + ] + }, + { + "name": "12", + "supportedVersionsToUpgrade": [ + "13", + "14", + "15", + "16" + ] + }, + { + "name": "13", + "supportedVersionsToUpgrade": [ + "14", + "15", + "16" + ] + }, + { + "name": "14", + "supportedVersionsToUpgrade": [ + "15", + "16" + ] + }, + { + "name": "15", + "supportedVersionsToUpgrade": [ + "16" + ] + }, + { + "name": "16", + "supportedVersionsToUpgrade": [] + } + ], + "fastProvisioningSupported": "Enabled", + "supportedFastProvisioningEditions": [ + { + "supportedTier": "Burstable", + "supportedSku": "standard_b1ms", + "supportedStorageGb": 32, + "supportedServerVersions": "12", + "serverCount": 0 + }, + { + "supportedTier": "Burstable", + "supportedSku": "standard_b2s", + "supportedStorageGb": 32, + "supportedServerVersions": "12", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2s_v3", + "supportedStorageGb": 128, + "supportedServerVersions": "12", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2ds_v4", + "supportedStorageGb": 128, + "supportedServerVersions": "12", + "serverCount": 0 + }, + { + "supportedTier": "MemoryOptimized", + "supportedSku": "standard_e2ds_v4", + "supportedStorageGb": 512, + "supportedServerVersions": "12", + "serverCount": 0 + }, + { + "supportedTier": "Burstable", + "supportedSku": "standard_b1ms", + "supportedStorageGb": 32, + "supportedServerVersions": "13", + "serverCount": 0 + }, + { + "supportedTier": "Burstable", + "supportedSku": "standard_b2s", + "supportedStorageGb": 32, + "supportedServerVersions": "13", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2s_v3", + "supportedStorageGb": 128, + "supportedServerVersions": "13", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2ds_v4", + "supportedStorageGb": 128, + "supportedServerVersions": "13", + "serverCount": 0 + }, + { + "supportedTier": "MemoryOptimized", + "supportedSku": "standard_e2ds_v4", + "supportedStorageGb": 512, + "supportedServerVersions": "13", + "serverCount": 0 + }, + { + "supportedTier": "Burstable", + "supportedSku": "standard_b1ms", + "supportedStorageGb": 32, + "supportedServerVersions": "14", + "serverCount": 0 + }, + { + "supportedTier": "Burstable", + "supportedSku": "standard_b2s", + "supportedStorageGb": 32, + "supportedServerVersions": "14", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2s_v3", + "supportedStorageGb": 128, + "supportedServerVersions": "14", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2ds_v4", + "supportedStorageGb": 128, + "supportedServerVersions": "14", + "serverCount": 0 + }, + { + "supportedTier": "MemoryOptimized", + "supportedSku": "standard_e2ds_v4", + "supportedStorageGb": 512, + "supportedServerVersions": "14", + "serverCount": 0 + }, + { + "supportedTier": "Burstable", + "supportedSku": "standard_b1ms", + "supportedStorageGb": 32, + "supportedServerVersions": "15", + "serverCount": 0 + }, + { + "supportedTier": "Burstable", + "supportedSku": "standard_b2s", + "supportedStorageGb": 32, + "supportedServerVersions": "15", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2s_v3", + "supportedStorageGb": 128, + "supportedServerVersions": "15", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2ds_v4", + "supportedStorageGb": 128, + "supportedServerVersions": "15", + "serverCount": 0 + }, + { + "supportedTier": "MemoryOptimized", + "supportedSku": "standard_e2ds_v4", + "supportedStorageGb": 512, + "supportedServerVersions": "15", + "serverCount": 0 + } + ], + "geoBackupSupported": "Enabled", + "zoneRedundantHaSupported": "Enabled", + "zoneRedundantHaAndGeoBackupSupported": "Enabled", + "storageAutoGrowthSupported": "Enabled", + "onlineResizeSupported": "Enabled", + "restricted": "Disabled" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CheckMigrationNameAvailability.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CheckMigrationNameAvailability.json new file mode 100644 index 000000000000..0700e877e679 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CheckMigrationNameAvailability.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "parameters": { + "name": "name1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/migrations" + } + }, + "responses": { + "200": { + "body": { + "name": "name1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/migrations", + "nameAvailable": true, + "reason": null, + "message": null + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CheckNameAvailability.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..39cc33978565 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "nameAvailabilityRequest": { + "name": "name1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "message": "", + "name": "name1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CheckNameAvailabilityLocationBased.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CheckNameAvailabilityLocationBased.json new file mode 100644 index 000000000000..f084ec37bf95 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CheckNameAvailabilityLocationBased.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "locationName": "westus", + "nameAvailabilityRequest": { + "name": "name1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "message": "", + "name": "name1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ConfigurationGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ConfigurationGet.json new file mode 100644 index 000000000000..d0627c81f2d6 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ConfigurationGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "configurationName": "array_nulls", + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "properties": { + "value": "on", + "description": "Enable input of NULL elements in arrays.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/array_nulls", + "name": "array_nulls", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ConfigurationListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ConfigurationListByServer.json new file mode 100644 index 000000000000..758d7e202805 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ConfigurationListByServer.json @@ -0,0 +1,1902 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff//resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations?api-version=2024-08-01&$top=200&$skiptoken=skiptoken", + "value": [ + { + "properties": { + "value": "", + "description": "Sets the application name to be reported in statistics and logs.", + "defaultValue": "", + "dataType": "String", + "allowedValues": "[A-Za-z0-9._-]*", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/application_name", + "name": "application_name", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables input of NULL elements in arrays.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/array_nulls", + "name": "array_nulls", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Starts the autovacuum subprocess.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum", + "name": "autovacuum", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.1", + "description": "Number of tuple inserts, updates, or deletes prior to analyze as a fraction of reltuples.", + "defaultValue": "0.1", + "dataType": "Numeric", + "allowedValues": "0-100", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_analyze_scale_factor", + "name": "autovacuum_analyze_scale_factor", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "50", + "description": "Minimum number of tuple inserts, updates, or deletes prior to analyze.", + "defaultValue": "50", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_analyze_threshold", + "name": "autovacuum_analyze_threshold", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "60", + "description": "Time to sleep between autovacuum runs.", + "defaultValue": "60", + "dataType": "Integer", + "allowedValues": "1-2147483", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_naptime", + "name": "autovacuum_naptime", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Vacuum cost delay in milliseconds, for autovacuum.", + "defaultValue": "2", + "dataType": "Integer", + "allowedValues": "-1-100", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_vacuum_cost_delay", + "name": "autovacuum_vacuum_cost_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Vacuum cost amount available before napping, for autovacuum.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_vacuum_cost_limit", + "name": "autovacuum_vacuum_cost_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.2", + "description": "Number of tuple updates or deletes prior to vacuum as a fraction of reltuples.", + "defaultValue": "0.2", + "dataType": "Numeric", + "allowedValues": "0-100", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_vacuum_scale_factor", + "name": "autovacuum_vacuum_scale_factor", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "50", + "description": "Minimum number of tuple updates or deletes prior to vacuum.", + "defaultValue": "50", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_vacuum_threshold", + "name": "autovacuum_vacuum_threshold", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Sets the maximum memory to be used by each autovacuum worker process.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_work_mem", + "name": "autovacuum_work_mem", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Number of pages after which previously performed writes are flushed to disk.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-256", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/backend_flush_after", + "name": "backend_flush_after", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "safe_encoding", + "description": "Sets whether \"\\'\" is allowed in string literals.", + "defaultValue": "safe_encoding", + "dataType": "Enumeration", + "allowedValues": "safe_encoding,on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/backslash_quote", + "name": "backslash_quote", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "200", + "description": "Background writer sleep time between rounds.", + "defaultValue": "200", + "dataType": "Integer", + "allowedValues": "10-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bgwriter_delay", + "name": "bgwriter_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "64", + "description": "Number of pages after which previously performed writes are flushed to disk.", + "defaultValue": "64", + "dataType": "Integer", + "allowedValues": "0-256", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bgwriter_flush_after", + "name": "bgwriter_flush_after", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "100", + "description": "Background writer maximum number of LRU pages to flush per round.", + "defaultValue": "100", + "dataType": "Integer", + "allowedValues": "0-1073741823", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bgwriter_lru_maxpages", + "name": "bgwriter_lru_maxpages", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Multiple of the average buffer usage to free per round.", + "defaultValue": "2", + "dataType": "Numeric", + "allowedValues": "0-10", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bgwriter_lru_multiplier", + "name": "bgwriter_lru_multiplier", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "hex", + "description": "Sets the output format for bytea.", + "defaultValue": "hex", + "dataType": "Enumeration", + "allowedValues": "escape,hex", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bytea_output", + "name": "bytea_output", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Checks function bodies during CREATE FUNCTION.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/check_function_bodies", + "name": "check_function_bodies", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.5", + "description": "Time spent flushing dirty buffers during checkpoint, as fraction of checkpoint interval.", + "defaultValue": "0.5", + "dataType": "Numeric", + "allowedValues": "0-1", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/checkpoint_completion_target", + "name": "checkpoint_completion_target", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "300", + "description": "Sets the maximum time between automatic WAL checkpoints.", + "defaultValue": "300", + "dataType": "Integer", + "allowedValues": "30-86400", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/checkpoint_timeout", + "name": "checkpoint_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "30", + "description": "Enables warnings if checkpoint segments are filled more frequently than this.", + "defaultValue": "30", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/checkpoint_warning", + "name": "checkpoint_warning", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "sql_ascii", + "description": "Sets the client's character set encoding.", + "defaultValue": "sql_ascii", + "dataType": "Enumeration", + "allowedValues": "BIG5,EUC_CN,EUC_JP,EUC_JIS_2004,EUC_KR,EUC_TW,GB18030,GBK,ISO_8859_5,ISO_8859_6,ISO_8859_7,ISO_8859_8,JOHAB,KOI8R,KOI8U,LATIN1,LATIN2,LATIN3,LATIN4,LATIN5,LATIN6,LATIN7,LATIN8,LATIN9,LATIN10,MULE_INTERNAL,SJIS,SHIFT_JIS_2004,SQL_ASCII,UHC,UTF8,WIN866,WIN874,WIN1250,WIN1251,WIN1252,WIN1253,WIN1254,WIN1255,WIN1256,WIN1257,WIN1258", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/client_encoding", + "name": "client_encoding", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "notice", + "description": "Sets the message levels that are sent to the client.", + "defaultValue": "notice", + "dataType": "Enumeration", + "allowedValues": "debug5,debug4,debug3,debug2,debug1,log,notice,warning,error", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/client_min_messages", + "name": "client_min_messages", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the delay in microseconds between transaction commit and flushing WAL to disk.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-100000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/commit_delay", + "name": "commit_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "5", + "description": "Sets the minimum concurrent open transactions before performing commit_delay.", + "defaultValue": "5", + "dataType": "Integer", + "allowedValues": "0-1000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/commit_siblings", + "name": "commit_siblings", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "partition", + "description": "Enables the planner to use constraints to optimize queries.", + "defaultValue": "partition", + "dataType": "Enumeration", + "allowedValues": "partition,on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/constraint_exclusion", + "name": "constraint_exclusion", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.005", + "description": "Sets the planner's estimate of the cost of processing each index entry during an index scan.", + "defaultValue": "0.005", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/cpu_index_tuple_cost", + "name": "cpu_index_tuple_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.0025", + "description": "Sets the planner's estimate of the cost of processing each operator or function call.", + "defaultValue": "0.0025", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/cpu_operator_cost", + "name": "cpu_operator_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.01", + "description": "Sets the planner's estimate of the cost of processing each tuple (row).", + "defaultValue": "0.01", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/cpu_tuple_cost", + "name": "cpu_tuple_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.1", + "description": "Sets the planner's estimate of the fraction of a cursor's rows that will be retrieved.", + "defaultValue": "0.1", + "dataType": "Numeric", + "allowedValues": "0-1", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/cursor_tuple_fraction", + "name": "cursor_tuple_fraction", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "ISO, MDY", + "description": "Sets the display format for date and time values.", + "defaultValue": "ISO, MDY", + "dataType": "String", + "allowedValues": "(ISO|POSTGRES|SQL|GERMAN)(, (DMY|MDY|YMD))?", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/DateStyle", + "name": "DateStyle", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1000", + "description": "Sets the amount of time, in milliseconds, to wait on a lock before checking for deadlock.", + "defaultValue": "1000", + "dataType": "Integer", + "allowedValues": "1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/deadlock_timeout", + "name": "deadlock_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Indents parse and plan tree displays.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/debug_pretty_print", + "name": "debug_pretty_print", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs each query's parse tree.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/debug_print_parse", + "name": "debug_print_parse", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs each query's execution plan.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/debug_print_plan", + "name": "debug_print_plan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs each query's rewritten parse tree.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/debug_print_rewritten", + "name": "debug_print_rewritten", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "100", + "description": "Sets the default statistics target.", + "defaultValue": "100", + "dataType": "Integer", + "allowedValues": "1-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_statistics_target", + "name": "default_statistics_target", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "", + "description": "Sets the default tablespace to create tables and indexes in.", + "defaultValue": "", + "dataType": "String", + "allowedValues": "[A-Za-z._]*", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_tablespace", + "name": "default_tablespace", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "pg_catalog.english", + "description": "Sets default text search configuration.", + "defaultValue": "pg_catalog.english", + "dataType": "String", + "allowedValues": "[A-Za-z._]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_text_search_config", + "name": "default_text_search_config", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Sets the default deferrable status of new transactions.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_transaction_deferrable", + "name": "default_transaction_deferrable", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "read committed", + "description": "Sets the transaction isolation level of each new transaction.", + "defaultValue": "read committed", + "dataType": "Enumeration", + "allowedValues": "serializable,repeatable read,read committed,read uncommitted", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_transaction_isolation", + "name": "default_transaction_isolation", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Sets the default read-only status of new transactions.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_transaction_read_only", + "name": "default_transaction_read_only", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Creates new tables with OIDs by default.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_with_oids", + "name": "default_with_oids", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "3145728", + "description": "Sets the planner's assumption about the size of the disk cache.", + "defaultValue": "3145728", + "dataType": "Integer", + "allowedValues": "1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/effective_cache_size", + "name": "effective_cache_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of bitmap-scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_bitmapscan", + "name": "enable_bitmapscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of gather merge plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_gathermerge", + "name": "enable_gathermerge", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of hashed aggregation plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_hashagg", + "name": "enable_hashagg", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of hash join plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_hashjoin", + "name": "enable_hashjoin", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of index-only-scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_indexonlyscan", + "name": "enable_indexonlyscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of index-scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_indexscan", + "name": "enable_indexscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of materialization.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_material", + "name": "enable_material", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of merge join plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_mergejoin", + "name": "enable_mergejoin", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of nested loop join plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_nestloop", + "name": "enable_nestloop", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of sequential-scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_seqscan", + "name": "enable_seqscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of explicit sort steps.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_sort", + "name": "enable_sort", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of TID scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_tidscan", + "name": "enable_tidscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Warns about backslash escapes in ordinary string literals.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/escape_string_warning", + "name": "escape_string_warning", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Terminates session on any error.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/exit_on_error", + "name": "exit_on_error", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1", + "description": "Sets the number of digits displayed for floating-point values.", + "defaultValue": "1", + "dataType": "Integer", + "allowedValues": "-15-3", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/extra_float_digits", + "name": "extra_float_digits", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Forces use of parallel query facilities.", + "defaultValue": "off", + "dataType": "Enumeration", + "allowedValues": "off,on,regress", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/force_parallel_mode", + "name": "force_parallel_mode", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "8", + "description": "Sets the FROM-list size beyond which subqueries are not collapsed.", + "defaultValue": "8", + "dataType": "Integer", + "allowedValues": "1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/from_collapse_limit", + "name": "from_collapse_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables genetic query optimization.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo", + "name": "geqo", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "5", + "description": "GEQO: effort is used to set the default for other GEQO parameters.", + "defaultValue": "5", + "dataType": "Integer", + "allowedValues": "1-10", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_effort", + "name": "geqo_effort", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "GEQO: number of iterations of the algorithm.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_generations", + "name": "geqo_generations", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "GEQO: number of individuals in the population.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_pool_size", + "name": "geqo_pool_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "GEQO: seed for random path selection.", + "defaultValue": "0", + "dataType": "Numeric", + "allowedValues": "0-1", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_seed", + "name": "geqo_seed", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "GEQO: selective pressure within the population.", + "defaultValue": "2", + "dataType": "Numeric", + "allowedValues": "1.5-2", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_selection_bias", + "name": "geqo_selection_bias", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "12", + "description": "Sets the threshold of FROM items beyond which GEQO is used.", + "defaultValue": "12", + "dataType": "Integer", + "allowedValues": "2-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_threshold", + "name": "geqo_threshold", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the maximum allowed result for exact search by GIN.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/gin_fuzzy_search_limit", + "name": "gin_fuzzy_search_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "4096", + "description": "Sets the maximum size of the pending list for GIN index.", + "defaultValue": "4096", + "dataType": "Integer", + "allowedValues": "64-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/gin_pending_list_limit", + "name": "gin_pending_list_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the maximum allowed duration of any idling transaction.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/idle_in_transaction_session_timeout", + "name": "idle_in_transaction_session_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "postgres", + "description": "Sets the display format for interval values.", + "defaultValue": "postgres", + "dataType": "Enumeration", + "allowedValues": "postgres,postgres_verbose,sql_standard,iso_8601", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/IntervalStyle", + "name": "IntervalStyle", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "8", + "description": "Sets the FROM-list size beyond which JOIN constructs are not flattened.", + "defaultValue": "8", + "dataType": "Integer", + "allowedValues": "1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/join_collapse_limit", + "name": "join_collapse_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "en_US.utf-8", + "description": "Sets the locale for formatting monetary amounts.", + "defaultValue": "en_US.utf-8", + "dataType": "String", + "allowedValues": "[A-Za-z0-9._ -]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/lc_monetary", + "name": "lc_monetary", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "en_US.utf-8", + "description": "Sets the locale for formatting numbers.", + "defaultValue": "en_US.utf-8", + "dataType": "String", + "allowedValues": "[A-Za-z0-9._ -]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/lc_numeric", + "name": "lc_numeric", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Enables backward compatibility mode for privilege checks on large objects.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/lo_compat_privileges", + "name": "lo_compat_privileges", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the maximum allowed duration (in milliseconds) of any wait for a lock. 0 turns this off.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/lock_timeout", + "name": "lock_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Sets the minimum execution time above which autovacuum actions will be logged.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_autovacuum_min_duration", + "name": "log_autovacuum_min_duration", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Logs each checkpoint.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_checkpoints", + "name": "log_checkpoints", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Logs each successful connection.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_connections", + "name": "log_connections", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "stderr", + "description": "Sets the destination for server log output.", + "defaultValue": "stderr", + "dataType": "Enumeration", + "allowedValues": "stderr,csvlog", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_destination", + "name": "log_destination", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs end of a session, including duration.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_disconnections", + "name": "log_disconnections", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs the duration of each completed SQL statement.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_duration", + "name": "log_duration", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "default", + "description": "Sets the verbosity of logged messages.", + "defaultValue": "default", + "dataType": "Enumeration", + "allowedValues": "terse,default,verbose", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_error_verbosity", + "name": "log_error_verbosity", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs long lock waits.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_lock_waits", + "name": "log_lock_waits", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Sets the minimum execution time (in milliseconds) above which statements will be logged. -1 disables logging statement durations.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_min_duration_statement", + "name": "log_min_duration_statement", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "error", + "description": "Causes all statements generating error at or above this level to be logged.", + "defaultValue": "error", + "dataType": "Enumeration", + "allowedValues": "debug5,debug4,debug3,debug2,debug1,info,notice,warning,error,log,fatal,panic", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_min_error_statement", + "name": "log_min_error_statement", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "warning", + "description": "Sets the message levels that are logged.", + "defaultValue": "warning", + "dataType": "Enumeration", + "allowedValues": "debug5,debug4,debug3,debug2,debug1,info,notice,warning,error,log,fatal,panic", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_min_messages", + "name": "log_min_messages", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs each replication command.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_replication_commands", + "name": "log_replication_commands", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "none", + "description": "Sets the type of statements logged.", + "defaultValue": "none", + "dataType": "Enumeration", + "allowedValues": "none,ddl,mod,all", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_statement", + "name": "log_statement", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "For each query, writes cumulative performance statistics to the server log.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_statement_stats", + "name": "log_statement_stats", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Logs the use of temporary files larger than this number of kilobytes.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_temp_files", + "name": "log_temp_files", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "332800", + "description": "Sets the maximum memory to be used for maintenance operations.", + "defaultValue": "332800", + "dataType": "Integer", + "allowedValues": "1024-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/maintenance_work_mem", + "name": "maintenance_work_mem", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "8", + "description": "Sets the maximum number of parallel workers than can be active at one time.", + "defaultValue": "8", + "dataType": "Integer", + "allowedValues": "0-1024", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_parallel_workers", + "name": "max_parallel_workers", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Sets the maximum number of parallel processes per executor node.", + "defaultValue": "2", + "dataType": "Integer", + "allowedValues": "0-1024", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_parallel_workers_per_gather", + "name": "max_parallel_workers_per_gather", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Sets the maximum number of predicate-locked tuples per page.", + "defaultValue": "2", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_pred_locks_per_page", + "name": "max_pred_locks_per_page", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-2", + "description": "Sets the maximum number of predicate-locked pages and tuples per relation.", + "defaultValue": "-2", + "dataType": "Integer", + "allowedValues": "-2147483648-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_pred_locks_per_relation", + "name": "max_pred_locks_per_relation", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "30000", + "description": "Sets the maximum delay before canceling queries when a hot standby server is processing archived WAL data.", + "defaultValue": "30000", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_standby_archive_delay", + "name": "max_standby_archive_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "30000", + "description": "Sets the maximum delay before canceling queries when a hot standby server is processing streamed WAL data.", + "defaultValue": "30000", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_standby_streaming_delay", + "name": "max_standby_streaming_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Maximum number of table synchronization workers per subscription.", + "defaultValue": "2", + "dataType": "Integer", + "allowedValues": "0-262143", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_sync_workers_per_subscription", + "name": "max_sync_workers_per_subscription", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1024", + "description": "Sets the WAL size that triggers a checkpoint.", + "defaultValue": "1024", + "dataType": "Integer", + "allowedValues": "2-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_wal_size", + "name": "max_wal_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "64", + "description": "Sets the minimum amount of index data for a parallel scan.", + "defaultValue": "64", + "dataType": "Integer", + "allowedValues": "0-715827882", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/min_parallel_index_scan_size", + "name": "min_parallel_index_scan_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1024", + "description": "Sets the minimum amount of table data for a parallel scan.", + "defaultValue": "1024", + "dataType": "Integer", + "allowedValues": "0-715827882", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/min_parallel_table_scan_size", + "name": "min_parallel_table_scan_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "80", + "description": "Sets the minimum size to shrink the WAL to.", + "defaultValue": "80", + "dataType": "Integer", + "allowedValues": "2-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/min_wal_size", + "name": "min_wal_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Emits a warning for constructs that changed meaning since PostgreSQL 9.4.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/operator_precedence_warning", + "name": "operator_precedence_warning", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1000", + "description": "Sets the planner's estimate of the cost of starting up worker processes for parallel query.", + "defaultValue": "1000", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/parallel_setup_cost", + "name": "parallel_setup_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.1", + "description": "Sets the planner's estimate of the cost of passing each tuple (row) from worker to master backend.", + "defaultValue": "0.1", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/parallel_tuple_cost", + "name": "parallel_tuple_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "When generating SQL fragments, quotes all identifiers.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/quote_all_identifiers", + "name": "quote_all_identifiers", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "4", + "description": "Sets the planner's estimate of the cost of a nonsequentially fetched disk page.", + "defaultValue": "4", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/random_page_cost", + "name": "random_page_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables row security.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/row_security", + "name": "row_security", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "\"$user\", public", + "description": "Sets the schema search order for names that are not schema-qualified.", + "defaultValue": "\"$user\", public", + "dataType": "String", + "allowedValues": "[A-Za-z.\"$, ]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/search_path", + "name": "search_path", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1", + "description": "Sets the planner's estimate of the cost of a sequentially fetched disk page.", + "defaultValue": "1", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/seq_page_cost", + "name": "seq_page_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "origin", + "description": "Sets the session's behavior for triggers and rewrite rules.", + "defaultValue": "origin", + "dataType": "Enumeration", + "allowedValues": "origin,replica,local", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/session_replication_role", + "name": "session_replication_role", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Causes '...' strings to treat backslashes literally.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/standard_conforming_strings", + "name": "standard_conforming_strings", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the maximum allowed duration (in milliseconds) of any statement. 0 turns this off.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/statement_timeout", + "name": "statement_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables synchronized sequential scans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/synchronize_seqscans", + "name": "synchronize_seqscans", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Sets the current transaction's synchronization level.", + "defaultValue": "on", + "dataType": "Enumeration", + "allowedValues": "local,remote_write,on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/synchronous_commit", + "name": "synchronous_commit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "9", + "description": "Maximum number of TCP keepalive retransmits.", + "defaultValue": "9", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/tcp_keepalives_count", + "name": "tcp_keepalives_count", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "120", + "description": "Time between issuing TCP keepalives.", + "defaultValue": "120", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/tcp_keepalives_idle", + "name": "tcp_keepalives_idle", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "30", + "description": "Time between TCP keepalive retransmits.", + "defaultValue": "30", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/tcp_keepalives_interval", + "name": "tcp_keepalives_interval", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1024", + "description": "Sets the maximum number of temporary buffers used by each database session.", + "defaultValue": "1024", + "dataType": "Integer", + "allowedValues": "100-1073741823", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/temp_buffers", + "name": "temp_buffers", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "", + "description": "Sets the tablespace(s) to use for temporary tables and sort files.", + "defaultValue": "", + "dataType": "String", + "allowedValues": "[A-Za-z._]*", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/temp_tablespaces", + "name": "temp_tablespaces", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "UTC", + "description": "Sets the time zone for displaying and interpreting time stamps.", + "defaultValue": "UTC", + "dataType": "String", + "allowedValues": "[A-Za-z0-9/+_-]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/TimeZone", + "name": "TimeZone", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Collects information about executing commands.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/track_activities", + "name": "track_activities", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Collects statistics on database activity.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/track_counts", + "name": "track_counts", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "none", + "description": "Collects function-level statistics on database activity.", + "defaultValue": "none", + "dataType": "Enumeration", + "allowedValues": "none,pl,all", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/track_functions", + "name": "track_functions", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Collects timing statistics for database I/O activity.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/track_io_timing", + "name": "track_io_timing", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Treats \"expr=NULL\" as \"expr IS NULL\".", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/transform_null_equals", + "name": "transform_null_equals", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Vacuum cost delay in milliseconds.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-100", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_delay", + "name": "vacuum_cost_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "200", + "description": "Vacuum cost amount available before napping.", + "defaultValue": "200", + "dataType": "Integer", + "allowedValues": "1-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_limit", + "name": "vacuum_cost_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "20", + "description": "Vacuum cost for a page dirtied by vacuum.", + "defaultValue": "20", + "dataType": "Integer", + "allowedValues": "0-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_page_dirty", + "name": "vacuum_cost_page_dirty", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1", + "description": "Vacuum cost for a page found in the buffer cache.", + "defaultValue": "1", + "dataType": "Integer", + "allowedValues": "0-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_page_hit", + "name": "vacuum_cost_page_hit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "10", + "description": "Vacuum cost for a page not found in the buffer cache.", + "defaultValue": "10", + "dataType": "Integer", + "allowedValues": "0-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_page_miss", + "name": "vacuum_cost_page_miss", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Number of transactions by which VACUUM and HOT cleanup should be deferred, if any.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-1000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_defer_cleanup_age", + "name": "vacuum_defer_cleanup_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "50000000", + "description": "Minimum age at which VACUUM should freeze a table row.", + "defaultValue": "50000000", + "dataType": "Integer", + "allowedValues": "0-1000000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_freeze_min_age", + "name": "vacuum_freeze_min_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "150000000", + "description": "Age at which VACUUM should scan whole table to freeze tuples.", + "defaultValue": "150000000", + "dataType": "Integer", + "allowedValues": "0-2000000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_freeze_table_age", + "name": "vacuum_freeze_table_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "5000000", + "description": "Minimum age at which VACUUM should freeze a MultiXactId in a table row.", + "defaultValue": "5000000", + "dataType": "Integer", + "allowedValues": "0-1000000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_multixact_freeze_min_age", + "name": "vacuum_multixact_freeze_min_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "150000000", + "description": "Multixact age at which VACUUM should scan whole table to freeze tuples.", + "defaultValue": "150000000", + "dataType": "Integer", + "allowedValues": "0-2000000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_multixact_freeze_table_age", + "name": "vacuum_multixact_freeze_table_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "10", + "description": "Sets the maximum interval between WAL receiver status reports to the primary.", + "defaultValue": "10", + "dataType": "Integer", + "allowedValues": "0-2147483", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/wal_receiver_status_interval", + "name": "wal_receiver_status_interval", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "200", + "description": "Time between WAL flushes performed in the WAL writer.", + "defaultValue": "200", + "dataType": "Integer", + "allowedValues": "1-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/wal_writer_delay", + "name": "wal_writer_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "128", + "description": "Amount of WAL written out by WAL writer that triggers a flush.", + "defaultValue": "128", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/wal_writer_flush_after", + "name": "wal_writer_flush_after", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "115712", + "description": "Sets the amount of memory to be used by internal sort operations and hash tables before writing to temporary disk files.", + "defaultValue": "115712", + "dataType": "Integer", + "allowedValues": "4096-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/work_mem", + "name": "work_mem", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "base64", + "description": "Sets how binary values are to be encoded in XML.", + "defaultValue": "base64", + "dataType": "Enumeration", + "allowedValues": "base64,hex", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/xmlbinary", + "name": "xmlbinary", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "content", + "description": "Sets whether XML data in implicit parsing and serialization operations is to be considered as documents or content fragments.", + "defaultValue": "content", + "dataType": "Enumeration", + "allowedValues": "content,document", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/xmloption", + "name": "xmloption", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ConfigurationUpdate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ConfigurationUpdate.json new file mode 100644 index 000000000000..b89bd87d1359 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ConfigurationUpdate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "serverName": "testserver", + "configurationName": "event_scheduler", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "value": "on", + "source": "user-override" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "value": "ON", + "description": "Indicates the status of the Event Scheduler.", + "defaultValue": "OFF", + "dataType": "Enumeration", + "allowedValues": "ON,OFF,DISABLED", + "source": "user-override" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/event_scheduler", + "name": "event_scheduler", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + } + }, + "201": { + "body": { + "properties": { + "value": "ON", + "description": "Indicates the status of the Event Scheduler.", + "defaultValue": "OFF", + "dataType": "Enumeration", + "allowedValues": "ON,OFF,DISABLED", + "source": "user-override" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/event_scheduler", + "name": "event_scheduler", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabaseCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabaseCreate.json new file mode 100644 index 000000000000..51ef07630ae0 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabaseCreate.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "databaseName": "db1", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "charset": "utf8", + "collation": "en_US.utf8" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/databases/db1", + "name": "db1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/databases", + "properties": { + "charset": "utf8", + "collation": "en_US.utf8" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/databases/db1", + "name": "db1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/databases", + "properties": { + "charset": "utf8", + "collation": "en_US.utf8" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westcentralus/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westcentralus/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabaseDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabaseDelete.json new file mode 100644 index 000000000000..5f8b1d3159d3 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabaseDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "databaseName": "db1", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + }, + "204": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabaseGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabaseGet.json new file mode 100644 index 000000000000..d4983f9f3c85 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabaseGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "databaseName": "db1", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/databases/db1", + "name": "db1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/databases", + "properties": { + "charset": "utf8", + "collation": "en_US.utf8" + } + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabasesListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabasesListByServer.json new file mode 100644 index 000000000000..449bd646fe7b --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabasesListByServer.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/databases/db1", + "name": "db1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/databases", + "properties": { + "charset": "utf8", + "collation": "en_US.utf8" + } + }, + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/databases/db2", + "name": "db2", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/databases", + "properties": { + "charset": "utf8", + "collation": "en_US.utf8" + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleCreate.json new file mode 100644 index 000000000000..e8eaba3ed0d6 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleCreate.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "firewallRuleName": "rule1", + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/servers/testserver/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/servers/testserver/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westcentralus/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westcentralus/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleDelete.json new file mode 100644 index 000000000000..ca6f8c0e994b --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "firewallRuleName": "rule1", + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + }, + "204": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleGet.json new file mode 100644 index 000000000000..a5b83aeca6c6 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "firewallRuleName": "rule1", + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/servers/testserver/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleListByServer.json new file mode 100644 index 000000000000..8f8080d52c88 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleListByServer.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff//resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/firewallRules?api-version=2024-08-01&$top=2&$skiptoken=skiptoken", + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + }, + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/firewallRules/rule2", + "name": "rule2", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "1.0.0.0", + "endIpAddress": "255.0.0.0" + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/GetPrivateDnsZoneSuffix.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/GetPrivateDnsZoneSuffix.json new file mode 100644 index 000000000000..a779e14c0918 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/GetPrivateDnsZoneSuffix.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": "postgres.database.azure.com" + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LogFilesListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LogFilesListByServer.json new file mode 100644 index 000000000000..711a4841b62a --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LogFilesListByServer.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serverName": "postgresqltestsvc1", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "sizeInKb": 1, + "createdTime": "0001-01-01T00:00:00+00:00", + "lastModifiedTime": "2018-03-01T06:09:20+00:00", + "type": "slowlog", + "url": "https://wasd2prodwus1afse42.file.core.windows.net/833c99b2f36c47349e5554b903fe0440/serverlogs/postgresql-slow-postgresqltestsvc1-2018022823.log?sv=2015-04-05&sr=f&se=2018-03-01T07%3A12%3A13Z&sp=r" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestsvc1/logFiles/postgresql-slow-postgresqltestsvc1-2018022823.log", + "name": "postgresql-slow-postgresqltestsvc1-2018022823.log", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/logFiles" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionBackup.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionBackup.json new file mode 100644 index 000000000000..9d0f0f15e0c8 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionBackup.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "rgLongTermRetention", + "serverName": "pgsqlltrtestserver", + "parameters": { + "backupSettings": { + "backupName": "backup1" + }, + "targetDetails": { + "sasUriList": [ + "sasuri" + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "datasourceSizeInBytes": 23, + "dataTransferredInBytes": 23, + "backupMetadata": "backupmetadata", + "status": "Running", + "startTime": "2023-04-13T01:32:30.128Z", + "endTime": "2023-04-13T01:32:30.128Z", + "percentComplete": 100 + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westcentralus/operationResults/ffc80e91-03db-4534-b5de-bacb77aa6a81?api-version=2024-08-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westcentralus/azureAsyncOperation/ffc80e91-03db-4534-b5de-bacb77aa6a81?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionOperationGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionOperationGet.json new file mode 100644 index 000000000000..d0052f12e428 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionOperationGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "rgLongTermRetention", + "serverName": "pgsqlltrtestserver", + "backupName": "backup1" + }, + "responses": { + "200": { + "body": { + "properties": { + "backupName": "backup1", + "datasourceSizeInBytes": 21, + "dataTransferredInBytes": 9, + "backupMetadata": "backupMetadata", + "status": "Running", + "percentComplete": 4, + "startTime": "2023-04-13T01:32:30.128Z", + "endTime": "2023-04-13T01:32:30.128Z" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/rgLongTermRetention/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgsqlltrtestserver", + "name": "backup1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/ltrbackupOperations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionOperationListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionOperationListByServer.json new file mode 100644 index 000000000000..45479950d71b --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionOperationListByServer.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "rgLongTermRetention", + "serverName": "pgsqlltrtestserver" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/rgLongTermRetention/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgsqlltrtestserver", + "name": "backup1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/ltrbackupOperations", + "properties": { + "backupName": "backup1", + "datasourceSizeInBytes": 21, + "dataTransferredInBytes": 9, + "backupMetadata": "backupMetadata", + "status": "Running", + "percentComplete": 4, + "startTime": "2023-04-13T01:32:30.128Z", + "endTime": "2023-04-13T01:32:30.128Z" + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionPreBackup.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionPreBackup.json new file mode 100644 index 000000000000..1b4488d9bb81 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionPreBackup.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "rgLongTermRetention", + "serverName": "pgsqlltrtestserver", + "parameters": { + "backupSettings": { + "backupName": "backup1" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "numberOfContainers": 1 + } + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Cancel.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Cancel.json new file mode 100644 index 000000000000..61a844350451 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Cancel.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationName": "testmigration", + "migrationMode": "Online", + "parameters": { + "properties": { + "cancel": "True" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "currentStatus": { + "state": "Canceled", + "currentSubStateDetails": { + "currentSubState": "Completed" + } + }, + "migrationMode": "Online", + "migrationWindowEndTimeInUtc": "2023-05-15T07:23:56.3260822Z", + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "postgres" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "True", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2023-05-15T07:22:57.7001251Z", + "migrateRoles": "False", + "sourceDbServerMetadata": { + "location": "eastasia", + "sku": { + "name": "B_Gen5_2", + "tier": "Basic" + } + }, + "targetDbServerMetadata": { + "location": "East Asia", + "sku": { + "name": "Standard_D2ds_v4", + "tier": "Standard_D2ds_v4" + } + } + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create.json new file mode 100644 index 000000000000..549c98233086 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationName": "testmigration", + "parameters": { + "properties": { + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "migrationInstanceResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testsourcemigration", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "secretParameters": { + "adminCredentials": { + "sourceServerPassword": "xxxxxxxx", + "targetServerPassword": "xxxxxxxx" + } + }, + "migrationMode": "Offline", + "overwriteDbsInTarget": "True" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "PerformingPreRequisiteSteps" + } + }, + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "False", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "False", + "migrationInstanceResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testsourcemigration" + }, + "tags": { + "key1624": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + }, + "201": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "PerformingPreRequisiteSteps" + } + }, + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "False", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "False", + "migrationInstanceResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testsourcemigration" + }, + "tags": { + "key1624": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_Other_SourceTypes_Validate_Migrate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_Other_SourceTypes_Validate_Migrate.json new file mode 100644 index 000000000000..7046573af57f --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_Other_SourceTypes_Validate_Migrate.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationName": "testmigration", + "parameters": { + "properties": { + "sourceDbServerResourceId": "testsource:5432@pguser", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "secretParameters": { + "adminCredentials": { + "sourceServerPassword": "xxxxxxxx", + "targetServerPassword": "xxxxxxxx" + } + }, + "migrationMode": "Offline", + "overwriteDbsInTarget": "True", + "migrationOption": "ValidateAndMigrate", + "sslMode": "Prefer", + "sourceType": "OnPremises" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "ValidationInProgress" + } + }, + "sourceDbServerResourceId": "testsource:5432@pguser", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "False", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "False", + "migrationOption": "ValidateAndMigrate", + "sslMode": "Prefer", + "sourceType": "OnPremises" + }, + "tags": { + "key1624": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + }, + "201": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "ValidationInProgress" + } + }, + "sourceDbServerResourceId": "testsource:5432@pguser", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "False", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "False", + "migrationOption": "ValidateAndMigrate", + "sslMode": "Prefer", + "sourceType": "OnPremises" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_Validate_Only.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_Validate_Only.json new file mode 100644 index 000000000000..ed2e832debc2 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_Validate_Only.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationName": "testmigration", + "parameters": { + "properties": { + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "secretParameters": { + "adminCredentials": { + "sourceServerPassword": "xxxxxxxx", + "targetServerPassword": "xxxxxxxx" + } + }, + "migrationMode": "Offline", + "overwriteDbsInTarget": "True", + "migrationOption": "Validate" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "ValidationInProgress" + } + }, + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "False", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "False", + "migrationOption": "Validate" + }, + "tags": { + "key1624": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + }, + "201": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "ValidationInProgress" + } + }, + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "False", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "False" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_With_Other_Users.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_With_Other_Users.json new file mode 100644 index 000000000000..aa3617170cef --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_With_Other_Users.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationName": "testmigration", + "parameters": { + "properties": { + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "secretParameters": { + "adminCredentials": { + "sourceServerPassword": "xxxxxxxx", + "targetServerPassword": "xxxxxxxx" + }, + "sourceServerUsername": "newadmin@testsource", + "targetServerUsername": "targetadmin" + }, + "migrationMode": "Offline" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "migrationMode": "Offline", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "PerformingPreRequisiteSteps" + } + }, + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "False", + "overwriteDbsInTarget": "False", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "False" + }, + "tags": { + "key1624": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + }, + "201": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "migrationMode": "Offline", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "PerformingPreRequisiteSteps" + } + }, + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "False", + "overwriteDbsInTarget": "False", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "False" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_With_PrivateEndpoint_Servers.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_With_PrivateEndpoint_Servers.json new file mode 100644 index 000000000000..549c98233086 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_With_PrivateEndpoint_Servers.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationName": "testmigration", + "parameters": { + "properties": { + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "migrationInstanceResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testsourcemigration", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "secretParameters": { + "adminCredentials": { + "sourceServerPassword": "xxxxxxxx", + "targetServerPassword": "xxxxxxxx" + } + }, + "migrationMode": "Offline", + "overwriteDbsInTarget": "True" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "PerformingPreRequisiteSteps" + } + }, + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "False", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "False", + "migrationInstanceResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testsourcemigration" + }, + "tags": { + "key1624": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + }, + "201": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "PerformingPreRequisiteSteps" + } + }, + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "False", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "False", + "migrationInstanceResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testsourcemigration" + }, + "tags": { + "key1624": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_With_Roles.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_With_Roles.json new file mode 100644 index 000000000000..9b8d0b921316 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_With_Roles.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationName": "testmigration", + "parameters": { + "properties": { + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "secretParameters": { + "adminCredentials": { + "sourceServerPassword": "xxxxxxxx", + "targetServerPassword": "xxxxxxxx" + } + }, + "migrationMode": "Offline", + "migrateRoles": "True", + "overwriteDbsInTarget": "True" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "PerformingPreRequisiteSteps" + } + }, + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "False", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "True" + }, + "tags": { + "key1624": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + }, + "201": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "PerformingPreRequisiteSteps" + } + }, + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "False", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "True" + }, + "tags": { + "key1624": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Delete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Delete.json new file mode 100644 index 000000000000..29f0dd25b619 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationName": "testmigration", + "migrationMode": "Offline" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Get.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Get.json new file mode 100644 index 000000000000..f8e107edac63 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Get.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationMode": "Offline", + "migrationName": "testmigration" + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "PerformingPreRequisiteSteps" + } + }, + "sourceDbServerMetadata": { + "location": "westus", + "version": "10", + "storageMb": 1024, + "sku": { + "name": "B_Gen5_2", + "tier": "Basic" + } + }, + "targetDbServerMetadata": { + "location": "westus", + "version": "11", + "storageMb": 2048, + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + } + }, + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "False", + "overwriteDbsInTarget": "False", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "False" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithSuccessfulValidationAndMigration.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithSuccessfulValidationAndMigration.json new file mode 100644 index 000000000000..681c36dd9edf --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithSuccessfulValidationAndMigration.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationMode": "Offline", + "migrationName": "testmigrationwithsuccessfulvalidationandmigration" + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "f2354e72-2828-4a19-ad20-b4cd9e2673c1", + "currentStatus": { + "state": "Succeeded", + "currentSubStateDetails": { + "currentSubState": "Completed", + "dbDetails": { + "testdb3": { + "databaseName": "testdb3", + "migrationState": "Succeeded", + "startedOn": "2023-10-12T05:55:28.9955656Z", + "endedOn": "2023-10-12T05:55:49.6813037Z", + "fullLoadErroredTables": 0, + "fullLoadQueuedTables": 0, + "fullLoadLoadingTables": 0, + "fullLoadCompletedTables": 10, + "cdcUpdateCounter": 0, + "cdcDeleteCounter": 0, + "cdcInsertCounter": 0, + "appliedChanges": 0, + "incomingChanges": 0, + "latency": 0 + } + }, + "validationDetails": { + "status": "Succeeded", + "validationStartTimeInUtc": "2023-10-12T05:54:28.0774816Z", + "validationEndTimeInUtc": "2023-10-12T05:55:00.4998326Z", + "serverLevelValidationDetails": [ + { + "type": "AuthenticationAndConnectivityValidation", + "state": "Succeeded" + }, + { + "type": "SourceVersionValidation", + "state": "Succeeded" + }, + { + "type": "ServerParametersValidation", + "state": "Succeeded" + } + ], + "dbLevelValidationDetails": [ + { + "databaseName": "testdb3", + "startedOn": "2023-10-12T05:54:29.5531609Z", + "endedOn": "2023-10-12T05:54:29.8948914Z", + "summary": [ + { + "type": "SchemaValidation", + "state": "Succeeded" + }, + { + "type": "ExtensionsValidation", + "state": "Succeeded" + }, + { + "type": "CollationsValidation", + "state": "Succeeded" + } + ] + } + ] + } + } + }, + "migrationMode": "Offline", + "migrationWindowEndTimeInUtc": "2023-10-12T05:57:30.7364856Z", + "sourceDbServerResourceId": "20.228.214.65:5432@postgres", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "testdb3" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "True", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2023-10-12T05:54:15.9991596Z", + "triggerCutover": "True", + "migrateRoles": "False", + "migrationOption": "ValidateAndMigrate" + }, + "location": "eastus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigrationwithsuccessfulvalidationandmigration", + "name": "testmigrationwithsuccessfulvalidationandmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithSuccessfulValidationButMigrationFailure.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithSuccessfulValidationButMigrationFailure.json new file mode 100644 index 000000000000..a7b9cf474546 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithSuccessfulValidationButMigrationFailure.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationMode": "Offline", + "migrationName": "testmigrationwithsuccessfulvalidationbutmigrationfailure" + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "da52db29-cfeb-4670-a1ad-683edb14c621", + "currentStatus": { + "state": "Failed", + "error": "testdb6: Collation/Encoding not Supported Error: User defined Collations are present in the source database. Please drop them before retrying the migration. ", + "currentSubStateDetails": { + "currentSubState": "Completed", + "dbDetails": { + "testdb6": { + "databaseName": "testdb6", + "migrationState": "Failed", + "startedOn": "2023-08-21T13:09:52.9226008Z", + "endedOn": "2023-08-21T13:09:53.2526436Z", + "fullLoadErroredTables": 0, + "fullLoadQueuedTables": 0, + "fullLoadLoadingTables": 0, + "fullLoadCompletedTables": 0, + "cdcUpdateCounter": 0, + "cdcDeleteCounter": 0, + "cdcInsertCounter": 0, + "appliedChanges": 0, + "incomingChanges": 0, + "latency": 0, + "message": "Collation/Encoding not Supported Error: User defined Collations are present in the source database. Please drop them before retrying the migration." + } + }, + "validationDetails": { + "status": "Succeeded", + "validationStartTimeInUtc": "2023-08-21T13:04:21.6230786Z", + "validationEndTimeInUtc": "2023-08-21T13:04:24.5659891Z", + "serverLevelValidationDetails": [ + { + "type": "AuthenticationAndConnectivityValidation", + "state": "Succeeded" + } + ], + "dbLevelValidationDetails": [ + { + "databaseName": "address_standardizer", + "startedOn": "2023-08-21T13:04:24.5659891+00:00", + "endedOn": "2023-08-21T13:04:24.5659891+00:00", + "summary": [ + { + "type": "ExtensionsValidation", + "state": "Succeeded" + } + ] + } + ] + } + } + }, + "migrationMode": "Offline", + "migrationWindowEndTimeInUtc": "2023-08-21T13:04:24.5659891Z", + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/source-rg/providers/Microsoft.DBforPostgreSQL/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testtarget", + "dbsToMigrate": [ + "testdb6" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "True", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2023-08-21T13:04:24.5659891Z", + "sourceDbServerMetadata": { + "location": "eastus2", + "storageMb": 102400, + "sku": {} + }, + "targetDbServerMetadata": { + "location": "East US 2", + "storageMb": 131072, + "sku": { + "name": "Standard_D2ds_v4", + "tier": "Standard_D2ds_v4" + } + }, + "migrateRoles": "False", + "migrationOption": "ValidateAndMigrate" + }, + "location": "eastus2", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigrationwithsuccessfulvalidationbutmigrationfailure", + "name": "testmigrationwithsuccessfulvalidationbutmigrationfailure", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithSuccessfulValidationOnly.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithSuccessfulValidationOnly.json new file mode 100644 index 000000000000..34c1e47cb3a6 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithSuccessfulValidationOnly.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationName": "testmigrationwithsuccessfulvalidationonly" + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "77840327-7be8-44b8-adc0-af0ccccfeb36", + "currentStatus": { + "state": "Succeeded", + "currentSubStateDetails": { + "currentSubState": "Completed", + "dbDetails": {}, + "validationDetails": { + "status": "Succeeded", + "validationStartTimeInUtc": "2023-10-16T05:29:35.634943Z", + "validationEndTimeInUtc": "2023-10-16T05:29:39.6663198Z", + "serverLevelValidationDetails": [ + { + "type": "AuthenticationAndConnectivityValidation", + "state": "Succeeded" + }, + { + "type": "SourceVersionValidation", + "state": "Succeeded" + }, + { + "type": "ServerParametersValidation", + "state": "Succeeded" + } + ], + "dbLevelValidationDetails": [ + { + "databaseName": "UnknownCollationTest", + "startedOn": "2023-10-16T05:29:38.904366Z", + "endedOn": "2023-10-16T05:29:39.2488086Z", + "summary": [ + { + "type": "SchemaValidation", + "state": "Succeeded" + }, + { + "type": "ExtensionsValidation", + "state": "Succeeded" + }, + { + "type": "CollationsValidation", + "state": "Succeeded" + } + ] + } + ] + } + } + }, + "migrationMode": "Offline", + "migrationWindowEndTimeInUtc": "2023-10-16T05:30:05.8854373Z", + "sourceDbServerResourceId": "20.228.214.65:5432@postgres", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "UnknownCollationTest" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "True", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2023-10-16T05:28:58.7751329Z", + "triggerCutover": "True", + "migrateRoles": "False", + "migrationOption": "Validate" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigrationwithsuccessfulvalidationonly", + "name": "testmigrationwithsuccessfulvalidationonly", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithValidationFailures.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithValidationFailures.json new file mode 100644 index 000000000000..e2e93f79f6a4 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithValidationFailures.json @@ -0,0 +1,198 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationName": "testmigrationwithvalidationfailure" + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "a3e2d3cc-b139-4201-9431-e4f3003140fd", + "currentStatus": { + "state": "ValidationFailed", + "currentSubStateDetails": { + "currentSubState": "Completed", + "dbDetails": {}, + "validationDetails": { + "status": "Failed", + "validationStartTimeInUtc": "2023-10-17T19:19:59.91782Z", + "validationEndTimeInUtc": "2023-10-17T19:20:33.1368946Z", + "serverLevelValidationDetails": [ + { + "type": "AuthenticationAndConnectivityValidation", + "state": "Succeeded" + }, + { + "type": "SourceVersionValidation", + "state": "Succeeded" + }, + { + "type": "ServerParametersValidation", + "state": "Succeeded" + } + ], + "dbLevelValidationDetails": [ + { + "databaseName": "c.utf-8", + "startedOn": "2023-10-17T19:20:01.830801Z", + "endedOn": "2023-10-17T19:20:02.810871Z", + "summary": [ + { + "type": "SchemaValidation", + "state": "Succeeded" + }, + { + "type": "ExtensionsValidation", + "state": "Failed", + "messages": [ + { + "state": "Failed", + "message": "Unsupported Extension. Single to Flex migration tool does not support migration of databases having postgres_fdw extension. Consider performing the migration through other migration tools such as pg_dump/pg_restore (https://aka.ms/migrate-using-pgdump-restore)" + } + ] + }, + { + "type": "CollationsValidation", + "state": "Succeeded" + } + ] + }, + { + "databaseName": "postgres", + "startedOn": "2023-10-17T19:20:01.8309442Z", + "endedOn": "2023-10-17T19:20:02.8109414Z", + "summary": [ + { + "type": "SchemaValidation", + "state": "Succeeded" + }, + { + "type": "ExtensionsValidation", + "state": "Succeeded" + }, + { + "type": "CollationsValidation", + "state": "Succeeded" + } + ] + }, + { + "databaseName": "readme_to_recover", + "startedOn": "2023-10-17T19:20:01.8309447Z", + "endedOn": "2023-10-17T19:20:02.8109415Z", + "summary": [ + { + "type": "SchemaValidation", + "state": "Succeeded" + }, + { + "type": "ExtensionsValidation", + "state": "Succeeded" + }, + { + "type": "CollationsValidation", + "state": "Succeeded" + } + ] + }, + { + "databaseName": "testdb1", + "startedOn": "2023-10-17T19:20:01.8309448Z", + "endedOn": "2023-10-17T19:20:02.8109416Z", + "summary": [ + { + "type": "SchemaValidation", + "state": "Succeeded" + }, + { + "type": "ExtensionsValidation", + "state": "Succeeded" + } + ] + }, + { + "databaseName": "testdb2", + "startedOn": "2023-10-17T19:20:01.830945Z", + "endedOn": "2023-10-17T19:20:02.8109418Z", + "summary": [ + { + "type": "SchemaValidation", + "state": "Succeeded" + }, + { + "type": "ExtensionsValidation", + "state": "Succeeded" + } + ] + }, + { + "databaseName": "testSchema", + "startedOn": "2023-10-17T19:20:01.8309464Z", + "endedOn": "2023-10-17T19:20:02.8109419Z", + "summary": [ + { + "type": "SchemaValidation", + "state": "Succeeded" + }, + { + "type": "ExtensionsValidation", + "state": "Succeeded" + } + ] + }, + { + "databaseName": "UnknownCollationTest", + "startedOn": "2023-10-17T19:20:01.8309465Z", + "endedOn": "2023-10-17T19:20:02.810942Z", + "summary": [ + { + "type": "SchemaValidation", + "state": "Succeeded" + }, + { + "type": "ExtensionsValidation", + "state": "Failed", + "messages": [ + { + "state": "Failed", + "message": "Unsupported Extension. Single to Flex migration tool does not support migration of databases having postgres_fdw extension. Consider performing the migration through other migration tools such as pg_dump/pg_restore (https://aka.ms/migrate-using-pgdump-restore)" + } + ] + } + ] + } + ] + } + } + }, + "migrationMode": "Offline", + "migrationWindowEndTimeInUtc": "2023-10-17T19:21:00.0434143Z", + "sourceDbServerResourceId": "20.228.214.65:5432@postgres", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testtarget", + "dbsToMigrate": [ + "c.utf-8", + "postgres", + "readme_to_recover", + "testdb1", + "testdb2", + "testSchema", + "UnknownCollationTest" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "True", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2023-10-17T19:19:47.4488908Z", + "triggerCutover": "True", + "migrateRoles": "False", + "migrationOption": "Validate" + }, + "location": "East US", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testtarget/migrations/testmigrationwithvalidationfailure", + "name": "testmigrationwithvalidationfailure", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_ListByTargetServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_ListByTargetServer.json new file mode 100644 index 000000000000..71ba3ef6acd8 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_ListByTargetServer.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationListFilter": "All" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "PerformingPreRequisiteSteps" + } + }, + "sourceDbServerMetadata": { + "location": "westus", + "version": "10", + "storageMb": 1024, + "sku": { + "name": "B_Gen5_2", + "tier": "Basic" + } + }, + "targetDbServerMetadata": { + "location": "westus", + "version": "11", + "storageMb": 2048, + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + } + }, + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "False", + "overwriteDbsInTarget": "False", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "False" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Update.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Update.json new file mode 100644 index 000000000000..291832a2720b --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Update.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationName": "testmigration", + "migrationMode": "Offline", + "parameters": { + "properties": { + "setupLogicalReplicationOnSourceDbIfNeeded": "True" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "PerformingPreRequisiteSteps" + } + }, + "sourceDbServerMetadata": { + "location": "westus", + "version": "10", + "storageMb": 1024, + "sku": { + "name": "B_Gen5_2", + "tier": "Basic" + } + }, + "targetDbServerMetadata": { + "location": "westus", + "version": "11", + "storageMb": 2048, + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + } + }, + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "True", + "overwriteDbsInTarget": "False", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "False" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/OperationList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/OperationList.json new file mode 100644 index 000000000000..3f20a67540e2 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/OperationList.json @@ -0,0 +1,176 @@ +{ + "parameters": { + "api-version": "2024-08-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/read", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "PostgreSQL Server", + "operation": "List/Get PostgreSQL Servers", + "description": "Return the list of servers or gets the properties for the specified server." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/write", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "PostgreSQL Server", + "operation": "Create/Update PostgreSQL Server", + "description": "Creates a server with the specified parameters or update the properties or tags for the specified server." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/delete", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "PostgreSQL Server", + "operation": "Delete PostgreSQL Server", + "description": "Deletes an existing server." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules/read", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Firewall Rules", + "operation": "List/Get Firewall Rules", + "description": "Return the list of firewall rules for a server or gets the properties for the specified firewall rule." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules/write", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Firewall Rules", + "operation": "Create/Update Firewall Rule", + "description": "Creates a firewall rule with the specified parameters or update an existing rule." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules/delete", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Firewall Rules", + "operation": "Delete Firewall Rule", + "description": "Deletes an existing firewall rule." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Database Metric Definition", + "operation": "Get database metric definitions", + "description": "Return types of metrics that are available for databases" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "cpu_percent", + "displayName": "CPU percent", + "displayDescription": "CPU percent", + "unit": "Percent", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "compute_limit", + "displayName": "Compute Unit limit", + "displayDescription": "Compute Unit limit", + "unit": "Count", + "aggregationType": "Average" + }, + { + "name": "compute_consumption_percent", + "displayName": "Compute Unit percentage", + "displayDescription": "Compute Unit percentage", + "unit": "Percent", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "memory_percent", + "displayName": "Memory percent", + "displayDescription": "Memory percent", + "unit": "Percent", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "io_consumption_percent", + "displayName": "IO percent", + "displayDescription": "IO percent", + "unit": "Percent", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "storage_percent", + "displayName": "Storage percentage", + "displayDescription": "Storage percentage", + "unit": "Percent", + "aggregationType": "Average" + }, + { + "name": "storage_used", + "displayName": "Storage used", + "displayDescription": "Storage used", + "unit": "Bytes", + "aggregationType": "Average" + }, + { + "name": "storage_limit", + "displayName": "Storage limit", + "displayDescription": "Storage limit", + "unit": "Bytes", + "aggregationType": "Average" + }, + { + "name": "active_connections", + "displayName": "Total active connections", + "displayDescription": "Total active connections", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "connections_failed", + "displayName": "Total failed connections", + "displayDescription": "Total failed connections", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": true + } + ] + } + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Database Metric Definition", + "operation": "Read diagnostic setting", + "description": "Gets the disagnostic setting for the resource" + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Database Metric Definition", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource" + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionDelete.json new file mode 100644 index 000000000000..0713d9153e76 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "Default", + "serverName": "test-svr", + "privateEndpointConnectionName": "private-endpoint-connection-name.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "api-version": "2024-08-01" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + }, + "204": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionGet.json new file mode 100644 index 000000000000..ab1d1bf2c879 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "Default", + "serverName": "test-svr", + "privateEndpointConnectionName": "private-endpoint-connection-name.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "api-version": "2024-08-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/Default/providers/Microsoft.DBforPostgreSQL/flexibleServers/test-svr/privateEndpointConnections/private-endpoint-connection-name.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "private-endpoint-connection-name.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/privateEndpointConnections", + "properties": { + "provisioningState": "Ready", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "groupIds": [ + "postgresqlServer" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionList.json new file mode 100644 index 000000000000..c7ce34bf9c64 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionList.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "Default", + "serverName": "test-svr", + "api-version": "2024-08-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.DBforPostgreSQL/flexibleServers/test-svr/privateEndpointConnections/private-endpoint-connection-name.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "private-endpoint-connection-name.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/privateEndpointConnections", + "properties": { + "provisioningState": "Ready", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "groupIds": [ + "postgresqlServer" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.DBforPostgreSQL/flexibleServers/test-svr/privateEndpointConnections/private-endpoint-connection-name-2.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "private-endpoint-connection-name-2.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/privateEndpointConnections", + "properties": { + "provisioningState": "Ready", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name-2" + }, + "groupIds": [ + "postgresqlServer" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionUpdate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionUpdate.json new file mode 100644 index 000000000000..8d6f796d91fe --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionUpdate.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "Default", + "serverName": "test-svr", + "privateEndpointConnectionName": "private-endpoint-connection-name.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "api-version": "2024-08-01", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/Default/providers/Microsoft.DBforPostgreSQL/flexibleServers/test-svr/privateEndpointConnections/private-endpoint-connection-name.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "private-endpoint-connection-name.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/privateEndpointConnections", + "properties": { + "provisioningState": "Ready", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "groupIds": [ + "postgresqlServer" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com", + "actionsRequired": "None" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/Default/providers/Microsoft.DBforPostgreSQL/flexibleServers/test-svr/privateEndpointConnections/private-endpoint-connection-name.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "private-endpoint-connection-name.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/privateEndpointConnections", + "properties": { + "provisioningState": "Ready", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "groupIds": [ + "postgresqlServer" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com", + "actionsRequired": "None" + } + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateLinkResourcesGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateLinkResourcesGet.json new file mode 100644 index 000000000000..7a0e05d8fea3 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateLinkResourcesGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "Default", + "serverName": "test-svr", + "groupName": "plr", + "api-version": "2024-08-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/Default/providers/Microsoft.DBforPostgreSQL/flexibleServers/test-svr/privateLinkResources/plr", + "name": "plr", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/privateLinkResources", + "properties": { + "groupId": "postgresqlServer", + "requiredMembers": [ + "postgresqlServer" + ], + "requiredZoneNames": [ + "privatelink.meru.com" + ] + } + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateLinkResourcesList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateLinkResourcesList.json new file mode 100644 index 000000000000..ab8f7af523a7 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateLinkResourcesList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "Default", + "serverName": "test-svr", + "api-version": "2024-08-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/Default/providers/Microsoft.DBforPostgreSQL/flexibleServers/test-svr/privateLinkResources/plr", + "name": "plr", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/privateLinkResources", + "properties": { + "groupId": "postgresqlServer", + "requiredMembers": [ + "postgresqlServer" + ], + "requiredZoneNames": [ + "privatelink.meru.com" + ] + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsForcedStandaloneServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsForcedStandaloneServer.json new file mode 100644 index 000000000000..e457d257474f --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsForcedStandaloneServer.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "serverName": "pgtestsvc4-replica", + "resourceGroupName": "testResourceGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "replica": { + "promoteMode": "standalone", + "promoteOption": "forced" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D8s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc4-replica.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "dataEncryption": { + "type": "SystemManaged" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "storage": { + "storageSizeGB": 1024, + "autoGrow": "Enabled", + "tier": "P30", + "iops": 5000 + }, + "backup": { + "backupRetentionDays": 20, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replica": { + "role": "None", + "capacity": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4-replica", + "name": "pgtestsvc4-replica", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsForcedSwitchover.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsForcedSwitchover.json new file mode 100644 index 000000000000..687db5fe6629 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsForcedSwitchover.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "serverName": "pgtestsvc4-replica", + "resourceGroupName": "testResourceGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "replica": { + "promoteMode": "switchover", + "promoteOption": "forced" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D8s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc4-replica.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "dataEncryption": { + "type": "SystemManaged" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "storage": { + "storageSizeGB": 1024, + "autoGrow": "Enabled", + "tier": "P30", + "iops": 5000 + }, + "backup": { + "backupRetentionDays": 20, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replica": { + "role": "Primary", + "capacity": 5 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4-replica", + "name": "pgtestsvc4-replica", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsPlannedStandaloneServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsPlannedStandaloneServer.json new file mode 100644 index 000000000000..036925086d22 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsPlannedStandaloneServer.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "serverName": "pgtestsvc4-replica", + "resourceGroupName": "testResourceGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "replica": { + "promoteMode": "standalone", + "promoteOption": "planned" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D8s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc4-replica.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "dataEncryption": { + "type": "SystemManaged" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "storage": { + "storageSizeGB": 1024, + "autoGrow": "Enabled", + "tier": "P30", + "iops": 5000 + }, + "backup": { + "backupRetentionDays": 20, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replica": { + "role": "None", + "capacity": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4-replica", + "name": "pgtestsvc4-replica", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsPlannedSwitchover.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsPlannedSwitchover.json new file mode 100644 index 000000000000..b6225e6163af --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsPlannedSwitchover.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "serverName": "pgtestsvc4-replica", + "resourceGroupName": "testResourceGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "replica": { + "promoteMode": "switchover", + "promoteOption": "planned" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D8s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc4-replica.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "dataEncryption": { + "type": "SystemManaged" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "storage": { + "storageSizeGB": 1024, + "autoGrow": "Enabled", + "tier": "P30", + "iops": 5000 + }, + "backup": { + "backupRetentionDays": 20, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replica": { + "role": "Primary", + "capacity": 5 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4-replica", + "name": "pgtestsvc4-replica", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ReplicasListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ReplicasListByServer.json new file mode 100644 index 000000000000..18c1f4e71a68 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ReplicasListByServer.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "serverName": "sourcepgservername", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc5rep.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "2", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "dataEncryption": { + "type": "SystemManaged" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "AsyncReplica", + "replicaCapacity": 0, + "replica": { + "role": "AsyncReplica", + "capacity": 0, + "replicationState": "Active" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5rep", + "name": "pgtestsvc5rep", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCapabilities.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCapabilities.json new file mode 100644 index 000000000000..842608f58c5f --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCapabilities.json @@ -0,0 +1,2154 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "FlexibleServerCapabilities", + "supportedServerEditions": [ + { + "name": "Burstable", + "defaultSkuName": "Standard_B1ms", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "defaultStorageSizeMb": 32768, + "supportedStorageMb": [ + { + "supportedIops": 120, + "storageSizeMb": 32768, + "defaultIopsTier": "P4", + "supportedIopsTiers": [ + { + "name": "P4", + "iops": 120 + }, + { + "name": "P6", + "iops": 240 + }, + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 240, + "storageSizeMb": 65536, + "defaultIopsTier": "P6", + "supportedIopsTiers": [ + { + "name": "P6", + "iops": 240 + }, + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 500, + "storageSizeMb": 131072, + "defaultIopsTier": "P10", + "supportedIopsTiers": [ + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 1100, + "storageSizeMb": 262144, + "defaultIopsTier": "P15", + "supportedIopsTiers": [ + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 2300, + "storageSizeMb": 524288, + "defaultIopsTier": "P20", + "supportedIopsTiers": [ + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 5000, + "storageSizeMb": 1048576, + "defaultIopsTier": "P30", + "supportedIopsTiers": [ + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 2097152, + "defaultIopsTier": "P40", + "supportedIopsTiers": [ + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 4193280, + "defaultIopsTier": "P50", + "supportedIopsTiers": [ + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 4194304, + "defaultIopsTier": "P50", + "supportedIopsTiers": [ + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 16000, + "storageSizeMb": 8388608, + "defaultIopsTier": "P60", + "supportedIopsTiers": [ + { + "name": "P60", + "iops": 16000 + }, + { + "name": "P70", + "iops": 18000 + }, + { + "name": "P80", + "iops": 20000 + } + ] + }, + { + "supportedIops": 18000, + "storageSizeMb": 16777216, + "defaultIopsTier": "P70", + "supportedIopsTiers": [ + { + "name": "P70", + "iops": 18000 + }, + { + "name": "P80", + "iops": 20000 + } + ] + }, + { + "supportedIops": 20000, + "storageSizeMb": 33553408, + "defaultIopsTier": "P80", + "supportedIopsTiers": [ + { + "name": "P80", + "iops": 20000 + } + ] + } + ] + }, + { + "name": "ManagedDiskV2", + "defaultStorageSizeMb": 32768, + "supportedStorageMb": [ + { + "supportedIops": 3000, + "supportedMaximumIops": 80000, + "storageSizeMb": 32768, + "maximumStorageSizeMb": 67108864, + "supportedThroughput": 125, + "supportedMaximumThroughput": 1200, + "defaultIopsTier": "None", + "supportedIopsTiers": [ + { + "name": "None", + "iops": 0 + } + ] + } + ] + } + ], + "supportedServerSkus": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMb": 2048, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMb": 2048, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_B2ms", + "vCores": 2, + "supportedIops": 1920, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_B4ms", + "vCores": 4, + "supportedIops": 2880, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_B8ms", + "vCores": 8, + "supportedIops": 4320, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_B12ms", + "vCores": 12, + "supportedIops": 4320, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_B16ms", + "vCores": 16, + "supportedIops": 4320, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_B20ms", + "vCores": 20, + "supportedIops": 4320, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + } + ] + }, + { + "name": "GeneralPurpose", + "defaultSkuName": "Standard_D4ads_v5", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "defaultStorageSizeMb": 65536, + "supportedStorageMb": [ + { + "supportedIops": 120, + "storageSizeMb": 32768, + "defaultIopsTier": "P4", + "supportedIopsTiers": [ + { + "name": "P4", + "iops": 120 + }, + { + "name": "P6", + "iops": 240 + }, + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 240, + "storageSizeMb": 65536, + "defaultIopsTier": "P6", + "supportedIopsTiers": [ + { + "name": "P6", + "iops": 240 + }, + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 500, + "storageSizeMb": 131072, + "defaultIopsTier": "P10", + "supportedIopsTiers": [ + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 1100, + "storageSizeMb": 262144, + "defaultIopsTier": "P15", + "supportedIopsTiers": [ + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 2300, + "storageSizeMb": 524288, + "defaultIopsTier": "P20", + "supportedIopsTiers": [ + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 5000, + "storageSizeMb": 1048576, + "defaultIopsTier": "P30", + "supportedIopsTiers": [ + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 2097152, + "defaultIopsTier": "P40", + "supportedIopsTiers": [ + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 4193280, + "defaultIopsTier": "P50", + "supportedIopsTiers": [ + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 4194304, + "defaultIopsTier": "P50", + "supportedIopsTiers": [ + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 16000, + "storageSizeMb": 8388608, + "defaultIopsTier": "P60", + "supportedIopsTiers": [ + { + "name": "P60", + "iops": 16000 + }, + { + "name": "P70", + "iops": 18000 + }, + { + "name": "P80", + "iops": 20000 + } + ] + }, + { + "supportedIops": 18000, + "storageSizeMb": 16777216, + "defaultIopsTier": "P70", + "supportedIopsTiers": [ + { + "name": "P70", + "iops": 18000 + }, + { + "name": "P80", + "iops": 20000 + } + ] + }, + { + "supportedIops": 20000, + "storageSizeMb": 33553408, + "defaultIopsTier": "P80", + "supportedIopsTiers": [ + { + "name": "P80", + "iops": 20000 + } + ] + } + ] + }, + { + "name": "ManagedDiskV2", + "defaultStorageSizeMb": 65536, + "supportedStorageMb": [ + { + "supportedIops": 3000, + "supportedMaximumIops": 80000, + "storageSizeMb": 32768, + "maximumStorageSizeMb": 67108864, + "supportedThroughput": 125, + "supportedMaximumThroughput": 1200, + "defaultIopsTier": "None", + "supportedIopsTiers": [ + { + "name": "None", + "iops": 0 + } + ] + } + ] + } + ], + "supportedServerSkus": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D2ads_v5", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D4ads_v5", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D8ads_v5", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D16ads_v5", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D32ads_v5", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D48ads_v5", + "vCores": 48, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D64ads_v5", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D96ads_v5", + "vCores": 96, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D2ds_v5", + "vCores": 2, + "supportedIops": 3750, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D4ds_v5", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D8ds_v5", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D16ds_v5", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D32ds_v5", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D48ds_v5", + "vCores": 48, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D64ds_v5", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D96ds_v5", + "vCores": 96, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + } + ] + }, + { + "name": "MemoryOptimized", + "defaultSkuName": "Standard_E4ads_v5", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "defaultStorageSizeMb": 131072, + "supportedStorageMb": [ + { + "supportedIops": 120, + "storageSizeMb": 32768, + "defaultIopsTier": "P4", + "supportedIopsTiers": [ + { + "name": "P4", + "iops": 120 + }, + { + "name": "P6", + "iops": 240 + }, + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 240, + "storageSizeMb": 65536, + "defaultIopsTier": "P6", + "supportedIopsTiers": [ + { + "name": "P6", + "iops": 240 + }, + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 500, + "storageSizeMb": 131072, + "defaultIopsTier": "P10", + "supportedIopsTiers": [ + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 1100, + "storageSizeMb": 262144, + "defaultIopsTier": "P15", + "supportedIopsTiers": [ + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 2300, + "storageSizeMb": 524288, + "defaultIopsTier": "P20", + "supportedIopsTiers": [ + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 5000, + "storageSizeMb": 1048576, + "defaultIopsTier": "P30", + "supportedIopsTiers": [ + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 2097152, + "defaultIopsTier": "P40", + "supportedIopsTiers": [ + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 4193280, + "defaultIopsTier": "P50", + "supportedIopsTiers": [ + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 4194304, + "defaultIopsTier": "P50", + "supportedIopsTiers": [ + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 16000, + "storageSizeMb": 8388608, + "defaultIopsTier": "P60", + "supportedIopsTiers": [ + { + "name": "P60", + "iops": 16000 + }, + { + "name": "P70", + "iops": 18000 + }, + { + "name": "P80", + "iops": 20000 + } + ] + }, + { + "supportedIops": 18000, + "storageSizeMb": 16777216, + "defaultIopsTier": "P70", + "supportedIopsTiers": [ + { + "name": "P70", + "iops": 18000 + }, + { + "name": "P80", + "iops": 20000 + } + ] + }, + { + "supportedIops": 20000, + "storageSizeMb": 33553408, + "defaultIopsTier": "P80", + "supportedIopsTiers": [ + { + "name": "P80", + "iops": 20000 + } + ] + } + ] + }, + { + "name": "ManagedDiskV2", + "defaultStorageSizeMb": 131072, + "supportedStorageMb": [ + { + "supportedIops": 3000, + "supportedMaximumIops": 80000, + "storageSizeMb": 32768, + "maximumStorageSizeMb": 67108864, + "supportedThroughput": 125, + "supportedMaximumThroughput": 1200, + "defaultIopsTier": "None", + "supportedIopsTiers": [ + { + "name": "None", + "iops": 0 + } + ] + } + ] + } + ], + "supportedServerSkus": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 32000, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 6912, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 32000, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 6912, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E2ads_v5", + "vCores": 2, + "supportedIops": 3750, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E4ads_v5", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E8ads_v5", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E16ads_v5", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E20ads_v5", + "vCores": 20, + "supportedIops": 32000, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E32ads_v5", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E48ads_v5", + "vCores": 48, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E64ads_v5", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E96ads_v5", + "vCores": 96, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 7168, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E2ds_v5", + "vCores": 2, + "supportedIops": 3750, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E4ds_v5", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E8ds_v5", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E16ds_v5", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E20ds_v5", + "vCores": 20, + "supportedIops": 32000, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E32ds_v5", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E48ds_v5", + "vCores": 48, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E64ds_v5", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E96ds_v5", + "vCores": 96, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 7168, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + } + ] + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVersionsToUpgrade": [ + "12", + "13", + "14", + "15", + "16" + ] + }, + { + "name": "12", + "supportedVersionsToUpgrade": [ + "13", + "14", + "15", + "16" + ] + }, + { + "name": "13", + "supportedVersionsToUpgrade": [ + "14", + "15", + "16" + ] + }, + { + "name": "14", + "supportedVersionsToUpgrade": [ + "15", + "16" + ] + }, + { + "name": "15", + "supportedVersionsToUpgrade": [ + "16" + ] + }, + { + "name": "16", + "supportedVersionsToUpgrade": [] + } + ], + "fastProvisioningSupported": "Enabled", + "supportedFastProvisioningEditions": [ + { + "supportedTier": "Burstable", + "supportedSku": "standard_b1ms", + "supportedStorageGb": 32, + "supportedServerVersions": "12", + "serverCount": 0 + }, + { + "supportedTier": "Burstable", + "supportedSku": "standard_b2s", + "supportedStorageGb": 32, + "supportedServerVersions": "12", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2s_v3", + "supportedStorageGb": 128, + "supportedServerVersions": "12", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2ds_v4", + "supportedStorageGb": 128, + "supportedServerVersions": "12", + "serverCount": 0 + }, + { + "supportedTier": "MemoryOptimized", + "supportedSku": "standard_e2ds_v4", + "supportedStorageGb": 512, + "supportedServerVersions": "12", + "serverCount": 0 + }, + { + "supportedTier": "Burstable", + "supportedSku": "standard_b1ms", + "supportedStorageGb": 32, + "supportedServerVersions": "13", + "serverCount": 0 + }, + { + "supportedTier": "Burstable", + "supportedSku": "standard_b2s", + "supportedStorageGb": 32, + "supportedServerVersions": "13", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2s_v3", + "supportedStorageGb": 128, + "supportedServerVersions": "13", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2ds_v4", + "supportedStorageGb": 128, + "supportedServerVersions": "13", + "serverCount": 0 + }, + { + "supportedTier": "MemoryOptimized", + "supportedSku": "standard_e2ds_v4", + "supportedStorageGb": 512, + "supportedServerVersions": "13", + "serverCount": 0 + }, + { + "supportedTier": "Burstable", + "supportedSku": "standard_b1ms", + "supportedStorageGb": 32, + "supportedServerVersions": "14", + "serverCount": 0 + }, + { + "supportedTier": "Burstable", + "supportedSku": "standard_b2s", + "supportedStorageGb": 32, + "supportedServerVersions": "14", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2s_v3", + "supportedStorageGb": 128, + "supportedServerVersions": "14", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2ds_v4", + "supportedStorageGb": 128, + "supportedServerVersions": "14", + "serverCount": 0 + }, + { + "supportedTier": "MemoryOptimized", + "supportedSku": "standard_e2ds_v4", + "supportedStorageGb": 512, + "supportedServerVersions": "14", + "serverCount": 0 + }, + { + "supportedTier": "Burstable", + "supportedSku": "standard_b1ms", + "supportedStorageGb": 32, + "supportedServerVersions": "15", + "serverCount": 0 + }, + { + "supportedTier": "Burstable", + "supportedSku": "standard_b2s", + "supportedStorageGb": 32, + "supportedServerVersions": "15", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2s_v3", + "supportedStorageGb": 128, + "supportedServerVersions": "15", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2ds_v4", + "supportedStorageGb": 128, + "supportedServerVersions": "15", + "serverCount": 0 + }, + { + "supportedTier": "MemoryOptimized", + "supportedSku": "standard_e2ds_v4", + "supportedStorageGb": 512, + "supportedServerVersions": "15", + "serverCount": 0 + } + ], + "geoBackupSupported": "Enabled", + "zoneRedundantHaSupported": "Enabled", + "zoneRedundantHaAndGeoBackupSupported": "Enabled", + "storageAutoGrowthSupported": "Enabled", + "onlineResizeSupported": "Enabled", + "restricted": "Disabled" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreate.json new file mode 100644 index 000000000000..e44426b5557d --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreate.json @@ -0,0 +1,158 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "cloudsa", + "administratorLoginPassword": "password", + "version": "12", + "availabilityZone": "1", + "createMode": "Create", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled" + }, + "network": { + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourcegroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant" + } + }, + "tags": { + "ElasticServer": "1" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "dataEncryption": { + "type": "SystemManaged" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:08:06.7197478+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "dataEncryption": { + "type": "SystemManaged" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:08:06.7197478+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateGeoRestoreWithDataEncryptionEnabled.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateGeoRestoreWithDataEncryptionEnabled.json new file mode 100644 index 000000000000..beee3658c5f9 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateGeoRestoreWithDataEncryptionEnabled.json @@ -0,0 +1,179 @@ +{ + "parameters": { + "serverName": "pgtestsvc5geo", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "eastus", + "identity": { + "userAssignedIdentities": { + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity": {}, + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity": {} + }, + "type": "UserAssigned" + }, + "properties": { + "createMode": "GeoRestore", + "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/sourcepgservername", + "pointInTimeUTC": "2021-06-27T00:04:59.4078005+00:00", + "dataEncryption": { + "type": "AzureKeyVault", + "primaryKeyURI": "https://test-kv.vault.azure.net/keys/test-key1/77f57315bab34b0189daa113fbc78787", + "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity", + "geoBackupKeyURI": "https://test-geo-kv.vault.azure.net/keys/test-key1/66f57315bab34b0189daa113fbc78787", + "geoBackupUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity" + } + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity": { + "principalId": "0a4e0c6e-7751-4078-ae1f-a477306c11e9", + "clientId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity": { + "principalId": "0a4e0c6e-7751-4078-ae1f-a477306c11e9", + "clientId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "type": "UserAssigned" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc5geo.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "2", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "dataEncryption": { + "type": "AzureKeyVault", + "primaryKeyURI": "https://test-kv.vault.azure.net/keys/test-key1/77f57315bab34b0189daa113fbc78787", + "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity", + "geoBackupKeyURI": "https://test-geo-kv.vault.azure.net/keys/test-key1/66f57315bab34b0189daa113fbc78787", + "geoBackupUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity", + "primaryEncryptionKeyStatus": "Valid", + "geoBackupEncryptionKeyStatus": "Valid" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Enabled", + "earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "eastus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5geo", + "name": "pgtestsvc5geo", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity": { + "principalId": "0a4e0c6e-7751-4078-ae1f-a477306c11e9", + "clientId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity": { + "principalId": "0a4e0c6e-7751-4078-ae1f-a477306c11e9", + "clientId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "type": "UserAssigned" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc5geo.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "2", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "dataEncryption": { + "type": "AzureKeyVault", + "primaryKeyURI": "https://test-kv.vault.azure.net/keys/test-key1/77f57315bab34b0189daa113fbc78787", + "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity", + "geoBackupKeyURI": "https://test-geo-kv.vault.azure.net/keys/test-key1/66f57315bab34b0189daa113fbc78787", + "geoBackupUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity", + "primaryEncryptionKeyStatus": "Valid", + "geoBackupEncryptionKeyStatus": "Valid" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Enabled", + "earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "eastus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5geo", + "name": "pgtestsvc5geo", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreatePointInTimeRestore.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreatePointInTimeRestore.json new file mode 100644 index 000000000000..45e8878b9d92 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreatePointInTimeRestore.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "serverName": "pgtestsvc5", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "properties": { + "createMode": "PointInTimeRestore", + "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/sourcepgservername", + "pointInTimeUTC": "2021-06-27T00:04:59.4078005+00:00" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc5.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "2", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "dataEncryption": { + "type": "SystemManaged" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5", + "name": "pgtestsvc5", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc5.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "2", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "dataEncryption": { + "type": "SystemManaged" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5", + "name": "pgtestsvc5", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateReplica.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateReplica.json new file mode 100644 index 000000000000..a3a0cb692979 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateReplica.json @@ -0,0 +1,180 @@ +{ + "parameters": { + "serverName": "pgtestsvc5rep", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "identity": { + "userAssignedIdentities": { + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity": {} + }, + "type": "UserAssigned" + }, + "properties": { + "createMode": "Replica", + "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/sourcepgservername", + "pointInTimeUTC": "2021-06-27T00:04:59.4078005+00:00", + "dataEncryption": { + "type": "AzureKeyVault", + "primaryKeyURI": "https://test-kv.vault.azure.net/keys/test-key1/77f57315bab34b0189daa113fbc78787", + "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity", + "geoBackupKeyURI": "", + "geoBackupUserAssignedIdentityId": "" + } + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity": { + "principalId": "0a4e0c6e-7751-4078-ae1f-a477306c11e9", + "clientId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "type": "UserAssigned" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc5rep.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "2", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "dataEncryption": { + "type": "AzureKeyVault", + "primaryKeyURI": "https://test-kv.vault.azure.net/keys/test-key1/77f57315bab34b0189daa113fbc78787", + "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity", + "primaryEncryptionKeyStatus": "Valid" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/sourcepgservername", + "replicationRole": "AsyncReplica", + "replicaCapacity": 0, + "replica": { + "role": "AsyncReplica", + "capacity": 0, + "replicationState": "Active" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5rep", + "name": "pgtestsvc5rep", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity": { + "principalId": "0a4e0c6e-7751-4078-ae1f-a477306c11e9", + "clientId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "type": "UserAssigned" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc5rep.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "2", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "dataEncryption": { + "type": "AzureKeyVault", + "primaryKeyURI": "https://test-kv.vault.azure.net/keys/test-key1/77f57315bab34b0189daa113fbc78787", + "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity", + "primaryEncryptionKeyStatus": "Valid" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/sourcepgservername", + "replicationRole": "AsyncReplica", + "replicaCapacity": 0, + "replica": { + "role": "AsyncReplica", + "capacity": 0, + "replicationState": "Active" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5rep", + "name": "pgtestsvc5rep", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateReviveDropped.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateReviveDropped.json new file mode 100644 index 000000000000..5ebe9a0c36c4 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateReviveDropped.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "serverName": "pgtestsvc5-rev", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "properties": { + "createMode": "ReviveDropped", + "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5", + "pointInTimeUTC": "2023-04-27T00:04:59.4078005+00:00" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc5-rev.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "2", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "Primary", + "replicaCapacity": 0 + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5-rev", + "name": "pgtestsvc5-rev", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc5-rev.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "2", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "Primary", + "replicaCapacity": 0 + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5-rev", + "name": "pgtestsvc5-rev", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateWithAadAuthEnabled.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateWithAadAuthEnabled.json new file mode 100644 index 000000000000..278791298a69 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateWithAadAuthEnabled.json @@ -0,0 +1,165 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "cloudsa", + "administratorLoginPassword": "password", + "version": "12", + "availabilityZone": "1", + "createMode": "Create", + "authConfig": { + "activeDirectoryAuth": "Enabled", + "passwordAuth": "Enabled", + "tenantId": "tttttt-tttt-tttt-tttt-tttttttttttt" + }, + "dataEncryption": { + "type": "SystemManaged" + }, + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled" + }, + "network": { + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourcegroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant" + } + }, + "tags": { + "ElasticServer": "1" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "authConfig": { + "activeDirectoryAuth": "Enabled", + "passwordAuth": "Enabled", + "tenantId": "tttttt-tttt-tttt-tttt-tttttttttttt" + }, + "dataEncryption": { + "type": "SystemManaged" + }, + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:08:06.7197478+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "authConfig": { + "activeDirectoryAuth": "Enabled", + "passwordAuth": "Enabled", + "tenantId": "tttttt-tttt-tttt-tttt-tttttttttttt" + }, + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:08:06.7197478+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateWithDataEncryptionEnabled.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateWithDataEncryptionEnabled.json new file mode 100644 index 000000000000..8f2a4e4c1be9 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateWithDataEncryptionEnabled.json @@ -0,0 +1,194 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity": {} + }, + "type": "UserAssigned" + }, + "properties": { + "administratorLogin": "cloudsa", + "administratorLoginPassword": "password", + "version": "12", + "availabilityZone": "1", + "createMode": "Create", + "dataEncryption": { + "type": "AzureKeyVault", + "primaryKeyURI": "https://test-kv.vault.azure.net/keys/test-key1/77f57315bab34b0189daa113fbc78787", + "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity", + "geoBackupKeyURI": "", + "geoBackupUserAssignedIdentityId": "" + }, + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled" + }, + "network": { + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourcegroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant" + } + }, + "tags": { + "ElasticServer": "1" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity": { + "principalId": "0a4e0c6e-7751-4078-ae1f-a477306c11e9", + "clientId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "type": "UserAssigned" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "authConfig": { + "activeDirectoryAuth": "Enabled", + "passwordAuth": "Enabled" + }, + "dataEncryption": { + "type": "AzureKeyVault", + "primaryKeyURI": "https://test-kv.vault.azure.net/keys/test-key1/77f57315bab34b0189daa113fbc78787", + "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity", + "primaryEncryptionKeyStatus": "Valid" + }, + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:08:06.7197478+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity": { + "principalId": "0a4e0c6e-7751-4078-ae1f-a477306c11e9", + "clientId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "type": "UserAssigned" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "authConfig": { + "activeDirectoryAuth": "Enabled", + "passwordAuth": "Enabled" + }, + "dataEncryption": { + "type": "AzureKeyVault", + "primaryKeyURI": "https://test-kv.vault.azure.net/keys/test-key1/77f57315bab34b0189daa113fbc78787", + "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity", + "primaryEncryptionKeyStatus": "Valid" + }, + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:08:06.7197478+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerDelete.json new file mode 100644 index 000000000000..398bce38088f --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + }, + "204": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerGet.json new file mode 100644 index 000000000000..f88efbd46832 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerGet.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "serverName": "pgtestsvc1", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc1.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1", + "name": "pgtestsvc1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerGetWithPrivateEndpoints.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerGetWithPrivateEndpoints.json new file mode 100644 index 000000000000..344a7184cd58 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerGetWithPrivateEndpoints.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "serverName": "pgtestsvc2", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc2.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/pe-test-rg/providers/Microsoft.Network/privateEndpoints/asdfasdfa" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "postgresqlServer" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc2/privateEndpointConnections/asdfasdfa.40c899c7-5847-493e-9c9e-d0a0c90aaf92", + "name": "asdfasdfa.40c899c7-5847-493e-9c9e-d0a0c90aaf92", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/privateEndpointConnections" + } + ] + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc2", + "name": "pgtestsvc1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerGetWithVnet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerGetWithVnet.json new file mode 100644 index 000000000000..6eea644856cb --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerGetWithVnet.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerList.json new file mode 100644 index 000000000000..1a5aaf01c5eb --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerList.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/flexibleServers?api-version=2024-08-01&$top=3&$skiptoken=skiptoken", + "value": [ + { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + }, + { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc1.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Enabled", + "tier": "P20", + "iops": 2300 + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:15:38.8131437+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "eastus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1", + "name": "pgtestsvc1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerListByResourceGroup.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerListByResourceGroup.json new file mode 100644 index 000000000000..ef02ebfb109c --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerListByResourceGroup.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers?api-version=2024-08-01&$top=3&$skiptoken=skiptoken", + "value": [ + { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + }, + { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc1.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:15:38.8131437+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1", + "name": "pgtestsvc1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerRestart.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerRestart.json new file mode 100644 index 000000000000..f3b6f105afbc --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerRestart.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerRestartWithFailover.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerRestartWithFailover.json new file mode 100644 index 000000000000..6f81de8ca3b2 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerRestartWithFailover.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "restartWithFailover": true, + "failoverMode": "ForcedFailover" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerStart.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerStart.json new file mode 100644 index 000000000000..f3b6f105afbc --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerStart.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerStop.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerStop.json new file mode 100644 index 000000000000..f3b6f105afbc --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerStop.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerThreatProtectionSettingsCreateOrUpdate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerThreatProtectionSettingsCreateOrUpdate.json new file mode 100644 index 000000000000..782bec5adf30 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerThreatProtectionSettingsCreateOrUpdate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "threatprotection-4799", + "serverName": "threatprotection-6440", + "threatProtectionName": "Default", + "api-version": "2024-08-01", + "parameters": { + "properties": { + "state": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/threatprotection-4799/providers/Microsoft.DBforPostgreSQL/flexibleServers/threatprotection-6440/advancedThreatProtectionSettings/Default", + "name": "Default", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/advancedThreatProtectionSettings", + "properties": { + "state": "Enabled", + "creationTime": "2023-09-03T04:41:33.937Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/threatprotection-4799/providers/Microsoft.DBforPostgreSQL/flexibleServers/threatprotection-6440/advancedThreatProtectionSettings/Default", + "name": "Default", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/advancedThreatProtectionSettings", + "properties": { + "state": "Enabled", + "creationTime": "2023-09-03T04:41:33.937Z" + } + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerThreatProtectionSettingsGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerThreatProtectionSettingsGet.json new file mode 100644 index 000000000000..a052d16ad6f9 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerThreatProtectionSettingsGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "threatprotection-6852", + "serverName": "threatprotection-2080", + "threatProtectionName": "Default", + "api-version": "2024-08-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/threatprotection-4799/providers/Microsoft.DBforPostgreSQL/flexibleServers/threatprotection-6440/advancedThreatProtectionSettings/Default", + "name": "Default", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/advancedThreatProtectionSettings", + "properties": { + "state": "Enabled", + "creationTime": "2023-09-03T04:41:33.937Z" + } + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerThreatProtectionSettingsListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerThreatProtectionSettingsListByServer.json new file mode 100644 index 000000000000..054c19e01f64 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerThreatProtectionSettingsListByServer.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "threatprotection-6852", + "serverName": "threatprotection-2080", + "api-version": "2024-08-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/threatprotection-6852/providers/Microsoft.DBforPostgreSQL/flexibleServers/threatprotection-2080/advancedThreatProtectionSettings/Default", + "name": "Default", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/advancedThreatProtectionSettings", + "properties": { + "state": "Enabled", + "creationTime": "2023-09-03T04:41:33.937Z" + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdate.json new file mode 100644 index 000000000000..874fd6bc1757 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdate.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "TestGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D8s_v3" + }, + "properties": { + "administratorLoginPassword": "newpassword", + "createMode": "Update", + "storage": { + "storageSizeGB": 1024, + "autoGrow": "Enabled", + "tier": "P30" + }, + "backup": { + "backupRetentionDays": 20 + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D8s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "dataEncryption": { + "type": "SystemManaged" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "storage": { + "storageSizeGB": 1024, + "autoGrow": "Enabled", + "tier": "P30", + "iops": 5000 + }, + "backup": { + "backupRetentionDays": 20, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithAadAuthEnabled.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithAadAuthEnabled.json new file mode 100644 index 000000000000..3b7883119d4f --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithAadAuthEnabled.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "TestGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D8s_v3" + }, + "properties": { + "administratorLoginPassword": "newpassword", + "createMode": "Update", + "authConfig": { + "activeDirectoryAuth": "Enabled", + "passwordAuth": "Enabled", + "tenantId": "tttttt-tttt-tttt-tttt-tttttttttttt" + }, + "storage": { + "storageSizeGB": 1024, + "autoGrow": "Disabled", + "tier": "P30" + }, + "backup": { + "backupRetentionDays": 20 + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D8s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "dataEncryption": { + "type": "SystemManaged" + }, + "authConfig": { + "activeDirectoryAuth": "Enabled", + "passwordAuth": "Enabled", + "tenantId": "tttttt-tttt-tttt-tttt-tttttttttttt" + }, + "storage": { + "storageSizeGB": 1024, + "autoGrow": "Disabled", + "tier": "P30", + "iops": 5000 + }, + "backup": { + "backupRetentionDays": 20, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithCustomerMaintenanceWindow.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithCustomerMaintenanceWindow.json new file mode 100644 index 000000000000..786ceea825c1 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithCustomerMaintenanceWindow.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "createMode": "Update", + "maintenanceWindow": { + "customWindow": "Enabled", + "dayOfWeek": 0, + "startHour": 8, + "startMinute": 0 + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "dataEncryption": { + "type": "SystemManaged" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Enabled", + "dayOfWeek": 0, + "startHour": 8, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithDataEncryptionEnabled.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithDataEncryptionEnabled.json new file mode 100644 index 000000000000..e9e2eabfd969 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithDataEncryptionEnabled.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "TestGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D8s_v3" + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity": {}, + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity": {} + }, + "type": "UserAssigned" + }, + "properties": { + "administratorLoginPassword": "newpassword", + "createMode": "Update", + "dataEncryption": { + "type": "AzureKeyVault", + "primaryKeyURI": "https://test-kv.vault.azure.net/keys/test-key1/77f57315bab34b0189daa113fbc78787", + "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity", + "geoBackupKeyURI": "https://test-geo-kv.vault.azure.net/keys/test-key1/66f57315bab34b0189daa113fbc78787", + "geoBackupUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity" + }, + "backup": { + "backupRetentionDays": 20 + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D8s_v3", + "tier": "GeneralPurpose" + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity": { + "principalId": "0a4e0c6e-7751-4078-ae1f-a477306c11e9", + "clientId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity-1": { + "principalId": "90008082-e024-4cc3-8fcf-63bcdb9cf6b6", + "clientId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity": { + "principalId": "0a4e0c6e-7751-4078-ae1f-a477306c11e9", + "clientId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "type": "UserAssigned" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "dataEncryption": { + "type": "AzureKeyVault", + "primaryKeyURI": "https://test-kv.vault.azure.net/keys/test-key1/77f57315bab34b0189daa113fbc78787", + "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity", + "geoBackupKeyURI": "https://test-geo-kv.vault.azure.net/keys/test-key1/66f57315bab34b0189daa113fbc78787", + "geoBackupUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity", + "primaryEncryptionKeyStatus": "Valid", + "geoBackupEncryptionKeyStatus": "Valid" + }, + "storage": { + "storageSizeGB": 1024, + "autoGrow": "Disabled", + "tier": "P30", + "iops": 5000 + }, + "backup": { + "backupRetentionDays": 20, + "geoRedundantBackup": "Enabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithMajorVersionUpgrade.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithMajorVersionUpgrade.json new file mode 100644 index 000000000000..fdf825196d26 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithMajorVersionUpgrade.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "createMode": "Update", + "version": "14" + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "14", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Enabled", + "tier": "P20", + "iops": 2300 + }, + "dataEncryption": { + "type": "SystemManaged" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointCreate.json new file mode 100644 index 000000000000..b05b7c4f7278 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointCreate.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "virtualEndpointName": "pgVirtualEndpoint1", + "parameters": { + "properties": { + "endpointType": "ReadWrite", + "members": [ + "testPrimary1" + ] + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "endpointType": "ReadWrite", + "members": [ + "testPrimary1" + ], + "virtualEndpoints": [ + "pgVirtualEndpoint1.reader.postgres.database.azure.com", + "pgVirtualEndpoint1.writer.postgres.database.azure.com" + ] + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4/virtualEndpoints/pgVirtualEndpoint1", + "name": "pgVirtualEndpoint1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/virtualEndpoints" + } + }, + "200": { + "body": { + "properties": { + "endpointType": "ReadWrite", + "members": [ + "testPrimary1" + ], + "virtualEndpoints": [ + "pgVirtualEndpoint1.reader.postgres.database.azure.com", + "pgVirtualEndpoint1.writer.postgres.database.azure.com" + ] + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4/virtualEndpoints/pgVirtualEndpoint1", + "name": "pgVirtualEndpoint1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/virtualEndpoints" + } + }, + "202": { + "content": { + "operation": "ReplicaGroupCreateManagementOperation", + "startTime": "2023-08-07T16:55:22.403Z" + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointDelete.json new file mode 100644 index 000000000000..e080d654d6e9 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointDelete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "virtualEndpointName": "pgVirtualEndpoint1" + }, + "responses": { + "202": { + "content": { + "operation": "VirtualEndpointDropManagementOperation", + "startTime": "2023-10-09T11:55:21.123Z" + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + }, + "204": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointUpdate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointUpdate.json new file mode 100644 index 000000000000..bc386b47741d --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointUpdate.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "virtualEndpointName": "pgVirtualEndpoint1", + "parameters": { + "properties": { + "endpointType": "ReadWrite", + "members": [ + "testReplica1" + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "ReadWrite", + "members": [ + "testReplica1" + ], + "virtualEndpoints": [ + "pgVirtualEndpoint1.reader.postgres.database.azure.com", + "pgVirtualEndpoint1.writer.postgres.database.azure.com" + ] + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4/virtualEndpoints/pgVirtualEndpoint1", + "name": "pgVirtualEndpoint1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/virtualEndpoints" + } + }, + "202": { + "content": { + "operation": "ReplicaGroupUpdateManagementOperation", + "startTime": "2023-08-07T16:55:22.403Z" + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointsGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointsGet.json new file mode 100644 index 000000000000..958f21c52d0c --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointsGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "virtualEndpointName": "pgVirtualEndpoint1" + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "ReadWrite", + "members": [ + "testReplica1" + ], + "virtualEndpoints": [ + "pgVirtualEndpoint1.reader.postgres.database.azure.com", + "pgVirtualEndpoint1.writer.postgres.database.azure.com" + ] + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4/virtualEndpoints/pgVirtualEndpoint1", + "name": "pgVirtualEndpoint1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/virtualEndpoints" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointsListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointsListByServer.json new file mode 100644 index 000000000000..690d631c1e7b --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointsListByServer.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "endpointType": "ReadWrite", + "members": [ + "testReplica1" + ], + "virtualEndpoints": [ + "pgVirtualEndpoint1.reader.postgres.database.azure.com", + "pgVirtualEndpoint1.writer.postgres.database.azure.com" + ] + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4/virtualEndpoints/pgVirtualEndpoint1", + "name": "pgVirtualEndpoint1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/virtualEndpoints" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualNetworkSubnetUsage.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualNetworkSubnetUsage.json new file mode 100644 index 000000000000..ea780f532648 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualNetworkSubnetUsage.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "locationName": "westus", + "parameters": { + "virtualNetworkArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/testvnet" + } + }, + "responses": { + "200": { + "body": { + "delegatedSubnetsUsage": [ + { + "subnetName": "test-subnet-1", + "usage": 2 + }, + { + "subnetName": "test-subnet-2", + "usage": 3 + } + ], + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "location": "westus" + } + } + } +} diff --git a/specification/postgresql/resource-manager/readme.md b/specification/postgresql/resource-manager/readme.md index 25f710721f48..a7976abf1690 100644 --- a/specification/postgresql/resource-manager/readme.md +++ b/specification/postgresql/resource-manager/readme.md @@ -25,20 +25,72 @@ To see additional help and options, run: These are the global settings for the PostgreSQL API. ``` yaml -title: PostgreSQLManagementClient +title: PostgreSQLServerManagementClient description: The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model. openapi-type: arm -tag: package-flexibleserver-2024-03-01-preview +tag: package-flexibleserver-2024-08-01 ``` ``` yaml $(package-flexibleservers) -tag: package-flexibleserver-2024-03-01-preview +tag: package-flexibleserver-2024-08-01 ``` ``` yaml $(package-singleservers) tag: package-2020-01-01 ``` +### Tag: package-flexibleserver-2024-08-01 + +These settings apply only when `--tag=package-flexibleserver-2024-08-01` is specified on the command line. + +``` yaml $(tag) == 'package-flexibleserver-2024-08-01' +input-file: + - Microsoft.DBforPostgreSQL/stable/2024-08-01/Administrators.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/Backups.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/Capabilities.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/CheckNameAvailability.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/Configuration.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/Databases.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/FirewallRules.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/FlexibleServers.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/LongTermRetentionOperation.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/Migrations.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/Operations.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateDnsZone.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateEndpointConnections.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateLinkResources.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/Replicas.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/ServerLogs.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/ServerStartStopRestart.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/ThreatProtection.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/VirtualEndpoints.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/VirtualNetwork.json +suppressions: + - code: PutResponseCodes + from: PrivateEndpointConnections.json + reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is. + - code: ProvisioningStateSpecifiedForLROPut + from: ThreatProtection.json + reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is. + - code: PutResponseCodes + from: ThreatProtection.json + reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is. + - code: ProvisioningStateSpecifiedForLROPut + from: VirtualEndpoints.json + reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is. + - code: ProvisioningStateSpecifiedForLROPatch + from: VirtualEndpoints.json + reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is. + - code: PutResponseCodes + from: VirtualEndpoints.json + reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is. + - code: PutResponseCodes + from: Backups.json + reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is. + - code: ProvisioningStateSpecifiedForLROPut + from: Backups.json + reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is. +``` ### Tag: package-flexibleserver-2024-03-preview From 2ff865ff79b52a0a116e1be02aa0431618fcc88a Mon Sep 17 00:00:00 2001 From: xudong-an <131921227+xudong-an@users.noreply.github.com> Date: Thu, 3 Oct 2024 15:34:13 -0700 Subject: [PATCH 40/47] Add new api version and schema changes for resource manager in new API version 2024-09-01-preview (#30836) * create new preview API version 2024-09-01-preview (just copied, no content change in this commit) * schema changes in new API version 2024-09-01-preview --- .../EligibleChildResources.json | 154 +++ .../RoleAssignmentSchedule.json | 420 ++++++ .../RoleAssignmentScheduleInstance.json | 427 ++++++ .../RoleAssignmentScheduleRequest.json | 642 +++++++++ .../RoleEligibilitySchedule.json | 404 ++++++ .../RoleEligibilityScheduleInstance.json | 403 ++++++ .../RoleEligibilityScheduleRequest.json | 638 +++++++++ .../RoleManagementPolicy.json | 384 ++++++ .../RoleManagementPolicyAssignment.json | 393 ++++++ .../2024-09-01-preview/common-types.json | 500 +++++++ ...elRoleAssignmentScheduleRequestByName.json | 10 + ...lRoleEligibilityScheduleRequestByName.json | 10 + .../examples/DeleteRoleManagementPolicy.json | 11 + .../DeleteRoleManagementPolicyAssignment.json | 11 + .../GetEligibleChildResourcesByScope.json | 25 + .../GetRoleAssignmentScheduleByName.json | 51 + ...tRoleAssignmentScheduleInstanceByName.json | 52 + ...oleAssignmentScheduleInstancesByScope.json | 56 + ...etRoleAssignmentScheduleRequestByName.json | 62 + ...tRoleAssignmentScheduleRequestByScope.json | 66 + .../GetRoleAssignmentSchedulesByScope.json | 55 + .../GetRoleEligibilityScheduleByName.json | 49 + ...RoleEligibilityScheduleInstanceByName.json | 48 + ...leEligibilityScheduleInstancesByScope.json | 52 + ...tRoleEligibilityScheduleRequestByName.json | 62 + ...RoleEligibilityScheduleRequestByScope.json | 66 + .../GetRoleEligibilitySchedulesByScope.json | 53 + ...tRoleManagementPolicyAssignmentByName.json | 394 ++++++ ...RoleManagementPolicyAssignmentByScope.json | 397 ++++++ .../GetRoleManagementPolicyByName.json | 738 +++++++++++ .../GetRoleManagementPolicyByScope.json | 741 +++++++++++ .../PatchPartialRoleManagementPolicy.json | 782 +++++++++++ .../examples/PatchRoleManagementPolicy.json | 1172 +++++++++++++++++ ...leManagementPolicyToEnablePIMOnlyMode.json | 861 ++++++++++++ .../PutRoleAssignmentScheduleRequest.json | 80 ++ .../PutRoleEligibilityScheduleRequest.json | 79 ++ .../PutRoleManagementPolicyAssignment.json | 396 ++++++ ...teRoleAssignmentScheduleRequestByName.json | 80 ++ ...eRoleEligibilityScheduleRequestByName.json | 79 ++ .../authorization/resource-manager/readme.md | 27 +- 40 files changed, 10929 insertions(+), 1 deletion(-) create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/EligibleChildResources.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentSchedule.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentScheduleInstance.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentScheduleRequest.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilitySchedule.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilityScheduleInstance.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilityScheduleRequest.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleManagementPolicy.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleManagementPolicyAssignment.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/common-types.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/CancelRoleAssignmentScheduleRequestByName.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/CancelRoleEligibilityScheduleRequestByName.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/DeleteRoleManagementPolicy.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/DeleteRoleManagementPolicyAssignment.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetEligibleChildResourcesByScope.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleByName.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleInstanceByName.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleInstancesByScope.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleRequestByName.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleRequestByScope.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentSchedulesByScope.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleByName.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleInstanceByName.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleInstancesByScope.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleRequestByName.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleRequestByScope.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilitySchedulesByScope.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyAssignmentByName.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyAssignmentByScope.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyByName.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyByScope.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PatchPartialRoleManagementPolicy.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PatchRoleManagementPolicy.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PatchRoleManagementPolicyToEnablePIMOnlyMode.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PutRoleAssignmentScheduleRequest.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PutRoleEligibilityScheduleRequest.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PutRoleManagementPolicyAssignment.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/ValidateRoleAssignmentScheduleRequestByName.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/ValidateRoleEligibilityScheduleRequestByName.json diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/EligibleChildResources.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/EligibleChildResources.json new file mode 100644 index 000000000000..9cc0b83c5b91 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/EligibleChildResources.json @@ -0,0 +1,154 @@ +{ + "swagger": "2.0", + "info": { + "title": "AuthorizationManagementClient", + "version": "2024-09-01-preview", + "description": "Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role assignments. A role assignment grants access to Azure Active Directory users." + }, + "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/eligibleChildResources": { + "get": { + "tags": [ + "eligibleChildResources" + ], + "operationId": "EligibleChildResources_Get", + "description": "Get the child resources of a resource on which user has eligible access", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role management policy.", + "x-ms-skip-url-encoding": true + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use $filter=resourceType+eq+'Subscription' to filter on only resource of type = 'Subscription'. Use $filter=resourceType+eq+'subscription'+or+resourceType+eq+'resourcegroup' to filter on resource of type = 'Subscription' or 'ResourceGroup'" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role management policy.", + "schema": { + "$ref": "#/definitions/EligibleChildResourcesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetEligibleChildResourcesByScope": { + "$ref": "./examples/GetEligibleChildResourcesByScope.json" + } + } + } + } + }, + "definitions": { + "EligibleChildResourcesListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EligibleChildResource" + }, + "description": "Eligible child resource list." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "type": "object", + "description": "Eligible child resources list operation result." + }, + "EligibleChildResource": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The resource scope Id." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The resource name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The resource type." + } + }, + "type": "object", + "description": "Eligible child resource" + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "type": "object", + "description": "An error response from the service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + } + }, + "type": "object", + "description": "An error response from the service." + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentSchedule.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentSchedule.json new file mode 100644 index 000000000000..0f781d1c69a7 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentSchedule.json @@ -0,0 +1,420 @@ +{ + "swagger": "2.0", + "info": { + "title": "AuthorizationManagementClient", + "version": "2024-09-01-preview", + "description": "Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role assignments. A role assignment grants access to Azure Active Directory users." + }, + "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/roleAssignmentSchedules/{roleAssignmentScheduleName}": { + "get": { + "tags": [ + "roleAssignmentSchedules" + ], + "operationId": "RoleAssignmentSchedules_Get", + "description": "Get the specified role assignment schedule for a resource scope", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignment schedule.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleAssignmentScheduleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name (guid) of the role assignment schedule to get." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role assignment schedule.", + "schema": { + "$ref": "#/definitions/RoleAssignmentSchedule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetRoleAssignmentScheduleByName": { + "$ref": "./examples/GetRoleAssignmentScheduleByName.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules": { + "get": { + "tags": [ + "roleAssignmentSchedules" + ], + "operationId": "RoleAssignmentSchedules_ListForScope", + "description": "Gets role assignment schedules for a resource scope.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignments schedules.", + "x-ms-skip-url-encoding": true + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedules at or above the scope. Use $filter=principalId eq {id} to return all role assignment schedules at, above or below the scope for the specified principal. Use $filter=assignedTo('{userId}') to return all role assignment schedules for the current user. Use $filter=asTarget() to return all role assignment schedules created for the current user." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of role assignments schedules.", + "schema": { + "$ref": "#/definitions/RoleAssignmentScheduleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/RoleAssignmentScheduleFilter", + "x-ms-examples": { + "GetRoleAssignmentSchedulesByScope": { + "$ref": "./examples/GetRoleAssignmentSchedulesByScope.json" + } + } + } + } + }, + "definitions": { + "RoleAssignmentScheduleFilter": { + "properties": { + "principalId": { + "type": "string", + "description": "Returns role assignment schedule of the specific principal." + }, + "roleDefinitionId": { + "type": "string", + "description": "Returns role assignment schedule of the specific role definition." + }, + "status": { + "type": "string", + "description": "Returns role assignment schedule instances of the specific status." + } + }, + "type": "object", + "description": "Role assignment schedule filter" + }, + "RoleAssignmentScheduleProperties": { + "properties": { + "scope": { + "type": "string", + "description": "The role assignment schedule scope." + }, + "roleDefinitionId": { + "type": "string", + "description": "The role definition ID." + }, + "principalId": { + "type": "string", + "description": "The principal ID." + }, + "principalType": { + "type": "string", + "description": "The principal type of the assigned principal ID.", + "enum": [ + "User", + "Group", + "ServicePrincipal", + "ForeignGroup", + "Device" + ], + "x-ms-enum": { + "name": "principalType", + "modelAsString": true + } + }, + "roleAssignmentScheduleRequestId": { + "type": "string", + "description": "The id of roleAssignmentScheduleRequest used to create this roleAssignmentSchedule" + }, + "linkedRoleEligibilityScheduleId": { + "type": "string", + "description": "The id of roleEligibilitySchedule used to activated this roleAssignmentSchedule" + }, + "assignmentType": { + "type": "string", + "description": "Assignment type of the role assignment schedule", + "enum": [ + "Activated", + "Assigned" + ], + "x-ms-enum": { + "name": "AssignmentType", + "modelAsString": true + } + }, + "memberType": { + "type": "string", + "description": "Membership type of the role assignment schedule", + "enum": [ + "Inherited", + "Direct", + "Group" + ], + "x-ms-enum": { + "name": "MemberType", + "modelAsString": true + } + }, + "status": { + "type": "string", + "description": "The status of the role assignment schedule.", + "enum": [ + "Accepted", + "PendingEvaluation", + "Granted", + "Denied", + "PendingProvisioning", + "Provisioned", + "PendingRevocation", + "Revoked", + "Canceled", + "Failed", + "PendingApprovalProvisioning", + "PendingApproval", + "FailedAsResourceIsLocked", + "PendingAdminDecision", + "AdminApproved", + "AdminDenied", + "TimedOut", + "ProvisioningStarted", + "Invalid", + "PendingScheduleCreation", + "ScheduleCreated", + "PendingExternalProvisioning" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + } + }, + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "Start DateTime when role assignment schedule" + }, + "endDateTime": { + "type": "string", + "format": "date-time", + "description": "End DateTime when role assignment schedule" + }, + "condition": { + "type": "string", + "description": "The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'" + }, + "conditionVersion": { + "type": "string", + "description": "Version of the condition. Currently accepted value is '2.0'" + }, + "createdOn": { + "type": "string", + "format": "date-time", + "description": "DateTime when role assignment schedule was created" + }, + "updatedOn": { + "type": "string", + "format": "date-time", + "description": "DateTime when role assignment schedule was modified" + }, + "expandedProperties": { + "type": "object", + "description": "Additional properties of principal, scope and role definition", + "$ref": "#/definitions/ExpandedProperties" + } + }, + "type": "object", + "description": "Role assignment schedule properties with scope." + }, + "RoleAssignmentSchedule": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The role assignment schedule Id." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The role assignment schedule name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The role assignment schedule type." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoleAssignmentScheduleProperties", + "description": "Role assignment schedule properties." + } + }, + "type": "object", + "description": "Role Assignment schedule" + }, + "RoleAssignmentScheduleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RoleAssignmentSchedule" + }, + "description": "Role assignment schedule list." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "type": "object", + "description": "Role assignment schedule list operation result." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "type": "object", + "description": "An error response from the service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + } + }, + "type": "object", + "description": "An error response from the service." + }, + "ExpandedProperties": { + "properties": { + "scope": { + "type": "object", + "description": "Details of the resource scope", + "properties": { + "id": { + "type": "string", + "description": "Scope id of the resource" + }, + "displayName": { + "type": "string", + "description": "Display name of the resource" + }, + "type": { + "type": "string", + "description": "Type of the resource" + } + } + }, + "roleDefinition": { + "type": "object", + "description": "Details of role definition", + "properties": { + "id": { + "type": "string", + "description": "Id of the role definition" + }, + "displayName": { + "type": "string", + "description": "Display name of the role definition" + }, + "type": { + "type": "string", + "description": "Type of the role definition" + } + } + }, + "principal": { + "type": "object", + "description": "Details of the principal", + "properties": { + "id": { + "type": "string", + "description": "Id of the principal" + }, + "displayName": { + "type": "string", + "description": "Display name of the principal" + }, + "email": { + "type": "string", + "description": "Email id of the principal" + }, + "type": { + "type": "string", + "description": "Type of the principal" + } + } + } + }, + "type": "object" + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentScheduleInstance.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentScheduleInstance.json new file mode 100644 index 000000000000..9d8b2d6cd802 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentScheduleInstance.json @@ -0,0 +1,427 @@ +{ + "swagger": "2.0", + "info": { + "title": "AuthorizationManagementClient", + "version": "2024-09-01-preview", + "description": "Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role assignments. A role assignment grants access to Azure Active Directory users." + }, + "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/roleAssignmentScheduleInstances": { + "get": { + "tags": [ + "roleAssignmentScheduleInstances" + ], + "operationId": "RoleAssignmentScheduleInstances_ListForScope", + "description": "Gets role assignment schedule instances of a role assignment schedule.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignment schedule.", + "x-ms-skip-url-encoding": true + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedules at or above the scope. Use $filter=principalId eq {id} to return all role assignment schedules at, above or below the scope for the specified principal. Use $filter=assignedTo('{userId}') to return all role assignment schedule instances for the user. Use $filter=asTarget() to return all role assignment schedule instances created for the current user." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns array of role assignment schedule instances.", + "schema": { + "$ref": "#/definitions/RoleAssignmentScheduleInstanceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/RoleAssignmentScheduleInstanceFilter", + "x-ms-examples": { + "GetRoleAssignmentScheduleInstancesByScope": { + "$ref": "./examples/GetRoleAssignmentScheduleInstancesByScope.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}": { + "get": { + "tags": [ + "roleAssignmentScheduleInstances" + ], + "operationId": "RoleAssignmentScheduleInstances_Get", + "description": "Gets the specified role assignment schedule instance.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignments schedules.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleAssignmentScheduleInstanceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name (hash of schedule name + time) of the role assignment schedule to get." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role assignment schedule instance.", + "schema": { + "$ref": "#/definitions/RoleAssignmentScheduleInstance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetRoleAssignmentScheduleInstanceByName": { + "$ref": "./examples/GetRoleAssignmentScheduleInstanceByName.json" + } + } + } + } + }, + "definitions": { + "RoleAssignmentScheduleInstanceFilter": { + "properties": { + "principalId": { + "type": "string", + "description": "Returns role assignment schedule instances of the specific principal." + }, + "roleDefinitionId": { + "type": "string", + "description": "Returns role assignment schedule instances of the specific role definition." + }, + "status": { + "type": "string", + "description": "Returns role assignment schedule instances of the specific status." + }, + "roleAssignmentScheduleId": { + "type": "string", + "description": "Returns role assignment schedule instances belonging to a specific role assignment schedule." + } + }, + "type": "object", + "description": "Role assignment schedule instance filter" + }, + "RoleAssignmentScheduleInstanceProperties": { + "properties": { + "scope": { + "type": "string", + "description": "The role assignment schedule scope." + }, + "roleDefinitionId": { + "type": "string", + "description": "The role definition ID." + }, + "principalId": { + "type": "string", + "description": "The principal ID." + }, + "principalType": { + "type": "string", + "description": "The principal type of the assigned principal ID.", + "enum": [ + "User", + "Group", + "ServicePrincipal", + "ForeignGroup", + "Device" + ], + "x-ms-enum": { + "name": "principalType", + "modelAsString": true + } + }, + "roleAssignmentScheduleId": { + "type": "string", + "description": "Id of the master role assignment schedule" + }, + "originRoleAssignmentId": { + "type": "string", + "description": "Role Assignment Id in external system" + }, + "status": { + "type": "string", + "description": "The status of the role assignment schedule instance.", + "enum": [ + "Accepted", + "PendingEvaluation", + "Granted", + "Denied", + "PendingProvisioning", + "Provisioned", + "PendingRevocation", + "Revoked", + "Canceled", + "Failed", + "PendingApprovalProvisioning", + "PendingApproval", + "FailedAsResourceIsLocked", + "PendingAdminDecision", + "AdminApproved", + "AdminDenied", + "TimedOut", + "ProvisioningStarted", + "Invalid", + "PendingScheduleCreation", + "ScheduleCreated", + "PendingExternalProvisioning" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + } + }, + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "The startDateTime of the role assignment schedule instance" + }, + "endDateTime": { + "type": "string", + "format": "date-time", + "description": "The endDateTime of the role assignment schedule instance" + }, + "linkedRoleEligibilityScheduleId": { + "type": "string", + "description": "roleEligibilityScheduleId used to activate" + }, + "linkedRoleEligibilityScheduleInstanceId": { + "type": "string", + "description": "roleEligibilityScheduleInstanceId linked to this roleAssignmentScheduleInstance" + }, + "assignmentType": { + "type": "string", + "description": "Assignment type of the role assignment schedule", + "enum": [ + "Activated", + "Assigned" + ], + "x-ms-enum": { + "name": "AssignmentType", + "modelAsString": true + } + }, + "memberType": { + "type": "string", + "description": "Membership type of the role assignment schedule", + "enum": [ + "Inherited", + "Direct", + "Group" + ], + "x-ms-enum": { + "name": "MemberType", + "modelAsString": true + } + }, + "condition": { + "type": "string", + "description": "The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'" + }, + "conditionVersion": { + "type": "string", + "description": "Version of the condition. Currently accepted value is '2.0'" + }, + "createdOn": { + "type": "string", + "format": "date-time", + "description": "DateTime when role assignment schedule was created" + }, + "expandedProperties": { + "type": "object", + "description": "Additional properties of principal, scope and role definition", + "$ref": "#/definitions/ExpandedProperties" + } + }, + "type": "object", + "description": "Role assignment schedule properties with scope." + }, + "RoleAssignmentScheduleInstance": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The role assignment schedule instance ID." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The role assignment schedule instance name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The role assignment schedule instance type." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoleAssignmentScheduleInstanceProperties", + "description": "Role assignment schedule instance properties." + } + }, + "type": "object", + "description": "Information about current or upcoming role assignment schedule instance" + }, + "RoleAssignmentScheduleInstanceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RoleAssignmentScheduleInstance" + }, + "description": "Role assignment schedule instance list." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "type": "object", + "description": "Role assignment schedule instance list operation result." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "type": "object", + "description": "An error response from the service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + } + }, + "type": "object", + "description": "An error response from the service." + }, + "ExpandedProperties": { + "properties": { + "scope": { + "type": "object", + "description": "Details of the resource scope", + "properties": { + "id": { + "type": "string", + "description": "Scope id of the resource" + }, + "displayName": { + "type": "string", + "description": "Display name of the resource" + }, + "type": { + "type": "string", + "description": "Type of the resource" + } + } + }, + "roleDefinition": { + "type": "object", + "description": "Details of role definition", + "properties": { + "id": { + "type": "string", + "description": "Id of the role definition" + }, + "displayName": { + "type": "string", + "description": "Display name of the role definition" + }, + "type": { + "type": "string", + "description": "Type of the role definition" + } + } + }, + "principal": { + "type": "object", + "description": "Details of the principal", + "properties": { + "id": { + "type": "string", + "description": "Id of the principal" + }, + "displayName": { + "type": "string", + "description": "Display name of the principal" + }, + "email": { + "type": "string", + "description": "Email id of the principal" + }, + "type": { + "type": "string", + "description": "Type of the principal" + } + } + } + }, + "type": "object" + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentScheduleRequest.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentScheduleRequest.json new file mode 100644 index 000000000000..c76b2c516b86 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentScheduleRequest.json @@ -0,0 +1,642 @@ +{ + "swagger": "2.0", + "info": { + "title": "AuthorizationManagementClient", + "version": "2024-09-01-preview", + "description": "Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role assignments. A role assignment grants access to Azure Active Directory users." + }, + "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/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}": { + "put": { + "tags": [ + "RoleAssignmentScheduleRequests" + ], + "operationId": "RoleAssignmentScheduleRequests_Create", + "description": "Creates a role assignment schedule request.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignment schedule request to create. The scope can be any REST resource instance. For example, use '/subscriptions/{subscription-id}/' for a subscription, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for a resource group, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}' for a resource.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleAssignmentScheduleRequestName", + "in": "path", + "required": true, + "type": "string", + "description": "A GUID for the role assignment to create. The name must be unique and different for each role assignment." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RoleAssignmentScheduleRequest" + }, + "description": "Parameters for the role assignment schedule request." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created - Returns information about the role assignment.", + "schema": { + "$ref": "#/definitions/RoleAssignmentScheduleRequest" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "PutRoleAssignmentScheduleRequest": { + "$ref": "./examples/PutRoleAssignmentScheduleRequest.json" + } + } + }, + "get": { + "tags": [ + "RoleAssignmentScheduleRequests" + ], + "operationId": "RoleAssignmentScheduleRequests_Get", + "description": "Get the specified role assignment schedule request.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignment schedule request.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleAssignmentScheduleRequestName", + "in": "path", + "required": true, + "type": "string", + "description": "The name (guid) of the role assignment schedule request to get." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role assignment schedule request.", + "schema": { + "$ref": "#/definitions/RoleAssignmentScheduleRequest" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetRoleAssignmentScheduleRequestByName": { + "$ref": "./examples/GetRoleAssignmentScheduleRequestByName.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests": { + "get": { + "tags": [ + "RoleAssignmentScheduleRequests" + ], + "operationId": "RoleAssignmentScheduleRequests_ListForScope", + "description": "Gets role assignment schedule requests for a scope.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignments schedule requests.", + "x-ms-skip-url-encoding": true + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedule requests at or above the scope. Use $filter=principalId eq {id} to return all role assignment schedule requests at, above or below the scope for the specified principal. Use $filter=asRequestor() to return all role assignment schedule requests requested by the current user. Use $filter=asTarget() to return all role assignment schedule requests created for the current user. Use $filter=asApprover() to return all role assignment schedule requests where the current user is an approver." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of role assignments schedule requests.", + "schema": { + "$ref": "#/definitions/RoleAssignmentScheduleRequestListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/RoleAssignmentScheduleRequestFilter", + "x-ms-examples": { + "GetRoleAssignmentScheduleRequestByScope": { + "$ref": "./examples/GetRoleAssignmentScheduleRequestByScope.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}/cancel": { + "post": { + "tags": [ + "RoleAssignmentScheduleRequests" + ], + "operationId": "RoleAssignmentScheduleRequests_Cancel", + "description": "Cancels a pending role assignment schedule request.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignment request to cancel.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleAssignmentScheduleRequestName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role assignment request to cancel." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns success." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CancelRoleAssignmentScheduleRequestByName": { + "$ref": "./examples/CancelRoleAssignmentScheduleRequestByName.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}/validate": { + "post": { + "tags": [ + "RoleAssignmentScheduleRequests" + ], + "operationId": "RoleAssignmentScheduleRequests_Validate", + "description": "Validates a new role assignment schedule request.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignment request to validate.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleAssignmentScheduleRequestName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role assignment request to validate." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RoleAssignmentScheduleRequest" + }, + "description": "Parameters for the role assignment schedule request." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role assignment request.", + "schema": { + "$ref": "#/definitions/RoleAssignmentScheduleRequest" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ValidateRoleAssignmentScheduleRequestByName": { + "$ref": "./examples/ValidateRoleAssignmentScheduleRequestByName.json" + } + } + } + } + }, + "definitions": { + "RoleAssignmentScheduleRequestFilter": { + "properties": { + "principalId": { + "type": "string", + "description": "Returns role assignment requests of the specific principal." + }, + "roleDefinitionId": { + "type": "string", + "description": "Returns role assignment requests of the specific role definition." + }, + "requestorId": { + "type": "string", + "description": "Returns role assignment requests created by specific principal." + }, + "status": { + "type": "string", + "description": "Returns role assignment requests of specific status." + } + }, + "type": "object", + "description": "Role assignment schedule request filter" + }, + "RoleAssignmentScheduleRequestProperties": { + "properties": { + "scope": { + "type": "string", + "readOnly": true, + "description": "The role assignment schedule request scope." + }, + "roleDefinitionId": { + "type": "string", + "description": "The role definition ID." + }, + "principalId": { + "type": "string", + "description": "The principal ID." + }, + "principalType": { + "type": "string", + "readOnly": true, + "description": "The principal type of the assigned principal ID.", + "enum": [ + "User", + "Group", + "ServicePrincipal", + "ForeignGroup", + "Device" + ], + "x-ms-enum": { + "name": "principalType", + "modelAsString": true + } + }, + "requestType": { + "type": "string", + "description": "The type of the role assignment schedule request. Eg: SelfActivate, AdminAssign etc", + "enum": [ + "AdminAssign", + "AdminRemove", + "AdminUpdate", + "AdminExtend", + "AdminRenew", + "SelfActivate", + "SelfDeactivate", + "SelfExtend", + "SelfRenew" + ], + "x-ms-enum": { + "name": "RequestType", + "modelAsString": true + } + }, + "status": { + "type": "string", + "readOnly": true, + "description": "The status of the role assignment schedule request.", + "enum": [ + "Accepted", + "PendingEvaluation", + "Granted", + "Denied", + "PendingProvisioning", + "Provisioned", + "PendingRevocation", + "Revoked", + "Canceled", + "Failed", + "PendingApprovalProvisioning", + "PendingApproval", + "FailedAsResourceIsLocked", + "PendingAdminDecision", + "AdminApproved", + "AdminDenied", + "TimedOut", + "ProvisioningStarted", + "Invalid", + "PendingScheduleCreation", + "ScheduleCreated", + "PendingExternalProvisioning" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + } + }, + "approvalId": { + "type": "string", + "readOnly": true, + "description": "The approvalId of the role assignment schedule request." + }, + "targetRoleAssignmentScheduleId": { + "type": "string", + "description": "The resultant role assignment schedule id or the role assignment schedule id being updated" + }, + "targetRoleAssignmentScheduleInstanceId": { + "type": "string", + "description": "The role assignment schedule instance id being updated" + }, + "scheduleInfo": { + "properties": { + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "Start DateTime of the role assignment schedule." + }, + "expiration": { + "properties": { + "type": { + "type": "string", + "description": "Type of the role assignment schedule expiration", + "enum": [ + "AfterDuration", + "AfterDateTime", + "NoExpiration" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": true + } + }, + "endDateTime": { + "type": "string", + "format": "date-time", + "description": "End DateTime of the role assignment schedule." + }, + "duration": { + "type": "string", + "description": "Duration of the role assignment schedule in TimeSpan." + } + }, + "type": "object", + "description": "Expiration of the role assignment schedule" + } + }, + "type": "object", + "description": "Schedule info of the role assignment schedule" + }, + "linkedRoleEligibilityScheduleId": { + "type": "string", + "description": "The linked role eligibility schedule id - to activate an eligibility." + }, + "justification": { + "type": "string", + "description": "Justification for the role assignment" + }, + "ticketInfo": { + "properties": { + "ticketNumber": { + "type": "string", + "description": "Ticket number for the role assignment" + }, + "ticketSystem": { + "type": "string", + "description": "Ticket system name for the role assignment" + } + }, + "type": "object", + "description": "Ticket Info of the role assignment" + }, + "condition": { + "type": "string", + "description": "The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'" + }, + "conditionVersion": { + "type": "string", + "description": "Version of the condition. Currently accepted value is '2.0'" + }, + "createdOn": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "DateTime when role assignment schedule request was created" + }, + "requestorId": { + "type": "string", + "readOnly": true, + "description": "Id of the user who created this request" + }, + "expandedProperties": { + "type": "object", + "readOnly": true, + "description": "Additional properties of principal, scope and role definition", + "$ref": "#/definitions/ExpandedProperties" + } + }, + "required": [ + "roleDefinitionId", + "principalId", + "requestType" + ], + "type": "object", + "description": "Role assignment schedule request properties with scope." + }, + "RoleAssignmentScheduleRequest": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The role assignment schedule request ID." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The role assignment schedule request name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The role assignment schedule request type." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoleAssignmentScheduleRequestProperties", + "description": "Role assignment schedule request properties." + } + }, + "type": "object", + "description": "Role Assignment schedule request" + }, + "RoleAssignmentScheduleRequestListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RoleAssignmentScheduleRequest" + }, + "description": "Role assignment schedule request list." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "type": "object", + "description": "Role assignment schedule request list operation result." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "type": "object", + "description": "An error response from the service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + } + }, + "type": "object", + "description": "An error response from the service." + }, + "ExpandedProperties": { + "properties": { + "scope": { + "type": "object", + "description": "Details of the resource scope", + "properties": { + "id": { + "type": "string", + "description": "Scope id of the resource" + }, + "displayName": { + "type": "string", + "description": "Display name of the resource" + }, + "type": { + "type": "string", + "description": "Type of the resource" + } + } + }, + "roleDefinition": { + "type": "object", + "description": "Details of role definition", + "properties": { + "id": { + "type": "string", + "description": "Id of the role definition" + }, + "displayName": { + "type": "string", + "description": "Display name of the role definition" + }, + "type": { + "type": "string", + "description": "Type of the role definition" + } + } + }, + "principal": { + "type": "object", + "description": "Details of the principal", + "properties": { + "id": { + "type": "string", + "description": "Id of the principal" + }, + "displayName": { + "type": "string", + "description": "Display name of the principal" + }, + "email": { + "type": "string", + "description": "Email id of the principal" + }, + "type": { + "type": "string", + "description": "Type of the principal" + } + } + } + }, + "type": "object", + "description": "Provides role assignment request scope, role definition and principal properties for expansion. " + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilitySchedule.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilitySchedule.json new file mode 100644 index 000000000000..ab3c8230520a --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilitySchedule.json @@ -0,0 +1,404 @@ +{ + "swagger": "2.0", + "info": { + "title": "AuthorizationManagementClient", + "version": "2024-09-01-preview", + "description": "Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role assignments. A role assignment grants access to Azure Active Directory users." + }, + "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/roleEligibilitySchedules/{roleEligibilityScheduleName}": { + "get": { + "tags": [ + "roleEligibilitySchedules" + ], + "operationId": "RoleEligibilitySchedules_Get", + "description": "Get the specified role eligibility schedule for a resource scope", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role eligibility schedule.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleEligibilityScheduleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name (guid) of the role eligibility schedule to get." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role eligibility schedule.", + "schema": { + "$ref": "#/definitions/RoleEligibilitySchedule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetRoleEligibilityScheduleByName": { + "$ref": "./examples/GetRoleEligibilityScheduleByName.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules": { + "get": { + "tags": [ + "roleEligibilitySchedules" + ], + "operationId": "RoleEligibilitySchedules_ListForScope", + "description": "Gets role eligibility schedules for a resource scope.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role eligibility schedules.", + "x-ms-skip-url-encoding": true + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use $filter=atScope() to return all role eligibility schedules at or above the scope. Use $filter=principalId eq {id} to return all role eligibility schedules at, above or below the scope for the specified principal. Use $filter=assignedTo('{userId}') to return all role eligibility schedules for the user. Use $filter=asTarget() to return all role eligibility schedules created for the current user." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of role eligibility schedules.", + "schema": { + "$ref": "#/definitions/RoleEligibilityScheduleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/RoleEligibilityScheduleFilter", + "x-ms-examples": { + "GetRoleEligibilitySchedulesByScope": { + "$ref": "./examples/GetRoleEligibilitySchedulesByScope.json" + } + } + } + } + }, + "definitions": { + "RoleEligibilityScheduleFilter": { + "properties": { + "principalId": { + "type": "string", + "description": "Returns role eligibility schedule of the specific principal." + }, + "roleDefinitionId": { + "type": "string", + "description": "Returns role eligibility schedule of the specific role definition." + }, + "status": { + "type": "string", + "description": "Returns role eligibility schedule of the specific status." + } + }, + "type": "object", + "description": "Role eligibility schedule filter" + }, + "RoleEligibilityScheduleProperties": { + "properties": { + "scope": { + "type": "string", + "description": "The role eligibility schedule scope." + }, + "roleDefinitionId": { + "type": "string", + "description": "The role definition ID." + }, + "principalId": { + "type": "string", + "description": "The principal ID." + }, + "principalType": { + "type": "string", + "description": "The principal type of the assigned principal ID.", + "enum": [ + "User", + "Group", + "ServicePrincipal", + "ForeignGroup", + "Device" + ], + "x-ms-enum": { + "name": "principalType", + "modelAsString": true + } + }, + "roleEligibilityScheduleRequestId": { + "type": "string", + "description": "The id of roleEligibilityScheduleRequest used to create this roleAssignmentSchedule" + }, + "memberType": { + "type": "string", + "description": "Membership type of the role eligibility schedule", + "enum": [ + "Inherited", + "Direct", + "Group" + ], + "x-ms-enum": { + "name": "MemberType", + "modelAsString": true + } + }, + "status": { + "type": "string", + "description": "The status of the role eligibility schedule.", + "enum": [ + "Accepted", + "PendingEvaluation", + "Granted", + "Denied", + "PendingProvisioning", + "Provisioned", + "PendingRevocation", + "Revoked", + "Canceled", + "Failed", + "PendingApprovalProvisioning", + "PendingApproval", + "FailedAsResourceIsLocked", + "PendingAdminDecision", + "AdminApproved", + "AdminDenied", + "TimedOut", + "ProvisioningStarted", + "Invalid", + "PendingScheduleCreation", + "ScheduleCreated", + "PendingExternalProvisioning" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + } + }, + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "Start DateTime when role eligibility schedule" + }, + "endDateTime": { + "type": "string", + "format": "date-time", + "description": "End DateTime when role eligibility schedule" + }, + "condition": { + "type": "string", + "description": "The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'" + }, + "conditionVersion": { + "type": "string", + "description": "Version of the condition. Currently accepted value is '2.0'" + }, + "createdOn": { + "type": "string", + "format": "date-time", + "description": "DateTime when role eligibility schedule was created" + }, + "updatedOn": { + "type": "string", + "format": "date-time", + "description": "DateTime when role eligibility schedule was modified" + }, + "expandedProperties": { + "type": "object", + "description": "Additional properties of principal, scope and role definition", + "$ref": "#/definitions/ExpandedProperties" + } + }, + "type": "object", + "description": "Role eligibility schedule properties with scope." + }, + "RoleEligibilitySchedule": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The role eligibility schedule Id." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The role eligibility schedule name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The role eligibility schedule type." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoleEligibilityScheduleProperties", + "description": "role eligibility schedule properties." + } + }, + "type": "object", + "description": "Role eligibility schedule" + }, + "RoleEligibilityScheduleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RoleEligibilitySchedule" + }, + "description": "role eligibility schedule list." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "type": "object", + "description": "role eligibility schedule list operation result." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "type": "object", + "description": "An error response from the service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + } + }, + "type": "object", + "description": "An error response from the service." + }, + "ExpandedProperties": { + "properties": { + "scope": { + "type": "object", + "description": "Details of the resource scope", + "properties": { + "id": { + "type": "string", + "description": "Scope id of the resource" + }, + "displayName": { + "type": "string", + "description": "Display name of the resource" + }, + "type": { + "type": "string", + "description": "Type of the resource" + } + } + }, + "roleDefinition": { + "type": "object", + "description": "Details of role definition", + "properties": { + "id": { + "type": "string", + "description": "Id of the role definition" + }, + "displayName": { + "type": "string", + "description": "Display name of the role definition" + }, + "type": { + "type": "string", + "description": "Type of the role definition" + } + } + }, + "principal": { + "type": "object", + "description": "Details of the principal", + "properties": { + "id": { + "type": "string", + "description": "Id of the principal" + }, + "displayName": { + "type": "string", + "description": "Display name of the principal" + }, + "email": { + "type": "string", + "description": "Email id of the principal" + }, + "type": { + "type": "string", + "description": "Type of the principal" + } + } + } + }, + "type": "object" + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilityScheduleInstance.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilityScheduleInstance.json new file mode 100644 index 000000000000..9a170eb605fd --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilityScheduleInstance.json @@ -0,0 +1,403 @@ +{ + "swagger": "2.0", + "info": { + "title": "AuthorizationManagementClient", + "version": "2024-09-01-preview", + "description": "Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role assignments. A role eligibility grants access to Azure Active Directory users." + }, + "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/roleEligibilityScheduleInstances": { + "get": { + "tags": [ + "roleEligibilityScheduleInstances" + ], + "operationId": "RoleEligibilityScheduleInstances_ListForScope", + "description": "Gets role eligibility schedule instances of a role eligibility schedule.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role eligibility schedule.", + "x-ms-skip-url-encoding": true + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedules at or above the scope. Use $filter=principalId eq {id} to return all role assignment schedules at, above or below the scope for the specified principal. Use $filter=assignedTo('{userId}') to return all role eligibility schedules for the user. Use $filter=asTarget() to return all role eligibility schedules created for the current user." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns array of role eligibility schedule instances.", + "schema": { + "$ref": "#/definitions/RoleEligibilityScheduleInstanceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/RoleEligibilityScheduleInstanceFilter", + "x-ms-examples": { + "GetRoleEligibilityScheduleInstancesByScope": { + "$ref": "./examples/GetRoleEligibilityScheduleInstancesByScope.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}": { + "get": { + "tags": [ + "roleEligibilityScheduleInstances" + ], + "operationId": "RoleEligibilityScheduleInstances_Get", + "description": "Gets the specified role eligibility schedule instance.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role eligibility schedules.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleEligibilityScheduleInstanceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name (hash of schedule name + time) of the role eligibility schedule to get." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role eligibility schedule instance.", + "schema": { + "$ref": "#/definitions/RoleEligibilityScheduleInstance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetRoleEligibilityScheduleInstanceByName": { + "$ref": "./examples/GetRoleEligibilityScheduleInstanceByName.json" + } + } + } + } + }, + "definitions": { + "RoleEligibilityScheduleInstanceFilter": { + "properties": { + "principalId": { + "type": "string", + "description": "Returns role eligibility schedule instances of the specific principal." + }, + "roleDefinitionId": { + "type": "string", + "description": "Returns role eligibility schedule instances of the specific role definition." + }, + "status": { + "type": "string", + "description": "Returns role eligibility schedule instances of the specific status." + }, + "roleEligibilityScheduleId": { + "type": "string", + "description": "Returns role eligibility schedule instances belonging to a specific role eligibility schedule." + } + }, + "type": "object", + "description": "Role eligibility schedule instance filter" + }, + "RoleEligibilityScheduleInstanceProperties": { + "properties": { + "scope": { + "type": "string", + "description": "The role eligibility schedule scope." + }, + "roleDefinitionId": { + "type": "string", + "description": "The role definition ID." + }, + "principalId": { + "type": "string", + "description": "The principal ID." + }, + "principalType": { + "type": "string", + "description": "The principal type of the assigned principal ID.", + "enum": [ + "User", + "Group", + "ServicePrincipal", + "ForeignGroup", + "Device" + ], + "x-ms-enum": { + "name": "principalType", + "modelAsString": true + } + }, + "roleEligibilityScheduleId": { + "type": "string", + "description": "Id of the master role eligibility schedule" + }, + "status": { + "type": "string", + "description": "The status of the role eligibility schedule instance", + "enum": [ + "Accepted", + "PendingEvaluation", + "Granted", + "Denied", + "PendingProvisioning", + "Provisioned", + "PendingRevocation", + "Revoked", + "Canceled", + "Failed", + "PendingApprovalProvisioning", + "PendingApproval", + "FailedAsResourceIsLocked", + "PendingAdminDecision", + "AdminApproved", + "AdminDenied", + "TimedOut", + "ProvisioningStarted", + "Invalid", + "PendingScheduleCreation", + "ScheduleCreated", + "PendingExternalProvisioning" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + } + }, + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "The startDateTime of the role eligibility schedule instance" + }, + "endDateTime": { + "type": "string", + "format": "date-time", + "description": "The endDateTime of the role eligibility schedule instance" + }, + "memberType": { + "type": "string", + "description": "Membership type of the role eligibility schedule", + "enum": [ + "Inherited", + "Direct", + "Group" + ], + "x-ms-enum": { + "name": "MemberType", + "modelAsString": true + } + }, + "condition": { + "type": "string", + "description": "The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'" + }, + "conditionVersion": { + "type": "string", + "description": "Version of the condition. Currently accepted value is '2.0'" + }, + "createdOn": { + "type": "string", + "format": "date-time", + "description": "DateTime when role eligibility schedule was created" + }, + "expandedProperties": { + "type": "object", + "description": "Additional properties of principal, scope and role definition", + "$ref": "#/definitions/ExpandedProperties" + } + }, + "type": "object", + "description": "Role eligibility schedule properties with scope." + }, + "RoleEligibilityScheduleInstance": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The role eligibility schedule instance ID." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The role eligibility schedule instance name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The role eligibility schedule instance type." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoleEligibilityScheduleInstanceProperties", + "description": "Role eligibility schedule instance properties." + } + }, + "type": "object", + "description": "Information about current or upcoming role eligibility schedule instance" + }, + "RoleEligibilityScheduleInstanceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RoleEligibilityScheduleInstance" + }, + "description": "Role eligibility schedule instance list." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "type": "object", + "description": "Role eligibility schedule instance list operation result." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "type": "object", + "description": "An error response from the service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + } + }, + "type": "object", + "description": "An error response from the service." + }, + "ExpandedProperties": { + "properties": { + "scope": { + "type": "object", + "description": "Details of the resource scope", + "properties": { + "id": { + "type": "string", + "description": "Scope id of the resource" + }, + "displayName": { + "type": "string", + "description": "Display name of the resource" + }, + "type": { + "type": "string", + "description": "Type of the resource" + } + } + }, + "roleDefinition": { + "type": "object", + "description": "Details of role definition", + "properties": { + "id": { + "type": "string", + "description": "Id of the role definition" + }, + "displayName": { + "type": "string", + "description": "Display name of the role definition" + }, + "type": { + "type": "string", + "description": "Type of the role definition" + } + } + }, + "principal": { + "type": "object", + "description": "Details of the principal", + "properties": { + "id": { + "type": "string", + "description": "Id of the principal" + }, + "displayName": { + "type": "string", + "description": "Display name of the principal" + }, + "email": { + "type": "string", + "description": "Email id of the principal" + }, + "type": { + "type": "string", + "description": "Type of the principal" + } + } + } + }, + "type": "object" + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilityScheduleRequest.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilityScheduleRequest.json new file mode 100644 index 000000000000..a024670456d7 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilityScheduleRequest.json @@ -0,0 +1,638 @@ +{ + "swagger": "2.0", + "info": { + "title": "AuthorizationManagementClient", + "version": "2024-09-01-preview", + "description": "Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role assignments. A role eligibility grants access to Azure Active Directory users." + }, + "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/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}": { + "put": { + "tags": [ + "RoleEligibilityScheduleRequests" + ], + "operationId": "RoleEligibilityScheduleRequests_Create", + "description": "Creates a role eligibility schedule request.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role eligibility schedule request to create. The scope can be any REST resource instance. For example, use '/subscriptions/{subscription-id}/' for a subscription, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for a resource group, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}' for a resource.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleEligibilityScheduleRequestName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role eligibility to create. It can be any valid GUID." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RoleEligibilityScheduleRequest" + }, + "description": "Parameters for the role eligibility schedule request." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created - Returns information about the role eligibility schedule request.", + "schema": { + "$ref": "#/definitions/RoleEligibilityScheduleRequest" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "PutRoleEligibilityScheduleRequest": { + "$ref": "./examples/PutRoleEligibilityScheduleRequest.json" + } + } + }, + "get": { + "tags": [ + "RoleEligibilityScheduleRequests" + ], + "operationId": "RoleEligibilityScheduleRequests_Get", + "description": "Get the specified role eligibility schedule request.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role eligibility schedule request.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleEligibilityScheduleRequestName", + "in": "path", + "required": true, + "type": "string", + "description": "The name (guid) of the role eligibility schedule request to get." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role eligibility schedule request.", + "schema": { + "$ref": "#/definitions/RoleEligibilityScheduleRequest" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetRoleEligibilityScheduleRequestByName": { + "$ref": "./examples/GetRoleEligibilityScheduleRequestByName.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests": { + "get": { + "tags": [ + "RoleEligibilityScheduleRequests" + ], + "operationId": "RoleEligibilityScheduleRequests_ListForScope", + "description": "Gets role eligibility schedule requests for a scope.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role eligibility schedule requests.", + "x-ms-skip-url-encoding": true + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use $filter=atScope() to return all role eligibility schedule requests at or above the scope. Use $filter=principalId eq {id} to return all role eligibility schedule requests at, above or below the scope for the specified principal. Use $filter=asRequestor() to return all role eligibility schedule requests requested by the current user. Use $filter=asTarget() to return all role eligibility schedule requests created for the current user. Use $filter=asApprover() to return all role eligibility schedule requests where the current user is an approver." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of role eligibility schedule requests.", + "schema": { + "$ref": "#/definitions/RoleEligibilityScheduleRequestListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/RoleEligibilityScheduleRequestFilter", + "x-ms-examples": { + "GetRoleEligibilityScheduleRequestByScope": { + "$ref": "./examples/GetRoleEligibilityScheduleRequestByScope.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}/cancel": { + "post": { + "tags": [ + "RoleEligibilityScheduleRequests" + ], + "operationId": "RoleEligibilityScheduleRequests_Cancel", + "description": "Cancels a pending role eligibility schedule request.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role eligibility request to cancel.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleEligibilityScheduleRequestName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role eligibility request to cancel." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns success." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CancelRoleEligibilityScheduleRequestByName": { + "$ref": "./examples/CancelRoleEligibilityScheduleRequestByName.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}/validate": { + "post": { + "tags": [ + "RoleEligibilityScheduleRequests" + ], + "operationId": "RoleEligibilityScheduleRequests_Validate", + "description": "Validates a new role eligibility schedule request.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role eligibility request to validate.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleEligibilityScheduleRequestName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role eligibility request to validate." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RoleEligibilityScheduleRequest" + }, + "description": "Parameters for the role eligibility schedule request." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role eligibility schedule request.", + "schema": { + "$ref": "#/definitions/RoleEligibilityScheduleRequest" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ValidateRoleEligibilityScheduleRequestByName": { + "$ref": "./examples/ValidateRoleEligibilityScheduleRequestByName.json" + } + } + } + } + }, + "definitions": { + "RoleEligibilityScheduleRequestFilter": { + "properties": { + "principalId": { + "type": "string", + "description": "Returns role eligibility requests of the specific principal." + }, + "roleDefinitionId": { + "type": "string", + "description": "Returns role eligibility requests of the specific role definition." + }, + "requestorId": { + "type": "string", + "description": "Returns role eligibility requests created by specific principal." + }, + "status": { + "type": "string", + "description": "Returns role eligibility requests of specific status." + } + }, + "type": "object", + "description": "Role eligibility schedule request filter" + }, + "RoleEligibilityScheduleRequestProperties": { + "properties": { + "scope": { + "type": "string", + "readOnly": true, + "description": "The role eligibility schedule request scope." + }, + "roleDefinitionId": { + "type": "string", + "description": "The role definition ID." + }, + "principalId": { + "type": "string", + "description": "The principal ID." + }, + "principalType": { + "type": "string", + "readOnly": true, + "description": "The principal type of the assigned principal ID.", + "enum": [ + "User", + "Group", + "ServicePrincipal", + "ForeignGroup", + "Device" + ], + "x-ms-enum": { + "name": "principalType", + "modelAsString": true + } + }, + "requestType": { + "type": "string", + "description": "The type of the role assignment schedule request. Eg: SelfActivate, AdminAssign etc", + "enum": [ + "AdminAssign", + "AdminRemove", + "AdminUpdate", + "AdminExtend", + "AdminRenew", + "SelfActivate", + "SelfDeactivate", + "SelfExtend", + "SelfRenew" + ], + "x-ms-enum": { + "name": "RequestType", + "modelAsString": true + } + }, + "status": { + "type": "string", + "readOnly": true, + "description": "The status of the role eligibility schedule request.", + "enum": [ + "Accepted", + "PendingEvaluation", + "Granted", + "Denied", + "PendingProvisioning", + "Provisioned", + "PendingRevocation", + "Revoked", + "Canceled", + "Failed", + "PendingApprovalProvisioning", + "PendingApproval", + "FailedAsResourceIsLocked", + "PendingAdminDecision", + "AdminApproved", + "AdminDenied", + "TimedOut", + "ProvisioningStarted", + "Invalid", + "PendingScheduleCreation", + "ScheduleCreated", + "PendingExternalProvisioning" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + } + }, + "approvalId": { + "type": "string", + "readOnly": true, + "description": "The approvalId of the role eligibility schedule request." + }, + "scheduleInfo": { + "properties": { + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "Start DateTime of the role eligibility schedule." + }, + "expiration": { + "properties": { + "type": { + "type": "string", + "description": "Type of the role eligibility schedule expiration", + "enum": [ + "AfterDuration", + "AfterDateTime", + "NoExpiration" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": true + } + }, + "endDateTime": { + "type": "string", + "format": "date-time", + "description": "End DateTime of the role eligibility schedule." + }, + "duration": { + "type": "string", + "description": "Duration of the role eligibility schedule in TimeSpan." + } + }, + "type": "object", + "description": "Expiration of the role eligibility schedule" + } + }, + "type": "object", + "description": "Schedule info of the role eligibility schedule" + }, + "targetRoleEligibilityScheduleId": { + "type": "string", + "description": "The resultant role eligibility schedule id or the role eligibility schedule id being updated" + }, + "targetRoleEligibilityScheduleInstanceId": { + "type": "string", + "description": "The role eligibility schedule instance id being updated" + }, + "justification": { + "type": "string", + "description": "Justification for the role eligibility" + }, + "ticketInfo": { + "properties": { + "ticketNumber": { + "type": "string", + "description": "Ticket number for the role eligibility" + }, + "ticketSystem": { + "type": "string", + "description": "Ticket system name for the role eligibility" + } + }, + "type": "object", + "description": "Ticket Info of the role eligibility" + }, + "condition": { + "type": "string", + "description": "The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'" + }, + "conditionVersion": { + "type": "string", + "description": "Version of the condition. Currently accepted value is '2.0'" + }, + "createdOn": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "DateTime when role eligibility schedule request was created" + }, + "requestorId": { + "type": "string", + "readOnly": true, + "description": "Id of the user who created this request" + }, + "expandedProperties": { + "readOnly": true, + "type": "object", + "description": "Additional properties of principal, scope and role definition", + "$ref": "#/definitions/ExpandedProperties" + } + }, + "required": [ + "roleDefinitionId", + "principalId", + "requestType" + ], + "type": "object", + "description": "Role eligibility schedule request properties with scope." + }, + "RoleEligibilityScheduleRequest": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The role eligibility schedule request ID." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The role eligibility schedule request name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The role eligibility schedule request type." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoleEligibilityScheduleRequestProperties", + "description": "Role eligibility schedule request properties." + } + }, + "type": "object", + "description": "Role Eligibility schedule request" + }, + "RoleEligibilityScheduleRequestListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RoleEligibilityScheduleRequest" + }, + "description": "Role eligibility schedule request list." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "type": "object", + "description": "Role eligibility schedule request list operation result." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "type": "object", + "description": "An error response from the service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + } + }, + "type": "object", + "description": "An error response from the service." + }, + "ExpandedProperties": { + "properties": { + "scope": { + "type": "object", + "description": "Details of the resource scope", + "properties": { + "id": { + "type": "string", + "description": "Scope id of the resource" + }, + "displayName": { + "type": "string", + "description": "Display name of the resource" + }, + "type": { + "type": "string", + "description": "Type of the resource" + } + } + }, + "roleDefinition": { + "type": "object", + "description": "Details of role definition", + "properties": { + "id": { + "type": "string", + "description": "Id of the role definition" + }, + "displayName": { + "type": "string", + "description": "Display name of the role definition" + }, + "type": { + "type": "string", + "description": "Type of the role definition" + } + } + }, + "principal": { + "type": "object", + "description": "Details of the principal", + "properties": { + "id": { + "type": "string", + "description": "Id of the principal" + }, + "displayName": { + "type": "string", + "description": "Display name of the principal" + }, + "email": { + "type": "string", + "description": "Email id of the principal" + }, + "type": { + "type": "string", + "description": "Type of the principal" + } + } + } + }, + "type": "object", + "description": "Expanded info of resource, role and principal" + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleManagementPolicy.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleManagementPolicy.json new file mode 100644 index 000000000000..523315260e37 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleManagementPolicy.json @@ -0,0 +1,384 @@ +{ + "swagger": "2.0", + "info": { + "title": "AuthorizationManagementClient", + "version": "2024-09-01-preview", + "description": "Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role assignments. A role assignment grants access to Azure Active Directory users." + }, + "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/roleManagementPolicies/{roleManagementPolicyName}": { + "get": { + "tags": [ + "roleManagementPolicies" + ], + "operationId": "RoleManagementPolicies_Get", + "description": "Get the specified role management policy for a resource scope", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role management policy.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleManagementPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name (guid) of the role management policy to get." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role management policy.", + "schema": { + "$ref": "#/definitions/RoleManagementPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetRoleManagementPolicyByName": { + "$ref": "./examples/GetRoleManagementPolicyByName.json" + } + } + }, + "patch": { + "tags": [ + "roleManagementPolicies" + ], + "operationId": "RoleManagementPolicies_Update", + "description": "Update a role management policy", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role management policy to upsert.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleManagementPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name (guid) of the role management policy to upsert." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RoleManagementPolicy" + }, + "description": "Parameters for the role management policy." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok - Returns the updated policy.", + "schema": { + "$ref": "#/definitions/RoleManagementPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "PatchRoleManagementPolicy": { + "$ref": "./examples/PatchRoleManagementPolicy.json" + }, + "PatchPartialRoleManagementPolicy": { + "$ref": "./examples/PatchPartialRoleManagementPolicy.json" + }, + "PatchRoleManagementPolicyToEnablePIMOnlyMode": { + "$ref": "./examples/PatchRoleManagementPolicyToEnablePIMOnlyMode.json" + } + } + }, + "delete": { + "tags": [ + "roleManagementPolicies" + ], + "operationId": "RoleManagementPolicies_Delete", + "description": "Delete a role management policy", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role management policy to upsert.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleManagementPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name (guid) of the role management policy to upsert." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Successfully deleted the policy." + }, + "204": { + "description": "NoContent - policy does not exists." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DeleteRoleManagementPolicy": { + "$ref": "./examples/DeleteRoleManagementPolicy.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleManagementPolicies": { + "get": { + "tags": [ + "roleManagementPolicies" + ], + "operationId": "RoleManagementPolicies_ListForScope", + "description": "Gets role management policies for a resource scope.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role management policy.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of role management policies.", + "schema": { + "$ref": "#/definitions/RoleManagementPolicyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetRoleManagementPolicyByRoleDefinitionFilter": { + "$ref": "./examples/GetRoleManagementPolicyByScope.json" + } + } + } + } + }, + "definitions": { + "RoleManagementPolicyProperties": { + "properties": { + "scope": { + "type": "string", + "description": "The role management policy scope." + }, + "displayName": { + "type": "string", + "description": "The role management policy display name." + }, + "description": { + "type": "string", + "description": "The role management policy description." + }, + "isOrganizationDefault": { + "type": "boolean", + "description": "The role management policy is default policy." + }, + "lastModifiedBy": { + "$ref": "./common-types.json#/definitions/Principal" + }, + "lastModifiedDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The last modified date time." + }, + "rules": { + "type": "array", + "items": { + "$ref": "./common-types.json#/definitions/RoleManagementPolicyRule" + }, + "description": "The rule applied to the policy." + }, + "effectiveRules": { + "type": "array", + "items": { + "$ref": "./common-types.json#/definitions/RoleManagementPolicyRule" + }, + "readOnly": true, + "description": "The readonly computed rule applied to the policy." + }, + "policyProperties": { + "readOnly": true, + "type": "object", + "description": "Additional properties of scope", + "$ref": "#/definitions/PolicyProperties" + } + }, + "type": "object", + "description": "Role management policy properties with scope." + }, + "RoleManagementPolicy": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The role management policy Id." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The role management policy name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The role management policy type." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoleManagementPolicyProperties", + "description": "Role management policy properties." + } + }, + "type": "object", + "description": "Role management policy" + }, + "RoleManagementPolicyListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RoleManagementPolicy" + }, + "description": "Role management policy list." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "type": "object", + "description": "Role management policy list operation result." + }, + "PolicyProperties": { + "properties": { + "scope": { + "type": "object", + "description": "Details of the resource scope", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Scope id of the resource" + }, + "displayName": { + "type": "string", + "description": "Display name of the resource" + }, + "type": { + "type": "string", + "description": "Type of the resource" + } + } + } + }, + "type": "object", + "description": "Expanded info of resource scope" + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "type": "object", + "description": "An error response from the service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + } + }, + "type": "object", + "description": "An error response from the service." + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleManagementPolicyAssignment.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleManagementPolicyAssignment.json new file mode 100644 index 000000000000..1479e16feae0 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleManagementPolicyAssignment.json @@ -0,0 +1,393 @@ +{ + "swagger": "2.0", + "info": { + "title": "AuthorizationManagementClient", + "version": "2024-09-01-preview", + "description": "Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role assignments. A role assignment grants access to Azure Active Directory users." + }, + "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/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}": { + "get": { + "tags": [ + "roleManagementPolicyAssignments" + ], + "operationId": "RoleManagementPolicyAssignments_Get", + "description": "Get the specified role management policy assignment for a resource scope", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role management policy.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleManagementPolicyAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of format {guid_guid} the role management policy assignment to get." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role management policy.", + "schema": { + "$ref": "#/definitions/RoleManagementPolicyAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/GetRoleManagementPolicyAssignmentByName.json" + } + } + }, + "put": { + "tags": [ + "roleManagementPolicyAssignments" + ], + "operationId": "RoleManagementPolicyAssignments_Create", + "description": "Create a role management policy assignment", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role management policy assignment to upsert.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleManagementPolicyAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of format {guid_guid} the role management policy assignment to upsert." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RoleManagementPolicyAssignment" + }, + "description": "Parameters for the role management policy assignment." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created - Returns the created or updated policy assignment.", + "schema": { + "$ref": "#/definitions/RoleManagementPolicyAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "PutRoleManagementPolicyAssignment": { + "$ref": "./examples/PutRoleManagementPolicyAssignment.json" + } + } + }, + "delete": { + "tags": [ + "roleManagementPolicyAssignments" + ], + "operationId": "RoleManagementPolicyAssignments_Delete", + "description": "Delete a role management policy assignment", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role management policy assignment to delete.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleManagementPolicyAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of format {guid_guid} the role management policy assignment to delete." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Successfully deleted the policy assignment." + }, + "204": { + "description": "NoContent - policy assignment does not exists." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DeleteRoleManagementPolicyAssignment": { + "$ref": "./examples/DeleteRoleManagementPolicyAssignment.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments": { + "get": { + "tags": [ + "roleManagementPolicyAssignments" + ], + "operationId": "RoleManagementPolicyAssignments_ListForScope", + "description": "Gets role management assignment policies for a resource scope.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role management policy.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of role management policies.", + "schema": { + "$ref": "#/definitions/RoleManagementPolicyAssignmentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetRoleManagementPolicyAssignmentByScope": { + "$ref": "./examples/GetRoleManagementPolicyAssignmentByScope.json" + } + } + } + } + }, + "definitions": { + "RoleManagementPolicyAssignment": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The role management policy Id." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The role management policy name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The role management policy type." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoleManagementPolicyAssignmentProperties", + "description": "Role management policy properties." + } + }, + "type": "object", + "description": "Role management policy" + }, + "RoleManagementPolicyAssignmentProperties": { + "properties": { + "scope": { + "type": "string", + "description": "The role management policy scope." + }, + "roleDefinitionId": { + "type": "string", + "description": "The role definition of management policy assignment." + }, + "policyId": { + "type": "string", + "description": "The policy id role management policy assignment." + }, + "effectiveRules": { + "type": "array", + "items": { + "$ref": "./common-types.json#/definitions/RoleManagementPolicyRule" + }, + "readOnly": true, + "description": "The readonly computed rule applied to the policy." + }, + "policyAssignmentProperties": { + "readOnly": true, + "type": "object", + "description": "Additional properties of scope, role definition and policy", + "$ref": "#/definitions/PolicyAssignmentProperties" + } + }, + "type": "object", + "description": "Role management policy assignment properties with scope." + }, + "RoleManagementPolicyAssignmentListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RoleManagementPolicyAssignment" + }, + "description": "Role management policy assignment list." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "type": "object", + "description": "Role management policy assignment list operation result." + }, + "PolicyAssignmentProperties": { + "properties": { + "scope": { + "type": "object", + "description": "Details of the resource scope", + "properties": { + "id": { + "type": "string", + "description": "Scope id of the resource" + }, + "displayName": { + "type": "string", + "description": "Display name of the resource" + }, + "type": { + "type": "string", + "description": "Type of the resource" + } + } + }, + "roleDefinition": { + "type": "object", + "description": "Details of role definition", + "properties": { + "id": { + "type": "string", + "description": "Id of the role definition" + }, + "displayName": { + "type": "string", + "description": "Display name of the role definition" + }, + "type": { + "type": "string", + "description": "Type of the role definition" + } + } + }, + "policy": { + "type": "object", + "description": "Details of the policy", + "properties": { + "id": { + "type": "string", + "description": "Id of the policy" + }, + "lastModifiedBy": { + "$ref": "./common-types.json#/definitions/Principal" + }, + "lastModifiedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last modified date time." + } + } + } + }, + "type": "object", + "description": "Expanded info of resource scope, role definition and policy" + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "type": "object", + "description": "An error response from the service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + } + }, + "type": "object", + "description": "An error response from the service." + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/common-types.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/common-types.json new file mode 100644 index 000000000000..3ed792b62118 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/common-types.json @@ -0,0 +1,500 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-09-01-preview", + "title": "AuthorizationManagementClient" + }, + "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": {}, + "definitions": { + "Principal": { + "readOnly": true, + "type": "object", + "description": "The name of the entity last modified it", + "properties": { + "id": { + "type": "string", + "description": "The id of the principal made changes" + }, + "displayName": { + "type": "string", + "description": "The name of the principal made changes" + }, + "type": { + "type": "string", + "description": "Type of principal such as user , group etc" + }, + "email": { + "type": "string", + "description": "Email of principal" + } + } + }, + "RoleManagementPolicyRule": { + "description": "The role management policy rule.", + "type": "object", + "required": [ + "ruleType" + ], + "discriminator": "ruleType", + "properties": { + "id": { + "type": "string", + "description": "The id of the rule." + }, + "ruleType": { + "description": "The type of rule", + "$ref": "#/definitions/RoleManagementPolicyRuleType" + }, + "target": { + "$ref": "#/definitions/RoleManagementPolicyRuleTarget", + "description": "The target of the current rule." + } + } + }, + "RoleManagementPolicyApprovalRule": { + "description": "The role management policy approval rule.", + "allOf": [ + { + "$ref": "#/definitions/RoleManagementPolicyRule" + } + ], + "type": "object", + "properties": { + "setting": { + "$ref": "#/definitions/ApprovalSettings", + "description": "The approval setting" + } + } + }, + "ApprovalSettings": { + "description": "The approval settings.", + "type": "object", + "properties": { + "isApprovalRequired": { + "type": "boolean", + "description": "Determines whether approval is required or not." + }, + "isApprovalRequiredForExtension": { + "type": "boolean", + "description": "Determines whether approval is required for assignment extension." + }, + "isRequestorJustificationRequired": { + "type": "boolean", + "description": "Determine whether requestor justification is required." + }, + "approvalMode": { + "type": "string", + "description": "The type of rule", + "enum": [ + "SingleStage", + "Serial", + "Parallel", + "NoApproval" + ], + "x-ms-enum": { + "name": "ApprovalMode", + "modelAsString": true + } + }, + "approvalStages": { + "type": "array", + "items": { + "$ref": "#/definitions/ApprovalStage" + }, + "x-ms-identifiers": [], + "description": "The approval stages of the request." + } + } + }, + "ApprovalStage": { + "description": "The approval stage.", + "type": "object", + "properties": { + "approvalStageTimeOutInDays": { + "type": "integer", + "format": "int32", + "description": "The time in days when approval request would be timed out" + }, + "isApproverJustificationRequired": { + "type": "boolean", + "description": "Determines whether approver need to provide justification for his decision." + }, + "escalationTimeInMinutes": { + "type": "integer", + "format": "int32", + "description": "The time in minutes when the approval request would be escalated if the primary approver does not approve" + }, + "primaryApprovers": { + "type": "array", + "description": "The primary approver of the request.", + "items": { + "$ref": "#/definitions/UserSet" + } + }, + "isEscalationEnabled": { + "type": "boolean", + "description": "The value determine whether escalation feature is enabled." + }, + "escalationApprovers": { + "type": "array", + "description": "The escalation approver of the request.", + "items": { + "$ref": "#/definitions/UserSet" + } + } + } + }, + "UserSet": { + "description": "The detail of a user.", + "type": "object", + "properties": { + "userType": { + "type": "string", + "description": "The type of user.", + "enum": [ + "User", + "Group" + ], + "x-ms-enum": { + "name": "UserType", + "modelAsString": true + } + }, + "isBackup": { + "type": "boolean", + "description": "The value indicating whether the user is a backup fallback approver" + }, + "id": { + "type": "string", + "description": "The object id of the user." + }, + "description": { + "type": "string", + "description": "The description of the user." + } + } + }, + "UsersOrServicePrincipalSet": { + "description": "The detail of a subject.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of user.", + "enum": [ + "User", + "Group", + "ServicePrincipal" + ], + "x-ms-enum": { + "name": "UserType", + "modelAsString": true + } + }, + "id": { + "type": "string", + "description": "The object id of the entity." + }, + "displayName": { + "type": "string", + "description": "The display Name of the entity." + } + } + }, + "RoleManagementPolicyAuthenticationContextRule": { + "description": "The role management policy authentication context rule.", + "allOf": [ + { + "$ref": "#/definitions/RoleManagementPolicyRule" + } + ], + "type": "object", + "properties": { + "isEnabled": { + "type": "boolean", + "description": "The value indicating if rule is enabled." + }, + "claimValue": { + "type": "string", + "description": "The claim value." + } + } + }, + "RoleManagementPolicyEnablementRule": { + "description": "The role management policy enablement rule.", + "allOf": [ + { + "$ref": "#/definitions/RoleManagementPolicyRule" + } + ], + "type": "object", + "properties": { + "enabledRules": { + "type": "array", + "items": { + "type": "string", + "description": "The type of enablement rule", + "enum": [ + "MultiFactorAuthentication", + "Justification", + "Ticketing" + ], + "x-ms-enum": { + "name": "EnablementRules", + "modelAsString": true + } + }, + "description": "The list of enabled rules." + } + } + }, + "RoleManagementPolicyExpirationRule": { + "description": "The role management policy expiration rule.", + "allOf": [ + { + "$ref": "#/definitions/RoleManagementPolicyRule" + } + ], + "type": "object", + "properties": { + "isExpirationRequired": { + "type": "boolean", + "description": "The value indicating whether expiration is required." + }, + "maximumDuration": { + "type": "string", + "description": "The maximum duration of expiration in timespan." + }, + "exceptionMembers": { + "type": "array", + "description": "The members not restricted by expiration rule.", + "items": { + "$ref": "#/definitions/UserSet" + } + } + } + }, + "RoleManagementPolicyNotificationRule": { + "description": "The role management policy notification rule.", + "allOf": [ + { + "$ref": "#/definitions/RoleManagementPolicyRule" + } + ], + "type": "object", + "properties": { + "notificationType": { + "type": "string", + "description": "The type of notification.", + "enum": [ + "Email" + ], + "x-ms-enum": { + "name": "NotificationDeliveryMechanism", + "modelAsString": true + } + }, + "notificationLevel": { + "type": "string", + "description": "The notification level.", + "enum": [ + "None", + "Critical", + "All" + ], + "x-ms-enum": { + "name": "NotificationLevel", + "modelAsString": true + } + }, + "recipientType": { + "type": "string", + "description": "The recipient type.", + "enum": [ + "Requestor", + "Approver", + "Admin" + ], + "x-ms-enum": { + "name": "RecipientType", + "modelAsString": true + } + }, + "notificationRecipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of notification recipients." + }, + "isDefaultRecipientsEnabled": { + "type": "boolean", + "description": "Determines if the notification will be sent to the recipient type specified in the policy rule." + } + } + }, + "RoleManagementPolicyRuleTarget": { + "description": "The role management policy rule target.", + "type": "object", + "properties": { + "caller": { + "type": "string", + "description": "The caller of the setting." + }, + "operations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The type of operation." + }, + "level": { + "type": "string", + "description": "The assignment level to which rule is applied." + }, + "targetObjects": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of target objects." + }, + "inheritableSettings": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of inheritable settings." + }, + "enforcedSettings": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of enforced settings." + } + } + }, + "RoleManagementPolicyRuleType": { + "type": "string", + "description": "The type of rule", + "enum": [ + "RoleManagementPolicyApprovalRule", + "RoleManagementPolicyAuthenticationContextRule", + "RoleManagementPolicyEnablementRule", + "RoleManagementPolicyExpirationRule", + "RoleManagementPolicyNotificationRule", + "RoleManagementPolicyPimOnlyModeRule" + ], + "x-ms-enum": { + "name": "RoleManagementPolicyRuleType", + "modelAsString": true + } + }, + "RoleManagementPolicyPimOnlyModeRule": { + "description": "The role management policy PIM only mode rule.", + "allOf": [ + { + "$ref": "#/definitions/RoleManagementPolicyRule" + } + ], + "type": "object", + "properties": { + "pimOnlyModeSettings": { + "$ref": "#/definitions/PIMOnlyModeSettings", + "description": "The PIM Only Mode settings" + } + } + }, + "PIMOnlyModeSettings": { + "description": "The PIM Only Mode settings.", + "type": "object", + "properties": { + "mode": { + "type": "string", + "description": "Determines whether the setting is enabled, disabled or report only.", + "enum": [ + "Disabled", + "Enabled", + "ReportOnly" + ], + "x-ms-enum": { + "name": "PIMOnlyMode", + "modelAsString": true + } + }, + "excludes": { + "type": "array", + "description": "The list of excluded entities that the rule does not apply to.", + "items": { + "$ref": "#/definitions/UsersOrServicePrincipalSet" + } + }, + "excludedAssignmentTypes": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "ServicePrincipalsAsTarget", + "ServicePrincipalsAsRequestor" + ], + "x-ms-enum": { + "name": "ExcludedPrincipalTypes", + "modelAsString": true + } + }, + "description": "The list of excluded assignment types allowed." + } + } + } + }, + "parameters": { + "ResourceProviderNamespaceParameter": { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace of the resource provider.", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "method" + }, + "ResourceTypeParameter": { + "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, + "x-ms-parameter-location": "method" + }, + "ResourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource name.", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "method" + }, + "ScopeParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the operation or resource. Valid scopes are: 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-skip-url-encoding": true, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/CancelRoleAssignmentScheduleRequestByName.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/CancelRoleAssignmentScheduleRequestByName.json new file mode 100644 index 000000000000..55ca173bc777 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/CancelRoleAssignmentScheduleRequestByName.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleAssignmentScheduleRequestName": "fea7a502-9a96-4806-a26f-eee560e52045", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/CancelRoleEligibilityScheduleRequestByName.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/CancelRoleEligibilityScheduleRequestByName.json new file mode 100644 index 000000000000..08a2d9d323d2 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/CancelRoleEligibilityScheduleRequestByName.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleEligibilityScheduleRequestName": "64caffb6-55c0-4deb-a585-68e948ea1ad6", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/DeleteRoleManagementPolicy.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/DeleteRoleManagementPolicy.json new file mode 100644 index 000000000000..386864163fb7 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/DeleteRoleManagementPolicy.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "roleManagementPolicyName": "570c3619-7688-4b34-b290-2b8bb3ccab2a", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/DeleteRoleManagementPolicyAssignment.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/DeleteRoleManagementPolicyAssignment.json new file mode 100644 index 000000000000..775fc20b75bf --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/DeleteRoleManagementPolicyAssignment.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "roleManagementPolicyAssignmentName": "b959d571-f0b5-4042-88a7-01be6cb22db9_a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetEligibleChildResourcesByScope.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetEligibleChildResourcesByScope.json new file mode 100644 index 000000000000..e6822e1599c5 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetEligibleChildResourcesByScope.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "api-version": "2024-09-01-preview", + "$filter": "resourceType+eq+'resourcegroup'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "RG-1", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/resourceGroups/RG-1", + "type": "resourcegroup" + }, + { + "name": "RG-2", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/resourceGroups/RG-2", + "type": "resourcegroup" + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleByName.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleByName.json new file mode 100644 index 000000000000..9bf6aaa1736b --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleByName.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleAssignmentScheduleName": "c9e264ff-3133-4776-a81a-ebc7c33c8ec6", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "linkedRoleEligibilityScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "assignmentType": "Assigned", + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "status": "Provisioned", + "roleAssignmentScheduleRequestId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentScheduleRequests/fea7a502-9a96-4806-a26f-eee560e52045", + "startDateTime": "2020-09-09T21:35:27.91Z", + "endDateTime": "2020-09-10T05:35:17.91Z", + "memberType": "Direct", + "createdOn": "2020-09-09T21:35:27.91Z", + "updatedOn": "2020-09-09T21:35:27.91Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "c9e264ff-3133-4776-a81a-ebc7c33c8ec6", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentSchedules/c9e264ff-3133-4776-a81a-ebc7c33c8ec6", + "type": "Microsoft.Authorization/RoleAssignmentSchedules" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleInstanceByName.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleInstanceByName.json new file mode 100644 index 000000000000..62f0b7e7d324 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleInstanceByName.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleAssignmentScheduleInstanceName": "ed9b8180-cef7-4c77-a63c-b8566ecfc412", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "originRoleAssignmentId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleAssignments/ed9b8180-cef7-4c77-a63c-b8566ecfc412", + "linkedRoleEligibilityScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "linkedRoleEligibilityScheduleInstanceId": "21e4b59a-0499-4fe0-a3c3-43a3055b773a", + "assignmentType": "Assigned", + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "status": "Accepted", + "roleAssignmentScheduleId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentSchedules/c9e264ff-3133-4776-a81a-ebc7c33c8ec6", + "startDateTime": "2020-09-09T21:35:27.91Z", + "endDateTime": "2020-09-10T05:35:17.91Z", + "memberType": "Direct", + "createdOn": "2020-09-09T21:35:27.91Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "ed9b8180-cef7-4c77-a63c-b8566ecfc412", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentScheduleInstances/ed9b8180-cef7-4c77-a63c-b8566ecfc412", + "type": "Microsoft.Authorization/RoleAssignmentScheduleInstances" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleInstancesByScope.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleInstancesByScope.json new file mode 100644 index 000000000000..9e48f568a642 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleInstancesByScope.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "$filter": "assignedTo('a3bb8764-cb92-4276-9d2a-ca1e895e55ea')", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "originRoleAssignmentId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleAssignments/ed9b8180-cef7-4c77-a63c-b8566ecfc412", + "linkedRoleEligibilityScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "linkedRoleEligibilityScheduleInstanceId": "21e4b59a-0499-4fe0-a3c3-43a3055b773a", + "assignmentType": "Assigned", + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "status": "Accepted", + "roleAssignmentScheduleId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentSchedules/c9e264ff-3133-4776-a81a-ebc7c33c8ec6", + "startDateTime": "2020-09-09T21:35:27.91Z", + "endDateTime": "2020-09-10T05:35:17.91Z", + "memberType": "Direct", + "createdOn": "2020-09-09T21:35:27.91Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "ed9b8180-cef7-4c77-a63c-b8566ecfc412", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentScheduleInstances/ed9b8180-cef7-4c77-a63c-b8566ecfc412", + "type": "Microsoft.Authorization/RoleAssignmentScheduleInstances" + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleRequestByName.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleRequestByName.json new file mode 100644 index 000000000000..e2cca775e6f2 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleRequestByName.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleAssignmentScheduleRequestName": "fea7a502-9a96-4806-a26f-eee560e52045", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "targetRoleAssignmentScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "targetRoleAssignmentScheduleInstanceId": null, + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "requestType": "SelfActivate", + "status": "Provisioned", + "approvalId": null, + "scheduleInfo": { + "startDateTime": "2020-09-09T21:35:27.91Z", + "expiration": { + "type": "AfterDuration", + "endDateTime": null, + "duration": "PT8H" + } + }, + "ticketInfo": { + "ticketNumber": null, + "ticketSystem": null + }, + "justification": null, + "requestorId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "createdOn": "2020-09-09T21:35:27.91Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "fea7a502-9a96-4806-a26f-eee560e52045", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentScheduleRequests/fea7a502-9a96-4806-a26f-eee560e52045", + "type": "Microsoft.Authorization/RoleAssignmentScheduleRequests" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleRequestByScope.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleRequestByScope.json new file mode 100644 index 000000000000..5045222d3db4 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleRequestByScope.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "$filter": "assignedTo('A3BB8764-CB92-4276-9D2A-CA1E895E55EA')", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "targetRoleAssignmentScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "targetRoleAssignmentScheduleInstanceId": null, + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "requestType": "SelfActivate", + "status": "Provisioned", + "approvalId": null, + "scheduleInfo": { + "startDateTime": "2020-09-09T21:35:27.91Z", + "expiration": { + "type": "AfterDuration", + "endDateTime": null, + "duration": "PT8H" + } + }, + "ticketInfo": { + "ticketNumber": null, + "ticketSystem": null + }, + "justification": null, + "requestorId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "createdOn": "2020-09-09T21:35:27.91Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "fea7a502-9a96-4806-a26f-eee560e52045", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentScheduleRequests/fea7a502-9a96-4806-a26f-eee560e52045", + "type": "Microsoft.Authorization/RoleAssignmentScheduleRequests" + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentSchedulesByScope.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentSchedulesByScope.json new file mode 100644 index 000000000000..250663179382 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentSchedulesByScope.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "$filter": "assignedTo('a3bb8764-cb92-4276-9d2a-ca1e895e55ea')", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "linkedRoleEligibilityScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "assignmentType": "Assigned", + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "status": "Provisioned", + "roleAssignmentScheduleRequestId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentScheduleRequests/fea7a502-9a96-4806-a26f-eee560e52045", + "startDateTime": "2020-09-09T21:35:27.91Z", + "endDateTime": "2020-09-10T05:35:17.91Z", + "memberType": "Direct", + "createdOn": "2020-09-09T21:35:27.91Z", + "updatedOn": "2020-09-09T21:35:27.91Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "c9e264ff-3133-4776-a81a-ebc7c33c8ec6", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentSchedules/c9e264ff-3133-4776-a81a-ebc7c33c8ec6", + "type": "Microsoft.Authorization/RoleAssignmentSchedules" + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleByName.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleByName.json new file mode 100644 index 000000000000..17a4b8367993 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleByName.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleEligibilityScheduleName": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/b24988ac-6180-42a0-ab88-20f7382dd24c", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "status": "Provisioned", + "roleEligibilityScheduleRequestId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilityScheduleRequests/64caffb6-55c0-4deb-a585-68e948ea1ad6", + "startDateTime": "2020-09-09T21:33:14.557Z", + "endDateTime": "2021-09-09T21:32:28.49Z", + "memberType": "Direct", + "createdOn": "2020-09-09T21:33:06.3Z", + "updatedOn": "2020-09-09T22:27:00.513Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilitySchedules/b1477448-2cc6-4ceb-93b4-54a202a89413", + "type": "Microsoft.Authorization/RoleEligibilitySchedules" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleInstanceByName.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleInstanceByName.json new file mode 100644 index 000000000000..ec45f8a5cbb2 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleInstanceByName.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleEligibilityScheduleInstanceName": "21e4b59a-0499-4fe0-a3c3-43a3055b773a", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/b24988ac-6180-42a0-ab88-20f7382dd24c", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "status": "Provisioned", + "roleEligibilityScheduleId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilitySchedules/b1477448-2cc6-4ceb-93b4-54a202a89413", + "startDateTime": "2020-09-10T00:32:36.86Z", + "endDateTime": "2021-09-10T00:31:41.477Z", + "memberType": "Direct", + "createdOn": "2020-09-10T00:32:36.86Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "21e4b59a-0499-4fe0-a3c3-43a3055b773a", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilityScheduleInstances/21e4b59a-0499-4fe0-a3c3-43a3055b773a", + "type": "Microsoft.Authorization/RoleEligibilityScheduleInstances" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleInstancesByScope.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleInstancesByScope.json new file mode 100644 index 000000000000..715c97443579 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleInstancesByScope.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "$filter": "assignedTo('a3bb8764-cb92-4276-9d2a-ca1e895e55ea')", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/b24988ac-6180-42a0-ab88-20f7382dd24c", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "status": "Provisioned", + "roleEligibilityScheduleId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilitySchedules/b1477448-2cc6-4ceb-93b4-54a202a89413", + "startDateTime": "2020-09-10T00:32:36.86Z", + "endDateTime": "2021-09-10T00:31:41.477Z", + "memberType": "Direct", + "createdOn": "2020-09-10T00:32:36.86Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "21e4b59a-0499-4fe0-a3c3-43a3055b773a", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilityScheduleInstances/21e4b59a-0499-4fe0-a3c3-43a3055b773a", + "type": "Microsoft.Authorization/RoleEligibilityScheduleInstances" + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleRequestByName.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleRequestByName.json new file mode 100644 index 000000000000..c17e47738891 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleRequestByName.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleEligibilityScheduleRequestName": "64caffb6-55c0-4deb-a585-68e948ea1ad6", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "targetRoleEligibilityScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "targetRoleEligibilityScheduleInstanceId": null, + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "requestType": "AdminAssign", + "status": "Provisioned", + "approvalId": null, + "scheduleInfo": { + "startDateTime": "2020-09-09T21:31:27.91Z", + "expiration": { + "type": "AfterDuration", + "endDateTime": null, + "duration": "P365D" + } + }, + "ticketInfo": { + "ticketNumber": null, + "ticketSystem": null + }, + "justification": null, + "requestorId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "createdOn": "2020-09-09T21:32:27.91Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "64caffb6-55c0-4deb-a585-68e948ea1ad6", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilityRequests/64caffb6-55c0-4deb-a585-68e948ea1ad6", + "type": "Microsoft.Authorization/RoleEligibilityRequests" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleRequestByScope.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleRequestByScope.json new file mode 100644 index 000000000000..e58d52f7edbd --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleRequestByScope.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "$filter": "assignedTo('A3BB8764-CB92-4276-9D2A-CA1E895E55EA')", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "targetRoleEligibilityScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "targetRoleEligibilityScheduleInstanceId": null, + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "requestType": "AdminAssign", + "status": "Provisioned", + "approvalId": null, + "scheduleInfo": { + "startDateTime": "2020-09-09T21:31:27.91Z", + "expiration": { + "type": "AfterDuration", + "endDateTime": null, + "duration": "P365D" + } + }, + "ticketInfo": { + "ticketNumber": null, + "ticketSystem": null + }, + "justification": null, + "requestorId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "createdOn": "2020-09-09T21:32:27.91Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "64caffb6-55c0-4deb-a585-68e948ea1ad6", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilityRequests/64caffb6-55c0-4deb-a585-68e948ea1ad6", + "type": "Microsoft.Authorization/RoleEligibilityRequests" + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilitySchedulesByScope.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilitySchedulesByScope.json new file mode 100644 index 000000000000..efff14bdf221 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilitySchedulesByScope.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "$filter": "assignedTo('a3bb8764-cb92-4276-9d2a-ca1e895e55ea')", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/b24988ac-6180-42a0-ab88-20f7382dd24c", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "status": "Provisioned", + "roleEligibilityScheduleRequestId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilityScheduleRequests/64caffb6-55c0-4deb-a585-68e948ea1ad6", + "startDateTime": "2020-09-09T21:33:14.557Z", + "endDateTime": "2021-09-09T21:32:28.49Z", + "memberType": "Direct", + "createdOn": "2020-09-09T21:33:06.3Z", + "updatedOn": "2020-09-09T22:27:00.513Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilitySchedules/b1477448-2cc6-4ceb-93b4-54a202a89413", + "type": "Microsoft.Authorization/RoleEligibilitySchedules" + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyAssignmentByName.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyAssignmentByName.json new file mode 100644 index 000000000000..dc63c66cf059 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyAssignmentByName.json @@ -0,0 +1,394 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "roleManagementPolicyAssignmentName": "b959d571-f0b5-4042-88a7-01be6cb22db9_a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "scope": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "roleDefinitionId": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleDefinitions/a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "policyId": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicies/b959d571-f0b5-4042-88a7-01be6cb22db9", + "effectiveRules": [ + { + "enabledRules": [], + "id": "Enablement_Admin_Eligibility", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_eligible@test.com" + ], + "id": "Notification_Requestor_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_eligible@test.com" + ], + "id": "Notification_Approver_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "MultiFactorAuthentication", + "Justification" + ], + "id": "Enablement_Admin_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": false, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_member@test.com" + ], + "id": "Notification_Admin_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_member@test.com" + ], + "id": "Notification_Requestor_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_member@test.com" + ], + "id": "Notification_Approver_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "setting": { + "isApprovalRequired": true, + "isApprovalRequiredForExtension": false, + "isRequestorJustificationRequired": true, + "approvalMode": "SingleStage", + "approvalStages": [ + { + "approvalStageTimeOutInDays": 1, + "isApproverJustificationRequired": true, + "escalationTimeInMinutes": 0, + "primaryApprovers": [ + { + "id": "2385b0f3-5fa9-43cf-8ca4-b01dc97298cd", + "description": "amansw_new_group", + "isBackup": false, + "userType": "Group" + }, + { + "id": "2f4913c9-d15b-406a-9946-1d66a28f2690", + "description": "amansw_group", + "isBackup": false, + "userType": "Group" + } + ], + "isEscalationEnabled": false, + "escalationApprovers": null + } + ] + }, + "id": "Approval_EndUser_Assignment", + "ruleType": "RoleManagementPolicyApprovalRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isEnabled": false, + "claimValue": "", + "id": "AuthenticationContext_EndUser_Assignment", + "ruleType": "RoleManagementPolicyAuthenticationContextRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "MultiFactorAuthentication", + "Justification", + "Ticketing" + ], + "id": "Enablement_EndUser_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "PT7H", + "exceptionMembers": null, + "id": "Expiration_EndUser_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_enduser_member@test.com" + ], + "id": "Notification_Admin_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_enduser_member@test.com" + ], + "id": "Notification_Requestor_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": true, + "notificationLevel": "Critical", + "notificationRecipients": null, + "id": "Notification_Approver_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + } + ], + "policyAssignmentProperties": { + "scope": { + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleDefinitions/a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "displayName": "FHIR Data Converter", + "type": "BuiltInRole" + }, + "policy": { + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicies/b959d571-f0b5-4042-88a7-01be6cb22db9", + "lastModifiedBy": { + "id": null, + "displayName": "Admin", + "type": null, + "email": null + }, + "lastModifiedDateTime": null + } + } + }, + "name": "b959d571-f0b5-4042-88a7-01be6cb22db9_a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicyAssignment/b959d571-f0b5-4042-88a7-01be6cb22db9_a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "type": "Microsoft.Authorization/RoleManagementPolicyAssignment" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyAssignmentByScope.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyAssignmentByScope.json new file mode 100644 index 000000000000..46e48704de5a --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyAssignmentByScope.json @@ -0,0 +1,397 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "scope": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "roleDefinitionId": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleDefinitions/a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "policyId": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicies/b959d571-f0b5-4042-88a7-01be6cb22db9", + "effectiveRules": [ + { + "enabledRules": [], + "id": "Enablement_Admin_Eligibility", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_eligible@test.com" + ], + "id": "Notification_Requestor_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_eligible@test.com" + ], + "id": "Notification_Approver_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "MultiFactorAuthentication", + "Justification" + ], + "id": "Enablement_Admin_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": false, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_member@test.com" + ], + "id": "Notification_Admin_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_member@test.com" + ], + "id": "Notification_Requestor_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_member@test.com" + ], + "id": "Notification_Approver_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "setting": { + "isApprovalRequired": true, + "isApprovalRequiredForExtension": false, + "isRequestorJustificationRequired": true, + "approvalMode": "SingleStage", + "approvalStages": [ + { + "approvalStageTimeOutInDays": 1, + "isApproverJustificationRequired": true, + "escalationTimeInMinutes": 0, + "primaryApprovers": [ + { + "id": "2385b0f3-5fa9-43cf-8ca4-b01dc97298cd", + "description": "amansw_new_group", + "isBackup": false, + "userType": "Group" + }, + { + "id": "2f4913c9-d15b-406a-9946-1d66a28f2690", + "description": "amansw_group", + "isBackup": false, + "userType": "Group" + } + ], + "isEscalationEnabled": false, + "escalationApprovers": null + } + ] + }, + "id": "Approval_EndUser_Assignment", + "ruleType": "RoleManagementPolicyApprovalRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isEnabled": false, + "claimValue": "", + "id": "AuthenticationContext_EndUser_Assignment", + "ruleType": "RoleManagementPolicyAuthenticationContextRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "MultiFactorAuthentication", + "Justification", + "Ticketing" + ], + "id": "Enablement_EndUser_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "PT7H", + "exceptionMembers": null, + "id": "Expiration_EndUser_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_enduser_member@test.com" + ], + "id": "Notification_Admin_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_enduser_member@test.com" + ], + "id": "Notification_Requestor_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": true, + "notificationLevel": "Critical", + "notificationRecipients": null, + "id": "Notification_Approver_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + } + ], + "policyAssignmentProperties": { + "scope": { + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleDefinitions/a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "displayName": "FHIR Data Converter", + "type": "BuiltInRole" + }, + "policy": { + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicies/b959d571-f0b5-4042-88a7-01be6cb22db9", + "lastModifiedBy": { + "id": null, + "displayName": "Admin", + "type": null, + "email": null + }, + "lastModifiedDateTime": null + } + } + }, + "name": "b959d571-f0b5-4042-88a7-01be6cb22db9_a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicyAssignment/b959d571-f0b5-4042-88a7-01be6cb22db9_a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "type": "Microsoft.Authorization/RoleManagementPolicyAssignment" + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyByName.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyByName.json new file mode 100644 index 000000000000..dd7377445abc --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyByName.json @@ -0,0 +1,738 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "roleManagementPolicyName": "570c3619-7688-4b34-b290-2b8bb3ccab2a", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "scope": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "displayName": null, + "description": null, + "isOrganizationDefault": false, + "lastModifiedDateTime": "2021-03-17T02:54:27.167+00:00", + "lastModifiedBy": { + "id": null, + "displayName": "Admin", + "type": null, + "email": null + }, + "rules": [ + { + "enabledRules": [], + "id": "Enablement_Admin_Eligibility", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_eligible@test.com" + ], + "id": "Notification_Requestor_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_eligible@test.com" + ], + "id": "Notification_Approver_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "MultiFactorAuthentication", + "Justification" + ], + "id": "Enablement_Admin_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": false, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_member@test.com" + ], + "id": "Notification_Admin_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_member@test.com" + ], + "id": "Notification_Requestor_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_member@test.com" + ], + "id": "Notification_Approver_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "setting": { + "isApprovalRequired": true, + "isApprovalRequiredForExtension": false, + "isRequestorJustificationRequired": true, + "approvalMode": "SingleStage", + "approvalStages": [ + { + "approvalStageTimeOutInDays": 1, + "isApproverJustificationRequired": true, + "escalationTimeInMinutes": 0, + "primaryApprovers": [ + { + "id": "2385b0f3-5fa9-43cf-8ca4-b01dc97298cd", + "description": "amansw_new_group", + "isBackup": false, + "userType": "Group" + }, + { + "id": "2f4913c9-d15b-406a-9946-1d66a28f2690", + "description": "amansw_group", + "isBackup": false, + "userType": "Group" + } + ], + "isEscalationEnabled": false, + "escalationApprovers": null + } + ] + }, + "id": "Approval_EndUser_Assignment", + "ruleType": "RoleManagementPolicyApprovalRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isEnabled": false, + "claimValue": "", + "id": "AuthenticationContext_EndUser_Assignment", + "ruleType": "RoleManagementPolicyAuthenticationContextRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "MultiFactorAuthentication", + "Justification", + "Ticketing" + ], + "id": "Enablement_EndUser_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "PT7H", + "exceptionMembers": null, + "id": "Expiration_EndUser_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_enduser_member@test.com" + ], + "id": "Notification_Admin_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_enduser_member@test.com" + ], + "id": "Notification_Requestor_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": true, + "notificationLevel": "Critical", + "notificationRecipients": null, + "id": "Notification_Approver_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + } + ], + "effectiveRules": [ + { + "enabledRules": [], + "id": "Enablement_Admin_Eligibility", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_eligible@test.com" + ], + "id": "Notification_Requestor_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_eligible@test.com" + ], + "id": "Notification_Approver_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "MultiFactorAuthentication", + "Justification" + ], + "id": "Enablement_Admin_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": false, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_member@test.com" + ], + "id": "Notification_Admin_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_member@test.com" + ], + "id": "Notification_Requestor_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_member@test.com" + ], + "id": "Notification_Approver_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "setting": { + "isApprovalRequired": true, + "isApprovalRequiredForExtension": false, + "isRequestorJustificationRequired": true, + "approvalMode": "SingleStage", + "approvalStages": [ + { + "approvalStageTimeOutInDays": 1, + "isApproverJustificationRequired": true, + "escalationTimeInMinutes": 0, + "primaryApprovers": [ + { + "id": "2385b0f3-5fa9-43cf-8ca4-b01dc97298cd", + "description": "amansw_new_group", + "isBackup": false, + "userType": "Group" + }, + { + "id": "2f4913c9-d15b-406a-9946-1d66a28f2690", + "description": "amansw_group", + "isBackup": false, + "userType": "Group" + } + ], + "isEscalationEnabled": false, + "escalationApprovers": null + } + ] + }, + "id": "Approval_EndUser_Assignment", + "ruleType": "RoleManagementPolicyApprovalRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isEnabled": false, + "claimValue": "", + "id": "AuthenticationContext_EndUser_Assignment", + "ruleType": "RoleManagementPolicyAuthenticationContextRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "MultiFactorAuthentication", + "Justification", + "Ticketing" + ], + "id": "Enablement_EndUser_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "PT7H", + "exceptionMembers": null, + "id": "Expiration_EndUser_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_enduser_member@test.com" + ], + "id": "Notification_Admin_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_enduser_member@test.com" + ], + "id": "Notification_Requestor_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": true, + "notificationLevel": "Critical", + "notificationRecipients": null, + "id": "Notification_Approver_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + } + ], + "policyProperties": { + "scope": { + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "displayName": "Pay-As-You-Go", + "type": "subscription" + } + } + }, + "name": "570c3619-7688-4b34-b290-2b8bb3ccab2a", + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicies/570c3619-7688-4b34-b290-2b8bb3ccab2a", + "type": "Microsoft.Authorization/RoleManagementPolicies" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyByScope.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyByScope.json new file mode 100644 index 000000000000..956daa8ec93a --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyByScope.json @@ -0,0 +1,741 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "scope": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "displayName": null, + "description": null, + "isOrganizationDefault": false, + "lastModifiedDateTime": "2021-03-17T02:54:27.167+00:00", + "lastModifiedBy": { + "id": null, + "displayName": "Admin", + "type": null, + "email": null + }, + "rules": [ + { + "enabledRules": [], + "id": "Enablement_Admin_Eligibility", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_eligible@test.com" + ], + "id": "Notification_Requestor_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_eligible@test.com" + ], + "id": "Notification_Approver_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "MultiFactorAuthentication", + "Justification" + ], + "id": "Enablement_Admin_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": false, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_member@test.com" + ], + "id": "Notification_Admin_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_member@test.com" + ], + "id": "Notification_Requestor_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_member@test.com" + ], + "id": "Notification_Approver_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "setting": { + "isApprovalRequired": true, + "isApprovalRequiredForExtension": false, + "isRequestorJustificationRequired": true, + "approvalMode": "SingleStage", + "approvalStages": [ + { + "approvalStageTimeOutInDays": 1, + "isApproverJustificationRequired": true, + "escalationTimeInMinutes": 0, + "primaryApprovers": [ + { + "id": "2385b0f3-5fa9-43cf-8ca4-b01dc97298cd", + "description": "amansw_new_group", + "isBackup": false, + "userType": "Group" + }, + { + "id": "2f4913c9-d15b-406a-9946-1d66a28f2690", + "description": "amansw_group", + "isBackup": false, + "userType": "Group" + } + ], + "isEscalationEnabled": false, + "escalationApprovers": null + } + ] + }, + "id": "Approval_EndUser_Assignment", + "ruleType": "RoleManagementPolicyApprovalRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isEnabled": false, + "claimValue": "", + "id": "AuthenticationContext_EndUser_Assignment", + "ruleType": "RoleManagementPolicyAuthenticationContextRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "MultiFactorAuthentication", + "Justification", + "Ticketing" + ], + "id": "Enablement_EndUser_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "PT7H", + "exceptionMembers": null, + "id": "Expiration_EndUser_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_enduser_member@test.com" + ], + "id": "Notification_Admin_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_enduser_member@test.com" + ], + "id": "Notification_Requestor_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": true, + "notificationLevel": "Critical", + "notificationRecipients": null, + "id": "Notification_Approver_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + } + ], + "effectiveRules": [ + { + "enabledRules": [], + "id": "Enablement_Admin_Eligibility", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_eligible@test.com" + ], + "id": "Notification_Requestor_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_eligible@test.com" + ], + "id": "Notification_Approver_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "MultiFactorAuthentication", + "Justification" + ], + "id": "Enablement_Admin_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": false, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_member@test.com" + ], + "id": "Notification_Admin_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_member@test.com" + ], + "id": "Notification_Requestor_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_member@test.com" + ], + "id": "Notification_Approver_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "setting": { + "isApprovalRequired": true, + "isApprovalRequiredForExtension": false, + "isRequestorJustificationRequired": true, + "approvalMode": "SingleStage", + "approvalStages": [ + { + "approvalStageTimeOutInDays": 1, + "isApproverJustificationRequired": true, + "escalationTimeInMinutes": 0, + "primaryApprovers": [ + { + "id": "2385b0f3-5fa9-43cf-8ca4-b01dc97298cd", + "description": "amansw_new_group", + "isBackup": false, + "userType": "Group" + }, + { + "id": "2f4913c9-d15b-406a-9946-1d66a28f2690", + "description": "amansw_group", + "isBackup": false, + "userType": "Group" + } + ], + "isEscalationEnabled": false, + "escalationApprovers": null + } + ] + }, + "id": "Approval_EndUser_Assignment", + "ruleType": "RoleManagementPolicyApprovalRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isEnabled": false, + "claimValue": "", + "id": "AuthenticationContext_EndUser_Assignment", + "ruleType": "RoleManagementPolicyAuthenticationContextRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "MultiFactorAuthentication", + "Justification", + "Ticketing" + ], + "id": "Enablement_EndUser_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "PT7H", + "exceptionMembers": null, + "id": "Expiration_EndUser_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_enduser_member@test.com" + ], + "id": "Notification_Admin_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_enduser_member@test.com" + ], + "id": "Notification_Requestor_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": true, + "notificationLevel": "Critical", + "notificationRecipients": null, + "id": "Notification_Approver_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + } + ], + "policyProperties": { + "scope": { + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "displayName": "Pay-As-You-Go", + "type": "subscription" + } + } + }, + "name": "570c3619-7688-4b34-b290-2b8bb3ccab2a", + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicies/570c3619-7688-4b34-b290-2b8bb3ccab2a", + "type": "Microsoft.Authorization/RoleManagementPolicies" + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PatchPartialRoleManagementPolicy.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PatchPartialRoleManagementPolicy.json new file mode 100644 index 000000000000..d608391c4c10 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PatchPartialRoleManagementPolicy.json @@ -0,0 +1,782 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "roleManagementPolicyName": "570c3619-7688-4b34-b290-2b8bb3ccab2a", + "api-version": "2024-09-01-preview", + "parameters": { + "properties": { + "rules": [ + { + "isExpirationRequired": false, + "maximumDuration": "P180D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "scope": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "displayName": null, + "description": null, + "isOrganizationDefault": false, + "lastModifiedDateTime": "2021-03-17T16:35:27.91+00:00", + "lastModifiedBy": { + "id": null, + "displayName": "Admin", + "type": null, + "email": null + }, + "rules": [ + { + "isExpirationRequired": false, + "maximumDuration": "P180D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_eligible@test.com" + ], + "id": "Notification_Requestor_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_eligible@test.com" + ], + "id": "Notification_Approver_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [], + "id": "Enablement_Admin_Eligibility", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": false, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "Justification", + "MultiFactorAuthentication" + ], + "id": "Enablement_Admin_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_member@test.com" + ], + "id": "Notification_Admin_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_member@test.com" + ], + "id": "Notification_Requestor_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_member@test.com" + ], + "id": "Notification_Approver_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "PT7H", + "exceptionMembers": null, + "id": "Expiration_EndUser_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "Justification", + "MultiFactorAuthentication", + "Ticketing" + ], + "id": "Enablement_EndUser_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "setting": { + "isApprovalRequired": true, + "isApprovalRequiredForExtension": false, + "isRequestorJustificationRequired": true, + "approvalMode": "SingleStage", + "approvalStages": [ + { + "approvalStageTimeOutInDays": 1, + "isApproverJustificationRequired": true, + "escalationTimeInMinutes": 0, + "primaryApprovers": [ + { + "id": "2385b0f3-5fa9-43cf-8ca4-b01dc97298cd", + "description": "amansw_new_group", + "isBackup": false, + "userType": "Group" + }, + { + "id": "2f4913c9-d15b-406a-9946-1d66a28f2690", + "description": "amansw_group", + "isBackup": false, + "userType": "Group" + } + ], + "isEscalationEnabled": false, + "escalationApprovers": null + } + ] + }, + "id": "Approval_EndUser_Assignment", + "ruleType": "RoleManagementPolicyApprovalRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isEnabled": false, + "claimValue": "", + "id": "AuthenticationContext_EndUser_Assignment", + "ruleType": "RoleManagementPolicyAuthenticationContextRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_enduser_member@test.com" + ], + "id": "Notification_Admin_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_enduser_member@test.com" + ], + "id": "Notification_Requestor_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": true, + "notificationLevel": "Critical", + "notificationRecipients": null, + "id": "Notification_Approver_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + } + ], + "effectiveRules": [ + { + "isExpirationRequired": false, + "maximumDuration": "P180D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_eligible@test.com" + ], + "id": "Notification_Requestor_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_eligible@test.com" + ], + "id": "Notification_Approver_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [], + "id": "Enablement_Admin_Eligibility", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": false, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "Justification", + "MultiFactorAuthentication" + ], + "id": "Enablement_Admin_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_member@test.com" + ], + "id": "Notification_Admin_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_member@test.com" + ], + "id": "Notification_Requestor_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_member@test.com" + ], + "id": "Notification_Approver_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "PT7H", + "exceptionMembers": null, + "id": "Expiration_EndUser_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "Justification", + "MultiFactorAuthentication", + "Ticketing" + ], + "id": "Enablement_EndUser_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "setting": { + "isApprovalRequired": true, + "isApprovalRequiredForExtension": false, + "isRequestorJustificationRequired": true, + "approvalMode": "SingleStage", + "approvalStages": [ + { + "approvalStageTimeOutInDays": 1, + "isApproverJustificationRequired": true, + "escalationTimeInMinutes": 0, + "primaryApprovers": [ + { + "id": "2385b0f3-5fa9-43cf-8ca4-b01dc97298cd", + "description": "amansw_new_group", + "isBackup": false, + "userType": "Group" + }, + { + "id": "2f4913c9-d15b-406a-9946-1d66a28f2690", + "description": "amansw_group", + "isBackup": false, + "userType": "Group" + } + ], + "isEscalationEnabled": false, + "escalationApprovers": null + } + ] + }, + "id": "Approval_EndUser_Assignment", + "ruleType": "RoleManagementPolicyApprovalRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isEnabled": false, + "claimValue": "", + "id": "AuthenticationContext_EndUser_Assignment", + "ruleType": "RoleManagementPolicyAuthenticationContextRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_enduser_member@test.com" + ], + "id": "Notification_Admin_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_enduser_member@test.com" + ], + "id": "Notification_Requestor_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": true, + "notificationLevel": "Critical", + "notificationRecipients": null, + "id": "Notification_Approver_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + } + ], + "policyProperties": { + "scope": { + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "displayName": "Pay-As-You-Go", + "type": "subscription" + } + } + }, + "name": "570c3619-7688-4b34-b290-2b8bb3ccab2a", + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicies/570c3619-7688-4b34-b290-2b8bb3ccab2a", + "type": "Microsoft.Authorization/RoleManagementPolicies" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PatchRoleManagementPolicy.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PatchRoleManagementPolicy.json new file mode 100644 index 000000000000..aa1ad8c3fd53 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PatchRoleManagementPolicy.json @@ -0,0 +1,1172 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "roleManagementPolicyName": "570c3619-7688-4b34-b290-2b8bb3ccab2a", + "api-version": "2024-09-01-preview", + "parameters": { + "properties": { + "rules": [ + { + "isExpirationRequired": false, + "maximumDuration": "P180D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_eligible@test.com" + ], + "id": "Notification_Requestor_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_eligible@test.com" + ], + "id": "Notification_Approver_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [], + "id": "Enablement_Admin_Eligibility", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": false, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "Justification", + "MultiFactorAuthentication" + ], + "id": "Enablement_Admin_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_member@test.com" + ], + "id": "Notification_Admin_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_member@test.com" + ], + "id": "Notification_Requestor_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_member@test.com" + ], + "id": "Notification_Approver_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "PT7H", + "exceptionMembers": null, + "id": "Expiration_EndUser_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "Justification", + "MultiFactorAuthentication", + "Ticketing" + ], + "id": "Enablement_EndUser_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "setting": { + "isApprovalRequired": true, + "isApprovalRequiredForExtension": false, + "isRequestorJustificationRequired": true, + "approvalMode": "SingleStage", + "approvalStages": [ + { + "approvalStageTimeOutInDays": 1, + "isApproverJustificationRequired": true, + "escalationTimeInMinutes": 0, + "primaryApprovers": [ + { + "id": "2385b0f3-5fa9-43cf-8ca4-b01dc97298cd", + "description": "amansw_new_group", + "isBackup": false, + "userType": "Group" + }, + { + "id": "2f4913c9-d15b-406a-9946-1d66a28f2690", + "description": "amansw_group", + "isBackup": false, + "userType": "Group" + } + ], + "isEscalationEnabled": false, + "escalationApprovers": null + } + ] + }, + "id": "Approval_EndUser_Assignment", + "ruleType": "RoleManagementPolicyApprovalRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isEnabled": false, + "claimValue": "", + "id": "AuthenticationContext_EndUser_Assignment", + "ruleType": "RoleManagementPolicyAuthenticationContextRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_enduser_member@test.com" + ], + "id": "Notification_Admin_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_enduser_member@test.com" + ], + "id": "Notification_Requestor_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": true, + "notificationLevel": "Critical", + "notificationRecipients": null, + "id": "Notification_Approver_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "id": "PIMOnlyMode_Admin_Assignment", + "ruleType": "RoleManagementPolicyPimOnlyModeRule", + "pimOnlyModeSettings": { + "excludedAssignmentTypes": [ + "ServicePrincipalsAsTarget" + ], + "mode": "Enabled", + "excludes": [ + { + "id": "ec42a424-a0c0-4418-8788-d19bdeb03704", + "type": "User" + }, + { + "id": "00029dfb-0218-4e7a-9a85-c15dc0c880bc", + "type": "Group" + }, + { + "id": "0000103d-1fc2-4ac8-81de-71517765655c", + "type": "ServicePrincipal" + } + ] + }, + "target": { + "caller": "Admin", + "level": "Assignment", + "operations": [ + "all" + ], + "enforcedSettings": [ + "all" + ], + "inheritableSettings": [ + "all" + ], + "targetObjects": [] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "scope": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "displayName": null, + "description": null, + "isOrganizationDefault": false, + "lastModifiedDateTime": "2021-03-17T16:35:27.91+00:00", + "lastModifiedBy": { + "id": null, + "displayName": "Admin", + "type": null, + "email": null + }, + "rules": [ + { + "isExpirationRequired": false, + "maximumDuration": "P180D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_eligible@test.com" + ], + "id": "Notification_Requestor_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_eligible@test.com" + ], + "id": "Notification_Approver_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [], + "id": "Enablement_Admin_Eligibility", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": false, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "Justification", + "MultiFactorAuthentication" + ], + "id": "Enablement_Admin_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_member@test.com" + ], + "id": "Notification_Admin_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_member@test.com" + ], + "id": "Notification_Requestor_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_member@test.com" + ], + "id": "Notification_Approver_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "PT7H", + "exceptionMembers": null, + "id": "Expiration_EndUser_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "Justification", + "MultiFactorAuthentication", + "Ticketing" + ], + "id": "Enablement_EndUser_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "setting": { + "isApprovalRequired": true, + "isApprovalRequiredForExtension": false, + "isRequestorJustificationRequired": true, + "approvalMode": "SingleStage", + "approvalStages": [ + { + "approvalStageTimeOutInDays": 1, + "isApproverJustificationRequired": true, + "escalationTimeInMinutes": 0, + "primaryApprovers": [ + { + "id": "2385b0f3-5fa9-43cf-8ca4-b01dc97298cd", + "description": "amansw_new_group", + "isBackup": false, + "userType": "Group" + }, + { + "id": "2f4913c9-d15b-406a-9946-1d66a28f2690", + "description": "amansw_group", + "isBackup": false, + "userType": "Group" + } + ], + "isEscalationEnabled": false, + "escalationApprovers": null + } + ] + }, + "id": "Approval_EndUser_Assignment", + "ruleType": "RoleManagementPolicyApprovalRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isEnabled": false, + "claimValue": "", + "id": "AuthenticationContext_EndUser_Assignment", + "ruleType": "RoleManagementPolicyAuthenticationContextRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_enduser_member@test.com" + ], + "id": "Notification_Admin_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_enduser_member@test.com" + ], + "id": "Notification_Requestor_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": true, + "notificationLevel": "Critical", + "notificationRecipients": null, + "id": "Notification_Approver_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + } + ], + "effectiveRules": [ + { + "isExpirationRequired": false, + "maximumDuration": "P180D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_eligible@test.com" + ], + "id": "Notification_Requestor_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_eligible@test.com" + ], + "id": "Notification_Approver_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [], + "id": "Enablement_Admin_Eligibility", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": false, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "Justification", + "MultiFactorAuthentication" + ], + "id": "Enablement_Admin_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_member@test.com" + ], + "id": "Notification_Admin_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_member@test.com" + ], + "id": "Notification_Requestor_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_member@test.com" + ], + "id": "Notification_Approver_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "PT7H", + "exceptionMembers": null, + "id": "Expiration_EndUser_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "Justification", + "MultiFactorAuthentication", + "Ticketing" + ], + "id": "Enablement_EndUser_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "setting": { + "isApprovalRequired": true, + "isApprovalRequiredForExtension": false, + "isRequestorJustificationRequired": true, + "approvalMode": "SingleStage", + "approvalStages": [ + { + "approvalStageTimeOutInDays": 1, + "isApproverJustificationRequired": true, + "escalationTimeInMinutes": 0, + "primaryApprovers": [ + { + "id": "2385b0f3-5fa9-43cf-8ca4-b01dc97298cd", + "description": "amansw_new_group", + "isBackup": false, + "userType": "Group" + }, + { + "id": "2f4913c9-d15b-406a-9946-1d66a28f2690", + "description": "amansw_group", + "isBackup": false, + "userType": "Group" + } + ], + "isEscalationEnabled": false, + "escalationApprovers": null + } + ] + }, + "id": "Approval_EndUser_Assignment", + "ruleType": "RoleManagementPolicyApprovalRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isEnabled": false, + "claimValue": "", + "id": "AuthenticationContext_EndUser_Assignment", + "ruleType": "RoleManagementPolicyAuthenticationContextRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_enduser_member@test.com" + ], + "id": "Notification_Admin_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_enduser_member@test.com" + ], + "id": "Notification_Requestor_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": true, + "notificationLevel": "Critical", + "notificationRecipients": null, + "id": "Notification_Approver_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "id": "PIMOnlyMode_Admin_Assignment", + "ruleType": "RoleManagementPolicyPimOnlyModeRule", + "pimOnlyModeSettings": { + "excludedAssignmentTypes": [ + "ServicePrincipalsAsTarget" + ], + "mode": "Enabled", + "excludes": [ + { + "id": "ec42a424-a0c0-4418-8788-d19bdeb03704", + "type": "User", + "displayName": "AdminUser1" + }, + { + "id": "00029dfb-0218-4e7a-9a85-c15dc0c880bc", + "type": "Group", + "displayName": "Admin Group1" + }, + { + "id": "0000103d-1fc2-4ac8-81de-71517765655c", + "type": "ServicePrincipal", + "displayName": "JIT Application" + } + ] + }, + "target": { + "caller": "Admin", + "level": "Assignment", + "operations": [ + "all" + ], + "enforcedSettings": [ + "all" + ], + "inheritableSettings": [ + "all" + ], + "targetObjects": [] + } + } + ], + "policyProperties": { + "scope": { + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "displayName": "Pay-As-You-Go", + "type": "subscription" + } + } + }, + "name": "570c3619-7688-4b34-b290-2b8bb3ccab2a", + "id": "/providers/Microsoft.Subscription/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicies/570c3619-7688-4b34-b290-2b8bb3ccab2a", + "type": "Microsoft.Authorization/RoleManagementPolicies" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PatchRoleManagementPolicyToEnablePIMOnlyMode.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PatchRoleManagementPolicyToEnablePIMOnlyMode.json new file mode 100644 index 000000000000..302e6822f305 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PatchRoleManagementPolicyToEnablePIMOnlyMode.json @@ -0,0 +1,861 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "roleManagementPolicyName": "570c3619-7688-4b34-b290-2b8bb3ccab2a", + "api-version": "2024-09-01-preview", + "parameters": { + "properties": { + "rules": [ + { + "id": "PIMOnlyMode_Admin_Assignment", + "ruleType": "RoleManagementPolicyPimOnlyModeRule", + "pimOnlyModeSettings": { + "excludedAssignmentTypes": [ + "ServicePrincipalsAsTarget" + ], + "mode": "Enabled", + "excludes": [ + { + "id": "ec42a424-a0c0-4418-8788-d19bdeb03704", + "type": "User" + }, + { + "id": "00029dfb-0218-4e7a-9a85-c15dc0c880bc", + "type": "Group" + }, + { + "id": "0000103d-1fc2-4ac8-81de-71517765655c", + "type": "ServicePrincipal" + } + ] + }, + "target": { + "caller": "Admin", + "level": "Assignment", + "operations": [ + "all" + ], + "enforcedSettings": [ + "all" + ], + "inheritableSettings": [ + "all" + ], + "targetObjects": [] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "scope": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "displayName": null, + "description": null, + "isOrganizationDefault": false, + "lastModifiedDateTime": "2021-03-17T16:35:27.91+00:00", + "lastModifiedBy": { + "id": null, + "displayName": "Admin", + "type": null, + "email": null + }, + "rules": [ + { + "isExpirationRequired": false, + "maximumDuration": "P180D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_eligible@test.com" + ], + "id": "Notification_Requestor_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_eligible@test.com" + ], + "id": "Notification_Approver_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [], + "id": "Enablement_Admin_Eligibility", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": false, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "Justification", + "MultiFactorAuthentication" + ], + "id": "Enablement_Admin_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_member@test.com" + ], + "id": "Notification_Admin_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_member@test.com" + ], + "id": "Notification_Requestor_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_member@test.com" + ], + "id": "Notification_Approver_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "PT7H", + "exceptionMembers": null, + "id": "Expiration_EndUser_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "Justification", + "MultiFactorAuthentication", + "Ticketing" + ], + "id": "Enablement_EndUser_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "setting": { + "isApprovalRequired": true, + "isApprovalRequiredForExtension": false, + "isRequestorJustificationRequired": true, + "approvalMode": "SingleStage", + "approvalStages": [ + { + "approvalStageTimeOutInDays": 1, + "isApproverJustificationRequired": true, + "escalationTimeInMinutes": 0, + "primaryApprovers": [ + { + "id": "2385b0f3-5fa9-43cf-8ca4-b01dc97298cd", + "description": "amansw_new_group", + "isBackup": false, + "userType": "Group" + }, + { + "id": "2f4913c9-d15b-406a-9946-1d66a28f2690", + "description": "amansw_group", + "isBackup": false, + "userType": "Group" + } + ], + "isEscalationEnabled": false, + "escalationApprovers": null + } + ] + }, + "id": "Approval_EndUser_Assignment", + "ruleType": "RoleManagementPolicyApprovalRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isEnabled": false, + "claimValue": "", + "id": "AuthenticationContext_EndUser_Assignment", + "ruleType": "RoleManagementPolicyAuthenticationContextRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_enduser_member@test.com" + ], + "id": "Notification_Admin_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_enduser_member@test.com" + ], + "id": "Notification_Requestor_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": true, + "notificationLevel": "Critical", + "notificationRecipients": null, + "id": "Notification_Approver_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + } + ], + "effectiveRules": [ + { + "isExpirationRequired": false, + "maximumDuration": "P180D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_eligible@test.com" + ], + "id": "Notification_Requestor_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_eligible@test.com" + ], + "id": "Notification_Approver_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [], + "id": "Enablement_Admin_Eligibility", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": false, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "Justification", + "MultiFactorAuthentication" + ], + "id": "Enablement_Admin_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_member@test.com" + ], + "id": "Notification_Admin_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_member@test.com" + ], + "id": "Notification_Requestor_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_member@test.com" + ], + "id": "Notification_Approver_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "PT7H", + "exceptionMembers": null, + "id": "Expiration_EndUser_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "Justification", + "MultiFactorAuthentication", + "Ticketing" + ], + "id": "Enablement_EndUser_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "setting": { + "isApprovalRequired": true, + "isApprovalRequiredForExtension": false, + "isRequestorJustificationRequired": true, + "approvalMode": "SingleStage", + "approvalStages": [ + { + "approvalStageTimeOutInDays": 1, + "isApproverJustificationRequired": true, + "escalationTimeInMinutes": 0, + "primaryApprovers": [ + { + "id": "2385b0f3-5fa9-43cf-8ca4-b01dc97298cd", + "description": "amansw_new_group", + "isBackup": false, + "userType": "Group" + }, + { + "id": "2f4913c9-d15b-406a-9946-1d66a28f2690", + "description": "amansw_group", + "isBackup": false, + "userType": "Group" + } + ], + "isEscalationEnabled": false, + "escalationApprovers": null + } + ] + }, + "id": "Approval_EndUser_Assignment", + "ruleType": "RoleManagementPolicyApprovalRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isEnabled": false, + "claimValue": "", + "id": "AuthenticationContext_EndUser_Assignment", + "ruleType": "RoleManagementPolicyAuthenticationContextRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_enduser_member@test.com" + ], + "id": "Notification_Admin_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_enduser_member@test.com" + ], + "id": "Notification_Requestor_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": true, + "notificationLevel": "Critical", + "notificationRecipients": null, + "id": "Notification_Approver_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "id": "PIMOnlyMode_Admin_Assignment", + "ruleType": "RoleManagementPolicyPimOnlyModeRule", + "pimOnlyModeSettings": { + "excludedAssignmentTypes": [ + "ServicePrincipalsAsTarget" + ], + "mode": "Enabled", + "excludes": [ + { + "id": "ec42a424-a0c0-4418-8788-d19bdeb03704", + "type": "User", + "displayName": "AdminUser1" + }, + { + "id": "00029dfb-0218-4e7a-9a85-c15dc0c880bc", + "type": "Group", + "displayName": "Admin Group1" + }, + { + "id": "0000103d-1fc2-4ac8-81de-71517765655c", + "type": "ServicePrincipal", + "displayName": "JIT Application" + } + ] + }, + "target": { + "caller": "Admin", + "level": "Assignment", + "operations": [ + "all" + ], + "enforcedSettings": [ + "all" + ], + "inheritableSettings": [ + "all" + ], + "targetObjects": [] + } + }, + { + "id": "PIMOnlyMode_Admin_Assignment", + "ruleType": "RoleManagementPolicyPimOnlyModeRule", + "pimOnlyModeSettings": { + "excludedAssignmentTypes": [ + "ServicePrincipalsAsTarget" + ], + "mode": "Enabled", + "excludes": [ + { + "id": "ec42a424-a0c0-4418-8788-d19bdeb03704", + "type": "User" + }, + { + "id": "00029dfb-0218-4e7a-9a85-c15dc0c880bc", + "type": "Group" + }, + { + "id": "0000103d-1fc2-4ac8-81de-71517765655c", + "type": "ServicePrincipal" + } + ] + }, + "target": { + "caller": "Admin", + "level": "Assignment", + "operations": [ + "all" + ], + "enforcedSettings": [ + "all" + ], + "inheritableSettings": [ + "all" + ], + "targetObjects": [] + } + } + ], + "policyProperties": { + "scope": { + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "displayName": "Pay-As-You-Go", + "type": "subscription" + } + } + }, + "name": "570c3619-7688-4b34-b290-2b8bb3ccab2a", + "id": "/providers/Microsoft.Subscription/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicies/570c3619-7688-4b34-b290-2b8bb3ccab2a", + "type": "Microsoft.Authorization/RoleManagementPolicies" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PutRoleAssignmentScheduleRequest.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PutRoleAssignmentScheduleRequest.json new file mode 100644 index 000000000000..b75cb221c0a7 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PutRoleAssignmentScheduleRequest.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleAssignmentScheduleRequestName": "fea7a502-9a96-4806-a26f-eee560e52045", + "parameters": { + "properties": { + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "requestType": "SelfActivate", + "linkedRoleEligibilityScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "scheduleInfo": { + "startDateTime": "2020-09-09T21:35:27.91Z", + "expiration": { + "type": "AfterDuration", + "endDateTime": null, + "duration": "PT8H" + } + }, + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0" + } + }, + "api-version": "2024-09-01-preview" + }, + "responses": { + "201": { + "body": { + "properties": { + "targetRoleAssignmentScheduleId": "c9e264ff-3133-4776-a81a-ebc7c33c8ec6", + "targetRoleAssignmentScheduleInstanceId": null, + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "requestType": "SelfActivate", + "status": "Provisioned", + "approvalId": null, + "scheduleInfo": { + "startDateTime": "2020-09-09T21:35:27.91Z", + "expiration": { + "type": "AfterDuration", + "endDateTime": null, + "duration": "PT8H" + } + }, + "ticketInfo": { + "ticketNumber": null, + "ticketSystem": null + }, + "justification": null, + "requestorId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "createdOn": "2020-09-09T21:35:27.91Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "fea7a502-9a96-4806-a26f-eee560e52045", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentScheduleRequests/fea7a502-9a96-4806-a26f-eee560e52045", + "type": "Microsoft.Authorization/RoleAssignmentScheduleRequests" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PutRoleEligibilityScheduleRequest.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PutRoleEligibilityScheduleRequest.json new file mode 100644 index 000000000000..0ad80a7d4ab4 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PutRoleEligibilityScheduleRequest.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleEligibilityScheduleRequestName": "64caffb6-55c0-4deb-a585-68e948ea1ad6", + "parameters": { + "properties": { + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "requestType": "AdminAssign", + "scheduleInfo": { + "startDateTime": "2020-09-09T21:31:27.91Z", + "expiration": { + "type": "AfterDuration", + "endDateTime": null, + "duration": "P365D" + } + }, + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0" + } + }, + "api-version": "2024-09-01-preview" + }, + "responses": { + "201": { + "body": { + "properties": { + "targetRoleEligibilityScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "targetRoleEligibilityScheduleInstanceId": null, + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "requestType": "AdminAssign", + "status": "Provisioned", + "approvalId": null, + "scheduleInfo": { + "startDateTime": "2020-09-09T21:31:27.91Z", + "expiration": { + "type": "AfterDuration", + "endDateTime": null, + "duration": "P365D" + } + }, + "ticketInfo": { + "ticketNumber": null, + "ticketSystem": null + }, + "justification": null, + "requestorId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "createdOn": "2020-09-09T21:32:27.91Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "64caffb6-55c0-4deb-a585-68e948ea1ad6", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilityScheduleRequests/64caffb6-55c0-4deb-a585-68e948ea1ad6", + "type": "Microsoft.Authorization/RoleEligibilityScheduleRequests" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PutRoleManagementPolicyAssignment.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PutRoleManagementPolicyAssignment.json new file mode 100644 index 000000000000..b01e12e31fa7 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PutRoleManagementPolicyAssignment.json @@ -0,0 +1,396 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "roleManagementPolicyAssignmentName": "b959d571-f0b5-4042-88a7-01be6cb22db9_a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "api-version": "2024-09-01-preview", + "parameters": { + "properties": { + "scope": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "roleDefinitionId": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleDefinitions/a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "policyId": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicies/b959d571-f0b5-4042-88a7-01be6cb22db9" + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "scope": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "roleDefinitionId": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleDefinitions/a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "policyId": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicies/b959d571-f0b5-4042-88a7-01be6cb22db9", + "effectiveRules": [ + { + "enabledRules": [], + "id": "Enablement_Admin_Eligibility", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_eligible@test.com" + ], + "id": "Notification_Requestor_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_eligible@test.com" + ], + "id": "Notification_Approver_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "MultiFactorAuthentication", + "Justification" + ], + "id": "Enablement_Admin_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": false, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_member@test.com" + ], + "id": "Notification_Admin_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_member@test.com" + ], + "id": "Notification_Requestor_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_member@test.com" + ], + "id": "Notification_Approver_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "setting": { + "isApprovalRequired": true, + "isApprovalRequiredForExtension": false, + "isRequestorJustificationRequired": true, + "approvalMode": "SingleStage", + "approvalStages": [ + { + "approvalStageTimeOutInDays": 1, + "isApproverJustificationRequired": true, + "escalationTimeInMinutes": 0, + "primaryApprovers": [ + { + "id": "2385b0f3-5fa9-43cf-8ca4-b01dc97298cd", + "description": "amansw_new_group", + "isBackup": false, + "userType": "Group" + }, + { + "id": "2f4913c9-d15b-406a-9946-1d66a28f2690", + "description": "amansw_group", + "isBackup": false, + "userType": "Group" + } + ], + "isEscalationEnabled": false, + "escalationApprovers": null + } + ] + }, + "id": "Approval_EndUser_Assignment", + "ruleType": "RoleManagementPolicyApprovalRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isEnabled": false, + "claimValue": "", + "id": "AuthenticationContext_EndUser_Assignment", + "ruleType": "RoleManagementPolicyAuthenticationContextRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "MultiFactorAuthentication", + "Justification", + "Ticketing" + ], + "id": "Enablement_EndUser_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "PT7H", + "exceptionMembers": null, + "id": "Expiration_EndUser_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_enduser_member@test.com" + ], + "id": "Notification_Admin_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_enduser_member@test.com" + ], + "id": "Notification_Requestor_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": true, + "notificationLevel": "Critical", + "notificationRecipients": null, + "id": "Notification_Approver_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + } + ], + "policyAssignmentProperties": { + "scope": { + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleDefinitions/a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "displayName": "FHIR Data Converter", + "type": "BuiltInRole" + }, + "policy": { + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicies/b959d571-f0b5-4042-88a7-01be6cb22db9", + "lastModifiedBy": null, + "lastModifiedDateTime": null + } + } + }, + "name": "b959d571-f0b5-4042-88a7-01be6cb22db9_a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicyAssignment/b959d571-f0b5-4042-88a7-01be6cb22db9_a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "type": "Microsoft.Authorization/RoleManagementPolicyAssignment" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/ValidateRoleAssignmentScheduleRequestByName.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/ValidateRoleAssignmentScheduleRequestByName.json new file mode 100644 index 000000000000..96eac3c70592 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/ValidateRoleAssignmentScheduleRequestByName.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "scope": "subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleAssignmentScheduleRequestName": "fea7a502-9a96-4806-a26f-eee560e52045", + "parameters": { + "properties": { + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "requestType": "SelfActivate", + "linkedRoleEligibilityScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "scheduleInfo": { + "startDateTime": "2020-09-09T21:35:27.91Z", + "expiration": { + "type": "AfterDuration", + "endDateTime": null, + "duration": "PT8H" + } + }, + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0" + } + }, + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "targetRoleAssignmentScheduleId": "c9e264ff-3133-4776-a81a-ebc7c33c8ec6", + "targetRoleAssignmentScheduleInstanceId": null, + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "requestType": "SelfActivate", + "status": "Provisioned", + "approvalId": null, + "scheduleInfo": { + "startDateTime": "2020-09-09T21:35:27.91Z", + "expiration": { + "type": "AfterDuration", + "endDateTime": null, + "duration": "PT8H" + } + }, + "ticketInfo": { + "ticketNumber": null, + "ticketSystem": null + }, + "justification": null, + "requestorId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "createdOn": "2020-09-09T21:35:27.91Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "fea7a502-9a96-4806-a26f-eee560e52045", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentScheduleRequests/fea7a502-9a96-4806-a26f-eee560e52045", + "type": "Microsoft.Authorization/RoleAssignmentScheduleRequests" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/ValidateRoleEligibilityScheduleRequestByName.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/ValidateRoleEligibilityScheduleRequestByName.json new file mode 100644 index 000000000000..5ba43835dfb4 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/ValidateRoleEligibilityScheduleRequestByName.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "scope": "subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleEligibilityScheduleRequestName": "64caffb6-55c0-4deb-a585-68e948ea1ad6", + "parameters": { + "properties": { + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "requestType": "AdminAssign", + "scheduleInfo": { + "startDateTime": "2020-09-09T21:31:27.91Z", + "expiration": { + "type": "AfterDuration", + "endDateTime": null, + "duration": "P365D" + } + }, + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0" + } + }, + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "targetRoleEligibilityScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "targetRoleEligibilityScheduleInstanceId": null, + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "requestType": "AdminAssign", + "status": "Provisioned", + "approvalId": null, + "scheduleInfo": { + "startDateTime": "2020-09-09T21:31:27.91Z", + "expiration": { + "type": "AfterDuration", + "endDateTime": null, + "duration": "P365D" + } + }, + "ticketInfo": { + "ticketNumber": null, + "ticketSystem": null + }, + "justification": null, + "requestorId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "createdOn": "2020-09-09T21:32:27.91Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "64caffb6-55c0-4deb-a585-68e948ea1ad6", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilityScheduleRequests/64caffb6-55c0-4deb-a585-68e948ea1ad6", + "type": "Microsoft.Authorization/RoleEligibilityScheduleRequests" + } + } + } +} diff --git a/specification/authorization/resource-manager/readme.md b/specification/authorization/resource-manager/readme.md index b7c24d4a3136..58d6c1637ddf 100644 --- a/specification/authorization/resource-manager/readme.md +++ b/specification/authorization/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the Authorization API. ``` yaml openapi-type: arm -tag: package-2024-02-01-preview +tag: package-2024-09-01-preview ``` ### Suppression @@ -93,6 +93,31 @@ directive: reason: common-types doesn't need to reference api version. ``` +### Tag: package-2024-09-01-preview + +These settings apply only when `--tag=package-2024-09-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-09-01-preview' +input-file: + - Microsoft.Authorization/stable/2015-07-01/authorization-ClassicAdminCalls.json + - Microsoft.Authorization/stable/2015-07-01/authorization-ElevateAccessCalls.json + - Microsoft.Authorization/stable/2022-04-01/authorization-DenyAssignmentCalls.json + - Microsoft.Authorization/stable/2022-04-01/authorization-ProviderOperationsCalls.json + - Microsoft.Authorization/stable/2022-04-01/authorization-RoleAssignmentsCalls.json + - Microsoft.Authorization/preview/2022-05-01-preview/authorization-RoleDefinitionsCalls.json + - Microsoft.Authorization/preview/2024-09-01-preview/common-types.json + - Microsoft.Authorization/preview/2021-12-01-preview/authorization-AccessReviewCalls.json + - Microsoft.Authorization/preview/2024-09-01-preview/EligibleChildResources.json + - Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentSchedule.json + - Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentScheduleInstance.json + - Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentScheduleRequest.json + - Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilitySchedule.json + - Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilityScheduleInstance.json + - Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilityScheduleRequest.json + - Microsoft.Authorization/preview/2024-09-01-preview/RoleManagementPolicy.json + - Microsoft.Authorization/preview/2024-09-01-preview/RoleManagementPolicyAssignment.json + - Microsoft.Authorization/preview/2022-08-01-preview/RoleManagementAlerts.json +``` ### Tag: package-2024-02-01-preview From aeb2e051cce9362ff65cd6267176db545817ccdc Mon Sep 17 00:00:00 2001 From: Almas Khan <162407742+almasak@users.noreply.github.com> Date: Fri, 4 Oct 2024 12:19:24 +0530 Subject: [PATCH 41/47] Onboard Liftr Neon Postgres service (#30806) * Onboard Liftr Neon Postgres service * [Fix] tsp compile error --- .../LiftrBase.Data/main.tsp | 40 + .../LiftrBase/main.tsp | 157 ++++ .../Neon.Postgres.Management/README.md | 28 + .../Operations_List_MaximumSet_Gen.json | 28 + ...zations_CreateOrUpdate_MaximumSet_Gen.json | 184 ++++ .../Organizations_Delete_MaximumSet_Gen.json | 18 + .../Organizations_Get_MaximumSet_Gen.json | 73 ++ ...ns_ListByResourceGroup_MaximumSet_Gen.json | 77 ++ ...ons_ListBySubscription_MaximumSet_Gen.json | 76 ++ .../Organizations_Update_MaximumSet_Gen.json | 112 +++ .../Neon.Postgres.Management/main.tsp | 53 ++ .../Neon.Postgres.Management/tspconfig.yaml | 12 + .../Operations_List_MaximumSet_Gen.json | 28 + ...zations_CreateOrUpdate_MaximumSet_Gen.json | 184 ++++ .../Organizations_Delete_MaximumSet_Gen.json | 18 + .../Organizations_Get_MaximumSet_Gen.json | 73 ++ ...ns_ListByResourceGroup_MaximumSet_Gen.json | 77 ++ ...ons_ListBySubscription_MaximumSet_Gen.json | 76 ++ .../Organizations_Update_MaximumSet_Gen.json | 112 +++ .../preview/2024-08-01-preview/neon.json | 844 ++++++++++++++++++ .../liftrneon/resource-manager/readme.md | 40 + 21 files changed, 2310 insertions(+) create mode 100644 specification/liftrneon/Neon.Postgres.Management/LiftrBase.Data/main.tsp create mode 100644 specification/liftrneon/Neon.Postgres.Management/LiftrBase/main.tsp create mode 100644 specification/liftrneon/Neon.Postgres.Management/README.md create mode 100644 specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Operations_List_MaximumSet_Gen.json create mode 100644 specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_Delete_MaximumSet_Gen.json create mode 100644 specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_Get_MaximumSet_Gen.json create mode 100644 specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_Update_MaximumSet_Gen.json create mode 100644 specification/liftrneon/Neon.Postgres.Management/main.tsp create mode 100644 specification/liftrneon/Neon.Postgres.Management/tspconfig.yaml create mode 100644 specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Operations_List_MaximumSet_Gen.json create mode 100644 specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_Delete_MaximumSet_Gen.json create mode 100644 specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_Get_MaximumSet_Gen.json create mode 100644 specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_Update_MaximumSet_Gen.json create mode 100644 specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/neon.json create mode 100644 specification/liftrneon/resource-manager/readme.md diff --git a/specification/liftrneon/Neon.Postgres.Management/LiftrBase.Data/main.tsp b/specification/liftrneon/Neon.Postgres.Management/LiftrBase.Data/main.tsp new file mode 100644 index 000000000000..940b56869be5 --- /dev/null +++ b/specification/liftrneon/Neon.Postgres.Management/LiftrBase.Data/main.tsp @@ -0,0 +1,40 @@ +import "../LiftrBase/main.tsp"; + +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-resource-manager"; + +using Azure.ResourceManager; +using TypeSpec.Versioning; +using LiftrBase; + +@versioned(LiftrBase.Data.Versions) +namespace LiftrBase.Data; + +@doc("Supported versions for LiftrBase.Data resource model") +enum Versions { + @doc("Dependent on Azure.ResourceManager.Versions.v1_0_Preview_1 and LiftrBase.Versions.v1_preview") + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(LiftrBase.Versions.v1_preview) + v1_preview: "2024-08-01-preview", +} + +@doc("Properties specific to Data Organization resource") +model OrganizationProperties is BaseResourceProperties { + @doc("Organization properties") + partnerOrganizationProperties?: PartnerOrganizationProperties; +} + +@doc("Properties specific to Partner's organization") +model PartnerOrganizationProperties { + @doc("Organization Id in partner's system") + organizationId?: string; + + @doc("Organization name in partner's system") + @pattern("^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$") + @minLength(1) + @maxLength(50) + organizationName: string; + + @doc("Single Sign On properties for the organization") + singleSignOnProperties?: SingleSignOnProperties; +} diff --git a/specification/liftrneon/Neon.Postgres.Management/LiftrBase/main.tsp b/specification/liftrneon/Neon.Postgres.Management/LiftrBase/main.tsp new file mode 100644 index 000000000000..afbeebb94191 --- /dev/null +++ b/specification/liftrneon/Neon.Postgres.Management/LiftrBase/main.tsp @@ -0,0 +1,157 @@ +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/versioning"; + +using Azure.ResourceManager; +using TypeSpec.Versioning; + +@versioned(LiftrBase.Versions) +namespace LiftrBase; + +@doc("Supported versions for LiftrBase resource model") +enum Versions { + @doc("Dependent on Azure.ResourceManager.Versions.v1_0_Preview_1") + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + v1_preview: "2024-08-01-preview", +} + +@doc("Marketplace subscription status of a resource.") +union MarketplaceSubscriptionStatus { + string, + + @doc("Purchased but not yet activated") + PendingFulfillmentStart: "PendingFulfillmentStart", + + @doc("Marketplace subscription is activated") + Subscribed: "Subscribed", + + @doc("This state indicates that a customer's payment for the Marketplace service was not received") + Suspended: "Suspended", + + @doc("Customer has cancelled the subscription") + Unsubscribed: "Unsubscribed", +} + +@doc("A string that represents a URI.") +scalar Uri extends string; + +@doc("Marketplace details for an organization") +model MarketplaceDetails { + @doc("SaaS subscription id for the the marketplace offer") + subscriptionId?: string; + + @doc("Marketplace subscription status") + subscriptionStatus?: MarketplaceSubscriptionStatus; + + @doc("Offer details for the marketplace that is selected by the user") + offerDetails: OfferDetails; +} + +@doc("Offer details for the marketplace that is selected by the user") +model OfferDetails { + @doc("Publisher Id for the marketplace offer") + publisherId: string; + + @doc("Offer Id for the marketplace offer") + offerId: string; + + @doc("Plan Id for the marketplace offer") + planId: string; + + @doc("Plan Name for the marketplace offer") + planName?: string; + + @doc("Term Name for the marketplace offer") + termUnit?: string; + + @doc("Term Id for the marketplace offer") + termId?: string; +} + +@doc("Reusable representation of an email address.") +@pattern("^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$") +scalar email extends string; + +@doc("User details for an organization") +model UserDetails { + @doc("First name of the user") + firstName?: string; + + @doc("Last name of the user") + lastName?: string; + + @doc("Email address of the user") + emailAddress?: email; + + @doc("User's principal name") + upn?: string; + + @doc("User's phone number") + phoneNumber?: string; +} + +@doc("Company details for an organization") +model CompanyDetails { + @doc("Company name") + companyName?: string; + + @doc("Country name of the company") + country?: string; + + @doc("Office address of the company") + officeAddress?: string; + + @doc("Business phone number of the company") + businessPhone?: string; + + @doc("Domain of the user") + domain?: string; + + @doc("Number of employees in the company") + numberOfEmployees?: int64; +} + +@doc("Base resource properties that can be extended for arm resources.") +model BaseResourceProperties { + @doc("Marketplace details of the resource.") + @visibility("create", "read") + marketplaceDetails: MarketplaceDetails; + + @doc("Details of the user.") + userDetails: UserDetails; + + @doc("Details of the company.") + companyDetails: CompanyDetails; + + @doc("Provisioning state of the resource.") + @visibility("read") + provisioningState?: ResourceProvisioningState; +} + +@doc("Properties specific to Single Sign On Resource") +model SingleSignOnProperties { + @doc("State of the Single Sign On for the organization") + singleSignOnState?: SingleSignOnStates; + + @doc("AAD enterprise application Id used to setup SSO") + enterpriseAppId?: string; + + @doc("URL for SSO to be used by the partner to redirect the user to their system") + singleSignOnUrl?: Uri; + + @doc("List of AAD domains fetched from Microsoft Graph for user.") + aadDomains?: string[]; +} + +@doc("Various states of the SSO resource") +union SingleSignOnStates { + string, + + @doc("Initial state of the SSO resource") + Initial: "Initial", + + @doc("SSO is enabled for the organization") + Enable: "Enable", + + @doc("SSO is disabled for the organization") + Disable: "Disable", +} diff --git a/specification/liftrneon/Neon.Postgres.Management/README.md b/specification/liftrneon/Neon.Postgres.Management/README.md new file mode 100644 index 000000000000..1888f2f6db26 --- /dev/null +++ b/specification/liftrneon/Neon.Postgres.Management/README.md @@ -0,0 +1,28 @@ +# Neon Postgres service typespec project + +## Getting started + +- environment setup: https://microsoft.github.io/typespec/introduction/installation + +## Generate Neon swagger + +## NPM registry authentication + +We have to use the Liftr Feed Service for NPM to fetch the typespec dependencies. +The `.npmrc` file configures the folder accordingly. + +in development, you can tell npm to use the standard public registry by specifying it: + +`npm install --registry https://registry.npmjs.org` + +then: + +`tsp compile .` + +## Development + +Always edit `tsp` files, and generate swagger, never edit the swagger directly. + +For generating examples use the following command: + +`oav generate-examples neon.json` diff --git a/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Operations_List_MaximumSet_Gen.json b/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..0ed2a97f35d4 --- /dev/null +++ b/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ekvuojrpbuyogrikfuzyghio", + "isDataAction": true, + "display": { + "provider": "lvppuskqcdcoejwuvsqrloczvnouy", + "resource": "rvvd", + "operation": "odjjqnodcgszczpsdrhrpwmqssrybr", + "description": "bwmstukaiaoisiu" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://contoso.com/nextlink" + } + } + } +} diff --git a/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_CreateOrUpdate_MaximumSet_Gen.json b/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..b73e24223705 --- /dev/null +++ b/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,184 @@ +{ + "title": "Organizations_CreateOrUpdate", + "operationId": "Organizations_CreateOrUpdate", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "1178323D-8270-4757-B639-D528B6266487", + "resourceGroupName": "rgneon", + "organizationName": "XB-.:", + "resource": { + "properties": { + "marketplaceDetails": { + "subscriptionId": "yxmkfivp", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "hporaxnopmolttlnkbarw", + "offerId": "bunyeeupoedueofwrzej", + "planId": "nlbfiwtslenfwek", + "planName": "ljbmgpkfqklaufacbpml", + "termUnit": "qbcq", + "termId": "aedlchikwqckuploswthvshe" + } + }, + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "partnerOrganizationProperties": { + "organizationId": "nrhvoqzulowcunhmvwfgjcaibvwcl", + "organizationName": "2__.-", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key2099": "omjjymaqtrqzksxszhzgyl" + }, + "location": "upxxgikyqrbnv" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "marketplaceDetails": { + "subscriptionId": "yxmkfivp", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "hporaxnopmolttlnkbarw", + "offerId": "bunyeeupoedueofwrzej", + "planId": "nlbfiwtslenfwek", + "planName": "ljbmgpkfqklaufacbpml", + "termUnit": "qbcq", + "termId": "aedlchikwqckuploswthvshe" + } + }, + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "nrhvoqzulowcunhmvwfgjcaibvwcl", + "organizationName": "2__.-", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key2099": "omjjymaqtrqzksxszhzgyl" + }, + "location": "upxxgikyqrbnv", + "id": "/subscriptions/1178323D-8270-4757-B639-D528B6266487/resourceGroups/rgneon/providers/Microsoft.Neon/organizations/2__.-", + "name": "grhdqtqnkqmu", + "type": "gapeymltyvlqlvpgdgfxidkkd", + "systemData": { + "createdBy": "qfhekdgpvdtqcohjhvlyhzd", + "createdByType": "User", + "createdAt": "2024-07-30T15:12:24.902Z", + "lastModifiedBy": "dqsjroejrtucfjyqcoonpdopfaa", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-30T15:12:24.902Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "marketplaceDetails": { + "subscriptionId": "yxmkfivp", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "hporaxnopmolttlnkbarw", + "offerId": "bunyeeupoedueofwrzej", + "planId": "nlbfiwtslenfwek", + "planName": "ljbmgpkfqklaufacbpml", + "termUnit": "qbcq", + "termId": "aedlchikwqckuploswthvshe" + } + }, + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "nrhvoqzulowcunhmvwfgjcaibvwcl", + "organizationName": "2__.-", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key2099": "omjjymaqtrqzksxszhzgyl" + }, + "location": "upxxgikyqrbnv", + "id": "/subscriptions/1178323D-8270-4757-B639-D528B6266487/resourceGroups/rgneon/providers/Microsoft.Neon/organizations/2__.-", + "name": "grhdqtqnkqmu", + "type": "gapeymltyvlqlvpgdgfxidkkd", + "systemData": { + "createdBy": "qfhekdgpvdtqcohjhvlyhzd", + "createdByType": "User", + "createdAt": "2024-07-30T15:12:24.902Z", + "lastModifiedBy": "dqsjroejrtucfjyqcoonpdopfaa", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-30T15:12:24.902Z" + } + } + } + } +} diff --git a/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_Delete_MaximumSet_Gen.json b/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..d3574b959b03 --- /dev/null +++ b/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "Organizations_Delete", + "operationId": "Organizations_Delete", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "1178323D-8270-4757-B639-D528B6266487", + "resourceGroupName": "rgneon", + "organizationName": "2_3" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_Get_MaximumSet_Gen.json b/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..4c4eba3507ee --- /dev/null +++ b/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_Get_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "title": "Organizations_Get", + "operationId": "Organizations_Get", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "1178323D-8270-4757-B639-D528B6266487", + "resourceGroupName": "rgneon", + "organizationName": "5" + }, + "responses": { + "200": { + "body": { + "properties": { + "marketplaceDetails": { + "subscriptionId": "yxmkfivp", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "hporaxnopmolttlnkbarw", + "offerId": "bunyeeupoedueofwrzej", + "planId": "nlbfiwtslenfwek", + "planName": "ljbmgpkfqklaufacbpml", + "termUnit": "qbcq", + "termId": "aedlchikwqckuploswthvshe" + } + }, + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "nrhvoqzulowcunhmvwfgjcaibvwcl", + "organizationName": "2__.-", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key2099": "omjjymaqtrqzksxszhzgyl" + }, + "location": "upxxgikyqrbnv", + "id": "/subscriptions/1178323D-8270-4757-B639-D528B6266487/resourceGroups/rgneon/providers/Microsoft.Neon/organizations/2__.-", + "name": "grhdqtqnkqmu", + "type": "gapeymltyvlqlvpgdgfxidkkd", + "systemData": { + "createdBy": "qfhekdgpvdtqcohjhvlyhzd", + "createdByType": "User", + "createdAt": "2024-07-30T15:12:24.902Z", + "lastModifiedBy": "dqsjroejrtucfjyqcoonpdopfaa", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-30T15:12:24.902Z" + } + } + } + } +} diff --git a/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_ListByResourceGroup_MaximumSet_Gen.json b/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..3dfabedecd89 --- /dev/null +++ b/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,77 @@ +{ + "title": "Organizations_ListByResourceGroup", + "operationId": "Organizations_ListByResourceGroup", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "1178323D-8270-4757-B639-D528B6266487", + "resourceGroupName": "rgneon" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "marketplaceDetails": { + "subscriptionId": "yxmkfivp", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "hporaxnopmolttlnkbarw", + "offerId": "bunyeeupoedueofwrzej", + "planId": "nlbfiwtslenfwek", + "planName": "ljbmgpkfqklaufacbpml", + "termUnit": "qbcq", + "termId": "aedlchikwqckuploswthvshe" + } + }, + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "nrhvoqzulowcunhmvwfgjcaibvwcl", + "organizationName": "2__.-", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key2099": "omjjymaqtrqzksxszhzgyl" + }, + "location": "upxxgikyqrbnv", + "id": "/subscriptions/1178323D-8270-4757-B639-D528B6266487/resourceGroups/rgneon/providers/Microsoft.Neon/organizations/2__.-", + "name": "grhdqtqnkqmu", + "type": "gapeymltyvlqlvpgdgfxidkkd", + "systemData": { + "createdBy": "qfhekdgpvdtqcohjhvlyhzd", + "createdByType": "User", + "createdAt": "2024-07-30T15:12:24.902Z", + "lastModifiedBy": "dqsjroejrtucfjyqcoonpdopfaa", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-30T15:12:24.902Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_ListBySubscription_MaximumSet_Gen.json b/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..c1d5f8609be1 --- /dev/null +++ b/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,76 @@ +{ + "title": "Organizations_ListBySubscription", + "operationId": "Organizations_ListBySubscription", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "1178323D-8270-4757-B639-D528B6266487" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "marketplaceDetails": { + "subscriptionId": "yxmkfivp", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "hporaxnopmolttlnkbarw", + "offerId": "bunyeeupoedueofwrzej", + "planId": "nlbfiwtslenfwek", + "planName": "ljbmgpkfqklaufacbpml", + "termUnit": "qbcq", + "termId": "aedlchikwqckuploswthvshe" + } + }, + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "nrhvoqzulowcunhmvwfgjcaibvwcl", + "organizationName": "2__.-", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key2099": "omjjymaqtrqzksxszhzgyl" + }, + "location": "upxxgikyqrbnv", + "id": "/subscriptions/1178323D-8270-4757-B639-D528B6266487/resourceGroups/rgneon/providers/Microsoft.Neon/organizations/2__.-", + "name": "grhdqtqnkqmu", + "type": "gapeymltyvlqlvpgdgfxidkkd", + "systemData": { + "createdBy": "qfhekdgpvdtqcohjhvlyhzd", + "createdByType": "User", + "createdAt": "2024-07-30T15:12:24.902Z", + "lastModifiedBy": "dqsjroejrtucfjyqcoonpdopfaa", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-30T15:12:24.902Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_Update_MaximumSet_Gen.json b/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..aa6b1e166e41 --- /dev/null +++ b/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_Update_MaximumSet_Gen.json @@ -0,0 +1,112 @@ +{ + "title": "Organizations_Update", + "operationId": "Organizations_Update", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "1178323D-8270-4757-B639-D528B6266487", + "resourceGroupName": "rgneon", + "organizationName": "eRY-J_:", + "properties": { + "properties": { + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "partnerOrganizationProperties": { + "organizationId": "njyoqflcmfwzfsqe", + "organizationName": "J:.._3P", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key8990": "wuvaontoqyttxtikvvahdegcfdfkz" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "marketplaceDetails": { + "subscriptionId": "yxmkfivp", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "hporaxnopmolttlnkbarw", + "offerId": "bunyeeupoedueofwrzej", + "planId": "nlbfiwtslenfwek", + "planName": "ljbmgpkfqklaufacbpml", + "termUnit": "qbcq", + "termId": "aedlchikwqckuploswthvshe" + } + }, + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "njyoqflcmfwzfsqe", + "organizationName": "J:.._3P", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key2099": "omjjymaqtrqzksxszhzgyl" + }, + "location": "upxxgikyqrbnv", + "id": "/subscriptions/1178323D-8270-4757-B639-D528B6266487/resourceGroups/rgneon/providers/Microsoft.Neon/organizations/eRY-J_:", + "name": "grhdqtqnkqmu", + "type": "gapeymltyvlqlvpgdgfxidkkd", + "systemData": { + "createdBy": "qfhekdgpvdtqcohjhvlyhzd", + "createdByType": "User", + "createdAt": "2024-07-30T15:12:24.902Z", + "lastModifiedBy": "dqsjroejrtucfjyqcoonpdopfaa", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-30T15:12:24.902Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/liftrneon/Neon.Postgres.Management/main.tsp b/specification/liftrneon/Neon.Postgres.Management/main.tsp new file mode 100644 index 000000000000..f61718301480 --- /dev/null +++ b/specification/liftrneon/Neon.Postgres.Management/main.tsp @@ -0,0 +1,53 @@ +import "./LiftrBase.Data/main.tsp"; + +import "@azure-tools/typespec-autorest"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Versioning; +using LiftrBase.Data; + +@armProviderNamespace +@service({ + title: "Neon.Postgres", + description: "Azure Native Services Integration for Neon Postgres", +}) +@versioned(Neon.Postgres.Versions) +@armCommonTypesVersion("v5") +namespace Neon.Postgres; + +@doc("Supported API versions for the Neon.Postgres resource provider.") +enum Versions { + @doc("Dependent on Azure.ResourceManager.Versions.v1_0_Preview_1, LiftrBase.Versions.v1_preview, LiftrBase.Data.Versions.v1_preview") + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(LiftrBase.Versions.v1_preview) + @useDependency(LiftrBase.Data.Versions.v1_preview) + v1_preview: "2024-08-01-preview", +} + +interface Operations extends Azure.ResourceManager.Operations {} + +@doc("Organization Resource by Neon") +model OrganizationResource is TrackedResource<OrganizationProperties> { + @key("organizationName") + @pattern("^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$") + @segment("organizations") + @minLength(1) + @maxLength(50) + @doc("Name of the Neon Organizations resource") + @path + name: string; +} + +@armResourceOperations +interface Organizations { + get is ArmResourceRead<OrganizationResource>; + createOrUpdate is ArmResourceCreateOrUpdateAsync<OrganizationResource>; + update is ArmResourcePatchAsync<OrganizationResource, OrganizationProperties>; + delete is ArmResourceDeleteWithoutOkAsync<OrganizationResource>; + listByResourceGroup is ArmResourceListByParent<OrganizationResource>; + listBySubscription is ArmListBySubscription<OrganizationResource>; +} diff --git a/specification/liftrneon/Neon.Postgres.Management/tspconfig.yaml b/specification/liftrneon/Neon.Postgres.Management/tspconfig.yaml new file mode 100644 index 000000000000..a2065d563052 --- /dev/null +++ b/specification/liftrneon/Neon.Postgres.Management/tspconfig.yaml @@ -0,0 +1,12 @@ +emit: + - "@azure-tools/typespec-autorest" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" +options: + "@azure-tools/typespec-autorest": + use-read-only-status-schema: true + emitter-output-dir: "{project-root}/.." + azure-resource-provider-folder: "resource-manager" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/neon.json" + examples-dir: "{project-root}/examples" diff --git a/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Operations_List_MaximumSet_Gen.json b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..0ed2a97f35d4 --- /dev/null +++ b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ekvuojrpbuyogrikfuzyghio", + "isDataAction": true, + "display": { + "provider": "lvppuskqcdcoejwuvsqrloczvnouy", + "resource": "rvvd", + "operation": "odjjqnodcgszczpsdrhrpwmqssrybr", + "description": "bwmstukaiaoisiu" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://contoso.com/nextlink" + } + } + } +} diff --git a/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_CreateOrUpdate_MaximumSet_Gen.json b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..b73e24223705 --- /dev/null +++ b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,184 @@ +{ + "title": "Organizations_CreateOrUpdate", + "operationId": "Organizations_CreateOrUpdate", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "1178323D-8270-4757-B639-D528B6266487", + "resourceGroupName": "rgneon", + "organizationName": "XB-.:", + "resource": { + "properties": { + "marketplaceDetails": { + "subscriptionId": "yxmkfivp", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "hporaxnopmolttlnkbarw", + "offerId": "bunyeeupoedueofwrzej", + "planId": "nlbfiwtslenfwek", + "planName": "ljbmgpkfqklaufacbpml", + "termUnit": "qbcq", + "termId": "aedlchikwqckuploswthvshe" + } + }, + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "partnerOrganizationProperties": { + "organizationId": "nrhvoqzulowcunhmvwfgjcaibvwcl", + "organizationName": "2__.-", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key2099": "omjjymaqtrqzksxszhzgyl" + }, + "location": "upxxgikyqrbnv" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "marketplaceDetails": { + "subscriptionId": "yxmkfivp", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "hporaxnopmolttlnkbarw", + "offerId": "bunyeeupoedueofwrzej", + "planId": "nlbfiwtslenfwek", + "planName": "ljbmgpkfqklaufacbpml", + "termUnit": "qbcq", + "termId": "aedlchikwqckuploswthvshe" + } + }, + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "nrhvoqzulowcunhmvwfgjcaibvwcl", + "organizationName": "2__.-", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key2099": "omjjymaqtrqzksxszhzgyl" + }, + "location": "upxxgikyqrbnv", + "id": "/subscriptions/1178323D-8270-4757-B639-D528B6266487/resourceGroups/rgneon/providers/Microsoft.Neon/organizations/2__.-", + "name": "grhdqtqnkqmu", + "type": "gapeymltyvlqlvpgdgfxidkkd", + "systemData": { + "createdBy": "qfhekdgpvdtqcohjhvlyhzd", + "createdByType": "User", + "createdAt": "2024-07-30T15:12:24.902Z", + "lastModifiedBy": "dqsjroejrtucfjyqcoonpdopfaa", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-30T15:12:24.902Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "marketplaceDetails": { + "subscriptionId": "yxmkfivp", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "hporaxnopmolttlnkbarw", + "offerId": "bunyeeupoedueofwrzej", + "planId": "nlbfiwtslenfwek", + "planName": "ljbmgpkfqklaufacbpml", + "termUnit": "qbcq", + "termId": "aedlchikwqckuploswthvshe" + } + }, + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "nrhvoqzulowcunhmvwfgjcaibvwcl", + "organizationName": "2__.-", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key2099": "omjjymaqtrqzksxszhzgyl" + }, + "location": "upxxgikyqrbnv", + "id": "/subscriptions/1178323D-8270-4757-B639-D528B6266487/resourceGroups/rgneon/providers/Microsoft.Neon/organizations/2__.-", + "name": "grhdqtqnkqmu", + "type": "gapeymltyvlqlvpgdgfxidkkd", + "systemData": { + "createdBy": "qfhekdgpvdtqcohjhvlyhzd", + "createdByType": "User", + "createdAt": "2024-07-30T15:12:24.902Z", + "lastModifiedBy": "dqsjroejrtucfjyqcoonpdopfaa", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-30T15:12:24.902Z" + } + } + } + } +} diff --git a/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_Delete_MaximumSet_Gen.json b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..d3574b959b03 --- /dev/null +++ b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "Organizations_Delete", + "operationId": "Organizations_Delete", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "1178323D-8270-4757-B639-D528B6266487", + "resourceGroupName": "rgneon", + "organizationName": "2_3" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_Get_MaximumSet_Gen.json b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..4c4eba3507ee --- /dev/null +++ b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_Get_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "title": "Organizations_Get", + "operationId": "Organizations_Get", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "1178323D-8270-4757-B639-D528B6266487", + "resourceGroupName": "rgneon", + "organizationName": "5" + }, + "responses": { + "200": { + "body": { + "properties": { + "marketplaceDetails": { + "subscriptionId": "yxmkfivp", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "hporaxnopmolttlnkbarw", + "offerId": "bunyeeupoedueofwrzej", + "planId": "nlbfiwtslenfwek", + "planName": "ljbmgpkfqklaufacbpml", + "termUnit": "qbcq", + "termId": "aedlchikwqckuploswthvshe" + } + }, + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "nrhvoqzulowcunhmvwfgjcaibvwcl", + "organizationName": "2__.-", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key2099": "omjjymaqtrqzksxszhzgyl" + }, + "location": "upxxgikyqrbnv", + "id": "/subscriptions/1178323D-8270-4757-B639-D528B6266487/resourceGroups/rgneon/providers/Microsoft.Neon/organizations/2__.-", + "name": "grhdqtqnkqmu", + "type": "gapeymltyvlqlvpgdgfxidkkd", + "systemData": { + "createdBy": "qfhekdgpvdtqcohjhvlyhzd", + "createdByType": "User", + "createdAt": "2024-07-30T15:12:24.902Z", + "lastModifiedBy": "dqsjroejrtucfjyqcoonpdopfaa", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-30T15:12:24.902Z" + } + } + } + } +} diff --git a/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_ListByResourceGroup_MaximumSet_Gen.json b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..3dfabedecd89 --- /dev/null +++ b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,77 @@ +{ + "title": "Organizations_ListByResourceGroup", + "operationId": "Organizations_ListByResourceGroup", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "1178323D-8270-4757-B639-D528B6266487", + "resourceGroupName": "rgneon" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "marketplaceDetails": { + "subscriptionId": "yxmkfivp", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "hporaxnopmolttlnkbarw", + "offerId": "bunyeeupoedueofwrzej", + "planId": "nlbfiwtslenfwek", + "planName": "ljbmgpkfqklaufacbpml", + "termUnit": "qbcq", + "termId": "aedlchikwqckuploswthvshe" + } + }, + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "nrhvoqzulowcunhmvwfgjcaibvwcl", + "organizationName": "2__.-", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key2099": "omjjymaqtrqzksxszhzgyl" + }, + "location": "upxxgikyqrbnv", + "id": "/subscriptions/1178323D-8270-4757-B639-D528B6266487/resourceGroups/rgneon/providers/Microsoft.Neon/organizations/2__.-", + "name": "grhdqtqnkqmu", + "type": "gapeymltyvlqlvpgdgfxidkkd", + "systemData": { + "createdBy": "qfhekdgpvdtqcohjhvlyhzd", + "createdByType": "User", + "createdAt": "2024-07-30T15:12:24.902Z", + "lastModifiedBy": "dqsjroejrtucfjyqcoonpdopfaa", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-30T15:12:24.902Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_ListBySubscription_MaximumSet_Gen.json b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..c1d5f8609be1 --- /dev/null +++ b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,76 @@ +{ + "title": "Organizations_ListBySubscription", + "operationId": "Organizations_ListBySubscription", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "1178323D-8270-4757-B639-D528B6266487" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "marketplaceDetails": { + "subscriptionId": "yxmkfivp", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "hporaxnopmolttlnkbarw", + "offerId": "bunyeeupoedueofwrzej", + "planId": "nlbfiwtslenfwek", + "planName": "ljbmgpkfqklaufacbpml", + "termUnit": "qbcq", + "termId": "aedlchikwqckuploswthvshe" + } + }, + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "nrhvoqzulowcunhmvwfgjcaibvwcl", + "organizationName": "2__.-", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key2099": "omjjymaqtrqzksxszhzgyl" + }, + "location": "upxxgikyqrbnv", + "id": "/subscriptions/1178323D-8270-4757-B639-D528B6266487/resourceGroups/rgneon/providers/Microsoft.Neon/organizations/2__.-", + "name": "grhdqtqnkqmu", + "type": "gapeymltyvlqlvpgdgfxidkkd", + "systemData": { + "createdBy": "qfhekdgpvdtqcohjhvlyhzd", + "createdByType": "User", + "createdAt": "2024-07-30T15:12:24.902Z", + "lastModifiedBy": "dqsjroejrtucfjyqcoonpdopfaa", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-30T15:12:24.902Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_Update_MaximumSet_Gen.json b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..aa6b1e166e41 --- /dev/null +++ b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_Update_MaximumSet_Gen.json @@ -0,0 +1,112 @@ +{ + "title": "Organizations_Update", + "operationId": "Organizations_Update", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "1178323D-8270-4757-B639-D528B6266487", + "resourceGroupName": "rgneon", + "organizationName": "eRY-J_:", + "properties": { + "properties": { + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "partnerOrganizationProperties": { + "organizationId": "njyoqflcmfwzfsqe", + "organizationName": "J:.._3P", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key8990": "wuvaontoqyttxtikvvahdegcfdfkz" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "marketplaceDetails": { + "subscriptionId": "yxmkfivp", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "hporaxnopmolttlnkbarw", + "offerId": "bunyeeupoedueofwrzej", + "planId": "nlbfiwtslenfwek", + "planName": "ljbmgpkfqklaufacbpml", + "termUnit": "qbcq", + "termId": "aedlchikwqckuploswthvshe" + } + }, + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "njyoqflcmfwzfsqe", + "organizationName": "J:.._3P", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key2099": "omjjymaqtrqzksxszhzgyl" + }, + "location": "upxxgikyqrbnv", + "id": "/subscriptions/1178323D-8270-4757-B639-D528B6266487/resourceGroups/rgneon/providers/Microsoft.Neon/organizations/eRY-J_:", + "name": "grhdqtqnkqmu", + "type": "gapeymltyvlqlvpgdgfxidkkd", + "systemData": { + "createdBy": "qfhekdgpvdtqcohjhvlyhzd", + "createdByType": "User", + "createdAt": "2024-07-30T15:12:24.902Z", + "lastModifiedBy": "dqsjroejrtucfjyqcoonpdopfaa", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-30T15:12:24.902Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/neon.json b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/neon.json new file mode 100644 index 000000000000..7369ccfb67ee --- /dev/null +++ b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/neon.json @@ -0,0 +1,844 @@ +{ + "swagger": "2.0", + "info": { + "title": "Neon.Postgres", + "version": "2024-08-01-preview", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "Organizations" + } + ], + "paths": { + "/providers/Neon.Postgres/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Neon.Postgres/organizations": { + "get": { + "operationId": "Organizations_ListBySubscription", + "tags": [ + "Organizations" + ], + "description": "List OrganizationResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OrganizationResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Organizations_ListBySubscription": { + "$ref": "./examples/Organizations_ListBySubscription_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations": { + "get": { + "operationId": "Organizations_ListByResourceGroup", + "tags": [ + "Organizations" + ], + "description": "List OrganizationResource resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OrganizationResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Organizations_ListByResourceGroup": { + "$ref": "./examples/Organizations_ListByResourceGroup_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}": { + "get": { + "operationId": "Organizations_Get", + "tags": [ + "Organizations" + ], + "description": "Get a OrganizationResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "organizationName", + "in": "path", + "description": "Name of the Neon Organizations resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OrganizationResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Organizations_Get": { + "$ref": "./examples/Organizations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "Organizations_CreateOrUpdate", + "tags": [ + "Organizations" + ], + "description": "Create a OrganizationResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "organizationName", + "in": "path", + "description": "Name of the Neon Organizations resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/OrganizationResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'OrganizationResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/OrganizationResource" + } + }, + "201": { + "description": "Resource 'OrganizationResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/OrganizationResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Organizations_CreateOrUpdate": { + "$ref": "./examples/Organizations_CreateOrUpdate_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Organizations_Update", + "tags": [ + "Organizations" + ], + "description": "Update a OrganizationResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "organizationName", + "in": "path", + "description": "Name of the Neon Organizations resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/OrganizationResourceUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OrganizationResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Organizations_Update": { + "$ref": "./examples/Organizations_Update_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Organizations_Delete", + "tags": [ + "Organizations" + ], + "description": "Delete a OrganizationResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "organizationName", + "in": "path", + "description": "Name of the Neon Organizations resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Organizations_Delete": { + "$ref": "./examples/Organizations_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "Azure.ResourceManager.CommonTypes.TrackedResourceUpdate": { + "type": "object", + "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ] + }, + "Azure.ResourceManager.ResourceProvisioningState": { + "type": "string", + "description": "The provisioning state of a resource type.", + "enum": [ + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ResourceProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + } + ] + }, + "readOnly": true + }, + "LiftrBase.CompanyDetails": { + "type": "object", + "description": "Company details for an organization", + "properties": { + "companyName": { + "type": "string", + "description": "Company name" + }, + "country": { + "type": "string", + "description": "Country name of the company" + }, + "officeAddress": { + "type": "string", + "description": "Office address of the company" + }, + "businessPhone": { + "type": "string", + "description": "Business phone number of the company" + }, + "domain": { + "type": "string", + "description": "Domain of the user" + }, + "numberOfEmployees": { + "type": "integer", + "format": "int64", + "description": "Number of employees in the company" + } + } + }, + "LiftrBase.Data.OrganizationProperties": { + "type": "object", + "description": "Properties specific to Data Organization resource", + "properties": { + "marketplaceDetails": { + "$ref": "#/definitions/LiftrBase.MarketplaceDetails", + "description": "Marketplace details of the resource.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "userDetails": { + "$ref": "#/definitions/LiftrBase.UserDetails", + "description": "Details of the user." + }, + "companyDetails": { + "$ref": "#/definitions/LiftrBase.CompanyDetails", + "description": "Details of the company." + }, + "provisioningState": { + "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "partnerOrganizationProperties": { + "$ref": "#/definitions/LiftrBase.Data.PartnerOrganizationProperties", + "description": "Organization properties" + } + }, + "required": [ + "marketplaceDetails", + "userDetails", + "companyDetails" + ] + }, + "LiftrBase.Data.OrganizationPropertiesUpdate": { + "type": "object", + "description": "Properties specific to Data Organization resource", + "properties": { + "userDetails": { + "$ref": "#/definitions/LiftrBase.UserDetails", + "description": "Details of the user." + }, + "companyDetails": { + "$ref": "#/definitions/LiftrBase.CompanyDetails", + "description": "Details of the company." + }, + "partnerOrganizationProperties": { + "$ref": "#/definitions/LiftrBase.Data.PartnerOrganizationPropertiesUpdate", + "description": "Organization properties" + } + } + }, + "LiftrBase.Data.PartnerOrganizationProperties": { + "type": "object", + "description": "Properties specific to Partner's organization", + "properties": { + "organizationId": { + "type": "string", + "description": "Organization Id in partner's system" + }, + "organizationName": { + "type": "string", + "description": "Organization name in partner's system", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$" + }, + "singleSignOnProperties": { + "$ref": "#/definitions/LiftrBase.SingleSignOnProperties", + "description": "Single Sign On properties for the organization" + } + }, + "required": [ + "organizationName" + ] + }, + "LiftrBase.Data.PartnerOrganizationPropertiesUpdate": { + "type": "object", + "description": "Properties specific to Partner's organization", + "properties": { + "organizationId": { + "type": "string", + "description": "Organization Id in partner's system" + }, + "organizationName": { + "type": "string", + "description": "Organization name in partner's system", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$" + }, + "singleSignOnProperties": { + "$ref": "#/definitions/LiftrBase.SingleSignOnProperties", + "description": "Single Sign On properties for the organization" + } + } + }, + "LiftrBase.MarketplaceDetails": { + "type": "object", + "description": "Marketplace details for an organization", + "properties": { + "subscriptionId": { + "type": "string", + "description": "SaaS subscription id for the the marketplace offer" + }, + "subscriptionStatus": { + "$ref": "#/definitions/LiftrBase.MarketplaceSubscriptionStatus", + "description": "Marketplace subscription status" + }, + "offerDetails": { + "$ref": "#/definitions/LiftrBase.OfferDetails", + "description": "Offer details for the marketplace that is selected by the user" + } + }, + "required": [ + "offerDetails" + ] + }, + "LiftrBase.MarketplaceSubscriptionStatus": { + "type": "string", + "description": "Marketplace subscription status of a resource.", + "enum": [ + "PendingFulfillmentStart", + "Subscribed", + "Suspended", + "Unsubscribed" + ], + "x-ms-enum": { + "name": "MarketplaceSubscriptionStatus", + "modelAsString": true, + "values": [ + { + "name": "PendingFulfillmentStart", + "value": "PendingFulfillmentStart", + "description": "Purchased but not yet activated" + }, + { + "name": "Subscribed", + "value": "Subscribed", + "description": "Marketplace subscription is activated" + }, + { + "name": "Suspended", + "value": "Suspended", + "description": "This state indicates that a customer's payment for the Marketplace service was not received" + }, + { + "name": "Unsubscribed", + "value": "Unsubscribed", + "description": "Customer has cancelled the subscription" + } + ] + } + }, + "LiftrBase.OfferDetails": { + "type": "object", + "description": "Offer details for the marketplace that is selected by the user", + "properties": { + "publisherId": { + "type": "string", + "description": "Publisher Id for the marketplace offer" + }, + "offerId": { + "type": "string", + "description": "Offer Id for the marketplace offer" + }, + "planId": { + "type": "string", + "description": "Plan Id for the marketplace offer" + }, + "planName": { + "type": "string", + "description": "Plan Name for the marketplace offer" + }, + "termUnit": { + "type": "string", + "description": "Term Name for the marketplace offer" + }, + "termId": { + "type": "string", + "description": "Term Id for the marketplace offer" + } + }, + "required": [ + "publisherId", + "offerId", + "planId" + ] + }, + "LiftrBase.SingleSignOnProperties": { + "type": "object", + "description": "Properties specific to Single Sign On Resource", + "properties": { + "singleSignOnState": { + "$ref": "#/definitions/LiftrBase.SingleSignOnStates", + "description": "State of the Single Sign On for the organization" + }, + "enterpriseAppId": { + "type": "string", + "description": "AAD enterprise application Id used to setup SSO" + }, + "singleSignOnUrl": { + "$ref": "#/definitions/LiftrBase.Uri", + "description": "URL for SSO to be used by the partner to redirect the user to their system" + }, + "aadDomains": { + "type": "array", + "description": "List of AAD domains fetched from Microsoft Graph for user.", + "items": { + "type": "string" + } + } + } + }, + "LiftrBase.SingleSignOnStates": { + "type": "string", + "description": "Various states of the SSO resource", + "enum": [ + "Initial", + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SingleSignOnStates", + "modelAsString": true, + "values": [ + { + "name": "Initial", + "value": "Initial", + "description": "Initial state of the SSO resource" + }, + { + "name": "Enable", + "value": "Enable", + "description": "SSO is enabled for the organization" + }, + { + "name": "Disable", + "value": "Disable", + "description": "SSO is disabled for the organization" + } + ] + } + }, + "LiftrBase.Uri": { + "type": "string", + "description": "A string that represents a URI." + }, + "LiftrBase.UserDetails": { + "type": "object", + "description": "User details for an organization", + "properties": { + "firstName": { + "type": "string", + "description": "First name of the user" + }, + "lastName": { + "type": "string", + "description": "Last name of the user" + }, + "emailAddress": { + "$ref": "#/definitions/LiftrBase.email", + "description": "Email address of the user" + }, + "upn": { + "type": "string", + "description": "User's principal name" + }, + "phoneNumber": { + "type": "string", + "description": "User's phone number" + } + } + }, + "LiftrBase.email": { + "type": "string", + "description": "Reusable representation of an email address.", + "pattern": "^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$" + }, + "OrganizationResource": { + "type": "object", + "description": "Organization Resource by Neon", + "properties": { + "properties": { + "$ref": "#/definitions/LiftrBase.Data.OrganizationProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "OrganizationResourceListResult": { + "type": "object", + "description": "The response of a OrganizationResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The OrganizationResource items on this page", + "items": { + "$ref": "#/definitions/OrganizationResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "OrganizationResourceUpdate": { + "type": "object", + "description": "Organization Resource by Neon", + "properties": { + "properties": { + "$ref": "#/definitions/LiftrBase.Data.OrganizationPropertiesUpdate", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.TrackedResourceUpdate" + } + ] + } + }, + "parameters": {} +} diff --git a/specification/liftrneon/resource-manager/readme.md b/specification/liftrneon/resource-manager/readme.md new file mode 100644 index 000000000000..0070928868c7 --- /dev/null +++ b/specification/liftrneon/resource-manager/readme.md @@ -0,0 +1,40 @@ +# Neon.Postgres RP + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for neon service. + +## Getting Started + +To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: + +> `autorest readme.md` + +To see additional help and options, run: + +> `autorest --help` + +For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. + +--- + +## Configuration + +### Basic Information + +These are the global settings for the neon service. + +```yaml +openapi-type: arm +openapi-subtype: rpaas +tag: package-2024-08-01-preview +``` + +### Tag: package-2024-08-01-preview + +These settings apply only when `--tag=package-2024-08-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-08-01-preview' +input-file: + - Neon.Postgres/preview/2024-08-01-preview/neon.json +``` From 99e9fcd0f7f00d64ed7bcf68a30af59aa7efc9f9 Mon Sep 17 00:00:00 2001 From: steve munk <33468793+stevemunk@users.noreply.github.com> Date: Fri, 4 Oct 2024 09:17:33 -0700 Subject: [PATCH 42/47] Changed 24 days to 24 hours. (#30856) --- .../maps/data-plane/Route/preview/1.0/route.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/maps/data-plane/Route/preview/1.0/route.json b/specification/maps/data-plane/Route/preview/1.0/route.json index 92ae9d2a3e68..848fab43bc18 100644 --- a/specification/maps/data-plane/Route/preview/1.0/route.json +++ b/specification/maps/data-plane/Route/preview/1.0/route.json @@ -887,7 +887,7 @@ "/route/matrix/{format}": { "post": { "summary": "Use to get a route matrix showing the travel time and distance for all possible pairs in a list of origins and destinations, using an asynchronous request.", - "description": "\n\nThe `Post Route Matrix` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) request. To make a synchronous (sync) request, see [Post Route Matrix Sync](/rest/api/maps/route/post-route-matrix-sync). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nPOST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **24** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", + "description": "\n\nThe `Post Route Matrix` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) request. To make a synchronous (sync) request, see [Post Route Matrix Sync](/rest/api/maps/route/post-route-matrix-sync). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nPOST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", "operationId": "Route_PostRouteMatrix", "x-ms-client-name": "RequestRouteMatrix", "x-ms-long-running-operation": true, @@ -993,7 +993,7 @@ }, "get": { "summary": "Use to get a route matrix showing the travel time and distance for all possible pairs in a list of origins and destinations.", - "description": "\n\nThe `Get Route Matrix` API is an HTTP `GET` request that computes the travel time and distance for all possible pairs in a list of origins and destinations. Unlike the [Get Route Directions](/rest/api/maps/route/get-route-directions) API, which provide detailed route instructions, this API focuses on efficiency by giving you the cost (travel time and distance) of routing from each origin to every destination. For more information, see [Best practices for Azure Maps Route service](/azure/azure-maps/how-to-use-best-practices-for-routing).\n\nFor every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nGET https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **24** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nGET https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix GET request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a GET request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", + "description": "\n\nThe `Get Route Matrix` API is an HTTP `GET` request that computes the travel time and distance for all possible pairs in a list of origins and destinations. Unlike the [Get Route Directions](/rest/api/maps/route/get-route-directions) API, which provide detailed route instructions, this API focuses on efficiency by giving you the cost (travel time and distance) of routing from each origin to every destination. For more information, see [Best practices for Azure Maps Route service](/azure/azure-maps/how-to-use-best-practices-for-routing).\n\nFor every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nGET https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nGET https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix GET request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a GET request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", "operationId": "Route_GetRouteMatrix", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -1034,7 +1034,7 @@ "/route/matrix/sync/{format}": { "post": { "summary": "Use to get a route matrix showing the travel time and distance for all possible pairs in a list of origins and destinations, using a synchronous request.", - "description": "\n\nThe `Post Route Matrix Sync` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using a single synchronous (sync) request. To make an asynchronous (async) request, see [Post Route Matrix](/rest/api/maps/route/post-route-matrix). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nPOST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **24** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", + "description": "\n\nThe `Post Route Matrix Sync` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using a single synchronous (sync) request. To make an asynchronous (async) request, see [Post Route Matrix](/rest/api/maps/route/post-route-matrix). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nPOST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", "operationId": "Route_PostRouteMatrixSync", "x-ms-client-name": "RequestRouteMatrixSync", "x-ms-examples": { @@ -1659,7 +1659,7 @@ "/route/directions/batch/{format}": { "post": { "summary": "Use to send a batch of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API in a single asynchronous request.", - "description": "\n\nThe `Post Route Directions Batch` API is an HTTP `POST` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single asynchronous request. You can call `Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. To call the `Post Route Directions Batch` API in a synchronous request, see [Post Route Directions Batch Sync](/rest/api/maps/route/post-route-directions-batch-sync).\n\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex route requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **700** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **24** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Route Directions Batch `POST` request to Azure Maps.\n```\nPOST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}\n```\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n```\nGET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key} \n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _route directions_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 3 _route directions_ queries:\n\n\n```json\n{\n \"batchItems\": [\n { \"query\": \"?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false\" },\n { \"query\": \"?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest\" },\n { \"query\": \"?query=48.923159,-122.557362:32.621279,-116.840362\" }\n ]\n}\n```\n\nA _route directions_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _route directions_ [URI parameters](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#uri-parameters). The string values in the _route directions_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **700** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n \n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 1,\n \"totalRequests\": 2\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\": {\n \"routes\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"legs\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"points\": [\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.34892\n },\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.3485\n },\n {\n \"latitude\": 47.62095,\n \"longitude\": -122.3476\n }\n ]\n }\n ],\n \"sections\": [\n {\n \"startPointIndex\": 0,\n \"endPointIndex\": 40,\n \"sectionType\": \"TRAVEL_MODE\",\n \"travelMode\": \"bicycle\"\n }\n ]\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "description": "\n\nThe `Post Route Directions Batch` API is an HTTP `POST` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single asynchronous request. You can call `Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. To call the `Post Route Directions Batch` API in a synchronous request, see [Post Route Directions Batch Sync](/rest/api/maps/route/post-route-directions-batch-sync).\n\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex route requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **700** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Route Directions Batch `POST` request to Azure Maps.\n```\nPOST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}\n```\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n```\nGET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key} \n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _route directions_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 3 _route directions_ queries:\n\n\n```json\n{\n \"batchItems\": [\n { \"query\": \"?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false\" },\n { \"query\": \"?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest\" },\n { \"query\": \"?query=48.923159,-122.557362:32.621279,-116.840362\" }\n ]\n}\n```\n\nA _route directions_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _route directions_ [URI parameters](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#uri-parameters). The string values in the _route directions_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **700** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n \n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 1,\n \"totalRequests\": 2\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\": {\n \"routes\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"legs\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"points\": [\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.34892\n },\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.3485\n },\n {\n \"latitude\": 47.62095,\n \"longitude\": -122.3476\n }\n ]\n }\n ],\n \"sections\": [\n {\n \"startPointIndex\": 0,\n \"endPointIndex\": 40,\n \"sectionType\": \"TRAVEL_MODE\",\n \"travelMode\": \"bicycle\"\n }\n ]\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", "operationId": "Route_PostRouteDirectionsBatch", "x-ms-client-name": "RequestRouteDirectionsBatch", "x-ms-long-running-operation": true, From 3bed98a1ba73672304439106e9d01eedd9233e36 Mon Sep 17 00:00:00 2001 From: Yuan Zhuang <40252949+yuanzhuangyuanzhuang@users.noreply.github.com> Date: Fri, 4 Oct 2024 10:25:58 -0700 Subject: [PATCH 43/47] fix wrong para position for the newly added params for AOAI (#30849) * fix wrong para position for the newly added params * Add parallel_tool_calls to assistant api * bug fix --------- Co-authored-by: Yuan Zhuang <yuzhua@microsoft.com> Co-authored-by: Shruti Gupta <shrgupta@microsoft.com> --- .../preview/2024-09-01-preview/inference.json | 18 ++++++++++++++---- .../preview/2024-09-01-preview/inference.yaml | 6 ++++++ 2 files changed, 20 insertions(+), 4 deletions(-) diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.json index 3be6ffd7734d..c339e42d06a6 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.json @@ -3739,6 +3739,10 @@ "nullable": true, "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.\n" }, + "parallel_tool_calls": { + "$ref": "#/components/schemas/ParallelToolCalls", + "nullable": true + }, "response_format": { "description": "An object specifying the format that the model must output. Compatible with [GPT-4o](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models), [GPT-4o mini](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models), [GPT-4 Turbo](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models) and all [GPT-3.5](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-35) Turbo models newer than `gpt-3.5-turbo-1106`.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which guarantees the model will match your supplied JSON schema.\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which guarantees the message the model generates is valid JSON.\n\n**Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.\n", "oneOf": [ @@ -3785,6 +3789,10 @@ "nullable": true, "default": false }, + "stream_options": { + "$ref": "#/components/schemas/chatCompletionStreamOptions", + "nullable": true + }, "temperature": { "type": "number", "minimum": 0, @@ -8202,10 +8210,6 @@ "nullable": true, "description": "If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.\n" }, - "stream_options": { - "$ref": "#/components/schemas/chatCompletionStreamOptions", - "nullable": true - }, "max_prompt_tokens": { "type": "integer", "nullable": true, @@ -8226,6 +8230,9 @@ "$ref": "#/components/schemas/assistantsApiToolChoiceOption", "nullable": true }, + "parallel_tool_calls": { + "$ref": "#/components/schemas/ParallelToolCalls" + }, "response_format": { "$ref": "#/components/schemas/assistantsApiResponseFormatOption", "nullable": true @@ -8486,6 +8493,9 @@ "$ref": "#/components/schemas/assistantsApiToolChoiceOption", "nullable": true }, + "parallel_tool_calls": { + "$ref": "#/components/schemas/ParallelToolCalls" + }, "response_format": { "$ref": "#/components/schemas/assistantsApiResponseFormatOption", "nullable": true diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.yaml index aa5051f82553..73e77e64decb 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.yaml +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.yaml @@ -2488,6 +2488,8 @@ components: example: 1 nullable: true description: How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep `n` as `1` to minimize costs. + parallel_tool_calls: + $ref: "#/components/schemas/ParallelToolCalls" presence_penalty: type: number default: 0 @@ -5723,6 +5725,8 @@ components: tool_choice: $ref: "#/components/schemas/assistantsApiToolChoiceOption" nullable: true + parallel_tool_calls: + $ref: "#/components/schemas/ParallelToolCalls" response_format: $ref: "#/components/schemas/assistantsApiResponseFormatOption" nullable: true @@ -5922,6 +5926,8 @@ components: tool_choice: $ref: "#/components/schemas/assistantsApiToolChoiceOption" nullable: true + parallel_tool_calls": + $ref: "#/components/schemas/ParallelToolCalls" response_format: $ref: "#/components/schemas/assistantsApiResponseFormatOption" nullable: true From a4bf7a2c5c9568202ab15eee8defda1f0779f6b3 Mon Sep 17 00:00:00 2001 From: jonathanserbent <34686049+jonathanserbent@users.noreply.github.com> Date: Fri, 4 Oct 2024 14:52:53 -0500 Subject: [PATCH 44/47] Release search azure.search preview: 2024-11-01-preview (#30485) * Copy over old spec into new folder * Update version to 11-01 * Initial feature spec changes * Additional Feature Changes and Examples * Swagger Prettier Check * Swagger Lint * Fix order of semanticQuery Parameter * Apply feedback * Add back defaultoversampling and rerankWithOriginalVectors * Semantic query order * Spellcheck CI * swagger prettier CI * Make the QueryRewrites List of List of strings into a List of objects which contain a list of string --------- Co-authored-by: Jonathan Serbent <jserbent@microsoft.com> --- cSpell.json | 7 +- .../SearchIndexAutocompleteDocumentsGet.json | 38 + .../SearchIndexAutocompleteDocumentsPost.json | 38 + .../examples/SearchIndexCountDocuments.json | 15 + .../examples/SearchIndexGetDocument.json | 29 + .../examples/SearchIndexIndexDocuments.json | 3808 +++++ .../SearchIndexSearchDocumentsGet.json | 86 + .../SearchIndexSearchDocumentsPost.json | 220 + ...SearchIndexSearchDocumentsSemanticGet.json | 52 + ...earchIndexSearchDocumentsSemanticPost.json | 69 + .../SearchIndexSuggestDocumentsGet.json | 47 + .../SearchIndexSuggestDocumentsPost.json | 59 + .../examples/SearchServiceCreateAlias.json | 25 + .../SearchServiceCreateDataSource.json | 73 + .../examples/SearchServiceCreateIndex.json | 582 + .../examples/SearchServiceCreateIndexer.json | 74 + .../SearchServiceCreateOrUpdateAlias.json | 37 + ...SearchServiceCreateOrUpdateDataSource.json | 112 + .../SearchServiceCreateOrUpdateIndex.json | 904 ++ .../SearchServiceCreateOrUpdateIndexer.json | 115 + .../SearchServiceCreateOrUpdateSkillset.json | 440 + ...SearchServiceCreateOrUpdateSynonymMap.json | 63 + .../examples/SearchServiceCreateSkillset.json | 288 + .../SearchServiceCreateSynonymMap.json | 42 + .../examples/SearchServiceDeleteAlias.json | 16 + .../SearchServiceDeleteDataSource.json | 16 + .../examples/SearchServiceDeleteIndex.json | 16 + .../examples/SearchServiceDeleteIndexer.json | 16 + .../examples/SearchServiceDeleteSkillset.json | 16 + .../SearchServiceDeleteSynonymMap.json | 16 + .../examples/SearchServiceGetAlias.json | 20 + .../examples/SearchServiceGetDataSource.json | 45 + .../examples/SearchServiceGetIndex.json | 331 + .../SearchServiceGetIndexStatistics.json | 19 + .../examples/SearchServiceGetIndexer.json | 43 + .../SearchServiceGetIndexerStatus.json | 89 + .../SearchServiceGetServiceStatistics.json | 58 + .../examples/SearchServiceGetSkillset.json | 161 + .../examples/SearchServiceGetSynonymMap.json | 29 + .../examples/SearchServiceIndexAnalyze.json | 40 + .../examples/SearchServiceListAliases.json | 23 + .../SearchServiceListDataSources.json | 49 + .../examples/SearchServiceListIndexers.json | 46 + .../examples/SearchServiceListIndexes.json | 335 + .../examples/SearchServiceListSkillsets.json | 165 + .../SearchServiceListSynonymMaps.json | 33 + .../examples/SearchServiceResetDocs.json | 21 + .../examples/SearchServiceResetIndexer.json | 13 + .../examples/SearchServiceResetSkills.json | 20 + .../examples/SearchServiceRunIndexer.json | 13 + .../2024-11-01-preview/searchindex.json | 3277 ++++ .../2024-11-01-preview/searchservice.json | 12918 ++++++++++++++++ .../search/data-plane/Azure.Search/readme.md | 30 +- 53 files changed, 25095 insertions(+), 2 deletions(-) create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexAutocompleteDocumentsGet.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexAutocompleteDocumentsPost.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexCountDocuments.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexGetDocument.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexIndexDocuments.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsGet.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsPost.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsSemanticGet.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsSemanticPost.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSuggestDocumentsGet.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSuggestDocumentsPost.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateAlias.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateDataSource.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateIndex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateAlias.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateDataSource.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateIndex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateSkillset.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateSynonymMap.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateSkillset.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateSynonymMap.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteAlias.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteDataSource.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteIndex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteSkillset.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteSynonymMap.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetAlias.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetDataSource.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndexStatistics.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndexerStatus.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetServiceStatistics.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetSkillset.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetSynonymMap.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceIndexAnalyze.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListAliases.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListDataSources.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListIndexers.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListIndexes.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListSkillsets.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListSynonymMaps.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceResetDocs.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceResetIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceResetSkills.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceRunIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/searchindex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/searchservice.json diff --git a/cSpell.json b/cSpell.json index 12154bc72508..327f6817c544 100644 --- a/cSpell.json +++ b/cSpell.json @@ -1239,7 +1239,12 @@ "vectorizing", "onelake", "tiktoken", - "Matryoshka" + "Matryoshka", + "rescore", + "rescoring", + "rescored", + "maxcharlength", + "submode" ] }, { diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexAutocompleteDocumentsGet.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexAutocompleteDocumentsGet.json new file mode 100644 index 000000000000..d7e422559283 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexAutocompleteDocumentsGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-11-01-preview", + "autocompleteMode": "oneTerm", + "search": "washington medic", + "suggesterName": "sg", + "filter": "search.in(docId,'101,102,105')", + "fuzzy": false, + "highlightPostTag": "</em>", + "highlightPreTag": "<em>", + "minimumCoverage": 80, + "searchFields": [ + "title", + "description" + ], + "top": 10 + }, + "responses": { + "200": { + "body": [ + { + "text": "medicaid", + "queryPlusText": "washington medicaid" + }, + { + "text": "medicare", + "queryPlusText": "washington medicare" + }, + { + "text": "medicine", + "queryPlusText": "washington medicine" + } + ] + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexAutocompleteDocumentsPost.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexAutocompleteDocumentsPost.json new file mode 100644 index 000000000000..1e8238c7ac9d --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexAutocompleteDocumentsPost.json @@ -0,0 +1,38 @@ +{ + "operationId": "Documents_AutocompletePost", + "title": "SearchIndexAutocompleteDocumentsPost", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexName": "preview-test", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "autocompleteRequest": { + "search": "p", + "autocompleteMode": "oneTerm", + "filter": "ownerId ne '1'", + "highlightPostTag": "</em>", + "highlightPreTag": "<em>", + "minimumCoverage": 80, + "searchFields": "category, ownerId", + "suggesterName": "sg", + "top": 10 + } + }, + "responses": { + "200": { + "body": { + "@search.coverage": 100.0, + "value": [ + { + "text": "purple", + "queryPlusText": "<em>purple</em>" + }, + { + "text": "pink", + "queryPlusText": "<em>pink</em>" + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexCountDocuments.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexCountDocuments.json new file mode 100644 index 000000000000..08553318c0e5 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexCountDocuments.json @@ -0,0 +1,15 @@ +{ + "operationId": "Documents_Count", + "title": "SearchIndexCountDocuments", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexName": "preview-test", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": 50 + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexGetDocument.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexGetDocument.json new file mode 100644 index 000000000000..d528286f1839 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexGetDocument.json @@ -0,0 +1,29 @@ +{ + "operationId": "Documents_Get", + "title": "SearchIndexGetDocument", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexName": "preview-test", + "key": "1", + "$select": [ + "id", + "description", + "name", + "category", + "ownerId" + ], + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "1", + "name": "test", + "description": "test1 hello", + "category": "purple", + "ownerId": "sam" + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexIndexDocuments.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexIndexDocuments.json new file mode 100644 index 000000000000..1376aa34cfae --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexIndexDocuments.json @@ -0,0 +1,3808 @@ +{ + "operationId": "Documents_Index", + "title": "SearchIndexIndexDocuments", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexName": "preview-test", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "batch": { + "value": [ + { + "@search.action": "mergeOrUpload", + "id": "0", + "name": "test", + "description": "test0 hello", + "vector1": [ + 0, + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19 + ], + "vector1b": [ + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19 + ], + "vector2": [ + 0, + 1, + 2, + 3, + 4 + ], + "vector3": [ + 0, + 1, + 2, + 3, + 4 + ], + "vector22": [ + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29 + ], + "ownerId": "benny", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "1", + "name": "test", + "description": "test1 hello", + "vector1": [ + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20 + ], + "vector1b": [ + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20 + ], + "vector2": [ + 1, + 2, + 3, + 4, + 5 + ], + "vector3": [ + 1, + 2, + 3, + 4, + 5 + ], + "vector22": [ + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30 + ], + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "2", + "name": "test", + "description": "test2 hello", + "vector1": [ + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21 + ], + "vector1b": [ + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21 + ], + "vector2": [ + 2, + 3, + 4, + 5, + 6 + ], + "vector3": [ + 2, + 3, + 4, + 5, + 6 + ], + "vector22": [ + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31 + ], + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "3", + "name": "test", + "description": "test3 hello", + "vector1": [ + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22 + ], + "vector1b": [ + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22 + ], + "vector2": [ + 3, + 4, + 5, + 6, + 7 + ], + "vector3": [ + 3, + 4, + 5, + 6, + 7 + ], + "vector22": [ + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32 + ], + "ownerId": "ryan", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "4", + "name": "test", + "description": "test4 hello", + "vector1": [ + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23 + ], + "vector1b": [ + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23 + ], + "vector2": [ + 4, + 5, + 6, + 7, + 8 + ], + "vector3": [ + 4, + 5, + 6, + 7, + 8 + ], + "vector22": [ + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33 + ], + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "5", + "name": "test", + "description": "test5 hello", + "vector1": [ + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24 + ], + "vector1b": [ + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24 + ], + "vector2": [ + 5, + 6, + 7, + 8, + 9 + ], + "vector3": [ + 5, + 6, + 7, + 8, + 9 + ], + "vector22": [ + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34 + ], + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "6", + "name": "test", + "description": "test6 hello", + "vector1": [ + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25 + ], + "vector1b": [ + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25 + ], + "vector2": [ + 6, + 7, + 8, + 9, + 10 + ], + "vector3": [ + 6, + 7, + 8, + 9, + 10 + ], + "vector22": [ + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35 + ], + "ownerId": "ryan", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "7", + "name": "test", + "description": "test7 hello", + "vector1": [ + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26 + ], + "vector1b": [ + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26 + ], + "vector2": [ + 7, + 8, + 9, + 10, + 11 + ], + "vector3": [ + 7, + 8, + 9, + 10, + 11 + ], + "vector22": [ + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36 + ], + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "8", + "name": "test", + "description": "test8 hello", + "vector1": [ + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27 + ], + "vector1b": [ + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27 + ], + "vector2": [ + 8, + 9, + 10, + 11, + 12 + ], + "vector3": [ + 8, + 9, + 10, + 11, + 12 + ], + "vector22": [ + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37 + ], + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "9", + "name": "test", + "description": "test9 hello", + "vector1": [ + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28 + ], + "vector1b": [ + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28 + ], + "vector2": [ + 9, + 10, + 11, + 12, + 13 + ], + "vector3": [ + 9, + 10, + 11, + 12, + 13 + ], + "vector22": [ + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38 + ], + "ownerId": "ryan", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "10", + "name": "test", + "description": "test10 hello", + "vector1": [ + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29 + ], + "vector1b": [ + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29 + ], + "vector2": [ + 10, + 11, + 12, + 13, + 14 + ], + "vector3": [ + 10, + 11, + 12, + 13, + 14 + ], + "vector22": [ + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39 + ], + "ownerId": "benny", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "11", + "name": "test", + "description": "test11 hello", + "vector1": [ + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30 + ], + "vector1b": [ + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30 + ], + "vector2": [ + 11, + 12, + 13, + 14, + 15 + ], + "vector3": [ + 11, + 12, + 13, + 14, + 15 + ], + "vector22": [ + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40 + ], + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "12", + "name": "test", + "description": "test12 hello", + "vector1": [ + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31 + ], + "vector1b": [ + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31 + ], + "vector2": [ + 12, + 13, + 14, + 15, + 16 + ], + "vector3": [ + 12, + 13, + 14, + 15, + 16 + ], + "vector22": [ + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41 + ], + "ownerId": "ryan", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "13", + "name": "test", + "description": "test13 hello", + "vector1": [ + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32 + ], + "vector1b": [ + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32 + ], + "vector2": [ + 13, + 14, + 15, + 16, + 17 + ], + "vector3": [ + 13, + 14, + 15, + 16, + 17 + ], + "vector22": [ + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42 + ], + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "14", + "name": "test", + "description": "test14 hello", + "vector1": [ + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33 + ], + "vector1b": [ + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33 + ], + "vector2": [ + 14, + 15, + 16, + 17, + 18 + ], + "vector3": [ + 14, + 15, + 16, + 17, + 18 + ], + "vector22": [ + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43 + ], + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "15", + "name": "test", + "description": "test15 hello", + "vector1": [ + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34 + ], + "vector1b": [ + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34 + ], + "vector2": [ + 15, + 16, + 17, + 18, + 19 + ], + "vector3": [ + 15, + 16, + 17, + 18, + 19 + ], + "vector22": [ + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44 + ], + "ownerId": "ryan", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "16", + "name": "test", + "description": "test16 hello", + "vector1": [ + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35 + ], + "vector1b": [ + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35 + ], + "vector2": [ + 16, + 17, + 18, + 19, + 20 + ], + "vector3": [ + 16, + 17, + 18, + 19, + 20 + ], + "vector22": [ + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45 + ], + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "17", + "name": "test", + "description": "test17 hello", + "vector1": [ + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36 + ], + "vector1b": [ + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36 + ], + "vector2": [ + 17, + 18, + 19, + 20, + 21 + ], + "vector3": [ + 17, + 18, + 19, + 20, + 21 + ], + "vector22": [ + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46 + ], + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "18", + "name": "test", + "description": "test18 hello", + "vector1": [ + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37 + ], + "vector1b": [ + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37 + ], + "vector2": [ + 18, + 19, + 20, + 21, + 22 + ], + "vector3": [ + 18, + 19, + 20, + 21, + 22 + ], + "vector22": [ + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47 + ], + "ownerId": "ryan", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "19", + "name": "test", + "description": "test19 hello", + "vector1": [ + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38 + ], + "vector1b": [ + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38 + ], + "vector2": [ + 19, + 20, + 21, + 22, + 23 + ], + "vector3": [ + 19, + 20, + 21, + 22, + 23 + ], + "vector22": [ + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48 + ], + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "20", + "name": "test", + "description": "test20 hello", + "vector1": [ + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39 + ], + "vector1b": [ + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39 + ], + "vector2": [ + 20, + 21, + 22, + 23, + 24 + ], + "vector3": [ + 20, + 21, + 22, + 23, + 24 + ], + "vector22": [ + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49 + ], + "ownerId": "benny", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "21", + "name": "test", + "description": "test21 hello", + "vector1": [ + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40 + ], + "vector1b": [ + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40 + ], + "vector2": [ + 21, + 22, + 23, + 24, + 25 + ], + "vector3": [ + 21, + 22, + 23, + 24, + 25 + ], + "vector22": [ + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50 + ], + "ownerId": "ryan", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "22", + "name": "test", + "description": "test22 hello", + "vector1": [ + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41 + ], + "vector1b": [ + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41 + ], + "vector2": [ + 22, + 23, + 24, + 25, + 26 + ], + "vector3": [ + 22, + 23, + 24, + 25, + 26 + ], + "vector22": [ + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51 + ], + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "23", + "name": "test", + "description": "test23 hello", + "vector1": [ + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42 + ], + "vector1b": [ + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42 + ], + "vector2": [ + 23, + 24, + 25, + 26, + 27 + ], + "vector3": [ + 23, + 24, + 25, + 26, + 27 + ], + "vector22": [ + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52 + ], + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "24", + "name": "test", + "description": "test24 hello", + "vector1": [ + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43 + ], + "vector1b": [ + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43 + ], + "vector2": [ + 24, + 25, + 26, + 27, + 28 + ], + "vector3": [ + 24, + 25, + 26, + 27, + 28 + ], + "vector22": [ + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53 + ], + "ownerId": "ryan", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "25", + "name": "test", + "description": "test25 hello", + "vector1": [ + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44 + ], + "vector1b": [ + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44 + ], + "vector2": [ + 25, + 26, + 27, + 28, + 29 + ], + "vector3": [ + 25, + 26, + 27, + 28, + 29 + ], + "vector22": [ + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54 + ], + "ownerId": "sam", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "26", + "name": "test", + "description": "test26 hello", + "vector1": [ + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45 + ], + "vector1b": [ + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45 + ], + "vector2": [ + 26, + 27, + 28, + 29, + 30 + ], + "vector3": [ + 26, + 27, + 28, + 29, + 30 + ], + "vector22": [ + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55 + ], + "ownerId": "sam", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "27", + "name": "test", + "description": "test27 hello", + "vector1": [ + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46 + ], + "vector1b": [ + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46 + ], + "vector2": [ + 27, + 28, + 29, + 30, + 31 + ], + "vector3": [ + 27, + 28, + 29, + 30, + 31 + ], + "vector22": [ + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56 + ], + "ownerId": "ryan", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "28", + "name": "test", + "description": "test28 hello", + "vector1": [ + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47 + ], + "vector1b": [ + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47 + ], + "vector2": [ + 28, + 29, + 30, + 31, + 32 + ], + "vector3": [ + 28, + 29, + 30, + 31, + 32 + ], + "vector22": [ + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57 + ], + "ownerId": "sam", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "29", + "name": "test", + "description": "test29 hello", + "vector1": [ + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48 + ], + "vector1b": [ + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48 + ], + "vector2": [ + 29, + 30, + 31, + 32, + 33 + ], + "vector3": [ + 29, + 30, + 31, + 32, + 33 + ], + "vector22": [ + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58 + ], + "ownerId": "sam", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "30", + "name": "test", + "description": "test30 hello", + "vector1": [ + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49 + ], + "vector1b": [ + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49 + ], + "vector2": [ + 30, + 31, + 32, + 33, + 34 + ], + "vector3": [ + 30, + 31, + 32, + 33, + 34 + ], + "vector22": [ + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59 + ], + "ownerId": "benny", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "31", + "name": "test", + "description": "test31 hello", + "vector1": [ + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50 + ], + "vector1b": [ + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50 + ], + "vector2": [ + 31, + 32, + 33, + 34, + 35 + ], + "vector3": [ + 31, + 32, + 33, + 34, + 35 + ], + "vector22": [ + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60 + ], + "ownerId": "sam", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "32", + "name": "test", + "description": "test32 hello", + "vector1": [ + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51 + ], + "vector1b": [ + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51 + ], + "vector2": [ + 32, + 33, + 34, + 35, + 36 + ], + "vector3": [ + 32, + 33, + 34, + 35, + 36 + ], + "vector22": [ + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61 + ], + "ownerId": "sam", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "33", + "name": "test", + "description": "test33 hello", + "vector1": [ + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52 + ], + "vector1b": [ + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52 + ], + "vector2": [ + 33, + 34, + 35, + 36, + 37 + ], + "vector3": [ + 33, + 34, + 35, + 36, + 37 + ], + "vector22": [ + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62 + ], + "ownerId": "ryan", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "34", + "name": "test", + "description": "test34 hello", + "vector1": [ + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53 + ], + "vector1b": [ + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53 + ], + "vector2": [ + 34, + 35, + 36, + 37, + 38 + ], + "vector3": [ + 34, + 35, + 36, + 37, + 38 + ], + "vector22": [ + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63 + ], + "ownerId": "sam", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "35", + "name": "test", + "description": "test35 hello", + "vector1": [ + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54 + ], + "vector1b": [ + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54 + ], + "vector2": [ + 35, + 36, + 37, + 38, + 39 + ], + "vector3": [ + 35, + 36, + 37, + 38, + 39 + ], + "vector22": [ + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63, + 64 + ], + "ownerId": "sam", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "36", + "name": "test", + "description": "test36 hello", + "vector1": [ + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55 + ], + "vector1b": [ + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55 + ], + "vector2": [ + 36, + 37, + 38, + 39, + 40 + ], + "vector3": [ + 36, + 37, + 38, + 39, + 40 + ], + "vector22": [ + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63, + 64, + 65 + ], + "ownerId": "ryan", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "37", + "name": "test", + "description": "test37 hello", + "vector1": [ + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56 + ], + "vector1b": [ + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56 + ], + "vector2": [ + 37, + 38, + 39, + 40, + 41 + ], + "vector3": [ + 37, + 38, + 39, + 40, + 41 + ], + "vector22": [ + 57, + 58, + 59, + 60, + 61, + 62, + 63, + 64, + 65, + 66 + ], + "ownerId": "sam", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "38", + "name": "test", + "description": "test38 hello", + "vector1": [ + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57 + ], + "vector1b": [ + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57 + ], + "vector2": [ + 38, + 39, + 40, + 41, + 42 + ], + "vector3": [ + 38, + 39, + 40, + 41, + 42 + ], + "vector22": [ + 58, + 59, + 60, + 61, + 62, + 63, + 64, + 65, + 66, + 67 + ], + "ownerId": "sam", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "39", + "name": "test", + "description": "test39 hello", + "vector1": [ + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58 + ], + "vector1b": [ + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58 + ], + "vector2": [ + 39, + 40, + 41, + 42, + 43 + ], + "vector3": [ + 39, + 40, + 41, + 42, + 43 + ], + "vector22": [ + 59, + 60, + 61, + 62, + 63, + 64, + 65, + 66, + 67, + 68 + ], + "ownerId": "ryan", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "40", + "name": "test", + "description": "test40 hello", + "vector1": [ + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59 + ], + "vector1b": [ + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59 + ], + "vector2": [ + 40, + 41, + 42, + 43, + 44 + ], + "vector3": [ + 40, + 41, + 42, + 43, + 44 + ], + "vector22": [ + 60, + 61, + 62, + 63, + 64, + 65, + 66, + 67, + 68, + 69 + ], + "ownerId": "benny", + "category": "green" + }, + { + "@search.action": "mergeOrUpload", + "id": "41", + "name": "test", + "description": "test41 hello", + "vector1": [ + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60 + ], + "vector1b": [ + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60 + ], + "vector2": [ + 41, + 42, + 43, + 44, + 45 + ], + "vector3": [ + 41, + 42, + 43, + 44, + 45 + ], + "vector22": [ + 61, + 62, + 63, + 64, + 65, + 66, + 67, + 68, + 69, + 70 + ], + "ownerId": "sam", + "category": "green" + }, + { + "@search.action": "mergeOrUpload", + "id": "42", + "name": "test", + "description": "test42 hello", + "vector1": [ + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61 + ], + "vector1b": [ + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61 + ], + "vector2": [ + 42, + 43, + 44, + 45, + 46 + ], + "vector3": [ + 42, + 43, + 44, + 45, + 46 + ], + "vector22": [ + 62, + 63, + 64, + 65, + 66, + 67, + 68, + 69, + 70, + 71 + ], + "ownerId": "ryan", + "category": "green" + }, + { + "@search.action": "mergeOrUpload", + "id": "43", + "name": "test", + "description": "test43 hello", + "vector1": [ + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62 + ], + "vector1b": [ + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62 + ], + "vector2": [ + 43, + 44, + 45, + 46, + 47 + ], + "vector3": [ + 43, + 44, + 45, + 46, + 47 + ], + "vector22": [ + 63, + 64, + 65, + 66, + 67, + 68, + 69, + 70, + 71, + 72 + ], + "ownerId": "sam", + "category": "green" + }, + { + "@search.action": "mergeOrUpload", + "id": "44", + "name": "test", + "description": "test44 hello", + "vector1": [ + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63 + ], + "vector1b": [ + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63 + ], + "vector2": [ + 44, + 45, + 46, + 47, + 48 + ], + "vector3": [ + 44, + 45, + 46, + 47, + 48 + ], + "vector22": [ + 64, + 65, + 66, + 67, + 68, + 69, + 70, + 71, + 72, + 73 + ], + "ownerId": "sam", + "category": "green" + }, + { + "@search.action": "mergeOrUpload", + "id": "45", + "name": "test", + "description": "test45 hello", + "vector1": [ + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63, + 64 + ], + "vector1b": [ + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63, + 64 + ], + "vector2": [ + 45, + 46, + 47, + 48, + 49 + ], + "vector3": [ + 45, + 46, + 47, + 48, + 49 + ], + "vector22": [ + 65, + 66, + 67, + 68, + 69, + 70, + 71, + 72, + 73, + 74 + ], + "ownerId": "ryan", + "category": "orange" + }, + { + "@search.action": "mergeOrUpload", + "id": "46", + "name": "test", + "description": "test46 hello", + "vector1": [ + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63, + 64, + 65 + ], + "vector1b": [ + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63, + 64, + 65 + ], + "vector2": [ + 46, + 47, + 48, + 49, + 50 + ], + "vector3": [ + 46, + 47, + 48, + 49, + 50 + ], + "vector22": [ + 66, + 67, + 68, + 69, + 70, + 71, + 72, + 73, + 74, + 75 + ], + "ownerId": "sam", + "category": "orange" + }, + { + "@search.action": "mergeOrUpload", + "id": "47", + "name": "test", + "description": "test47 hello", + "vector1": [ + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63, + 64, + 65, + 66 + ], + "vector1b": [ + 57, + 58, + 59, + 60, + 61, + 62, + 63, + 64, + 65, + 66 + ], + "vector2": [ + 47, + 48, + 49, + 50, + 51 + ], + "vector3": [ + 47, + 48, + 49, + 50, + 51 + ], + "vector22": [ + 67, + 68, + 69, + 70, + 71, + 72, + 73, + 74, + 75, + 76 + ], + "ownerId": "sam", + "category": "orange" + }, + { + "@search.action": "mergeOrUpload", + "id": "no-vectors", + "name": "test", + "description": "no vector", + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "empty-vectors", + "name": "test", + "description": "no vector", + "ownerId": "sam", + "category": "purple" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "key": "0", + "status": true, + "statusCode": 201 + }, + { + "key": "1", + "status": true, + "statusCode": 201 + }, + { + "key": "2", + "status": true, + "statusCode": 201 + }, + { + "key": "3", + "status": true, + "statusCode": 201 + }, + { + "key": "4", + "status": true, + "statusCode": 201 + }, + { + "key": "5", + "status": true, + "statusCode": 201 + }, + { + "key": "6", + "status": true, + "statusCode": 201 + }, + { + "key": "7", + "status": true, + "statusCode": 201 + }, + { + "key": "8", + "status": true, + "statusCode": 201 + }, + { + "key": "9", + "status": true, + "statusCode": 201 + }, + { + "key": "10", + "status": true, + "statusCode": 201 + }, + { + "key": "11", + "status": true, + "statusCode": 201 + }, + { + "key": "12", + "status": true, + "statusCode": 201 + }, + { + "key": "13", + "status": true, + "statusCode": 201 + }, + { + "key": "14", + "status": true, + "statusCode": 201 + }, + { + "key": "15", + "status": true, + "statusCode": 201 + }, + { + "key": "16", + "status": true, + "statusCode": 201 + }, + { + "key": "17", + "status": true, + "statusCode": 201 + }, + { + "key": "18", + "status": true, + "statusCode": 201 + }, + { + "key": "19", + "status": true, + "statusCode": 201 + }, + { + "key": "20", + "status": true, + "statusCode": 201 + }, + { + "key": "21", + "status": true, + "statusCode": 201 + }, + { + "key": "22", + "status": true, + "statusCode": 201 + }, + { + "key": "23", + "status": true, + "statusCode": 201 + }, + { + "key": "24", + "status": true, + "statusCode": 201 + }, + { + "key": "25", + "status": true, + "statusCode": 201 + }, + { + "key": "26", + "status": true, + "statusCode": 201 + }, + { + "key": "27", + "status": true, + "statusCode": 201 + }, + { + "key": "28", + "status": true, + "statusCode": 201 + }, + { + "key": "29", + "status": true, + "statusCode": 201 + }, + { + "key": "30", + "status": true, + "statusCode": 201 + }, + { + "key": "31", + "status": true, + "statusCode": 201 + }, + { + "key": "32", + "status": true, + "statusCode": 201 + }, + { + "key": "33", + "status": true, + "statusCode": 201 + }, + { + "key": "34", + "status": true, + "statusCode": 201 + }, + { + "key": "35", + "status": true, + "statusCode": 201 + }, + { + "key": "36", + "status": true, + "statusCode": 201 + }, + { + "key": "37", + "status": true, + "statusCode": 201 + }, + { + "key": "38", + "status": true, + "statusCode": 201 + }, + { + "key": "39", + "status": true, + "statusCode": 201 + }, + { + "key": "40", + "status": true, + "statusCode": 201 + }, + { + "key": "41", + "status": true, + "statusCode": 201 + }, + { + "key": "42", + "status": true, + "statusCode": 201 + }, + { + "key": "43", + "status": true, + "statusCode": 201 + }, + { + "key": "44", + "status": true, + "statusCode": 201 + }, + { + "key": "45", + "status": true, + "statusCode": 201 + }, + { + "key": "46", + "status": true, + "statusCode": 201 + }, + { + "key": "47", + "status": true, + "statusCode": 201 + }, + { + "key": "no-vectors", + "status": true, + "statusCode": 201 + }, + { + "key": "empty-vectors", + "status": true, + "statusCode": 201 + } + ] + } + }, + "207": { + "body": { + "value": [ + { + "key": "0", + "status": true, + "statusCode": 201 + }, + { + "key": "1", + "status": true, + "statusCode": 201 + }, + { + "key": "2", + "status": true, + "statusCode": 201 + }, + { + "key": "3", + "status": true, + "statusCode": 201 + }, + { + "key": "4", + "status": true, + "statusCode": 201 + }, + { + "key": "5", + "status": true, + "statusCode": 201 + }, + { + "key": "6", + "status": true, + "statusCode": 201 + }, + { + "key": "7", + "status": true, + "statusCode": 201 + }, + { + "key": "8", + "status": true, + "statusCode": 201 + }, + { + "key": "9", + "status": true, + "statusCode": 201 + }, + { + "key": "10", + "status": true, + "statusCode": 201 + }, + { + "key": "11", + "status": true, + "statusCode": 201 + }, + { + "key": "12", + "status": true, + "statusCode": 201 + }, + { + "key": "13", + "status": true, + "statusCode": 201 + }, + { + "key": "14", + "status": true, + "statusCode": 201 + }, + { + "key": "15", + "status": true, + "statusCode": 201 + }, + { + "key": "16", + "status": true, + "statusCode": 201 + }, + { + "key": "17", + "status": true, + "statusCode": 201 + }, + { + "key": "18", + "status": true, + "statusCode": 201 + }, + { + "key": "19", + "status": true, + "statusCode": 201 + }, + { + "key": "20", + "status": true, + "statusCode": 201 + }, + { + "key": "21", + "status": true, + "statusCode": 201 + }, + { + "key": "22", + "status": true, + "statusCode": 201 + }, + { + "key": "23", + "status": true, + "statusCode": 201 + }, + { + "key": "24", + "status": true, + "statusCode": 201 + }, + { + "key": "25", + "status": true, + "statusCode": 201 + }, + { + "key": "26", + "status": true, + "statusCode": 201 + }, + { + "key": "27", + "status": true, + "statusCode": 201 + }, + { + "key": "28", + "status": true, + "statusCode": 201 + }, + { + "key": "29", + "status": true, + "statusCode": 201 + }, + { + "key": "30", + "status": true, + "statusCode": 201 + }, + { + "key": "31", + "status": true, + "statusCode": 201 + }, + { + "key": "32", + "status": true, + "statusCode": 201 + }, + { + "key": "33", + "status": true, + "statusCode": 201 + }, + { + "key": "34", + "status": true, + "statusCode": 201 + }, + { + "key": "35", + "status": true, + "statusCode": 201 + }, + { + "key": "36", + "status": true, + "statusCode": 201 + }, + { + "key": "37", + "status": true, + "statusCode": 201 + }, + { + "key": "38", + "status": true, + "statusCode": 201 + }, + { + "key": "39", + "status": true, + "statusCode": 201 + }, + { + "key": "40", + "status": true, + "statusCode": 201 + }, + { + "key": "41", + "status": true, + "statusCode": 201 + }, + { + "key": "42", + "status": true, + "statusCode": 201 + }, + { + "key": "43", + "status": true, + "statusCode": 201 + }, + { + "key": "44", + "status": true, + "statusCode": 201 + }, + { + "key": "45", + "status": true, + "statusCode": 201 + }, + { + "key": "46", + "status": true, + "statusCode": 201 + }, + { + "key": "47", + "status": true, + "statusCode": 201 + }, + { + "key": "no-vectors", + "status": true, + "statusCode": 201 + }, + { + "key": "empty-vectors", + "status": true, + "statusCode": 201 + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsGet.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsGet.json new file mode 100644 index 000000000000..1267b386a073 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsGet.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-11-01-preview", + "$count": true, + "facet": [ + "category,count:10,sort:count" + ], + "$filter": "rating gt 10", + "highlight": [ + "title" + ], + "highlightPostTag": "</em>", + "highlightPreTag": "<em>", + "minimumCoverage": 80, + "$orderby": [ + "search.score() desc", + "rating desc" + ], + "queryType": "simple", + "sessionId": "mysessionid", + "scoringStatistics": "global", + "scoringParameters": [ + "currentLocation--122.123,44.77233" + ], + "scoringProfile": "sp", + "search": "nice hotels", + "searchFields": [ + "title", + "description" + ], + "searchMode": "any", + "$select": [ + "docId", + "title", + "description" + ], + "$skip": 100, + "$top": 10 + }, + "responses": { + "200": { + "body": { + "@odata.count": 25, + "@search.coverage": 80, + "@search.facets": { + "category": [ + { + "count": 1, + "value": "Economy" + }, + { + "count": 1, + "value": "Luxury" + } + ] + }, + "value": [ + { + "@search.score": 1.50, + "@search.highlights": { + "title": [ + "<em>Nice</em> <em>Hotel</em>" + ] + }, + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + }, + { + "@search.score": 0.70, + "@search.highlights": { + "title": [ + "Fancy <em>Hotel</em>" + ] + }, + "description": "Best hotel in town", + "docId": "2", + "title": "Fancy Hotel" + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsPost.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsPost.json new file mode 100644 index 000000000000..eb57be4b7bc3 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsPost.json @@ -0,0 +1,220 @@ +{ + "operationId": "Documents_SearchPost", + "title": "SearchIndexSearchDocumentsPost", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexName": "preview-test", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "searchRequest": { + "count": true, + "facets": [ + "ownerId" + ], + "filter": "category eq 'purple' or category eq 'pink'", + "highlight": "category", + "highlightPostTag": "</em>", + "highlightPreTag": "</em>", + "orderby": "id desc", + "queryType": "simple", + "scoringStatistics": "global", + "sessionId": "mysessionid", + "scoringParameters": [ + "categoryTag:desiredCategoryValue" + ], + "scoringProfile": "stringFieldBoost", + "search": "purple", + "searchFields": "id,name,description,category,ownerId", + "searchMode": "any", + "select": "id,name,description,category,ownerId", + "skip": 0, + "top": 10, + "vectorQueries": [ + { + "vector": [ + 0, + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9 + ], + "kind": "vector", + "k": 50, + "fields": "vector22, vector1b", + "oversampling": 20, + "weight": 1, + "threshold": { + "value": 0.984, + "kind": "vectorSimilarity" + }, + "filterOverride": "ownerId eq 'sam'" + } + ], + "vectorFilterMode": "preFilter", + "hybridSearch": { + "maxTextRecallSize": 100, + "countAndFacetMode": "countAllResults" + } + } + }, + "responses": { + "200": { + "body": { + "@odata.count": 27, + "@search.facets": { + "ownerId": [ + { + "count": 16, + "value": "sam" + }, + { + "count": 8, + "value": "ryan" + }, + { + "count": 3, + "value": "benny" + } + ] + }, + "value": [ + { + "@search.score": 1.0, + "@search.highlights": { + "category": [ + "</em>purple</em>" + ] + }, + "id": "no-vectors", + "name": "test", + "description": "no vector", + "category": "purple", + "ownerId": "sam" + }, + { + "@search.score": 1.0, + "@search.highlights": { + "category": [ + "</em>purple</em>" + ] + }, + "id": "empty-vectors", + "name": "test", + "description": "no vector", + "category": "purple", + "ownerId": "sam" + }, + { + "@search.score": 1.0, + "@search.highlights": { + "category": [ + "</em>purple</em>" + ] + }, + "id": "9", + "name": "test", + "description": "test9 hello", + "category": "purple", + "ownerId": "ryan" + }, + { + "@search.score": 1.0, + "@search.highlights": { + "category": [ + "</em>purple</em>" + ] + }, + "id": "8", + "name": "test", + "description": "test8 hello", + "category": "purple", + "ownerId": "sam" + }, + { + "@search.score": 1.0, + "@search.highlights": { + "category": [ + "</em>purple</em>" + ] + }, + "id": "7", + "name": "test", + "description": "test7 hello", + "category": "purple", + "ownerId": "sam" + }, + { + "@search.score": 1.0, + "@search.highlights": { + "category": [ + "</em>purple</em>" + ] + }, + "id": "6", + "name": "test", + "description": "test6 hello", + "category": "purple", + "ownerId": "ryan" + }, + { + "@search.score": 1.0, + "@search.highlights": { + "category": [ + "</em>purple</em>" + ] + }, + "id": "5", + "name": "test", + "description": "test5 hello", + "category": "purple", + "ownerId": "sam" + }, + { + "@search.score": 1.0, + "@search.highlights": { + "category": [ + "</em>purple</em>" + ] + }, + "id": "4", + "name": "test", + "description": "test4 hello", + "category": "purple", + "ownerId": "sam" + }, + { + "@search.score": 1.0, + "@search.highlights": { + "category": [ + "</em>purple</em>" + ] + }, + "id": "3", + "name": "test", + "description": "test3 hello", + "category": "purple", + "ownerId": "ryan" + }, + { + "@search.score": 1.0, + "@search.highlights": { + "category": [ + "</em>purple</em>" + ] + }, + "id": "24", + "name": "test", + "description": "test24 hello", + "category": "purple", + "ownerId": "ryan" + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsSemanticGet.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsSemanticGet.json new file mode 100644 index 000000000000..656b6db2b4a6 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsSemanticGet.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-11-01-preview", + "$count": true, + "highlightPostTag": "</em>", + "highlightPreTag": "<em>", + "queryType": "semantic", + "search": "how do clouds form", + "semanticConfiguration": "my-semantic-config", + "answers": "extractive|count-3", + "captions": "extractive|highlight-true", + "semanticErrorHandling": "partial", + "semanticMaxWaitInMilliseconds": 780 + }, + "responses": { + "200": { + "body": { + "@odata.count": 25, + "@search.answers": [ + { + "key": "4123", + "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case), but not where it is descending (over the river).", + "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case), but not where it is<em> descending</em> (over the river).", + "score": 0.94639826 + } + ], + "value": [ + { + "@search.score": 0.5479723, + "@search.rerankerScore": 1.0321671911515296, + "@search.captions": [ + { + "text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.", + "highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America." + } + ], + "id": "4123", + "title": "Earth Atmosphere", + "content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n", + "locations": [ + "Pacific Northwest", + "North America", + "Vancouver" + ] + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsSemanticPost.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsSemanticPost.json new file mode 100644 index 000000000000..1b03fad7f52b --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsSemanticPost.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-11-01-preview", + "searchRequest": { + "count": true, + "highlightPostTag": "</em>", + "highlightPreTag": "<em>", + "queryType": "semantic", + "search": "how do clouds form", + "semanticConfiguration": "my-semantic-config", + "answers": "extractive|count-3", + "captions": "extractive|highlight-true", + "semanticErrorHandling": "partial", + "semanticMaxWaitInMilliseconds": 780 + } + }, + "responses": { + "200": { + "body": { + "@odata.count": 25, + "@search.answers": [ + { + "key": "4123", + "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case), but not where it is descending (over the river).", + "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case), but not where it is<em> descending</em> (over the river).", + "score": 0.94639826 + } + ], + "@search.nextPageParameters": { + "count": true, + "highlightPostTag": "</em>", + "highlightPreTag": "<em>", + "queryType": "semantic", + "search": "how do clouds form", + "semanticConfiguration": "my-semantic-config", + "answers": "extractive|count-3", + "captions": "extractive|highlight-true", + "semanticErrorHandling": "partial", + "semanticMaxWaitInMilliseconds": 780, + "skip": 2, + "top": 8 + }, + "value": [ + { + "@search.score": 0.5479723, + "@search.rerankerScore": 1.0321671911515296, + "@search.captions": [ + { + "text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.", + "highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America." + } + ], + "id": "4123", + "title": "Earth Atmosphere", + "content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n", + "locations": [ + "Pacific Northwest", + "North America", + "Vancouver" + ] + } + ], + "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2024-11-01-preview" + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSuggestDocumentsGet.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSuggestDocumentsGet.json new file mode 100644 index 000000000000..c7b3a006ad5b --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSuggestDocumentsGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-11-01-preview", + "$filter": "rating gt 10", + "fuzzy": false, + "highlightPostTag": "</em>", + "highlightPreTag": "<em>", + "minimumCoverage": 80, + "$orderby": [ + "search.score() desc", + "rating desc" + ], + "search": "hote", + "searchFields": [ + "title" + ], + "suggesterName": "sg", + "$select": [ + "docId", + "title", + "description" + ], + "$top": 10 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "@search.text": "Nice <em>Hotel</em>", + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + }, + { + "@search.text": "Fancy <em>Hotel</em>", + "description": "Best hotel in town", + "docId": "2", + "title": "Fancy Hotel" + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSuggestDocumentsPost.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSuggestDocumentsPost.json new file mode 100644 index 000000000000..1d1c05aba34d --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSuggestDocumentsPost.json @@ -0,0 +1,59 @@ +{ + "operationId": "Documents_SuggestPost", + "title": "SearchIndexSuggestDocumentsPost", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexName": "preview-test", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "suggestRequest": { + "filter": "ownerId eq 'sam' and id lt '15'", + "highlightPostTag": "</em>", + "highlightPreTag": "<em>", + "minimumCoverage": 80, + "orderby": "id desc", + "search": "p", + "searchFields": "category", + "select": "id,name,category,ownerId", + "suggesterName": "sg", + "top": 10 + } + }, + "responses": { + "200": { + "body": { + "@search.coverage": 100.0, + "value": [ + { + "@search.text": "<em>p</em>urple", + "id": "14", + "name": "test", + "category": "purple", + "ownerId": "sam" + }, + { + "@search.text": "<em>p</em>urple", + "id": "13", + "name": "test", + "category": "purple", + "ownerId": "sam" + }, + { + "@search.text": "<em>p</em>urple", + "id": "11", + "name": "test", + "category": "purple", + "ownerId": "sam" + }, + { + "@search.text": "<em>p</em>urple", + "id": "1", + "name": "test", + "category": "purple", + "ownerId": "sam" + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateAlias.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateAlias.json new file mode 100644 index 000000000000..bc0e3d0410d0 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateAlias.json @@ -0,0 +1,25 @@ +{ + "operationId": "Aliases_Create", + "title": "SearchServiceCreateAlias", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "alias": { + "name": "tempalias", + "indexes": [ + "preview-test" + ] + } + }, + "responses": { + "201": { + "body": { + "name": "tempalias", + "indexes": [ + "preview-test" + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateDataSource.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateDataSource.json new file mode 100644 index 000000000000..dfeca99c161c --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateDataSource.json @@ -0,0 +1,73 @@ +{ + "operationId": "DataSources_Create", + "title": "SearchServiceCreateDataSource", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "dataSource": { + "name": "tempdatasource", + "description": "My Azure Blob data source.", + "type": "azureblob", + "credentials": { + "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net " + }, + "container": { + "name": "doc-extraction-skillset", + "query": "E2E_Dsat" + }, + "dataChangeDetectionPolicy": { + "highWaterMarkColumnName": "metadata_storage_last_modified", + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy" + }, + "dataDeletionDetectionPolicy": { + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true", + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "tempdatasource", + "description": "My Azure Blob data source.", + "type": "azureblob", + "credentials": { + "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net " + }, + "container": { + "name": "doc-extraction-skillset", + "query": "E2E_Dsat" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "metadata_storage_last_modified" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateIndex.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateIndex.json new file mode 100644 index 000000000000..7112b1f89d15 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateIndex.json @@ -0,0 +1,582 @@ +{ + "operationId": "Indexes_Create", + "title": "SearchServiceCreateIndex", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "index": { + "name": "temp-preview-test", + "fields": [ + { + "name": "id", + "type": "Edm.String", + "key": true, + "sortable": true + }, + { + "name": "vector1", + "type": "Collection(Edm.Single)", + "retrievable": true, + "searchable": true, + "dimensions": 20, + "vectorSearchProfile": "config1" + }, + { + "name": "vector1b", + "type": "Collection(Edm.Single)", + "retrievable": true, + "searchable": true, + "dimensions": 10, + "vectorSearchProfile": "config2" + }, + { + "name": "vector2", + "type": "Collection(Edm.Single)", + "retrievable": true, + "searchable": true, + "dimensions": 5, + "vectorSearchProfile": "config3" + }, + { + "name": "vector3", + "type": "Collection(Edm.Single)", + "retrievable": true, + "searchable": true, + "dimensions": 5, + "vectorSearchProfile": "config3" + }, + { + "name": "vector22", + "type": "Collection(Edm.Single)", + "retrievable": true, + "searchable": true, + "dimensions": 10, + "vectorSearchProfile": "config2" + }, + { + "name": "name", + "type": "Edm.String", + "retrievable": true, + "searchable": true, + "filterable": true, + "sortable": true, + "facetable": true, + "analyzer": "en.lucene" + }, + { + "name": "description", + "type": "Edm.String", + "retrievable": true, + "searchable": true, + "filterable": true, + "sortable": true, + "facetable": true, + "analyzer": "standard.lucene" + }, + { + "name": "category", + "type": "Edm.String", + "retrievable": true, + "searchable": true, + "filterable": true, + "sortable": true, + "facetable": true, + "analyzer": "en.lucene" + }, + { + "name": "ownerId", + "type": "Edm.String", + "retrievable": true, + "searchable": true, + "filterable": true, + "sortable": true, + "facetable": true, + "analyzer": "en.lucene" + } + ], + "scoringProfiles": [ + { + "name": "stringFieldBoost", + "text": { + "weights": { + "name": 3, + "description": 1, + "category": 2, + "ownerId": 1 + } + }, + "functions": [ + { + "tag": { + "tagsParameter": "categoryTag" + }, + "type": "tag", + "fieldName": "category", + "boost": 2 + } + ] + } + ], + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "category", + "ownerId" + ] + } + ], + "analyzers": [ + { + "tokenizer": "standard_v2", + "tokenFilters": [ + "common_grams" + ], + "charFilters": [ + "html_strip" + ], + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "name": "tagsAnalyzer" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "normalizers": [], + "semantic": {}, + "vectorSearch": { + "profiles": [ + { + "name": "config1", + "algorithm": "cosine", + "vectorizer": "openai", + "compression": "mySQ8" + }, + { + "name": "config2", + "algorithm": "euclidean", + "vectorizer": "custom-web-api", + "compression": "mySQ8" + }, + { + "name": "config3", + "algorithm": "dotProduct", + "vectorizer": "custom-web-api", + "compression": "myBQC" + } + ], + "algorithms": [ + { + "hnswParameters": { + "metric": "cosine" + }, + "name": "cosine", + "kind": "hnsw" + }, + { + "hnswParameters": { + "metric": "euclidean" + }, + "name": "euclidean", + "kind": "hnsw" + }, + { + "hnswParameters": { + "metric": "dotProduct" + }, + "name": "dotProduct", + "kind": "hnsw" + } + ], + "vectorizers": [ + { + "azureOpenAIParameters": { + "resourceUri": "https://test-sample.openai.azure.com/", + "deploymentId": "model", + "apiKey": "api-key", + "modelName": "text-embedding-3-large" + }, + "name": "openai", + "kind": "azureOpenAI" + }, + { + "customWebApiParameters": { + "uri": "https://my-custom-endpoint.org/", + "httpHeaders": { + "header1": "value1", + "header2": "value2" + }, + "httpMethod": "POST", + "timeout": "PT1M", + "authResourceId": "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", + "authIdentity": { + "@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity" + } + }, + "name": "custom-web-api", + "kind": "customWebApi" + }, + { + "amlParameters": { + "uri": "https://my-custom-endpoint.org/", + "resourceId": "aml resource id", + "timeout": "PT1M", + "region": "aml region", + "modelName": "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32" + }, + "name": "aml", + "kind": "aml" + } + ], + "compressions": [ + { + "scalarQuantizationParameters": { + "quantizedDataType": "int8" + }, + "name": "mySQ8", + "kind": "scalarQuantization", + "rescoringOptions": { + "enableRescoring": true, + "defaultOversampling": 10, + "rescoreStorageMethod": "preserveOriginals" + }, + "truncationDimension": 2 + }, + { + "name": "myBQC", + "kind": "binaryQuantization", + "rescoringOptions": { + "enableRescoring": true, + "defaultOversampling": 10, + "rescoreStorageMethod": "preserveOriginals" + }, + "truncationDimension": 2 + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "temp-preview-test", + "fields": [ + { + "name": "id", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": true, + "synonymMaps": [] + }, + { + "name": "vector1", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 20, + "vectorSearchProfile": "config1", + "synonymMaps": [] + }, + { + "name": "vector1b", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 10, + "vectorSearchProfile": "config2", + "synonymMaps": [] + }, + { + "name": "vector2", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 5, + "vectorSearchProfile": "config3", + "synonymMaps": [] + }, + { + "name": "vector3", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 5, + "vectorSearchProfile": "config3", + "synonymMaps": [] + }, + { + "name": "vector22", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 10, + "vectorSearchProfile": "config2", + "synonymMaps": [] + }, + { + "name": "name", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "standard.lucene", + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + }, + { + "name": "ownerId", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "stringFieldBoost", + "functionAggregation": "sum", + "text": { + "weights": { + "name": 3.0, + "description": 1.0, + "category": 2.0, + "ownerId": 1.0 + } + }, + "functions": [ + { + "fieldName": "category", + "interpolation": "linear", + "type": "tag", + "boost": 2.0, + "tag": { + "tagsParameter": "categoryTag" + } + } + ] + } + ], + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "category", + "ownerId" + ] + } + ], + "analyzers": [ + { + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "name": "tagsAnalyzer", + "tokenizer": "standard_v2", + "tokenFilters": [ + "common_grams" + ], + "charFilters": [ + "html_strip" + ] + } + ], + "normalizers": [], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.BM25Similarity" + }, + "semantic": { + "configurations": [] + }, + "vectorSearch": { + "algorithms": [ + { + "name": "cosine", + "kind": "hnsw", + "hnswParameters": { + "metric": "cosine", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "euclidean", + "kind": "hnsw", + "hnswParameters": { + "metric": "euclidean", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "dotProduct", + "kind": "hnsw", + "hnswParameters": { + "metric": "dotProduct", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + } + ], + "profiles": [ + { + "name": "config1", + "algorithm": "cosine", + "vectorizer": "openai", + "compression": "mySQ8" + }, + { + "name": "config2", + "algorithm": "euclidean", + "vectorizer": "custom-web-api", + "compression": "mySQ8" + }, + { + "name": "config3", + "algorithm": "dotProduct", + "vectorizer": "custom-web-api", + "compression": "myBQC" + } + ], + "vectorizers": [ + { + "name": "openai", + "kind": "azureOpenAI", + "azureOpenAIParameters": { + "resourceUri": "https://test-sample.openai.azure.com", + "deploymentId": "model", + "apiKey": "api-key", + "modelName": "text-embedding-3-large" + } + }, + { + "name": "custom-web-api", + "kind": "customWebApi", + "customWebApiParameters": { + "httpMethod": "POST", + "uri": "https://my-custom-endpoint.org/", + "timeout": "PT1M", + "authResourceId": "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", + "httpHeaders": { + "header1": "value1", + "header2": "value2" + }, + "authIdentity": { + "@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity" + } + } + }, + { + "name": "aml", + "kind": "aml", + "amlParameters": { + "resourceId": "aml resource id", + "region": "aml region", + "uri": "https://my-custom-endpoint.org/", + "timeout": "PT1M", + "modelName": "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32" + } + } + ], + "compressions": [ + { + "name": "mySQ8", + "kind": "scalarQuantization", + "truncationDimension": 2, + "scalarQuantizationParameters": { + "quantizedDataType": "int8" + }, + "rescoringOptions": { + "enableRescoring": true, + "defaultOversampling": 10.0, + "rescoreStorageMethod": "preserveOriginals" + } + }, + { + "name": "myBQC", + "kind": "binaryQuantization", + "truncationDimension": 2, + "rescoringOptions": { + "enableRescoring": true, + "defaultOversampling": 10.0, + "rescoreStorageMethod": "preserveOriginals" + } + } + ] + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateIndexer.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateIndexer.json new file mode 100644 index 000000000000..9731be059de3 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateIndexer.json @@ -0,0 +1,74 @@ +{ + "operationId": "Indexers_Create", + "title": "SearchServiceCreateIndexer", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "indexer": { + "name": "myindexer", + "description": "Description of the indexer", + "dataSourceName": "mydocdbdatasource", + "skillsetName": "myskillset", + "targetIndexName": "preview-test", + "schedule": { + "interval": "P1D" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5, + "configuration": { + "parsingMode": "markdown", + "markdownParsingSubmode": "oneToMany" + } + }, + "fieldMappings": [], + "outputFieldMappings": [], + "disabled": false, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "myindexer", + "description": "Description of the indexer", + "dataSourceName": "mydocdbdatasource", + "skillsetName": "myskillset", + "targetIndexName": "preview-test", + "disabled": false, + "schedule": { + "interval": "P1D", + "startTime": "2024-06-06T00:01:50.265Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5, + "configuration": { + "parsingMode": "markdown", + "markdownParsingSubmode": "oneToMany" + } + }, + "fieldMappings": [], + "outputFieldMappings": [], + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateAlias.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateAlias.json new file mode 100644 index 000000000000..67ec8b97cf71 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateAlias.json @@ -0,0 +1,37 @@ +{ + "operationId": "Aliases_CreateOrUpdate", + "title": "SearchServiceCreateOrUpdateAlias", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "aliasName": "myalias", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "If-Match": null, + "If-None-Match": null, + "Prefer": "return=representation", + "alias": { + "name": "myalias", + "indexes": [ + "preview-test" + ] + } + }, + "responses": { + "200": { + "body": { + "name": "myalias", + "indexes": [ + "preview-test" + ] + } + }, + "201": { + "body": { + "name": "myalias", + "indexes": [ + "preview-test" + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateDataSource.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateDataSource.json new file mode 100644 index 000000000000..833560453684 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateDataSource.json @@ -0,0 +1,112 @@ +{ + "operationId": "DataSources_CreateOrUpdate", + "title": "SearchServiceCreateOrUpdateDataSource", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "dataSourceName": "tempdatasource", + "api-version": "2024-11-01-preview", + "ignoreResetRequirements": null, + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "If-Match": null, + "If-None-Match": null, + "Prefer": "return=representation", + "dataSource": { + "name": "tempdatasource", + "description": "My Azure Blob data source.", + "type": "azureblob", + "credentials": { + "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net " + }, + "container": { + "name": "doc-extraction-skillset", + "query": "E2E_Dsat" + }, + "dataChangeDetectionPolicy": { + "highWaterMarkColumnName": "metadata_storage_last_modified", + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy" + }, + "dataDeletionDetectionPolicy": { + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true", + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + }, + "responses": { + "200": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "tempdatasource", + "description": "My Azure Blob data source.", + "type": "azureblob", + "credentials": { + "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net " + }, + "container": { + "name": "doc-extraction-skillset", + "query": "E2E_Dsat" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "metadata_storage_last_modified" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + }, + "201": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "tempdatasource", + "description": "My Azure Blob data source.", + "type": "azureblob", + "credentials": { + "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net " + }, + "container": { + "name": "doc-extraction-skillset", + "query": "E2E_Dsat" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "metadata_storage_last_modified" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateIndex.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateIndex.json new file mode 100644 index 000000000000..13234c786119 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateIndex.json @@ -0,0 +1,904 @@ +{ + "operationId": "Indexes_CreateOrUpdate", + "title": "SearchServiceCreateOrUpdateIndex", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexName": "temp-preview-test", + "allowIndexDowntime": null, + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "If-Match": null, + "If-None-Match": null, + "Prefer": "return=representation", + "index": { + "name": "temp-preview-test", + "fields": [ + { + "name": "id", + "type": "Edm.String", + "key": true, + "sortable": true + }, + { + "name": "vector1", + "type": "Collection(Edm.Single)", + "retrievable": true, + "searchable": true, + "dimensions": 20, + "vectorSearchProfile": "config1" + }, + { + "name": "vector1b", + "type": "Collection(Edm.Single)", + "retrievable": true, + "searchable": true, + "dimensions": 10, + "vectorSearchProfile": "config2" + }, + { + "name": "vector2", + "type": "Collection(Edm.Single)", + "retrievable": true, + "searchable": true, + "dimensions": 5, + "vectorSearchProfile": "config3" + }, + { + "name": "vector3", + "type": "Collection(Edm.Single)", + "retrievable": true, + "searchable": true, + "dimensions": 5, + "vectorSearchProfile": "config3" + }, + { + "name": "vector22", + "type": "Collection(Edm.Single)", + "retrievable": true, + "searchable": true, + "dimensions": 10, + "vectorSearchProfile": "config2" + }, + { + "name": "name", + "type": "Edm.String", + "retrievable": true, + "searchable": true, + "filterable": true, + "sortable": true, + "facetable": true, + "analyzer": "en.lucene" + }, + { + "name": "description", + "type": "Edm.String", + "retrievable": true, + "searchable": true, + "filterable": true, + "sortable": true, + "facetable": true, + "analyzer": "standard.lucene" + }, + { + "name": "category", + "type": "Edm.String", + "retrievable": true, + "searchable": true, + "filterable": true, + "sortable": true, + "facetable": true, + "analyzer": "en.lucene" + }, + { + "name": "ownerId", + "type": "Edm.String", + "retrievable": true, + "searchable": true, + "filterable": true, + "sortable": true, + "facetable": true, + "analyzer": "en.lucene" + } + ], + "scoringProfiles": [ + { + "name": "stringFieldBoost", + "text": { + "weights": { + "name": 3, + "description": 1, + "category": 2, + "ownerId": 1 + } + }, + "functions": [ + { + "tag": { + "tagsParameter": "categoryTag" + }, + "type": "tag", + "fieldName": "category", + "boost": 2 + } + ] + } + ], + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "category", + "ownerId" + ] + } + ], + "analyzers": [ + { + "tokenizer": "standard_v2", + "tokenFilters": [ + "common_grams" + ], + "charFilters": [ + "html_strip" + ], + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "name": "tagsAnalyzer" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "normalizers": [], + "semantic": {}, + "vectorSearch": { + "profiles": [ + { + "name": "config1", + "algorithm": "cosine", + "vectorizer": "openai", + "compression": "mySQ8" + }, + { + "name": "config2", + "algorithm": "euclidean", + "vectorizer": "custom-web-api", + "compression": "mySQ8" + }, + { + "name": "config3", + "algorithm": "dotProduct", + "vectorizer": "custom-web-api", + "compression": "myBQC" + } + ], + "algorithms": [ + { + "hnswParameters": { + "metric": "cosine" + }, + "name": "cosine", + "kind": "hnsw" + }, + { + "hnswParameters": { + "metric": "euclidean" + }, + "name": "euclidean", + "kind": "hnsw" + }, + { + "hnswParameters": { + "metric": "dotProduct" + }, + "name": "dotProduct", + "kind": "hnsw" + } + ], + "vectorizers": [ + { + "azureOpenAIParameters": { + "resourceUri": "https://test-sample.openai.azure.com/", + "deploymentId": "model", + "apiKey": "api-key", + "modelName": "text-embedding-3-large" + }, + "name": "openai", + "kind": "azureOpenAI" + }, + { + "customWebApiParameters": { + "uri": "https://my-custom-endpoint.org/", + "httpHeaders": { + "header1": "value1", + "header2": "value2" + }, + "httpMethod": "POST", + "timeout": "PT1M", + "authResourceId": "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", + "authIdentity": { + "@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity" + } + }, + "name": "custom-web-api", + "kind": "customWebApi" + }, + { + "amlParameters": { + "uri": "https://my-custom-endpoint.org/", + "resourceId": "aml resource id", + "timeout": "PT1M", + "region": "aml region", + "modelName": "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32" + }, + "name": "aml", + "kind": "aml" + } + ], + "compressions": [ + { + "scalarQuantizationParameters": { + "quantizedDataType": "int8" + }, + "name": "mySQ8", + "kind": "scalarQuantization", + "rescoringOptions": { + "enableRescoring": true, + "defaultOversampling": 10, + "rescoreStorageMethod": "preserveOriginals" + }, + "truncationDimension": 2 + }, + { + "name": "myBQC", + "kind": "binaryQuantization", + "rescoringOptions": { + "enableRescoring": true, + "defaultOversampling": 10, + "rescoreStorageMethod": "preserveOriginals" + }, + "truncationDimension": 2 + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "temp-preview-test", + "fields": [ + { + "name": "id", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": true, + "synonymMaps": [] + }, + { + "name": "vector1", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 20, + "vectorSearchProfile": "config1", + "synonymMaps": [] + }, + { + "name": "vector1b", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 10, + "vectorSearchProfile": "config2", + "synonymMaps": [] + }, + { + "name": "vector2", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 5, + "vectorSearchProfile": "config3", + "synonymMaps": [] + }, + { + "name": "vector3", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 5, + "vectorSearchProfile": "config3", + "synonymMaps": [] + }, + { + "name": "vector22", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 10, + "vectorSearchProfile": "config2", + "synonymMaps": [] + }, + { + "name": "name", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "standard.lucene", + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + }, + { + "name": "ownerId", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "stringFieldBoost", + "functionAggregation": "sum", + "text": { + "weights": { + "name": 3.0, + "description": 1.0, + "category": 2.0, + "ownerId": 1.0 + } + }, + "functions": [ + { + "fieldName": "category", + "interpolation": "linear", + "type": "tag", + "boost": 2.0, + "tag": { + "tagsParameter": "categoryTag" + } + } + ] + } + ], + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "category", + "ownerId" + ] + } + ], + "analyzers": [ + { + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "name": "tagsAnalyzer", + "tokenizer": "standard_v2", + "tokenFilters": [ + "common_grams" + ], + "charFilters": [ + "html_strip" + ] + } + ], + "normalizers": [], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.BM25Similarity" + }, + "semantic": { + "configurations": [] + }, + "vectorSearch": { + "algorithms": [ + { + "name": "cosine", + "kind": "hnsw", + "hnswParameters": { + "metric": "cosine", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "euclidean", + "kind": "hnsw", + "hnswParameters": { + "metric": "euclidean", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "dotProduct", + "kind": "hnsw", + "hnswParameters": { + "metric": "dotProduct", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + } + ], + "profiles": [ + { + "name": "config1", + "algorithm": "cosine", + "vectorizer": "openai", + "compression": "mySQ8" + }, + { + "name": "config2", + "algorithm": "euclidean", + "vectorizer": "custom-web-api", + "compression": "mySQ8" + }, + { + "name": "config3", + "algorithm": "dotProduct", + "vectorizer": "custom-web-api", + "compression": "myBQC" + } + ], + "vectorizers": [ + { + "name": "openai", + "kind": "azureOpenAI", + "azureOpenAIParameters": { + "resourceUri": "https://test-sample.openai.azure.com", + "deploymentId": "model", + "apiKey": "api-key", + "modelName": "text-embedding-3-large" + } + }, + { + "name": "custom-web-api", + "kind": "customWebApi", + "customWebApiParameters": { + "httpMethod": "POST", + "uri": "https://my-custom-endpoint.org/", + "timeout": "PT1M", + "authResourceId": "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", + "httpHeaders": { + "header1": "value1", + "header2": "value2" + }, + "authIdentity": { + "@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity" + } + } + }, + { + "name": "aml", + "kind": "aml", + "amlParameters": { + "resourceId": "aml resource id", + "region": "aml region", + "uri": "https://my-custom-endpoint.org/", + "timeout": "PT1M", + "modelName": "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32" + } + } + ], + "compressions": [ + { + "name": "mySQ8", + "kind": "scalarQuantization", + "truncationDimension": 2, + "scalarQuantizationParameters": { + "quantizedDataType": "int8" + }, + "rescoringOptions": { + "enableRescoring": true, + "defaultOversampling": 10.0, + "rescoreStorageMethod": "preserveOriginals" + } + }, + { + "name": "myBQC", + "kind": "binaryQuantization", + "truncationDimension": 2, + "rescoringOptions": { + "enableRescoring": true, + "defaultOversampling": 10.0, + "rescoreStorageMethod": "preserveOriginals" + } + } + ] + } + } + }, + "201": { + "body": { + "name": "temp-preview-test", + "fields": [ + { + "name": "id", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": true, + "synonymMaps": [] + }, + { + "name": "vector1", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 20, + "vectorSearchProfile": "config1", + "synonymMaps": [] + }, + { + "name": "vector1b", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 10, + "vectorSearchProfile": "config2", + "synonymMaps": [] + }, + { + "name": "vector2", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 5, + "vectorSearchProfile": "config3", + "synonymMaps": [] + }, + { + "name": "vector3", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 5, + "vectorSearchProfile": "config3", + "synonymMaps": [] + }, + { + "name": "vector22", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 10, + "vectorSearchProfile": "config2", + "synonymMaps": [] + }, + { + "name": "name", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "standard.lucene", + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + }, + { + "name": "ownerId", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "stringFieldBoost", + "functionAggregation": "sum", + "text": { + "weights": { + "name": 3.0, + "description": 1.0, + "category": 2.0, + "ownerId": 1.0 + } + }, + "functions": [ + { + "fieldName": "category", + "interpolation": "linear", + "type": "tag", + "boost": 2.0, + "tag": { + "tagsParameter": "categoryTag" + } + } + ] + } + ], + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "category", + "ownerId" + ] + } + ], + "analyzers": [ + { + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "name": "tagsAnalyzer", + "tokenizer": "standard_v2", + "tokenFilters": [ + "common_grams" + ], + "charFilters": [ + "html_strip" + ] + } + ], + "normalizers": [], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.BM25Similarity" + }, + "semantic": { + "configurations": [] + }, + "vectorSearch": { + "algorithms": [ + { + "name": "cosine", + "kind": "hnsw", + "hnswParameters": { + "metric": "cosine", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "euclidean", + "kind": "hnsw", + "hnswParameters": { + "metric": "euclidean", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "dotProduct", + "kind": "hnsw", + "hnswParameters": { + "metric": "dotProduct", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + } + ], + "profiles": [ + { + "name": "config1", + "algorithm": "cosine", + "vectorizer": "openai", + "compression": "mySQ8" + }, + { + "name": "config2", + "algorithm": "euclidean", + "vectorizer": "custom-web-api", + "compression": "mySQ8" + }, + { + "name": "config3", + "algorithm": "dotProduct", + "vectorizer": "custom-web-api", + "compression": "myBQC" + } + ], + "vectorizers": [ + { + "name": "openai", + "kind": "azureOpenAI", + "azureOpenAIParameters": { + "resourceUri": "https://test-sample.openai.azure.com", + "deploymentId": "model", + "apiKey": "api-key", + "modelName": "text-embedding-3-large" + } + }, + { + "name": "custom-web-api", + "kind": "customWebApi", + "customWebApiParameters": { + "httpMethod": "POST", + "uri": "https://my-custom-endpoint.org/", + "timeout": "PT1M", + "authResourceId": "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", + "httpHeaders": { + "header1": "value1", + "header2": "value2" + }, + "authIdentity": { + "@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity" + } + } + }, + { + "name": "aml", + "kind": "aml", + "amlParameters": { + "resourceId": "aml resource id", + "region": "aml region", + "uri": "https://my-custom-endpoint.org/", + "timeout": "PT1M", + "modelName": "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32" + } + } + ], + "compressions": [ + { + "name": "mySQ8", + "kind": "scalarQuantization", + "truncationDimension": 2, + "scalarQuantizationParameters": { + "quantizedDataType": "int8" + }, + "rescoringOptions": { + "enableRescoring": true, + "defaultOversampling": 10.0, + "rescoreStorageMethod": "preserveOriginals" + } + }, + { + "name": "myBQC", + "kind": "binaryQuantization", + "truncationDimension": 2, + "rescoringOptions": { + "enableRescoring": true, + "defaultOversampling": 10.0, + "rescoreStorageMethod": "preserveOriginals" + } + } + ] + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateIndexer.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateIndexer.json new file mode 100644 index 000000000000..5eaefa934ef2 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateIndexer.json @@ -0,0 +1,115 @@ +{ + "operationId": "Indexers_CreateOrUpdate", + "title": "SearchServiceCreateOrUpdateIndexer", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2024-11-01-preview", + "ignoreResetRequirements": null, + "disableCacheReprocessingChangeDetection": null, + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "If-Match": null, + "If-None-Match": null, + "Prefer": "return=representation", + "indexer": { + "name": "myindexer", + "description": "Description of the indexer", + "dataSourceName": "mydocdbdatasource", + "skillsetName": "myskillset", + "targetIndexName": "preview-test", + "schedule": { + "interval": "P1D" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5, + "configuration": { + "parsingMode": "markdown", + "markdownParsingSubmode": "oneToOne" + } + }, + "fieldMappings": [], + "outputFieldMappings": [], + "disabled": false, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + }, + "responses": { + "201": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "myindexer", + "description": "Description of the indexer", + "dataSourceName": "mydocdbdatasource", + "skillsetName": "myskillset", + "targetIndexName": "preview-test", + "disabled": false, + "schedule": { + "interval": "P1D", + "startTime": "2024-06-06T00:01:50.265Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5, + "configuration": { + "parsingMode": "markdown", + "markdownParsingSubmode": "oneToOne" + } + }, + "fieldMappings": [], + "outputFieldMappings": [], + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + }, + "200": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "myindexer", + "description": "Description of the indexer", + "dataSourceName": "mydocdbdatasource", + "skillsetName": "myskillset", + "targetIndexName": "preview-test", + "disabled": false, + "schedule": { + "interval": "P1D", + "startTime": "2024-06-06T00:01:50.265Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5, + "configuration": { + "parsingMode": "markdown", + "markdownParsingSubmode": "oneToOne" + } + }, + "fieldMappings": [], + "outputFieldMappings": [], + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateSkillset.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateSkillset.json new file mode 100644 index 000000000000..0385859a626e --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateSkillset.json @@ -0,0 +1,440 @@ +{ + "operationId": "Skillsets_CreateOrUpdate", + "title": "SearchServiceCreateOrUpdateSkillset", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "skillsetName": "tempskillset", + "api-version": "2024-11-01-preview", + "ignoreResetRequirements": null, + "disableCacheReprocessingChangeDetection": null, + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "If-Match": null, + "If-None-Match": null, + "Prefer": "return=representation", + "skillset": { + "name": "tempskillset", + "description": "Skillset for extracting entities and more", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "skill2", + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "countryHint", + "source": "/document/countryHint" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "textSplitMode": "pages", + "maximumPageLength": 4000, + "unit": "azureOpenAITokens", + "azureOpenAITokenizerParameters": { + "encoderModelName": "cl100k_base", + "allowedSpecialTokens": [ + "[START]", + "[END]" + ] + }, + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "skill3", + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "skill4", + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ] + }, + { + "uri": "https://contoso.example.org/", + "httpMethod": "POST", + "timeout": "PT5S", + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "skill5", + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ] + }, + { + "outputMode": "oneToMany", + "markdownHeaderDepth": "h3", + "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill", + "name": "docIntelligenceLayoutSkill", + "context": "/document", + "inputs": [ + { + "name": "file_data", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "markdown_document", + "targetName": "markdown_document" + } + ] + } + ], + "cognitiveServices": { + "key": "myKey", + "subdomainUrl": "https://mySubdomainName.cognitiveservices.azure.com", + "@odata.type": "#Microsoft.Azure.Search.AIServicesByKey" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + }, + "responses": { + "200": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "tempskillset", + "description": "Skillset for extracting entities and more", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "skill2", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "countryHint", + "source": "/document/countryHint", + "inputs": [] + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "skill3", + "textSplitMode": "pages", + "maximumPageLength": 4000, + "unit": "azureOpenAITokens", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "azureOpenAITokenizerParameters": { + "encoderModelName": "cl100k_base", + "allowedSpecialTokens": [ + "[START]", + "[END]" + ] + } + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "skill4", + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "skill5", + "uri": "https://contoso.example.org/", + "httpMethod": "POST", + "timeout": "PT5S", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill", + "name": "docIntelligenceLayoutSkill", + "context": "/document", + "outputMode": "oneToMany", + "markdownHeaderDepth": "h3", + "inputs": [ + { + "name": "file_data", + "source": "/document/content", + "inputs": [] + } + ], + "outputs": [ + { + "name": "markdown_document", + "targetName": "markdown_document" + } + ] + } + ], + "cognitiveServices": { + "@odata.type": "#Microsoft.Azure.Search.AIServicesByKey", + "key": "myKey", + "subdomainUrl": "https://mySubdomainName.cognitiveservices.azure.com" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + }, + "201": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "tempskillset", + "description": "Skillset for extracting entities and more", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "skill2", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "countryHint", + "source": "/document/countryHint", + "inputs": [] + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "skill3", + "textSplitMode": "pages", + "maximumPageLength": 4000, + "unit": "azureOpenAITokens", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "azureOpenAITokenizerParameters": { + "encoderModelName": "cl100k_base", + "allowedSpecialTokens": [ + "[START]", + "[END]" + ] + } + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "skill4", + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "skill5", + "uri": "https://contoso.example.org/", + "httpMethod": "POST", + "timeout": "PT5S", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill", + "name": "docIntelligenceLayoutSkill", + "context": "/document", + "outputMode": "oneToMany", + "markdownHeaderDepth": "h3", + "inputs": [ + { + "name": "file_data", + "source": "/document/content", + "inputs": [] + } + ], + "outputs": [ + { + "name": "markdown_document", + "targetName": "markdown_document" + } + ] + } + ], + "cognitiveServices": { + "@odata.type": "#Microsoft.Azure.Search.AIServicesByKey", + "key": "myKey", + "subdomainUrl": "https://mySubdomainName.cognitiveservices.azure.com" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateSynonymMap.json new file mode 100644 index 000000000000..7e14a451af29 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateSynonymMap.json @@ -0,0 +1,63 @@ +{ + "operationId": "SynonymMaps_CreateOrUpdate", + "title": "SearchServiceCreateOrUpdateSynonymMap", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "synonymMapName": "mysynonymmap", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "If-Match": null, + "If-None-Match": null, + "Prefer": "return=representation", + "synonymMap": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + }, + "responses": { + "200": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + }, + "201": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateSkillset.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateSkillset.json new file mode 100644 index 000000000000..4204b09bc7a2 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateSkillset.json @@ -0,0 +1,288 @@ +{ + "operationId": "Skillsets_Create", + "title": "SearchServiceCreateSkillset", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "skillset": { + "name": "tempskillset", + "description": "Skillset for extracting entities and more", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "skill2", + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "countryHint", + "source": "/document/countryHint" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "textSplitMode": "pages", + "maximumPageLength": 4000, + "unit": "azureOpenAITokens", + "azureOpenAITokenizerParameters": { + "encoderModelName": "cl100k_base", + "allowedSpecialTokens": [ + "[START]", + "[END]" + ] + }, + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "skill3", + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "skill4", + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ] + }, + { + "uri": "https://contoso.example.org/", + "httpMethod": "POST", + "timeout": "PT5S", + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "skill5", + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ] + }, + { + "outputMode": "oneToMany", + "markdownHeaderDepth": "h3", + "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill", + "name": "docIntelligenceLayoutSkill", + "context": "/document", + "inputs": [ + { + "name": "file_data", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "markdown_document", + "targetName": "markdown_document" + } + ] + } + ], + "cognitiveServices": { + "key": "myKey", + "subdomainUrl": "https://mySubdomainName.cognitiveservices.azure.com", + "@odata.type": "#Microsoft.Azure.Search.AIServicesByKey" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "tempskillset", + "description": "Skillset for extracting entities and more", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "skill2", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "countryHint", + "source": "/document/countryHint", + "inputs": [] + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "skill3", + "textSplitMode": "pages", + "maximumPageLength": 4000, + "unit": "azureOpenAITokens", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "azureOpenAITokenizerParameters": { + "encoderModelName": "cl100k_base", + "allowedSpecialTokens": [ + "[START]", + "[END]" + ] + } + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "skill4", + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "skill5", + "uri": "https://contoso.example.org/", + "httpMethod": "POST", + "timeout": "PT5S", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill", + "name": "docIntelligenceLayoutSkill", + "context": "/document", + "outputMode": "oneToMany", + "markdownHeaderDepth": "h3", + "inputs": [ + { + "name": "file_data", + "source": "/document/content", + "inputs": [] + } + ], + "outputs": [ + { + "name": "markdown_document", + "targetName": "markdown_document" + } + ] + } + ], + "cognitiveServices": { + "@odata.type": "#Microsoft.Azure.Search.AIServicesByKey", + "key": "myKey", + "subdomainUrl": "https://mySubdomainName.cognitiveservices.azure.com" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateSynonymMap.json new file mode 100644 index 000000000000..9ee48aae761b --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateSynonymMap.json @@ -0,0 +1,42 @@ +{ + "operationId": "SynonymMaps_Create", + "title": "SearchServiceCreateSynonymMap", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "synonymMap": { + "name": "tempsynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + }, + "responses": { + "201": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "tempsynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteAlias.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteAlias.json new file mode 100644 index 000000000000..889089824926 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteAlias.json @@ -0,0 +1,16 @@ +{ + "operationId": "Aliases_Delete", + "title": "SearchServiceDeleteAlias", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "aliasName": "tempalias", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "If-Match": null, + "If-None-Match": null + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteDataSource.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteDataSource.json new file mode 100644 index 000000000000..4d2d7eca9289 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteDataSource.json @@ -0,0 +1,16 @@ +{ + "operationId": "DataSources_Delete", + "title": "SearchServiceDeleteDataSource", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "dataSourceName": "tempdatasource", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "If-Match": null, + "If-None-Match": null + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteIndex.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteIndex.json new file mode 100644 index 000000000000..cd5240a09a9e --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteIndex.json @@ -0,0 +1,16 @@ +{ + "operationId": "Indexes_Delete", + "title": "SearchServiceDeleteIndex", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexName": "temp-preview-test", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "If-Match": null, + "If-None-Match": null + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteIndexer.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteIndexer.json new file mode 100644 index 000000000000..ecc4f149f674 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteIndexer.json @@ -0,0 +1,16 @@ +{ + "operationId": "Indexers_Delete", + "title": "SearchServiceDeleteIndexer", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexerName": "tempindexer", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "If-Match": null, + "If-None-Match": null + }, + "responses": { + "404": {}, + "204": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteSkillset.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteSkillset.json new file mode 100644 index 000000000000..9b43b2af7df4 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteSkillset.json @@ -0,0 +1,16 @@ +{ + "operationId": "Skillsets_Delete", + "title": "SearchServiceDeleteSkillset", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "skillsetName": "tempskillset", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "If-Match": null, + "If-None-Match": null + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteSynonymMap.json new file mode 100644 index 000000000000..53b4c7485013 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteSynonymMap.json @@ -0,0 +1,16 @@ +{ + "operationId": "SynonymMaps_Delete", + "title": "SearchServiceDeleteSynonymMap", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "synonymMapName": "tempsynonymmap", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "If-Match": null, + "If-None-Match": null + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetAlias.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetAlias.json new file mode 100644 index 000000000000..8bdef8764719 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetAlias.json @@ -0,0 +1,20 @@ +{ + "operationId": "Aliases_Get", + "title": "SearchServiceGetAlias", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "aliasName": "myalias", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "myalias", + "indexes": [ + "preview-test" + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetDataSource.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetDataSource.json new file mode 100644 index 000000000000..903cb9f52307 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetDataSource.json @@ -0,0 +1,45 @@ +{ + "operationId": "DataSources_Get", + "title": "SearchServiceGetDataSource", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "dataSourceName": "mydocdbdatasource", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "mydocdbdatasource", + "description": "My Azure Blob data source.", + "type": "azureblob", + "credentials": { + "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net " + }, + "container": { + "name": "doc-extraction-skillset", + "query": "E2E_Dsat" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "metadata_storage_last_modified" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndex.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndex.json new file mode 100644 index 000000000000..adb39be8a2f1 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndex.json @@ -0,0 +1,331 @@ +{ + "operationId": "Indexes_Get", + "title": "SearchServiceGetIndex", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexName": "preview-test", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "preview-test", + "fields": [ + { + "name": "id", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": true, + "synonymMaps": [] + }, + { + "name": "vector1", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 20, + "vectorSearchProfile": "config1", + "synonymMaps": [] + }, + { + "name": "vector1b", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 10, + "vectorSearchProfile": "config2", + "synonymMaps": [] + }, + { + "name": "vector2", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 5, + "vectorSearchProfile": "config3", + "synonymMaps": [] + }, + { + "name": "vector3", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 5, + "vectorSearchProfile": "config3", + "synonymMaps": [] + }, + { + "name": "vector22", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 10, + "vectorSearchProfile": "config2", + "synonymMaps": [] + }, + { + "name": "name", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "standard.lucene", + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + }, + { + "name": "ownerId", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "stringFieldBoost", + "functionAggregation": "sum", + "text": { + "weights": { + "name": 3.0, + "description": 1.0, + "category": 2.0, + "ownerId": 1.0 + } + }, + "functions": [ + { + "fieldName": "category", + "interpolation": "linear", + "type": "tag", + "boost": 2.0, + "tag": { + "tagsParameter": "categoryTag" + } + } + ] + } + ], + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "category", + "ownerId" + ] + } + ], + "analyzers": [ + { + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "name": "tagsAnalyzer", + "tokenizer": "standard_v2", + "tokenFilters": [ + "common_grams" + ], + "charFilters": [ + "html_strip" + ] + } + ], + "normalizers": [], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.BM25Similarity" + }, + "semantic": { + "configurations": [] + }, + "vectorSearch": { + "algorithms": [ + { + "name": "cosine", + "kind": "hnsw", + "hnswParameters": { + "metric": "cosine", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "euclidean", + "kind": "hnsw", + "hnswParameters": { + "metric": "euclidean", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "dotProduct", + "kind": "hnsw", + "hnswParameters": { + "metric": "dotProduct", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + } + ], + "profiles": [ + { + "name": "config1", + "algorithm": "cosine", + "vectorizer": "openai", + "compression": "mySQ8" + }, + { + "name": "config2", + "algorithm": "euclidean", + "vectorizer": "custom-web-api", + "compression": "mySQ8" + }, + { + "name": "config3", + "algorithm": "dotProduct", + "vectorizer": "custom-web-api", + "compression": "myBQC" + } + ], + "vectorizers": [ + { + "name": "openai", + "kind": "azureOpenAI", + "azureOpenAIParameters": { + "resourceUri": "https://test-sample.openai.azure.com", + "deploymentId": "model", + "apiKey": "<redacted>", + "modelName": "text-embedding-3-large" + } + }, + { + "name": "custom-web-api", + "kind": "customWebApi", + "customWebApiParameters": { + "httpMethod": "POST", + "uri": "https://my-custom-endpoint.org/", + "timeout": "PT1M", + "authResourceId": "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", + "httpHeaders": { + "header1": "value1", + "header2": "value2" + }, + "authIdentity": { + "@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity" + } + } + }, + { + "name": "aml", + "kind": "aml", + "amlParameters": { + "resourceId": "aml resource id", + "region": "aml region", + "uri": "https://my-custom-endpoint.org/", + "timeout": "PT1M", + "modelName": "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32" + } + } + ], + "compressions": [ + { + "name": "mySQ8", + "kind": "scalarQuantization", + "truncationDimension": 2, + "scalarQuantizationParameters": { + "quantizedDataType": "int8" + }, + "rescoringOptions": { + "enableRescoring": true, + "defaultOversampling": 10.0, + "rescoreStorageMethod": "preserveOriginals" + } + }, + { + "name": "myBQC", + "kind": "binaryQuantization", + "truncationDimension": 2, + "rescoringOptions": { + "enableRescoring": true, + "defaultOversampling": 10.0, + "rescoreStorageMethod": "preserveOriginals" + } + } + ] + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndexStatistics.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndexStatistics.json new file mode 100644 index 000000000000..edca0dc5aa5b --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndexStatistics.json @@ -0,0 +1,19 @@ +{ + "operationId": "Indexes_GetStatistics", + "title": "SearchServiceGetIndexStatistics", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexName": "preview-test", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "documentCount": 12, + "storageSize": 123456, + "vectorIndexSize": 123456 + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndexer.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndexer.json new file mode 100644 index 000000000000..b7f67eff7c54 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndexer.json @@ -0,0 +1,43 @@ +{ + "operationId": "Indexers_Get", + "title": "SearchServiceGetIndexer", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "myindexer", + "description": "Description of the indexer", + "dataSourceName": "mydocdbdatasource", + "skillsetName": "myskillset", + "targetIndexName": "preview-test", + "disabled": false, + "schedule": { + "interval": "P1D", + "startTime": "2024-06-06T00:01:50.265Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5, + "configuration": {} + }, + "fieldMappings": [], + "outputFieldMappings": [], + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndexerStatus.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndexerStatus.json new file mode 100644 index 000000000000..801414653941 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndexerStatus.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2024-11-01-preview" + }, + "responses": { + "200": { + "body": { + "status": "running", + "lastResult": { + "status": "success", + "errorMessage": null, + "startTime": "2014-11-26T03:37:18.853Z", + "endTime": "2014-11-26T03:37:19.012Z", + "errors": [], + "warnings": [], + "itemsProcessed": 11, + "itemsFailed": 0, + "initialTrackingState": null, + "finalTrackingState": null + }, + "executionHistory": [ + { + "status": "success", + "errorMessage": null, + "startTime": "2014-11-26T03:37:18.853Z", + "endTime": "2014-11-26T03:37:19.012Z", + "errors": [], + "warnings": [], + "itemsProcessed": 11, + "itemsFailed": 0, + "initialTrackingState": null, + "finalTrackingState": null + }, + { + "status": "transientFailure", + "errorMessage": null, + "startTime": "2014-11-26T03:28:10.125Z", + "endTime": "2014-11-26T03:28:12.007Z", + "errors": [ + { + "key": "", + "errorMessage": "Document key cannot be missing or empty.", + "statusCode": 400, + "name": null, + "details": null, + "documentationLink": null + }, + { + "key": "document id 1", + "errorMessage": "Could not read the value of column 'foo' at index '0'.", + "statusCode": 400, + "name": "DocumentExtraction.AzureBlob.MyDataSource", + "details": "The file could not be parsed.", + "documentationLink": "https://go.microsoft.com/fwlink/?linkid=2049388" + } + ], + "warnings": [ + { + "key": "document id", + "message": "A warning doesn't stop indexing, and is intended to inform you of certain interesting situations, like when a blob indexer truncates the amount of text extracted from a blob.", + "name": null, + "details": null, + "documentationLink": null + }, + { + "key": "document id 2", + "message": "Document was truncated to 50000 characters.", + "name": "Enrichment.LanguageDetectionSkill.#4", + "details": "The skill did something that didn't break anything, nonetheless something we didn't expect happened, so it might be worth double checking.", + "documentationLink": "https://go.microsoft.com/fwlink/?linkid=2099692" + } + ], + "itemsProcessed": 1, + "itemsFailed": 2, + "initialTrackingState": null, + "finalTrackingState": null + } + ], + "limits": { + "maxRunTime": "PT22H", + "maxDocumentExtractionSize": 256000000, + "maxDocumentContentCharactersToExtract": 4000000 + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetServiceStatistics.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetServiceStatistics.json new file mode 100644 index 000000000000..4122c86506f5 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetServiceStatistics.json @@ -0,0 +1,58 @@ +{ + "operationId": "GetServiceStatistics", + "title": "SearchServiceGetServiceStatistics", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "counters": { + "documentCount": { + "usage": 12 + }, + "indexesCount": { + "usage": 2, + "quota": 2 + }, + "indexersCount": { + "usage": 2, + "quota": 2 + }, + "dataSourcesCount": { + "usage": 2, + "quota": 2 + }, + "storageSize": { + "usage": 123456, + "quota": 10485760 + }, + "synonymMaps": { + "usage": 3, + "quota": 3 + }, + "skillsetCount": { + "usage": 2, + "quota": 2 + }, + "aliasesCount": { + "usage": 4, + "quota": 4 + }, + "vectorIndexSize": { + "usage": 123456 + } + }, + "limits": { + "maxStoragePerIndex": 10485760, + "maxFieldsPerIndex": 1000, + "maxFieldNestingDepthPerIndex": 10, + "maxComplexCollectionFieldsPerIndex": 40, + "maxComplexObjectsInCollectionsPerDocument": 3000 + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetSkillset.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetSkillset.json new file mode 100644 index 000000000000..f5460462a599 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetSkillset.json @@ -0,0 +1,161 @@ +{ + "operationId": "Skillsets_Get", + "title": "SearchServiceGetSkillset", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "skillsetName": "myskillset", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "myskillset", + "description": "Skillset for extracting entities and more", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "skill2", + "context": "/document", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "countryHint", + "source": "/document/countryHint", + "inputs": [] + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "skill3", + "context": "/document", + "defaultLanguageCode": "en", + "textSplitMode": "pages", + "maximumPageLength": 4000, + "pageOverlapLength": 0, + "maximumPagesToTake": 0, + "unit": "azureOpenAITokens", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "azureOpenAITokenizerParameters": { + "encoderModelName": "cl100k_base", + "allowedSpecialTokens": [ + "[START]", + "[END]" + ] + } + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "skill4", + "context": "/document/pages/*", + "defaultLanguageCode": "en", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "skill5", + "context": "/document", + "uri": "https://contoso.example.org/", + "httpMethod": "POST", + "timeout": "PT5S", + "batchSize": 1000, + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + }, + { + "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill", + "name": "docIntelligenceLayoutSkill", + "context": "/document", + "outputMode": "oneToMany", + "markdownHeaderDepth": "h3", + "inputs": [ + { + "name": "file_data", + "source": "/document/content", + "inputs": [] + } + ], + "outputs": [ + { + "name": "markdown_document", + "targetName": "markdown_document" + } + ] + } + ], + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetSynonymMap.json new file mode 100644 index 000000000000..dafbceb70d0d --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetSynonymMap.json @@ -0,0 +1,29 @@ +{ + "operationId": "SynonymMaps_Get", + "title": "SearchServiceGetSynonymMap", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "synonymMapName": "mysynonymmap", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceIndexAnalyze.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceIndexAnalyze.json new file mode 100644 index 000000000000..f990fed87fd6 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceIndexAnalyze.json @@ -0,0 +1,40 @@ +{ + "operationId": "Indexes_Analyze", + "title": "SearchServiceIndexAnalyze", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexName": "preview-test", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "request": { + "text": "Text to analyze", + "analyzer": "ar.lucene" + } + }, + "responses": { + "200": { + "body": { + "tokens": [ + { + "token": "text", + "startOffset": 0, + "endOffset": 4, + "position": 0 + }, + { + "token": "to", + "startOffset": 5, + "endOffset": 7, + "position": 1 + }, + { + "token": "analyze", + "startOffset": 8, + "endOffset": 15, + "position": 2 + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListAliases.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListAliases.json new file mode 100644 index 000000000000..69c9ecb9b00c --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListAliases.json @@ -0,0 +1,23 @@ +{ + "operationId": "Aliases_List", + "title": "SearchServiceListAliases", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myalias", + "indexes": [ + "preview-test" + ] + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListDataSources.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListDataSources.json new file mode 100644 index 000000000000..845e2dd9704e --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListDataSources.json @@ -0,0 +1,49 @@ +{ + "operationId": "DataSources_List", + "title": "SearchServiceListDataSources", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "$select": null, + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "@odata.etag": "0x1234568AE7E58A1", + "name": "mydocdbdatasource", + "description": "My Azure Blob data source.", + "type": "azureblob", + "credentials": { + "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net " + }, + "container": { + "name": "doc-extraction-skillset", + "query": "E2E_Dsat" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "metadata_storage_last_modified" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListIndexers.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListIndexers.json new file mode 100644 index 000000000000..ee4a73b3eed5 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListIndexers.json @@ -0,0 +1,46 @@ +{ + "operationId": "Indexers_List", + "title": "SearchServiceListIndexers", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "$select": "*", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myindexer", + "description": "Description of the indexer", + "dataSourceName": "mydocdbdatasource", + "skillsetName": "myskillset", + "targetIndexName": "preview-test", + "disabled": false, + "schedule": { + "interval": "P1D", + "startTime": "2024-06-06T00:01:50.265Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5, + "configuration": {} + }, + "fieldMappings": [], + "outputFieldMappings": [], + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListIndexes.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListIndexes.json new file mode 100644 index 000000000000..b633eb879d39 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListIndexes.json @@ -0,0 +1,335 @@ +{ + "operationId": "Indexes_List", + "title": "SearchServiceListIndexes", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "$select": null, + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "@odata.etag": "0x1234568AE7E58A1", + "name": "preview-test", + "fields": [ + { + "name": "id", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": true, + "synonymMaps": [] + }, + { + "name": "vector1", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 20, + "vectorSearchProfile": "config1", + "synonymMaps": [] + }, + { + "name": "vector1b", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 10, + "vectorSearchProfile": "config2", + "synonymMaps": [] + }, + { + "name": "vector2", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 5, + "vectorSearchProfile": "config3", + "synonymMaps": [] + }, + { + "name": "vector3", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 5, + "vectorSearchProfile": "config3", + "synonymMaps": [] + }, + { + "name": "vector22", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 10, + "vectorSearchProfile": "config2", + "synonymMaps": [] + }, + { + "name": "name", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "standard.lucene", + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + }, + { + "name": "ownerId", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "stringFieldBoost", + "functionAggregation": "sum", + "text": { + "weights": { + "name": 3.0, + "description": 1.0, + "category": 2.0, + "ownerId": 1.0 + } + }, + "functions": [ + { + "fieldName": "category", + "interpolation": "linear", + "type": "tag", + "boost": 2.0, + "tag": { + "tagsParameter": "categoryTag" + } + } + ] + } + ], + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "category", + "ownerId" + ] + } + ], + "analyzers": [ + { + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "name": "tagsAnalyzer", + "tokenizer": "standard_v2", + "tokenFilters": [ + "common_grams" + ], + "charFilters": [ + "html_strip" + ] + } + ], + "normalizers": [], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.BM25Similarity" + }, + "semantic": { + "configurations": [] + }, + "vectorSearch": { + "algorithms": [ + { + "name": "cosine", + "kind": "hnsw", + "hnswParameters": { + "metric": "cosine", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "euclidean", + "kind": "hnsw", + "hnswParameters": { + "metric": "euclidean", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "dotProduct", + "kind": "hnsw", + "hnswParameters": { + "metric": "dotProduct", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + } + ], + "profiles": [ + { + "name": "config1", + "algorithm": "cosine", + "vectorizer": "openai", + "compression": "mySQ8" + }, + { + "name": "config2", + "algorithm": "euclidean", + "vectorizer": "custom-web-api", + "compression": "mySQ8" + }, + { + "name": "config3", + "algorithm": "dotProduct", + "vectorizer": "custom-web-api", + "compression": "myBQC" + } + ], + "vectorizers": [ + { + "name": "openai", + "kind": "azureOpenAI", + "azureOpenAIParameters": { + "resourceUri": "https://test-sample.openai.azure.com", + "deploymentId": "model", + "apiKey": "<redacted>", + "modelName": "text-embedding-3-large" + } + }, + { + "name": "custom-web-api", + "kind": "customWebApi", + "customWebApiParameters": { + "httpMethod": "POST", + "uri": "https://my-custom-endpoint.org/", + "timeout": "PT1M", + "authResourceId": "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", + "httpHeaders": { + "header1": "value1", + "header2": "value2" + }, + "authIdentity": { + "@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity" + } + } + }, + { + "name": "aml", + "kind": "aml", + "amlParameters": { + "resourceId": "aml resource id", + "region": "aml region", + "uri": "https://my-custom-endpoint.org/", + "timeout": "PT1M", + "modelName": "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32" + } + } + ], + "compressions": [ + { + "name": "mySQ8", + "kind": "scalarQuantization", + "truncationDimension": 2, + "scalarQuantizationParameters": { + "quantizedDataType": "int8" + }, + "rescoringOptions": { + "enableRescoring": true, + "defaultOversampling": 10.0, + "rescoreStorageMethod": "preserveOriginals" + } + }, + { + "name": "myBQC", + "kind": "binaryQuantization", + "truncationDimension": 2, + "rescoringOptions": { + "enableRescoring": true, + "defaultOversampling": 10.0, + "rescoreStorageMethod": "preserveOriginals" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListSkillsets.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListSkillsets.json new file mode 100644 index 000000000000..f3a1fcbe4306 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListSkillsets.json @@ -0,0 +1,165 @@ +{ + "operationId": "Skillsets_List", + "title": "SearchServiceListSkillsets", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "$select": null, + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "@odata.etag": "0x1234568AE7E58A1", + "name": "myskillset", + "description": "Skillset for extracting entities and more", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "skill2", + "context": "/document", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "countryHint", + "source": "/document/countryHint", + "inputs": [] + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "skill3", + "context": "/document", + "defaultLanguageCode": "en", + "textSplitMode": "pages", + "maximumPageLength": 4000, + "pageOverlapLength": 0, + "maximumPagesToTake": 0, + "unit": "azureOpenAITokens", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "azureOpenAITokenizerParameters": { + "encoderModelName": "cl100k_base", + "allowedSpecialTokens": [ + "[START]", + "[END]" + ] + } + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "skill4", + "context": "/document/pages/*", + "defaultLanguageCode": "en", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "skill5", + "context": "/document", + "uri": "https://contoso.example.org/", + "httpMethod": "POST", + "timeout": "PT5S", + "batchSize": 1000, + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + }, + { + "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill", + "name": "docIntelligenceLayoutSkill", + "context": "/document", + "outputMode": "oneToMany", + "markdownHeaderDepth": "h3", + "inputs": [ + { + "name": "file_data", + "source": "/document/content", + "inputs": [] + } + ], + "outputs": [ + { + "name": "markdown_document", + "targetName": "markdown_document" + } + ] + } + ], + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListSynonymMaps.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListSynonymMaps.json new file mode 100644 index 000000000000..5c7b199b818c --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListSynonymMaps.json @@ -0,0 +1,33 @@ +{ + "operationId": "SynonymMaps_List", + "title": "SearchServiceListSynonymMaps", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "$select": null, + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "@odata.etag": "0x1234568AE7E58A1", + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceResetDocs.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceResetDocs.json new file mode 100644 index 000000000000..20a91dd39c69 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceResetDocs.json @@ -0,0 +1,21 @@ +{ + "operationId": "Indexers_ResetDocs", + "title": "SearchServiceResetDocs", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexerName": "myindexer", + "overwrite": true, + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "keysOrIds": { + "documentKeys": [ + "1", + "2", + "3" + ] + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceResetIndexer.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceResetIndexer.json new file mode 100644 index 000000000000..9bbe95f61d97 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceResetIndexer.json @@ -0,0 +1,13 @@ +{ + "operationId": "Indexers_Reset", + "title": "SearchServiceResetIndexer", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "204": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceResetSkills.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceResetSkills.json new file mode 100644 index 000000000000..eb179862b112 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceResetSkills.json @@ -0,0 +1,20 @@ +{ + "operationId": "Skillsets_ResetSkills", + "title": "SearchServiceResetSkills", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "skillsetName": "myskillset", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "skillNames": { + "skillNames": [ + "skill2", + "skill3", + "skill4" + ] + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceRunIndexer.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceRunIndexer.json new file mode 100644 index 000000000000..af555c5787cc --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceRunIndexer.json @@ -0,0 +1,13 @@ +{ + "operationId": "Indexers_Run", + "title": "SearchServiceRunIndexer", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/searchindex.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/searchindex.json new file mode 100644 index 000000000000..181d92e26be4 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/searchindex.json @@ -0,0 +1,3277 @@ +{ + "swagger": "2.0", + "info": { + "title": "SearchIndexClient", + "description": "Client that can be used to query an index and upload, merge, or delete documents.", + "version": "2024-11-01-preview", + "x-ms-code-generation-settings": { + "useDateTimeOffset": true, + "syncMethods": "None" + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/indexes('{indexName}')", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/EndpointParameter" + }, + { + "$ref": "#/parameters/IndexNameParameter" + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/docs/$count": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_Count", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Count-Documents" + }, + "x-ms-examples": { + "SearchIndexCountDocuments": { + "$ref": "./examples/SearchIndexCountDocuments.json" + } + }, + "description": "Queries the number of documents in the index.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "type": "integer", + "format": "int64" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/docs": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_SearchGet", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Search-Documents" + }, + "x-ms-examples": { + "SearchIndexSearchDocumentsGet": { + "$ref": "./examples/SearchIndexSearchDocumentsGet.json" + }, + "SearchIndexSearchDocumentsSemanticGet": { + "$ref": "./examples/SearchIndexSearchDocumentsSemanticGet.json" + } + }, + "description": "Searches for documents in the index.", + "parameters": [ + { + "name": "search", + "in": "query", + "type": "string", + "description": "A full-text search query expression; Use \"*\" or omit this parameter to match all documents.", + "x-ms-client-name": "SearchText" + }, + { + "name": "$count", + "in": "query", + "type": "boolean", + "description": "A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation.", + "x-nullable": false, + "x-ms-client-name": "IncludeTotalResultCount", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "facet", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "description": "The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs.", + "x-ms-client-name": "Facets", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$filter", + "in": "query", + "type": "string", + "description": "The OData $filter expression to apply to the search query.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "highlight", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting.", + "x-ms-client-name": "HighlightFields", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "highlightPostTag", + "in": "query", + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "highlightPreTag", + "in": "query", + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "minimumCoverage", + "in": "query", + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$orderby", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses.", + "x-ms-client-name": "OrderBy", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "queryType", + "in": "query", + "type": "string", + "enum": [ + "simple", + "full", + "semantic" + ], + "x-ms-enum": { + "name": "QueryType", + "modelAsString": false, + "values": [ + { + "value": "simple", + "name": "Simple", + "description": "Uses the simple query syntax for searches. Search text is interpreted using a simple query language that allows for symbols such as +, * and \"\". Queries are evaluated across all searchable fields by default, unless the searchFields parameter is specified." + }, + { + "value": "full", + "name": "Full", + "description": "Uses the full Lucene query syntax for searches. Search text is interpreted using the Lucene query language which allows field-specific and weighted searches, as well as other advanced features." + }, + { + "value": "semantic", + "name": "Semantic", + "description": "Best suited for queries expressed in natural language as opposed to keywords. Improves precision of search results by re-ranking the top search results using a ranking model trained on the Web corpus." + } + ] + }, + "x-nullable": false, + "description": "A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "scoringParameter", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "x-ms-client-name": "ScoringParameters", + "description": "The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be \"mylocation--122.2,44.8\" (without the quotes).", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "scoringProfile", + "in": "query", + "type": "string", + "description": "The name of a scoring profile to evaluate match scores for matching documents in order to sort the results.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "searchFields", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any field names listed in this parameter.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "searchMode", + "in": "query", + "type": "string", + "enum": [ + "any", + "all" + ], + "x-ms-enum": { + "name": "SearchMode", + "modelAsString": false, + "values": [ + { + "value": "any", + "name": "Any", + "description": "Any of the search terms must be matched in order to count the document as a match." + }, + { + "value": "all", + "name": "All", + "description": "All of the search terms must be matched in order to count the document as a match." + } + ] + }, + "x-nullable": false, + "description": "A value that specifies whether any or all of the search terms must be matched in order to count the document as a match.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "scoringStatistics", + "in": "query", + "type": "string", + "enum": [ + "local", + "global" + ], + "x-ms-enum": { + "name": "ScoringStatistics", + "modelAsString": false, + "values": [ + { + "value": "local", + "name": "Local", + "description": "The scoring statistics will be calculated locally for lower latency." + }, + { + "value": "global", + "name": "Global", + "description": "The scoring statistics will be calculated globally for more consistent scoring." + } + ] + }, + "x-nullable": false, + "description": "A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower latency.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "sessionId", + "in": "query", + "type": "string", + "description": "A value to be used to create a sticky session, which can help to get more consistent results. As long as the same sessionId is used, a best-effort attempt will be made to target the same replica set. Be wary that reusing the same sessionID values repeatedly can interfere with the load balancing of the requests across replicas and adversely affect the performance of the search service. The value used as sessionId cannot start with a '_' character.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$select", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$skip", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use $skip due to this limitation, consider using $orderby on a totally-ordered key and $filter with a range query instead.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be used to issue another Search request for the next page of results.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "name": "semanticConfiguration", + "in": "query", + "type": "string", + "description": "The name of the semantic configuration that lists which fields should be used for semantic ranking, captions, highlights, and answers", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "semanticErrorHandling", + "in": "query", + "type": "string", + "enum": [ + "partial", + "fail" + ], + "x-ms-enum": { + "name": "SemanticErrorMode", + "modelAsString": true, + "values": [ + { + "value": "partial", + "name": "Partial", + "description": "If the semantic processing fails, partial results still return. The definition of partial results depends on what semantic step failed and what was the reason for failure." + }, + { + "value": "fail", + "name": "Fail", + "description": "If there is an exception during the semantic processing step, the query will fail and return the appropriate HTTP code depending on the error." + } + ] + }, + "description": "Allows the user to choose whether a semantic call should fail completely, or to return partial results (default).", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "semanticMaxWaitInMilliseconds", + "in": "query", + "type": "integer", + "format": "int32", + "minimum": 700, + "description": "Allows the user to set an upper bound on the amount of time it takes for semantic enrichment to finish processing before the request fails.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "answers", + "in": "query", + "type": "string", + "enum": [ + "none", + "extractive" + ], + "x-ms-enum": { + "name": "QueryAnswerType", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Do not return answers for the query." + }, + { + "value": "extractive", + "name": "Extractive", + "description": "Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language." + } + ] + }, + "description": "This parameter is only valid if the query type is `semantic`. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character `|` followed by the `count-<number of answers>` option after the answers parameter value, such as `extractive|count-3`. Default count is 1. The confidence threshold can be configured by appending the pipe character `|` followed by the `threshold-<confidence threshold>` option after the answers parameter value, such as `extractive|threshold-0.9`. Default threshold is 0.7. The maximum character length of answers can be configured by appending the pipe character '|' followed by the 'count-<number of maximum character length>', such as 'extractive|maxcharlength-600'.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "captions", + "in": "query", + "type": "string", + "enum": [ + "none", + "extractive" + ], + "x-ms-enum": { + "name": "QueryCaptionType", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Do not return captions for the query." + }, + { + "value": "extractive", + "name": "Extractive", + "description": "Extracts captions from the matching documents that contain passages relevant to the search query." + } + ] + }, + "description": "This parameter is only valid if the query type is `semantic`. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to `extractive`, highlighting is enabled by default, and can be configured by appending the pipe character `|` followed by the `highlight-<true/false>` option, such as `extractive|highlight-true`. Defaults to `None`. The maximum character length of captions can be configured by appending the pipe character '|' followed by the 'count-<number of maximum character length>', such as 'extractive|maxcharlength-600'.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "semanticQuery", + "in": "query", + "type": "string", + "description": "Allows setting a separate search query that will be solely used for semantic reranking, semantic captions and semantic answers. Is useful for scenarios where there is a need to use different queries between the base retrieval and ranking phase, and the L2 semantic phase.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "queryRewrites", + "in": "query", + "type": "string", + "enum": [ + "none", + "generative" + ], + "x-ms-enum": { + "name": "QueryRewritesType", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Do not generate additional query rewrites for this query." + }, + { + "value": "generative", + "name": "Generative", + "description": "Generate alternative query terms to increase the recall of a search request." + } + ] + }, + "description": "When QueryRewrites is set to `generative`, the query terms are sent to a generate model which will produce 10 (default) rewrites to help increase the recall of the request. The requested count can be configured by appending the pipe character `|` followed by the `count-<number of rewrites>` option, such as `generative|count-3`. Defaults to `None`. This parameter is only valid if the query type is `semantic`.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "debug", + "in": "query", + "type": "string", + "enum": [ + "disabled", + "semantic", + "vector", + "queryRewrites", + "all" + ], + "x-ms-enum": { + "name": "QueryDebugMode", + "modelAsString": true, + "values": [ + { + "value": "disabled", + "name": "Disabled", + "description": "No query debugging information will be returned." + }, + { + "value": "semantic", + "name": "Semantic", + "description": "Allows the user to further explore their reranked results." + }, + { + "value": "vector", + "name": "Vector", + "description": "Allows the user to further explore their hybrid and vector query results." + }, + { + "value": "queryRewrites", + "name": "QueryRewrites", + "description": "Allows the user to explore the list of query rewrites generated for their search request." + }, + { + "value": "all", + "name": "All", + "description": "Turn on all debug options." + } + ] + }, + "description": "Enables a debugging tool that can be used to further explore your search results.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "queryLanguage", + "in": "query", + "type": "string", + "enum": [ + "none", + "en-us" + ], + "x-ms-enum": { + "name": "QueryLanguage", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Query language not specified." + }, + { + "value": "en-us", + "name": "EnUs", + "description": "English (US)" + } + ] + }, + "description": "The language of the query.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "speller", + "in": "query", + "type": "string", + "enum": [ + "none", + "lexicon" + ], + "x-ms-enum": { + "name": "QuerySpellerType", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Speller not enabled." + }, + { + "value": "lexicon", + "name": "Lexicon", + "description": "Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter." + } + ] + }, + "description": "Improve search recall by spell-correcting individual search query terms.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "semanticFields", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names used for semantic ranking.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing documents that match the search criteria.", + "schema": { + "$ref": "#/definitions/SearchDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/docs/search.post.search": { + "post": { + "tags": [ + "Documents" + ], + "operationId": "Documents_SearchPost", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Search-Documents" + }, + "x-ms-examples": { + "SearchIndexSearchDocumentsPost": { + "$ref": "./examples/SearchIndexSearchDocumentsPost.json" + }, + "SearchIndexSearchDocumentsSemanticPost": { + "$ref": "./examples/SearchIndexSearchDocumentsSemanticPost.json" + } + }, + "description": "Searches for documents in the index.", + "parameters": [ + { + "name": "searchRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchRequest", + "description": "The Search request." + }, + "description": "The definition of the Search request." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing documents that match the search criteria.", + "schema": { + "$ref": "#/definitions/SearchDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/docs('{key}')": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_Get", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/lookup-document" + }, + "x-ms-examples": { + "SearchIndexGetDocument": { + "$ref": "./examples/SearchIndexGetDocument.json" + } + }, + "description": "Retrieves a document from the index.", + "parameters": [ + { + "name": "key", + "in": "path", + "required": true, + "description": "The key of the document to retrieve.", + "type": "string" + }, + { + "name": "$select", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "List of field names to retrieve for the document; Any field not retrieved will be missing from the returned document.", + "x-ms-client-name": "SelectedFields" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "responses": { + "200": { + "description": "Response containing the requested document.", + "schema": { + "$ref": "#/definitions/LookupDocument" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/docs/search.suggest": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_SuggestGet", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/suggestions" + }, + "x-ms-examples": { + "SearchIndexSuggestDocumentsGet": { + "$ref": "./examples/SearchIndexSuggestDocumentsGet.json" + } + }, + "description": "Suggests documents in the index that match the given partial query text.", + "parameters": [ + { + "name": "search", + "in": "query", + "required": true, + "type": "string", + "description": "The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters.", + "x-ms-client-name": "SearchText" + }, + { + "name": "suggesterName", + "in": "query", + "required": true, + "type": "string", + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + { + "name": "$filter", + "in": "query", + "type": "string", + "description": "An OData expression that filters the documents considered for suggestions.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "fuzzy", + "in": "query", + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the suggestions query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy suggestions queries are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching", + "x-nullable": false, + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "highlightPostTag", + "in": "query", + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "highlightPreTag", + "in": "query", + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "minimumCoverage", + "in": "query", + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestions query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "$orderby", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-client-name": "OrderBy", + "description": "The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "searchFields", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to search for the specified search text. Target fields must be included in the specified suggester.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "$select", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of fields to retrieve. If unspecified, only the key field will be included in the results.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of suggestions to retrieve. The value must be a number between 1 and 100. The default is 5.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing suggested documents that match the partial input.", + "schema": { + "$ref": "#/definitions/SuggestDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/docs/search.post.suggest": { + "post": { + "tags": [ + "Documents" + ], + "operationId": "Documents_SuggestPost", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/suggestions" + }, + "x-ms-examples": { + "SearchIndexSuggestDocumentsPost": { + "$ref": "./examples/SearchIndexSuggestDocumentsPost.json" + } + }, + "description": "Suggests documents in the index that match the given partial query text.", + "parameters": [ + { + "name": "suggestRequest", + "in": "body", + "required": true, + "description": "The Suggest request.", + "schema": { + "$ref": "#/definitions/SuggestRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing suggested documents that match the partial input.", + "schema": { + "$ref": "#/definitions/SuggestDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/docs/search.index": { + "post": { + "tags": [ + "Documents" + ], + "operationId": "Documents_Index", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents" + }, + "x-ms-examples": { + "SearchIndexIndexDocuments": { + "$ref": "./examples/SearchIndexIndexDocuments.json" + } + }, + "description": "Sends a batch of document write actions to the index.", + "parameters": [ + { + "name": "batch", + "in": "body", + "description": "The batch of index actions.", + "required": true, + "schema": { + "$ref": "#/definitions/IndexBatch" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing the status of operations for all actions in the batch.", + "schema": { + "$ref": "#/definitions/IndexDocumentsResult" + } + }, + "207": { + "description": "Response containing the status of operations for all actions in the batch.", + "schema": { + "$ref": "#/definitions/IndexDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/docs/search.autocomplete": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_AutocompleteGet", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/autocomplete" + }, + "x-ms-examples": { + "SearchIndexAutocompleteDocumentsGet": { + "$ref": "./examples/SearchIndexAutocompleteDocumentsGet.json" + } + }, + "description": "Autocompletes incomplete query terms based on input text and matching terms in the index.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "search", + "in": "query", + "type": "string", + "required": true, + "description": "The incomplete term which should be auto-completed.", + "x-ms-client-name": "SearchText" + }, + { + "name": "suggesterName", + "in": "query", + "type": "string", + "required": true, + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + { + "name": "autocompleteMode", + "in": "query", + "type": "string", + "x-nullable": false, + "enum": [ + "oneTerm", + "twoTerms", + "oneTermWithContext" + ], + "x-ms-enum": { + "name": "AutocompleteMode", + "modelAsString": false, + "values": [ + { + "value": "oneTerm", + "name": "OneTerm", + "description": "Only one term is suggested. If the query has two terms, only the last term is completed. For example, if the input is 'washington medic', the suggested terms could include 'medicaid', 'medicare', and 'medicine'." + }, + { + "value": "twoTerms", + "name": "TwoTerms", + "description": "Matching two-term phrases in the index will be suggested. For example, if the input is 'medic', the suggested terms could include 'medicare coverage' and 'medical assistant'." + }, + { + "value": "oneTermWithContext", + "name": "OneTermWithContext", + "description": "Completes the last term in a query with two or more terms, where the last two terms are a phrase that exists in the index. For example, if the input is 'washington medic', the suggested terms could include 'washington medicaid' and 'washington medical'." + } + ] + }, + "description": "Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context while producing auto-completed terms.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "$filter", + "in": "query", + "type": "string", + "description": "An OData expression that filters the documents used to produce completed terms for the Autocomplete result.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "fuzzy", + "in": "query", + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "highlightPostTag", + "in": "query", + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "highlightPreTag", + "in": "query", + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "minimumCoverage", + "in": "query", + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "searchFields", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing suggested query terms that complete the partial input.", + "schema": { + "$ref": "#/definitions/AutocompleteResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/docs/search.post.autocomplete": { + "post": { + "tags": [ + "Documents" + ], + "operationId": "Documents_AutocompletePost", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/autocomplete" + }, + "x-ms-examples": { + "SearchIndexAutocompleteDocumentsPost": { + "$ref": "./examples/SearchIndexAutocompleteDocumentsPost.json" + } + }, + "description": "Autocompletes incomplete query terms based on input text and matching terms in the index.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "autocompleteRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AutocompleteRequest" + }, + "description": "The definition of the Autocomplete request." + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing suggested query terms that complete the partial input.", + "schema": { + "$ref": "#/definitions/AutocompleteResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "SuggestDocumentsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SuggestResult" + }, + "readOnly": true, + "x-ms-client-name": "Results", + "description": "The sequence of results returned by the query." + }, + "@search.coverage": { + "type": "number", + "readOnly": true, + "format": "double", + "x-ms-client-name": "Coverage", + "description": "A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not set in the request." + } + }, + "required": [ + "value" + ], + "description": "Response containing suggestion query results from an index." + }, + "SuggestResult": { + "properties": { + "@search.text": { + "type": "string", + "readOnly": true, + "description": "The text of the suggestion result.", + "x-ms-client-name": "Text" + } + }, + "required": [ + "@search.text" + ], + "additionalProperties": true, + "description": "A result containing a document found by a suggestion query, plus associated metadata." + }, + "SearchFacetsResult": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/FacetResult" + } + }, + "readOnly": true + }, + "FacetResult": { + "properties": { + "count": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The approximate count of documents falling within the bucket described by this facet." + }, + "@search.facets": { + "$ref": "#/definitions/SearchFacetsResult", + "readOnly": true, + "x-ms-client-name": "Facets", + "description": "The nested facet query results for the search operation, organized as a collection of buckets for each faceted field; null if the query did not contain any nested facets." + } + }, + "additionalProperties": true, + "description": "A single bucket of a facet query result. Reports the number of documents with a field value falling within a particular range or having a particular value or interval." + }, + "SearchDocumentsResult": { + "properties": { + "@odata.count": { + "type": "integer", + "format": "int64", + "readOnly": true, + "x-ms-client-name": "Count", + "description": "The total count of results found by the search operation, or null if the count was not requested. If present, the count may be greater than the number of results in this response. This can happen if you use the $top or $skip parameters, or if the query can't return all the requested documents in a single response." + }, + "@search.coverage": { + "type": "number", + "format": "double", + "readOnly": true, + "x-ms-client-name": "Coverage", + "description": "A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not specified in the request." + }, + "@search.facets": { + "$ref": "#/definitions/SearchFacetsResult", + "readOnly": true, + "x-ms-client-name": "Facets", + "description": "The facet query results for the search operation, organized as a collection of buckets for each faceted field; null if the query did not include any facet expressions." + }, + "@search.answers": { + "type": "array", + "items": { + "$ref": "#/definitions/AnswerResult" + }, + "readOnly": true, + "x-ms-client-name": "Answers", + "x-nullable": true, + "description": "The answers query results for the search operation; null if the answers query parameter was not specified or set to 'none'." + }, + "@search.debugInfo": { + "$ref": "#/definitions/DebugInfo", + "readOnly": true, + "x-ms-client-name": "DebugInfo", + "x-nullable": true, + "description": "Debug information that applies to the search results as a whole." + }, + "@search.nextPageParameters": { + "$ref": "#/definitions/SearchRequest", + "readOnly": true, + "x-ms-client-name": "NextPageParameters", + "description": "Continuation JSON payload returned when the query can't return all the requested results in a single response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to get the next part of the search response." + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchResult" + }, + "readOnly": true, + "x-ms-client-name": "Results", + "description": "The sequence of results returned by the query." + }, + "@odata.nextLink": { + "type": "string", + "readOnly": true, + "x-ms-client-name": "NextLink", + "description": "Continuation URL returned when the query can't return all the requested results in a single response. You can use this URL to formulate another GET or POST Search request to get the next part of the search response. Make sure to use the same verb (GET or POST) as the request that produced this response." + }, + "@search.semanticPartialResponseReason": { + "$ref": "#/definitions/SemanticPartialResponseReason", + "readOnly": true, + "x-ms-client-name": "SemanticPartialResponseReason", + "description": "Reason that a partial response was returned for a semantic ranking request." + }, + "@search.semanticPartialResponseType": { + "$ref": "#/definitions/SemanticPartialResponseType", + "readOnly": true, + "x-ms-client-name": "SemanticPartialResponseType", + "description": "Type of partial response that was returned for a semantic ranking request." + }, + "@search.semanticQueryRewritesResultType": { + "$ref": "#/definitions/SemanticQueryRewritesResultType", + "readOnly": true, + "x-ms-client-name": "SemanticQueryRewritesResultType", + "description": "Type of query rewrite that was used to retrieve documents." + } + }, + "required": [ + "value" + ], + "description": "Response containing search results from an index." + }, + "SearchResult": { + "properties": { + "@search.score": { + "type": "number", + "format": "double", + "readOnly": true, + "x-ms-client-name": "Score", + "x-nullable": false, + "description": "The relevance score of the document compared to other documents returned by the query." + }, + "@search.rerankerScore": { + "type": "number", + "format": "double", + "readOnly": true, + "x-ms-client-name": "RerankerScore", + "x-nullable": true, + "description": "The relevance score computed by the semantic ranker for the top search results. Search results are sorted by the RerankerScore first and then by the Score. RerankerScore is only returned for queries of type 'semantic'." + }, + "@search.highlights": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + }, + "readOnly": true, + "x-ms-client-name": "Highlights", + "description": "Text fragments from the document that indicate the matching search terms, organized by each applicable field; null if hit highlighting was not enabled for the query." + }, + "@search.captions": { + "type": "array", + "items": { + "$ref": "#/definitions/CaptionResult" + }, + "readOnly": true, + "x-ms-client-name": "Captions", + "x-nullable": true, + "description": "Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type 'semantic'." + }, + "@search.documentDebugInfo": { + "type": "array", + "items": { + "$ref": "#/definitions/DocumentDebugInfo" + }, + "readOnly": true, + "x-ms-client-name": "DocumentDebugInfo", + "x-nullable": true, + "description": "Contains debugging information that can be used to further explore your search results." + } + }, + "required": [ + "@search.score" + ], + "additionalProperties": true, + "description": "Contains a document found by a search query, plus associated metadata." + }, + "LookupDocument": { + "type": "object", + "additionalProperties": true, + "description": "A document retrieved via a document lookup operation." + }, + "IndexBatch": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IndexAction" + }, + "description": "The actions in the batch.", + "x-ms-client-name": "Actions" + } + }, + "required": [ + "value" + ], + "description": "Contains a batch of document write actions to send to the index." + }, + "IndexAction": { + "properties": { + "@search.action": { + "type": "string", + "enum": [ + "upload", + "merge", + "mergeOrUpload", + "delete" + ], + "x-ms-enum": { + "name": "IndexActionType", + "modelAsString": false, + "values": [ + { + "value": "upload", + "name": "Upload", + "description": "Inserts the document into the index if it is new and updates it if it exists. All fields are replaced in the update case." + }, + { + "value": "merge", + "name": "Merge", + "description": "Merges the specified field values with an existing document. If the document does not exist, the merge will fail. Any field you specify in a merge will replace the existing field in the document. This also applies to collections of primitive and complex types." + }, + { + "value": "mergeOrUpload", + "name": "MergeOrUpload", + "description": "Behaves like merge if a document with the given key already exists in the index. If the document does not exist, it behaves like upload with a new document." + }, + { + "value": "delete", + "name": "Delete", + "description": "Removes the specified document from the index. Any field you specify in a delete operation other than the key field will be ignored. If you want to remove an individual field from a document, use merge instead and set the field explicitly to null." + } + ] + }, + "x-ms-client-name": "ActionType", + "x-nullable": false, + "description": "The operation to perform on a document in an indexing batch." + } + }, + "additionalProperties": true, + "description": "Represents an index action that operates on a document." + }, + "IndexingResult": { + "properties": { + "key": { + "type": "string", + "readOnly": true, + "description": "The key of a document that was in the indexing request." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "The error message explaining why the indexing operation failed for the document identified by the key; null if indexing succeeded." + }, + "status": { + "x-ms-client-name": "Succeeded", + "type": "boolean", + "x-nullable": false, + "readOnly": true, + "description": "A value indicating whether the indexing operation succeeded for the document identified by the key." + }, + "statusCode": { + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The status code of the indexing operation. Possible values include: 200 for a successful update or delete, 201 for successful document creation, 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy." + } + }, + "required": [ + "key", + "status", + "statusCode" + ], + "description": "Status of an indexing operation for a single document." + }, + "IndexDocumentsResult": { + "properties": { + "value": { + "x-ms-client-name": "Results", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/IndexingResult" + }, + "description": "The list of status information for each document in the indexing request." + } + }, + "required": [ + "value" + ], + "description": "Response containing the status of operations for all documents in the indexing request." + }, + "QueryDebugMode": { + "type": "string", + "enum": [ + "disabled", + "semantic", + "vector", + "queryRewrites", + "all" + ], + "x-ms-enum": { + "name": "QueryDebugMode", + "modelAsString": true, + "values": [ + { + "value": "disabled", + "name": "Disabled", + "description": "No query debugging information will be returned." + }, + { + "value": "semantic", + "name": "Semantic", + "description": "Allows the user to further explore their reranked results." + }, + { + "value": "vector", + "name": "Vector", + "description": "Allows the user to further explore their hybrid and vector query results." + }, + { + "value": "queryRewrites", + "name": "QueryRewrites", + "description": "Allows the user to explore the list of query rewrites generated for their search request." + }, + { + "value": "all", + "name": "All", + "description": "Turn on all debug options." + } + ] + }, + "description": "Enables a debugging tool that can be used to further explore your search results. You can enable multiple debug modes simultaneously by separating them with a | character, for example: semantic|queryRewrites." + }, + "SearchMode": { + "type": "string", + "enum": [ + "any", + "all" + ], + "x-ms-enum": { + "name": "SearchMode", + "modelAsString": false, + "values": [ + { + "value": "any", + "name": "Any", + "description": "Any of the search terms must be matched in order to count the document as a match." + }, + { + "value": "all", + "name": "All", + "description": "All of the search terms must be matched in order to count the document as a match." + } + ] + }, + "description": "Specifies whether any or all of the search terms must be matched in order to count the document as a match." + }, + "QueryType": { + "type": "string", + "enum": [ + "simple", + "full", + "semantic" + ], + "x-ms-enum": { + "name": "QueryType", + "modelAsString": false, + "values": [ + { + "value": "simple", + "name": "Simple", + "description": "Uses the simple query syntax for searches. Search text is interpreted using a simple query language that allows for symbols such as +, * and \"\". Queries are evaluated across all searchable fields by default, unless the searchFields parameter is specified." + }, + { + "value": "full", + "name": "Full", + "description": "Uses the full Lucene query syntax for searches. Search text is interpreted using the Lucene query language which allows field-specific and weighted searches, as well as other advanced features." + }, + { + "value": "semantic", + "name": "Semantic", + "description": "Best suited for queries expressed in natural language as opposed to keywords. Improves precision of search results by re-ranking the top search results using a ranking model trained on the Web corpus." + } + ] + }, + "description": "Specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax and 'semantic' if query syntax is not needed." + }, + "Speller": { + "type": "string", + "enum": [ + "none", + "lexicon" + ], + "x-ms-enum": { + "name": "QuerySpellerType", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Speller not enabled." + }, + { + "value": "lexicon", + "name": "Lexicon", + "description": "Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter." + } + ] + }, + "description": "Improve search recall by spell-correcting individual search query terms." + }, + "VectorQuery": { + "type": "object", + "discriminator": "kind", + "properties": { + "kind": { + "$ref": "#/definitions/VectorQueryKind", + "description": "The kind of vector query being performed.", + "x-nullable": false + }, + "k": { + "type": "integer", + "format": "int32", + "description": "Number of nearest neighbors to return as top hits." + }, + "fields": { + "type": "string", + "description": "Vector Fields of type Collection(Edm.Single) to be included in the vector searched." + }, + "exhaustive": { + "type": "boolean", + "description": "When true, triggers an exhaustive k-nearest neighbor search across all vectors within the vector index. Useful for scenarios where exact matches are critical, such as determining ground truth values." + }, + "oversampling": { + "type": "number", + "format": "double", + "description": "Oversampling factor. Minimum value is 1. It overrides the 'defaultOversampling' parameter configured in the index definition. It can be set only when 'rerankWithOriginalVectors' is true. This parameter is only permitted when a compression method is used on the underlying vector field." + }, + "weight": { + "type": "number", + "format": "float", + "description": "Relative weight of the vector query when compared to other vector query and/or the text query within the same search request. This value is used when combining the results of multiple ranking lists produced by the different vector queries and/or the results retrieved through the text query. The higher the weight, the higher the documents that matched that query will be in the final ranking. Default is 1.0 and the value needs to be a positive number larger than zero. " + }, + "threshold": { + "$ref": "#/definitions/VectorThreshold", + "description": "The threshold used for vector queries. Note this can only be set if all 'fields' use the same similarity metric." + }, + "filterOverride": { + "type": "string", + "description": "The OData filter expression to apply to this specific vector query. If no filter expression is defined at the vector level, the expression defined in the top level filter parameter is used instead." + } + }, + "required": [ + "kind" + ], + "description": "The query parameters for vector and hybrid search queries." + }, + "RawVectorQuery": { + "type": "object", + "x-ms-client-name": "VectorizedQuery", + "x-ms-discriminator-value": "vector", + "allOf": [ + { + "$ref": "#/definitions/VectorQuery" + } + ], + "properties": { + "vector": { + "type": "array", + "items": { + "type": "number", + "format": "float" + }, + "description": "The vector representation of a search query." + } + }, + "required": [ + "vector" + ], + "description": "The query parameters to use for vector search when a raw vector value is provided." + }, + "VectorizableTextQuery": { + "type": "object", + "x-ms-discriminator-value": "text", + "allOf": [ + { + "$ref": "#/definitions/VectorQuery" + } + ], + "properties": { + "text": { + "type": "string", + "description": "The text to be vectorized to perform a vector search query." + }, + "queryRewrites": { + "$ref": "#/definitions/QueryRewrites", + "description": "Can be configured to let a generative model rewrite the query before sending it to be vectorized." + } + }, + "required": [ + "text" + ], + "description": "The query parameters to use for vector search when a text value that needs to be vectorized is provided." + }, + "VectorizableImageUrlQuery": { + "type": "object", + "x-ms-discriminator-value": "imageUrl", + "allOf": [ + { + "$ref": "#/definitions/VectorQuery" + } + ], + "properties": { + "url": { + "type": "string", + "description": "The URL of an image to be vectorized to perform a vector search query." + } + }, + "description": "The query parameters to use for vector search when an url that represents an image value that needs to be vectorized is provided." + }, + "VectorizableImageBinaryQuery": { + "type": "object", + "x-ms-discriminator-value": "imageBinary", + "allOf": [ + { + "$ref": "#/definitions/VectorQuery" + } + ], + "properties": { + "base64Image": { + "type": "string", + "description": "The base 64 encoded binary of an image to be vectorized to perform a vector search query." + } + }, + "description": "The query parameters to use for vector search when a base 64 encoded binary of an image that needs to be vectorized is provided." + }, + "VectorQueryKind": { + "type": "string", + "enum": [ + "vector", + "text", + "imageUrl", + "imageBinary" + ], + "x-ms-enum": { + "name": "VectorQueryKind", + "modelAsString": true, + "values": [ + { + "value": "vector", + "name": "Vector", + "description": "Vector query where a raw vector value is provided." + }, + { + "value": "text", + "name": "Text", + "description": "Vector query where a text value that needs to be vectorized is provided." + }, + { + "value": "imageUrl", + "name": "ImageUrl", + "description": "Vector query where an url that represents an image value that needs to be vectorized is provided." + }, + { + "value": "imageBinary", + "name": "ImageBinary", + "description": "Vector query where a base 64 encoded binary of an image that needs to be vectorized is provided." + } + ] + }, + "description": "The kind of vector query being performed." + }, + "VectorThreshold": { + "type": "object", + "discriminator": "kind", + "properties": { + "kind": { + "$ref": "#/definitions/VectorThresholdKind", + "description": "The kind of threshold used to filter vector queries", + "x-nullable": false + } + }, + "required": [ + "kind" + ], + "description": "The threshold used for vector queries." + }, + "VectorSimilarityThreshold": { + "type": "object", + "x-ms-discriminator-value": "vectorSimilarity", + "allOf": [ + { + "$ref": "#/definitions/VectorThreshold" + } + ], + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The threshold will filter based on the similarity metric value. Note this is the canonical definition of similarity metric, not the 'distance' version. The threshold direction (larger or smaller) will be chosen automatically according to the metric used by the field." + } + }, + "required": [ + "value" + ], + "description": "The results of the vector query will be filtered based on the vector similarity metric. Note this is the canonical definition of similarity metric, not the 'distance' version. The threshold direction (larger or smaller) will be chosen automatically according to the metric used by the field." + }, + "SearchScoreThreshold": { + "type": "object", + "x-ms-discriminator-value": "searchScore", + "allOf": [ + { + "$ref": "#/definitions/VectorThreshold" + } + ], + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The threshold will filter based on the '@search.score' value. Note this is the @search.score returned as part of the search response. The threshold direction will be chosen for higher @search.score." + } + }, + "required": [ + "value" + ], + "description": "The results of the vector query will filter based on the '@search.score' value. Note this is the @search.score returned as part of the search response. The threshold direction will be chosen for higher @search.score." + }, + "VectorThresholdKind": { + "type": "string", + "enum": [ + "vectorSimilarity", + "searchScore" + ], + "x-ms-enum": { + "name": "VectorThresholdKind", + "modelAsString": true, + "values": [ + { + "value": "vectorSimilarity", + "name": "VectorSimilarity", + "description": "The results of the vector query will be filtered based on the vector similarity metric. Note this is the canonical definition of similarity metric, not the 'distance' version. The threshold direction (larger or smaller) will be chosen automatically according to the metric used by the field." + }, + { + "value": "searchScore", + "name": "SearchScore", + "description": "The results of the vector query will filter based on the '@search.score' value. Note this is the @search.score returned as part of the search response. The threshold direction will be chosen for higher @search.score." + } + ] + }, + "description": "The kind of vector query being performed." + }, + "VectorFilterMode": { + "type": "string", + "enum": [ + "postFilter", + "preFilter" + ], + "x-ms-enum": { + "name": "VectorFilterMode", + "modelAsString": true, + "values": [ + { + "value": "postFilter", + "name": "PostFilter", + "description": "The filter will be applied after the candidate set of vector results is returned. Depending on the filter selectivity, this can result in fewer results than requested by the parameter 'k'." + }, + { + "value": "preFilter", + "name": "PreFilter", + "description": "The filter will be applied before the search query." + } + ] + }, + "description": "Determines whether or not filters are applied before or after the vector search is performed." + }, + "HybridSearch": { + "type": "object", + "properties": { + "maxTextRecallSize": { + "type": "integer", + "format": "int32", + "description": "Determines the maximum number of documents to be retrieved by the text query portion of a hybrid search request. Those documents will be combined with the documents matching the vector queries to produce a single final list of results. Choosing a larger maxTextRecallSize value will allow retrieving and paging through more documents (using the top and skip parameters), at the cost of higher resource utilization and higher latency. The value needs to be between 1 and 10,000. Default is 1000." + }, + "countAndFacetMode": { + "$ref": "#/definitions/HybridCountAndFacetMode", + "description": "Determines whether the count and facets should includes all documents that matched the search query, or only the documents that are retrieved within the 'maxTextRecallSize' window." + } + }, + "description": "TThe query parameters to configure hybrid search behaviors." + }, + "HybridCountAndFacetMode": { + "type": "string", + "enum": [ + "countRetrievableResults", + "countAllResults" + ], + "x-ms-enum": { + "name": "HybridCountAndFacetMode", + "modelAsString": true, + "values": [ + { + "value": "countRetrievableResults", + "name": "CountRetrievableResults", + "description": "Only include documents that were matched within the 'maxTextRecallSize' retrieval window when computing 'count' and 'facets'." + }, + { + "value": "countAllResults", + "name": "CountAllResults", + "description": "Include all documents that were matched by the search query when computing 'count' and 'facets', regardless of whether or not those documents are within the 'maxTextRecallSize' retrieval window." + } + ] + }, + "description": "Determines whether the count and facets should includes all documents that matched the search query, or only the documents that are retrieved within the 'maxTextRecallSize' window. The default value is 'countAllResults'." + }, + "QueryLanguage": { + "type": "string", + "enum": [ + "none", + "en-us", + "en-gb", + "en-in", + "en-ca", + "en-au", + "fr-fr", + "fr-ca", + "de-de", + "es-es", + "es-mx", + "zh-cn", + "zh-tw", + "pt-br", + "pt-pt", + "it-it", + "ja-jp", + "ko-kr", + "ru-ru", + "cs-cz", + "nl-be", + "nl-nl", + "hu-hu", + "pl-pl", + "sv-se", + "tr-tr", + "hi-in", + "ar-sa", + "ar-eg", + "ar-ma", + "ar-kw", + "ar-jo", + "da-dk", + "no-no", + "bg-bg", + "hr-hr", + "hr-ba", + "ms-my", + "ms-bn", + "sl-sl", + "ta-in", + "vi-vn", + "el-gr", + "ro-ro", + "is-is", + "id-id", + "th-th", + "lt-lt", + "uk-ua", + "lv-lv", + "et-ee", + "ca-es", + "fi-fi", + "sr-ba", + "sr-me", + "sr-rs", + "sk-sk", + "nb-no", + "hy-am", + "bn-in", + "eu-es", + "gl-es", + "gu-in", + "he-il", + "ga-ie", + "kn-in", + "ml-in", + "mr-in", + "fa-ae", + "pa-in", + "te-in", + "ur-pk" + ], + "x-ms-enum": { + "name": "QueryLanguage", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Query language not specified." + }, + { + "value": "en-us", + "name": "EnUs", + "description": "Query language value for English (United States)." + }, + { + "value": "en-gb", + "name": "EnGb", + "description": "Query language value for English (Great Britain)." + }, + { + "value": "en-in", + "name": "EnIn", + "description": "Query language value for English (India)." + }, + { + "value": "en-ca", + "name": "EnCa", + "description": "Query language value for English (Canada)." + }, + { + "value": "en-au", + "name": "EnAu", + "description": "Query language value for English (Australia)." + }, + { + "value": "fr-fr", + "name": "FrFr", + "description": "Query language value for French (France)." + }, + { + "value": "fr-ca", + "name": "FrCa", + "description": "Query language value for French (Canada)." + }, + { + "value": "de-de", + "name": "DeDe", + "description": "Query language value for German (Germany)." + }, + { + "value": "es-es", + "name": "EsEs", + "description": "Query language value for Spanish (Spain)." + }, + { + "value": "es-mx", + "name": "EsMx", + "description": "Query language value for Spanish (Mexico)." + }, + { + "value": "zh-cn", + "name": "ZhCn", + "description": "Query language value for Chinese (China)." + }, + { + "value": "zh-tw", + "name": "ZhTw", + "description": "Query language value for Chinese (Taiwan)." + }, + { + "value": "pt-br", + "name": "PtBr", + "description": "Query language value for Portuguese (Brazil)." + }, + { + "value": "pt-pt", + "name": "PtPt", + "description": "Query language value for Portuguese (Portugal)." + }, + { + "value": "it-it", + "name": "ItIt", + "description": "Query language value for Italian (Italy)." + }, + { + "value": "ja-jp", + "name": "JaJp", + "description": "Query language value for Japanese (Japan)." + }, + { + "value": "ko-kr", + "name": "KoKr", + "description": "Query language value for Korean (Korea)." + }, + { + "value": "ru-ru", + "name": "RuRu", + "description": "Query language value for Russian (Russia)." + }, + { + "value": "cs-cz", + "name": "CsCz", + "description": "Query language value for Czech (Czech Republic)." + }, + { + "value": "nl-be", + "name": "NlBe", + "description": "Query language value for Dutch (Belgium)." + }, + { + "value": "nl-nl", + "name": "NlNl", + "description": "Query language value for Dutch (Netherlands)." + }, + { + "value": "hu-hu", + "name": "HuHu", + "description": "Query language value for Hungarian (Hungary)." + }, + { + "value": "pl-pl", + "name": "PlPl", + "description": "Query language value for Polish (Poland)." + }, + { + "value": "sv-se", + "name": "SvSe", + "description": "Query language value for Swedish (Sweden)." + }, + { + "value": "tr-tr", + "name": "TrTr", + "description": "Query language value for Turkish (Turkey)." + }, + { + "value": "hi-in", + "name": "HiIn", + "description": "Query language value for Hindi (India)." + }, + { + "value": "ar-sa", + "name": "ArSa", + "description": "Query language value for Arabic (Saudi Arabia)." + }, + { + "value": "ar-eg", + "name": "ArEg", + "description": "Query language value for Arabic (Egypt)." + }, + { + "value": "ar-ma", + "name": "ArMa", + "description": "Query language value for Arabic (Morocco)." + }, + { + "value": "ar-kw", + "name": "ArKw", + "description": "Query language value for Arabic (Kuwait)." + }, + { + "value": "ar-jo", + "name": "ArJo", + "description": "Query language value for Arabic (Jordan)." + }, + { + "value": "da-dk", + "name": "DaDk", + "description": "Query language value for Danish (Denmark)." + }, + { + "value": "no-no", + "name": "NoNo", + "description": "Query language value for Norwegian (Norway)." + }, + { + "value": "bg-bg", + "name": "BgBg", + "description": "Query language value for Bulgarian (Bulgaria)." + }, + { + "value": "hr-hr", + "name": "HrHr", + "description": "Query language value for Croatian (Croatia)." + }, + { + "value": "hr-ba", + "name": "HrBa", + "description": "Query language value for Croatian (Bosnia and Herzegovina)." + }, + { + "value": "ms-my", + "name": "MsMy", + "description": "Query language value for Malay (Malaysia)." + }, + { + "value": "ms-bn", + "name": "MsBn", + "description": "Query language value for Malay (Brunei Darussalam)." + }, + { + "value": "sl-sl", + "name": "SlSl", + "description": "Query language value for Slovenian (Slovenia)." + }, + { + "value": "ta-in", + "name": "TaIn", + "description": "Query language value for Tamil (India)." + }, + { + "value": "vi-vn", + "name": "ViVn", + "description": "Query language value for Vietnamese (Viet Nam)." + }, + { + "value": "el-gr", + "name": "ElGr", + "description": "Query language value for Greek (Greece)." + }, + { + "value": "ro-ro", + "name": "RoRo", + "description": "Query language value for Romanian (Romania)." + }, + { + "value": "is-is", + "name": "IsIs", + "description": "Query language value for Icelandic (Iceland)." + }, + { + "value": "id-id", + "name": "IdId", + "description": "Query language value for Indonesian (Indonesia)." + }, + { + "value": "th-th", + "name": "ThTh", + "description": "Query language value for Thai (Thailand)." + }, + { + "value": "lt-lt", + "name": "LtLt", + "description": "Query language value for Lithuanian (Lithuania)." + }, + { + "value": "uk-ua", + "name": "UkUa", + "description": "Query language value for Ukrainian (Ukraine)." + }, + { + "value": "lv-lv", + "name": "LvLv", + "description": "Query language value for Latvian (Latvia)." + }, + { + "value": "et-ee", + "name": "EtEe", + "description": "Query language value for Estonian (Estonia)." + }, + { + "value": "ca-es", + "name": "CaEs", + "description": "Query language value for Catalan." + }, + { + "value": "fi-fi", + "name": "FiFi", + "description": "Query language value for Finnish (Finland)." + }, + { + "value": "sr-ba", + "name": "SrBa", + "description": "Query language value for Serbian (Bosnia and Herzegovina)." + }, + { + "value": "sr-me", + "name": "SrMe", + "description": "Query language value for Serbian (Montenegro)." + }, + { + "value": "sr-rs", + "name": "SrRs", + "description": "Query language value for Serbian (Serbia)." + }, + { + "value": "sk-sk", + "name": "SkSk", + "description": "Query language value for Slovak (Slovakia)." + }, + { + "value": "nb-no", + "name": "NbNo", + "description": "Query language value for Norwegian (Norway)." + }, + { + "value": "hy-am", + "name": "HyAm", + "description": "Query language value for Armenian (Armenia)." + }, + { + "value": "bn-in", + "name": "BnIn", + "description": "Query language value for Bengali (India)." + }, + { + "value": "eu-es", + "name": "EuEs", + "description": "Query language value for Basque." + }, + { + "value": "gl-es", + "name": "GlEs", + "description": "Query language value for Galician." + }, + { + "value": "gu-in", + "name": "GuIn", + "description": "Query language value for Gujarati (India)." + }, + { + "value": "he-il", + "name": "HeIl", + "description": "Query language value for Hebrew (Israel)." + }, + { + "value": "ga-ie", + "name": "GaIe", + "description": "Query language value for Irish (Ireland)." + }, + { + "value": "kn-in", + "name": "KnIn", + "description": "Query language value for Kannada (India)." + }, + { + "value": "ml-in", + "name": "MlIn", + "description": "Query language value for Malayalam (India)." + }, + { + "value": "mr-in", + "name": "MrIn", + "description": "Query language value for Marathi (India)." + }, + { + "value": "fa-ae", + "name": "FaAe", + "description": "Query language value for Persian (U.A.E.)." + }, + { + "value": "pa-in", + "name": "PaIn", + "description": "Query language value for Punjabi (India)." + }, + { + "value": "te-in", + "name": "TeIn", + "description": "Query language value for Telugu (India)." + }, + { + "value": "ur-pk", + "name": "UrPk", + "description": "Query language value for Urdu (Pakistan)." + } + ] + }, + "description": "The language of the query." + }, + "ScoringStatistics": { + "type": "string", + "enum": [ + "local", + "global" + ], + "x-ms-enum": { + "name": "ScoringStatistics", + "modelAsString": false, + "values": [ + { + "value": "local", + "name": "Local", + "description": "The scoring statistics will be calculated locally for lower latency." + }, + { + "value": "global", + "name": "Global", + "description": "The scoring statistics will be calculated globally for more consistent scoring." + } + ] + }, + "description": "A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower latency. The default is 'local'. Use 'global' to aggregate scoring statistics globally before scoring. Using global scoring statistics can increase latency of search queries." + }, + "AutocompleteMode": { + "type": "string", + "enum": [ + "oneTerm", + "twoTerms", + "oneTermWithContext" + ], + "x-ms-enum": { + "name": "AutocompleteMode", + "modelAsString": false, + "values": [ + { + "value": "oneTerm", + "name": "OneTerm", + "description": "Only one term is suggested. If the query has two terms, only the last term is completed. For example, if the input is 'washington medic', the suggested terms could include 'medicaid', 'medicare', and 'medicine'." + }, + { + "value": "twoTerms", + "name": "TwoTerms", + "description": "Matching two-term phrases in the index will be suggested. For example, if the input is 'medic', the suggested terms could include 'medicare coverage' and 'medical assistant'." + }, + { + "value": "oneTermWithContext", + "name": "OneTermWithContext", + "description": "Completes the last term in a query with two or more terms, where the last two terms are a phrase that exists in the index. For example, if the input is 'washington medic', the suggested terms could include 'washington medicaid' and 'washington medical'." + } + ] + }, + "description": "Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context in producing autocomplete terms." + }, + "SearchRequest": { + "properties": { + "count": { + "type": "boolean", + "description": "A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation.", + "x-ms-client-name": "IncludeTotalResultCount" + }, + "facets": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Search-Documents" + }, + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs." + }, + "filter": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" + }, + "type": "string", + "description": "The OData $filter expression to apply to the search query." + }, + "highlight": { + "type": "string", + "description": "The comma-separated list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting.", + "x-ms-client-name": "HighlightFields" + }, + "highlightPostTag": { + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>." + }, + "highlightPreTag": { + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>." + }, + "minimumCoverage": { + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100." + }, + "orderby": { + "x-ms-client-name": "OrderBy", + "type": "string", + "description": "The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses." + }, + "queryType": { + "$ref": "#/definitions/QueryType", + "description": "A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax." + }, + "scoringStatistics": { + "$ref": "#/definitions/ScoringStatistics", + "description": "A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower latency. The default is 'local'. Use 'global' to aggregate scoring statistics globally before scoring. Using global scoring statistics can increase latency of search queries." + }, + "sessionId": { + "type": "string", + "description": "A value to be used to create a sticky session, which can help getting more consistent results. As long as the same sessionId is used, a best-effort attempt will be made to target the same replica set. Be wary that reusing the same sessionID values repeatedly can interfere with the load balancing of the requests across replicas and adversely affect the performance of the search service. The value used as sessionId cannot start with a '_' character." + }, + "scoringParameters": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be \"mylocation--122.2,44.8\" (without the quotes)." + }, + "scoringProfile": { + "type": "string", + "description": "The name of a scoring profile to evaluate match scores for matching documents in order to sort the results." + }, + "debug": { + "$ref": "#/definitions/QueryDebugMode", + "description": "Enables a debugging tool that can be used to further explore your reranked results." + }, + "search": { + "type": "string", + "description": "A full-text search query expression; Use \"*\" or omit this parameter to match all documents.", + "x-ms-client-name": "SearchText" + }, + "searchFields": { + "type": "string", + "description": "The comma-separated list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any field names listed in this parameter." + }, + "searchMode": { + "$ref": "#/definitions/SearchMode", + "description": "A value that specifies whether any or all of the search terms must be matched in order to count the document as a match." + }, + "queryLanguage": { + "$ref": "#/definitions/QueryLanguage", + "description": "A value that specifies the language of the search query." + }, + "speller": { + "$ref": "#/definitions/Speller", + "description": "A value that specified the type of the speller to use to spell-correct individual search query terms." + }, + "select": { + "type": "string", + "description": "The comma-separated list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included." + }, + "skip": { + "type": "integer", + "format": "int32", + "description": "The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use skip due to this limitation, consider using orderby on a totally-ordered key and filter with a range query instead." + }, + "top": { + "type": "integer", + "format": "int32", + "description": "The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be used to issue another Search request for the next page of results." + }, + "semanticConfiguration": { + "type": "string", + "description": "The name of a semantic configuration that will be used when processing documents for queries of type semantic." + }, + "semanticErrorHandling": { + "$ref": "#/definitions/SemanticErrorHandling", + "description": "Allows the user to choose whether a semantic call should fail completely (default / current behavior), or to return partial results." + }, + "semanticMaxWaitInMilliseconds": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "minimum": 700, + "description": "Allows the user to set an upper bound on the amount of time it takes for semantic enrichment to finish processing before the request fails." + }, + "semanticQuery": { + "type": "string", + "description": "Allows setting a separate search query that will be solely used for semantic reranking, semantic captions and semantic answers. Is useful for scenarios where there is a need to use different queries between the base retrieval and ranking phase, and the L2 semantic phase." + }, + "answers": { + "$ref": "#/definitions/Answers", + "description": "A value that specifies whether answers should be returned as part of the search response." + }, + "captions": { + "$ref": "#/definitions/Captions", + "description": "A value that specifies whether captions should be returned as part of the search response." + }, + "queryRewrites": { + "$ref": "#/definitions/QueryRewrites", + "description": "A value that specifies whether query rewrites should be generated to augment the search query." + }, + "semanticFields": { + "type": "string", + "description": "The comma-separated list of field names used for semantic ranking." + }, + "vectorQueries": { + "type": "array", + "items": { + "$ref": "#/definitions/VectorQuery" + }, + "description": "The query parameters for vector and hybrid search queries." + }, + "vectorFilterMode": { + "$ref": "#/definitions/VectorFilterMode", + "description": "Determines whether or not filters are applied before or after the vector search is performed. Default is 'preFilter' for new indexes." + }, + "hybridSearch": { + "$ref": "#/definitions/HybridSearch", + "description": "The query parameters to configure hybrid search behaviors." + } + }, + "description": "Parameters for filtering, sorting, faceting, paging, and other search query behaviors." + }, + "SuggestRequest": { + "properties": { + "filter": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" + }, + "type": "string", + "description": "An OData expression that filters the documents considered for suggestions." + }, + "fuzzy": { + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the suggestion query. Default is false. When set to true, the query will find suggestions even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy suggestion searches are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching" + }, + "highlightPostTag": { + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled." + }, + "highlightPreTag": { + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled." + }, + "minimumCoverage": { + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestion query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80." + }, + "orderby": { + "x-ms-client-name": "OrderBy", + "type": "string", + "description": "The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses." + }, + "search": { + "type": "string", + "description": "The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters.", + "x-ms-client-name": "SearchText" + }, + "searchFields": { + "type": "string", + "description": "The comma-separated list of field names to search for the specified search text. Target fields must be included in the specified suggester." + }, + "select": { + "type": "string", + "description": "The comma-separated list of fields to retrieve. If unspecified, only the key field will be included in the results." + }, + "suggesterName": { + "type": "string", + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + "top": { + "type": "integer", + "format": "int32", + "description": "The number of suggestions to retrieve. This must be a value between 1 and 100. The default is 5." + } + }, + "required": [ + "search", + "suggesterName" + ], + "description": "Parameters for filtering, sorting, fuzzy matching, and other suggestions query behaviors." + }, + "AutocompleteRequest": { + "properties": { + "search": { + "type": "string", + "description": "The search text on which to base autocomplete results.", + "x-ms-client-name": "SearchText" + }, + "autocompleteMode": { + "$ref": "#/definitions/AutocompleteMode", + "description": "Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context while producing auto-completed terms." + }, + "filter": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" + }, + "type": "string", + "description": "An OData expression that filters the documents used to produce completed terms for the Autocomplete result." + }, + "fuzzy": { + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will autocomplete terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching" + }, + "highlightPostTag": { + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled." + }, + "highlightPreTag": { + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled." + }, + "minimumCoverage": { + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80." + }, + "searchFields": { + "type": "string", + "description": "The comma-separated list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester." + }, + "suggesterName": { + "type": "string", + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + "top": { + "type": "integer", + "format": "int32", + "description": "The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5." + } + }, + "required": [ + "search", + "suggesterName" + ], + "description": "Parameters for fuzzy matching, and other autocomplete query behaviors." + }, + "AutocompleteResult": { + "properties": { + "@search.coverage": { + "type": "number", + "format": "double", + "readOnly": true, + "x-ms-client-name": "Coverage", + "description": "A value indicating the percentage of the index that was considered by the autocomplete request, or null if minimumCoverage was not specified in the request." + }, + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AutocompleteItem" + }, + "description": "The list of returned Autocompleted items.", + "x-ms-client-name": "Results" + } + }, + "required": [ + "value" + ], + "description": "The result of Autocomplete query." + }, + "AutocompleteItem": { + "properties": { + "text": { + "type": "string", + "readOnly": true, + "description": "The completed term." + }, + "queryPlusText": { + "type": "string", + "readOnly": true, + "description": "The query along with the completed term." + } + }, + "required": [ + "text", + "queryPlusText" + ], + "description": "The result of Autocomplete requests." + }, + "AnswerResult": { + "x-ms-client-name": "QueryAnswerResult", + "properties": { + "score": { + "type": "number", + "format": "double", + "readOnly": true, + "description": "The score value represents how relevant the answer is to the query relative to other answers returned for the query." + }, + "key": { + "type": "string", + "readOnly": true, + "description": "The key of the document the answer was extracted from." + }, + "text": { + "type": "string", + "readOnly": true, + "description": "The text passage extracted from the document contents as the answer." + }, + "highlights": { + "type": "string", + "readOnly": true, + "x-nullable": true, + "description": "Same text passage as in the Text property with highlighted text phrases most relevant to the query." + } + }, + "additionalProperties": true, + "description": "An answer is a text passage extracted from the contents of the most relevant documents that matched the query. Answers are extracted from the top search results. Answer candidates are scored and the top answers are selected." + }, + "CaptionResult": { + "x-ms-client-name": "QueryCaptionResult", + "properties": { + "text": { + "type": "string", + "readOnly": true, + "description": "A representative text passage extracted from the document most relevant to the search query." + }, + "highlights": { + "type": "string", + "readOnly": true, + "x-nullable": true, + "description": "Same text passage as in the Text property with highlighted phrases most relevant to the query." + } + }, + "additionalProperties": true, + "description": "Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type `semantic`." + }, + "SemanticPartialResponseReason": { + "type": "string", + "enum": [ + "maxWaitExceeded", + "capacityOverloaded", + "transient" + ], + "x-ms-enum": { + "name": "SemanticErrorReason", + "modelAsString": true, + "values": [ + { + "value": "maxWaitExceeded", + "name": "MaxWaitExceeded", + "description": "If `semanticMaxWaitInMilliseconds` was set and the semantic processing duration exceeded that value. Only the base results were returned." + }, + { + "value": "capacityOverloaded", + "name": "CapacityOverloaded", + "description": "The request was throttled. Only the base results were returned." + }, + { + "value": "transient", + "name": "Transient", + "description": "At least one step of the semantic process failed." + } + ] + }, + "description": "Reason that a partial response was returned for a semantic ranking request." + }, + "SemanticPartialResponseType": { + "type": "string", + "enum": [ + "baseResults", + "rerankedResults" + ], + "x-ms-enum": { + "name": "SemanticSearchResultsType", + "modelAsString": true, + "values": [ + { + "value": "baseResults", + "name": "BaseResults", + "description": "Results without any semantic enrichment or reranking." + }, + { + "value": "rerankedResults", + "name": "RerankedResults", + "description": "Results have been reranked with the reranker model and will include semantic captions. They will not include any answers, answers highlights or caption highlights." + } + ] + }, + "description": "Type of partial response that was returned for a semantic ranking request." + }, + "SemanticQueryRewritesResultType": { + "type": "string", + "enum": [ + "originalQueryOnly" + ], + "x-ms-enum": { + "name": "SemanticQueryRewritesResultType", + "modelAsString": true, + "values": [ + { + "value": "originalQueryOnly", + "name": "OriginalQueryOnly", + "description": "Query rewrites were not successfully generated for this request. Only the original query was used to retrieve the results." + } + ] + }, + "description": "Type of query rewrite that was used for this request." + }, + "SemanticErrorHandling": { + "type": "string", + "enum": [ + "partial", + "fail" + ], + "x-ms-enum": { + "name": "SemanticErrorMode", + "modelAsString": true, + "values": [ + { + "value": "partial", + "name": "Partial", + "description": "If the semantic processing fails, partial results still return. The definition of partial results depends on what semantic step failed and what was the reason for failure." + }, + { + "value": "fail", + "name": "Fail", + "description": "If there is an exception during the semantic processing step, the query will fail and return the appropriate HTTP code depending on the error." + } + ] + }, + "description": "Allows the user to choose whether a semantic call should fail completely, or to return partial results." + }, + "Answers": { + "type": "string", + "enum": [ + "none", + "extractive" + ], + "x-ms-enum": { + "name": "QueryAnswerType", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Do not return answers for the query." + }, + { + "value": "extractive", + "name": "Extractive", + "description": "Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language." + } + ] + }, + "description": "This parameter is only valid if the query type is `semantic`. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character `|` followed by the `count-<number of answers>` option after the answers parameter value, such as `extractive|count-3`. Default count is 1. The confidence threshold can be configured by appending the pipe character `|` followed by the `threshold-<confidence threshold>` option after the answers parameter value, such as `extractive|threshold-0.9`. Default threshold is 0.7. The maximum character length of answers can be configured by appending the pipe character '|' followed by the 'count-<number of maximum character length>', such as 'extractive|maxcharlength-600'." + }, + "Captions": { + "type": "string", + "enum": [ + "none", + "extractive" + ], + "x-ms-enum": { + "name": "QueryCaptionType", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Do not return captions for the query." + }, + { + "value": "extractive", + "name": "Extractive", + "description": "Extracts captions from the matching documents that contain passages relevant to the search query." + } + ] + }, + "description": "This parameter is only valid if the query type is `semantic`. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to `extractive`, highlighting is enabled by default, and can be configured by appending the pipe character `|` followed by the `highlight-<true/false>` option, such as `extractive|highlight-true`. Defaults to `None`. The maximum character length of captions can be configured by appending the pipe character '|' followed by the 'count-<number of maximum character length>', such as 'extractive|maxcharlength-600'." + }, + "QueryRewrites": { + "type": "string", + "enum": [ + "none", + "generative" + ], + "x-ms-enum": { + "name": "QueryRewritesType", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Do not generate additional query rewrites for this query." + }, + { + "value": "generative", + "name": "Generative", + "description": "Generate alternative query terms to increase the recall of a search request." + } + ] + }, + "description": "This parameter is only valid if the query type is `semantic`. When QueryRewrites is set to `generative`, the query terms are sent to a generate model which will produce 10 (default) rewrites to help increase the recall of the request. The requested count can be configured by appending the pipe character `|` followed by the `count-<number of rewrites>` option, such as `generative|count-3`. Defaults to `None`." + }, + "DebugInfo": { + "type": "object", + "properties": { + "queryRewrites": { + "$ref": "#/definitions/QueryRewritesDebugInfo", + "readOnly": true, + "description": "Contains debugging information specific to query rewrites." + } + }, + "description": "Contains debugging information that can be used to further explore your search results." + }, + "DocumentDebugInfo": { + "type": "object", + "properties": { + "semantic": { + "$ref": "#/definitions/SemanticDebugInfo", + "readOnly": true, + "description": "Contains debugging information specific to semantic ranking requests." + }, + "vectors": { + "$ref": "#/definitions/VectorsDebugInfo", + "readOnly": true, + "description": "Contains debugging information specific to vector and hybrid search." + } + }, + "description": "Contains debugging information that can be used to further explore your search results." + }, + "SemanticDebugInfo": { + "type": "object", + "properties": { + "titleField": { + "$ref": "#/definitions/QueryResultDocumentSemanticField", + "readOnly": true, + "description": "The title field that was sent to the semantic enrichment process, as well as how it was used" + }, + "contentFields": { + "type": "array", + "items": { + "$ref": "#/definitions/QueryResultDocumentSemanticField" + }, + "readOnly": true, + "description": "The content fields that were sent to the semantic enrichment process, as well as how they were used" + }, + "keywordFields": { + "type": "array", + "items": { + "$ref": "#/definitions/QueryResultDocumentSemanticField" + }, + "readOnly": true, + "description": "The keyword fields that were sent to the semantic enrichment process, as well as how they were used" + }, + "rerankerInput": { + "$ref": "#/definitions/QueryResultDocumentRerankerInput", + "readOnly": true, + "description": "The raw concatenated strings that were sent to the semantic enrichment process." + } + } + }, + "QueryResultDocumentSemanticField": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the field that was sent to the semantic enrichment process" + }, + "state": { + "$ref": "#/definitions/QueryResultDocumentSemanticFieldState", + "readOnly": true, + "description": "The way the field was used for the semantic enrichment process (fully used, partially used, or unused)" + } + }, + "description": "Description of fields that were sent to the semantic enrichment process, as well as how they were used" + }, + "QueryResultDocumentSemanticFieldState": { + "type": "string", + "enum": [ + "used", + "unused", + "partial" + ], + "x-ms-enum": { + "name": "SemanticFieldState", + "modelAsString": true, + "values": [ + { + "value": "used", + "name": "Used", + "description": "The field was fully used for semantic enrichment." + }, + { + "value": "unused", + "name": "Unused", + "description": "The field was not used for semantic enrichment." + }, + { + "value": "partial", + "name": "Partial", + "description": "The field was partially used for semantic enrichment." + } + ] + }, + "description": "The way the field was used for the semantic enrichment process." + }, + "QueryResultDocumentRerankerInput": { + "type": "object", + "properties": { + "title": { + "type": "string", + "readOnly": true, + "description": "The raw string for the title field that was used for semantic enrichment." + }, + "content": { + "type": "string", + "readOnly": true, + "description": "The raw concatenated strings for the content fields that were used for semantic enrichment." + }, + "keywords": { + "type": "string", + "readOnly": true, + "description": "The raw concatenated strings for the keyword fields that were used for semantic enrichment." + } + }, + "description": "The raw concatenated strings that were sent to the semantic enrichment process." + }, + "VectorsDebugInfo": { + "type": "object", + "properties": { + "subscores": { + "$ref": "#/definitions/QueryResultDocumentSubscores", + "readOnly": true, + "description": "The breakdown of subscores of the document prior to the chosen result set fusion/combination method such as RRF." + } + } + }, + "QueryResultDocumentSubscores": { + "type": "object", + "properties": { + "text": { + "$ref": "#/definitions/TextResult", + "readOnly": true, + "description": "The BM25 or Classic score for the text portion of the query." + }, + "vectors": { + "type": "array", + "items": { + "$ref": "#/definitions/QueryResultDocumentVectorSubscores" + }, + "readOnly": true, + "description": "The vector similarity and @search.score values for each vector query." + }, + "documentBoost": { + "type": "number", + "format": "double", + "readOnly": true, + "description": "The BM25 or Classic score for the text portion of the query." + } + }, + "description": "The breakdown of subscores between the text and vector query components of the search query for this document. Each vector query is shown as a separate object in the same order they were received." + }, + "TextResult": { + "type": "object", + "properties": { + "searchScore": { + "type": "number", + "format": "double", + "readOnly": true, + "description": "The BM25 or Classic score for the text portion of the query." + } + }, + "readOnly": true, + "description": "The BM25 or Classic score for the text portion of the query." + }, + "QueryResultDocumentVectorSubscores": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SingleVectorFieldResult", + "readOnly": true + }, + "readOnly": true, + "description": "The vector similarity and @search.score values for each vector query. Each cross-field vector query will have separate subscores for each referenced field." + }, + "SingleVectorFieldResult": { + "type": "object", + "properties": { + "searchScore": { + "type": "number", + "format": "double", + "readOnly": true, + "description": "The @search.score value that is calculated from the vector similarity score. This is the score that's visible in a pure single-field single-vector query." + }, + "vectorSimilarity": { + "type": "number", + "format": "double", + "readOnly": true, + "description": "The vector similarity score for this document. Note this is the canonical definition of similarity metric, not the 'distance' version. For example, cosine similarity instead of cosine distance." + } + }, + "readOnly": true, + "description": "A single vector field result. Both @search.score and vector similarity values are returned. Vector similarity is related to @search.score by an equation." + }, + "QueryRewritesDebugInfo": { + "type": "object", + "properties": { + "text": { + "$ref": "#/definitions/QueryRewritesValuesDebugInfo", + "readOnly": true, + "description": "List of query rewrites generated for the text query." + }, + "vectors": { + "type": "array", + "items": { + "$ref": "#/definitions/QueryRewritesValuesDebugInfo" + }, + "readOnly": true, + "description": "List of query rewrites generated for the vectorizable text queries." + } + }, + "readOnly": true, + "description": "Contains debugging information specific to query rewrites." + }, + "QueryRewritesValuesDebugInfo": { + "type": "object", + "properties": { + "rewrites": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "List of query rewrites." + } + }, + "readOnly": true, + "description": "Contains debugging information specific to query rewrites." + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ClientRequestIdParameter": { + "name": "x-ms-client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The tracking ID sent with the request to help with debugging.", + "x-ms-client-request-id": true, + "x-ms-parameter-grouping": { + "name": "request-options" + }, + "x-ms-parameter-location": "method" + }, + "EndpointParameter": { + "name": "endpoint", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "description": "The endpoint URL of the search service.", + "x-ms-parameter-location": "client" + }, + "IndexNameParameter": { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": false, + "description": "The name of the index.", + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/searchservice.json new file mode 100644 index 000000000000..2445398325e1 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/searchservice.json @@ -0,0 +1,12918 @@ +{ + "swagger": "2.0", + "info": { + "title": "SearchServiceClient", + "description": "Client that can be used to manage and query indexes and documents, as well as manage other resources, on a search service.", + "version": "2024-11-01-preview", + "x-ms-code-generation-settings": { + "useDateTimeOffset": true + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/EndpointParameter" + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/datasources('{dataSourceName}')": { + "put": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateDataSource": { + "$ref": "./examples/SearchServiceCreateOrUpdateDataSource.json" + } + }, + "description": "Creates a new datasource or updates a datasource if it already exists.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Update-Data-Source" + }, + "parameters": [ + { + "name": "dataSourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the datasource to create or update." + }, + { + "name": "dataSource", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + }, + "description": "The definition of the datasource to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IgnoreResetRequirementsParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_Delete", + "x-ms-examples": { + "SearchServiceDeleteDataSource": { + "$ref": "./examples/SearchServiceDeleteDataSource.json" + } + }, + "description": "Deletes a datasource.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Delete-Data-Source" + }, + "parameters": [ + { + "name": "dataSourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the datasource to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_Get", + "x-ms-examples": { + "SearchServiceGetDataSource": { + "$ref": "./examples/SearchServiceGetDataSource.json" + } + }, + "description": "Retrieves a datasource definition.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Get-Data-Source" + }, + "parameters": [ + { + "name": "dataSourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the datasource to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/datasources": { + "get": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_List", + "x-ms-examples": { + "SearchServiceListDataSources": { + "$ref": "./examples/SearchServiceListDataSources.json" + } + }, + "description": "Lists all datasources available for a search service.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/List-Data-Sources" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the data sources to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListDataSourcesResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "post": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_Create", + "x-ms-examples": { + "SearchServiceCreateDataSource": { + "$ref": "./examples/SearchServiceCreateDataSource.json" + } + }, + "description": "Creates a new datasource.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Data-Source" + }, + "parameters": [ + { + "name": "dataSource", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + }, + "description": "The definition of the datasource to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/indexers('{indexerName}')/search.reset": { + "post": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Reset", + "x-ms-examples": { + "SearchServiceResetIndexer": { + "$ref": "./examples/SearchServiceResetIndexer.json" + } + }, + "description": "Resets the change tracking state associated with an indexer.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Reset-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to reset." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/indexers('{indexerName}')/search.resetdocs": { + "post": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_ResetDocs", + "x-ms-examples": { + "SearchServiceResetDocs": { + "$ref": "./examples/SearchServiceResetDocs.json" + } + }, + "description": "Resets specific documents in the datasource to be selectively re-ingested by the indexer.", + "externalDocs": { + "url": "https://aka.ms/reset-documents" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to reset documents for." + }, + { + "name": "keysOrIds", + "in": "body", + "required": false, + "schema": { + "type": "object", + "x-ms-client-name": "DocumentKeysOrIds", + "properties": { + "documentKeys": { + "type": "array", + "items": { + "type": "string" + }, + "description": "document keys to be reset" + }, + "datasourceDocumentIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "datasource document identifiers to be reset" + } + } + } + }, + { + "name": "overwrite", + "in": "query", + "required": false, + "default": false, + "type": "boolean", + "description": "If false, keys or ids will be appended to existing ones. If true, only the keys or ids in this payload will be queued to be re-ingested." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/indexers('{indexerName}')/search.run": { + "post": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Run", + "x-ms-examples": { + "SearchServiceRunIndexer": { + "$ref": "./examples/SearchServiceRunIndexer.json" + } + }, + "description": "Runs an indexer on-demand.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Run-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to run." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "202": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/indexers('{indexerName}')": { + "put": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateIndexer": { + "$ref": "./examples/SearchServiceCreateOrUpdateIndexer.json" + } + }, + "description": "Creates a new indexer or updates an indexer if it already exists.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to create or update." + }, + { + "name": "indexer", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexer" + }, + "description": "The definition of the indexer to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IgnoreResetRequirementsParameter" + }, + { + "$ref": "#/parameters/DisableCacheReprocessingChangeDetectionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexer" + } + }, + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexer" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Delete", + "x-ms-examples": { + "SearchServiceDeleteIndexer": { + "$ref": "./examples/SearchServiceDeleteIndexer.json" + } + }, + "description": "Deletes an indexer.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Delete-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "404": { + "description": "" + }, + "204": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Get", + "x-ms-examples": { + "SearchServiceGetIndexer": { + "$ref": "./examples/SearchServiceGetIndexer.json" + } + }, + "description": "Retrieves an indexer definition.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Get-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexer" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/indexers": { + "get": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_List", + "x-ms-examples": { + "SearchServiceListIndexers": { + "$ref": "./examples/SearchServiceListIndexers.json" + } + }, + "description": "Lists all indexers available for a search service.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/List-Indexers" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the indexers to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListIndexersResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "post": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Create", + "x-ms-examples": { + "SearchServiceCreateIndexer": { + "$ref": "./examples/SearchServiceCreateIndexer.json" + } + }, + "description": "Creates a new indexer.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Indexer" + }, + "parameters": [ + { + "name": "indexer", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexer" + }, + "description": "The definition of the indexer to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexer" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/indexers('{indexerName}')/search.status": { + "get": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_GetStatus", + "x-ms-examples": { + "SearchServiceGetIndexerStatus": { + "$ref": "./examples/SearchServiceGetIndexerStatus.json" + } + }, + "description": "Returns the current status and execution history of an indexer.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Get-Indexer-Status" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer for which to retrieve status." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerStatus" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/skillsets('{skillsetName}')": { + "put": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateSkillset": { + "$ref": "./examples/SearchServiceCreateOrUpdateSkillset.json" + } + }, + "description": "Creates a new skillset in a search service or updates the skillset if it already exists.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/update-skillset" + }, + "parameters": [ + { + "name": "skillsetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the skillset to create or update." + }, + { + "name": "skillset", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + }, + "description": "The skillset containing one or more skills to create or update in a search service." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IgnoreResetRequirementsParameter" + }, + { + "$ref": "#/parameters/DisableCacheReprocessingChangeDetectionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "The skillset is successfully updated.", + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + } + }, + "201": { + "description": "The skillset is successfully created.", + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_Delete", + "x-ms-examples": { + "SearchServiceDeleteSkillset": { + "$ref": "./examples/SearchServiceDeleteSkillset.json" + } + }, + "description": "Deletes a skillset in a search service.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/delete-skillset" + }, + "parameters": [ + { + "name": "skillsetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the skillset to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "The skillset is successfully deleted." + }, + "404": { + "description": "The provided skillset name is not found." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_Get", + "x-ms-examples": { + "SearchServiceGetSkillset": { + "$ref": "./examples/SearchServiceGetSkillset.json" + } + }, + "description": "Retrieves a skillset in a search service.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/get-skillset" + }, + "parameters": [ + { + "name": "skillsetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the skillset to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "The skillset is successfully returned.", + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/skillsets": { + "get": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_List", + "x-ms-examples": { + "SearchServiceListSkillsets": { + "$ref": "./examples/SearchServiceListSkillsets.json" + } + }, + "description": "List all skillsets in a search service.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/list-skillset" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the skillsets to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "The list is successfully returned.", + "schema": { + "$ref": "#/definitions/ListSkillsetsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "post": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_Create", + "x-ms-examples": { + "SearchServiceCreateSkillset": { + "$ref": "./examples/SearchServiceCreateSkillset.json" + } + }, + "description": "Creates a new skillset in a search service.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/create-skillset" + }, + "parameters": [ + { + "name": "skillset", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + }, + "description": "The skillset containing one or more skills to create in a search service." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "The skillset is successfully created.", + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/skillsets('{skillsetName}')/search.resetskills": { + "post": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_ResetSkills", + "x-ms-examples": { + "SearchServiceResetSkills": { + "$ref": "./examples/SearchServiceResetSkills.json" + } + }, + "description": "Reset an existing skillset in a search service.", + "externalDocs": { + "url": "https://aka.ms/reset-skills" + }, + "parameters": [ + { + "name": "skillsetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the skillset to reset." + }, + { + "name": "skillNames", + "in": "body", + "required": true, + "schema": { + "type": "object", + "x-ms-client-name": "SkillNames", + "properties": { + "skillNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "the names of skills to be reset." + } + } + }, + "description": "The names of skills to reset." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "The skills in the skillset are successfully reset." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/synonymmaps('{synonymMapName}')": { + "put": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateSynonymMap": { + "$ref": "./examples/SearchServiceCreateOrUpdateSynonymMap.json" + } + }, + "description": "Creates a new synonym map or updates a synonym map if it already exists.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Update-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the synonym map to create or update." + }, + { + "name": "synonymMap", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SynonymMap" + }, + "description": "The definition of the synonym map to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_Delete", + "x-ms-examples": { + "SearchServiceDeleteSynonymMap": { + "$ref": "./examples/SearchServiceDeleteSynonymMap.json" + } + }, + "description": "Deletes a synonym map.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Delete-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the synonym map to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_Get", + "x-ms-examples": { + "SearchServiceGetSynonymMap": { + "$ref": "./examples/SearchServiceGetSynonymMap.json" + } + }, + "description": "Retrieves a synonym map definition.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Get-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the synonym map to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/synonymmaps": { + "get": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_List", + "x-ms-examples": { + "SearchServiceListSynonymMaps": { + "$ref": "./examples/SearchServiceListSynonymMaps.json" + } + }, + "description": "Lists all synonym maps available for a search service.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/List-Synonym-Maps" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the synonym maps to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListSynonymMapsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "post": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_Create", + "x-ms-examples": { + "SearchServiceCreateSynonymMap": { + "$ref": "./examples/SearchServiceCreateSynonymMap.json" + } + }, + "description": "Creates a new synonym map.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMap", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SynonymMap" + }, + "description": "The definition of the synonym map to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/indexes": { + "post": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Create", + "x-ms-examples": { + "SearchServiceCreateIndex": { + "$ref": "./examples/SearchServiceCreateIndex.json" + } + }, + "description": "Creates a new search index.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Index" + }, + "parameters": [ + { + "name": "index", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndex" + }, + "description": "The definition of the index to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndex" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_List", + "x-ms-examples": { + "SearchServiceListIndexes": { + "$ref": "./examples/SearchServiceListIndexes.json" + } + }, + "description": "Lists all indexes available for a search service.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/List-Indexes" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the index definitions to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListIndexesResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/indexes('{indexName}')": { + "put": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateIndex": { + "$ref": "./examples/SearchServiceCreateOrUpdateIndex.json" + } + }, + "description": "Creates a new search index or updates an index if it already exists.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Update-Index" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The definition of the index to create or update." + }, + { + "name": "index", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndex" + }, + "description": "The definition of the index to create or update." + }, + { + "name": "allowIndexDowntime", + "in": "query", + "required": false, + "type": "boolean", + "description": "Allows new analyzers, tokenizers, token filters, or char filters to be added to an index by taking the index offline for at least a few seconds. This temporarily causes indexing and query requests to fail. Performance and write availability of the index can be impaired for several minutes after the index is updated, or longer for very large indexes." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndex" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndex" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Delete", + "x-ms-examples": { + "SearchServiceDeleteIndex": { + "$ref": "./examples/SearchServiceDeleteIndex.json" + } + }, + "description": "Deletes a search index and all the documents it contains. This operation is permanent, with no recovery option. Make sure you have a master copy of your index definition, data ingestion code, and a backup of the primary data source in case you need to re-build the index.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Delete-Index" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Get", + "x-ms-examples": { + "SearchServiceGetIndex": { + "$ref": "./examples/SearchServiceGetIndex.json" + } + }, + "description": "Retrieves an index definition.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Get-Index" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndex" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/indexes('{indexName}')/search.stats": { + "get": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_GetStatistics", + "x-ms-examples": { + "SearchServiceGetIndexStatistics": { + "$ref": "./examples/SearchServiceGetIndexStatistics.json" + } + }, + "description": "Returns statistics for the given index, including a document count and storage usage.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Get-Index-Statistics" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index for which to retrieve statistics." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/GetIndexStatisticsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/indexes('{indexName}')/search.analyze": { + "post": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Analyze", + "x-ms-examples": { + "SearchServiceIndexAnalyze": { + "$ref": "./examples/SearchServiceIndexAnalyze.json" + } + }, + "description": "Shows how an analyzer breaks text into tokens.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/test-analyzer" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index for which to test an analyzer." + }, + { + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeRequest" + }, + "description": "The text and analyzer or analysis components to test." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/AnalyzeResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/aliases": { + "post": { + "tags": [ + "Aliases" + ], + "operationId": "Aliases_Create", + "x-ms-examples": { + "SearchServiceCreateAlias": { + "$ref": "./examples/SearchServiceCreateAlias.json" + } + }, + "description": "Creates a new search alias.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Alias" + }, + "parameters": [ + { + "name": "alias", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchAlias" + }, + "description": "The definition of the alias to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchAlias" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Aliases" + ], + "operationId": "Aliases_List", + "x-ms-examples": { + "SearchServiceListAliases": { + "$ref": "./examples/SearchServiceListAliases.json" + } + }, + "description": "Lists all aliases available for a search service.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/List-Aliases" + }, + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListAliasesResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/aliases('{aliasName}')": { + "put": { + "tags": [ + "Aliases" + ], + "operationId": "Aliases_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateAlias": { + "$ref": "./examples/SearchServiceCreateOrUpdateAlias.json" + } + }, + "description": "Creates a new search alias or updates an alias if it already exists.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Update-Alias" + }, + "parameters": [ + { + "name": "aliasName", + "in": "path", + "required": true, + "type": "string", + "description": "The definition of the alias to create or update." + }, + { + "name": "alias", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchAlias" + }, + "description": "The definition of the alias to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchAlias" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchAlias" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Aliases" + ], + "operationId": "Aliases_Delete", + "x-ms-examples": { + "SearchServiceDeleteAlias": { + "$ref": "./examples/SearchServiceDeleteAlias.json" + } + }, + "description": "Deletes a search alias and its associated mapping to an index. This operation is permanent, with no recovery option. The mapped index is untouched by this operation.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Delete-Alias" + }, + "parameters": [ + { + "name": "aliasName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the alias to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Aliases" + ], + "operationId": "Aliases_Get", + "x-ms-examples": { + "SearchServiceGetAlias": { + "$ref": "./examples/SearchServiceGetAlias.json" + } + }, + "description": "Retrieves an alias definition.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Get-Alias" + }, + "parameters": [ + { + "name": "aliasName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the alias to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchAlias" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/servicestats": { + "get": { + "tags": [ + "Service" + ], + "operationId": "GetServiceStatistics", + "x-ms-examples": { + "SearchServiceGetServiceStatistics": { + "$ref": "./examples/SearchServiceGetServiceStatistics.json" + } + }, + "description": "Gets service level statistics for a search service.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ServiceStatistics" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "AnalyzeRequest": { + "properties": { + "text": { + "type": "string", + "description": "The text to break into tokens." + }, + "analyzer": { + "$ref": "#/definitions/LexicalAnalyzerName", + "description": "The name of the analyzer to use to break the given text. If this parameter is not specified, you must specify a tokenizer instead. The tokenizer and analyzer parameters are mutually exclusive." + }, + "tokenizer": { + "$ref": "#/definitions/LexicalTokenizerName", + "description": "The name of the tokenizer to use to break the given text. If this parameter is not specified, you must specify an analyzer instead. The tokenizer and analyzer parameters are mutually exclusive." + }, + "normalizer": { + "$ref": "#/definitions/LexicalNormalizerName", + "description": "The name of the normalizer to use to normalize the given text." + }, + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilterName", + "x-nullable": false + }, + "description": "An optional list of token filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter." + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilterName", + "x-nullable": false + }, + "description": "An optional list of character filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter." + } + }, + "required": [ + "text" + ], + "description": "Specifies some text and analysis components used to break that text into tokens." + }, + "AnalyzeResult": { + "properties": { + "tokens": { + "type": "array", + "items": { + "$ref": "#/definitions/AnalyzedTokenInfo" + }, + "description": "The list of tokens returned by the analyzer specified in the request." + } + }, + "required": [ + "tokens" + ], + "description": "The result of testing an analyzer on text." + }, + "AnalyzedTokenInfo": { + "properties": { + "token": { + "type": "string", + "readOnly": true, + "description": "The token returned by the analyzer." + }, + "startOffset": { + "type": "integer", + "format": "int32", + "readOnly": true, + "x-nullable": false, + "description": "The index of the first character of the token in the input text." + }, + "endOffset": { + "type": "integer", + "format": "int32", + "readOnly": true, + "x-nullable": false, + "description": "The index of the last character of the token in the input text." + }, + "position": { + "type": "integer", + "format": "int32", + "readOnly": true, + "x-nullable": false, + "description": "The position of the token in the input text relative to other tokens. The first token in the input text has position 0, the next has position 1, and so on. Depending on the analyzer used, some tokens might have the same position, for example if they are synonyms of each other." + } + }, + "required": [ + "token", + "startOffset", + "endOffset", + "position" + ], + "description": "Information about a token returned by an analyzer." + }, + "LexicalAnalyzerName": { + "type": "string", + "enum": [ + "ar.microsoft", + "ar.lucene", + "hy.lucene", + "bn.microsoft", + "eu.lucene", + "bg.microsoft", + "bg.lucene", + "ca.microsoft", + "ca.lucene", + "zh-Hans.microsoft", + "zh-Hans.lucene", + "zh-Hant.microsoft", + "zh-Hant.lucene", + "hr.microsoft", + "cs.microsoft", + "cs.lucene", + "da.microsoft", + "da.lucene", + "nl.microsoft", + "nl.lucene", + "en.microsoft", + "en.lucene", + "et.microsoft", + "fi.microsoft", + "fi.lucene", + "fr.microsoft", + "fr.lucene", + "gl.lucene", + "de.microsoft", + "de.lucene", + "el.microsoft", + "el.lucene", + "gu.microsoft", + "he.microsoft", + "hi.microsoft", + "hi.lucene", + "hu.microsoft", + "hu.lucene", + "is.microsoft", + "id.microsoft", + "id.lucene", + "ga.lucene", + "it.microsoft", + "it.lucene", + "ja.microsoft", + "ja.lucene", + "kn.microsoft", + "ko.microsoft", + "ko.lucene", + "lv.microsoft", + "lv.lucene", + "lt.microsoft", + "ml.microsoft", + "ms.microsoft", + "mr.microsoft", + "nb.microsoft", + "no.lucene", + "fa.lucene", + "pl.microsoft", + "pl.lucene", + "pt-BR.microsoft", + "pt-BR.lucene", + "pt-PT.microsoft", + "pt-PT.lucene", + "pa.microsoft", + "ro.microsoft", + "ro.lucene", + "ru.microsoft", + "ru.lucene", + "sr-cyrillic.microsoft", + "sr-latin.microsoft", + "sk.microsoft", + "sl.microsoft", + "es.microsoft", + "es.lucene", + "sv.microsoft", + "sv.lucene", + "ta.microsoft", + "te.microsoft", + "th.microsoft", + "th.lucene", + "tr.microsoft", + "tr.lucene", + "uk.microsoft", + "ur.microsoft", + "vi.microsoft", + "standard.lucene", + "standardasciifolding.lucene", + "keyword", + "pattern", + "simple", + "stop", + "whitespace" + ], + "x-ms-enum": { + "name": "LexicalAnalyzerName", + "modelAsString": true, + "values": [ + { + "value": "ar.microsoft", + "name": "ArMicrosoft", + "description": "Microsoft analyzer for Arabic." + }, + { + "value": "ar.lucene", + "name": "ArLucene", + "description": "Lucene analyzer for Arabic." + }, + { + "value": "hy.lucene", + "name": "HyLucene", + "description": "Lucene analyzer for Armenian." + }, + { + "value": "bn.microsoft", + "name": "BnMicrosoft", + "description": "Microsoft analyzer for Bangla." + }, + { + "value": "eu.lucene", + "name": "EuLucene", + "description": "Lucene analyzer for Basque." + }, + { + "value": "bg.microsoft", + "name": "BgMicrosoft", + "description": "Microsoft analyzer for Bulgarian." + }, + { + "value": "bg.lucene", + "name": "BgLucene", + "description": "Lucene analyzer for Bulgarian." + }, + { + "value": "ca.microsoft", + "name": "CaMicrosoft", + "description": "Microsoft analyzer for Catalan." + }, + { + "value": "ca.lucene", + "name": "CaLucene", + "description": "Lucene analyzer for Catalan." + }, + { + "value": "zh-Hans.microsoft", + "name": "ZhHansMicrosoft", + "description": "Microsoft analyzer for Chinese (Simplified)." + }, + { + "value": "zh-Hans.lucene", + "name": "ZhHansLucene", + "description": "Lucene analyzer for Chinese (Simplified)." + }, + { + "value": "zh-Hant.microsoft", + "name": "ZhHantMicrosoft", + "description": "Microsoft analyzer for Chinese (Traditional)." + }, + { + "value": "zh-Hant.lucene", + "name": "ZhHantLucene", + "description": "Lucene analyzer for Chinese (Traditional)." + }, + { + "value": "hr.microsoft", + "name": "HrMicrosoft", + "description": "Microsoft analyzer for Croatian." + }, + { + "value": "cs.microsoft", + "name": "CsMicrosoft", + "description": "Microsoft analyzer for Czech." + }, + { + "value": "cs.lucene", + "name": "CsLucene", + "description": "Lucene analyzer for Czech." + }, + { + "value": "da.microsoft", + "name": "DaMicrosoft", + "description": "Microsoft analyzer for Danish." + }, + { + "value": "da.lucene", + "name": "DaLucene", + "description": "Lucene analyzer for Danish." + }, + { + "value": "nl.microsoft", + "name": "NlMicrosoft", + "description": "Microsoft analyzer for Dutch." + }, + { + "value": "nl.lucene", + "name": "NlLucene", + "description": "Lucene analyzer for Dutch." + }, + { + "value": "en.microsoft", + "name": "EnMicrosoft", + "description": "Microsoft analyzer for English." + }, + { + "value": "en.lucene", + "name": "EnLucene", + "description": "Lucene analyzer for English." + }, + { + "value": "et.microsoft", + "name": "EtMicrosoft", + "description": "Microsoft analyzer for Estonian." + }, + { + "value": "fi.microsoft", + "name": "FiMicrosoft", + "description": "Microsoft analyzer for Finnish." + }, + { + "value": "fi.lucene", + "name": "FiLucene", + "description": "Lucene analyzer for Finnish." + }, + { + "value": "fr.microsoft", + "name": "FrMicrosoft", + "description": "Microsoft analyzer for French." + }, + { + "value": "fr.lucene", + "name": "FrLucene", + "description": "Lucene analyzer for French." + }, + { + "value": "gl.lucene", + "name": "GlLucene", + "description": "Lucene analyzer for Galician." + }, + { + "value": "de.microsoft", + "name": "DeMicrosoft", + "description": "Microsoft analyzer for German." + }, + { + "value": "de.lucene", + "name": "DeLucene", + "description": "Lucene analyzer for German." + }, + { + "value": "el.microsoft", + "name": "ElMicrosoft", + "description": "Microsoft analyzer for Greek." + }, + { + "value": "el.lucene", + "name": "ElLucene", + "description": "Lucene analyzer for Greek." + }, + { + "value": "gu.microsoft", + "name": "GuMicrosoft", + "description": "Microsoft analyzer for Gujarati." + }, + { + "value": "he.microsoft", + "name": "HeMicrosoft", + "description": "Microsoft analyzer for Hebrew." + }, + { + "value": "hi.microsoft", + "name": "HiMicrosoft", + "description": "Microsoft analyzer for Hindi." + }, + { + "value": "hi.lucene", + "name": "HiLucene", + "description": "Lucene analyzer for Hindi." + }, + { + "value": "hu.microsoft", + "name": "HuMicrosoft", + "description": "Microsoft analyzer for Hungarian." + }, + { + "value": "hu.lucene", + "name": "HuLucene", + "description": "Lucene analyzer for Hungarian." + }, + { + "value": "is.microsoft", + "name": "IsMicrosoft", + "description": "Microsoft analyzer for Icelandic." + }, + { + "value": "id.microsoft", + "name": "IdMicrosoft", + "description": "Microsoft analyzer for Indonesian (Bahasa)." + }, + { + "value": "id.lucene", + "name": "IdLucene", + "description": "Lucene analyzer for Indonesian." + }, + { + "value": "ga.lucene", + "name": "GaLucene", + "description": "Lucene analyzer for Irish." + }, + { + "value": "it.microsoft", + "name": "ItMicrosoft", + "description": "Microsoft analyzer for Italian." + }, + { + "value": "it.lucene", + "name": "ItLucene", + "description": "Lucene analyzer for Italian." + }, + { + "value": "ja.microsoft", + "name": "JaMicrosoft", + "description": "Microsoft analyzer for Japanese." + }, + { + "value": "ja.lucene", + "name": "JaLucene", + "description": "Lucene analyzer for Japanese." + }, + { + "value": "kn.microsoft", + "name": "KnMicrosoft", + "description": "Microsoft analyzer for Kannada." + }, + { + "value": "ko.microsoft", + "name": "KoMicrosoft", + "description": "Microsoft analyzer for Korean." + }, + { + "value": "ko.lucene", + "name": "KoLucene", + "description": "Lucene analyzer for Korean." + }, + { + "value": "lv.microsoft", + "name": "LvMicrosoft", + "description": "Microsoft analyzer for Latvian." + }, + { + "value": "lv.lucene", + "name": "LvLucene", + "description": "Lucene analyzer for Latvian." + }, + { + "value": "lt.microsoft", + "name": "LtMicrosoft", + "description": "Microsoft analyzer for Lithuanian." + }, + { + "value": "ml.microsoft", + "name": "MlMicrosoft", + "description": "Microsoft analyzer for Malayalam." + }, + { + "value": "ms.microsoft", + "name": "MsMicrosoft", + "description": "Microsoft analyzer for Malay (Latin)." + }, + { + "value": "mr.microsoft", + "name": "MrMicrosoft", + "description": "Microsoft analyzer for Marathi." + }, + { + "value": "nb.microsoft", + "name": "NbMicrosoft", + "description": "Microsoft analyzer for Norwegian (Bokmål)." + }, + { + "value": "no.lucene", + "name": "NoLucene", + "description": "Lucene analyzer for Norwegian." + }, + { + "value": "fa.lucene", + "name": "FaLucene", + "description": "Lucene analyzer for Persian." + }, + { + "value": "pl.microsoft", + "name": "PlMicrosoft", + "description": "Microsoft analyzer for Polish." + }, + { + "value": "pl.lucene", + "name": "PlLucene", + "description": "Lucene analyzer for Polish." + }, + { + "value": "pt-BR.microsoft", + "name": "PtBrMicrosoft", + "description": "Microsoft analyzer for Portuguese (Brazil)." + }, + { + "value": "pt-BR.lucene", + "name": "PtBrLucene", + "description": "Lucene analyzer for Portuguese (Brazil)." + }, + { + "value": "pt-PT.microsoft", + "name": "PtPtMicrosoft", + "description": "Microsoft analyzer for Portuguese (Portugal)." + }, + { + "value": "pt-PT.lucene", + "name": "PtPtLucene", + "description": "Lucene analyzer for Portuguese (Portugal)." + }, + { + "value": "pa.microsoft", + "name": "PaMicrosoft", + "description": "Microsoft analyzer for Punjabi." + }, + { + "value": "ro.microsoft", + "name": "RoMicrosoft", + "description": "Microsoft analyzer for Romanian." + }, + { + "value": "ro.lucene", + "name": "RoLucene", + "description": "Lucene analyzer for Romanian." + }, + { + "value": "ru.microsoft", + "name": "RuMicrosoft", + "description": "Microsoft analyzer for Russian." + }, + { + "value": "ru.lucene", + "name": "RuLucene", + "description": "Lucene analyzer for Russian." + }, + { + "value": "sr-cyrillic.microsoft", + "name": "SrCyrillicMicrosoft", + "description": "Microsoft analyzer for Serbian (Cyrillic)." + }, + { + "value": "sr-latin.microsoft", + "name": "SrLatinMicrosoft", + "description": "Microsoft analyzer for Serbian (Latin)." + }, + { + "value": "sk.microsoft", + "name": "SkMicrosoft", + "description": "Microsoft analyzer for Slovak." + }, + { + "value": "sl.microsoft", + "name": "SlMicrosoft", + "description": "Microsoft analyzer for Slovenian." + }, + { + "value": "es.microsoft", + "name": "EsMicrosoft", + "description": "Microsoft analyzer for Spanish." + }, + { + "value": "es.lucene", + "name": "EsLucene", + "description": "Lucene analyzer for Spanish." + }, + { + "value": "sv.microsoft", + "name": "SvMicrosoft", + "description": "Microsoft analyzer for Swedish." + }, + { + "value": "sv.lucene", + "name": "SvLucene", + "description": "Lucene analyzer for Swedish." + }, + { + "value": "ta.microsoft", + "name": "TaMicrosoft", + "description": "Microsoft analyzer for Tamil." + }, + { + "value": "te.microsoft", + "name": "TeMicrosoft", + "description": "Microsoft analyzer for Telugu." + }, + { + "value": "th.microsoft", + "name": "ThMicrosoft", + "description": "Microsoft analyzer for Thai." + }, + { + "value": "th.lucene", + "name": "ThLucene", + "description": "Lucene analyzer for Thai." + }, + { + "value": "tr.microsoft", + "name": "TrMicrosoft", + "description": "Microsoft analyzer for Turkish." + }, + { + "value": "tr.lucene", + "name": "TrLucene", + "description": "Lucene analyzer for Turkish." + }, + { + "value": "uk.microsoft", + "name": "UkMicrosoft", + "description": "Microsoft analyzer for Ukrainian." + }, + { + "value": "ur.microsoft", + "name": "UrMicrosoft", + "description": "Microsoft analyzer for Urdu." + }, + { + "value": "vi.microsoft", + "name": "ViMicrosoft", + "description": "Microsoft analyzer for Vietnamese." + }, + { + "value": "standard.lucene", + "name": "StandardLucene", + "description": "Standard Lucene analyzer." + }, + { + "value": "standardasciifolding.lucene", + "name": "StandardAsciiFoldingLucene", + "description": "Standard ASCII Folding Lucene analyzer. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers" + }, + { + "value": "keyword", + "name": "Keyword", + "description": "Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html" + }, + { + "value": "pattern", + "name": "Pattern", + "description": "Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html" + }, + { + "value": "simple", + "name": "Simple", + "description": "Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html" + }, + { + "value": "stop", + "name": "Stop", + "description": "Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html" + }, + { + "value": "whitespace", + "name": "Whitespace", + "description": "An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html" + } + ] + }, + "description": "Defines the names of all text analyzers supported by the search engine.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Language-support" + } + }, + "LexicalTokenizerName": { + "type": "string", + "enum": [ + "classic", + "edgeNGram", + "keyword_v2", + "letter", + "lowercase", + "microsoft_language_tokenizer", + "microsoft_language_stemming_tokenizer", + "nGram", + "path_hierarchy_v2", + "pattern", + "standard_v2", + "uax_url_email", + "whitespace" + ], + "x-ms-enum": { + "name": "LexicalTokenizerName", + "modelAsString": true, + "values": [ + { + "value": "classic", + "name": "Classic", + "description": "Grammar-based tokenizer that is suitable for processing most European-language documents. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicTokenizer.html" + }, + { + "value": "edgeNGram", + "name": "EdgeNGram", + "description": "Tokenizes the input from an edge into n-grams of the given size(s). See https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenizer.html" + }, + { + "value": "keyword_v2", + "name": "Keyword", + "description": "Emits the entire input as a single token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" + }, + { + "value": "letter", + "name": "Letter", + "description": "Divides text at non-letters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LetterTokenizer.html" + }, + { + "value": "lowercase", + "name": "Lowercase", + "description": "Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LowerCaseTokenizer.html" + }, + { + "value": "microsoft_language_tokenizer", + "name": "MicrosoftLanguageTokenizer", + "description": "Divides text using language-specific rules." + }, + { + "value": "microsoft_language_stemming_tokenizer", + "name": "MicrosoftLanguageStemmingTokenizer", + "description": "Divides text using language-specific rules and reduces words to their base forms." + }, + { + "value": "nGram", + "name": "NGram", + "description": "Tokenizes the input into n-grams of the given size(s). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenizer.html" + }, + { + "value": "path_hierarchy_v2", + "name": "PathHierarchy", + "description": "Tokenizer for path-like hierarchies. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/path/PathHierarchyTokenizer.html" + }, + { + "value": "pattern", + "name": "Pattern", + "description": "Tokenizer that uses regex pattern matching to construct distinct tokens. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternTokenizer.html" + }, + { + "value": "standard_v2", + "name": "Standard", + "description": "Standard Lucene analyzer; Composed of the standard tokenizer, lowercase filter and stop filter. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html" + }, + { + "value": "uax_url_email", + "name": "UaxUrlEmail", + "description": "Tokenizes urls and emails as one token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/UAX29URLEmailTokenizer.html" + }, + { + "value": "whitespace", + "name": "Whitespace", + "description": "Divides text at whitespace. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceTokenizer.html" + } + ] + }, + "description": "Defines the names of all tokenizers supported by the search engine.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "TokenFilterName": { + "type": "string", + "enum": [ + "arabic_normalization", + "apostrophe", + "asciifolding", + "cjk_bigram", + "cjk_width", + "classic", + "common_grams", + "edgeNGram_v2", + "elision", + "german_normalization", + "hindi_normalization", + "indic_normalization", + "keyword_repeat", + "kstem", + "length", + "limit", + "lowercase", + "nGram_v2", + "persian_normalization", + "phonetic", + "porter_stem", + "reverse", + "scandinavian_normalization", + "scandinavian_folding", + "shingle", + "snowball", + "sorani_normalization", + "stemmer", + "stopwords", + "trim", + "truncate", + "unique", + "uppercase", + "word_delimiter" + ], + "x-ms-enum": { + "name": "TokenFilterName", + "modelAsString": true, + "values": [ + { + "value": "arabic_normalization", + "name": "ArabicNormalization", + "description": "A token filter that applies the Arabic normalizer to normalize the orthography. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ar/ArabicNormalizationFilter.html" + }, + { + "value": "apostrophe", + "name": "Apostrophe", + "description": "Strips all characters after an apostrophe (including the apostrophe itself). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/tr/ApostropheFilter.html" + }, + { + "value": "asciifolding", + "name": "AsciiFolding", + "description": "Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the \"Basic Latin\" Unicode block) into their ASCII equivalents, if such equivalents exist. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html" + }, + { + "value": "cjk_bigram", + "name": "CjkBigram", + "description": "Forms bigrams of CJK terms that are generated from the standard tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKBigramFilter.html" + }, + { + "value": "cjk_width", + "name": "CjkWidth", + "description": "Normalizes CJK width differences. Folds fullwidth ASCII variants into the equivalent basic Latin, and half-width Katakana variants into the equivalent Kana. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKWidthFilter.html" + }, + { + "value": "classic", + "name": "Classic", + "description": "Removes English possessives, and dots from acronyms. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicFilter.html" + }, + { + "value": "common_grams", + "name": "CommonGram", + "description": "Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/commongrams/CommonGramsFilter.html" + }, + { + "value": "edgeNGram_v2", + "name": "EdgeNGram", + "description": "Generates n-grams of the given size(s) starting from the front or the back of an input token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html" + }, + { + "value": "elision", + "name": "Elision", + "description": "Removes elisions. For example, \"l'avion\" (the plane) will be converted to \"avion\" (plane). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html" + }, + { + "value": "german_normalization", + "name": "GermanNormalization", + "description": "Normalizes German characters according to the heuristics of the German2 snowball algorithm. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/de/GermanNormalizationFilter.html" + }, + { + "value": "hindi_normalization", + "name": "HindiNormalization", + "description": "Normalizes text in Hindi to remove some differences in spelling variations. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/hi/HindiNormalizationFilter.html" + }, + { + "value": "indic_normalization", + "name": "IndicNormalization", + "description": "Normalizes the Unicode representation of text in Indian languages. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/in/IndicNormalizationFilter.html" + }, + { + "value": "keyword_repeat", + "name": "KeywordRepeat", + "description": "Emits each incoming token twice, once as keyword and once as non-keyword. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeywordRepeatFilter.html" + }, + { + "value": "kstem", + "name": "KStem", + "description": "A high-performance kstem filter for English. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/en/KStemFilter.html" + }, + { + "value": "length", + "name": "Length", + "description": "Removes words that are too long or too short. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LengthFilter.html" + }, + { + "value": "limit", + "name": "Limit", + "description": "Limits the number of tokens while indexing. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LimitTokenCountFilter.html" + }, + { + "value": "lowercase", + "name": "Lowercase", + "description": "Normalizes token text to lower case. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html" + }, + { + "value": "nGram_v2", + "name": "NGram", + "description": "Generates n-grams of the given size(s). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html" + }, + { + "value": "persian_normalization", + "name": "PersianNormalization", + "description": "Applies normalization for Persian. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/fa/PersianNormalizationFilter.html" + }, + { + "value": "phonetic", + "name": "Phonetic", + "description": "Create tokens for phonetic matches. See https://lucene.apache.org/core/4_10_3/analyzers-phonetic/org/apache/lucene/analysis/phonetic/package-tree.html" + }, + { + "value": "porter_stem", + "name": "PorterStem", + "description": "Uses the Porter stemming algorithm to transform the token stream. See http://tartarus.org/~martin/PorterStemmer" + }, + { + "value": "reverse", + "name": "Reverse", + "description": "Reverses the token string. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html" + }, + { + "value": "scandinavian_normalization", + "name": "ScandinavianNormalization", + "description": "Normalizes use of the interchangeable Scandinavian characters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianNormalizationFilter.html" + }, + { + "value": "scandinavian_folding", + "name": "ScandinavianFoldingNormalization", + "description": "Folds Scandinavian characters åÅäæÄÆ->a and öÖøØ->o. It also discriminates against use of double vowels aa, ae, ao, oe and oo, leaving just the first one. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianFoldingFilter.html" + }, + { + "value": "shingle", + "name": "Shingle", + "description": "Creates combinations of tokens as a single token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/shingle/ShingleFilter.html" + }, + { + "value": "snowball", + "name": "Snowball", + "description": "A filter that stems words using a Snowball-generated stemmer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/snowball/SnowballFilter.html" + }, + { + "value": "sorani_normalization", + "name": "SoraniNormalization", + "description": "Normalizes the Unicode representation of Sorani text. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ckb/SoraniNormalizationFilter.html" + }, + { + "value": "stemmer", + "name": "Stemmer", + "description": "Language specific stemming filter. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters" + }, + { + "value": "stopwords", + "name": "Stopwords", + "description": "Removes stop words from a token stream. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopFilter.html" + }, + { + "value": "trim", + "name": "Trim", + "description": "Trims leading and trailing whitespace from tokens. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TrimFilter.html" + }, + { + "value": "truncate", + "name": "Truncate", + "description": "Truncates the terms to a specific length. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TruncateTokenFilter.html" + }, + { + "value": "unique", + "name": "Unique", + "description": "Filters out tokens with same text as the previous token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/RemoveDuplicatesTokenFilter.html" + }, + { + "value": "uppercase", + "name": "Uppercase", + "description": "Normalizes token text to upper case. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html" + }, + { + "value": "word_delimiter", + "name": "WordDelimiter", + "description": "Splits words into subwords and performs optional transformations on subword groups." + } + ] + }, + "description": "Defines the names of all token filters supported by the search engine.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "LexicalNormalizerName": { + "type": "string", + "enum": [ + "asciifolding", + "elision", + "lowercase", + "standard", + "uppercase" + ], + "x-ms-enum": { + "name": "LexicalNormalizerName", + "modelAsString": true, + "values": [ + { + "value": "asciifolding", + "name": "AsciiFolding", + "description": "Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the \"Basic Latin\" Unicode block) into their ASCII equivalents, if such equivalents exist. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html" + }, + { + "value": "elision", + "name": "Elision", + "description": "Removes elisions. For example, \"l'avion\" (the plane) will be converted to \"avion\" (plane). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html" + }, + { + "value": "lowercase", + "name": "Lowercase", + "description": "Normalizes token text to lowercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html" + }, + { + "value": "standard", + "name": "Standard", + "description": "Standard normalizer, which consists of lowercase and asciifolding. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html" + }, + { + "value": "uppercase", + "name": "Uppercase", + "description": "Normalizes token text to uppercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html" + } + ] + }, + "description": "Defines the names of all text normalizers supported by the search engine.", + "externalDocs": { + "url": "https://aka.ms/azs-normalizers" + } + }, + "CharFilterName": { + "type": "string", + "enum": [ + "html_strip" + ], + "x-ms-enum": { + "name": "CharFilterName", + "modelAsString": true, + "values": [ + { + "value": "html_strip", + "name": "HtmlStrip", + "description": "A character filter that attempts to strip out HTML constructs. See https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.html" + } + ] + }, + "description": "Defines the names of all character filters supported by the search engine.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "RegexFlags": { + "type": "string", + "enum": [ + "CANON_EQ", + "CASE_INSENSITIVE", + "COMMENTS", + "DOTALL", + "LITERAL", + "MULTILINE", + "UNICODE_CASE", + "UNIX_LINES" + ], + "x-ms-enum": { + "name": "RegexFlags", + "modelAsString": true, + "values": [ + { + "value": "CANON_EQ", + "name": "CanonEq", + "description": "Enables canonical equivalence." + }, + { + "value": "CASE_INSENSITIVE", + "name": "CaseInsensitive", + "description": "Enables case-insensitive matching." + }, + { + "value": "COMMENTS", + "name": "Comments", + "description": "Permits whitespace and comments in the pattern." + }, + { + "value": "DOTALL", + "name": "DotAll", + "description": "Enables dotall mode." + }, + { + "value": "LITERAL", + "name": "Literal", + "description": "Enables literal parsing of the pattern." + }, + { + "value": "MULTILINE", + "name": "Multiline", + "description": "Enables multiline mode." + }, + { + "value": "UNICODE_CASE", + "name": "UnicodeCase", + "description": "Enables Unicode-aware case folding." + }, + { + "value": "UNIX_LINES", + "name": "UnixLines", + "description": "Enables Unix lines mode." + } + ] + }, + "description": "Defines flags that can be combined to control how regular expressions are used in the pattern analyzer and pattern tokenizer.", + "externalDocs": { + "url": "http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html#field_summary" + } + }, + "VectorEncodingFormat": { + "type": "string", + "enum": [ + "packedBit" + ], + "x-ms-enum": { + "name": "VectorEncodingFormat", + "modelAsString": true, + "values": [ + { + "value": "packedBit", + "name": "PackedBit", + "description": "Encoding format representing bits packed into a wider data type." + } + ] + }, + "description": "The encoding format for interpreting vector field contents." + }, + "SearchFieldDataType": { + "type": "string", + "enum": [ + "Edm.String", + "Edm.Int32", + "Edm.Int64", + "Edm.Double", + "Edm.Boolean", + "Edm.DateTimeOffset", + "Edm.GeographyPoint", + "Edm.ComplexType", + "Edm.Single", + "Edm.Half", + "Edm.Int16", + "Edm.SByte", + "Edm.Byte" + ], + "x-ms-enum": { + "name": "SearchFieldDataType", + "modelAsString": true, + "values": [ + { + "value": "Edm.String", + "name": "String", + "description": "Indicates that a field contains a string." + }, + { + "value": "Edm.Int32", + "name": "Int32", + "description": "Indicates that a field contains a 32-bit signed integer." + }, + { + "value": "Edm.Int64", + "name": "Int64", + "description": "Indicates that a field contains a 64-bit signed integer." + }, + { + "value": "Edm.Double", + "name": "Double", + "description": "Indicates that a field contains an IEEE double-precision floating point number." + }, + { + "value": "Edm.Boolean", + "name": "Boolean", + "description": "Indicates that a field contains a Boolean value (true or false)." + }, + { + "value": "Edm.DateTimeOffset", + "name": "DateTimeOffset", + "description": "Indicates that a field contains a date/time value, including timezone information." + }, + { + "value": "Edm.GeographyPoint", + "name": "GeographyPoint", + "description": "Indicates that a field contains a geo-location in terms of longitude and latitude." + }, + { + "value": "Edm.ComplexType", + "name": "Complex", + "description": "Indicates that a field contains one or more complex objects that in turn have sub-fields of other types." + }, + { + "value": "Edm.Single", + "name": "Single", + "description": "Indicates that a field contains a single-precision floating point number. This is only valid when used with Collection(Edm.Single)." + }, + { + "value": "Edm.Half", + "name": "Half", + "description": "Indicates that a field contains a half-precision floating point number. This is only valid when used with Collection(Edm.Half)." + }, + { + "value": "Edm.Int16", + "name": "Int16", + "description": "Indicates that a field contains a 16-bit signed integer. This is only valid when used with Collection(Edm.Int16)." + }, + { + "value": "Edm.SByte", + "name": "SByte", + "description": "Indicates that a field contains a 8-bit signed integer. This is only valid when used with Collection(Edm.SByte)." + }, + { + "value": "Edm.Byte", + "name": "Byte", + "description": "Indicates that a field contains a 8-bit unsigned integer. This is only valid when used with Collection(Edm.Byte)." + } + ] + }, + "description": "Defines the data type of a field in a search index." + }, + "LexicalAnalyzer": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "A URI fragment specifying the type of analyzer." + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Base type for analyzers." + }, + "CustomAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CustomAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/LexicalAnalyzer" + } + ], + "properties": { + "tokenizer": { + "$ref": "#/definitions/LexicalTokenizerName", + "description": "The name of the tokenizer to use to divide continuous text into a sequence of tokens, such as breaking a sentence into words." + }, + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilterName", + "x-nullable": false + }, + "description": "A list of token filters used to filter out or modify the tokens generated by a tokenizer. For example, you can specify a lowercase filter that converts all characters to lowercase. The filters are run in the order in which they are listed." + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilterName", + "x-nullable": false + }, + "description": "A list of character filters used to prepare input text before it is processed by the tokenizer. For instance, they can replace certain characters or symbols. The filters are run in the order in which they are listed." + } + }, + "required": [ + "tokenizer" + ], + "description": "Allows you to take control over the process of converting text into indexable/searchable tokens. It's a user-defined configuration consisting of a single predefined tokenizer and one or more filters. The tokenizer is responsible for breaking text into tokens, and the filters for modifying tokens emitted by the tokenizer." + }, + "PatternAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/LexicalAnalyzer" + } + ], + "properties": { + "lowercase": { + "x-ms-client-name": "LowerCaseTerms", + "type": "boolean", + "default": true, + "description": "A value indicating whether terms should be lower-cased. Default is true." + }, + "pattern": { + "type": "string", + "default": "\\W+", + "description": "A regular expression pattern to match token separators. Default is an expression that matches one or more non-word characters." + }, + "flags": { + "$ref": "#/definitions/RegexFlags", + "description": "Regular expression flags." + }, + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stopwords." + } + }, + "description": "Flexibly separates text into terms via a regular expression pattern. This analyzer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html" + } + }, + "LuceneStandardAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StandardAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/LexicalAnalyzer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + }, + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stopwords." + } + }, + "description": "Standard Apache Lucene analyzer; Composed of the standard tokenizer, lowercase filter and stop filter.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardAnalyzer.html" + } + }, + "StopAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StopAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/LexicalAnalyzer" + } + ], + "properties": { + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stopwords." + } + }, + "description": "Divides text at non-letters; Applies the lowercase and stopword token filters. This analyzer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html" + } + }, + "LexicalNormalizer": { + "type": "object", + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "A URI fragment specifying the type of normalizer." + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://aka.ms/azs-normalizers" + }, + "description": "The name of the normalizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. It cannot end in '.microsoft' nor '.lucene', nor be named 'asciifolding', 'standard', 'lowercase', 'uppercase', or 'elision'." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Base type for normalizers." + }, + "CustomNormalizer": { + "type": "object", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CustomNormalizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalNormalizer" + } + ], + "properties": { + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilterName", + "x-nullable": false + }, + "description": "A list of token filters used to filter out or modify the input token. For example, you can specify a lowercase filter that converts all characters to lowercase. The filters are run in the order in which they are listed." + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilterName", + "x-nullable": false + }, + "description": "A list of character filters used to prepare input text before it is processed. For instance, they can replace certain characters or symbols. The filters are run in the order in which they are listed." + } + }, + "description": "Allows you to configure normalization for filterable, sortable, and facetable fields, which by default operate with strict matching. This is a user-defined configuration consisting of at least one or more filters, which modify the token that is stored.", + "externalDocs": { + "url": "https://aka.ms/azs-custom-normalizers" + } + }, + "LexicalTokenizer": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "A URI fragment specifying the type of tokenizer." + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Base type for tokenizers.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "ClassicTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ClassicTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Grammar-based tokenizer that is suitable for processing most European-language documents. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicTokenizer.html" + } + }, + "TokenCharacterKind": { + "type": "string", + "enum": [ + "letter", + "digit", + "whitespace", + "punctuation", + "symbol" + ], + "x-ms-enum": { + "name": "TokenCharacterKind", + "modelAsString": false, + "values": [ + { + "value": "letter", + "name": "Letter", + "description": "Keeps letters in tokens." + }, + { + "value": "digit", + "name": "Digit", + "description": "Keeps digits in tokens." + }, + { + "value": "whitespace", + "name": "Whitespace", + "description": "Keeps whitespace in tokens." + }, + { + "value": "punctuation", + "name": "Punctuation", + "description": "Keeps punctuation in tokens." + }, + { + "value": "symbol", + "name": "Symbol", + "description": "Keeps symbols in tokens." + } + ] + }, + "description": "Represents classes of characters on which a token filter can operate." + }, + "EdgeNGramTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.EdgeNGramTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + }, + "tokenChars": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenCharacterKind", + "x-nullable": false + }, + "description": "Character classes to keep in the tokens." + } + }, + "description": "Tokenizes the input from an edge into n-grams of the given size(s). This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenizer.html" + } + }, + "KeywordTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeywordTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "bufferSize": { + "type": "integer", + "format": "int32", + "default": 256, + "description": "The read buffer size in bytes. Default is 256." + } + }, + "description": "Emits the entire input as a single token. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" + }, + "x-az-search-deprecated": true + }, + "KeywordTokenizerV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeywordTokenizerV2", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 256, + "maximum": 300, + "description": "The maximum token length. Default is 256. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Emits the entire input as a single token. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" + } + }, + "MicrosoftTokenizerLanguage": { + "type": "string", + "enum": [ + "bangla", + "bulgarian", + "catalan", + "chineseSimplified", + "chineseTraditional", + "croatian", + "czech", + "danish", + "dutch", + "english", + "french", + "german", + "greek", + "gujarati", + "hindi", + "icelandic", + "indonesian", + "italian", + "japanese", + "kannada", + "korean", + "malay", + "malayalam", + "marathi", + "norwegianBokmaal", + "polish", + "portuguese", + "portugueseBrazilian", + "punjabi", + "romanian", + "russian", + "serbianCyrillic", + "serbianLatin", + "slovenian", + "spanish", + "swedish", + "tamil", + "telugu", + "thai", + "ukrainian", + "urdu", + "vietnamese" + ], + "x-ms-enum": { + "name": "MicrosoftTokenizerLanguage", + "modelAsString": false, + "values": [ + { + "value": "bangla", + "name": "Bangla", + "description": "Selects the Microsoft tokenizer for Bangla." + }, + { + "value": "bulgarian", + "name": "Bulgarian", + "description": "Selects the Microsoft tokenizer for Bulgarian." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the Microsoft tokenizer for Catalan." + }, + { + "value": "chineseSimplified", + "name": "ChineseSimplified", + "description": "Selects the Microsoft tokenizer for Chinese (Simplified)." + }, + { + "value": "chineseTraditional", + "name": "ChineseTraditional", + "description": "Selects the Microsoft tokenizer for Chinese (Traditional)." + }, + { + "value": "croatian", + "name": "Croatian", + "description": "Selects the Microsoft tokenizer for Croatian." + }, + { + "value": "czech", + "name": "Czech", + "description": "Selects the Microsoft tokenizer for Czech." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the Microsoft tokenizer for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the Microsoft tokenizer for Dutch." + }, + { + "value": "english", + "name": "English", + "description": "Selects the Microsoft tokenizer for English." + }, + { + "value": "french", + "name": "French", + "description": "Selects the Microsoft tokenizer for French." + }, + { + "value": "german", + "name": "German", + "description": "Selects the Microsoft tokenizer for German." + }, + { + "value": "greek", + "name": "Greek", + "description": "Selects the Microsoft tokenizer for Greek." + }, + { + "value": "gujarati", + "name": "Gujarati", + "description": "Selects the Microsoft tokenizer for Gujarati." + }, + { + "value": "hindi", + "name": "Hindi", + "description": "Selects the Microsoft tokenizer for Hindi." + }, + { + "value": "icelandic", + "name": "Icelandic", + "description": "Selects the Microsoft tokenizer for Icelandic." + }, + { + "value": "indonesian", + "name": "Indonesian", + "description": "Selects the Microsoft tokenizer for Indonesian." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the Microsoft tokenizer for Italian." + }, + { + "value": "japanese", + "name": "Japanese", + "description": "Selects the Microsoft tokenizer for Japanese." + }, + { + "value": "kannada", + "name": "Kannada", + "description": "Selects the Microsoft tokenizer for Kannada." + }, + { + "value": "korean", + "name": "Korean", + "description": "Selects the Microsoft tokenizer for Korean." + }, + { + "value": "malay", + "name": "Malay", + "description": "Selects the Microsoft tokenizer for Malay." + }, + { + "value": "malayalam", + "name": "Malayalam", + "description": "Selects the Microsoft tokenizer for Malayalam." + }, + { + "value": "marathi", + "name": "Marathi", + "description": "Selects the Microsoft tokenizer for Marathi." + }, + { + "value": "norwegianBokmaal", + "name": "NorwegianBokmaal", + "description": "Selects the Microsoft tokenizer for Norwegian (Bokmål)." + }, + { + "value": "polish", + "name": "Polish", + "description": "Selects the Microsoft tokenizer for Polish." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the Microsoft tokenizer for Portuguese." + }, + { + "value": "portugueseBrazilian", + "name": "PortugueseBrazilian", + "description": "Selects the Microsoft tokenizer for Portuguese (Brazil)." + }, + { + "value": "punjabi", + "name": "Punjabi", + "description": "Selects the Microsoft tokenizer for Punjabi." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the Microsoft tokenizer for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the Microsoft tokenizer for Russian." + }, + { + "value": "serbianCyrillic", + "name": "SerbianCyrillic", + "description": "Selects the Microsoft tokenizer for Serbian (Cyrillic)." + }, + { + "value": "serbianLatin", + "name": "SerbianLatin", + "description": "Selects the Microsoft tokenizer for Serbian (Latin)." + }, + { + "value": "slovenian", + "name": "Slovenian", + "description": "Selects the Microsoft tokenizer for Slovenian." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the Microsoft tokenizer for Spanish." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the Microsoft tokenizer for Swedish." + }, + { + "value": "tamil", + "name": "Tamil", + "description": "Selects the Microsoft tokenizer for Tamil." + }, + { + "value": "telugu", + "name": "Telugu", + "description": "Selects the Microsoft tokenizer for Telugu." + }, + { + "value": "thai", + "name": "Thai", + "description": "Selects the Microsoft tokenizer for Thai." + }, + { + "value": "ukrainian", + "name": "Ukrainian", + "description": "Selects the Microsoft tokenizer for Ukrainian." + }, + { + "value": "urdu", + "name": "Urdu", + "description": "Selects the Microsoft tokenizer for Urdu." + }, + { + "value": "vietnamese", + "name": "Vietnamese", + "description": "Selects the Microsoft tokenizer for Vietnamese." + } + ] + }, + "description": "Lists the languages supported by the Microsoft language tokenizer." + }, + "MicrosoftLanguageTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.MicrosoftLanguageTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Tokens longer than the maximum length are split. Maximum token length that can be used is 300 characters. Tokens longer than 300 characters are first split into tokens of length 300 and then each of those tokens is split based on the max token length set. Default is 255." + }, + "isSearchTokenizer": { + "type": "boolean", + "default": false, + "description": "A value indicating how the tokenizer is used. Set to true if used as the search tokenizer, set to false if used as the indexing tokenizer. Default is false." + }, + "language": { + "$ref": "#/definitions/MicrosoftTokenizerLanguage", + "description": "The language to use. The default is English." + } + }, + "description": "Divides text using language-specific rules." + }, + "MicrosoftStemmingTokenizerLanguage": { + "type": "string", + "enum": [ + "arabic", + "bangla", + "bulgarian", + "catalan", + "croatian", + "czech", + "danish", + "dutch", + "english", + "estonian", + "finnish", + "french", + "german", + "greek", + "gujarati", + "hebrew", + "hindi", + "hungarian", + "icelandic", + "indonesian", + "italian", + "kannada", + "latvian", + "lithuanian", + "malay", + "malayalam", + "marathi", + "norwegianBokmaal", + "polish", + "portuguese", + "portugueseBrazilian", + "punjabi", + "romanian", + "russian", + "serbianCyrillic", + "serbianLatin", + "slovak", + "slovenian", + "spanish", + "swedish", + "tamil", + "telugu", + "turkish", + "ukrainian", + "urdu" + ], + "x-ms-enum": { + "name": "MicrosoftStemmingTokenizerLanguage", + "modelAsString": false, + "values": [ + { + "value": "arabic", + "name": "Arabic", + "description": "Selects the Microsoft stemming tokenizer for Arabic." + }, + { + "value": "bangla", + "name": "Bangla", + "description": "Selects the Microsoft stemming tokenizer for Bangla." + }, + { + "value": "bulgarian", + "name": "Bulgarian", + "description": "Selects the Microsoft stemming tokenizer for Bulgarian." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the Microsoft stemming tokenizer for Catalan." + }, + { + "value": "croatian", + "name": "Croatian", + "description": "Selects the Microsoft stemming tokenizer for Croatian." + }, + { + "value": "czech", + "name": "Czech", + "description": "Selects the Microsoft stemming tokenizer for Czech." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the Microsoft stemming tokenizer for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the Microsoft stemming tokenizer for Dutch." + }, + { + "value": "english", + "name": "English", + "description": "Selects the Microsoft stemming tokenizer for English." + }, + { + "value": "estonian", + "name": "Estonian", + "description": "Selects the Microsoft stemming tokenizer for Estonian." + }, + { + "value": "finnish", + "name": "Finnish", + "description": "Selects the Microsoft stemming tokenizer for Finnish." + }, + { + "value": "french", + "name": "French", + "description": "Selects the Microsoft stemming tokenizer for French." + }, + { + "value": "german", + "name": "German", + "description": "Selects the Microsoft stemming tokenizer for German." + }, + { + "value": "greek", + "name": "Greek", + "description": "Selects the Microsoft stemming tokenizer for Greek." + }, + { + "value": "gujarati", + "name": "Gujarati", + "description": "Selects the Microsoft stemming tokenizer for Gujarati." + }, + { + "value": "hebrew", + "name": "Hebrew", + "description": "Selects the Microsoft stemming tokenizer for Hebrew." + }, + { + "value": "hindi", + "name": "Hindi", + "description": "Selects the Microsoft stemming tokenizer for Hindi." + }, + { + "value": "hungarian", + "name": "Hungarian", + "description": "Selects the Microsoft stemming tokenizer for Hungarian." + }, + { + "value": "icelandic", + "name": "Icelandic", + "description": "Selects the Microsoft stemming tokenizer for Icelandic." + }, + { + "value": "indonesian", + "name": "Indonesian", + "description": "Selects the Microsoft stemming tokenizer for Indonesian." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the Microsoft stemming tokenizer for Italian." + }, + { + "value": "kannada", + "name": "Kannada", + "description": "Selects the Microsoft stemming tokenizer for Kannada." + }, + { + "value": "latvian", + "name": "Latvian", + "description": "Selects the Microsoft stemming tokenizer for Latvian." + }, + { + "value": "lithuanian", + "name": "Lithuanian", + "description": "Selects the Microsoft stemming tokenizer for Lithuanian." + }, + { + "value": "malay", + "name": "Malay", + "description": "Selects the Microsoft stemming tokenizer for Malay." + }, + { + "value": "malayalam", + "name": "Malayalam", + "description": "Selects the Microsoft stemming tokenizer for Malayalam." + }, + { + "value": "marathi", + "name": "Marathi", + "description": "Selects the Microsoft stemming tokenizer for Marathi." + }, + { + "value": "norwegianBokmaal", + "name": "NorwegianBokmaal", + "description": "Selects the Microsoft stemming tokenizer for Norwegian (Bokmål)." + }, + { + "value": "polish", + "name": "Polish", + "description": "Selects the Microsoft stemming tokenizer for Polish." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the Microsoft stemming tokenizer for Portuguese." + }, + { + "value": "portugueseBrazilian", + "name": "PortugueseBrazilian", + "description": "Selects the Microsoft stemming tokenizer for Portuguese (Brazil)." + }, + { + "value": "punjabi", + "name": "Punjabi", + "description": "Selects the Microsoft stemming tokenizer for Punjabi." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the Microsoft stemming tokenizer for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the Microsoft stemming tokenizer for Russian." + }, + { + "value": "serbianCyrillic", + "name": "SerbianCyrillic", + "description": "Selects the Microsoft stemming tokenizer for Serbian (Cyrillic)." + }, + { + "value": "serbianLatin", + "name": "SerbianLatin", + "description": "Selects the Microsoft stemming tokenizer for Serbian (Latin)." + }, + { + "value": "slovak", + "name": "Slovak", + "description": "Selects the Microsoft stemming tokenizer for Slovak." + }, + { + "value": "slovenian", + "name": "Slovenian", + "description": "Selects the Microsoft stemming tokenizer for Slovenian." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the Microsoft stemming tokenizer for Spanish." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the Microsoft stemming tokenizer for Swedish." + }, + { + "value": "tamil", + "name": "Tamil", + "description": "Selects the Microsoft stemming tokenizer for Tamil." + }, + { + "value": "telugu", + "name": "Telugu", + "description": "Selects the Microsoft stemming tokenizer for Telugu." + }, + { + "value": "turkish", + "name": "Turkish", + "description": "Selects the Microsoft stemming tokenizer for Turkish." + }, + { + "value": "ukrainian", + "name": "Ukrainian", + "description": "Selects the Microsoft stemming tokenizer for Ukrainian." + }, + { + "value": "urdu", + "name": "Urdu", + "description": "Selects the Microsoft stemming tokenizer for Urdu." + } + ] + }, + "description": "Lists the languages supported by the Microsoft language stemming tokenizer." + }, + "MicrosoftLanguageStemmingTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.MicrosoftLanguageStemmingTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Tokens longer than the maximum length are split. Maximum token length that can be used is 300 characters. Tokens longer than 300 characters are first split into tokens of length 300 and then each of those tokens is split based on the max token length set. Default is 255." + }, + "isSearchTokenizer": { + "type": "boolean", + "default": false, + "description": "A value indicating how the tokenizer is used. Set to true if used as the search tokenizer, set to false if used as the indexing tokenizer. Default is false." + }, + "language": { + "$ref": "#/definitions/MicrosoftStemmingTokenizerLanguage", + "description": "The language to use. The default is English." + } + }, + "description": "Divides text using language-specific rules and reduces words to their base forms." + }, + "NGramTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NGramTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + }, + "tokenChars": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenCharacterKind", + "x-nullable": false + }, + "description": "Character classes to keep in the tokens." + } + }, + "description": "Tokenizes the input into n-grams of the given size(s). This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenizer.html" + } + }, + "PathHierarchyTokenizerV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PathHierarchyTokenizerV2", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "delimiter": { + "type": "string", + "format": "char", + "default": "/", + "description": "The delimiter character to use. Default is \"/\"." + }, + "replacement": { + "type": "string", + "format": "char", + "default": "/", + "description": "A value that, if set, replaces the delimiter character. Default is \"/\"." + }, + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 300, + "maximum": 300, + "description": "The maximum token length. Default and maximum is 300." + }, + "reverse": { + "x-ms-client-name": "ReverseTokenOrder", + "type": "boolean", + "default": false, + "description": "A value indicating whether to generate tokens in reverse order. Default is false." + }, + "skip": { + "x-ms-client-name": "NumberOfTokensToSkip", + "type": "integer", + "format": "int32", + "default": 0, + "description": "The number of initial tokens to skip. Default is 0." + } + }, + "description": "Tokenizer for path-like hierarchies. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/path/PathHierarchyTokenizer.html" + } + }, + "PatternTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "pattern": { + "type": "string", + "default": "\\W+", + "description": "A regular expression pattern to match token separators. Default is an expression that matches one or more non-word characters." + }, + "flags": { + "$ref": "#/definitions/RegexFlags", + "description": "Regular expression flags." + }, + "group": { + "type": "integer", + "format": "int32", + "default": -1, + "description": "The zero-based ordinal of the matching group in the regular expression pattern to extract into tokens. Use -1 if you want to use the entire pattern to split the input into tokens, irrespective of matching groups. Default is -1." + } + }, + "description": "Tokenizer that uses regex pattern matching to construct distinct tokens. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternTokenizer.html" + } + }, + "LuceneStandardTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StandardTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split." + } + }, + "description": "Breaks text following the Unicode Text Segmentation rules. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html" + }, + "x-az-search-deprecated": true + }, + "LuceneStandardTokenizerV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StandardTokenizerV2", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Breaks text following the Unicode Text Segmentation rules. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html" + } + }, + "UaxUrlEmailTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.UaxUrlEmailTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Tokenizes urls and emails as one token. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/UAX29URLEmailTokenizer.html" + } + }, + "TokenFilter": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "A URI fragment specifying the type of token filter." + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Base type for token filters.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "AsciiFoldingTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.AsciiFoldingTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "preserveOriginal": { + "type": "boolean", + "default": false, + "description": "A value indicating whether the original token will be kept. Default is false." + } + }, + "description": "Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the \"Basic Latin\" Unicode block) into their ASCII equivalents, if such equivalents exist. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html" + } + }, + "CjkBigramTokenFilterScripts": { + "type": "string", + "enum": [ + "han", + "hiragana", + "katakana", + "hangul" + ], + "x-ms-enum": { + "name": "CjkBigramTokenFilterScripts", + "modelAsString": false, + "values": [ + { + "value": "han", + "name": "Han", + "description": "Ignore Han script when forming bigrams of CJK terms." + }, + { + "value": "hiragana", + "name": "Hiragana", + "description": "Ignore Hiragana script when forming bigrams of CJK terms." + }, + { + "value": "katakana", + "name": "Katakana", + "description": "Ignore Katakana script when forming bigrams of CJK terms." + }, + { + "value": "hangul", + "name": "Hangul", + "description": "Ignore Hangul script when forming bigrams of CJK terms." + } + ] + }, + "description": "Scripts that can be ignored by CjkBigramTokenFilter." + }, + "CjkBigramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CjkBigramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "ignoreScripts": { + "type": "array", + "items": { + "$ref": "#/definitions/CjkBigramTokenFilterScripts", + "x-nullable": false + }, + "description": "The scripts to ignore." + }, + "outputUnigrams": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to output both unigrams and bigrams (if true), or just bigrams (if false). Default is false." + } + }, + "description": "Forms bigrams of CJK terms that are generated from the standard tokenizer. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKBigramFilter.html" + } + }, + "CommonGramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CommonGramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "commonWords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of common words." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether common words matching will be case insensitive. Default is false." + }, + "queryMode": { + "x-ms-client-name": "UseQueryMode", + "type": "boolean", + "default": false, + "description": "A value that indicates whether the token filter is in query mode. When in query mode, the token filter generates bigrams and then removes common words and single terms followed by a common word. Default is false." + } + }, + "required": [ + "commonWords" + ], + "description": "Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/commongrams/CommonGramsFilter.html" + } + }, + "DictionaryDecompounderTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.DictionaryDecompounderTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "wordList": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of words to match against." + }, + "minWordSize": { + "type": "integer", + "format": "int32", + "default": 5, + "maximum": 300, + "description": "The minimum word size. Only words longer than this get processed. Default is 5. Maximum is 300." + }, + "minSubwordSize": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The minimum subword size. Only subwords longer than this are outputted. Default is 2. Maximum is 300." + }, + "maxSubwordSize": { + "type": "integer", + "format": "int32", + "default": 15, + "maximum": 300, + "description": "The maximum subword size. Only subwords shorter than this are outputted. Default is 15. Maximum is 300." + }, + "onlyLongestMatch": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to add only the longest matching subword to the output. Default is false." + } + }, + "required": [ + "wordList" + ], + "description": "Decomposes compound words found in many Germanic languages. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/compound/DictionaryCompoundWordTokenFilter.html" + } + }, + "EdgeNGramTokenFilterSide": { + "type": "string", + "enum": [ + "front", + "back" + ], + "x-ms-enum": { + "name": "EdgeNGramTokenFilterSide", + "modelAsString": false, + "values": [ + { + "value": "front", + "name": "Front", + "description": "Specifies that the n-gram should be generated from the front of the input." + }, + { + "value": "back", + "name": "Back", + "description": "Specifies that the n-gram should be generated from the back of the input." + } + ] + }, + "description": "Specifies which side of the input an n-gram should be generated from." + }, + "EdgeNGramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.EdgeNGramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "description": "The minimum n-gram length. Default is 1. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "description": "The maximum n-gram length. Default is 2." + }, + "side": { + "$ref": "#/definitions/EdgeNGramTokenFilterSide", + "default": "front", + "description": "Specifies which side of the input the n-gram should be generated from. Default is \"front\"." + } + }, + "description": "Generates n-grams of the given size(s) starting from the front or the back of an input token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html" + }, + "x-az-search-deprecated": true + }, + "EdgeNGramTokenFilterV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.EdgeNGramTokenFilterV2", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + }, + "side": { + "$ref": "#/definitions/EdgeNGramTokenFilterSide", + "default": "front", + "description": "Specifies which side of the input the n-gram should be generated from. Default is \"front\"." + } + }, + "description": "Generates n-grams of the given size(s) starting from the front or the back of an input token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html" + } + }, + "ElisionTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ElisionTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "articles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of articles to remove." + } + }, + "description": "Removes elisions. For example, \"l'avion\" (the plane) will be converted to \"avion\" (plane). This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html" + } + }, + "KeepTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeepTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "keepWords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of words to keep." + }, + "keepWordsCase": { + "x-ms-client-name": "LowerCaseKeepWords", + "type": "boolean", + "default": false, + "description": "A value indicating whether to lower case all words first. Default is false." + } + }, + "required": [ + "keepWords" + ], + "description": "A token filter that only keeps tokens with text contained in a specified list of words. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeepWordFilter.html" + } + }, + "KeywordMarkerTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeywordMarkerTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "keywords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of words to mark as keywords." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to ignore case. If true, all words are converted to lower case first. Default is false." + } + }, + "required": [ + "keywords" + ], + "description": "Marks terms as keywords. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeywordMarkerFilter.html" + } + }, + "LengthTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.LengthTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "min": { + "x-ms-client-name": "minLength", + "type": "integer", + "format": "int32", + "default": 0, + "maximum": 300, + "description": "The minimum length in characters. Default is 0. Maximum is 300. Must be less than the value of max." + }, + "max": { + "x-ms-client-name": "maxLength", + "type": "integer", + "format": "int32", + "default": 300, + "maximum": 300, + "description": "The maximum length in characters. Default and maximum is 300." + } + }, + "description": "Removes words that are too long or too short. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LengthFilter.html" + } + }, + "LimitTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.LimitTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "maxTokenCount": { + "type": "integer", + "format": "int32", + "default": 1, + "description": "The maximum number of tokens to produce. Default is 1." + }, + "consumeAllTokens": { + "type": "boolean", + "default": false, + "description": "A value indicating whether all tokens from the input must be consumed even if maxTokenCount is reached. Default is false." + } + }, + "description": "Limits the number of tokens while indexing. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LimitTokenCountFilter.html" + } + }, + "NGramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NGramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "description": "The minimum n-gram length. Default is 1. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "description": "The maximum n-gram length. Default is 2." + } + }, + "description": "Generates n-grams of the given size(s). This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html" + }, + "x-az-search-deprecated": true + }, + "NGramTokenFilterV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NGramTokenFilterV2", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + } + }, + "description": "Generates n-grams of the given size(s). This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html" + } + }, + "PatternCaptureTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternCaptureTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "patterns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of patterns to match against each token." + }, + "preserveOriginal": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to return the original token even if one of the patterns matches. Default is true." + } + }, + "required": [ + "patterns" + ], + "description": "Uses Java regexes to emit multiple tokens - one for each capture group in one or more patterns. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternCaptureGroupTokenFilter.html" + } + }, + "PatternReplaceTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternReplaceTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "pattern": { + "type": "string", + "description": "A regular expression pattern." + }, + "replacement": { + "type": "string", + "description": "The replacement text." + } + }, + "required": [ + "pattern", + "replacement" + ], + "description": "A character filter that replaces characters in the input string. It uses a regular expression to identify character sequences to preserve and a replacement pattern to identify characters to replace. For example, given the input text \"aa bb aa bb\", pattern \"(aa)\\s+(bb)\", and replacement \"$1#$2\", the result would be \"aa#bb aa#bb\". This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternReplaceFilter.html" + } + }, + "PhoneticEncoder": { + "type": "string", + "enum": [ + "metaphone", + "doubleMetaphone", + "soundex", + "refinedSoundex", + "caverphone1", + "caverphone2", + "cologne", + "nysiis", + "koelnerPhonetik", + "haasePhonetik", + "beiderMorse" + ], + "x-ms-enum": { + "name": "PhoneticEncoder", + "modelAsString": false, + "values": [ + { + "value": "metaphone", + "name": "Metaphone", + "description": "Encodes a token into a Metaphone value." + }, + { + "value": "doubleMetaphone", + "name": "DoubleMetaphone", + "description": "Encodes a token into a double metaphone value." + }, + { + "value": "soundex", + "name": "Soundex", + "description": "Encodes a token into a Soundex value." + }, + { + "value": "refinedSoundex", + "name": "RefinedSoundex", + "description": "Encodes a token into a Refined Soundex value." + }, + { + "value": "caverphone1", + "name": "Caverphone1", + "description": "Encodes a token into a Caverphone 1.0 value." + }, + { + "value": "caverphone2", + "name": "Caverphone2", + "description": "Encodes a token into a Caverphone 2.0 value." + }, + { + "value": "cologne", + "name": "Cologne", + "description": "Encodes a token into a Cologne Phonetic value." + }, + { + "value": "nysiis", + "name": "Nysiis", + "description": "Encodes a token into a NYSIIS value." + }, + { + "value": "koelnerPhonetik", + "name": "KoelnerPhonetik", + "description": "Encodes a token using the Kölner Phonetik algorithm." + }, + { + "value": "haasePhonetik", + "name": "HaasePhonetik", + "description": "Encodes a token using the Haase refinement of the Kölner Phonetik algorithm." + }, + { + "value": "beiderMorse", + "name": "BeiderMorse", + "description": "Encodes a token into a Beider-Morse value." + } + ] + }, + "description": "Identifies the type of phonetic encoder to use with a PhoneticTokenFilter." + }, + "PhoneticTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PhoneticTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "encoder": { + "$ref": "#/definitions/PhoneticEncoder", + "default": "metaphone", + "description": "The phonetic encoder to use. Default is \"metaphone\"." + }, + "replace": { + "x-ms-client-name": "ReplaceOriginalTokens", + "type": "boolean", + "default": true, + "description": "A value indicating whether encoded tokens should replace original tokens. If false, encoded tokens are added as synonyms. Default is true." + } + }, + "description": "Create tokens for phonetic matches. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-phonetic/org/apache/lucene/analysis/phonetic/package-tree.html" + } + }, + "ShingleTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ShingleTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "maxShingleSize": { + "type": "integer", + "format": "int32", + "default": 2, + "minimum": 2, + "description": "The maximum shingle size. Default and minimum value is 2." + }, + "minShingleSize": { + "type": "integer", + "format": "int32", + "default": 2, + "minimum": 2, + "description": "The minimum shingle size. Default and minimum value is 2. Must be less than the value of maxShingleSize." + }, + "outputUnigrams": { + "type": "boolean", + "default": true, + "description": "A value indicating whether the output stream will contain the input tokens (unigrams) as well as shingles. Default is true." + }, + "outputUnigramsIfNoShingles": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to output unigrams for those times when no shingles are available. This property takes precedence when outputUnigrams is set to false. Default is false." + }, + "tokenSeparator": { + "type": "string", + "default": " ", + "description": "The string to use when joining adjacent tokens to form a shingle. Default is a single space (\" \")." + }, + "filterToken": { + "type": "string", + "default": "_", + "description": "The string to insert for each position at which there is no token. Default is an underscore (\"_\")." + } + }, + "description": "Creates combinations of tokens as a single token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/shingle/ShingleFilter.html" + } + }, + "SnowballTokenFilterLanguage": { + "type": "string", + "enum": [ + "armenian", + "basque", + "catalan", + "danish", + "dutch", + "english", + "finnish", + "french", + "german", + "german2", + "hungarian", + "italian", + "kp", + "lovins", + "norwegian", + "porter", + "portuguese", + "romanian", + "russian", + "spanish", + "swedish", + "turkish" + ], + "x-ms-enum": { + "name": "SnowballTokenFilterLanguage", + "modelAsString": false, + "values": [ + { + "value": "armenian", + "name": "Armenian", + "description": "Selects the Lucene Snowball stemming tokenizer for Armenian." + }, + { + "value": "basque", + "name": "Basque", + "description": "Selects the Lucene Snowball stemming tokenizer for Basque." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the Lucene Snowball stemming tokenizer for Catalan." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the Lucene Snowball stemming tokenizer for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the Lucene Snowball stemming tokenizer for Dutch." + }, + { + "value": "english", + "name": "English", + "description": "Selects the Lucene Snowball stemming tokenizer for English." + }, + { + "value": "finnish", + "name": "Finnish", + "description": "Selects the Lucene Snowball stemming tokenizer for Finnish." + }, + { + "value": "french", + "name": "French", + "description": "Selects the Lucene Snowball stemming tokenizer for French." + }, + { + "value": "german", + "name": "German", + "description": "Selects the Lucene Snowball stemming tokenizer for German." + }, + { + "value": "german2", + "name": "German2", + "description": "Selects the Lucene Snowball stemming tokenizer that uses the German variant algorithm." + }, + { + "value": "hungarian", + "name": "Hungarian", + "description": "Selects the Lucene Snowball stemming tokenizer for Hungarian." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the Lucene Snowball stemming tokenizer for Italian." + }, + { + "value": "kp", + "name": "Kp", + "description": "Selects the Lucene Snowball stemming tokenizer for Dutch that uses the Kraaij-Pohlmann stemming algorithm." + }, + { + "value": "lovins", + "name": "Lovins", + "description": "Selects the Lucene Snowball stemming tokenizer for English that uses the Lovins stemming algorithm." + }, + { + "value": "norwegian", + "name": "Norwegian", + "description": "Selects the Lucene Snowball stemming tokenizer for Norwegian." + }, + { + "value": "porter", + "name": "Porter", + "description": "Selects the Lucene Snowball stemming tokenizer for English that uses the Porter stemming algorithm." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the Lucene Snowball stemming tokenizer for Portuguese." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the Lucene Snowball stemming tokenizer for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the Lucene Snowball stemming tokenizer for Russian." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the Lucene Snowball stemming tokenizer for Spanish." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the Lucene Snowball stemming tokenizer for Swedish." + }, + { + "value": "turkish", + "name": "Turkish", + "description": "Selects the Lucene Snowball stemming tokenizer for Turkish." + } + ] + }, + "description": "The language to use for a Snowball token filter." + }, + "SnowballTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SnowballTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "language": { + "$ref": "#/definitions/SnowballTokenFilterLanguage", + "description": "The language to use." + } + }, + "required": [ + "language" + ], + "description": "A filter that stems words using a Snowball-generated stemmer. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/snowball/SnowballFilter.html" + } + }, + "StemmerTokenFilterLanguage": { + "type": "string", + "enum": [ + "arabic", + "armenian", + "basque", + "brazilian", + "bulgarian", + "catalan", + "czech", + "danish", + "dutch", + "dutchKp", + "english", + "lightEnglish", + "minimalEnglish", + "possessiveEnglish", + "porter2", + "lovins", + "finnish", + "lightFinnish", + "french", + "lightFrench", + "minimalFrench", + "galician", + "minimalGalician", + "german", + "german2", + "lightGerman", + "minimalGerman", + "greek", + "hindi", + "hungarian", + "lightHungarian", + "indonesian", + "irish", + "italian", + "lightItalian", + "sorani", + "latvian", + "norwegian", + "lightNorwegian", + "minimalNorwegian", + "lightNynorsk", + "minimalNynorsk", + "portuguese", + "lightPortuguese", + "minimalPortuguese", + "portugueseRslp", + "romanian", + "russian", + "lightRussian", + "spanish", + "lightSpanish", + "swedish", + "lightSwedish", + "turkish" + ], + "x-ms-enum": { + "name": "StemmerTokenFilterLanguage", + "modelAsString": false, + "values": [ + { + "value": "arabic", + "name": "Arabic", + "description": "Selects the Lucene stemming tokenizer for Arabic." + }, + { + "value": "armenian", + "name": "Armenian", + "description": "Selects the Lucene stemming tokenizer for Armenian." + }, + { + "value": "basque", + "name": "Basque", + "description": "Selects the Lucene stemming tokenizer for Basque." + }, + { + "value": "brazilian", + "name": "Brazilian", + "description": "Selects the Lucene stemming tokenizer for Portuguese (Brazil)." + }, + { + "value": "bulgarian", + "name": "Bulgarian", + "description": "Selects the Lucene stemming tokenizer for Bulgarian." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the Lucene stemming tokenizer for Catalan." + }, + { + "value": "czech", + "name": "Czech", + "description": "Selects the Lucene stemming tokenizer for Czech." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the Lucene stemming tokenizer for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the Lucene stemming tokenizer for Dutch." + }, + { + "value": "dutchKp", + "name": "DutchKp", + "description": "Selects the Lucene stemming tokenizer for Dutch that uses the Kraaij-Pohlmann stemming algorithm." + }, + { + "value": "english", + "name": "English", + "description": "Selects the Lucene stemming tokenizer for English." + }, + { + "value": "lightEnglish", + "name": "LightEnglish", + "description": "Selects the Lucene stemming tokenizer for English that does light stemming." + }, + { + "value": "minimalEnglish", + "name": "MinimalEnglish", + "description": "Selects the Lucene stemming tokenizer for English that does minimal stemming." + }, + { + "value": "possessiveEnglish", + "name": "PossessiveEnglish", + "description": "Selects the Lucene stemming tokenizer for English that removes trailing possessives from words." + }, + { + "value": "porter2", + "name": "Porter2", + "description": "Selects the Lucene stemming tokenizer for English that uses the Porter2 stemming algorithm." + }, + { + "value": "lovins", + "name": "Lovins", + "description": "Selects the Lucene stemming tokenizer for English that uses the Lovins stemming algorithm." + }, + { + "value": "finnish", + "name": "Finnish", + "description": "Selects the Lucene stemming tokenizer for Finnish." + }, + { + "value": "lightFinnish", + "name": "LightFinnish", + "description": "Selects the Lucene stemming tokenizer for Finnish that does light stemming." + }, + { + "value": "french", + "name": "French", + "description": "Selects the Lucene stemming tokenizer for French." + }, + { + "value": "lightFrench", + "name": "LightFrench", + "description": "Selects the Lucene stemming tokenizer for French that does light stemming." + }, + { + "value": "minimalFrench", + "name": "MinimalFrench", + "description": "Selects the Lucene stemming tokenizer for French that does minimal stemming." + }, + { + "value": "galician", + "name": "Galician", + "description": "Selects the Lucene stemming tokenizer for Galician." + }, + { + "value": "minimalGalician", + "name": "MinimalGalician", + "description": "Selects the Lucene stemming tokenizer for Galician that does minimal stemming." + }, + { + "value": "german", + "name": "German", + "description": "Selects the Lucene stemming tokenizer for German." + }, + { + "value": "german2", + "name": "German2", + "description": "Selects the Lucene stemming tokenizer that uses the German variant algorithm." + }, + { + "value": "lightGerman", + "name": "LightGerman", + "description": "Selects the Lucene stemming tokenizer for German that does light stemming." + }, + { + "value": "minimalGerman", + "name": "MinimalGerman", + "description": "Selects the Lucene stemming tokenizer for German that does minimal stemming." + }, + { + "value": "greek", + "name": "Greek", + "description": "Selects the Lucene stemming tokenizer for Greek." + }, + { + "value": "hindi", + "name": "Hindi", + "description": "Selects the Lucene stemming tokenizer for Hindi." + }, + { + "value": "hungarian", + "name": "Hungarian", + "description": "Selects the Lucene stemming tokenizer for Hungarian." + }, + { + "value": "lightHungarian", + "name": "LightHungarian", + "description": "Selects the Lucene stemming tokenizer for Hungarian that does light stemming." + }, + { + "value": "indonesian", + "name": "Indonesian", + "description": "Selects the Lucene stemming tokenizer for Indonesian." + }, + { + "value": "irish", + "name": "Irish", + "description": "Selects the Lucene stemming tokenizer for Irish." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the Lucene stemming tokenizer for Italian." + }, + { + "value": "lightItalian", + "name": "LightItalian", + "description": "Selects the Lucene stemming tokenizer for Italian that does light stemming." + }, + { + "value": "sorani", + "name": "Sorani", + "description": "Selects the Lucene stemming tokenizer for Sorani." + }, + { + "value": "latvian", + "name": "Latvian", + "description": "Selects the Lucene stemming tokenizer for Latvian." + }, + { + "value": "norwegian", + "name": "Norwegian", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Bokmål)." + }, + { + "value": "lightNorwegian", + "name": "LightNorwegian", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Bokmål) that does light stemming." + }, + { + "value": "minimalNorwegian", + "name": "MinimalNorwegian", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Bokmål) that does minimal stemming." + }, + { + "value": "lightNynorsk", + "name": "LightNynorsk", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Nynorsk) that does light stemming." + }, + { + "value": "minimalNynorsk", + "name": "MinimalNynorsk", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Nynorsk) that does minimal stemming." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the Lucene stemming tokenizer for Portuguese." + }, + { + "value": "lightPortuguese", + "name": "LightPortuguese", + "description": "Selects the Lucene stemming tokenizer for Portuguese that does light stemming." + }, + { + "value": "minimalPortuguese", + "name": "MinimalPortuguese", + "description": "Selects the Lucene stemming tokenizer for Portuguese that does minimal stemming." + }, + { + "value": "portugueseRslp", + "name": "PortugueseRslp", + "description": "Selects the Lucene stemming tokenizer for Portuguese that uses the RSLP stemming algorithm." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the Lucene stemming tokenizer for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the Lucene stemming tokenizer for Russian." + }, + { + "value": "lightRussian", + "name": "LightRussian", + "description": "Selects the Lucene stemming tokenizer for Russian that does light stemming." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the Lucene stemming tokenizer for Spanish." + }, + { + "value": "lightSpanish", + "name": "LightSpanish", + "description": "Selects the Lucene stemming tokenizer for Spanish that does light stemming." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the Lucene stemming tokenizer for Swedish." + }, + { + "value": "lightSwedish", + "name": "LightSwedish", + "description": "Selects the Lucene stemming tokenizer for Swedish that does light stemming." + }, + { + "value": "turkish", + "name": "Turkish", + "description": "Selects the Lucene stemming tokenizer for Turkish." + } + ] + }, + "description": "The language to use for a stemmer token filter." + }, + "StemmerTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StemmerTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "language": { + "$ref": "#/definitions/StemmerTokenFilterLanguage", + "description": "The language to use." + } + }, + "required": [ + "language" + ], + "description": "Language specific stemming filter. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters" + } + }, + "StemmerOverrideTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StemmerOverrideTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "rules": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stemming rules in the following format: \"word => stem\", for example: \"ran => run\"." + } + }, + "required": [ + "rules" + ], + "description": "Provides the ability to override other stemming filters with custom dictionary-based stemming. Any dictionary-stemmed terms will be marked as keywords so that they will not be stemmed with stemmers down the chain. Must be placed before any stemming filters. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/StemmerOverrideFilter.html" + } + }, + "StopwordsList": { + "type": "string", + "enum": [ + "arabic", + "armenian", + "basque", + "brazilian", + "bulgarian", + "catalan", + "czech", + "danish", + "dutch", + "english", + "finnish", + "french", + "galician", + "german", + "greek", + "hindi", + "hungarian", + "indonesian", + "irish", + "italian", + "latvian", + "norwegian", + "persian", + "portuguese", + "romanian", + "russian", + "sorani", + "spanish", + "swedish", + "thai", + "turkish" + ], + "x-ms-enum": { + "name": "StopwordsList", + "modelAsString": false, + "values": [ + { + "value": "arabic", + "name": "Arabic", + "description": "Selects the stopword list for Arabic." + }, + { + "value": "armenian", + "name": "Armenian", + "description": "Selects the stopword list for Armenian." + }, + { + "value": "basque", + "name": "Basque", + "description": "Selects the stopword list for Basque." + }, + { + "value": "brazilian", + "name": "Brazilian", + "description": "Selects the stopword list for Portuguese (Brazil)." + }, + { + "value": "bulgarian", + "name": "Bulgarian", + "description": "Selects the stopword list for Bulgarian." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the stopword list for Catalan." + }, + { + "value": "czech", + "name": "Czech", + "description": "Selects the stopword list for Czech." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the stopword list for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the stopword list for Dutch." + }, + { + "value": "english", + "name": "English", + "description": "Selects the stopword list for English." + }, + { + "value": "finnish", + "name": "Finnish", + "description": "Selects the stopword list for Finnish." + }, + { + "value": "french", + "name": "French", + "description": "Selects the stopword list for French." + }, + { + "value": "galician", + "name": "Galician", + "description": "Selects the stopword list for Galician." + }, + { + "value": "german", + "name": "German", + "description": "Selects the stopword list for German." + }, + { + "value": "greek", + "name": "Greek", + "description": "Selects the stopword list for Greek." + }, + { + "value": "hindi", + "name": "Hindi", + "description": "Selects the stopword list for Hindi." + }, + { + "value": "hungarian", + "name": "Hungarian", + "description": "Selects the stopword list for Hungarian." + }, + { + "value": "indonesian", + "name": "Indonesian", + "description": "Selects the stopword list for Indonesian." + }, + { + "value": "irish", + "name": "Irish", + "description": "Selects the stopword list for Irish." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the stopword list for Italian." + }, + { + "value": "latvian", + "name": "Latvian", + "description": "Selects the stopword list for Latvian." + }, + { + "value": "norwegian", + "name": "Norwegian", + "description": "Selects the stopword list for Norwegian." + }, + { + "value": "persian", + "name": "Persian", + "description": "Selects the stopword list for Persian." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the stopword list for Portuguese." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the stopword list for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the stopword list for Russian." + }, + { + "value": "sorani", + "name": "Sorani", + "description": "Selects the stopword list for Sorani." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the stopword list for Spanish." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the stopword list for Swedish." + }, + { + "value": "thai", + "name": "Thai", + "description": "Selects the stopword list for Thai." + }, + { + "value": "turkish", + "name": "Turkish", + "description": "Selects the stopword list for Turkish." + } + ] + }, + "description": "Identifies a predefined list of language-specific stopwords." + }, + "StopwordsTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StopwordsTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of stopwords. This property and the stopwords list property cannot both be set." + }, + "stopwordsList": { + "$ref": "#/definitions/StopwordsList", + "default": "english", + "description": "A predefined list of stopwords to use. This property and the stopwords property cannot both be set. Default is English." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to ignore case. If true, all words are converted to lower case first. Default is false." + }, + "removeTrailing": { + "x-ms-client-name": "RemoveTrailingStopWords", + "type": "boolean", + "default": true, + "description": "A value indicating whether to ignore the last search term if it's a stop word. Default is true." + } + }, + "description": "Removes stop words from a token stream. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopFilter.html" + } + }, + "SynonymTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SynonymTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "synonyms": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of synonyms in following one of two formats: 1. incredible, unbelievable, fabulous => amazing - all terms on the left side of => symbol will be replaced with all terms on its right side; 2. incredible, unbelievable, fabulous, amazing - comma separated list of equivalent words. Set the expand option to change how this list is interpreted." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to case-fold input for matching. Default is false." + }, + "expand": { + "type": "boolean", + "default": true, + "description": "A value indicating whether all words in the list of synonyms (if => notation is not used) will map to one another. If true, all words in the list of synonyms (if => notation is not used) will map to one another. The following list: incredible, unbelievable, fabulous, amazing is equivalent to: incredible, unbelievable, fabulous, amazing => incredible, unbelievable, fabulous, amazing. If false, the following list: incredible, unbelievable, fabulous, amazing will be equivalent to: incredible, unbelievable, fabulous, amazing => incredible. Default is true." + } + }, + "required": [ + "synonyms" + ], + "description": "Matches single or multi-word synonyms in a token stream. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/synonym/SynonymFilter.html" + } + }, + "TruncateTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.TruncateTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "length": { + "type": "integer", + "format": "int32", + "default": 300, + "maximum": 300, + "description": "The length at which terms will be truncated. Default and maximum is 300." + } + }, + "description": "Truncates the terms to a specific length. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TruncateTokenFilter.html" + } + }, + "UniqueTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.UniqueTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "onlyOnSamePosition": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to remove duplicates only at the same position. Default is false." + } + }, + "description": "Filters out tokens with same text as the previous token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/RemoveDuplicatesTokenFilter.html" + } + }, + "WordDelimiterTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.WordDelimiterTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "generateWordParts": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to generate part words. If set, causes parts of words to be generated; for example \"AzureSearch\" becomes \"Azure\" \"Search\". Default is true." + }, + "generateNumberParts": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to generate number subwords. Default is true." + }, + "catenateWords": { + "type": "boolean", + "default": false, + "description": "A value indicating whether maximum runs of word parts will be catenated. For example, if this is set to true, \"Azure-Search\" becomes \"AzureSearch\". Default is false." + }, + "catenateNumbers": { + "type": "boolean", + "default": false, + "description": "A value indicating whether maximum runs of number parts will be catenated. For example, if this is set to true, \"1-2\" becomes \"12\". Default is false." + }, + "catenateAll": { + "type": "boolean", + "default": false, + "description": "A value indicating whether all subword parts will be catenated. For example, if this is set to true, \"Azure-Search-1\" becomes \"AzureSearch1\". Default is false." + }, + "splitOnCaseChange": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to split words on caseChange. For example, if this is set to true, \"AzureSearch\" becomes \"Azure\" \"Search\". Default is true." + }, + "preserveOriginal": { + "type": "boolean", + "default": false, + "description": "A value indicating whether original words will be preserved and added to the subword list. Default is false." + }, + "splitOnNumerics": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to split on numbers. For example, if this is set to true, \"Azure1Search\" becomes \"Azure\" \"1\" \"Search\". Default is true." + }, + "stemEnglishPossessive": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to remove trailing \"'s\" for each subword. Default is true." + }, + "protectedWords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of tokens to protect from being delimited." + } + }, + "description": "Splits words into subwords and performs optional transformations on subword groups. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/WordDelimiterFilter.html" + } + }, + "CharFilter": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "A URI fragment specifying the type of char filter." + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Base type for character filters.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "MappingCharFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.MappingCharFilter", + "allOf": [ + { + "$ref": "#/definitions/CharFilter" + } + ], + "properties": { + "mappings": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of mappings of the following format: \"a=>b\" (all occurrences of the character \"a\" will be replaced with character \"b\")." + } + }, + "required": [ + "mappings" + ], + "description": "A character filter that applies mappings defined with the mappings option. Matching is greedy (longest pattern matching at a given point wins). Replacement is allowed to be the empty string. This character filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/MappingCharFilter.html" + } + }, + "PatternReplaceCharFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternReplaceCharFilter", + "allOf": [ + { + "$ref": "#/definitions/CharFilter" + } + ], + "properties": { + "pattern": { + "type": "string", + "description": "A regular expression pattern." + }, + "replacement": { + "type": "string", + "description": "The replacement text." + } + }, + "required": [ + "pattern", + "replacement" + ], + "description": "A character filter that replaces characters in the input string. It uses a regular expression to identify character sequences to preserve and a replacement pattern to identify characters to replace. For example, given the input text \"aa bb aa bb\", pattern \"(aa)\\s+(bb)\", and replacement \"$1#$2\", the result would be \"aa#bb aa#bb\". This character filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternReplaceCharFilter.html" + } + }, + "Similarity": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string" + } + }, + "required": [ + "@odata.type" + ], + "description": "Base type for similarity algorithms. Similarity algorithms are used to calculate scores that tie queries to documents. The higher the score, the more relevant the document is to that specific query. Those scores are used to rank the search results.", + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/index-ranking-similarity" + } + }, + "ClassicSimilarity": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ClassicSimilarity", + "allOf": [ + { + "$ref": "#/definitions/Similarity" + } + ], + "description": "Legacy similarity algorithm which uses the Lucene TFIDFSimilarity implementation of TF-IDF. This variation of TF-IDF introduces static document length normalization as well as coordinating factors that penalize documents that only partially match the searched queries." + }, + "BM25Similarity": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.BM25Similarity", + "allOf": [ + { + "$ref": "#/definitions/Similarity" + } + ], + "properties": { + "k1": { + "type": "number", + "format": "double", + "description": "This property controls the scaling function between the term frequency of each matching terms and the final relevance score of a document-query pair. By default, a value of 1.2 is used. A value of 0.0 means the score does not scale with an increase in term frequency.", + "x-nullable": true + }, + "b": { + "type": "number", + "format": "double", + "description": "This property controls how the length of a document affects the relevance score. By default, a value of 0.75 is used. A value of 0.0 means no length normalization is applied, while a value of 1.0 means the score is fully normalized by the length of the document.", + "x-nullable": true + } + }, + "description": "Ranking function based on the Okapi BM25 similarity algorithm. BM25 is a TF-IDF-like algorithm that includes length normalization (controlled by the 'b' parameter) as well as term frequency saturation (controlled by the 'k1' parameter)." + }, + "VectorSearch": { + "type": "object", + "properties": { + "profiles": { + "type": "array", + "items": { + "$ref": "#/definitions/VectorSearchProfile" + }, + "description": "Defines combinations of configurations to use with vector search." + }, + "algorithms": { + "type": "array", + "items": { + "$ref": "#/definitions/VectorSearchAlgorithmConfiguration" + }, + "description": "Contains configuration options specific to the algorithm used during indexing or querying." + }, + "vectorizers": { + "type": "array", + "items": { + "$ref": "#/definitions/VectorSearchVectorizer" + }, + "description": "Contains configuration options on how to vectorize text vector queries." + }, + "compressions": { + "type": "array", + "items": { + "$ref": "#/definitions/VectorSearchCompressionConfiguration" + }, + "description": "Contains configuration options specific to the compression method used during indexing or querying." + } + }, + "description": "Contains configuration options related to vector search." + }, + "VectorSearchProfile": { + "type": "object", + "properties": { + "name": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name to associate with this particular vector search profile.", + "x-nullable": false + }, + "algorithm": { + "x-ms-client-name": "algorithmConfigurationName", + "type": "string", + "description": "The name of the vector search algorithm configuration that specifies the algorithm and optional parameters.", + "x-nullable": false + }, + "vectorizer": { + "x-ms-client-name": "vectorizerName", + "type": "string", + "description": "The name of the vectorization being configured for use with vector search.", + "x-nullable": false + }, + "compression": { + "x-ms-client-name": "compressionConfigurationName", + "type": "string", + "description": "The name of the compression method configuration that specifies the compression method and optional parameters.", + "x-nullable": false + } + }, + "required": [ + "name", + "algorithm" + ], + "description": "Defines a combination of configurations to use with vector search." + }, + "VectorSearchAlgorithmConfiguration": { + "type": "object", + "discriminator": "kind", + "properties": { + "name": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name to associate with this particular configuration.", + "x-nullable": false + }, + "kind": { + "$ref": "#/definitions/VectorSearchAlgorithmKind", + "description": "The name of the kind of algorithm being configured for use with vector search.", + "x-nullable": false + } + }, + "required": [ + "name", + "kind" + ], + "description": "Contains configuration options specific to the algorithm used during indexing or querying." + }, + "HnswVectorSearchAlgorithmConfiguration": { + "x-ms-client-name": "HnswAlgorithmConfiguration", + "type": "object", + "x-ms-discriminator-value": "hnsw", + "allOf": [ + { + "$ref": "#/definitions/VectorSearchAlgorithmConfiguration" + } + ], + "properties": { + "hnswParameters": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/HnswParameters", + "description": "Contains the parameters specific to HNSW algorithm." + } + }, + "description": "Contains configuration options specific to the HNSW approximate nearest neighbors algorithm used during indexing and querying. The HNSW algorithm offers a tunable trade-off between search speed and accuracy." + }, + "HnswParameters": { + "type": "object", + "properties": { + "m": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "minimum": 4, + "maximum": 10, + "default": 4, + "description": "The number of bi-directional links created for every new element during construction. Increasing this parameter value may improve recall and reduce retrieval times for datasets with high intrinsic dimensionality at the expense of increased memory consumption and longer indexing time." + }, + "efConstruction": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "minimum": 100, + "maximum": 1000, + "default": 400, + "description": "The size of the dynamic list containing the nearest neighbors, which is used during index time. Increasing this parameter may improve index quality, at the expense of increased indexing time. At a certain point, increasing this parameter leads to diminishing returns." + }, + "efSearch": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "minimum": 100, + "maximum": 1000, + "default": 500, + "description": "The size of the dynamic list containing the nearest neighbors, which is used during search time. Increasing this parameter may improve search results, at the expense of slower search. At a certain point, increasing this parameter leads to diminishing returns." + }, + "metric": { + "$ref": "#/definitions/VectorSearchAlgorithmMetric", + "x-nullable": true, + "description": "The similarity metric to use for vector comparisons." + } + }, + "description": "Contains the parameters specific to the HNSW algorithm." + }, + "ExhaustiveKnnVectorSearchAlgorithmConfiguration": { + "x-ms-client-name": "ExhaustiveKnnAlgorithmConfiguration", + "type": "object", + "x-ms-discriminator-value": "exhaustiveKnn", + "allOf": [ + { + "$ref": "#/definitions/VectorSearchAlgorithmConfiguration" + } + ], + "properties": { + "exhaustiveKnnParameters": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/ExhaustiveKnnParameters", + "description": "Contains the parameters specific to exhaustive KNN algorithm." + } + }, + "description": "Contains configuration options specific to the exhaustive KNN algorithm used during querying, which will perform brute-force search across the entire vector index." + }, + "ExhaustiveKnnParameters": { + "type": "object", + "properties": { + "metric": { + "$ref": "#/definitions/VectorSearchAlgorithmMetric", + "x-nullable": true, + "description": "The similarity metric to use for vector comparisons." + } + }, + "description": "Contains the parameters specific to exhaustive KNN algorithm." + }, + "VectorSearchAlgorithmMetric": { + "type": "string", + "enum": [ + "cosine", + "euclidean", + "dotProduct", + "hamming" + ], + "x-ms-enum": { + "name": "VectorSearchAlgorithmMetric", + "modelAsString": true, + "values": [ + { + "value": "cosine", + "name": "Cosine", + "description": "Measures the angle between vectors to quantify their similarity, disregarding magnitude. The smaller the angle, the closer the similarity." + }, + { + "value": "euclidean", + "name": "Euclidean", + "description": "Computes the straight-line distance between vectors in a multi-dimensional space. The smaller the distance, the closer the similarity." + }, + { + "value": "dotProduct", + "name": "DotProduct", + "description": "Calculates the sum of element-wise products to gauge alignment and magnitude similarity. The larger and more positive, the closer the similarity." + }, + { + "value": "hamming", + "name": "Hamming", + "description": "Only applicable to bit-packed binary data types. Determines dissimilarity by counting differing positions in binary vectors. The fewer differences, the closer the similarity." + } + ] + }, + "description": "The similarity metric to use for vector comparisons. It is recommended to choose the same similarity metric as the embedding model was trained on." + }, + "VectorSearchAlgorithmKind": { + "type": "string", + "enum": [ + "hnsw", + "exhaustiveKnn" + ], + "x-ms-enum": { + "name": "VectorSearchAlgorithmKind", + "modelAsString": true, + "values": [ + { + "value": "hnsw", + "name": "Hnsw", + "description": "HNSW (Hierarchical Navigable Small World), a type of approximate nearest neighbors algorithm." + }, + { + "value": "exhaustiveKnn", + "name": "ExhaustiveKnn", + "description": "Exhaustive KNN algorithm which will perform brute-force search." + } + ] + }, + "description": "The algorithm used for indexing and querying." + }, + "VectorSearchCompressionConfiguration": { + "type": "object", + "discriminator": "kind", + "properties": { + "name": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name to associate with this particular configuration.", + "x-nullable": false + }, + "kind": { + "$ref": "#/definitions/VectorSearchCompressionKind", + "description": "The name of the kind of compression method being configured for use with vector search.", + "x-nullable": false + }, + "rerankWithOriginalVectors": { + "type": "boolean", + "default": true, + "description": "If set to true, once the ordered set of results calculated using compressed vectors are obtained, they will be reranked again by recalculating the full-precision similarity scores. This will improve recall at the expense of latency." + }, + "defaultOversampling": { + "type": "number", + "format": "double", + "description": "Default oversampling factor. Oversampling will internally request more documents (specified by this multiplier) in the initial search. This increases the set of results that will be reranked using recomputed similarity scores from full-precision vectors. Minimum value is 1, meaning no oversampling (1x). This parameter can only be set when rerankWithOriginalVectors is true. Higher values improve recall at the expense of latency.", + "x-nullable": true + }, + "rescoringOptions": { + "type": "object", + "$ref": "#/definitions/RescoringOptions", + "description": "Contains the options for rescoring.", + "x-nullable": true + }, + "truncationDimension": { + "type": "integer", + "format": "int32", + "description": "The number of dimensions to truncate the vectors to. Truncating the vectors reduces the size of the vectors and the amount of data that needs to be transferred during search. This can save storage cost and improve search performance at the expense of recall. It should be only used for embeddings trained with Matryoshka Representation Learning (MRL) such as OpenAI text-embedding-3-large (small). The default value is null, which means no truncation.", + "x-nullable": true + } + }, + "required": [ + "name", + "kind" + ], + "description": "Contains configuration options specific to the compression method used during indexing or querying." + }, + "RescoringOptions": { + "x-ms-client-name": "RescoringOptions", + "type": "object", + "properties": { + "enableRescoring": { + "type": "boolean", + "default": true, + "description": "If set to true, after the initial search on the compressed vectors, the similarity scores are recalculated using the full-precision vectors. This will improve recall at the expense of latency.", + "x-nullable": true + }, + "defaultOversampling": { + "type": "number", + "format": "double", + "description": "Default oversampling factor. Oversampling retrieves a greater set of potential documents to offset the resolution loss due to quantization. This increases the set of results that will be rescored on full-precision vectors. Minimum value is 1, meaning no oversampling (1x). This parameter can only be set when 'enableRescoring' is true. Higher values improve recall at the expense of latency.", + "x-nullable": true + }, + "rescoreStorageMethod": { + "$ref": "#/definitions/VectorSearchCompressionRescoreStorageMethod", + "default": "preserveOriginals", + "description": "Controls the storage method for original vectors. This setting is immutable.", + "x-nullable": true + } + }, + "description": "Contains the options for rescoring." + }, + "ScalarQuantizationVectorSearchCompressionConfiguration": { + "x-ms-client-name": "ScalarQuantizationCompressionConfiguration", + "type": "object", + "x-ms-discriminator-value": "scalarQuantization", + "allOf": [ + { + "$ref": "#/definitions/VectorSearchCompressionConfiguration" + } + ], + "properties": { + "scalarQuantizationParameters": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/ScalarQuantizationParameters", + "description": "Contains the parameters specific to Scalar Quantization." + } + }, + "description": "Contains configuration options specific to the scalar quantization compression method used during indexing and querying." + }, + "ScalarQuantizationParameters": { + "type": "object", + "properties": { + "quantizedDataType": { + "$ref": "#/definitions/VectorSearchCompressionTargetDataType", + "x-nullable": true, + "description": "The quantized data type of compressed vector values." + } + }, + "description": "Contains the parameters specific to Scalar Quantization." + }, + "BinaryQuantizationVectorSearchCompressionConfiguration": { + "x-ms-client-name": "BinaryQuantizationCompressionConfiguration", + "type": "object", + "x-ms-discriminator-value": "binaryQuantization", + "allOf": [ + { + "$ref": "#/definitions/VectorSearchCompressionConfiguration" + } + ], + "description": "Contains configuration options specific to the binary quantization compression method used during indexing and querying." + }, + "VectorSearchCompressionTargetDataType": { + "type": "string", + "enum": [ + "int8" + ], + "x-ms-enum": { + "name": "VectorSearchCompressionTargetDataType", + "modelAsString": true, + "values": [ + { + "value": "int8", + "name": "Int8" + } + ] + }, + "description": "The quantized data type of compressed vector values." + }, + "VectorSearchCompressionKind": { + "type": "string", + "enum": [ + "scalarQuantization", + "binaryQuantization" + ], + "x-ms-enum": { + "name": "VectorSearchCompressionKind", + "modelAsString": true, + "values": [ + { + "value": "scalarQuantization", + "name": "ScalarQuantization", + "description": "Scalar Quantization, a type of compression method. In scalar quantization, the original vectors values are compressed to a narrower type by discretizing and representing each component of a vector using a reduced set of quantized values, thereby reducing the overall data size." + }, + { + "value": "binaryQuantization", + "name": "BinaryQuantization", + "description": "Binary Quantization, a type of compression method. In binary quantization, the original vectors values are compressed to the narrower binary type by discretizing and representing each component of a vector using binary values, thereby reducing the overall data size." + } + ] + }, + "description": "The compression method used for indexing and querying." + }, + "VectorSearchCompressionRescoreStorageMethod": { + "type": "string", + "enum": [ + "preserveOriginals", + "discardOriginals" + ], + "x-ms-enum": { + "name": "VectorSearchCompressionRescoreStorageMethod", + "modelAsString": true, + "values": [ + { + "value": "preserveOriginals", + "name": "PreserveOriginals", + "description": "This option preserves the original full-precision vectors. Choose this option for maximum flexibility and highest quality of compressed search results. This consumes more storage but allows for rescoring and oversampling." + }, + { + "value": "discardOriginals", + "name": "DiscardOriginals", + "description": "This option discards the original full-precision vectors. Choose this option for maximum storage savings. Since this option does not allow for rescoring and oversampling, it will often cause slight to moderate reductions in quality." + } + ] + }, + "description": "The storage method for the original full-precision vectors used for rescoring and internal index operations." + }, + "VectorSearchVectorizer": { + "type": "object", + "discriminator": "kind", + "properties": { + "name": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name to associate with this particular vectorization method.", + "x-nullable": false + }, + "kind": { + "$ref": "#/definitions/VectorSearchVectorizerKind", + "description": "The name of the kind of vectorization method being configured for use with vector search.", + "x-nullable": false + } + }, + "required": [ + "name", + "kind" + ], + "description": "Specifies the vectorization method to be used during query time." + }, + "AzureOpenAIVectorizer": { + "type": "object", + "x-ms-discriminator-value": "azureOpenAI", + "allOf": [ + { + "$ref": "#/definitions/VectorSearchVectorizer" + } + ], + "properties": { + "azureOpenAIParameters": { + "x-ms-client-name": "AzureOpenAIParameters", + "$ref": "#/definitions/AzureOpenAIParameters", + "description": "Contains the parameters specific to Azure OpenAI embedding vectorization." + } + }, + "description": "Specifies the Azure OpenAI resource used to vectorize a query string." + }, + "AzureOpenAIParameters": { + "type": "object", + "properties": { + "resourceUri": { + "type": "string", + "format": "uri", + "description": "The resource URI of the Azure OpenAI resource." + }, + "deploymentId": { + "x-ms-client-name": "deploymentName", + "type": "string", + "description": "ID of the Azure OpenAI model deployment on the designated resource." + }, + "apiKey": { + "type": "string", + "description": "API key of the designated Azure OpenAI resource." + }, + "authIdentity": { + "$ref": "#/definitions/SearchIndexerDataIdentity", + "x-nullable": true, + "description": "The user-assigned managed identity used for outbound connections." + }, + "modelName": { + "$ref": "#/definitions/AzureOpenAIModelName", + "description": "The name of the embedding model that is deployed at the provided deploymentId path." + } + }, + "description": "Specifies the parameters for connecting to the Azure OpenAI resource." + }, + "AzureOpenAIModelName": { + "type": "string", + "enum": [ + "text-embedding-ada-002", + "text-embedding-3-large", + "text-embedding-3-small" + ], + "x-ms-enum": { + "name": "AzureOpenAIModelName", + "modelAsString": true, + "values": [ + { + "value": "text-embedding-ada-002", + "name": "TextEmbeddingAda002" + }, + { + "value": "text-embedding-3-large", + "name": "TextEmbedding3Large" + }, + { + "value": "text-embedding-3-small", + "name": "TextEmbedding3Small" + } + ] + }, + "description": "The Azure Open AI model name that will be called." + }, + "WebApiVectorizer": { + "type": "object", + "x-ms-discriminator-value": "customWebApi", + "allOf": [ + { + "$ref": "#/definitions/VectorSearchVectorizer" + } + ], + "properties": { + "customWebApiParameters": { + "x-ms-client-name": "WebApiParameters", + "$ref": "#/definitions/WebApiParameters", + "description": "Specifies the properties of the user-defined vectorizer." + } + }, + "description": "Specifies a user-defined vectorizer for generating the vector embedding of a query string. Integration of an external vectorizer is achieved using the custom Web API interface of a skillset." + }, + "WebApiParameters": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The URI of the Web API providing the vectorizer." + }, + "httpHeaders": { + "$ref": "#/definitions/WebApiHttpHeaders", + "description": "The headers required to make the HTTP request." + }, + "httpMethod": { + "type": "string", + "description": "The method for the HTTP request." + }, + "timeout": { + "type": "string", + "format": "duration", + "description": "The desired timeout for the request. Default is 30 seconds." + }, + "authResourceId": { + "type": "string", + "x-nullable": true, + "x-ms-format": "arm-id", + "description": "Applies to custom endpoints that connect to external code in an Azure function or some other application that provides the transformations. This value should be the application ID created for the function or app when it was registered with Azure Active Directory. When specified, the vectorization connects to the function or app using a managed ID (either system or user-assigned) of the search service and the access token of the function or app, using this value as the resource id for creating the scope of the access token." + }, + "authIdentity": { + "$ref": "#/definitions/SearchIndexerDataIdentity", + "x-nullable": true, + "description": "The user-assigned managed identity used for outbound connections. If an authResourceId is provided and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to \"none\", the value of this property is cleared." + } + }, + "description": "Specifies the properties for connecting to a user-defined vectorizer." + }, + "AIServicesVisionVectorizer": { + "type": "object", + "x-ms-discriminator-value": "aiServicesVision", + "allOf": [ + { + "$ref": "#/definitions/VectorSearchVectorizer" + } + ], + "properties": { + "aiServicesVisionParameters": { + "x-ms-client-name": "AIServicesVisionParameters", + "$ref": "#/definitions/AIServicesVisionParameters", + "description": "Contains the parameters specific to AI Services Vision embedding vectorization." + } + }, + "description": "Specifies the AI Services Vision parameters for vectorizing a query image or text." + }, + "AIServicesVisionParameters": { + "type": "object", + "properties": { + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the AI Services Vision service. It will default to the latest available when not specified." + }, + "resourceUri": { + "type": "string", + "format": "uri", + "description": "The resource URI of the AI Services resource." + }, + "apiKey": { + "type": "string", + "description": "API key of the designated AI Services resource." + }, + "authIdentity": { + "$ref": "#/definitions/SearchIndexerDataIdentity", + "x-nullable": true, + "description": "The user-assigned managed identity used for outbound connections. If an authResourceId is provided and it's not specified, the system-assigned managed identity is used. On updates to the index, if the identity is unspecified, the value remains unchanged. If set to \"none\", the value of this property is cleared." + } + }, + "description": "Specifies the AI Services Vision parameters for vectorizing a query image or text.", + "required": [ + "resourceUri", + "modelVersion" + ] + }, + "AMLVectorizer": { + "type": "object", + "x-ms-discriminator-value": "aml", + "allOf": [ + { + "$ref": "#/definitions/VectorSearchVectorizer" + } + ], + "properties": { + "amlParameters": { + "x-ms-client-name": "AMLParameters", + "$ref": "#/definitions/AMLParameters", + "description": "Specifies the properties of the AML vectorizer." + } + }, + "description": "Specifies an Azure Machine Learning endpoint deployed via the Azure AI Studio Model Catalog for generating the vector embedding of a query string." + }, + "AMLParameters": { + "type": "object", + "properties": { + "uri": { + "x-ms-client-name": "ScoringUri", + "type": "string", + "format": "uri", + "x-nullable": true, + "description": "(Required for no authentication or key authentication) The scoring URI of the AML service to which the JSON payload will be sent. Only the https URI scheme is allowed." + }, + "key": { + "x-ms-client-name": "AuthenticationKey", + "type": "string", + "x-nullable": true, + "description": "(Required for key authentication) The key for the AML service." + }, + "resourceId": { + "type": "string", + "x-nullable": true, + "description": "(Required for token authentication). The Azure Resource Manager resource ID of the AML service. It should be in the format subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}." + }, + "timeout": { + "type": "string", + "format": "duration", + "x-nullable": true, + "description": "(Optional) When specified, indicates the timeout for the http client making the API call." + }, + "region": { + "type": "string", + "x-nullable": true, + "description": "(Optional for token authentication). The region the AML service is deployed in." + }, + "modelName": { + "$ref": "#/definitions/AIStudioModelCatalogName", + "description": "The name of the embedding model from the Azure AI Studio Catalog that is deployed at the provided endpoint." + } + }, + "required": [ + "uri" + ], + "description": "Specifies the properties for connecting to an AML vectorizer." + }, + "AIStudioModelCatalogName": { + "type": "string", + "enum": [ + "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32", + "OpenAI-CLIP-Image-Text-Embeddings-ViT-Large-Patch14-336", + "Facebook-DinoV2-Image-Embeddings-ViT-Base", + "Facebook-DinoV2-Image-Embeddings-ViT-Giant", + "Cohere-embed-v3-english", + "Cohere-embed-v3-multilingual" + ], + "x-ms-enum": { + "name": "AIStudioModelCatalogName", + "modelAsString": true, + "values": [ + { + "value": "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32", + "name": "OpenAI_CLIP_Image_Text_Embeddings_vit_base_patch32" + }, + { + "value": "OpenAI-CLIP-Image-Text-Embeddings-ViT-Large-Patch14-336", + "name": "OpenAI_CLIP_Image_Text_Embeddings_ViT_Large_Patch14_336" + }, + { + "value": "Facebook-DinoV2-Image-Embeddings-ViT-Base", + "name": "Facebook_DinoV2_Image_Embeddings_ViT_Base" + }, + { + "value": "Facebook-DinoV2-Image-Embeddings-ViT-Giant", + "name": "Facebook_DinoV2_Image_Embeddings_ViT_Giant" + }, + { + "value": "Cohere-embed-v3-english", + "name": "Cohere_embed_v3_english" + }, + { + "value": "Cohere-embed-v3-multilingual", + "name": "Cohere_embed_v3_multilingual" + } + ] + }, + "description": "The name of the embedding model from the Azure AI Studio Catalog that will be called." + }, + "VectorSearchVectorizerKind": { + "type": "string", + "enum": [ + "azureOpenAI", + "customWebApi", + "aiServicesVision", + "aml" + ], + "x-ms-enum": { + "name": "VectorSearchVectorizerKind", + "modelAsString": true, + "values": [ + { + "value": "azureOpenAI", + "name": "AzureOpenAI", + "description": "Generate embeddings using an Azure OpenAI resource at query time." + }, + { + "value": "customWebApi", + "name": "CustomWebApi", + "description": "Generate embeddings using a custom web endpoint at query time." + }, + { + "value": "aiServicesVision", + "name": "AIServicesVision", + "description": "Generate embeddings for an image or text input at query time using the Azure AI Services Vision Vectorize API." + }, + { + "value": "aml", + "name": "AML", + "description": "Generate embeddings using an Azure Machine Learning endpoint deployed via the Azure AI Studio Model Catalog at query time." + } + ] + }, + "description": "The vectorization method to be used during query time." + }, + "DataSourceCredentials": { + "properties": { + "connectionString": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Data-Source" + }, + "type": "string", + "description": "The connection string for the datasource. Set to `<unchanged>` (with brackets) if you don't want the connection string updated. Set to `<redacted>` if you want to remove the connection string value from the datasource." + } + }, + "description": "Represents credentials that can be used to connect to a datasource." + }, + "SearchIndexerDataContainer": { + "properties": { + "name": { + "type": "string", + "description": "The name of the table or view (for Azure SQL data source) or collection (for CosmosDB data source) that will be indexed." + }, + "query": { + "type": "string", + "description": "A query that is applied to this data container. The syntax and meaning of this parameter is datasource-specific. Not supported by Azure SQL datasources." + } + }, + "required": [ + "name" + ], + "description": "Represents information about the entity (such as Azure SQL table or CosmosDB collection) that will be indexed." + }, + "SearchIndexerDataIdentity": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "A URI fragment specifying the type of identity." + } + }, + "required": [ + "@odata.type" + ], + "description": "Abstract base type for data identities." + }, + "SearchIndexerDataNoneIdentity": { + "description": "Clears the identity property of a datasource.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.DataNoneIdentity", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerDataIdentity" + } + ] + }, + "SearchIndexerDataUserAssignedIdentity": { + "description": "Specifies the identity for a datasource to use.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.DataUserAssignedIdentity", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerDataIdentity" + } + ], + "properties": { + "userAssignedIdentity": { + "type": "string", + "description": "The fully qualified Azure resource Id of a user assigned managed identity typically in the form \"/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId\" that should have been assigned to the search service." + } + }, + "required": [ + "userAssignedIdentity" + ] + }, + "DataChangeDetectionPolicy": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "A URI fragment specifying the type of data change detection policy." + } + }, + "required": [ + "@odata.type" + ], + "description": "Base type for data change detection policies." + }, + "HighWaterMarkChangeDetectionPolicy": { + "description": "Defines a data change detection policy that captures changes based on the value of a high water mark column.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataChangeDetectionPolicy" + } + ], + "properties": { + "highWaterMarkColumnName": { + "type": "string", + "description": "The name of the high water mark column." + } + }, + "required": [ + "highWaterMarkColumnName" + ] + }, + "SqlIntegratedChangeTrackingPolicy": { + "description": "Defines a data change detection policy that captures changes using the Integrated Change Tracking feature of Azure SQL Database.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataChangeDetectionPolicy" + } + ] + }, + "DataDeletionDetectionPolicy": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "A URI fragment specifying the type of data deletion detection policy." + } + }, + "required": [ + "@odata.type" + ], + "description": "Base type for data deletion detection policies." + }, + "SoftDeleteColumnDeletionDetectionPolicy": { + "description": "Defines a data deletion detection policy that implements a soft-deletion strategy. It determines whether an item should be deleted based on the value of a designated 'soft delete' column.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataDeletionDetectionPolicy" + } + ], + "properties": { + "softDeleteColumnName": { + "type": "string", + "description": "The name of the column to use for soft-deletion detection." + }, + "softDeleteMarkerValue": { + "type": "string", + "description": "The marker value that identifies an item as deleted." + } + } + }, + "NativeBlobSoftDeleteDeletionDetectionPolicy": { + "description": "Defines a data deletion detection policy utilizing Azure Blob Storage's native soft delete feature for deletion detection.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataDeletionDetectionPolicy" + } + ] + }, + "SearchIndexerDataSourceType": { + "type": "string", + "enum": [ + "azuresql", + "cosmosdb", + "azureblob", + "azuretable", + "mysql", + "adlsgen2", + "onelake" + ], + "x-ms-enum": { + "name": "SearchIndexerDataSourceType", + "modelAsString": true, + "values": [ + { + "value": "azuresql", + "name": "AzureSql", + "description": "Indicates an Azure SQL datasource." + }, + { + "value": "cosmosdb", + "name": "CosmosDb", + "description": "Indicates a CosmosDB datasource." + }, + { + "value": "azureblob", + "name": "AzureBlob", + "description": "Indicates an Azure Blob datasource." + }, + { + "value": "azuretable", + "name": "AzureTable", + "description": "Indicates an Azure Table datasource." + }, + { + "value": "mysql", + "name": "MySql", + "description": "Indicates a MySql datasource." + }, + { + "value": "adlsgen2", + "name": "AdlsGen2", + "description": "Indicates an ADLS Gen2 datasource." + }, + { + "value": "onelake", + "name": "OneLake", + "description": "Indicates a Microsoft Fabric OneLake datasource." + } + ] + }, + "description": "Defines the type of a datasource." + }, + "SearchIndexerDataSource": { + "properties": { + "name": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the datasource." + }, + "description": { + "type": "string", + "description": "The description of the datasource." + }, + "type": { + "$ref": "#/definitions/SearchIndexerDataSourceType", + "description": "The type of the datasource." + }, + "credentials": { + "$ref": "#/definitions/DataSourceCredentials", + "description": "Credentials for the datasource." + }, + "container": { + "$ref": "#/definitions/SearchIndexerDataContainer", + "description": "The data container for the datasource." + }, + "identity": { + "$ref": "#/definitions/SearchIndexerDataIdentity", + "x-nullable": true, + "description": "An explicit managed identity to use for this datasource. If not specified and the connection string is a managed identity, the system-assigned managed identity is used. If not specified, the value remains unchanged. If \"none\" is specified, the value of this property is cleared." + }, + "dataChangeDetectionPolicy": { + "$ref": "#/definitions/DataChangeDetectionPolicy", + "x-nullable": true, + "description": "The data change detection policy for the datasource." + }, + "dataDeletionDetectionPolicy": { + "$ref": "#/definitions/DataDeletionDetectionPolicy", + "x-nullable": true, + "description": "The data deletion detection policy for the datasource." + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the data source." + }, + "encryptionKey": { + "$ref": "#/definitions/SearchResourceEncryptionKey", + "description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your datasource definition when you want full assurance that no one, not even Microsoft, can decrypt your data source definition. Once you have encrypted your data source definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your datasource definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.", + "externalDocs": { + "url": "https://aka.ms/azure-search-encryption-with-cmk" + }, + "x-nullable": true + } + }, + "required": [ + "name", + "type", + "credentials", + "container" + ], + "description": "Represents a datasource definition, which can be used to configure an indexer." + }, + "ListDataSourcesResult": { + "properties": { + "value": { + "x-ms-client-name": "DataSources", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexerDataSource" + }, + "description": "The datasources in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a List Datasources request. If successful, it includes the full definitions of all datasources." + }, + "IndexingSchedule": { + "properties": { + "interval": { + "type": "string", + "format": "duration", + "description": "The interval of time between indexer executions." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The time when an indexer should start running." + } + }, + "required": [ + "interval" + ], + "description": "Represents a schedule for indexer execution." + }, + "IndexingParameters": { + "properties": { + "batchSize": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type." + }, + "maxFailedItems": { + "type": "integer", + "format": "int32", + "default": 0, + "x-nullable": true, + "description": "The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0." + }, + "maxFailedItemsPerBatch": { + "type": "integer", + "format": "int32", + "default": 0, + "x-nullable": true, + "description": "The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0." + }, + "configuration": { + "$ref": "#/definitions/IndexingParametersConfiguration" + } + }, + "description": "Represents parameters for indexer execution.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/create-indexer#parameters" + } + }, + "IndexingParametersConfiguration": { + "type": "object", + "properties": { + "parsingMode": { + "$ref": "#/definitions/ParsingMode" + }, + "excludedFileNameExtensions": { + "type": "string", + "default": "", + "description": "Comma-delimited list of filename extensions to ignore when processing from Azure blob storage. For example, you could exclude \".png, .mp4\" to skip over those files during indexing." + }, + "indexedFileNameExtensions": { + "type": "string", + "default": "", + "description": "Comma-delimited list of filename extensions to select when processing from Azure blob storage. For example, you could focus indexing on specific application files \".docx, .pptx, .msg\" to specifically include those file types." + }, + "failOnUnsupportedContentType": { + "type": "boolean", + "default": false, + "description": "For Azure blobs, set to false if you want to continue indexing when an unsupported content type is encountered, and you don't know all the content types (file extensions) in advance." + }, + "failOnUnprocessableDocument": { + "type": "boolean", + "default": false, + "description": "For Azure blobs, set to false if you want to continue indexing if a document fails indexing." + }, + "indexStorageMetadataOnlyForOversizedDocuments": { + "type": "boolean", + "default": false, + "description": "For Azure blobs, set this property to true to still index storage metadata for blob content that is too large to process. Oversized blobs are treated as errors by default. For limits on blob size, see https://learn.microsoft.com/azure/search/search-limits-quotas-capacity." + }, + "delimitedTextHeaders": { + "type": "string", + "description": "For CSV blobs, specifies a comma-delimited list of column headers, useful for mapping source fields to destination fields in an index." + }, + "delimitedTextDelimiter": { + "type": "string", + "description": "For CSV blobs, specifies the end-of-line single-character delimiter for CSV files where each line starts a new document (for example, \"|\")." + }, + "firstLineContainsHeaders": { + "type": "boolean", + "default": true, + "description": "For CSV blobs, indicates that the first (non-blank) line of each blob contains headers." + }, + "markdownParsingSubmode": { + "$ref": "#/definitions/MarkdownParsingSubmode", + "x-nullable": true + }, + "markdownHeaderDepth": { + "$ref": "#/definitions/MarkdownHeaderDepth", + "x-nullable": true + }, + "documentRoot": { + "type": "string", + "description": "For JSON arrays, given a structured or semi-structured document, you can specify a path to the array using this property." + }, + "dataToExtract": { + "$ref": "#/definitions/DataToExtract" + }, + "imageAction": { + "$ref": "#/definitions/ImageAction" + }, + "allowSkillsetToReadFileData": { + "type": "boolean", + "default": false, + "description": "If true, will create a path //document//file_data that is an object representing the original file data downloaded from your blob data source. This allows you to pass the original file data to a custom skill for processing within the enrichment pipeline, or to the Document Extraction skill." + }, + "pdfTextRotationAlgorithm": { + "$ref": "#/definitions/PdfTextRotationAlgorithm" + }, + "executionEnvironment": { + "$ref": "#/definitions/ExecutionEnvironment" + }, + "queryTimeout": { + "type": "string", + "default": "00:05:00", + "description": "Increases the timeout beyond the 5-minute default for Azure SQL database data sources, specified in the format \"hh:mm:ss\"." + } + }, + "additionalProperties": true, + "description": "A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/create-indexer#parameters" + } + }, + "ParsingMode": { + "type": "string", + "enum": [ + "default", + "text", + "delimitedText", + "json", + "jsonArray", + "jsonLines", + "markdown" + ], + "x-ms-enum": { + "name": "BlobIndexerParsingMode", + "modelAsString": true, + "values": [ + { + "value": "default", + "name": "Default", + "description": "Set to default for normal file processing." + }, + { + "value": "text", + "name": "Text", + "description": "Set to text to improve indexing performance on plain text files in blob storage." + }, + { + "value": "delimitedText", + "name": "DelimitedText", + "description": "Set to delimitedText when blobs are plain CSV files." + }, + { + "value": "json", + "name": "Json", + "description": "Set to json to extract structured content from JSON files." + }, + { + "value": "jsonArray", + "name": "JsonArray", + "description": "Set to jsonArray to extract individual elements of a JSON array as separate documents." + }, + { + "value": "jsonLines", + "name": "JsonLines", + "description": "Set to jsonLines to extract individual JSON entities, separated by a new line, as separate documents." + }, + { + "value": "markdown", + "name": "Markdown", + "description": "Set to markdown to extract content from markdown files." + } + ] + }, + "default": "default", + "description": "Represents the parsing mode for indexing from an Azure blob data source." + }, + "DataToExtract": { + "type": "string", + "enum": [ + "storageMetadata", + "allMetadata", + "contentAndMetadata" + ], + "x-ms-enum": { + "name": "BlobIndexerDataToExtract", + "modelAsString": true, + "values": [ + { + "value": "storageMetadata", + "name": "StorageMetadata", + "description": "Indexes just the standard blob properties and user-specified metadata." + }, + { + "value": "allMetadata", + "name": "AllMetadata", + "description": "Extracts metadata provided by the Azure blob storage subsystem and the content-type specific metadata (for example, metadata unique to just .png files are indexed)." + }, + { + "value": "contentAndMetadata", + "name": "ContentAndMetadata", + "description": "Extracts all metadata and textual content from each blob." + } + ] + }, + "default": "contentAndMetadata", + "description": "Specifies the data to extract from Azure blob storage and tells the indexer which data to extract from image content when \"imageAction\" is set to a value other than \"none\". This applies to embedded image content in a .PDF or other application, or image files such as .jpg and .png, in Azure blobs." + }, + "ImageAction": { + "type": "string", + "enum": [ + "none", + "generateNormalizedImages", + "generateNormalizedImagePerPage" + ], + "x-ms-enum": { + "name": "BlobIndexerImageAction", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Ignores embedded images or image files in the data set. This is the default." + }, + { + "value": "generateNormalizedImages", + "name": "GenerateNormalizedImages", + "description": "Extracts text from images (for example, the word \"STOP\" from a traffic stop sign), and embeds it into the content field. This action requires that \"dataToExtract\" is set to \"contentAndMetadata\". A normalized image refers to additional processing resulting in uniform image output, sized and rotated to promote consistent rendering when you include images in visual search results. This information is generated for each image when you use this option." + }, + { + "value": "generateNormalizedImagePerPage", + "name": "GenerateNormalizedImagePerPage", + "description": "Extracts text from images (for example, the word \"STOP\" from a traffic stop sign), and embeds it into the content field, but treats PDF files differently in that each page will be rendered as an image and normalized accordingly, instead of extracting embedded images. Non-PDF file types will be treated the same as if \"generateNormalizedImages\" was set." + } + ] + }, + "default": "none", + "description": "Determines how to process embedded images and image files in Azure blob storage. Setting the \"imageAction\" configuration to any value other than \"none\" requires that a skillset also be attached to that indexer." + }, + "PdfTextRotationAlgorithm": { + "type": "string", + "enum": [ + "none", + "detectAngles" + ], + "x-ms-enum": { + "name": "BlobIndexerPDFTextRotationAlgorithm", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Leverages normal text extraction. This is the default." + }, + { + "value": "detectAngles", + "name": "DetectAngles", + "description": "May produce better and more readable text extraction from PDF files that have rotated text within them. Note that there may be a small performance speed impact when this parameter is used. This parameter only applies to PDF files, and only to PDFs with embedded text. If the rotated text appears within an embedded image in the PDF, this parameter does not apply." + } + ] + }, + "default": "none", + "description": "Determines algorithm for text extraction from PDF files in Azure blob storage." + }, + "MarkdownParsingSubmode": { + "type": "string", + "enum": [ + "oneToMany", + "oneToOne" + ], + "x-ms-enum": { + "name": "MarkdownParsingSubmode", + "modelAsString": true, + "values": [ + { + "value": "oneToMany", + "name": "OneToMany", + "description": "Indicates that each section of the markdown file (up to a specified depth) will be parsed into individual search documents. This can result in a single markdown file producing multiple search documents. This is the default sub-mode." + }, + { + "value": "oneToOne", + "name": "OneToOne", + "description": "Indicates that each markdown file will be parsed into a single search document." + } + ] + }, + "default": "oneToMany", + "description": "Specifies the submode that will determine whether a markdown file will be parsed into exactly one search document or multiple search documents. Default is `oneToMany`." + }, + "MarkdownHeaderDepth": { + "type": "string", + "enum": [ + "h1", + "h2", + "h3", + "h4", + "h5", + "h6" + ], + "x-ms-enum": { + "name": "MarkdownHeaderDepth", + "modelAsString": true, + "values": [ + { + "value": "h1", + "name": "h1", + "description": "Indicates that headers up to a level of h1 will be considered while grouping markdown content." + }, + { + "value": "h2", + "name": "h2", + "description": "Indicates that headers up to a level of h2 will be considered while grouping markdown content." + }, + { + "value": "h3", + "name": "h3", + "description": "Indicates that headers up to a level of h3 will be considered while grouping markdown content." + }, + { + "value": "h4", + "name": "h4", + "description": "Indicates that headers up to a level of h4 will be considered while grouping markdown content." + }, + { + "value": "h5", + "name": "h5", + "description": "Indicates that headers up to a level of h5 will be considered while grouping markdown content." + }, + { + "value": "h6", + "name": "h6", + "description": "Indicates that headers up to a level of h6 will be considered while grouping markdown content. This is the default." + } + ] + }, + "default": "h6", + "description": "Specifies the max header depth that will be considered while grouping markdown content. Default is `h6`." + }, + "ExecutionEnvironment": { + "type": "string", + "enum": [ + "standard", + "private" + ], + "x-ms-enum": { + "name": "IndexerExecutionEnvironment", + "modelAsString": true, + "values": [ + { + "value": "standard", + "name": "standard", + "description": "Indicates that the search service can determine where the indexer should execute. This is the default environment when nothing is specified and is the recommended value." + }, + { + "value": "private", + "name": "private", + "description": "Indicates that the indexer should run with the environment provisioned specifically for the search service. This should only be specified as the execution environment if the indexer needs to access resources securely over shared private link resources." + } + ] + }, + "default": "standard", + "description": "Specifies the environment in which the indexer should execute." + }, + "FieldMappingFunction": { + "properties": { + "name": { + "type": "string", + "description": "The name of the field mapping function." + }, + "parameters": { + "type": "object", + "x-nullable": true, + "additionalProperties": true, + "description": "A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type." + } + }, + "required": [ + "name" + ], + "description": "Represents a function that transforms a value from a data source before indexing.", + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "FieldMapping": { + "properties": { + "sourceFieldName": { + "type": "string", + "description": "The name of the field in the data source." + }, + "targetFieldName": { + "type": "string", + "description": "The name of the target field in the index. Same as the source field name by default." + }, + "mappingFunction": { + "$ref": "#/definitions/FieldMappingFunction", + "x-nullable": true, + "description": "A function to apply to each source field value before indexing." + } + }, + "required": [ + "sourceFieldName" + ], + "description": "Defines a mapping between a field in a data source and a target field in an index.", + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "SearchIndexer": { + "properties": { + "name": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the indexer." + }, + "description": { + "type": "string", + "description": "The description of the indexer." + }, + "dataSourceName": { + "type": "string", + "description": "The name of the datasource from which this indexer reads data." + }, + "skillsetName": { + "type": "string", + "description": "The name of the skillset executing with this indexer." + }, + "targetIndexName": { + "type": "string", + "description": "The name of the index to which this indexer writes data." + }, + "schedule": { + "$ref": "#/definitions/IndexingSchedule", + "x-nullable": true, + "description": "The schedule for this indexer." + }, + "parameters": { + "$ref": "#/definitions/IndexingParameters", + "x-nullable": true, + "description": "Parameters for indexer execution." + }, + "fieldMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/FieldMapping" + }, + "description": "Defines mappings between fields in the data source and corresponding target fields in the index.", + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "outputFieldMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/FieldMapping" + }, + "description": "Output field mappings are applied after enrichment and immediately before indexing.", + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "disabled": { + "x-ms-client-name": "IsDisabled", + "type": "boolean", + "default": false, + "x-nullable": true, + "description": "A value indicating whether the indexer is disabled. Default is false." + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the indexer." + }, + "encryptionKey": { + "$ref": "#/definitions/SearchResourceEncryptionKey", + "description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your indexer definition (as well as indexer execution status) when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your indexer definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your indexer definition (and indexer execution status) will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.", + "externalDocs": { + "url": "https://aka.ms/azure-search-encryption-with-cmk" + }, + "x-nullable": true + }, + "cache": { + "$ref": "#/definitions/SearchIndexerCache", + "x-nullable": true, + "description": "Adds caching to an enrichment pipeline to allow for incremental modification steps without having to rebuild the index every time.", + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/search-howto-incremental-index" + } + } + }, + "required": [ + "name", + "dataSourceName", + "targetIndexName" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Indexer-operations" + }, + "description": "Represents an indexer." + }, + "ListIndexersResult": { + "properties": { + "value": { + "x-ms-client-name": "Indexers", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexer" + }, + "description": "The indexers in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a List Indexers request. If successful, it includes the full definitions of all indexers." + }, + "SearchIndexerError": { + "properties": { + "key": { + "type": "string", + "readOnly": true, + "description": "The key of the item for which indexing failed." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "The message describing the error that occurred while processing the item." + }, + "statusCode": { + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The status code indicating why the indexing operation failed. Possible values include: 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the source at which the error originated. For example, this could refer to a particular skill in the attached skillset. This may not be always available." + }, + "details": { + "type": "string", + "readOnly": true, + "description": "Additional, verbose details about the error to assist in debugging the indexer. This may not be always available." + }, + "documentationLink": { + "type": "string", + "readOnly": true, + "description": "A link to a troubleshooting guide for these classes of errors. This may not be always available." + } + }, + "required": [ + "errorMessage", + "statusCode" + ], + "description": "Represents an item- or document-level indexing error." + }, + "SearchIndexerWarning": { + "properties": { + "key": { + "type": "string", + "readOnly": true, + "description": "The key of the item which generated a warning." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The message describing the warning that occurred while processing the item." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the source at which the warning originated. For example, this could refer to a particular skill in the attached skillset. This may not be always available." + }, + "details": { + "type": "string", + "readOnly": true, + "description": "Additional, verbose details about the warning to assist in debugging the indexer. This may not be always available." + }, + "documentationLink": { + "type": "string", + "readOnly": true, + "description": "A link to a troubleshooting guide for these classes of warnings. This may not be always available." + } + }, + "required": [ + "message" + ], + "description": "Represents an item-level warning." + }, + "IndexerExecutionResult": { + "properties": { + "status": { + "$ref": "#/definitions/IndexerExecutionStatus", + "readOnly": true, + "description": "The outcome of this indexer execution." + }, + "statusDetail": { + "$ref": "#/definitions/IndexerExecutionStatusDetail", + "readOnly": true, + "description": "The outcome of this indexer execution." + }, + "currentState": { + "$ref": "#/definitions/IndexerCurrentState", + "readOnly": true, + "description": "All of the state that defines and dictates the indexer's current execution." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "The error message indicating the top-level error, if any." + }, + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The start time of this indexer execution." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true, + "description": "The end time of this indexer execution, if the execution has already completed." + }, + "errors": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexerError" + }, + "description": "The item-level indexing errors." + }, + "warnings": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexerWarning" + }, + "description": "The item-level indexing warnings." + }, + "itemsProcessed": { + "x-ms-client-name": "ItemCount", + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The number of items that were processed during this indexer execution. This includes both successfully processed items and items where indexing was attempted but failed." + }, + "itemsFailed": { + "x-ms-client-name": "FailedItemCount", + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The number of items that failed to be indexed during this indexer execution." + }, + "initialTrackingState": { + "type": "string", + "readOnly": true, + "description": "Change tracking state with which an indexer execution started." + }, + "finalTrackingState": { + "type": "string", + "readOnly": true, + "description": "Change tracking state with which an indexer execution finished." + } + }, + "required": [ + "status", + "errors", + "warnings", + "itemsProcessed", + "itemsFailed" + ], + "description": "Represents the result of an individual indexer execution." + }, + "IndexerExecutionStatus": { + "type": "string", + "enum": [ + "transientFailure", + "success", + "inProgress", + "reset" + ], + "x-ms-enum": { + "name": "IndexerExecutionStatus", + "modelAsString": false, + "values": [ + { + "value": "transientFailure", + "name": "TransientFailure", + "description": "An indexer invocation has failed, but the failure may be transient. Indexer invocations will continue per schedule." + }, + { + "value": "success", + "name": "Success", + "description": "Indexer execution completed successfully." + }, + { + "value": "inProgress", + "name": "InProgress", + "description": "Indexer execution is in progress." + }, + { + "value": "reset", + "name": "Reset", + "description": "Indexer has been reset." + } + ] + }, + "x-nullable": false, + "description": "Represents the status of an individual indexer execution." + }, + "SearchIndexerStatus": { + "properties": { + "status": { + "$ref": "#/definitions/IndexerStatus", + "readOnly": true, + "description": "Overall indexer status." + }, + "lastResult": { + "$ref": "#/definitions/IndexerExecutionResult", + "readOnly": true, + "description": "The result of the most recent or an in-progress indexer execution." + }, + "executionHistory": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/IndexerExecutionResult" + }, + "description": "History of the recent indexer executions, sorted in reverse chronological order." + }, + "limits": { + "$ref": "#/definitions/SearchIndexerLimits", + "readOnly": true, + "description": "The execution limits for the indexer." + } + }, + "required": [ + "status", + "executionHistory", + "limits" + ], + "description": "Represents the current status and execution history of an indexer." + }, + "IndexerStatus": { + "type": "string", + "enum": [ + "unknown", + "error", + "running" + ], + "x-ms-enum": { + "name": "IndexerStatus", + "modelAsString": false, + "values": [ + { + "value": "unknown", + "name": "Unknown", + "description": "Indicates that the indexer is in an unknown state." + }, + { + "value": "error", + "name": "Error", + "description": "Indicates that the indexer experienced an error that cannot be corrected without human intervention." + }, + { + "value": "running", + "name": "Running", + "description": "Indicates that the indexer is running normally." + } + ] + }, + "x-nullable": false, + "description": "Represents the overall indexer status." + }, + "IndexerExecutionStatusDetail": { + "type": "string", + "enum": [ + "resetDocs" + ], + "x-ms-enum": { + "name": "IndexerExecutionStatusDetail", + "modelAsString": true, + "values": [ + { + "value": "resetDocs", + "name": "ResetDocs", + "description": "Indicates that the reset that occurred was for a call to ResetDocs." + } + ] + }, + "description": "Details the status of an individual indexer execution." + }, + "IndexerCurrentState": { + "type": "object", + "properties": { + "mode": { + "$ref": "#/definitions/IndexingMode", + "readOnly": true, + "description": "The mode the indexer is running in." + }, + "allDocsInitialChangeTrackingState": { + "type": "string", + "readOnly": true, + "description": "Change tracking state used when indexing starts on all documents in the datasource." + }, + "allDocsFinalChangeTrackingState": { + "type": "string", + "readOnly": true, + "description": "Change tracking state value when indexing finishes on all documents in the datasource." + }, + "resetDocsInitialChangeTrackingState": { + "type": "string", + "readOnly": true, + "description": "Change tracking state used when indexing starts on select, reset documents in the datasource." + }, + "resetDocsFinalChangeTrackingState": { + "type": "string", + "readOnly": true, + "description": "Change tracking state value when indexing finishes on select, reset documents in the datasource." + }, + "resetDocumentKeys": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "The list of document keys that have been reset. The document key is the document's unique identifier for the data in the search index. The indexer will prioritize selectively re-ingesting these keys." + }, + "resetDatasourceDocumentIds": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "The list of datasource document ids that have been reset. The datasource document id is the unique identifier for the data in the datasource. The indexer will prioritize selectively re-ingesting these ids." + } + }, + "description": "Represents all of the state that defines and dictates the indexer's current execution." + }, + "IndexingMode": { + "type": "string", + "enum": [ + "indexingAllDocs", + "indexingResetDocs" + ], + "x-ms-enum": { + "name": "IndexingMode", + "modelAsString": true, + "values": [ + { + "value": "indexingAllDocs", + "name": "IndexingAllDocs", + "description": "The indexer is indexing all documents in the datasource." + }, + { + "value": "indexingResetDocs", + "name": "indexingResetDocs", + "description": "The indexer is indexing selective, reset documents in the datasource. The documents being indexed are defined on indexer status." + } + ] + }, + "x-nullable": false, + "description": "Represents the mode the indexer is executing in." + }, + "SearchIndexerLimits": { + "properties": { + "maxRunTime": { + "type": "string", + "format": "duration", + "readOnly": true, + "description": "The maximum duration that the indexer is permitted to run for one execution." + }, + "maxDocumentExtractionSize": { + "type": "number", + "format": "int64", + "readOnly": true, + "description": "The maximum size of a document, in bytes, which will be considered valid for indexing." + }, + "maxDocumentContentCharactersToExtract": { + "type": "number", + "format": "int64", + "readOnly": true, + "description": "The maximum number of characters that will be extracted from a document picked up for indexing." + } + } + }, + "SearchField": { + "properties": { + "name": { + "type": "string", + "description": "The name of the field, which must be unique within the fields collection of the index or parent field.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" + } + }, + "type": { + "$ref": "#/definitions/SearchFieldDataType", + "description": "The data type of the field.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/supported-data-types" + } + }, + "key": { + "type": "boolean", + "description": "A value indicating whether the field uniquely identifies documents in the index. Exactly one top-level field in each index must be chosen as the key field and it must be of type Edm.String. Key fields can be used to look up documents directly and update or delete specific documents. Default is false for simple fields and null for complex fields." + }, + "retrievable": { + "type": "boolean", + "description": "A value indicating whether the field can be returned in a search result. You can disable this option if you want to use a field (for example, margin) as a filter, sorting, or scoring mechanism but do not want the field to be visible to the end user. This property must be true for key fields, and it must be null for complex fields. This property can be changed on existing fields. Enabling this property does not cause any increase in index storage requirements. Default is true for simple fields, false for vector fields, and null for complex fields." + }, + "stored": { + "type": "boolean", + "description": "An immutable value indicating whether the field will be persisted separately on disk to be returned in a search result. You can disable this option if you don't plan to return the field contents in a search response to save on storage overhead. This can only be set during index creation and only for vector fields. This property cannot be changed for existing fields or set as false for new fields. If this property is set as false, the property 'retrievable' must also be set to false. This property must be true or unset for key fields, for new fields, and for non-vector fields, and it must be null for complex fields. Disabling this property will reduce index storage requirements. The default is true for vector fields." + }, + "searchable": { + "type": "boolean", + "description": "A value indicating whether the field is full-text searchable. This means it will undergo analysis such as word-breaking during indexing. If you set a searchable field to a value like \"sunny day\", internally it will be split into the individual tokens \"sunny\" and \"day\". This enables full-text searches for these terms. Fields of type Edm.String or Collection(Edm.String) are searchable by default. This property must be false for simple fields of other non-string data types, and it must be null for complex fields. Note: searchable fields consume extra space in your index to accommodate additional tokenized versions of the field value for full-text searches. If you want to save space in your index and you don't need a field to be included in searches, set searchable to false." + }, + "filterable": { + "type": "boolean", + "description": "A value indicating whether to enable the field to be referenced in $filter queries. filterable differs from searchable in how strings are handled. Fields of type Edm.String or Collection(Edm.String) that are filterable do not undergo word-breaking, so comparisons are for exact matches only. For example, if you set such a field f to \"sunny day\", $filter=f eq 'sunny' will find no matches, but $filter=f eq 'sunny day' will. This property must be null for complex fields. Default is true for simple fields and null for complex fields." + }, + "sortable": { + "type": "boolean", + "description": "A value indicating whether to enable the field to be referenced in $orderby expressions. By default, the search engine sorts results by score, but in many experiences users will want to sort by fields in the documents. A simple field can be sortable only if it is single-valued (it has a single value in the scope of the parent document). Simple collection fields cannot be sortable, since they are multi-valued. Simple sub-fields of complex collections are also multi-valued, and therefore cannot be sortable. This is true whether it's an immediate parent field, or an ancestor field, that's the complex collection. Complex fields cannot be sortable and the sortable property must be null for such fields. The default for sortable is true for single-valued simple fields, false for multi-valued simple fields, and null for complex fields." + }, + "facetable": { + "type": "boolean", + "description": "A value indicating whether to enable the field to be referenced in facet queries. Typically used in a presentation of search results that includes hit count by category (for example, search for digital cameras and see hits by brand, by megapixels, by price, and so on). This property must be null for complex fields. Fields of type Edm.GeographyPoint or Collection(Edm.GeographyPoint) cannot be facetable. Default is true for all other simple fields." + }, + "analyzer": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Language-support" + }, + "$ref": "#/definitions/LexicalAnalyzerName", + "description": "The name of the analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields.", + "x-nullable": true + }, + "searchAnalyzer": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Language-support" + }, + "$ref": "#/definitions/LexicalAnalyzerName", + "description": "The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. This analyzer can be updated on an existing field. Must be null for complex fields.", + "x-nullable": true + }, + "indexAnalyzer": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Language-support" + }, + "$ref": "#/definitions/LexicalAnalyzerName", + "description": "The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields.", + "x-nullable": true + }, + "normalizer": { + "externalDocs": { + "url": "https://aka.ms/azs-normalizers" + }, + "$ref": "#/definitions/LexicalNormalizerName", + "description": "The name of the normalizer to use for the field. This option can be used only with fields with filterable, sortable, or facetable enabled. Once the normalizer is chosen, it cannot be changed for the field. Must be null for complex fields.", + "x-nullable": true + }, + "dimensions": { + "x-ms-client-name": "vectorSearchDimensions", + "type": "integer", + "format": "int32", + "x-nullable": true, + "minimum": 2, + "maximum": 2048, + "description": "The dimensionality of the vector field." + }, + "vectorSearchProfile": { + "x-ms-client-name": "vectorSearchProfileName", + "type": "string", + "x-nullable": true, + "description": "The name of the vector search profile that specifies the algorithm and vectorizer to use when searching the vector field." + }, + "vectorEncoding": { + "x-ms-client-name": "VectorEncodingFormat", + "$ref": "#/definitions/VectorEncodingFormat", + "description": "The encoding format to interpret the field contents.", + "x-nullable": true + }, + "synonymMaps": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Synonym-Map-operations" + }, + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of the names of synonym maps to associate with this field. This option can be used only with searchable fields. Currently only one synonym map per field is supported. Assigning a synonym map to a field ensures that query terms targeting that field are expanded at query-time using the rules in the synonym map. This attribute can be changed on existing fields. Must be null or an empty collection for complex fields." + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchField" + }, + "description": "A list of sub-fields if this is a field of type Edm.ComplexType or Collection(Edm.ComplexType). Must be null or empty for simple fields." + } + }, + "required": [ + "name", + "type" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Index" + }, + "description": "Represents a field in an index definition, which describes the name, data type, and search behavior of a field." + }, + "TextWeights": { + "properties": { + "weights": { + "type": "object", + "additionalProperties": { + "type": "number", + "format": "double", + "x-nullable": false + }, + "description": "The dictionary of per-field weights to boost document scoring. The keys are field names and the values are the weights for each field." + } + }, + "required": [ + "weights" + ], + "description": "Defines weights on index fields for which matches should boost scoring in search queries." + }, + "ScoringFunction": { + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Indicates the type of function to use. Valid values include magnitude, freshness, distance, and tag. The function type must be lower case." + }, + "fieldName": { + "type": "string", + "description": "The name of the field used as input to the scoring function." + }, + "boost": { + "type": "number", + "format": "double", + "description": "A multiplier for the raw score. Must be a positive number not equal to 1.0." + }, + "interpolation": { + "$ref": "#/definitions/ScoringFunctionInterpolation", + "description": "A value indicating how boosting will be interpolated across document scores; defaults to \"Linear\"." + } + }, + "required": [ + "type", + "fieldName", + "boost" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Base type for functions that can modify document scores during ranking." + }, + "DistanceScoringFunction": { + "x-ms-discriminator-value": "distance", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "distance": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/DistanceScoringParameters", + "description": "Parameter values for the distance scoring function." + } + }, + "required": [ + "distance" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores based on distance from a geographic location." + }, + "DistanceScoringParameters": { + "properties": { + "referencePointParameter": { + "type": "string", + "description": "The name of the parameter passed in search queries to specify the reference location." + }, + "boostingDistance": { + "type": "number", + "format": "double", + "description": "The distance in kilometers from the reference location where the boosting range ends." + } + }, + "required": [ + "referencePointParameter", + "boostingDistance" + ], + "description": "Provides parameter values to a distance scoring function." + }, + "FreshnessScoringFunction": { + "x-ms-discriminator-value": "freshness", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "freshness": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/FreshnessScoringParameters", + "description": "Parameter values for the freshness scoring function." + } + }, + "required": [ + "freshness" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores based on the value of a date-time field." + }, + "FreshnessScoringParameters": { + "properties": { + "boostingDuration": { + "type": "string", + "format": "duration", + "description": "The expiration period after which boosting will stop for a particular document." + } + }, + "required": [ + "boostingDuration" + ], + "description": "Provides parameter values to a freshness scoring function." + }, + "MagnitudeScoringFunction": { + "x-ms-discriminator-value": "magnitude", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "magnitude": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/MagnitudeScoringParameters", + "description": "Parameter values for the magnitude scoring function." + } + }, + "required": [ + "magnitude" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores based on the magnitude of a numeric field." + }, + "MagnitudeScoringParameters": { + "properties": { + "boostingRangeStart": { + "type": "number", + "format": "double", + "description": "The field value at which boosting starts." + }, + "boostingRangeEnd": { + "type": "number", + "format": "double", + "description": "The field value at which boosting ends." + }, + "constantBoostBeyondRange": { + "x-ms-client-name": "ShouldBoostBeyondRangeByConstant", + "type": "boolean", + "description": "A value indicating whether to apply a constant boost for field values beyond the range end value; default is false." + } + }, + "required": [ + "boostingRangeStart", + "boostingRangeEnd" + ], + "description": "Provides parameter values to a magnitude scoring function." + }, + "TagScoringFunction": { + "x-ms-discriminator-value": "tag", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "tag": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/TagScoringParameters", + "description": "Parameter values for the tag scoring function." + } + }, + "required": [ + "tag" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores of documents with string values matching a given list of tags." + }, + "TagScoringParameters": { + "properties": { + "tagsParameter": { + "type": "string", + "description": "The name of the parameter passed in search queries to specify the list of tags to compare against the target field." + } + }, + "required": [ + "tagsParameter" + ], + "description": "Provides parameter values to a tag scoring function." + }, + "ScoringFunctionInterpolation": { + "type": "string", + "enum": [ + "linear", + "constant", + "quadratic", + "logarithmic" + ], + "x-ms-enum": { + "name": "ScoringFunctionInterpolation", + "modelAsString": false, + "values": [ + { + "value": "linear", + "name": "Linear", + "description": "Boosts scores by a linearly decreasing amount. This is the default interpolation for scoring functions." + }, + { + "value": "constant", + "name": "Constant", + "description": "Boosts scores by a constant factor." + }, + { + "value": "quadratic", + "name": "Quadratic", + "description": "Boosts scores by an amount that decreases quadratically. Boosts decrease slowly for higher scores, and more quickly as the scores decrease. This interpolation option is not allowed in tag scoring functions." + }, + { + "value": "logarithmic", + "name": "Logarithmic", + "description": "Boosts scores by an amount that decreases logarithmically. Boosts decrease quickly for higher scores, and more slowly as the scores decrease. This interpolation option is not allowed in tag scoring functions." + } + ] + }, + "description": "Defines the function used to interpolate score boosting across a range of documents." + }, + "ScoringProfile": { + "properties": { + "name": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the scoring profile." + }, + "text": { + "x-ms-client-name": "TextWeights", + "$ref": "#/definitions/TextWeights", + "description": "Parameters that boost scoring based on text matches in certain index fields.", + "x-nullable": true + }, + "functions": { + "type": "array", + "items": { + "$ref": "#/definitions/ScoringFunction" + }, + "description": "The collection of functions that influence the scoring of documents." + }, + "functionAggregation": { + "$ref": "#/definitions/ScoringFunctionAggregation", + "description": "A value indicating how the results of individual scoring functions should be combined. Defaults to \"Sum\". Ignored if there are no scoring functions." + } + }, + "required": [ + "name" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines parameters for a search index that influence scoring in search queries." + }, + "ScoringFunctionAggregation": { + "type": "string", + "enum": [ + "sum", + "average", + "minimum", + "maximum", + "firstMatching" + ], + "x-ms-enum": { + "name": "ScoringFunctionAggregation", + "modelAsString": false, + "values": [ + { + "value": "sum", + "name": "Sum", + "description": "Boost scores by the sum of all scoring function results." + }, + { + "value": "average", + "name": "Average", + "description": "Boost scores by the average of all scoring function results." + }, + { + "value": "minimum", + "name": "Minimum", + "description": "Boost scores by the minimum of all scoring function results." + }, + { + "value": "maximum", + "name": "Maximum", + "description": "Boost scores by the maximum of all scoring function results." + }, + { + "value": "firstMatching", + "name": "FirstMatching", + "description": "Boost scores using the first applicable scoring function in the scoring profile." + } + ] + }, + "description": "Defines the aggregation function used to combine the results of all the scoring functions in a scoring profile." + }, + "CorsOptions": { + "properties": { + "allowedOrigins": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of origins from which JavaScript code will be granted access to your index. Can contain a list of hosts of the form {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow all origins (not recommended)." + }, + "maxAgeInSeconds": { + "type": "integer", + "format": "int64", + "description": "The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes.", + "x-nullable": true + } + }, + "required": [ + "allowedOrigins" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Index" + }, + "description": "Defines options to control Cross-Origin Resource Sharing (CORS) for an index." + }, + "Suggester": { + "properties": { + "name": { + "type": "string", + "description": "The name of the suggester." + }, + "searchMode": { + "type": "string", + "enum": [ + "analyzingInfixMatching" + ], + "x-ms-enum": { + "name": "SuggesterSearchMode", + "modelAsString": false, + "values": [ + { + "value": "analyzingInfixMatching", + "name": "AnalyzingInfixMatching", + "description": "Matches consecutive whole terms and prefixes in a field. For example, for the field 'The fastest brown fox', the queries 'fast' and 'fastest brow' would both match." + } + ] + }, + "description": "A value indicating the capabilities of the suggester." + }, + "sourceFields": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to which the suggester applies. Each field must be searchable." + } + }, + "required": [ + "name", + "searchMode", + "sourceFields" + ], + "description": "Defines how the Suggest API should apply to a group of fields in the index." + }, + "SearchIndex": { + "properties": { + "name": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the index." + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchField" + }, + "description": "The fields of the index." + }, + "scoringProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ScoringProfile" + }, + "description": "The scoring profiles for the index." + }, + "defaultScoringProfile": { + "type": "string", + "description": "The name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used." + }, + "corsOptions": { + "$ref": "#/definitions/CorsOptions", + "description": "Options to control Cross-Origin Resource Sharing (CORS) for the index.", + "x-nullable": true + }, + "suggesters": { + "type": "array", + "items": { + "$ref": "#/definitions/Suggester" + }, + "description": "The suggesters for the index." + }, + "analyzers": { + "type": "array", + "items": { + "$ref": "#/definitions/LexicalAnalyzer" + }, + "description": "The analyzers for the index.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "tokenizers": { + "type": "array", + "items": { + "$ref": "#/definitions/LexicalTokenizer" + }, + "description": "The tokenizers for the index.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilter" + }, + "description": "The token filters for the index.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilter" + }, + "description": "The character filters for the index.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "normalizers": { + "type": "array", + "items": { + "$ref": "#/definitions/LexicalNormalizer" + }, + "description": "The normalizers for the index.", + "externalDocs": { + "url": "https://aka.ms/azs-custom-normalizers" + } + }, + "encryptionKey": { + "$ref": "#/definitions/SearchResourceEncryptionKey", + "description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data. Once you have encrypted your data, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.", + "externalDocs": { + "url": "https://aka.ms/azure-search-encryption-with-cmk" + }, + "x-nullable": true + }, + "similarity": { + "$ref": "#/definitions/Similarity", + "description": "The type of similarity algorithm to be used when scoring and ranking the documents matching a search query. The similarity algorithm can only be defined at index creation time and cannot be modified on existing indexes. If null, the ClassicSimilarity algorithm is used.", + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/index-ranking-similarity" + } + }, + "semantic": { + "$ref": "#/definitions/SemanticSettings", + "description": "Defines parameters for a search index that influence semantic capabilities.", + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/semantic-search-overview" + }, + "x-ms-client-name": "SemanticSearch", + "x-nullable": true + }, + "vectorSearch": { + "$ref": "#/definitions/VectorSearch", + "description": "Contains configuration options related to vector search.", + "x-ms-client-name": "VectorSearch", + "x-nullable": true + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the index." + } + }, + "required": [ + "name", + "fields" + ], + "description": "Represents a search index definition, which describes the fields and search behavior of an index." + }, + "SearchAlias": { + "type": "object", + "properties": { + "name": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the alias." + }, + "indexes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The name of the index this alias maps to. Only one index name may be specified." + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the alias." + } + }, + "required": [ + "name", + "indexes" + ], + "description": "Represents an index alias, which describes a mapping from the alias name to an index. The alias name can be used in place of the index name for supported operations." + }, + "GetIndexStatisticsResult": { + "properties": { + "documentCount": { + "type": "integer", + "format": "int64", + "x-nullable": false, + "readOnly": true, + "description": "The number of documents in the index." + }, + "storageSize": { + "type": "integer", + "format": "int64", + "x-nullable": false, + "readOnly": true, + "description": "The amount of storage in bytes consumed by the index." + }, + "vectorIndexSize": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The amount of memory in bytes consumed by vectors in the index." + } + }, + "required": [ + "documentCount", + "storageSize", + "vectorIndexSize" + ], + "description": "Statistics for a given index. Statistics are collected periodically and are not guaranteed to always be up-to-date." + }, + "ListIndexesResult": { + "properties": { + "value": { + "x-ms-client-name": "Indexes", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndex" + }, + "description": "The indexes in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a List Indexes request. If successful, it includes the full definitions of all indexes." + }, + "ListAliasesResult": { + "type": "object", + "properties": { + "value": { + "x-ms-client-name": "Aliases", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchAlias" + }, + "description": "The aliases in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a List Aliases request. If successful, it includes the associated index mappings for all aliases." + }, + "SearchIndexerSkillset": { + "properties": { + "name": { + "type": "string", + "description": "The name of the skillset." + }, + "description": { + "type": "string", + "description": "The description of the skillset." + }, + "skills": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchIndexerSkill" + }, + "description": "A list of skills in the skillset." + }, + "cognitiveServices": { + "x-ms-client-name": "CognitiveServicesAccount", + "$ref": "#/definitions/CognitiveServicesAccount", + "description": "Details about the Azure AI service to be used when running skills." + }, + "knowledgeStore": { + "$ref": "#/definitions/SearchIndexerKnowledgeStore", + "description": "Definition of additional projections to Azure blob, table, or files, of enriched data." + }, + "indexProjections": { + "$ref": "#/definitions/SearchIndexerIndexProjections", + "description": "Definition of additional projections to secondary search index(es)." + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the skillset." + }, + "encryptionKey": { + "$ref": "#/definitions/SearchResourceEncryptionKey", + "description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your skillset definition when you want full assurance that no one, not even Microsoft, can decrypt your skillset definition. Once you have encrypted your skillset definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your skillset definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.", + "externalDocs": { + "url": "https://aka.ms/azure-search-encryption-with-cmk" + }, + "x-nullable": true + } + }, + "required": [ + "name", + "skills" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-tutorial-blob" + }, + "description": "A list of skills." + }, + "CognitiveServicesAccount": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "A URI fragment specifying the type of Azure AI service resource attached to a skillset." + }, + "description": { + "type": "string", + "description": "Description of the Azure AI service resource attached to a skillset." + } + }, + "required": [ + "@odata.type" + ], + "description": "Base type for describing any Azure AI service resource attached to a skillset." + }, + "SearchIndexerKnowledgeStore": { + "properties": { + "storageConnectionString": { + "type": "string", + "description": "The connection string to the storage account projections will be stored in." + }, + "projections": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreProjection", + "x-nullable": false + }, + "description": "A list of additional projections to perform during indexing." + }, + "identity": { + "$ref": "#/definitions/SearchIndexerDataIdentity", + "x-nullable": true, + "description": "The user-assigned managed identity used for connections to Azure Storage when writing knowledge store projections. If the connection string indicates an identity (ResourceId) and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to \"none\", the value of this property is cleared." + }, + "parameters": { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreParameters" + } + }, + "required": [ + "storageConnectionString", + "projections" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/knowledge-store-projection-overview" + }, + "description": "Definition of additional projections to azure blob, table, or files, of enriched data." + }, + "SearchIndexerKnowledgeStoreProjection": { + "properties": { + "tables": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreTableProjectionSelector", + "x-nullable": false + }, + "description": "Projections to Azure Table storage." + }, + "objects": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreObjectProjectionSelector", + "x-nullable": false + }, + "description": "Projections to Azure Blob storage." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreFileProjectionSelector", + "x-nullable": false + }, + "description": "Projections to Azure File storage." + } + }, + "description": "Container object for various projection selectors." + }, + "SearchIndexerKnowledgeStoreProjectionSelector": { + "properties": { + "referenceKeyName": { + "type": "string", + "description": "Name of reference key to different projection." + }, + "generatedKeyName": { + "type": "string", + "description": "Name of generated key to store projection under." + }, + "source": { + "type": "string", + "description": "Source data to project." + }, + "sourceContext": { + "type": "string", + "description": "Source context for complex projections." + }, + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/InputFieldMappingEntry" + }, + "description": "Nested inputs for complex projections." + } + }, + "description": "Abstract class to share properties between concrete selectors." + }, + "SearchIndexerKnowledgeStoreBlobProjectionSelector": { + "properties": { + "storageContainer": { + "type": "string", + "description": "Blob container to store projections in." + } + }, + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreProjectionSelector" + } + ], + "required": [ + "storageContainer" + ], + "description": "Abstract class to share properties between concrete selectors." + }, + "SearchIndexerKnowledgeStoreTableProjectionSelector": { + "properties": { + "tableName": { + "type": "string", + "description": "Name of the Azure table to store projected data in." + } + }, + "required": [ + "generatedKeyName", + "tableName" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreProjectionSelector" + } + ], + "description": "Description for what data to store in Azure Tables." + }, + "SearchIndexerKnowledgeStoreObjectProjectionSelector": { + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreBlobProjectionSelector" + } + ], + "description": "Projection definition for what data to store in Azure Blob." + }, + "SearchIndexerKnowledgeStoreFileProjectionSelector": { + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreBlobProjectionSelector" + } + ], + "description": "Projection definition for what data to store in Azure Files." + }, + "SearchIndexerKnowledgeStoreParameters": { + "type": "object", + "properties": { + "synthesizeGeneratedKeyName": { + "type": "boolean", + "default": false, + "description": "Whether or not projections should synthesize a generated key name if one isn't already present." + } + }, + "additionalProperties": true, + "description": "A dictionary of knowledge store-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type." + }, + "SearchIndexerIndexProjections": { + "type": "object", + "properties": { + "selectors": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchIndexerIndexProjectionSelector" + }, + "description": "A list of projections to be performed to secondary search indexes." + }, + "parameters": { + "$ref": "#/definitions/SearchIndexerIndexProjectionsParameters" + } + }, + "required": [ + "selectors" + ], + "description": "Definition of additional projections to secondary search indexes." + }, + "SearchIndexerIndexProjectionSelector": { + "type": "object", + "properties": { + "targetIndexName": { + "type": "string", + "description": "Name of the search index to project to. Must have a key field with the 'keyword' analyzer set." + }, + "parentKeyFieldName": { + "type": "string", + "description": "Name of the field in the search index to map the parent document's key value to. Must be a string field that is filterable and not the key field." + }, + "sourceContext": { + "type": "string", + "description": "Source context for the projections. Represents the cardinality at which the document will be split into multiple sub documents." + }, + "mappings": { + "type": "array", + "items": { + "$ref": "#/definitions/InputFieldMappingEntry" + }, + "description": "Mappings for the projection, or which source should be mapped to which field in the target index." + } + }, + "required": [ + "targetIndexName", + "parentKeyFieldName", + "sourceContext", + "mappings" + ], + "description": "Description for what data to store in the designated search index." + }, + "SearchIndexerIndexProjectionsParameters": { + "type": "object", + "properties": { + "projectionMode": { + "$ref": "#/definitions/IndexProjectionMode", + "description": "Defines behavior of the index projections in relation to the rest of the indexer." + } + }, + "additionalProperties": true, + "description": "A dictionary of index projection-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type." + }, + "IndexProjectionMode": { + "type": "string", + "enum": [ + "skipIndexingParentDocuments", + "includeIndexingParentDocuments" + ], + "x-ms-enum": { + "name": "IndexProjectionMode", + "modelAsString": true, + "values": [ + { + "value": "skipIndexingParentDocuments", + "name": "SkipIndexingParentDocuments", + "description": "The source document will be skipped from writing into the indexer's target index." + }, + { + "value": "includeIndexingParentDocuments", + "name": "IncludeIndexingParentDocuments", + "description": "The source document will be written into the indexer's target index. This is the default pattern." + } + ] + }, + "description": "Defines behavior of the index projections in relation to the rest of the indexer." + }, + "DefaultCognitiveServicesAccount": { + "description": "An empty object that represents the default Azure AI service resource for a skillset.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.DefaultCognitiveServices", + "allOf": [ + { + "$ref": "#/definitions/CognitiveServicesAccount" + } + ] + }, + "CognitiveServicesAccountKey": { + "description": "The multi-region account key of an Azure AI service resource that's attached to a skillset.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CognitiveServicesByKey", + "allOf": [ + { + "$ref": "#/definitions/CognitiveServicesAccount" + } + ], + "properties": { + "key": { + "type": "string", + "description": "The key used to provision the Azure AI service resource attached to a skillset." + } + }, + "required": [ + "key" + ] + }, + "AIServicesAccountKey": { + "type": "object", + "description": "The account key of an Azure AI service resource that's attached to a skillset, to be used with the resource's subdomain.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.AIServicesByKey", + "allOf": [ + { + "$ref": "#/definitions/CognitiveServicesAccount" + } + ], + "properties": { + "key": { + "type": "string", + "description": "The key used to provision the Azure AI service resource attached to a skillset." + }, + "subdomainUrl": { + "type": "string", + "description": "The subdomain url for the corresponding AI Service." + } + }, + "required": [ + "key", + "subdomainUrl" + ] + }, + "AIServicesAccountIdentity": { + "type": "object", + "description": "The multi-region account of an Azure AI service resource that's attached to a skillset.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.AIServicesByIdentity", + "allOf": [ + { + "$ref": "#/definitions/CognitiveServicesAccount" + } + ], + "properties": { + "identity": { + "$ref": "#/definitions/SearchIndexerDataIdentity", + "x-nullable": true, + "description": "The user-assigned managed identity used for connections to AI Service. If not specified, the system-assigned managed identity is used. On updates to the skillset, if the identity is unspecified, the value remains unchanged. If set to \"none\", the value of this property is cleared." + }, + "subdomainUrl": { + "type": "string", + "description": "The subdomain url for the corresponding AI Service." + } + }, + "required": [ + "identity", + "subdomainUrl" + ] + }, + "SearchIndexerSkill": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "A URI fragment specifying the type of skill." + }, + "name": { + "type": "string", + "description": "The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'." + }, + "description": { + "type": "string", + "description": "The description of the skill which describes the inputs, outputs, and usage of the skill." + }, + "context": { + "type": "string", + "description": "Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document." + }, + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/InputFieldMappingEntry" + }, + "description": "Inputs of the skills could be a column in the source data set, or the output of an upstream skill." + }, + "outputs": { + "type": "array", + "items": { + "$ref": "#/definitions/OutputFieldMappingEntry" + }, + "description": "The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill." + } + }, + "required": [ + "@odata.type", + "inputs", + "outputs" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-predefined-skills" + }, + "description": "Base type for skills." + }, + "CustomEntity": { + "properties": { + "name": { + "type": "string", + "description": "The top-level entity descriptor. Matches in the skill output will be grouped by this name, and it should represent the \"normalized\" form of the text being found." + }, + "description": { + "type": "string", + "x-nullable": true, + "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." + }, + "type": { + "type": "string", + "x-nullable": true, + "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." + }, + "subtype": { + "type": "string", + "x-nullable": true, + "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." + }, + "id": { + "type": "string", + "x-nullable": true, + "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." + }, + "caseSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to character casing. Sample case insensitive matches of \"Microsoft\" could be: microsoft, microSoft, MICROSOFT." + }, + "accentSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to accent." + }, + "fuzzyEditDistance": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "Defaults to 0. Maximum value of 5. Denotes the acceptable number of divergent characters that would still constitute a match with the entity name. The smallest possible fuzziness for any given match is returned. For instance, if the edit distance is set to 3, \"Windows10\" would still match \"Windows\", \"Windows10\" and \"Windows 7\". When case sensitivity is set to false, case differences do NOT count towards fuzziness tolerance, but otherwise do." + }, + "defaultCaseSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Changes the default case sensitivity value for this entity. It be used to change the default value of all aliases caseSensitive values." + }, + "defaultAccentSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Changes the default accent sensitivity value for this entity. It be used to change the default value of all aliases accentSensitive values." + }, + "defaultFuzzyEditDistance": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "Changes the default fuzzy edit distance value for this entity. It can be used to change the default value of all aliases fuzzyEditDistance values." + }, + "aliases": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomEntityAlias" + }, + "x-nullable": true, + "description": "An array of complex objects that can be used to specify alternative spellings or synonyms to the root entity name." + } + }, + "required": [ + "name" + ], + "description": "An object that contains information about the matches that were found, and related metadata." + }, + "CustomEntityAlias": { + "properties": { + "text": { + "type": "string", + "description": "The text of the alias." + }, + "caseSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Determine if the alias is case sensitive." + }, + "accentSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Determine if the alias is accent sensitive." + }, + "fuzzyEditDistance": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "Determine the fuzzy edit distance of the alias." + } + }, + "required": [ + "text" + ], + "description": "A complex object that can be used to specify alternative spellings or synonyms to the root entity name." + }, + "InputFieldMappingEntry": { + "properties": { + "name": { + "type": "string", + "description": "The name of the input." + }, + "source": { + "type": "string", + "description": "The source of the input." + }, + "sourceContext": { + "type": "string", + "description": "The source context used for selecting recursive inputs." + }, + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/InputFieldMappingEntry" + }, + "description": "The recursive inputs used when creating a complex type." + } + }, + "required": [ + "name" + ], + "description": "Input field mapping for a skill." + }, + "OutputFieldMappingEntry": { + "properties": { + "name": { + "type": "string", + "description": "The name of the output defined by the skill." + }, + "targetName": { + "type": "string", + "description": "The target name of the output. It is optional and default to name." + } + }, + "required": [ + "name" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "description": "Output field mapping for a skill." + }, + "ConditionalSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Util.ConditionalSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-conditional" + }, + "description": "A skill that enables scenarios that require a Boolean operation to determine the data to assign to an output." + }, + "KeyPhraseExtractionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/KeyPhraseExtractionSkillLanguage", + "description": "A value indicating which language code to use. Default is `en`." + }, + "maxKeyPhraseCount": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "A number indicating how many key phrases to return. If absent, all identified key phrases will be returned." + }, + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-keyphrases" + }, + "description": "A skill that uses text analytics for key phrase extraction." + }, + "OcrSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Vision.OcrSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/OcrSkillLanguage", + "description": "A value indicating which language code to use. Default is `en`." + }, + "detectOrientation": { + "x-ms-client-name": "ShouldDetectOrientation", + "type": "boolean", + "default": false, + "description": "A value indicating to turn orientation detection on or not. Default is false." + }, + "lineEnding": { + "$ref": "#/definitions/OcrSkillLineEnding", + "description": "Defines the sequence of characters to use between the lines of text recognized by the OCR skill. The default value is \"space\"." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-ocr" + }, + "description": "A skill that extracts text from image files." + }, + "ImageAnalysisSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Vision.ImageAnalysisSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/ImageAnalysisSkillLanguage", + "description": "A value indicating which language code to use. Default is `en`." + }, + "visualFeatures": { + "type": "array", + "items": { + "$ref": "#/definitions/VisualFeature", + "x-nullable": false + }, + "description": "A list of visual features." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageDetail", + "x-nullable": false + }, + "description": "A string indicating which domain-specific details to return." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-image-analysis" + }, + "description": "A skill that analyzes image files. It extracts a rich set of visual features based on the image content." + }, + "LanguageDetectionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultCountryHint": { + "type": "string", + "x-nullable": true, + "description": "A country code to use as a hint to the language detection model if it cannot disambiguate the language." + }, + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-language-detection" + }, + "description": "A skill that detects the language of input text and reports a single language code for every document submitted on the request. The language code is paired with a score indicating the confidence of the analysis." + }, + "ShaperSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Util.ShaperSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-shaper" + }, + "description": "A skill for reshaping the outputs. It creates a complex type to support composite fields (also known as multipart fields)." + }, + "MergeSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.MergeSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "insertPreTag": { + "type": "string", + "default": " ", + "description": "The tag indicates the start of the merged text. By default, the tag is an empty space." + }, + "insertPostTag": { + "type": "string", + "default": " ", + "description": "The tag indicates the end of the merged text. By default, the tag is an empty space." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-textmerger" + }, + "description": "A skill for merging two or more strings into a single unified string, with an optional user-defined delimiter separating each component part." + }, + "EntityRecognitionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "categories": { + "type": "array", + "items": { + "$ref": "#/definitions/EntityCategory", + "x-nullable": false + }, + "description": "A list of entity categories that should be extracted." + }, + "defaultLanguageCode": { + "$ref": "#/definitions/EntityRecognitionSkillLanguage", + "description": "A value indicating which language code to use. Default is `en`." + }, + "includeTypelessEntities": { + "type": "boolean", + "x-nullable": true, + "description": "Determines whether or not to include entities which are well known but don't conform to a pre-defined type. If this configuration is not set (default), set to null or set to false, entities which don't conform to one of the pre-defined types will not be surfaced." + }, + "minimumPrecision": { + "type": "number", + "format": "double", + "x-nullable": true, + "description": "A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-entity-recognition" + }, + "description": "This skill is deprecated. Use the V3.EntityRecognitionSkill instead.", + "x-az-search-deprecated": true + }, + "SentimentSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.SentimentSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/SentimentSkillLanguage", + "description": "A value indicating which language code to use. Default is `en`." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-sentiment" + }, + "description": "This skill is deprecated. Use the V3.SentimentSkill instead.", + "x-az-search-deprecated": true + }, + "SentimentSkillV3": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.V3.SentimentSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "type": "string", + "x-nullable": true, + "description": "A value indicating which language code to use. Default is `en`." + }, + "includeOpinionMining": { + "type": "boolean", + "default": false, + "description": "If set to true, the skill output will include information from Text Analytics for opinion mining, namely targets (nouns or verbs) and their associated assessment (adjective) in the text. Default is false." + }, + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-sentiment-v3" + }, + "description": "Using the Text Analytics API, evaluates unstructured text and for each record, provides sentiment labels (such as \"negative\", \"neutral\" and \"positive\") based on the highest confidence score found by the service at a sentence and document-level." + }, + "EntityLinkingSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.V3.EntityLinkingSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "type": "string", + "x-nullable": true, + "description": "A value indicating which language code to use. Default is `en`." + }, + "minimumPrecision": { + "type": "number", + "format": "double", + "minimum": 0.0, + "maximum": 1.0, + "x-nullable": true, + "description": "A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included." + }, + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-entity-linking-v3" + }, + "description": "Using the Text Analytics API, extracts linked entities from text." + }, + "EntityRecognitionSkillV3": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.V3.EntityRecognitionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "categories": { + "type": "array", + "items": { + "type": "string", + "x-nullable": false + }, + "description": "A list of entity categories that should be extracted." + }, + "defaultLanguageCode": { + "type": "string", + "x-nullable": true, + "description": "A value indicating which language code to use. Default is `en`." + }, + "minimumPrecision": { + "type": "number", + "format": "double", + "minimum": 0.0, + "maximum": 1.0, + "x-nullable": true, + "description": "A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included." + }, + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the Text Analytics API. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-entity-recognition-v3" + }, + "description": "Using the Text Analytics API, extracts entities of different types from text." + }, + "PIIDetectionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.PIIDetectionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "type": "string", + "x-nullable": true, + "description": "A value indicating which language code to use. Default is `en`." + }, + "minimumPrecision": { + "type": "number", + "format": "double", + "x-nullable": true, + "minimum": 0.0, + "maximum": 1.0, + "description": "A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included." + }, + "maskingMode": { + "$ref": "#/definitions/PIIDetectionSkillMaskingMode", + "description": "A parameter that provides various ways to mask the personal information detected in the input text. Default is 'none'." + }, + "maskingCharacter": { + "x-ms-client-name": "mask", + "type": "string", + "x-nullable": true, + "maxLength": 1, + "description": "The character used to mask the text if the maskingMode parameter is set to replace. Default is '*'." + }, + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary." + }, + "piiCategories": { + "type": "array", + "items": { + "type": "string", + "x-nullable": false + }, + "description": "A list of PII entity categories that should be extracted and masked." + }, + "domain": { + "type": "string", + "x-nullable": true, + "description": "If specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'phi', 'none'. Default is 'none'." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-pii-detection" + }, + "description": "Using the Text Analytics API, extracts personal information from an input text and gives you the option of masking it." + }, + "SplitSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.SplitSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/SplitSkillLanguage", + "description": "A value indicating which language code to use. Default is `en`." + }, + "textSplitMode": { + "$ref": "#/definitions/TextSplitMode", + "x-nullable": false, + "description": "A value indicating which split mode to perform." + }, + "maximumPageLength": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The desired maximum page length. Default is 10000." + }, + "pageOverlapLength": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "Only applicable when textSplitMode is set to 'pages'. If specified, n+1th chunk will start with this number of characters/tokens from the end of the nth chunk." + }, + "maximumPagesToTake": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "Only applicable when textSplitMode is set to 'pages'. If specified, the SplitSkill will discontinue splitting after processing the first 'maximumPagesToTake' pages, in order to improve performance when only a few initial pages are needed from each document." + }, + "unit": { + "$ref": "#/definitions/SplitSkillUnit", + "x-nullable": true, + "description": "Only applies if textSplitMode is set to pages. There are two possible values. The choice of the values will decide the length (maximumPageLength and pageOverlapLength) measurement. The default is 'characters', which means the length will be measured by character." + }, + "azureOpenAITokenizerParameters": { + "$ref": "#/definitions/AzureOpenAITokenizerParameters", + "x-nullable": true, + "description": "Only applies if the unit is set to azureOpenAITokens. If specified, the splitSkill will use these parameters when performing the tokenization. The parameters are a valid 'encoderModelName' and an optional 'allowedSpecialTokens' property." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-textsplit" + }, + "description": "A skill to split a string into chunks of text." + }, + "CustomEntityLookupSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.CustomEntityLookupSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/CustomEntityLookupSkillLanguage", + "x-nullable": true, + "description": "A value indicating which language code to use. Default is `en`." + }, + "entitiesDefinitionUri": { + "type": "string", + "x-nullable": true, + "description": "Path to a JSON or CSV file containing all the target text to match against. This entity definition is read at the beginning of an indexer run. Any updates to this file during an indexer run will not take effect until subsequent runs. This config must be accessible over HTTPS." + }, + "inlineEntitiesDefinition": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomEntity" + }, + "x-nullable": true, + "description": "The inline CustomEntity definition." + }, + "globalDefaultCaseSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "A global flag for CaseSensitive. If CaseSensitive is not set in CustomEntity, this value will be the default value." + }, + "globalDefaultAccentSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "A global flag for AccentSensitive. If AccentSensitive is not set in CustomEntity, this value will be the default value." + }, + "globalDefaultFuzzyEditDistance": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in CustomEntity, this value will be the default value." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/en-us/azure/search/cognitive-search-skill-custom-entity-lookup" + }, + "description": "A skill looks for text from a custom, user-defined list of words and phrases." + }, + "TextTranslationSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.TranslationSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultToLanguageCode": { + "$ref": "#/definitions/TextTranslationSkillLanguage", + "description": "The language code to translate documents into for documents that don't specify the to language explicitly. " + }, + "defaultFromLanguageCode": { + "$ref": "#/definitions/TextTranslationSkillLanguage", + "description": "The language code to translate documents from for documents that don't specify the from language explicitly." + }, + "suggestedFrom": { + "$ref": "#/definitions/TextTranslationSkillLanguage", + "x-nullable": true, + "description": "The language code to translate documents from when neither the fromLanguageCode input nor the defaultFromLanguageCode parameter are provided, and the automatic language detection is unsuccessful. Default is `en`." + } + }, + "required": [ + "defaultToLanguageCode" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-text-translation" + }, + "description": "A skill to translate text from one language to another." + }, + "DocumentExtractionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Util.DocumentExtractionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "parsingMode": { + "type": "string", + "x-nullable": true, + "description": "The parsingMode for the skill. Will be set to 'default' if not defined." + }, + "dataToExtract": { + "type": "string", + "x-nullable": true, + "description": "The type of data to be extracted for the skill. Will be set to 'contentAndMetadata' if not defined." + }, + "configuration": { + "type": "object", + "additionalProperties": true, + "x-nullable": true, + "description": "A dictionary of configurations for the skill." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-document-extraction" + }, + "description": "A skill that extracts content from a file within the enrichment pipeline." + }, + "DocumentIntelligenceLayoutSkill": { + "type": "object", + "x-ms-discriminator-value": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "outputMode": { + "$ref": "#/definitions/DocumentIntelligenceLayoutSkillOutputMode", + "x-nullable": true, + "description": "Controls the cardinality of the output produced by the skill. Default is 'oneToMany'." + }, + "markdownHeaderDepth": { + "$ref": "#/definitions/DocumentIntelligenceLayoutSkillMarkdownHeaderDepth", + "x-nullable": true, + "description": "The depth of headers in the markdown output. Default is h6." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-document-extraction" + }, + "description": "A skill that extracts content and layout information (as markdown), via Azure AI Services, from files within the enrichment pipeline." + }, + "DocumentIntelligenceLayoutSkillOutputMode": { + "type": "string", + "enum": [ + "oneToMany" + ], + "x-ms-enum": { + "name": "DocumentIntelligenceLayoutSkillOutputMode", + "modelAsString": true, + "values": [ + { + "value": "oneToMany", + "name": "OneToMany", + "description": "Specify the deepest markdown header section to parse." + } + ] + }, + "default": "oneToMany", + "description": "Controls the cardinality of the output produced by the skill. Default is 'oneToMany'" + }, + "DocumentIntelligenceLayoutSkillMarkdownHeaderDepth": { + "type": "string", + "enum": [ + "h1", + "h2", + "h3", + "h4", + "h5", + "h6" + ], + "x-ms-enum": { + "name": "DocumentIntelligenceLayoutSkillMarkdownHeaderDepth", + "modelAsString": true, + "values": [ + { + "value": "h1", + "name": "H1", + "description": "Header level 1." + }, + { + "value": "h2", + "name": "H2", + "description": "Header level 2." + }, + { + "value": "h3", + "name": "H3", + "description": "Header level 3." + }, + { + "value": "h4", + "name": "H4", + "description": "Header level 4." + }, + { + "value": "h5", + "name": "H5", + "description": "Header level 5." + }, + { + "value": "h6", + "name": "H6", + "description": "Header level 6." + } + ] + }, + "default": "h6", + "description": "The depth of headers in the markdown output. Default is h6." + }, + "WebApiSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Custom.WebApiSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "uri": { + "type": "string", + "description": "The url for the Web API." + }, + "httpHeaders": { + "$ref": "#/definitions/WebApiHttpHeaders", + "description": "The headers required to make the http request." + }, + "httpMethod": { + "type": "string", + "description": "The method for the http request." + }, + "timeout": { + "type": "string", + "format": "duration", + "description": "The desired timeout for the request. Default is 30 seconds." + }, + "batchSize": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The desired batch size which indicates number of documents." + }, + "degreeOfParallelism": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "If set, the number of parallel calls that can be made to the Web API." + }, + "authResourceId": { + "type": "string", + "x-nullable": true, + "x-ms-format": "arm-id", + "description": "Applies to custom skills that connect to external code in an Azure function or some other application that provides the transformations. This value should be the application ID created for the function or app when it was registered with Azure Active Directory. When specified, the custom skill connects to the function or app using a managed ID (either system or user-assigned) of the search service and the access token of the function or app, using this value as the resource id for creating the scope of the access token." + }, + "authIdentity": { + "$ref": "#/definitions/SearchIndexerDataIdentity", + "x-nullable": true, + "description": "The user-assigned managed identity used for outbound connections. If an authResourceId is provided and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to \"none\", the value of this property is cleared." + } + }, + "required": [ + "uri" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-custom-skill-web-api" + }, + "description": "A skill that can call a Web API endpoint, allowing you to extend a skillset by having it call your custom code." + }, + "WebApiHttpHeaders": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "A dictionary of http request headers." + }, + "AmlSkill": { + "type": "object", + "x-ms-client-name": "AzureMachineLearningSkill", + "x-ms-discriminator-value": "#Microsoft.Skills.Custom.AmlSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "uri": { + "x-ms-client-name": "ScoringUri", + "type": "string", + "format": "uri", + "x-nullable": true, + "description": "(Required for no authentication or key authentication) The scoring URI of the AML service to which the JSON payload will be sent. Only the https URI scheme is allowed." + }, + "key": { + "x-ms-client-name": "AuthenticationKey", + "type": "string", + "x-nullable": true, + "description": "(Required for key authentication) The key for the AML service." + }, + "resourceId": { + "type": "string", + "x-nullable": true, + "description": "(Required for token authentication). The Azure Resource Manager resource ID of the AML service. It should be in the format subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}." + }, + "timeout": { + "type": "string", + "format": "duration", + "x-nullable": true, + "description": "(Optional) When specified, indicates the timeout for the http client making the API call." + }, + "region": { + "type": "string", + "x-nullable": true, + "description": "(Optional for token authentication). The region the AML service is deployed in." + }, + "degreeOfParallelism": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "(Optional) When specified, indicates the number of calls the indexer will make in parallel to the endpoint you have provided. You can decrease this value if your endpoint is failing under too high of a request load, or raise it if your endpoint is able to accept more requests and you would like an increase in the performance of the indexer. If not set, a default value of 5 is used. The degreeOfParallelism can be set to a maximum of 10 and a minimum of 1." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/en-us/azure/search/cognitive-search-aml-skill" + }, + "description": "The AML skill allows you to extend AI enrichment with a custom Azure Machine Learning (AML) model. Once an AML model is trained and deployed, an AML skill integrates it into AI enrichment." + }, + "AzureOpenAIEmbeddingSkill": { + "x-ms-client-name": "AzureOpenAIEmbeddingSkill", + "x-ms-discriminator-value": "#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + }, + { + "$ref": "#/definitions/AzureOpenAIParameters" + } + ], + "properties": { + "dimensions": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models." + } + }, + "type": "object", + "description": "Allows you to generate a vector embedding for a given text input using the Azure OpenAI resource." + }, + "VisionVectorizeSkill": { + "x-ms-client-name": "VisionVectorizeSkill", + "x-ms-discriminator-value": "#Microsoft.Skills.Vision.VectorizeSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "type": "object", + "properties": { + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the AI Services Vision service. It will default to the latest available when not specified." + } + }, + "required": [ + "modelVersion" + ], + "description": "Allows you to generate a vector embedding for a given image or text input using the Azure AI Services Vision Vectorize API." + }, + "ListSkillsetsResult": { + "properties": { + "value": { + "x-ms-client-name": "Skillsets", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexerSkillset" + }, + "description": "The skillsets defined in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a list skillset request. If successful, it includes the full definitions of all skillsets." + }, + "TextSplitMode": { + "type": "string", + "enum": [ + "pages", + "sentences" + ], + "x-ms-enum": { + "name": "TextSplitMode", + "modelAsString": true, + "values": [ + { + "value": "pages", + "name": "Pages", + "description": "Split the text into individual pages." + }, + { + "value": "sentences", + "name": "Sentences", + "description": "Split the text into individual sentences." + } + ] + }, + "description": "A value indicating which split mode to perform." + }, + "SplitSkillUnit": { + "type": "string", + "enum": [ + "characters", + "azureOpenAITokens" + ], + "x-ms-enum": { + "name": "SplitSkillUnit", + "modelAsString": true, + "values": [ + { + "value": "characters", + "name": "Characters", + "description": "The length will be measured by character." + }, + { + "value": "azureOpenAITokens", + "name": "AzureOpenAITokens", + "description": "The length will be measured by an AzureOpenAI tokenizer from the tiktoken library." + } + ] + }, + "description": "A value indicating which unit to use." + }, + "AzureOpenAITokenizerParameters": { + "type": "object", + "properties": { + "encoderModelName": { + "$ref": "#/definitions/EncoderModelName", + "x-nullable": true, + "description": "Only applies if the unit is set to azureOpenAITokens. Options include 'R50k_base', 'P50k_base', 'P50k_edit' and 'CL100k_base'. The default value is 'CL100k_base'." + }, + "allowedSpecialTokens": { + "type": "array", + "items": { + "type": "string" + }, + "description": "(Optional) Only applies if the unit is set to azureOpenAITokens. This parameter defines a collection of special tokens that are permitted within the tokenization process." + } + } + }, + "EncoderModelName": { + "type": "string", + "enum": [ + "r50k_base", + "p50k_base", + "p50k_edit", + "cl100k_base" + ], + "x-ms-enum": { + "name": "SplitSkillEncoderModelName", + "modelAsString": true, + "values": [ + { + "value": "r50k_base", + "name": "R50kBase", + "description": "Refers to a base model trained with a 50,000 token vocabulary, often used in general natural language processing tasks." + }, + { + "value": "p50k_base", + "name": "P50kBase", + "description": "A base model with a 50,000 token vocabulary, optimized for prompt-based tasks." + }, + { + "value": "p50k_edit", + "name": "P50kEdit", + "description": "Similar to p50k_base but fine-tuned for editing or rephrasing tasks with a 50,000 token vocabulary." + }, + { + "value": "cl100k_base", + "name": "CL100kBase", + "description": "A base model with a 100,000 token vocabulary." + } + ] + }, + "description": "A value indicating which tokenizer to use." + }, + "VisualFeature": { + "type": "string", + "enum": [ + "adult", + "brands", + "categories", + "description", + "faces", + "objects", + "tags" + ], + "x-ms-enum": { + "name": "VisualFeature", + "modelAsString": true, + "values": [ + { + "value": "adult", + "name": "Adult", + "description": "Visual features recognized as adult persons." + }, + { + "value": "brands", + "name": "Brands", + "description": "Visual features recognized as commercial brands." + }, + { + "value": "categories", + "name": "Categories", + "description": "Categories." + }, + { + "value": "description", + "name": "Description", + "description": "Description." + }, + { + "value": "faces", + "name": "Faces", + "description": "Visual features recognized as people faces." + }, + { + "value": "objects", + "name": "Objects", + "description": "Visual features recognized as objects." + }, + { + "value": "tags", + "name": "Tags", + "description": "Tags." + } + ] + }, + "description": "The strings indicating what visual feature types to return." + }, + "ImageDetail": { + "type": "string", + "enum": [ + "celebrities", + "landmarks" + ], + "x-ms-enum": { + "name": "ImageDetail", + "modelAsString": true, + "values": [ + { + "value": "celebrities", + "name": "Celebrities", + "description": "Details recognized as celebrities." + }, + { + "value": "landmarks", + "name": "Landmarks", + "description": "Details recognized as landmarks." + } + ] + }, + "description": "A string indicating which domain-specific details to return." + }, + "EntityCategory": { + "type": "string", + "enum": [ + "location", + "organization", + "person", + "quantity", + "datetime", + "url", + "email" + ], + "x-ms-enum": { + "name": "EntityCategory", + "modelAsString": true, + "values": [ + { + "value": "location", + "name": "Location", + "description": "Entities describing a physical location." + }, + { + "value": "organization", + "name": "Organization", + "description": "Entities describing an organization." + }, + { + "value": "person", + "name": "Person", + "description": "Entities describing a person." + }, + { + "value": "quantity", + "name": "Quantity", + "description": "Entities describing a quantity." + }, + { + "value": "datetime", + "name": "Datetime", + "description": "Entities describing a date and time." + }, + { + "value": "url", + "name": "Url", + "description": "Entities describing a URL." + }, + { + "value": "email", + "name": "Email", + "description": "Entities describing an email address." + } + ] + }, + "description": "A string indicating what entity categories to return." + }, + "PIIDetectionSkillMaskingMode": { + "type": "string", + "enum": [ + "none", + "replace" + ], + "x-ms-enum": { + "name": "PIIDetectionSkillMaskingMode", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "No masking occurs and the maskedText output will not be returned." + }, + { + "value": "replace", + "name": "Replace", + "description": "Replaces the detected entities with the character given in the maskingCharacter parameter. The character will be repeated to the length of the detected entity so that the offsets will correctly correspond to both the input text as well as the output maskedText." + } + ] + }, + "description": "A string indicating what maskingMode to use to mask the personal information detected in the input text." + }, + "SentimentSkillLanguage": { + "type": "string", + "enum": [ + "da", + "nl", + "en", + "fi", + "fr", + "de", + "el", + "it", + "no", + "pl", + "pt-PT", + "ru", + "es", + "sv", + "tr" + ], + "x-ms-enum": { + "name": "SentimentSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "da", + "description": "Danish" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "el", + "description": "Greek" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "no", + "description": "Norwegian (Bokmaal)" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt-PT", + "description": "Portuguese (Portugal)" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "tr", + "description": "Turkish" + } + ] + }, + "description": "Deprecated. The language codes supported for input text by SentimentSkill.", + "x-az-search-deprecated": true + }, + "KeyPhraseExtractionSkillLanguage": { + "type": "string", + "enum": [ + "da", + "nl", + "en", + "fi", + "fr", + "de", + "it", + "ja", + "ko", + "no", + "pl", + "pt-PT", + "pt-BR", + "ru", + "es", + "sv" + ], + "x-ms-enum": { + "name": "KeyPhraseExtractionSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "da", + "description": "Danish" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "no", + "description": "Norwegian (Bokmaal)" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt-PT", + "description": "Portuguese (Portugal)" + }, + { + "value": "pt-BR", + "description": "Portuguese (Brazil)" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sv", + "description": "Swedish" + } + ] + }, + "description": "The language codes supported for input text by KeyPhraseExtractionSkill." + }, + "OcrSkillLanguage": { + "type": "string", + "enum": [ + "af", + "sq", + "anp", + "ar", + "ast", + "awa", + "az", + "bfy", + "eu", + "be", + "be-cyrl", + "be-latn", + "bho", + "bi", + "brx", + "bs", + "bra", + "br", + "bg", + "bns", + "bua", + "ca", + "ceb", + "rab", + "ch", + "hne", + "zh-Hans", + "zh-Hant", + "kw", + "co", + "crh", + "hr", + "cs", + "da", + "prs", + "dhi", + "doi", + "nl", + "en", + "myv", + "et", + "fo", + "fj", + "fil", + "fi", + "fr", + "fur", + "gag", + "gl", + "de", + "gil", + "gon", + "el", + "kl", + "gvr", + "ht", + "hlb", + "hni", + "bgc", + "haw", + "hi", + "mww", + "hoc", + "hu", + "is", + "smn", + "id", + "ia", + "iu", + "ga", + "it", + "ja", + "Jns", + "jv", + "kea", + "kac", + "xnr", + "krc", + "kaa-cyrl", + "kaa", + "csb", + "kk-cyrl", + "kk-latn", + "klr", + "kha", + "quc", + "ko", + "kfq", + "kpy", + "kos", + "kum", + "ku-arab", + "ku-latn", + "kru", + "ky", + "lkt", + "la", + "lt", + "dsb", + "smj", + "lb", + "bfz", + "ms", + "mt", + "kmj", + "gv", + "mi", + "mr", + "mn", + "cnr-cyrl", + "cnr-latn", + "nap", + "ne", + "niu", + "nog", + "sme", + "nb", + "no", + "oc", + "os", + "ps", + "fa", + "pl", + "pt", + "pa", + "ksh", + "ro", + "rm", + "ru", + "sck", + "sm", + "sa", + "sat", + "sco", + "gd", + "sr", + "sr-Cyrl", + "sr-Latn", + "xsr", + "srx", + "sms", + "sk", + "sl", + "so", + "sma", + "es", + "sw", + "sv", + "tg", + "tt", + "tet", + "thf", + "to", + "tr", + "tk", + "tyv", + "hsb", + "ur", + "ug", + "uz-arab", + "uz-cyrl", + "uz", + "vo", + "wae", + "cy", + "fy", + "yua", + "za", + "zu", + "unk" + ], + "x-ms-enum": { + "name": "OcrSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "af", + "description": "Afrikaans" + }, + { + "value": "sq", + "description": "Albanian" + }, + { + "value": "anp", + "description": "Angika (Devanagiri)" + }, + { + "value": "ar", + "description": "Arabic" + }, + { + "value": "ast", + "description": "Asturian" + }, + { + "value": "awa", + "description": "Awadhi-Hindi (Devanagiri)" + }, + { + "value": "az", + "description": "Azerbaijani (Latin)" + }, + { + "value": "bfy", + "description": "Bagheli" + }, + { + "value": "eu", + "description": "Basque" + }, + { + "value": "be", + "description": "Belarusian (Cyrillic and Latin)" + }, + { + "value": "be-cyrl", + "description": "Belarusian (Cyrillic)" + }, + { + "value": "be-latn", + "description": "Belarusian (Latin)" + }, + { + "value": "bho", + "description": "Bhojpuri-Hindi (Devanagiri)" + }, + { + "value": "bi", + "description": "Bislama" + }, + { + "value": "brx", + "description": "Bodo (Devanagiri)" + }, + { + "value": "bs", + "description": "Bosnian Latin" + }, + { + "value": "bra", + "description": "Brajbha" + }, + { + "value": "br", + "description": "Breton" + }, + { + "value": "bg", + "description": "Bulgarian" + }, + { + "value": "bns", + "description": "Bundeli" + }, + { + "value": "bua", + "description": "Buryat (Cyrillic)" + }, + { + "value": "ca", + "description": "Catalan" + }, + { + "value": "ceb", + "description": "Cebuano" + }, + { + "value": "rab", + "description": "Chamling" + }, + { + "value": "ch", + "description": "Chamorro" + }, + { + "value": "hne", + "description": "Chhattisgarhi (Devanagiri)" + }, + { + "value": "zh-Hans", + "description": "Chinese Simplified" + }, + { + "value": "zh-Hant", + "description": "Chinese Traditional" + }, + { + "value": "kw", + "description": "Cornish" + }, + { + "value": "co", + "description": "Corsican" + }, + { + "value": "crh", + "description": "Crimean Tatar (Latin)" + }, + { + "value": "hr", + "description": "Croatian" + }, + { + "value": "cs", + "description": "Czech" + }, + { + "value": "da", + "description": "Danish" + }, + { + "value": "prs", + "description": "Dari" + }, + { + "value": "dhi", + "description": "Dhimal (Devanagiri)" + }, + { + "value": "doi", + "description": "Dogri (Devanagiri)" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "myv", + "description": "Erzya (Cyrillic)" + }, + { + "value": "et", + "description": "Estonian" + }, + { + "value": "fo", + "description": "Faroese" + }, + { + "value": "fj", + "description": "Fijian" + }, + { + "value": "fil", + "description": "Filipino" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "fur", + "description": "Frulian" + }, + { + "value": "gag", + "description": "Gagauz (Latin)" + }, + { + "value": "gl", + "description": "Galician" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "gil", + "description": "Gilbertese" + }, + { + "value": "gon", + "description": "Gondi (Devanagiri)" + }, + { + "value": "el", + "description": "Greek" + }, + { + "value": "kl", + "description": "Greenlandic" + }, + { + "value": "gvr", + "description": "Gurung (Devanagiri)" + }, + { + "value": "ht", + "description": "Haitian Creole" + }, + { + "value": "hlb", + "description": "Halbi (Devanagiri)" + }, + { + "value": "hni", + "description": "Hani" + }, + { + "value": "bgc", + "description": "Haryanvi" + }, + { + "value": "haw", + "description": "Hawaiian" + }, + { + "value": "hi", + "description": "Hindi" + }, + { + "value": "mww", + "description": "Hmong Daw (Latin)" + }, + { + "value": "hoc", + "description": "Ho (Devanagiri)" + }, + { + "value": "hu", + "description": "Hungarian" + }, + { + "value": "is", + "description": "Icelandic" + }, + { + "value": "smn", + "description": "Inari Sami" + }, + { + "value": "id", + "description": "Indonesian" + }, + { + "value": "ia", + "description": "Interlingua" + }, + { + "value": "iu", + "description": "Inuktitut (Latin)" + }, + { + "value": "ga", + "description": "Irish" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "Jns", + "description": "Jaunsari (Devanagiri)" + }, + { + "value": "jv", + "description": "Javanese" + }, + { + "value": "kea", + "description": "Kabuverdianu" + }, + { + "value": "kac", + "description": "Kachin (Latin)" + }, + { + "value": "xnr", + "description": "Kangri (Devanagiri)" + }, + { + "value": "krc", + "description": "Karachay-Balkar" + }, + { + "value": "kaa-cyrl", + "description": "Kara-Kalpak (Cyrillic)" + }, + { + "value": "kaa", + "description": "Kara-Kalpak (Latin)" + }, + { + "value": "csb", + "description": "Kashubian" + }, + { + "value": "kk-cyrl", + "description": "Kazakh (Cyrillic)" + }, + { + "value": "kk-latn", + "description": "Kazakh (Latin)" + }, + { + "value": "klr", + "description": "Khaling" + }, + { + "value": "kha", + "description": "Khasi" + }, + { + "value": "quc", + "description": "K'iche'" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "kfq", + "description": "Korku" + }, + { + "value": "kpy", + "description": "Koryak" + }, + { + "value": "kos", + "description": "Kosraean" + }, + { + "value": "kum", + "description": "Kumyk (Cyrillic)" + }, + { + "value": "ku-arab", + "description": "Kurdish (Arabic)" + }, + { + "value": "ku-latn", + "description": "Kurdish (Latin)" + }, + { + "value": "kru", + "description": "Kurukh (Devanagiri)" + }, + { + "value": "ky", + "description": "Kyrgyz (Cyrillic)" + }, + { + "value": "lkt", + "description": "Lakota" + }, + { + "value": "la", + "description": "Latin" + }, + { + "value": "lt", + "description": "Lithuanian" + }, + { + "value": "dsb", + "description": "Lower Sorbian" + }, + { + "value": "smj", + "description": "Lule Sami" + }, + { + "value": "lb", + "description": "Luxembourgish" + }, + { + "value": "bfz", + "description": "Mahasu Pahari (Devanagiri)" + }, + { + "value": "ms", + "description": "Malay (Latin)" + }, + { + "value": "mt", + "description": "Maltese" + }, + { + "value": "kmj", + "description": "Malto (Devanagiri)" + }, + { + "value": "gv", + "description": "Manx" + }, + { + "value": "mi", + "description": "Maori" + }, + { + "value": "mr", + "description": "Marathi" + }, + { + "value": "mn", + "description": "Mongolian (Cyrillic)" + }, + { + "value": "cnr-cyrl", + "description": "Montenegrin (Cyrillic)" + }, + { + "value": "cnr-latn", + "description": "Montenegrin (Latin)" + }, + { + "value": "nap", + "description": "Neapolitan" + }, + { + "value": "ne", + "description": "Nepali" + }, + { + "value": "niu", + "description": "Niuean" + }, + { + "value": "nog", + "description": "Nogay" + }, + { + "value": "sme", + "description": "Northern Sami (Latin)" + }, + { + "value": "nb", + "description": "Norwegian" + }, + { + "value": "no", + "description": "Norwegian" + }, + { + "value": "oc", + "description": "Occitan" + }, + { + "value": "os", + "description": "Ossetic" + }, + { + "value": "ps", + "description": "Pashto" + }, + { + "value": "fa", + "description": "Persian" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt", + "description": "Portuguese" + }, + { + "value": "pa", + "description": "Punjabi (Arabic)" + }, + { + "value": "ksh", + "description": "Ripuarian" + }, + { + "value": "ro", + "description": "Romanian" + }, + { + "value": "rm", + "description": "Romansh" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "sck", + "description": "Sadri (Devanagiri)" + }, + { + "value": "sm", + "description": "Samoan (Latin)" + }, + { + "value": "sa", + "description": "Sanskrit (Devanagiri)" + }, + { + "value": "sat", + "description": "Santali (Devanagiri)" + }, + { + "value": "sco", + "description": "Scots" + }, + { + "value": "gd", + "description": "Scottish Gaelic" + }, + { + "value": "sr", + "description": "Serbian (Latin)" + }, + { + "value": "sr-Cyrl", + "description": "Serbian (Cyrillic)" + }, + { + "value": "sr-Latn", + "description": "Serbian (Latin)" + }, + { + "value": "xsr", + "description": "Sherpa (Devanagiri)" + }, + { + "value": "srx", + "description": "Sirmauri (Devanagiri)" + }, + { + "value": "sms", + "description": "Skolt Sami" + }, + { + "value": "sk", + "description": "Slovak" + }, + { + "value": "sl", + "description": "Slovenian" + }, + { + "value": "so", + "description": "Somali (Arabic)" + }, + { + "value": "sma", + "description": "Southern Sami" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sw", + "description": "Swahili (Latin)" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "tg", + "description": "Tajik (Cyrillic)" + }, + { + "value": "tt", + "description": "Tatar (Latin)" + }, + { + "value": "tet", + "description": "Tetum" + }, + { + "value": "thf", + "description": "Thangmi" + }, + { + "value": "to", + "description": "Tongan" + }, + { + "value": "tr", + "description": "Turkish" + }, + { + "value": "tk", + "description": "Turkmen (Latin)" + }, + { + "value": "tyv", + "description": "Tuvan" + }, + { + "value": "hsb", + "description": "Upper Sorbian" + }, + { + "value": "ur", + "description": "Urdu" + }, + { + "value": "ug", + "description": "Uyghur (Arabic)" + }, + { + "value": "uz-arab", + "description": "Uzbek (Arabic)" + }, + { + "value": "uz-cyrl", + "description": "Uzbek (Cyrillic)" + }, + { + "value": "uz", + "description": "Uzbek (Latin)" + }, + { + "value": "vo", + "description": "Volapük" + }, + { + "value": "wae", + "description": "Walser" + }, + { + "value": "cy", + "description": "Welsh" + }, + { + "value": "fy", + "description": "Western Frisian" + }, + { + "value": "yua", + "description": "Yucatec Maya" + }, + { + "value": "za", + "description": "Zhuang" + }, + { + "value": "zu", + "description": "Zulu" + }, + { + "value": "unk", + "description": "Unknown (All)" + } + ] + }, + "description": "The language codes supported for input by OcrSkill." + }, + "OcrSkillLineEnding": { + "type": "string", + "enum": [ + "space", + "carriageReturn", + "lineFeed", + "carriageReturnLineFeed" + ], + "x-ms-enum": { + "name": "LineEnding", + "modelAsString": true, + "values": [ + { + "value": "space", + "name": "Space", + "description": "Lines are separated by a single space character." + }, + { + "value": "carriageReturn", + "name": "CarriageReturn", + "description": "Lines are separated by a carriage return ('\\r') character." + }, + { + "value": "lineFeed", + "name": "LineFeed", + "description": "Lines are separated by a single line feed ('\\n') character." + }, + { + "value": "carriageReturnLineFeed", + "name": "CarriageReturnLineFeed", + "description": "Lines are separated by a carriage return and a line feed ('\\r\\n') character." + } + ] + }, + "description": "Defines the sequence of characters to use between the lines of text recognized by the OCR skill. The default value is \"space\"." + }, + "SplitSkillLanguage": { + "type": "string", + "enum": [ + "am", + "bs", + "cs", + "da", + "de", + "en", + "es", + "et", + "fi", + "fr", + "he", + "hi", + "hr", + "hu", + "id", + "is", + "it", + "ja", + "ko", + "lv", + "nb", + "nl", + "pl", + "pt", + "pt-br", + "ru", + "sk", + "sl", + "sr", + "sv", + "tr", + "ur", + "zh" + ], + "x-ms-enum": { + "name": "SplitSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "am", + "description": "Amharic" + }, + { + "value": "bs", + "description": "Bosnian" + }, + { + "value": "cs", + "description": "Czech" + }, + { + "value": "da", + "description": "Danish" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "et", + "description": "Estonian" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "he", + "description": "Hebrew" + }, + { + "value": "hi", + "description": "Hindi" + }, + { + "value": "hr", + "description": "Croatian" + }, + { + "value": "hu", + "description": "Hungarian" + }, + { + "value": "id", + "description": "Indonesian" + }, + { + "value": "is", + "description": "Icelandic" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "lv", + "description": "Latvian" + }, + { + "value": "nb", + "description": "Norwegian" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt", + "description": "Portuguese (Portugal)" + }, + { + "value": "pt-br", + "description": "Portuguese (Brazil)" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "sk", + "description": "Slovak" + }, + { + "value": "sl", + "description": "Slovenian" + }, + { + "value": "sr", + "description": "Serbian" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "tr", + "description": "Turkish" + }, + { + "value": "ur", + "description": "Urdu" + }, + { + "value": "zh", + "description": "Chinese (Simplified)" + } + ] + }, + "description": "The language codes supported for input text by SplitSkill." + }, + "CustomEntityLookupSkillLanguage": { + "type": "string", + "enum": [ + "da", + "de", + "en", + "es", + "fi", + "fr", + "it", + "ko", + "pt" + ], + "x-ms-enum": { + "name": "CustomEntityLookupSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "da", + "description": "Danish" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "pt", + "description": "Portuguese" + } + ] + }, + "description": "The language codes supported for input text by CustomEntityLookupSkill." + }, + "EntityRecognitionSkillLanguage": { + "type": "string", + "enum": [ + "ar", + "cs", + "zh-Hans", + "zh-Hant", + "da", + "nl", + "en", + "fi", + "fr", + "de", + "el", + "hu", + "it", + "ja", + "ko", + "no", + "pl", + "pt-PT", + "pt-BR", + "ru", + "es", + "sv", + "tr" + ], + "x-ms-enum": { + "name": "EntityRecognitionSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "ar", + "description": "Arabic" + }, + { + "value": "cs", + "description": "Czech" + }, + { + "value": "zh-Hans", + "description": "Chinese-Simplified" + }, + { + "value": "zh-Hant", + "description": "Chinese-Traditional" + }, + { + "value": "da", + "description": "Danish" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "el", + "description": "Greek" + }, + { + "value": "hu", + "description": "Hungarian" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "no", + "description": "Norwegian (Bokmaal)" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt-PT", + "description": "Portuguese (Portugal)" + }, + { + "value": "pt-BR", + "description": "Portuguese (Brazil)" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "tr", + "description": "Turkish" + } + ] + }, + "description": "Deprecated. The language codes supported for input text by EntityRecognitionSkill.", + "x-az-search-deprecated": true + }, + "TextTranslationSkillLanguage": { + "type": "string", + "enum": [ + "af", + "ar", + "bn", + "bs", + "bg", + "yue", + "ca", + "zh-Hans", + "zh-Hant", + "hr", + "cs", + "da", + "nl", + "en", + "et", + "fj", + "fil", + "fi", + "fr", + "de", + "el", + "ht", + "he", + "hi", + "mww", + "hu", + "is", + "id", + "it", + "ja", + "sw", + "tlh", + "tlh-Latn", + "tlh-Piqd", + "ko", + "lv", + "lt", + "mg", + "ms", + "mt", + "nb", + "fa", + "pl", + "pt", + "pt-br", + "pt-PT", + "otq", + "ro", + "ru", + "sm", + "sr-Cyrl", + "sr-Latn", + "sk", + "sl", + "es", + "sv", + "ty", + "ta", + "te", + "th", + "to", + "tr", + "uk", + "ur", + "vi", + "cy", + "yua", + "ga", + "kn", + "mi", + "ml", + "pa" + ], + "x-ms-enum": { + "name": "TextTranslationSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "af", + "description": "Afrikaans" + }, + { + "value": "ar", + "description": "Arabic" + }, + { + "value": "bn", + "description": "Bangla" + }, + { + "value": "bs", + "description": "Bosnian (Latin)" + }, + { + "value": "bg", + "description": "Bulgarian" + }, + { + "value": "yue", + "description": "Cantonese (Traditional)" + }, + { + "value": "ca", + "description": "Catalan" + }, + { + "value": "zh-Hans", + "description": "Chinese Simplified" + }, + { + "value": "zh-Hant", + "description": "Chinese Traditional" + }, + { + "value": "hr", + "description": "Croatian" + }, + { + "value": "cs", + "description": "Czech" + }, + { + "value": "da", + "description": "Danish" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "et", + "description": "Estonian" + }, + { + "value": "fj", + "description": "Fijian" + }, + { + "value": "fil", + "description": "Filipino" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "el", + "description": "Greek" + }, + { + "value": "ht", + "description": "Haitian Creole" + }, + { + "value": "he", + "description": "Hebrew" + }, + { + "value": "hi", + "description": "Hindi" + }, + { + "value": "mww", + "description": "Hmong Daw" + }, + { + "value": "hu", + "description": "Hungarian" + }, + { + "value": "is", + "description": "Icelandic" + }, + { + "value": "id", + "description": "Indonesian" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "sw", + "description": "Kiswahili" + }, + { + "value": "tlh", + "description": "Klingon" + }, + { + "value": "tlh-Latn", + "description": "Klingon (Latin script)" + }, + { + "value": "tlh-Piqd", + "description": "Klingon (Klingon script)" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "lv", + "description": "Latvian" + }, + { + "value": "lt", + "description": "Lithuanian" + }, + { + "value": "mg", + "description": "Malagasy" + }, + { + "value": "ms", + "description": "Malay" + }, + { + "value": "mt", + "description": "Maltese" + }, + { + "value": "nb", + "description": "Norwegian" + }, + { + "value": "fa", + "description": "Persian" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt", + "description": "Portuguese" + }, + { + "value": "pt-br", + "description": "Portuguese (Brazil)" + }, + { + "value": "pt-PT", + "description": "Portuguese (Portugal)" + }, + { + "value": "otq", + "description": "Queretaro Otomi" + }, + { + "value": "ro", + "description": "Romanian" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "sm", + "description": "Samoan" + }, + { + "value": "sr-Cyrl", + "description": "Serbian (Cyrillic)" + }, + { + "value": "sr-Latn", + "description": "Serbian (Latin)" + }, + { + "value": "sk", + "description": "Slovak" + }, + { + "value": "sl", + "description": "Slovenian" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "ty", + "description": "Tahitian" + }, + { + "value": "ta", + "description": "Tamil" + }, + { + "value": "te", + "description": "Telugu" + }, + { + "value": "th", + "description": "Thai" + }, + { + "value": "to", + "description": "Tongan" + }, + { + "value": "tr", + "description": "Turkish" + }, + { + "value": "uk", + "description": "Ukrainian" + }, + { + "value": "ur", + "description": "Urdu" + }, + { + "value": "vi", + "description": "Vietnamese" + }, + { + "value": "cy", + "description": "Welsh" + }, + { + "value": "yua", + "description": "Yucatec Maya" + }, + { + "value": "ga", + "description": "Irish" + }, + { + "value": "kn", + "description": "Kannada" + }, + { + "value": "mi", + "description": "Maori" + }, + { + "value": "ml", + "description": "Malayalam" + }, + { + "value": "pa", + "description": "Punjabi" + } + ] + }, + "description": "The language codes supported for input text by TextTranslationSkill." + }, + "ImageAnalysisSkillLanguage": { + "type": "string", + "enum": [ + "ar", + "az", + "bg", + "bs", + "ca", + "cs", + "cy", + "da", + "de", + "el", + "en", + "es", + "et", + "eu", + "fi", + "fr", + "ga", + "gl", + "he", + "hi", + "hr", + "hu", + "id", + "it", + "ja", + "kk", + "ko", + "lt", + "lv", + "mk", + "ms", + "nb", + "nl", + "pl", + "prs", + "pt-BR", + "pt", + "pt-PT", + "ro", + "ru", + "sk", + "sl", + "sr-Cyrl", + "sr-Latn", + "sv", + "th", + "tr", + "uk", + "vi", + "zh", + "zh-Hans", + "zh-Hant" + ], + "x-ms-enum": { + "name": "ImageAnalysisSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "ar", + "description": "Arabic" + }, + { + "value": "az", + "description": "Azerbaijani" + }, + { + "value": "bg", + "description": "Bulgarian" + }, + { + "value": "bs", + "description": "Bosnian Latin" + }, + { + "value": "ca", + "description": "Catalan" + }, + { + "value": "cs", + "description": "Czech" + }, + { + "value": "cy", + "description": "Welsh" + }, + { + "value": "da", + "description": "Danish" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "el", + "description": "Greek" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "et", + "description": "Estonian" + }, + { + "value": "eu", + "description": "Basque" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "ga", + "description": "Irish" + }, + { + "value": "gl", + "description": "Galician" + }, + { + "value": "he", + "description": "Hebrew" + }, + { + "value": "hi", + "description": "Hindi" + }, + { + "value": "hr", + "description": "Croatian" + }, + { + "value": "hu", + "description": "Hungarian" + }, + { + "value": "id", + "description": "Indonesian" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "kk", + "description": "Kazakh" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "lt", + "description": "Lithuanian" + }, + { + "value": "lv", + "description": "Latvian" + }, + { + "value": "mk", + "description": "Macedonian" + }, + { + "value": "ms", + "description": "Malay Malaysia" + }, + { + "value": "nb", + "description": "Norwegian (Bokmal)" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "prs", + "description": "Dari" + }, + { + "value": "pt-BR", + "description": "Portuguese-Brazil" + }, + { + "value": "pt", + "description": "Portuguese-Portugal" + }, + { + "value": "pt-PT", + "description": "Portuguese-Portugal" + }, + { + "value": "ro", + "description": "Romanian" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "sk", + "description": "Slovak" + }, + { + "value": "sl", + "description": "Slovenian" + }, + { + "value": "sr-Cyrl", + "description": "Serbian - Cyrillic RS" + }, + { + "value": "sr-Latn", + "description": "Serbian - Latin RS" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "th", + "description": "Thai" + }, + { + "value": "tr", + "description": "Turkish" + }, + { + "value": "uk", + "description": "Ukrainian" + }, + { + "value": "vi", + "description": "Vietnamese" + }, + { + "value": "zh", + "description": "Chinese Simplified" + }, + { + "value": "zh-Hans", + "description": "Chinese Simplified" + }, + { + "value": "zh-Hant", + "description": "Chinese Traditional" + } + ] + }, + "description": "The language codes supported for input by ImageAnalysisSkill." + }, + "SynonymMap": { + "properties": { + "name": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the synonym map." + }, + "format": { + "type": "string", + "enum": [ + "solr" + ], + "x-ms-enum": { + "name": "SynonymMapFormat", + "modelAsString": false, + "values": [ + { + "value": "solr", + "name": "Solr", + "description": "Selects the SOLR format for synonym maps." + } + ] + }, + "description": "The format of the synonym map. Only the 'solr' format is currently supported." + }, + "synonyms": { + "type": "string", + "description": "A series of synonym rules in the specified synonym map format. The rules must be separated by newlines.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Synonym-Map#SynonymMapFormat" + } + }, + "encryptionKey": { + "$ref": "#/definitions/SearchResourceEncryptionKey", + "description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data. Once you have encrypted your data, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.", + "externalDocs": { + "url": "https://aka.ms/azure-search-encryption-with-cmk" + }, + "x-nullable": true + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the synonym map." + } + }, + "required": [ + "name", + "format", + "synonyms" + ], + "description": "Represents a synonym map definition." + }, + "ListSynonymMapsResult": { + "properties": { + "value": { + "x-ms-client-name": "SynonymMaps", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SynonymMap" + }, + "description": "The synonym maps in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a List SynonymMaps request. If successful, it includes the full definitions of all synonym maps." + }, + "SearchResourceEncryptionKey": { + "properties": { + "keyVaultKeyName": { + "x-ms-client-name": "keyName", + "type": "string", + "description": "The name of your Azure Key Vault key to be used to encrypt your data at rest." + }, + "keyVaultKeyVersion": { + "x-ms-client-name": "keyVersion", + "type": "string", + "description": "The version of your Azure Key Vault key to be used to encrypt your data at rest." + }, + "keyVaultUri": { + "x-ms-client-name": "vaultUri", + "type": "string", + "description": "The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`." + }, + "accessCredentials": { + "$ref": "#/definitions/AzureActiveDirectoryApplicationCredentials", + "description": "Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead.", + "externalDocs": { + "url": "https://aka.ms/azure-search-msi" + } + }, + "identity": { + "$ref": "#/definitions/SearchIndexerDataIdentity", + "x-nullable": true, + "description": "An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If \"none\" is specified, the value of this property is cleared." + } + }, + "required": [ + "keyVaultKeyName", + "keyVaultKeyVersion", + "keyVaultUri" + ], + "description": "A customer-managed encryption key in Azure Key Vault. Keys that you create and manage can be used to encrypt or decrypt data-at-rest, such as indexes and synonym maps." + }, + "SearchIndexerCache": { + "type": "object", + "properties": { + "storageConnectionString": { + "type": "string", + "description": "The connection string to the storage account where the cache data will be persisted." + }, + "enableReprocessing": { + "type": "boolean", + "x-nullable": true, + "description": "Specifies whether incremental reprocessing is enabled." + }, + "identity": { + "$ref": "#/definitions/SearchIndexerDataIdentity", + "x-nullable": true, + "description": "The user-assigned managed identity used for connections to the enrichment cache. If the connection string indicates an identity (ResourceId) and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to \"none\", the value of this property is cleared." + } + } + }, + "AzureActiveDirectoryApplicationCredentials": { + "properties": { + "applicationId": { + "type": "string", + "description": "An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application." + }, + "applicationSecret": { + "type": "string", + "description": "The authentication key of the specified AAD application." + } + }, + "required": [ + "applicationId" + ], + "description": "Credentials of a registered application created for your search service, used for authenticated access to the encryption keys stored in Azure Key Vault." + }, + "ServiceStatistics": { + "properties": { + "counters": { + "$ref": "#/definitions/ServiceCounters", + "description": "Service level resource counters." + }, + "limits": { + "$ref": "#/definitions/ServiceLimits", + "description": "Service level general limits." + } + }, + "required": [ + "counters", + "limits" + ], + "description": "Response from a get service statistics request. If successful, it includes service level counters and limits." + }, + "ServiceCounters": { + "properties": { + "aliasesCount": { + "x-ms-client-name": "aliasCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of aliases." + }, + "documentCount": { + "x-ms-client-name": "documentCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of documents across all indexes in the service." + }, + "indexesCount": { + "x-ms-client-name": "indexCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of indexes." + }, + "indexersCount": { + "x-ms-client-name": "indexerCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of indexers." + }, + "dataSourcesCount": { + "x-ms-client-name": "dataSourceCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of data sources." + }, + "storageSize": { + "x-ms-client-name": "storageSizeCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total size of used storage in bytes." + }, + "synonymMaps": { + "x-ms-client-name": "synonymMapCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of synonym maps." + }, + "skillsetCount": { + "x-ms-client-name": "skillsetCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of skillsets." + }, + "vectorIndexSize": { + "x-ms-client-name": "vectorIndexSizeCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total memory consumption of all vector indexes within the service, in bytes." + } + }, + "required": [ + "aliasesCount", + "documentCount", + "indexesCount", + "indexersCount", + "dataSourcesCount", + "storageSize", + "synonymMaps", + "skillsetCount", + "vectorIndexSize" + ], + "description": "Represents service-level resource counters and quotas." + }, + "ServiceLimits": { + "properties": { + "maxFieldsPerIndex": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum allowed fields per index." + }, + "maxFieldNestingDepthPerIndex": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum depth which you can nest sub-fields in an index, including the top-level complex field. For example, a/b/c has a nesting depth of 3." + }, + "maxComplexCollectionFieldsPerIndex": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum number of fields of type Collection(Edm.ComplexType) allowed in an index." + }, + "maxComplexObjectsInCollectionsPerDocument": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum number of objects in complex collections allowed per document." + }, + "maxStoragePerIndex": { + "x-ms-client-name": "maxStoragePerIndexInBytes", + "type": "integer", + "format": "int64", + "x-nullable": true, + "description": "The maximum amount of storage in bytes allowed per index." + } + }, + "description": "Represents various service level limits." + }, + "ResourceCounter": { + "properties": { + "usage": { + "type": "integer", + "format": "int64", + "x-nullable": false, + "description": "The resource usage amount." + }, + "quota": { + "type": "integer", + "format": "int64", + "x-nullable": true, + "description": "The resource amount quota." + } + }, + "required": [ + "usage" + ], + "description": "Represents a resource's usage and quota." + }, + "SemanticSettings": { + "x-ms-client-name": "SemanticSearch", + "properties": { + "defaultConfiguration": { + "x-ms-client-name": "defaultConfigurationName", + "type": "string", + "description": "Allows you to set the name of a default semantic configuration in your index, making it optional to pass it on as a query parameter every time." + }, + "configurations": { + "type": "array", + "items": { + "$ref": "#/definitions/SemanticConfiguration" + }, + "description": "The semantic configurations for the index." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/semantic-search-overview" + }, + "description": "Defines parameters for a search index that influence semantic capabilities." + }, + "SemanticConfiguration": { + "properties": { + "name": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the semantic configuration.", + "x-nullable": false + }, + "prioritizedFields": { + "$ref": "#/definitions/PrioritizedFields", + "x-nullable": false, + "description": "Describes the title, content, and keyword fields to be used for semantic ranking, captions, highlights, and answers. At least one of the three sub properties (titleField, prioritizedKeywordsFields and prioritizedContentFields) need to be set." + } + }, + "required": [ + "name", + "prioritizedFields" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/semantic-search-overview" + }, + "description": "Defines a specific configuration to be used in the context of semantic capabilities." + }, + "PrioritizedFields": { + "x-ms-client-name": "SemanticPrioritizedFields", + "properties": { + "titleField": { + "$ref": "#/definitions/SemanticField", + "description": "Defines the title field to be used for semantic ranking, captions, highlights, and answers. If you don't have a title field in your index, leave this blank." + }, + "prioritizedContentFields": { + "x-ms-client-name": "contentFields", + "type": "array", + "items": { + "$ref": "#/definitions/SemanticField" + }, + "description": "Defines the content fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain text in natural language form. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long." + }, + "prioritizedKeywordsFields": { + "x-ms-client-name": "keywordsFields", + "type": "array", + "items": { + "$ref": "#/definitions/SemanticField" + }, + "description": "Defines the keyword fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain a list of keywords. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/semantic-search-overview" + }, + "description": "Describes the title, content, and keywords fields to be used for semantic ranking, captions, highlights, and answers." + }, + "SemanticField": { + "properties": { + "fieldName": { + "type": "string", + "description": "", + "x-nullable": false + } + }, + "required": [ + "fieldName" + ], + "description": "A field that is used as part of the semantic configuration." + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ClientRequestIdParameter": { + "name": "x-ms-client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The tracking ID sent with the request to help with debugging.", + "x-ms-client-request-id": true, + "x-ms-parameter-grouping": { + "name": "request-options" + }, + "x-ms-parameter-location": "method" + }, + "IfMatchParameter": { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.", + "x-ms-parameter-location": "method" + }, + "IfNoneMatchParameter": { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.", + "x-ms-parameter-location": "method" + }, + "PreferHeaderParameter": { + "name": "Prefer", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "return=representation" + ], + "description": "For HTTP PUT requests, instructs the service to return the created/updated resource on success.", + "x-ms-parameter-location": "method" + }, + "EndpointParameter": { + "name": "endpoint", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "description": "The endpoint URL of the search service.", + "x-ms-parameter-location": "client" + }, + "DisableCacheReprocessingChangeDetectionParameter": { + "name": "disableCacheReprocessingChangeDetection", + "in": "query", + "required": false, + "type": "boolean", + "description": "Disables cache reprocessing change detection.", + "x-ms-parameter-location": "method" + }, + "IgnoreResetRequirementsParameter": { + "name": "ignoreResetRequirements", + "x-ms-client-name": "skipIndexerResetRequirementForCache", + "in": "query", + "required": false, + "type": "boolean", + "description": "Ignores cache reset requirements.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/search/data-plane/Azure.Search/readme.md b/specification/search/data-plane/Azure.Search/readme.md index 1ff80a2c48e2..b1cc42b884bd 100644 --- a/specification/search/data-plane/Azure.Search/readme.md +++ b/specification/search/data-plane/Azure.Search/readme.md @@ -26,7 +26,7 @@ These are the global settings for SearchServiceClient and SearchIndexClient. title: SearchClient opt-in-extensible-enums: true openapi-type: data-plane -tag: package-2024-09-01-preview +tag: package-2024-11-01-preview directive: - where: @@ -169,6 +169,34 @@ directive: ### Tag: package-2024-09-01-preview +These settings apply only when `--tag=package-2024-11-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2024-11-01-preview' +input-file: +- preview/2024-11-01-preview/searchservice.json +- preview/2024-11-01-preview/searchindex.json +``` + +### Tag: package-2024-11-searchservice-preview + +These settings apply only when `--tag=package-2024-11-searchservice-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2024-11-searchservice-preview' +input-file: +- preview/2024-11-01-preview/searchservice.json +``` + +### Tag: package-2024-11-searchindex-preview + +These settings apply only when `--tag=package-2024-11-searchindex-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2024-11-searchindex-preview' +input-file: +- preview/2024-11-01-preview/searchindex.json +``` + +### Tag: package-2024-09-01-preview + These settings apply only when `--tag=package-2024-09-01-preview` is specified on the command line. ``` yaml $(tag) == 'package-2024-09-01-preview' From 30ecdd9b72f70eb2fdb29d99e31e0de2959af272 Mon Sep 17 00:00:00 2001 From: Rahul Singh <53578268+rahuls-microsoft@users.noreply.github.com> Date: Fri, 4 Oct 2024 14:28:28 -0700 Subject: [PATCH 45/47] Fleet GA API version "2024-11-01" (#30568) * Updating the version to "2024-10-01" * Fix Stable version path in readme.Md * Updating path for stable version. * Updating Readme.md files for other languages SDK. * Updating SDK readme.md files. * Add Java SDK readme reference to main readme.md file. * Updating Main.tsp to add GA version. * Remove version references from individual sdk readme.md files, as it gets it from main.tsp. * fixing dependencies for2024-10-01 in main.tsp. * updated generated file from sp. * Adding example refs back, removed by tool * Adding examples * Update main.tsp. local build - npx tsv specification/azurefleet/AzureFleet.Management * Update Path for 24_10_01 in main.tsp * Restore Python package-version: 1.0.0b1 * Adding Retry-after header in 20` response examples. * Changing API version to 2024-11-01 * Updating "provisioningState" in example and swagger - adding "Azure-AsyncOperation" - header. * update to example. * Updating the examples based on tsp generated to pass the build. The Tsp files needs to be update for correctness. * Update examples to have succeeded state * Update sdk-suppressions.yaml * Updating examples to add Retry-After header. Update "provisioningState": "Creating" for 201 responses. * Changes for Attribute schema. * Attribute changes. * Updates. * Adding Atrributes. * Supressing - typespec-azure-core/casing-style: The names of Model types must use PascalCase * Adding VM Attributes properties. * Adding refrence to VmAttributes and locationProfiles (Needs to be completed for model.) * Adding AdditionalCapabilities, LocationProfile. * Run Prettier. * Spell Check fixes. * Make paramters optional - vmAttributes, additionalLocationsProfile * Fixing Descriptions. * Supress error for ultraSSDEnabled name. * Updates after npx ci * Revert "Updates after npx ci" This reverts commit bf1aed71f182bc43cfe5efd23a929a6c49912f29. * Updates after npx ci * Supression update * Updating description of ultraSSD to match Compute description. * Supress Camel Case error for SSD * Suppress ultraSSDEnabled for DefinitionsPropertiesNamesCamelCase --------- Co-authored-by: Sahil Arora <arorasahil@microsoft.com> Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> Co-authored-by: Rahul Singh <rahuls@microsft.com> --- .../Fleets_CreateOrUpdate_MaximumSet.json | 3 +- .../Fleets_CreateOrUpdate_MinimumSet.json | 3 +- .../Fleets_Update_MaximumSet.json | 3 +- .../Fleets_Update_MinimumSet.json | 3 +- .../Fleets_CreateOrUpdate.json | 2 +- .../Fleets_CreateOrUpdate_MinimumSet.json | 2 +- .../2024-05-01-preview/Fleets_Update.json | 3 +- .../2024-11-01/Fleets_CreateOrUpdate.json | 1174 ++++++ .../Fleets_CreateOrUpdate_MinimumSet.json | 300 ++ .../examples/2024-11-01/Fleets_Delete.json | 18 + .../examples/2024-11-01/Fleets_Get.json | 405 ++ .../Fleets_ListByResourceGroup.json | 409 ++ .../2024-11-01/Fleets_ListBySubscription.json | 408 ++ .../Fleets_ListVirtualMachineScaleSets.json | 40 + .../examples/2024-11-01/Fleets_Update.json | 767 ++++ .../examples/2024-11-01/Operations_List.json | 71 + .../AzureFleet.Management/fleet.tsp | 285 ++ .../azurefleet/AzureFleet.Management/main.tsp | 6 + .../Fleets_CreateOrUpdate_MaximumSet.json | 3 +- .../Fleets_CreateOrUpdate_MinimumSet.json | 3 +- .../examples/Fleets_Update_MaximumSet.json | 3 +- .../examples/Fleets_Update_MinimumSet.json | 3 +- .../examples/Fleets_CreateOrUpdate.json | 2 +- .../Fleets_CreateOrUpdate_MinimumSet.json | 2 +- .../examples/Fleets_Update.json | 3 +- .../stable/2024-11-01/azurefleet.json | 3581 +++++++++++++++++ .../examples/Fleets_CreateOrUpdate.json | 1174 ++++++ .../Fleets_CreateOrUpdate_MinimumSet.json | 300 ++ .../2024-11-01/examples/Fleets_Delete.json | 18 + .../2024-11-01/examples/Fleets_Get.json | 405 ++ .../examples/Fleets_ListByResourceGroup.json | 409 ++ .../examples/Fleets_ListBySubscription.json | 408 ++ .../Fleets_ListVirtualMachineScaleSets.json | 40 + .../2024-11-01/examples/Fleets_Update.json | 767 ++++ .../2024-11-01/examples/Operations_List.json | 71 + .../azurefleet/resource-manager/readme.az.md | 2 - .../azurefleet/resource-manager/readme.cli.md | 12 +- .../azurefleet/resource-manager/readme.go.md | 2 +- .../resource-manager/readme.java.md | 13 + .../azurefleet/resource-manager/readme.md | 18 +- .../resource-manager/readme.python.md | 2 +- .../resource-manager/sdk-suppressions.yaml | 48 +- 42 files changed, 11169 insertions(+), 22 deletions(-) create mode 100644 specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_CreateOrUpdate.json create mode 100644 specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_CreateOrUpdate_MinimumSet.json create mode 100644 specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_Delete.json create mode 100644 specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_Get.json create mode 100644 specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_ListByResourceGroup.json create mode 100644 specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_ListBySubscription.json create mode 100644 specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_ListVirtualMachineScaleSets.json create mode 100644 specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_Update.json create mode 100644 specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Operations_List.json create mode 100644 specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/azurefleet.json create mode 100644 specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_CreateOrUpdate.json create mode 100644 specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_CreateOrUpdate_MinimumSet.json create mode 100644 specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_Delete.json create mode 100644 specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_Get.json create mode 100644 specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_ListByResourceGroup.json create mode 100644 specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_ListBySubscription.json create mode 100644 specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_ListVirtualMachineScaleSets.json create mode 100644 specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_Update.json create mode 100644 specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Operations_List.json create mode 100644 specification/azurefleet/resource-manager/readme.java.md diff --git a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_CreateOrUpdate_MaximumSet.json b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_CreateOrUpdate_MaximumSet.json index afa94a22086e..765892be1275 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_CreateOrUpdate_MaximumSet.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_CreateOrUpdate_MaximumSet.json @@ -765,7 +765,8 @@ }, "201": { "headers": { - "Azure-AsyncOperation": "https://contoso.com/operationstatus" + "Azure-AsyncOperation": "https://contoso.com/operationstatus", + "Retry-After": 30 }, "body": { "properties": { diff --git a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_CreateOrUpdate_MinimumSet.json b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_CreateOrUpdate_MinimumSet.json index 1adda99d41ae..0c7cbc16f8e8 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_CreateOrUpdate_MinimumSet.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_CreateOrUpdate_MinimumSet.json @@ -19,7 +19,8 @@ }, "201": { "headers": { - "Azure-AsyncOperation": "https://contoso.com/operationstatus" + "Azure-AsyncOperation": "https://contoso.com/operationstatus", + "Retry-After": 30 }, "body": { "location": "westus", diff --git a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Update_MaximumSet.json b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Update_MaximumSet.json index 1ec2663494ac..7abc1f77347b 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Update_MaximumSet.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Update_MaximumSet.json @@ -752,7 +752,8 @@ }, "202": { "headers": { - "location": "https://contoso.com/operationstatus" + "location": "https://contoso.com/operationstatus", + "Retry-After": 30 } } } diff --git a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Update_MinimumSet.json b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Update_MinimumSet.json index ae9018cbee4f..b8629a85cf15 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Update_MinimumSet.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Update_MinimumSet.json @@ -16,7 +16,8 @@ }, "202": { "headers": { - "location": "https://contoso.com/operationstatus" + "location": "https://contoso.com/operationstatus", + "Retry-After": 30 } } } diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_CreateOrUpdate.json b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_CreateOrUpdate.json index f8a4fab670f2..45338e3137a5 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_CreateOrUpdate.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_CreateOrUpdate.json @@ -383,7 +383,7 @@ "200": { "body": { "properties": { - "provisioningState": "Creating", + "provisioningState": "Succeeded", "spotPriorityProfile": { "capacity": 10, "minCapacity": 20, diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_CreateOrUpdate_MinimumSet.json b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_CreateOrUpdate_MinimumSet.json index 8d9bd1338335..74ee56feafa8 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_CreateOrUpdate_MinimumSet.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_CreateOrUpdate_MinimumSet.json @@ -101,7 +101,7 @@ "200": { "body": { "properties": { - "provisioningState": "Creating", + "provisioningState": "Succeeded", "spotPriorityProfile": { "capacity": 2, "minCapacity": 1, diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_Update.json b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_Update.json index 41186c2130fa..0abdb2cf6780 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_Update.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_Update.json @@ -759,7 +759,8 @@ }, "202": { "headers": { - "location": "https://contoso.com/operationstatus" + "location": "https://contoso.com/operationstatus", + "Retry-After": 30 } } } diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_CreateOrUpdate.json b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_CreateOrUpdate.json new file mode 100644 index 000000000000..a76ad9c827a9 --- /dev/null +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_CreateOrUpdate.json @@ -0,0 +1,1174 @@ +{ + "title": "Fleets_CreateOrUpdate", + "operationId": "Fleets_CreateOrUpdate", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet", + "fleetName": "testFleet", + "resource": { + "properties": { + "spotPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "adminPassword": "adfbrdxpv", + "customData": "xjjib", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon", + "content": "bubmqbxjkj" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Https", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "protectedSettings": {}, + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myvaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } + } + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "configurationReference": "ulztmiavpojpbpbddgnuuiimxcpau", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + } + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + } + }, + "zones": [ + "zone1", + "zone2" + ], + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "key9851": {} + } + }, + "tags": { + "key3518": "luvrnuvsgdpbuofdskkcoqhfh" + }, + "location": "westus", + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "spotPriorityProfile": { + "capacity": 10, + "minCapacity": 20, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 10, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Https", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "exactVersion": "zjbntmiskjexlr", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "type": "cmeam", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "provisioningState": "Succeeded", + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + }, + "timeCreated": "2024-04-29T21:51:44.043Z" + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "zones": [ + "zone1", + "zone2" + ], + "identity": { + "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "type": "UserAssigned", + "userAssignedIdentities": { + "key9851": { + "principalId": "6d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "clientId": "7d508e5b-374b-4382-9a1c-01fb8b6cb37c" + } + } + }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, + "tags": { + "key3518": "luvrnuvsgdpbuofdskkcoqhfh" + }, + "location": "westus", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets", + "systemData": { + "createdBy": "rowegentrpoajsv", + "createdByType": "User", + "createdAt": "2024-04-29T21:51:44.043Z", + "lastModifiedBy": "edwuayhhaoepxzisfaqjhmrxjq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-29T21:51:44.043Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus", + "Retry-After": 30 + }, + "body": { + "properties": { + "provisioningState": "Creating", + "spotPriorityProfile": { + "capacity": 0, + "minCapacity": 0, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Https", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "exactVersion": "zjbntmiskjexlr", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "type": "cmeam", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "provisioningState": "Succeeded", + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + }, + "timeCreated": "2024-04-29T21:51:44.043Z" + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "zones": [ + "zone1", + "zone2" + ], + "identity": { + "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "type": "UserAssigned", + "userAssignedIdentities": { + "key9851": { + "principalId": "6d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "clientId": "7d508e5b-374b-4382-9a1c-01fb8b6cb37c" + } + } + }, + "tags": { + "key3518": "luvrnuvsgdpbuofdskkcoqhfh" + }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, + "location": "westus", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets", + "systemData": { + "createdBy": "rowegentrpoajsv", + "createdByType": "User", + "createdAt": "2024-04-29T21:51:44.043Z", + "lastModifiedBy": "edwuayhhaoepxzisfaqjhmrxjq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-29T21:51:44.043Z" + } + } + } + } +} diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_CreateOrUpdate_MinimumSet.json b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_CreateOrUpdate_MinimumSet.json new file mode 100644 index 000000000000..e94c80506873 --- /dev/null +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_CreateOrUpdate_MinimumSet.json @@ -0,0 +1,300 @@ +{ + "title": "Fleets_CreateOrUpdate_MinimumSet", + "operationId": "Fleets_CreateOrUpdate", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet", + "fleetName": "testFleet", + "resource": { + "properties": { + "spotPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_D2s_v3" + }, + { + "name": "Standard_D4s_v3" + }, + { + "name": "Standard_E2s_v3" + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "storageProfile": { + "imageReference": { + "publisher": "canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts-gen2", + "version": "latest" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + } + }, + "osProfile": { + "computerNamePrefix": "prefix", + "adminUsername": "azureuser", + "adminPassword": "TestPassword$0", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "primary": true, + "enableAcceleratedNetworking": false, + "ipConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true + } + } + ], + "networkApiVersion": "2022-07-01" + } + }, + "computeApiVersion": "2023-09-01", + "platformFaultDomainCount": 1 + } + }, + "tags": { + "key": "fleets-test" + }, + "location": "eastus2euap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "spotPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_D2s_v3" + }, + { + "name": "Standard_D4s_v3" + }, + { + "name": "Standard_E2s_v3" + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "storageProfile": { + "imageReference": { + "publisher": "canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts-gen2", + "version": "latest" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + } + }, + "osProfile": { + "computerNamePrefix": "prefix", + "adminUsername": "azureuser", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "primary": true, + "enableAcceleratedNetworking": false, + "ipConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true + } + } + ], + "networkApiVersion": "2022-07-01" + } + }, + "computeApiVersion": "2023-09-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "tags": { + "key": "fleets-test" + }, + "location": "eastus2euap", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus", + "Retry-After": 30 + }, + "body": { + "properties": { + "provisioningState": "Creating", + "spotPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_D2s_v3" + }, + { + "name": "Standard_D4s_v3" + }, + { + "name": "Standard_E2s_v3" + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "storageProfile": { + "imageReference": { + "publisher": "canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts-gen2", + "version": "latest" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + } + }, + "osProfile": { + "computerNamePrefix": "prefix", + "adminUsername": "azureuser", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "primary": true, + "enableAcceleratedNetworking": false, + "ipConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true + } + } + ], + "networkApiVersion": "2022-07-01" + } + }, + "computeApiVersion": "2023-09-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "tags": { + "key": "fleets-test" + }, + "location": "eastus2euap", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets" + } + } + } +} diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_Delete.json b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_Delete.json new file mode 100644 index 000000000000..18f72eff408a --- /dev/null +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Fleets_Delete", + "operationId": "Fleets_Delete", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet", + "fleetName": "testFleet" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_Get.json b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_Get.json new file mode 100644 index 000000000000..5d9c7b54d0a9 --- /dev/null +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_Get.json @@ -0,0 +1,405 @@ +{ + "title": "Fleets_Get", + "operationId": "Fleets_Get", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet", + "fleetName": "testFleet" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Creating", + "spotPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "exactVersion": "zjbntmiskjexlr", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "type": "cmeam", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "provisioningState": "Succeeded", + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "mubredelfbshboaxrsxiajihahaa", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + }, + "timeCreated": "2024-04-29T21:51:44.043Z" + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "zones": [ + "zone1", + "zone2" + ], + "identity": { + "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "type": "UserAssigned", + "userAssignedIdentities": { + "key9851": { + "principalId": "6d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "clientId": "7d508e5b-374b-4382-9a1c-01fb8b6cb37c" + } + } + }, + "tags": { + "key3518": "luvrnuvsgdpbuofdskkcoqhfh" + }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, + "location": "westus", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets", + "systemData": { + "createdBy": "rowegentrpoajsv", + "createdByType": "User", + "createdAt": "2024-04-29T21:51:44.043Z", + "lastModifiedBy": "edwuayhhaoepxzisfaqjhmrxjq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-29T21:51:44.043Z" + } + } + } + } +} diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_ListByResourceGroup.json b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_ListByResourceGroup.json new file mode 100644 index 000000000000..3a834d56d590 --- /dev/null +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_ListByResourceGroup.json @@ -0,0 +1,409 @@ +{ + "title": "Fleets_ListByResourceGroup", + "operationId": "Fleets_ListByResourceGroup", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Creating", + "spotPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "exactVersion": "zjbntmiskjexlr", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "type": "cmeam", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "provisioningState": "Succeeded", + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "mubredelfbshboaxrsxiajihahaa", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + }, + "timeCreated": "2024-04-29T21:51:44.043Z" + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "zones": [ + "zone1", + "zone2" + ], + "identity": { + "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "type": "UserAssigned", + "userAssignedIdentities": { + "key9851": { + "principalId": "6d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "clientId": "7d508e5b-374b-4382-9a1c-01fb8b6cb37c" + } + } + }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, + "tags": { + "key3518": "luvrnuvsgdpbuofdskkcoqhfh" + }, + "location": "westus", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets", + "systemData": { + "createdBy": "rowegentrpoajsv", + "createdByType": "User", + "createdAt": "2024-04-29T21:51:44.043Z", + "lastModifiedBy": "edwuayhhaoepxzisfaqjhmrxjq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-29T21:51:44.043Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_ListBySubscription.json b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_ListBySubscription.json new file mode 100644 index 000000000000..e93f74bee6b9 --- /dev/null +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_ListBySubscription.json @@ -0,0 +1,408 @@ +{ + "title": "Fleets_ListBySubscription", + "operationId": "Fleets_ListBySubscription", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Creating", + "spotPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "exactVersion": "zjbntmiskjexlr", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "type": "cmeam", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "provisioningState": "Succeeded", + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "mubredelfbshboaxrsxiajihahaa", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + }, + "timeCreated": "2024-04-29T21:51:44.043Z" + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "zones": [ + "zone1", + "zone2" + ], + "identity": { + "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "type": "UserAssigned", + "userAssignedIdentities": { + "key9851": { + "principalId": "6d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "clientId": "7d508e5b-374b-4382-9a1c-01fb8b6cb37c" + } + } + }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, + "tags": { + "key3518": "luvrnuvsgdpbuofdskkcoqhfh" + }, + "location": "westus", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets", + "systemData": { + "createdBy": "rowegentrpoajsv", + "createdByType": "User", + "createdAt": "2024-04-29T21:51:44.043Z", + "lastModifiedBy": "edwuayhhaoepxzisfaqjhmrxjq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-29T21:51:44.043Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_ListVirtualMachineScaleSets.json b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_ListVirtualMachineScaleSets.json new file mode 100644 index 000000000000..96c7add60f74 --- /dev/null +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_ListVirtualMachineScaleSets.json @@ -0,0 +1,40 @@ +{ + "title": "Fleets_ListVirtualMachineScaleSets", + "operationId": "Fleets_ListVirtualMachineScaleSets", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet", + "name": "myFleet" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myVmss", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/myFleet/virtualMachineScaleSets/myVmss", + "type": "Microsoft.AzureFleet/fleets/virtualMachineScaleSets", + "operationStatus": "Creating", + "error": { + "details": [ + { + "code": "gzhtOverconstrainedAllocationRequestyosk", + "target": "qfthabhrmndhfizfnrwpgxvnokpy", + "message": "Allocation Failed" + } + ], + "innererror": { + "exceptionType": "sfaomfpoaptnbxchrfskm", + "errorDetail": "ihjwbwykq" + }, + "code": "OverconstrainedAllocationRequest", + "target": "nhaj", + "message": "Allocation Failed" + } + } + ] + } + } + } +} diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_Update.json b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_Update.json new file mode 100644 index 000000000000..73a8f4820114 --- /dev/null +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_Update.json @@ -0,0 +1,767 @@ +{ + "title": "Fleets_Update", + "operationId": "Fleets_Update", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet", + "fleetName": "testFleet", + "properties": { + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": {} + }, + "tags": {}, + "properties": { + "spotPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "adminPassword": "adfbrdxpv", + "customData": "xjjib", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon", + "content": "bubmqbxjkj" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "protectedSettings": {}, + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } + } + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "configurationReference": "ulztmiavpojpbpbddgnuuiimxcpau", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + } + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + } + }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "spotPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}", + "exactVersion": "zjbntmiskjexlr" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + }, + "settings": {}, + "provisioningState": "Succeeded" + }, + "type": "cmeam", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + }, + "timeCreated": "2024-04-29T21:51:44.043Z" + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + }, + "provisioningState": "Creating", + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "zones": [ + "zone1", + "zone2" + ], + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": {}, + "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c" + }, + "tags": {}, + "location": "westus", + "plan": { + "name": "uapfngmdekvpgjhomthtpxjfdmmll", + "publisher": "aqhles", + "product": "bfzbkdnbexmedxdc", + "promotionCode": "gspehogwfjxirz", + "version": "yza" + }, + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets", + "systemData": { + "createdBy": "rowegentrpoajsv", + "createdByType": "User", + "createdAt": "2024-04-29T21:51:44.043Z", + "lastModifiedBy": "edwuayhhaoepxzisfaqjhmrxjq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-29T21:51:44.043Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus", + "Retry-After": 30 + } + } + } +} diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Operations_List.json b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Operations_List.json new file mode 100644 index 000000000000..8acf291032fe --- /dev/null +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Operations_List.json @@ -0,0 +1,71 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "origin": "user,system", + "name": "Microsoft.AzureFleet/fleets/read", + "isDataAction": false, + "display": { + "provider": "Microsoft Azure Fleet", + "resource": "Fleets", + "operation": "Get Azure Fleet", + "description": "Get properties of Azure Fleet resource" + } + }, + { + "origin": "user,system", + "name": "Microsoft.AzureFleet/fleets/write", + "isDataAction": false, + "display": { + "provider": "Microsoft Azure Fleet", + "resource": "Fleets", + "operation": "Create or Update Azure Fleet", + "description": "Creates a new Azure Fleet resource or updates an existing one" + } + }, + { + "origin": "user,system", + "name": "Microsoft.AzureFleet/fleets/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft Azure Fleet", + "resource": "Fleets", + "operation": "Delete Virtual Machine and Virtual Machine scale sets in a Azure Fleet resource", + "description": "Deletes all compute resources of Azure Fleet resource" + } + }, + { + "origin": "user,system", + "name": "Microsoft.AzureFleet/register/action", + "isDataAction": false, + "display": { + "provider": "Microsoft Azure Fleet", + "resource": "Subscription", + "operation": "Register subscription for Microsoft.AzureFleet", + "description": "Registers Subscription with Microsoft.AzureFleet resource provider" + } + }, + { + "origin": "user,system", + "name": "Microsoft.AzureFleet/unregister/action", + "isDataAction": false, + "display": { + "provider": "Microsoft Azure Fleet", + "resource": "Subscription", + "operation": "Unregister Subscription for Microsoft.AzureFleet", + "description": "Unregisters Subscription with Microsoft.AzureFleet resource provider" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/azurefleet/AzureFleet.Management/fleet.tsp b/specification/azurefleet/AzureFleet.Management/fleet.tsp index 2ea667384c57..c4c78b4e7f5f 100644 --- a/specification/azurefleet/AzureFleet.Management/fleet.tsp +++ b/specification/azurefleet/AzureFleet.Management/fleet.tsp @@ -84,6 +84,14 @@ model FleetProperties { @doc("List of VM sizes supported for Compute Fleet") vmSizesProfile: Array<VmSizeProfile>; + @added(Versions.v2024_11_01) + @doc("Attribute based Fleet.") + vmAttributes?: VMAttributes; + + @added(Versions.v2024_11_01) + @doc("Represents the configuration for additional locations where Fleet resources may be deployed.") + additionalLocationsProfile?: AdditionalLocationsProfile; + @doc("Compute Profile to use for running user's workloads.") computeProfile: ComputeProfile; @@ -118,6 +126,15 @@ model ComputeProfile { This property cannot be updated. """) platformFaultDomainCount?: int32; + + @added(Versions.v2024_11_01) + @doc(""" + Specifies VMSS and VM API entity models support two additional capabilities as of today: ultraSSDEnabled and hibernationEnabled. + ultraSSDEnabled: Enables UltraSSD_LRS storage account type on the VMSS VMs. + hibernationEnabled: Enables the hibernation capability on the VMSS VMs. + Default value is null if not specified. This property cannot be updated once set. + """) + additionalVirtualMachineCapabilities?: AdditionalCapabilities; } @doc("Specifications about a VM Size. This will also contain the corresponding rank and weight in future.") @@ -211,6 +228,274 @@ union EvictionPolicy { Deallocate: "Deallocate", } +@added(Versions.v2024_11_01) +@doc("AdditionalCapabilities for VM.") +model AdditionalCapabilities { + #suppress "@azure-tools/typespec-azure-core/casing-style" "ultraSSDEnabled which does not follow camel casing" + @doc(""" + The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. + Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. + """) + ultraSSDEnabled?: boolean; + + @doc("The flag that enables or disables hibernation capability on the VM.") + hibernationEnabled?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "VMAttributeMinMaxInteger which does not follow camel casing" +@added(Versions.v2024_11_01) +@doc("While retrieving VMSizes from CRS, Min = 0 (uint.MinValue) if not specified, Max = 4294967295 (uint.MaxValue) if not specified. This allows to filter VMAttributes on all available VMSizes.") +model VMAttributeMinMaxInteger { + @minValue(0) + @doc("Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified.") + min?: int32; + + @minValue(0) + @doc("Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified.") + max?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "VMAttributeMinMaxDouble which does not follow camel casing" +@added(Versions.v2024_11_01) +@doc("VMAttributes using double values.") +model VMAttributeMinMaxDouble { + @minValue(0.0) + @doc("Minimum value. default 0. Double.MinValue()") + min?: float64; + + @minValue(0.0) + @doc("Maximum value. Double.MaxValue(1.7976931348623157E+308)") + max?: float64; +} + +@added(Versions.v2024_11_01) +@doc("VMSizes supported by Azure VMs. Included is a union of Excluded and Required.") +union VMAttributeSupport { + string, + + @doc("All VMSizes having the feature support will be excluded.") + Excluded: "Excluded", + + @doc(" VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required.") + Included: "Included", + + @doc("Only the VMSizes having the feature support will be used.") + Required: "Required", +} + +@added(Versions.v2024_11_01) +@doc(""" + VMCategories defined for Azure VMs. + See: https://learn.microsoft.com/en-us/azure/virtual-machines/sizes/overview?tabs=breakdownseries%2Cgeneralsizelist%2Ccomputesizelist%2Cmemorysizelist%2Cstoragesizelist%2Cgpusizelist%2Cfpgasizelist%2Chpcsizelist#general-purpose + """) +union VMCategory { + string, + + @doc(""" + General purpose VM sizes provide balanced CPU-to-memory ratio. Ideal for testing and development, small to medium databases, and low to medium traffic web servers. + """) + GeneralPurpose: "GeneralPurpose", + + @doc(""" + Compute optimized VM sizes have a high CPU-to-memory ratio. These sizes are good for medium traffic web servers, network appliances, batch processes, and application servers. + """) + ComputeOptimized: "ComputeOptimized", + + @doc(""" + Memory optimized VM sizes offer a high memory-to-CPU ratio that is great for relational database servers, medium to large caches, and in-memory analytics. + """) + MemoryOptimized: "MemoryOptimized", + + @doc(""" + Storage optimized virtual machine (VM) sizes offer high disk throughput and IO, and are ideal for Big Data, SQL, NoSQL databases, data warehousing, and large transactional databases. + Examples include Cassandra, MongoDB, Cloudera, and Redis. + """) + StorageOptimized: "StorageOptimized", + + @doc(""" + GPU optimized VM sizes are specialized virtual machines available with single, multiple, or fractional GPUs. + These sizes are designed for compute-intensive, graphics-intensive, and visualization workloads. + """) + GpuAccelerated: "GpuAccelerated", + + @doc(""" + FPGA optimized VM sizes are specialized virtual machines available with single or multiple FPGA. + These sizes are designed for compute-intensive workloads. This article provides information about the number and type of FPGA, vCPUs, data disks, and NICs. + Storage throughput and network bandwidth are also included for each size in this grouping. + """) + FpgaAccelerated: "FpgaAccelerated", + + @doc(""" + Azure High Performance Compute VMs are optimized for various HPC workloads such as computational fluid dynamics, finite element analysis, frontend and backend EDA, + rendering, molecular dynamics, computational geo science, weather simulation, and financial risk analysis. + """) + HighPerformanceCompute: "HighPerformanceCompute", +} + +@added(Versions.v2024_11_01) +@doc("Cpu Manufacturers supported by Azure VMs.") +union CpuManufacturer { + string, + + @doc("Intel CPU.") + Intel: "Intel", + + @doc("AMD CPU.") + AMD: "AMD", + + @doc("Microsoft CPU.") + Microsoft: "Microsoft", + + @doc("Ampere CPU.") + Ampere: "Ampere", +} + +@added(Versions.v2024_11_01) +@doc("Different kind of Local storage disk types supported by Azure VMs.") +union LocalStorageDiskType { + string, + + @doc("HDD DiskType.") + HDD: "HDD", + + @doc("SDD DiskType.") + SSD: "SSD", +} + +@added(Versions.v2024_11_01) +@doc("Architecture types supported by Azure VMs.") +union ArchitectureType { + string, + + @doc("ARM64 Architecture") + ARM64: "ARM64", + + @doc("X86 Architecture") + X86: "X86", +} + +@added(Versions.v2024_11_01) +@doc("Accelerator manufacturers supported by Azure VMs.") +union AcceleratorManufacturer { + string, + + @doc("AMD GpuType") + AMD: "AMD", + + @doc("Nvidia GpuType") + Nvidia: "Nvidia", + + @doc("Xilinx GpuType") + Xilinx: "Xilinx", +} + +@added(Versions.v2024_11_01) +@doc("Accelerator types supported by Azure VMs.") +union AcceleratorType { + string, + + @doc("GPU Accelerator") + GPU: "GPU", + + @doc("FPGA Accelerator") + FPGA: "FPGA", +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "VMAttributes which does not follow camel casing" +@added(Versions.v2024_11_01) +@doc("VMAttributes that will be used to filter VMSizes which will be used to build Fleet.") +model VMAttributes { + @doc("The range of vCpuCount specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified.") + vCpuCount: VMAttributeMinMaxInteger; + + @doc("The range of memory specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified.") + memoryInGiB: VMAttributeMinMaxDouble; + + @doc("Specifies whether the VMSize supporting local storage should be used to build Fleet or not.") + localStorageSupport?: VMAttributeSupport; + + @doc("The range of local storage in GB specified from Min to Max.") + localStorageInGiB?: VMAttributeMinMaxDouble; + + @extension("x-ms-identifiers", []) + @doc(""" + The local storage disk types specified as a list. LocalStorageSupport should be set to "Included" or "Required" to use this VMAttribute. + If localStorageSupport is "Excluded", this VMAttribute can not be used. + """) + localStorageDiskTypes?: Array<LocalStorageDiskType>; + + @doc("The range of data disk count specified from Min to Max. Optional parameter. Either Min or Max is required if specified.") + dataDiskCount?: VMAttributeMinMaxInteger; + + @doc("The range of network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified.") + networkInterfaceCount?: VMAttributeMinMaxInteger; + + @doc("The range of network bandwidth in Mbps specified from Min to Max. Optional parameter. Either Min or Max is required if specified.") + networkBandwidthInMbps?: VMAttributeMinMaxDouble; + + @doc("Specifies whether the VMSize supporting RDMA (Remote Direct Memory Access) should be used to build Fleet or not.") + rdmaSupport?: VMAttributeSupport; + + @doc("The range of RDMA (Remote Direct Memory Access) network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified.") + rdmaNetworkInterfaceCount?: VMAttributeMinMaxInteger; + + @doc("Specifies whether the VMSize supporting accelerator should be used to build Fleet or not.") + acceleratorSupport?: VMAttributeSupport; + + @extension("x-ms-identifiers", []) + @doc("The accelerator manufacturers specified as a list. acceleratorSupport should be set to Included or Required to use this VMAttribute.") + acceleratorManufacturers?: Array<AcceleratorManufacturer>; + + @extension("x-ms-identifiers", []) + @doc("The accelerator types specified as a list. acceleratorSupport should be set to Included or Required to use this VMAttribute.") + acceleratorTypes?: Array<AcceleratorType>; + + @doc("The range of accelerator count specified from min to max.. Optional parameter. Either Min or Max is required if specified.") + acceleratorCount?: VMAttributeMinMaxInteger; + + @extension("x-ms-identifiers", []) + @doc("The VM category specified as a list. Optional parameter.") + vmCategories?: Array<VMCategory>; + + @extension("x-ms-identifiers", []) + @doc("The VM architecture types specified as a list. Optional parameter.") + architectureTypes?: Array<ArchitectureType>; + + @extension("x-ms-identifiers", []) + @doc("The VM CPU manufacturers specified as a list. Optional parameter.") + cpuManufacturers?: Array<CpuManufacturer>; + + @doc("Specifies whether the VMSize supporting burstable capability should be used to build Fleet or not.") + burstableSupport?: VMAttributeSupport; + + @extension("x-ms-identifiers", []) + @doc("Specifies which VMSizes should be excluded while building Fleet. Optional parameter.") + excludedVMSizes?: Array<string>; +} + +@added(Versions.v2024_11_01) +@doc("Represents the profile for a single additional location in the Fleet. The location and the virtualMachineProfileOverride (optional).") +model LocationProfile { + @doc(""" + The ARM location name of the additional region. + """) + location?: string; + + @doc(""" + An override for computeProfile.baseVirtualMachineProfile specific to this region. + This override is merged with the base virtual machine profile to define the final virtual machine profile for the resources deployed in this location. + """) + virtualMachineProfileOverride?: BaseVirtualMachineProfile; +} + +@added(Versions.v2024_11_01) +@doc("Represents the configuration for additional locations where Fleet resources may be deployed.") +model AdditionalLocationsProfile { + @extension("x-ms-identifiers", []) + @doc("The list of location profiles.") + locationProfiles: Array<LocationProfile>; +} + @armResourceOperations interface Fleets { get is ArmResourceRead<Fleet>; diff --git a/specification/azurefleet/AzureFleet.Management/main.tsp b/specification/azurefleet/AzureFleet.Management/main.tsp index a29951f7985a..a27c615626af 100644 --- a/specification/azurefleet/AzureFleet.Management/main.tsp +++ b/specification/azurefleet/AzureFleet.Management/main.tsp @@ -33,6 +33,12 @@ enum Versions { @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) @doc("Public Preview Api version") v2024_05_01_preview: "2024-05-01-preview", + + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) + @doc("Public Api version") + v2024_11_01: "2024-11-01", } interface Operations extends Azure.ResourceManager.Operations {} diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_CreateOrUpdate_MaximumSet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_CreateOrUpdate_MaximumSet.json index afa94a22086e..765892be1275 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_CreateOrUpdate_MaximumSet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_CreateOrUpdate_MaximumSet.json @@ -765,7 +765,8 @@ }, "201": { "headers": { - "Azure-AsyncOperation": "https://contoso.com/operationstatus" + "Azure-AsyncOperation": "https://contoso.com/operationstatus", + "Retry-After": 30 }, "body": { "properties": { diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_CreateOrUpdate_MinimumSet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_CreateOrUpdate_MinimumSet.json index 1adda99d41ae..0c7cbc16f8e8 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_CreateOrUpdate_MinimumSet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_CreateOrUpdate_MinimumSet.json @@ -19,7 +19,8 @@ }, "201": { "headers": { - "Azure-AsyncOperation": "https://contoso.com/operationstatus" + "Azure-AsyncOperation": "https://contoso.com/operationstatus", + "Retry-After": 30 }, "body": { "location": "westus", diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Update_MaximumSet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Update_MaximumSet.json index 1ec2663494ac..7abc1f77347b 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Update_MaximumSet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Update_MaximumSet.json @@ -752,7 +752,8 @@ }, "202": { "headers": { - "location": "https://contoso.com/operationstatus" + "location": "https://contoso.com/operationstatus", + "Retry-After": 30 } } } diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Update_MinimumSet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Update_MinimumSet.json index ae9018cbee4f..b8629a85cf15 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Update_MinimumSet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Update_MinimumSet.json @@ -16,7 +16,8 @@ }, "202": { "headers": { - "location": "https://contoso.com/operationstatus" + "location": "https://contoso.com/operationstatus", + "Retry-After": 30 } } } diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_CreateOrUpdate.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_CreateOrUpdate.json index f8a4fab670f2..45338e3137a5 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_CreateOrUpdate.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_CreateOrUpdate.json @@ -383,7 +383,7 @@ "200": { "body": { "properties": { - "provisioningState": "Creating", + "provisioningState": "Succeeded", "spotPriorityProfile": { "capacity": 10, "minCapacity": 20, diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_CreateOrUpdate_MinimumSet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_CreateOrUpdate_MinimumSet.json index 8d9bd1338335..74ee56feafa8 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_CreateOrUpdate_MinimumSet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_CreateOrUpdate_MinimumSet.json @@ -101,7 +101,7 @@ "200": { "body": { "properties": { - "provisioningState": "Creating", + "provisioningState": "Succeeded", "spotPriorityProfile": { "capacity": 2, "minCapacity": 1, diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_Update.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_Update.json index 41186c2130fa..0abdb2cf6780 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_Update.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_Update.json @@ -759,7 +759,8 @@ }, "202": { "headers": { - "location": "https://contoso.com/operationstatus" + "location": "https://contoso.com/operationstatus", + "Retry-After": 30 } } } diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/azurefleet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/azurefleet.json new file mode 100644 index 000000000000..3042422c58d8 --- /dev/null +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/azurefleet.json @@ -0,0 +1,3581 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AzureFleet", + "version": "2024-11-01", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "Fleets" + } + ], + "paths": { + "/providers/Microsoft.AzureFleet/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureFleet/fleets": { + "get": { + "operationId": "Fleets_ListBySubscription", + "tags": [ + "Fleets" + ], + "description": "List Fleet resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FleetListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Fleets_ListBySubscription": { + "$ref": "./examples/Fleets_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureFleet/fleets": { + "get": { + "operationId": "Fleets_ListByResourceGroup", + "tags": [ + "Fleets" + ], + "description": "List Fleet resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FleetListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Fleets_ListByResourceGroup": { + "$ref": "./examples/Fleets_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureFleet/fleets/{fleetName}": { + "get": { + "operationId": "Fleets_Get", + "tags": [ + "Fleets" + ], + "description": "Get a Fleet", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "fleetName", + "in": "path", + "description": "The name of the Compute Fleet", + "required": true, + "type": "string", + "pattern": "^[^_\\W][\\w\\-._]{0,79}(?<![-.])$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Fleet" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Fleets_Get": { + "$ref": "./examples/Fleets_Get.json" + } + } + }, + "put": { + "operationId": "Fleets_CreateOrUpdate", + "tags": [ + "Fleets" + ], + "description": "Create a Fleet", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "fleetName", + "in": "path", + "description": "The name of the Compute Fleet", + "required": true, + "type": "string", + "pattern": "^[^_\\W][\\w\\-._]{0,79}(?<![-.])$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Fleet" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Fleet' update operation succeeded", + "schema": { + "$ref": "#/definitions/Fleet" + } + }, + "201": { + "description": "Resource 'Fleet' create operation succeeded", + "schema": { + "$ref": "#/definitions/Fleet" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Fleets_CreateOrUpdate": { + "$ref": "./examples/Fleets_CreateOrUpdate.json" + }, + "Fleets_CreateOrUpdate_MinimumSet": { + "$ref": "./examples/Fleets_CreateOrUpdate_MinimumSet.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Fleets_Update", + "tags": [ + "Fleets" + ], + "description": "Update a Fleet", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "fleetName", + "in": "path", + "description": "The name of the Compute Fleet", + "required": true, + "type": "string", + "pattern": "^[^_\\W][\\w\\-._]{0,79}(?<![-.])$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/FleetUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Fleet" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Fleets_Update": { + "$ref": "./examples/Fleets_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Fleets_Delete", + "tags": [ + "Fleets" + ], + "description": "Delete a Fleet", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "fleetName", + "in": "path", + "description": "The name of the Compute Fleet", + "required": true, + "type": "string", + "pattern": "^[^_\\W][\\w\\-._]{0,79}(?<![-.])$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Fleets_Delete": { + "$ref": "./examples/Fleets_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureFleet/fleets/{name}/virtualMachineScaleSets": { + "get": { + "operationId": "Fleets_ListVirtualMachineScaleSets", + "tags": [ + "Fleets" + ], + "description": "List VirtualMachineScaleSet resources by Fleet", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the Fleet", + "required": true, + "type": "string", + "pattern": "^[^_\\W][\\w\\-._]{0,79}(?<![-.])$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Fleets_ListVirtualMachineScaleSets": { + "$ref": "./examples/Fleets_ListVirtualMachineScaleSets.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AcceleratorManufacturer": { + "type": "string", + "description": "Accelerator manufacturers supported by Azure VMs.", + "enum": [ + "AMD", + "Nvidia", + "Xilinx" + ], + "x-ms-enum": { + "name": "AcceleratorManufacturer", + "modelAsString": true, + "values": [ + { + "name": "AMD", + "value": "AMD", + "description": "AMD GpuType" + }, + { + "name": "Nvidia", + "value": "Nvidia", + "description": "Nvidia GpuType" + }, + { + "name": "Xilinx", + "value": "Xilinx", + "description": "Xilinx GpuType" + } + ] + } + }, + "AcceleratorType": { + "type": "string", + "description": "Accelerator types supported by Azure VMs.", + "enum": [ + "GPU", + "FPGA" + ], + "x-ms-enum": { + "name": "AcceleratorType", + "modelAsString": true, + "values": [ + { + "name": "GPU", + "value": "GPU", + "description": "GPU Accelerator" + }, + { + "name": "FPGA", + "value": "FPGA", + "description": "FPGA Accelerator" + } + ] + } + }, + "AdditionalCapabilities": { + "type": "object", + "description": "AdditionalCapabilities for VM.", + "properties": { + "ultraSSDEnabled": { + "type": "boolean", + "description": "The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS.\nManaged disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled." + }, + "hibernationEnabled": { + "type": "boolean", + "description": "The flag that enables or disables hibernation capability on the VM." + } + } + }, + "AdditionalLocationsProfile": { + "type": "object", + "description": "Represents the configuration for additional locations where Fleet resources may be deployed.", + "properties": { + "locationProfiles": { + "type": "array", + "description": "The list of location profiles.", + "items": { + "$ref": "#/definitions/LocationProfile" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "locationProfiles" + ] + }, + "AdditionalUnattendContent": { + "type": "object", + "description": "Specifies additional XML formatted information that can be included in the\nUnattend.xml file, which is used by Windows Setup. Contents are defined by\nsetting name, component name, and the pass in which the content is applied.", + "properties": { + "passName": { + "type": "string", + "description": "The pass name. Currently, the only allowable value is OobeSystem.", + "enum": [ + "OobeSystem" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "componentName": { + "type": "string", + "description": "The component name. Currently, the only allowable value is\nMicrosoft-Windows-Shell-Setup.", + "enum": [ + "Microsoft-Windows-Shell-Setup" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "settingName": { + "$ref": "#/definitions/SettingNames", + "description": "Specifies the name of the setting to which the content applies. Possible values\nare: FirstLogonCommands and AutoLogon." + }, + "content": { + "type": "string", + "format": "password", + "description": "Specifies the XML formatted content that is added to the unattend.xml file for\nthe specified path and component. The XML must be less than 4KB and must\ninclude the root element for the setting or feature that is being inserted.", + "x-ms-mutability": [ + "update", + "create" + ], + "x-ms-secret": true + } + } + }, + "ApiEntityReference": { + "type": "object", + "description": "The API entity reference.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM resource id in the form of\n/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." + } + } + }, + "ApiError": { + "type": "object", + "description": "ApiError for Fleet", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + }, + "details": { + "type": "array", + "description": "The API error details", + "items": { + "$ref": "#/definitions/ApiErrorBase" + }, + "x-ms-identifiers": [ + "message", + "target" + ] + }, + "innererror": { + "$ref": "#/definitions/InnerError", + "description": "The API inner error" + } + } + }, + "ApiErrorBase": { + "type": "object", + "description": "API error base.", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + } + }, + "ApplicationProfile": { + "type": "object", + "description": "Contains the list of gallery applications that should be made available to the\nVM/VMSS", + "properties": { + "galleryApplications": { + "type": "array", + "description": "Specifies the gallery applications that should be made available to the VM/VMSS", + "items": { + "$ref": "#/definitions/VMGalleryApplication" + }, + "x-ms-identifiers": [ + "packageReferenceId" + ] + } + } + }, + "ArchitectureType": { + "type": "string", + "description": "Architecture types supported by Azure VMs.", + "enum": [ + "ARM64", + "X86" + ], + "x-ms-enum": { + "name": "ArchitectureType", + "modelAsString": true, + "values": [ + { + "name": "ARM64", + "value": "ARM64", + "description": "ARM64 Architecture" + }, + { + "name": "X86", + "value": "X86", + "description": "X86 Architecture" + } + ] + } + }, + "BasePriorityProfile": { + "type": "object", + "description": "Contains common properties that are applicable to both Spot and Regular.", + "properties": { + "capacity": { + "type": "integer", + "format": "int32", + "description": "Total capacity to achieve. It is currently in terms of number of VMs.", + "minimum": 0 + }, + "minCapacity": { + "type": "integer", + "format": "int32", + "description": "Minimum capacity to achieve which cannot be updated. If we will not be able to \"guarantee\" minimum capacity, we will reject the request in the sync path itself.", + "minimum": 0 + } + } + }, + "BaseVirtualMachineProfile": { + "type": "object", + "description": "Describes the base virtual machine profile for fleet", + "properties": { + "osProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetOSProfile", + "description": "Specifies the operating system settings for the virtual machines in the scale\nset." + }, + "storageProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "networkProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile", + "description": "Specifies properties of the network interfaces of the virtual machines in the\nscale set." + }, + "securityProfile": { + "$ref": "#/definitions/SecurityProfile", + "description": "Specifies the Security related profile settings for the virtual machines in the\nscale set." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state." + }, + "extensionProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile", + "description": "Specifies a collection of settings for extensions installed on virtual machines\nin the scale set." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises.\n<br><br> Possible values for Windows Server operating system are: <br><br>\nWindows_Client <br><br> Windows_Server <br><br> Possible values for Linux\nServer operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS\n(for SUSE) <br><br> For more information, see [Azure Hybrid Use Benefit for\nWindows\nServer](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)\n<br><br> [Azure Hybrid Use Benefit for Linux\nServer](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)\n<br><br> Minimum api-version: 2015-06-15" + }, + "scheduledEventsProfile": { + "$ref": "#/definitions/ScheduledEventsProfile", + "description": "Specifies Scheduled Event related configurations." + }, + "userData": { + "type": "string", + "description": "UserData for the virtual machines in the scale set, which must be base-64\nencoded. Customer should not pass any secrets in here. Minimum api-version:\n2021-03-01." + }, + "capacityReservation": { + "$ref": "#/definitions/CapacityReservationProfile", + "description": "Specifies the capacity reservation related details of a scale set. Minimum\napi-version: 2021-04-01." + }, + "applicationProfile": { + "$ref": "#/definitions/ApplicationProfile", + "description": "Specifies the gallery applications that should be made available to the VM/VMSS" + }, + "hardwareProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetHardwareProfile", + "description": "Specifies the hardware profile related details of a scale set. Minimum\napi-version: 2021-11-01." + }, + "serviceArtifactReference": { + "$ref": "#/definitions/ServiceArtifactReference", + "description": "Specifies the service artifact reference id used to set same image version for\nall virtual machines in the scale set when using 'latest' image version.\nMinimum api-version: 2022-11-01" + }, + "securityPostureReference": { + "$ref": "#/definitions/SecurityPostureReference", + "description": "Specifies the security posture to be used for all virtual machines in the scale\nset. Minimum api-version: 2023-03-01" + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "Specifies the time in which this VM profile for the Virtual Machine Scale Set\nwas created. Minimum API version for this property is 2023-09-01. This value\nwill be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile\nwith minimum api-version 2023-09-01. Examples: \"2024-07-01T00:00:01.1234567+00:00\"", + "readOnly": true + } + } + }, + "BootDiagnostics": { + "type": "object", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output\nand Screenshot to diagnose VM status. You can easily view the output of your\nconsole log. Azure also enables you to see a screenshot of the VM from the\nhypervisor.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + }, + "storageUri": { + "type": "string", + "format": "uri", + "description": "Uri of the storage account to use for placing the console output and\nscreenshot. If storageUri is not specified while enabling boot diagnostics,\nmanaged storage will be used." + } + } + }, + "CachingTypes": { + "type": "string", + "description": "Specifies the caching requirements.", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "CachingTypes", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "'None' is default for Standard Storage" + }, + { + "name": "ReadOnly", + "value": "ReadOnly", + "description": "'ReadOnly' is default for Premium Storage" + }, + { + "name": "ReadWrite", + "value": "ReadWrite", + "description": "'ReadWrite' is default for OS Disk" + } + ] + } + }, + "CapacityReservationProfile": { + "type": "object", + "description": "The parameters of a capacity reservation Profile.", + "properties": { + "capacityReservationGroup": { + "$ref": "#/definitions/SubResource", + "description": "Specifies the capacity reservation group resource id that should be used for\nallocating the virtual machine or scaleset vm instances provided enough\ncapacity has been reserved. Please refer to https://aka.ms/CapacityReservation\nfor more details." + } + } + }, + "ComputeProfile": { + "type": "object", + "description": "Compute Profile to use for running user's workloads.", + "properties": { + "baseVirtualMachineProfile": { + "$ref": "#/definitions/BaseVirtualMachineProfile", + "description": "Base Virtual Machine Profile Properties to be specified according to \"specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachineScaleSet.json#/definitions/VirtualMachineScaleSetVMProfile\"" + }, + "computeApiVersion": { + "type": "string", + "description": "Specifies the Microsoft.Compute API version to use when creating underlying Virtual Machine scale sets and Virtual Machines.\nThe default value will be the latest supported computeApiVersion by Compute Fleet." + }, + "platformFaultDomainCount": { + "type": "integer", + "format": "int32", + "description": "Specifies the number of fault domains to use when creating the underlying VMSS.\nA fault domain is a logical group of hardware within an Azure datacenter.\nVMs in the same fault domain share a common power source and network switch.\nIf not specified, defaults to 1, which represents \"Max Spreading\" (using as many fault domains as possible).\nThis property cannot be updated." + }, + "additionalVirtualMachineCapabilities": { + "$ref": "#/definitions/AdditionalCapabilities", + "description": "Specifies VMSS and VM API entity models support two additional capabilities as of today: ultraSSDEnabled and hibernationEnabled.\nultraSSDEnabled: Enables UltraSSD_LRS storage account type on the VMSS VMs.\nhibernationEnabled: Enables the hibernation capability on the VMSS VMs.\nDefault value is null if not specified. This property cannot be updated once set." + } + }, + "required": [ + "baseVirtualMachineProfile" + ] + }, + "CpuManufacturer": { + "type": "string", + "description": "Cpu Manufacturers supported by Azure VMs.", + "enum": [ + "Intel", + "AMD", + "Microsoft", + "Ampere" + ], + "x-ms-enum": { + "name": "CpuManufacturer", + "modelAsString": true, + "values": [ + { + "name": "Intel", + "value": "Intel", + "description": "Intel CPU." + }, + { + "name": "AMD", + "value": "AMD", + "description": "AMD CPU." + }, + { + "name": "Microsoft", + "value": "Microsoft", + "description": "Microsoft CPU." + }, + { + "name": "Ampere", + "value": "Ampere", + "description": "Ampere CPU." + } + ] + } + }, + "DeleteOptions": { + "type": "string", + "description": "Specify what happens to the network interface when the VM is deleted", + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "DeleteOptions", + "modelAsString": true, + "values": [ + { + "name": "Delete", + "value": "Delete", + "description": "Delete Option" + }, + { + "name": "Detach", + "value": "Detach", + "description": "Detach Option" + } + ] + } + }, + "DiagnosticsProfile": { + "type": "object", + "description": "Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.", + "properties": { + "bootDiagnostics": { + "$ref": "#/definitions/BootDiagnostics", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output\nand Screenshot to diagnose VM status. **NOTE**: If storageUri is being\nspecified then ensure that the storage account is in the same region and\nsubscription as the VM. You can easily view the output of your console log.\nAzure also enables you to see a screenshot of the VM from the hypervisor." + } + } + }, + "DiffDiskOptions": { + "type": "string", + "description": "Specifies the ephemeral disk option for operating system disk.", + "enum": [ + "Local" + ], + "x-ms-enum": { + "name": "DiffDiskOptions", + "modelAsString": true, + "values": [ + { + "name": "Local", + "value": "Local", + "description": "Local Option." + } + ] + } + }, + "DiffDiskPlacement": { + "type": "string", + "description": "Specifies the ephemeral disk placement for operating system disk. This property\ncan be used by user in the request to choose the location i.e, cache disk or\nresource disk space for Ephemeral OS disk provisioning. For more information on\nEphemeral OS disk size requirements, please refer Ephemeral OS disk size\nrequirements for Windows VM at\nhttps://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements\nand Linux VM at\nhttps://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements\nMinimum api-version for NvmeDisk: 2024-03-01.", + "enum": [ + "CacheDisk", + "ResourceDisk", + "NvmeDisk" + ], + "x-ms-enum": { + "name": "DiffDiskPlacement", + "modelAsString": true, + "values": [ + { + "name": "CacheDisk", + "value": "CacheDisk", + "description": "CacheDisk option." + }, + { + "name": "ResourceDisk", + "value": "ResourceDisk", + "description": "Resource Disk option." + }, + { + "name": "NvmeDisk", + "value": "NvmeDisk", + "description": "NvmeDisk option." + } + ] + } + }, + "DiffDiskSettings": { + "type": "object", + "description": "Describes the parameters of ephemeral disk settings that can be specified for\noperating system disk. **Note:** The ephemeral disk settings can only be\nspecified for managed disk.", + "properties": { + "option": { + "$ref": "#/definitions/DiffDiskOptions", + "description": "Specifies the ephemeral disk settings for operating system disk." + }, + "placement": { + "$ref": "#/definitions/DiffDiskPlacement", + "description": "Specifies the ephemeral disk placement for operating system disk. Possible\nvalues are: **CacheDisk,** **ResourceDisk.** The defaulting behavior is:\n**CacheDisk** if one is configured for the VM size otherwise **ResourceDisk**\nis used. Refer to the VM size documentation for Windows VM at\nhttps://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at\nhttps://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM\nsizes exposes a cache disk." + } + } + }, + "DiskControllerTypes": { + "type": "string", + "description": "Specifies the disk controller type configured for the VM and\nVirtualMachineScaleSet. This property is only supported for virtual machines\nwhose operating system disk and VM sku supports Generation 2\n(https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), please\ncheck the HyperVGenerations capability returned as part of VM sku capabilities\nin the response of Microsoft.Compute SKUs api for the region contains V2\n(https://docs.microsoft.com/rest/api/compute/resourceskus/list). For more\ninformation about Disk Controller Types supported please refer to\nhttps://aka.ms/azure-diskcontrollertypes.", + "enum": [ + "SCSI", + "NVMe" + ], + "x-ms-enum": { + "name": "DiskControllerTypes", + "modelAsString": true, + "values": [ + { + "name": "SCSI", + "value": "SCSI", + "description": "SCSI disk type" + }, + { + "name": "NVMe", + "value": "NVMe", + "description": "NVMe disk type" + } + ] + } + }, + "DiskCreateOptionTypes": { + "type": "string", + "description": "Specifies how the virtual machine should be created.", + "enum": [ + "FromImage", + "Empty", + "Attach", + "Copy", + "Restore" + ], + "x-ms-enum": { + "name": "DiskCreateOptionTypes", + "modelAsString": true, + "values": [ + { + "name": "FromImage", + "value": "FromImage", + "description": "This value is used when you are using an image to create the virtual machine.\nIf you are using a platform image, you also use the imageReference element\ndescribed above. If you are using a marketplace image, you also use the\nplan element previously described." + }, + { + "name": "Empty", + "value": "Empty", + "description": "This value is used when creating an empty data disk." + }, + { + "name": "Attach", + "value": "Attach", + "description": "This value is used when you are using a specialized disk to create the virtual machine." + }, + { + "name": "Copy", + "value": "Copy", + "description": "This value is used to create a data disk from a snapshot or another disk." + }, + { + "name": "Restore", + "value": "Restore", + "description": "This value is used to create a data disk from a disk restore point." + } + ] + } + }, + "DiskDeleteOptionTypes": { + "type": "string", + "description": "Specifies the behavior of the managed disk when the VM gets deleted, for\nexample whether the managed disk is deleted or detached. Supported values are:\n**Delete.** If this value is used, the managed disk is deleted when VM gets\ndeleted. **Detach.** If this value is used, the managed disk is retained after\nVM gets deleted. Minimum api-version: 2021-03-01.", + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "DiskDeleteOptionTypes", + "modelAsString": true, + "values": [ + { + "name": "Delete", + "value": "Delete", + "description": "If this value is used, the managed disk is deleted when VM gets deleted." + }, + { + "name": "Detach", + "value": "Detach", + "description": "If this value is used, the managed disk is retained after VM gets deleted." + } + ] + } + }, + "DiskEncryptionSetParameters": { + "type": "object", + "description": "Describes the parameter of customer managed disk encryption set resource id\nthat can be specified for disk. **Note:** The disk encryption set resource id\ncan only be specified for managed disk. Please refer\nhttps://aka.ms/mdssewithcmkoverview for more details.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "Resource Id" + } + } + }, + "DomainNameLabelScopeTypes": { + "type": "string", + "description": "The Domain name label scope.The concatenation of the hashed domain name label\nthat generated according to the policy from domain name label scope and vm\nindex will be the domain name labels of the PublicIPAddress resources that will\nbe created", + "enum": [ + "TenantReuse", + "SubscriptionReuse", + "ResourceGroupReuse", + "NoReuse" + ], + "x-ms-enum": { + "name": "DomainNameLabelScopeTypes", + "modelAsString": true, + "values": [ + { + "name": "TenantReuse", + "value": "TenantReuse", + "description": "TenantReuse type" + }, + { + "name": "SubscriptionReuse", + "value": "SubscriptionReuse", + "description": "SubscriptionReuse type" + }, + { + "name": "ResourceGroupReuse", + "value": "ResourceGroupReuse", + "description": "ResourceGroupReuse type" + }, + { + "name": "NoReuse", + "value": "NoReuse", + "description": "NoReuse type" + } + ] + } + }, + "EncryptionIdentity": { + "type": "object", + "description": "Specifies the Managed Identity used by ADE to get access token for keyvault\noperations.", + "properties": { + "userAssignedIdentityResourceId": { + "type": "string", + "format": "arm-id", + "description": "Specifies ARM Resource ID of one of the user identities associated with the VM." + } + } + }, + "EvictionPolicy": { + "type": "string", + "description": "Different kind of eviction policies", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "EvictionPolicy", + "modelAsString": true, + "values": [ + { + "name": "Delete", + "value": "Delete", + "description": "When evicted, the Spot VM will be deleted and the corresponding capacity will be updated to reflect this." + }, + { + "name": "Deallocate", + "value": "Deallocate", + "description": "When evicted, the Spot VM will be deallocated/stopped" + } + ] + } + }, + "Fleet": { + "type": "object", + "description": "An Compute Fleet resource", + "properties": { + "properties": { + "$ref": "#/definitions/FleetProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "zones": { + "type": "array", + "description": "Zones in which the Compute Fleet is available", + "items": { + "type": "string" + } + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + }, + "plan": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Plan", + "description": "Details of the resource plan." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "FleetListResult": { + "type": "object", + "description": "The response of a Fleet list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Fleet items on this page", + "items": { + "$ref": "#/definitions/Fleet" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "FleetProperties": { + "type": "object", + "description": "Details of the Compute Fleet.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + }, + "spotPriorityProfile": { + "$ref": "#/definitions/SpotPriorityProfile", + "description": "Configuration Options for Spot instances in Compute Fleet." + }, + "regularPriorityProfile": { + "$ref": "#/definitions/RegularPriorityProfile", + "description": "Configuration Options for Regular instances in Compute Fleet." + }, + "vmSizesProfile": { + "type": "array", + "description": "List of VM sizes supported for Compute Fleet", + "items": { + "$ref": "#/definitions/VmSizeProfile" + }, + "x-ms-identifiers": [] + }, + "vmAttributes": { + "$ref": "#/definitions/VMAttributes", + "description": "Attribute based Fleet." + }, + "additionalLocationsProfile": { + "$ref": "#/definitions/AdditionalLocationsProfile", + "description": "Represents the configuration for additional locations where Fleet resources may be deployed." + }, + "computeProfile": { + "$ref": "#/definitions/ComputeProfile", + "description": "Compute Profile to use for running user's workloads." + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "Specifies the time at which the Compute Fleet is created.", + "readOnly": true + }, + "uniqueId": { + "type": "string", + "description": "Specifies the ID which uniquely identifies a Compute Fleet.", + "readOnly": true + } + }, + "required": [ + "vmSizesProfile", + "computeProfile" + ] + }, + "FleetUpdate": { + "type": "object", + "description": "Fleet Update Model", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "identity": { + "$ref": "#/definitions/ManagedServiceIdentityUpdate", + "description": "Updatable managed service identity" + }, + "plan": { + "$ref": "#/definitions/ResourcePlanUpdate", + "description": "Updatable resource plan" + }, + "properties": { + "$ref": "#/definitions/FleetProperties", + "description": "RP-specific updatable properties" + } + } + }, + "IPVersion": { + "type": "string", + "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the\nspecific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible\nvalues are: 'IPv4' and 'IPv6'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true, + "values": [ + { + "name": "IPv4", + "value": "IPv4", + "description": "IPv4 version" + }, + { + "name": "IPv6", + "value": "IPv6", + "description": "IPv6 version" + } + ] + } + }, + "ImageReference": { + "type": "object", + "description": "Specifies information about the image to use. You can specify information about\nplatform images, marketplace images, or virtual machine images. This element is\nrequired when you want to use a platform image, marketplace image, or virtual\nmachine image, but is not used in other creation operations. NOTE: Image\nreference publisher and offer can only be set when you create the scale set.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "Resource Id" + }, + "publisher": { + "type": "string", + "description": "The image publisher." + }, + "offer": { + "type": "string", + "description": "Specifies the offer of the platform image or marketplace image used to create\nthe virtual machine." + }, + "sku": { + "type": "string", + "description": "The image SKU." + }, + "version": { + "type": "string", + "description": "Specifies the version of the platform image or marketplace image used to create\nthe virtual machine. The allowed formats are Major.Minor.Build or 'latest'.\nMajor, Minor, and Build are decimal numbers. Specify 'latest' to use the latest\nversion of an image available at deploy time. Even if you use 'latest', the VM\nimage will not automatically update after deploy time even if a new version\nbecomes available. Please do not use field 'version' for gallery image\ndeployment, gallery image should always use 'id' field for deployment, to use 'latest'\nversion of gallery image, just set\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}'\nin the 'id' field without version input." + }, + "exactVersion": { + "type": "string", + "description": "Specifies in decimal numbers, the version of platform image or marketplace\nimage used to create the virtual machine. This readonly field differs from 'version',\nonly if the value specified in 'version' field is 'latest'.", + "readOnly": true + }, + "sharedGalleryImageId": { + "type": "string", + "description": "Specified the shared gallery image unique id for vm deployment. This can be\nfetched from shared gallery image GET call." + }, + "communityGalleryImageId": { + "type": "string", + "description": "Specified the community gallery image unique id for vm deployment. This can be\nfetched from community gallery image GET call." + } + } + }, + "InnerError": { + "type": "object", + "description": "Inner error details.", + "properties": { + "exceptionType": { + "type": "string", + "description": "The exception type." + }, + "errorDetail": { + "type": "string", + "description": "The internal error message or exception dump." + } + } + }, + "KeyVaultSecretReference": { + "type": "object", + "description": "Describes a reference to Key Vault Secret", + "properties": { + "secretUrl": { + "type": "string", + "format": "uri", + "description": "The URL referencing a secret in a Key Vault." + }, + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing the secret." + } + }, + "required": [ + "secretUrl", + "sourceVault" + ] + }, + "LinuxConfiguration": { + "type": "object", + "description": "Specifies the Linux operating system settings on the virtual machine. For a\nlist of supported Linux distributions, see [Linux on Azure-Endorsed\nDistributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros).", + "properties": { + "disablePasswordAuthentication": { + "type": "boolean", + "description": "Specifies whether password authentication should be disabled." + }, + "ssh": { + "$ref": "#/definitions/SshConfiguration", + "description": "Specifies the ssh key configuration for a Linux OS." + }, + "provisionVMAgent": { + "type": "boolean", + "description": "Indicates whether virtual machine agent should be provisioned on the virtual\nmachine. When this property is not specified in the request body, default\nbehavior is to set it to true. This will ensure that VM Agent is installed on\nthe VM so that extensions can be added to the VM later." + }, + "patchSettings": { + "$ref": "#/definitions/LinuxPatchSettings", + "description": "[Preview Feature] Specifies settings related to VM Guest Patching on Linux." + }, + "enableVMAgentPlatformUpdates": { + "type": "boolean", + "description": "Indicates whether VMAgent Platform Updates is enabled for the Linux virtual\nmachine. Default value is false." + } + } + }, + "LinuxPatchAssessmentMode": { + "type": "string", + "description": "Specifies the mode of VM Guest Patch Assessment for the IaaS virtual\nmachine.<br /><br /> Possible values are:<br /><br /> **ImageDefault** - You\ncontrol the timing of patch assessments on a virtual machine. <br /><br />\n**AutomaticByPlatform** - The platform will trigger periodic patch assessments.\nThe property provisionVMAgent must be true.", + "enum": [ + "ImageDefault", + "AutomaticByPlatform" + ], + "x-ms-enum": { + "name": "LinuxPatchAssessmentMode", + "modelAsString": true, + "values": [ + { + "name": "ImageDefault", + "value": "ImageDefault", + "description": "You control the timing of patch assessments on a virtual machine." + }, + { + "name": "AutomaticByPlatform", + "value": "AutomaticByPlatform", + "description": "The platform will trigger periodic patch assessments.The property provisionVMAgent must be true." + } + ] + } + }, + "LinuxPatchSettings": { + "type": "object", + "description": "Specifies settings related to VM Guest Patching on Linux.", + "properties": { + "patchMode": { + "$ref": "#/definitions/LinuxVMGuestPatchMode", + "description": "Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual\nmachines associated to virtual machine scale set with OrchestrationMode as\nFlexible.<br /><br /> Possible values are:<br /><br /> **ImageDefault** - The\nvirtual machine's default patching configuration is used. <br /><br />\n**AutomaticByPlatform** - The virtual machine will be automatically updated by\nthe platform. The property provisionVMAgent must be true" + }, + "assessmentMode": { + "$ref": "#/definitions/LinuxPatchAssessmentMode", + "description": "Specifies the mode of VM Guest Patch Assessment for the IaaS virtual\nmachine.<br /><br /> Possible values are:<br /><br /> **ImageDefault** - You\ncontrol the timing of patch assessments on a virtual machine. <br /><br />\n**AutomaticByPlatform** - The platform will trigger periodic patch assessments.\nThe property provisionVMAgent must be true." + }, + "automaticByPlatformSettings": { + "$ref": "#/definitions/LinuxVMGuestPatchAutomaticByPlatformSettings", + "description": "Specifies additional settings for patch mode AutomaticByPlatform in VM Guest\nPatching on Linux." + } + } + }, + "LinuxVMGuestPatchAutomaticByPlatformRebootSetting": { + "type": "string", + "description": "Specifies the reboot setting for all AutomaticByPlatform patch installation\noperations.", + "enum": [ + "Unknown", + "IfRequired", + "Never", + "Always" + ], + "x-ms-enum": { + "name": "LinuxVMGuestPatchAutomaticByPlatformRebootSetting", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Reboot setting" + }, + { + "name": "IfRequired", + "value": "IfRequired", + "description": "IfRequired Reboot setting" + }, + { + "name": "Never", + "value": "Never", + "description": "Never Reboot setting" + }, + { + "name": "Always", + "value": "Always", + "description": "Always Reboot setting" + } + ] + } + }, + "LinuxVMGuestPatchAutomaticByPlatformSettings": { + "type": "object", + "description": "Specifies additional settings to be applied when patch mode AutomaticByPlatform\nis selected in Linux patch settings.", + "properties": { + "rebootSetting": { + "$ref": "#/definitions/LinuxVMGuestPatchAutomaticByPlatformRebootSetting", + "description": "Specifies the reboot setting for all AutomaticByPlatform patch installation\noperations." + }, + "bypassPlatformSafetyChecksOnUserSchedule": { + "type": "boolean", + "description": "Enables customer to schedule patching without accidental upgrades" + } + } + }, + "LinuxVMGuestPatchMode": { + "type": "string", + "description": "Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual\nmachines associated to virtual machine scale set with OrchestrationMode as\nFlexible.", + "enum": [ + "ImageDefault", + "AutomaticByPlatform" + ], + "x-ms-enum": { + "name": "LinuxVMGuestPatchMode", + "modelAsString": true, + "values": [ + { + "name": "ImageDefault", + "value": "ImageDefault", + "description": "The virtual machine's default patching configuration is used." + }, + { + "name": "AutomaticByPlatform", + "value": "AutomaticByPlatform", + "description": "The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true." + } + ] + } + }, + "LocalStorageDiskType": { + "type": "string", + "description": "Different kind of Local storage disk types supported by Azure VMs.", + "enum": [ + "HDD", + "SSD" + ], + "x-ms-enum": { + "name": "LocalStorageDiskType", + "modelAsString": true, + "values": [ + { + "name": "HDD", + "value": "HDD", + "description": "HDD DiskType." + }, + { + "name": "SSD", + "value": "SSD", + "description": "SDD DiskType." + } + ] + } + }, + "LocationProfile": { + "type": "object", + "description": "Represents the profile for a single additional location in the Fleet. The location and the virtualMachineProfileOverride (optional).", + "properties": { + "location": { + "type": "string", + "description": "The ARM location name of the additional region." + }, + "virtualMachineProfileOverride": { + "$ref": "#/definitions/BaseVirtualMachineProfile", + "description": "An override for computeProfile.baseVirtualMachineProfile specific to this region. \nThis override is merged with the base virtual machine profile to define the final virtual machine profile for the resources deployed in this location." + } + } + }, + "ManagedServiceIdentityUpdate": { + "type": "object", + "description": "The template for adding optional properties.", + "properties": { + "type": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentityType", + "description": "The type of managed identity assigned to this resource." + }, + "userAssignedIdentities": { + "type": "object", + "description": "The identities assigned to this resource by the user.", + "additionalProperties": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/UserAssignedIdentity" + } + ], + "type": "object", + "x-nullable": true + } + } + } + }, + "Mode": { + "type": "string", + "description": "Specifies the mode that ProxyAgent will execute on if the feature is enabled.\nProxyAgent will start to audit or monitor but not enforce access control over\nrequests to host endpoints in Audit mode, while in Enforce mode it will enforce\naccess control. The default value is Enforce mode.", + "enum": [ + "Audit", + "Enforce" + ], + "x-ms-enum": { + "name": "Mode", + "modelAsString": true, + "values": [ + { + "name": "Audit", + "value": "Audit", + "description": "Audit Mode" + }, + { + "name": "Enforce", + "value": "Enforce", + "description": "Enforce Mode" + } + ] + } + }, + "NetworkApiVersion": { + "type": "string", + "description": "specifies the Microsoft.Network API version used when creating networking\nresources in the Network Interface Configurations for Virtual Machine Scale Set\nwith orchestration mode 'Flexible'", + "enum": [ + "2020-11-01" + ], + "x-ms-enum": { + "name": "NetworkApiVersion", + "modelAsString": true, + "values": [ + { + "name": "v2020_11_01", + "value": "2020-11-01", + "description": "Initial version supported. Later versions are supported as well." + } + ] + } + }, + "NetworkInterfaceAuxiliaryMode": { + "type": "string", + "description": "Specifies whether the Auxiliary mode is enabled for the Network Interface\nresource.", + "enum": [ + "None", + "AcceleratedConnections", + "Floating" + ], + "x-ms-enum": { + "name": "NetworkInterfaceAuxiliaryMode", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "None Mode" + }, + { + "name": "AcceleratedConnections", + "value": "AcceleratedConnections", + "description": "AcceleratedConnections Mode" + }, + { + "name": "Floating", + "value": "Floating", + "description": "Floating Mode" + } + ] + } + }, + "NetworkInterfaceAuxiliarySku": { + "type": "string", + "description": "Specifies whether the Auxiliary sku is enabled for the Network Interface\nresource.", + "enum": [ + "None", + "A1", + "A2", + "A4", + "A8" + ], + "x-ms-enum": { + "name": "NetworkInterfaceAuxiliarySku", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "no sku" + }, + { + "name": "A1", + "value": "A1", + "description": "A1 sku" + }, + { + "name": "A2", + "value": "A2", + "description": "A2 sku" + }, + { + "name": "A4", + "value": "A4", + "description": "A4 sku" + }, + { + "name": "A8", + "value": "A8", + "description": "A8 sku" + } + ] + } + }, + "OSImageNotificationProfile": { + "type": "object", + "description": "Specifies OS Image Scheduled Event related configurations.", + "properties": { + "notBeforeTimeout": { + "type": "string", + "description": "Length of time a Virtual Machine being reimaged or having its OS upgraded will\nhave to potentially approve the OS Image Scheduled Event before the event is\nauto approved (timed out). The configuration is specified in ISO 8601 format,\nand the value must not exceed 15 minutes (PT15M)" + }, + "enable": { + "type": "boolean", + "description": "Specifies whether the OS Image Scheduled event is enabled or disabled." + } + } + }, + "OperatingSystemTypes": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the\ndisk if creating a VM from user-image or a specialized VHD. Possible values\nare: **Windows,** **Linux.**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": true, + "values": [ + { + "name": "Windows", + "value": "Windows", + "description": "Windows OS type" + }, + { + "name": "Linux", + "value": "Linux", + "description": "Linux OS type" + } + ] + } + }, + "PatchSettings": { + "type": "object", + "description": "Specifies settings related to VM Guest Patching on Windows.", + "properties": { + "patchMode": { + "$ref": "#/definitions/WindowsVMGuestPatchMode", + "description": "Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual\nmachines associated to virtual machine scale set with OrchestrationMode as\nFlexible.<br /><br /> Possible values are:<br /><br /> **Manual** - You\ncontrol the application of patches to a virtual machine. You do this by\napplying patches manually inside the VM. In this mode, automatic updates are\ndisabled; the property WindowsConfiguration.enableAutomaticUpdates must be\nfalse<br /><br /> **AutomaticByOS** - The virtual machine will automatically be\nupdated by the OS. The property WindowsConfiguration.enableAutomaticUpdates\nmust be true. <br /><br /> **AutomaticByPlatform** - the virtual machine will\nautomatically updated by the platform. The properties provisionVMAgent and\nWindowsConfiguration.enableAutomaticUpdates must be true" + }, + "enableHotpatching": { + "type": "boolean", + "description": "Enables customers to patch their Azure VMs without requiring a reboot. For\nenableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode'\nmust be set to 'AutomaticByPlatform'." + }, + "assessmentMode": { + "$ref": "#/definitions/WindowsPatchAssessmentMode", + "description": "Specifies the mode of VM Guest patch assessment for the IaaS virtual\nmachine.<br /><br /> Possible values are:<br /><br /> **ImageDefault** - You\ncontrol the timing of patch assessments on a virtual machine.<br /><br />\n**AutomaticByPlatform** - The platform will trigger periodic patch assessments.\nThe property provisionVMAgent must be true." + }, + "automaticByPlatformSettings": { + "$ref": "#/definitions/WindowsVMGuestPatchAutomaticByPlatformSettings", + "description": "Specifies additional settings for patch mode AutomaticByPlatform in VM Guest\nPatching on Windows." + } + } + }, + "ProtocolTypes": { + "type": "string", + "description": "Specifies the protocol of WinRM listener. Possible values are: **http,**\n**https.**", + "enum": [ + "Http", + "Https" + ], + "x-ms-enum": { + "name": "ProtocolTypes", + "modelAsString": true, + "values": [ + { + "name": "Http", + "value": "Http", + "description": "Http protocol" + }, + { + "name": "Https", + "value": "Https", + "description": "Https protocol" + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The status of the current operation.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Updating", + "Deleting", + "Migrating" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Creating", + "value": "Creating", + "description": "Initial creation in progress." + }, + { + "name": "Updating", + "value": "Updating", + "description": "Update in progress." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Deletion in progress." + }, + { + "name": "Migrating", + "value": "Migrating", + "description": "Resource is being migrated from one subscription or resource group to another." + } + ] + }, + "readOnly": true + }, + "ProxyAgentSettings": { + "type": "object", + "description": "Specifies ProxyAgent settings while creating the virtual machine. Minimum\napi-version: 2023-09-01.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Specifies whether ProxyAgent feature should be enabled on the virtual machine\nor virtual machine scale set." + }, + "mode": { + "$ref": "#/definitions/Mode", + "description": "Specifies the mode that ProxyAgent will execute on if the feature is enabled.\nProxyAgent will start to audit or monitor but not enforce access control over\nrequests to host endpoints in Audit mode, while in Enforce mode it will enforce\naccess control. The default value is Enforce mode." + }, + "keyIncarnationId": { + "type": "integer", + "format": "int32", + "description": "Increase the value of this property allows user to reset the key used for\nsecuring communication channel between guest and host." + } + } + }, + "PublicIPAddressSku": { + "type": "object", + "description": "Describes the public IP Sku. It can only be set with OrchestrationMode as\nFlexible.", + "properties": { + "name": { + "$ref": "#/definitions/PublicIPAddressSkuName", + "description": "Specify public IP sku name" + }, + "tier": { + "$ref": "#/definitions/PublicIPAddressSkuTier", + "description": "Specify public IP sku tier" + } + } + }, + "PublicIPAddressSkuName": { + "type": "string", + "description": "Specify public IP sku name.", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "PublicIPAddressSkuName", + "modelAsString": true, + "values": [ + { + "name": "Basic", + "value": "Basic", + "description": "Basic sku name" + }, + { + "name": "Standard", + "value": "Standard", + "description": "Standard sku name" + } + ] + } + }, + "PublicIPAddressSkuTier": { + "type": "string", + "description": "Specify public IP sku tier", + "enum": [ + "Regional", + "Global" + ], + "x-ms-enum": { + "name": "PublicIPAddressSkuTier", + "modelAsString": true, + "values": [ + { + "name": "Regional", + "value": "Regional", + "description": "Regional sku tier" + }, + { + "name": "Global", + "value": "Global", + "description": "Global sku tier" + } + ] + } + }, + "RegularPriorityAllocationStrategy": { + "type": "string", + "description": "Regular VM Allocation strategy types for Compute Fleet", + "enum": [ + "LowestPrice", + "Prioritized" + ], + "x-ms-enum": { + "name": "RegularPriorityAllocationStrategy", + "modelAsString": true, + "values": [ + { + "name": "LowestPrice", + "value": "LowestPrice", + "description": "Default. VM sizes distribution will be determined to optimize for price." + }, + { + "name": "Prioritized", + "value": "Prioritized", + "description": "VM sizes distribution will be determined to optimize for the 'priority' as specified for each vm size." + } + ] + } + }, + "RegularPriorityProfile": { + "type": "object", + "description": "Configuration Options for Regular instances in Compute Fleet.", + "properties": { + "capacity": { + "type": "integer", + "format": "int32", + "description": "Total capacity to achieve. It is currently in terms of number of VMs.", + "minimum": 0 + }, + "minCapacity": { + "type": "integer", + "format": "int32", + "description": "Minimum capacity to achieve which cannot be updated. If we will not be able to \"guarantee\" minimum capacity, we will reject the request in the sync path itself.", + "minimum": 0 + }, + "allocationStrategy": { + "$ref": "#/definitions/RegularPriorityAllocationStrategy", + "description": "Allocation strategy to follow when determining the VM sizes distribution for Regular VMs." + } + } + }, + "ResourcePlanUpdate": { + "type": "object", + "description": "The template for adding optional properties.", + "properties": { + "name": { + "type": "string", + "description": "A user defined name of the 3rd Party Artifact that is being procured." + }, + "publisher": { + "type": "string", + "description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic" + }, + "product": { + "type": "string", + "description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding." + }, + "promotionCode": { + "type": "string", + "description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact." + }, + "version": { + "type": "string", + "description": "The version of the desired product/artifact." + } + } + }, + "ScheduledEventsProfile": { + "type": "object", + "description": "Specifies Scheduled Event related configurations.", + "properties": { + "terminateNotificationProfile": { + "$ref": "#/definitions/TerminateNotificationProfile", + "description": "Specifies Terminate Scheduled Event related configurations." + }, + "osImageNotificationProfile": { + "$ref": "#/definitions/OSImageNotificationProfile", + "description": "Specifies OS Image Scheduled Event related configurations." + } + } + }, + "SecurityEncryptionTypes": { + "type": "string", + "description": "Specifies the EncryptionType of the managed disk.\n**Note:** It can be set for only Confidential VMs.", + "enum": [ + "VMGuestStateOnly", + "DiskWithVMGuestState", + "NonPersistedTPM" + ], + "x-ms-enum": { + "name": "SecurityEncryptionTypes", + "modelAsString": true, + "values": [ + { + "name": "VMGuestStateOnly", + "value": "VMGuestStateOnly", + "description": "EncryptionType of the managed disk is set to VMGuestStateOnly for encryption\nof just the VMGuestState blob." + }, + { + "name": "DiskWithVMGuestState", + "value": "DiskWithVMGuestState", + "description": "EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption\nof the managed disk along with VMGuestState blob." + }, + { + "name": "NonPersistedTPM", + "value": "NonPersistedTPM", + "description": "EncryptionType of the managed disk is set to NonPersistedTPM for not persisting\nfirmware state in the VMGuestState blob." + } + ] + } + }, + "SecurityPostureReference": { + "type": "object", + "description": "Specifies the security posture to be used for all virtual machines in the scale\nset. Minimum api-version: 2023-03-01", + "properties": { + "id": { + "type": "string", + "description": "The security posture reference id in the form of\n/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest" + }, + "excludeExtensions": { + "type": "array", + "description": "List of virtual machine extension names to exclude when applying the security\nposture.", + "items": { + "type": "string" + } + }, + "isOverridable": { + "type": "boolean", + "description": "Whether the security posture can be overridden by the user." + } + } + }, + "SecurityProfile": { + "type": "object", + "description": "Specifies the Security profile settings for the virtual machine or virtual\nmachine scale set.", + "properties": { + "uefiSettings": { + "$ref": "#/definitions/UefiSettings", + "description": "Specifies the security settings like secure boot and vTPM used while creating\nthe virtual machine. Minimum api-version: 2020-12-01." + }, + "encryptionAtHost": { + "type": "boolean", + "description": "This property can be used by user in the request to enable or disable the Host\nEncryption for the virtual machine or virtual machine scale set. This will\nenable the encryption for all the disks including Resource/Temp disk at host\nitself. The default behavior is: The Encryption at host will be disabled unless\nthis property is set to true for the resource." + }, + "securityType": { + "$ref": "#/definitions/SecurityTypes", + "description": "Specifies the SecurityType of the virtual machine. It has to be set to any\nspecified value to enable UefiSettings. The default behavior is: UefiSettings\nwill not be enabled unless this property is set." + }, + "encryptionIdentity": { + "$ref": "#/definitions/EncryptionIdentity", + "description": "Specifies the Managed Identity used by ADE to get access token for keyvault\noperations." + }, + "proxyAgentSettings": { + "$ref": "#/definitions/ProxyAgentSettings", + "description": "Specifies ProxyAgent settings while creating the virtual machine. Minimum\napi-version: 2023-09-01." + } + } + }, + "SecurityTypes": { + "type": "string", + "description": "Specifies the SecurityType of the virtual machine. It has to be set to any\nspecified value to enable UefiSettings. The default behavior is: UefiSettings\nwill not be enabled unless this property is set.", + "enum": [ + "TrustedLaunch", + "ConfidentialVM" + ], + "x-ms-enum": { + "name": "SecurityTypes", + "modelAsString": true, + "values": [ + { + "name": "TrustedLaunch", + "value": "TrustedLaunch", + "description": "TrustedLaunch security type" + }, + { + "name": "ConfidentialVM", + "value": "ConfidentialVM", + "description": "ConfidentialVM security type" + } + ] + } + }, + "ServiceArtifactReference": { + "type": "object", + "description": "Specifies the service artifact reference id used to set same image version for\nall virtual machines in the scale set when using 'latest' image version.\nMinimum api-version: 2022-11-01", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The service artifact reference id in the form of\n/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}" + } + } + }, + "SettingNames": { + "type": "string", + "description": "Specifies the name of the setting to which the content applies. Possible values\nare: FirstLogonCommands and AutoLogon.", + "enum": [ + "AutoLogon", + "FirstLogonCommands" + ], + "x-ms-enum": { + "name": "SettingNames", + "modelAsString": true, + "values": [ + { + "name": "AutoLogon", + "value": "AutoLogon", + "description": "AutoLogon setting" + }, + { + "name": "FirstLogonCommands", + "value": "FirstLogonCommands", + "description": "FirstLogonCommands setting" + } + ] + } + }, + "SpotAllocationStrategy": { + "type": "string", + "description": "Spot allocation strategy types for Compute Fleet", + "enum": [ + "PriceCapacityOptimized", + "LowestPrice", + "CapacityOptimized" + ], + "x-ms-enum": { + "name": "SpotAllocationStrategy", + "modelAsString": true, + "values": [ + { + "name": "PriceCapacityOptimized", + "value": "PriceCapacityOptimized", + "description": "Default. VM sizes distribution will be determined to optimize for both price and capacity." + }, + { + "name": "LowestPrice", + "value": "LowestPrice", + "description": "VM sizes distribution will be determined to optimize for price. Note: Capacity will still be considered here but will be given much less weight." + }, + { + "name": "CapacityOptimized", + "value": "CapacityOptimized", + "description": "VM sizes distribution will be determined to optimize for capacity." + } + ] + } + }, + "SpotPriorityProfile": { + "type": "object", + "description": "Configuration Options for Spot instances in Compute Fleet.", + "properties": { + "capacity": { + "type": "integer", + "format": "int32", + "description": "Total capacity to achieve. It is currently in terms of number of VMs.", + "minimum": 0 + }, + "minCapacity": { + "type": "integer", + "format": "int32", + "description": "Minimum capacity to achieve which cannot be updated. If we will not be able to \"guarantee\" minimum capacity, we will reject the request in the sync path itself.", + "minimum": 0 + }, + "maxPricePerVM": { + "type": "number", + "format": "float", + "description": "Price per hour of each Spot VM will never exceed this." + }, + "evictionPolicy": { + "$ref": "#/definitions/EvictionPolicy", + "description": "Eviction Policy to follow when evicting Spot VMs." + }, + "allocationStrategy": { + "$ref": "#/definitions/SpotAllocationStrategy", + "description": "Allocation strategy to follow when determining the VM sizes distribution for Spot VMs." + }, + "maintain": { + "type": "boolean", + "description": "Flag to enable/disable continuous goal seeking for the desired capacity and restoration of evicted Spot VMs.\nIf maintain is enabled, AzureFleetRP will use all VM sizes in vmSizesProfile to create new VMs (if VMs are evicted deleted)\nor update existing VMs with new VM sizes (if VMs are evicted deallocated or failed to allocate due to capacity constraint) in order to achieve the desired capacity.\nMaintain is enabled by default." + } + } + }, + "SshConfiguration": { + "type": "object", + "description": "SSH configuration for Linux based VMs running on Azure", + "properties": { + "publicKeys": { + "type": "array", + "description": "The list of SSH public keys used to authenticate with linux based VMs.", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "x-ms-identifiers": [ + "path" + ] + } + } + }, + "SshPublicKey": { + "type": "object", + "description": "Contains information about SSH certificate public key and the path on the Linux\nVM where the public key is placed.", + "properties": { + "path": { + "type": "string", + "description": "Specifies the full path on the created VM where ssh public key is stored. If\nthe file already exists, the specified key is appended to the file. Example:\n/home/user/.ssh/authorized_keys" + }, + "keyData": { + "type": "string", + "description": "SSH public key certificate used to authenticate with the VM through ssh. The\nkey needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys,\nsee [Create SSH keys on Linux and Mac for Linux VMs in\nAzure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed)." + } + } + }, + "StatusLevelTypes": { + "type": "string", + "description": "The level code.", + "enum": [ + "Info", + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "StatusLevelTypes", + "modelAsString": true, + "values": [ + { + "name": "Info", + "value": "Info", + "description": "Info level" + }, + { + "name": "Warning", + "value": "Warning", + "description": "Warning level" + }, + { + "name": "Error", + "value": "Error", + "description": "Error Level" + } + ] + } + }, + "StorageAccountTypes": { + "type": "string", + "description": "Specifies the storage account type for the managed disk. Managed OS disk\nstorage account type can only be set when you create the scale set. NOTE:\nUltraSSD_LRS can only be used with data disks. It cannot be used with OS Disk.\nStandard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS\nuses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD\nzone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant\nstorage. For more information regarding disks supported for Windows Virtual\nMachines, refer to\nhttps://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for\nLinux Virtual Machines, refer to\nhttps://docs.microsoft.com/azure/virtual-machines/linux/disks-types", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS", + "Premium_ZRS", + "StandardSSD_ZRS", + "PremiumV2_LRS" + ], + "x-ms-enum": { + "name": "StorageAccountTypes", + "modelAsString": true, + "values": [ + { + "name": "Standard_LRS", + "value": "Standard_LRS", + "description": "Standard_LRS option." + }, + { + "name": "Premium_LRS", + "value": "Premium_LRS", + "description": "Premium_LRS option." + }, + { + "name": "StandardSSD_LRS", + "value": "StandardSSD_LRS", + "description": "StandardSSD_LRS option." + }, + { + "name": "UltraSSD_LRS", + "value": "UltraSSD_LRS", + "description": "UltraSSD_LRS option." + }, + { + "name": "Premium_ZRS", + "value": "Premium_ZRS", + "description": "Premium_ZRS option." + }, + { + "name": "StandardSSD_ZRS", + "value": "StandardSSD_ZRS", + "description": "StandardSSD_ZRS option." + }, + { + "name": "PremiumV2_LRS", + "value": "PremiumV2_LRS", + "description": "PremiumV2_LRS option." + } + ] + } + }, + "SubResource": { + "type": "object", + "description": "Describes SubResource", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "Resource Id" + } + } + }, + "SubResourceReadOnly": { + "type": "object", + "description": "Describes a Readonly subresource.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "Resource Id", + "readOnly": true + } + } + }, + "TerminateNotificationProfile": { + "type": "object", + "description": "Specifies Terminate Scheduled Event related configurations.", + "properties": { + "notBeforeTimeout": { + "type": "string", + "description": "Configurable length of time a Virtual Machine being deleted will have to\npotentially approve the Terminate Scheduled Event before the event is auto\napproved (timed out). The configuration must be specified in ISO 8601 format,\nthe default value is 5 minutes (PT5M)" + }, + "enable": { + "type": "boolean", + "description": "Specifies whether the Terminate Scheduled event is enabled or disabled." + } + } + }, + "UefiSettings": { + "type": "object", + "description": "Specifies the security settings like secure boot and vTPM used while creating\nthe virtual machine. Minimum api-version: 2020-12-01.", + "properties": { + "secureBootEnabled": { + "type": "boolean", + "description": "Specifies whether secure boot should be enabled on the virtual machine. Minimum\napi-version: 2020-12-01." + }, + "vTpmEnabled": { + "type": "boolean", + "description": "Specifies whether vTPM should be enabled on the virtual machine. Minimum\napi-version: 2020-12-01." + } + } + }, + "VMAttributeMinMaxDouble": { + "type": "object", + "description": "VMAttributes using double values.", + "properties": { + "min": { + "type": "number", + "format": "double", + "description": "Minimum value. default 0. Double.MinValue()", + "minimum": 0 + }, + "max": { + "type": "number", + "format": "double", + "description": "Maximum value. Double.MaxValue(1.7976931348623157E+308)", + "minimum": 0 + } + } + }, + "VMAttributeMinMaxInteger": { + "type": "object", + "description": "While retrieving VMSizes from CRS, Min = 0 (uint.MinValue) if not specified, Max = 4294967295 (uint.MaxValue) if not specified. This allows to filter VMAttributes on all available VMSizes.", + "properties": { + "min": { + "type": "integer", + "format": "int32", + "description": "Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified.", + "minimum": 0 + }, + "max": { + "type": "integer", + "format": "int32", + "description": "Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified.", + "minimum": 0 + } + } + }, + "VMAttributeSupport": { + "type": "string", + "description": "VMSizes supported by Azure VMs. Included is a union of Excluded and Required.", + "enum": [ + "Excluded", + "Included", + "Required" + ], + "x-ms-enum": { + "name": "VMAttributeSupport", + "modelAsString": true, + "values": [ + { + "name": "Excluded", + "value": "Excluded", + "description": "All VMSizes having the feature support will be excluded." + }, + { + "name": "Included", + "value": "Included", + "description": " VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required." + }, + { + "name": "Required", + "value": "Required", + "description": "Only the VMSizes having the feature support will be used." + } + ] + } + }, + "VMAttributes": { + "type": "object", + "description": "VMAttributes that will be used to filter VMSizes which will be used to build Fleet.", + "properties": { + "vCpuCount": { + "$ref": "#/definitions/VMAttributeMinMaxInteger", + "description": "The range of vCpuCount specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified." + }, + "memoryInGiB": { + "$ref": "#/definitions/VMAttributeMinMaxDouble", + "description": "The range of memory specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified." + }, + "localStorageSupport": { + "$ref": "#/definitions/VMAttributeSupport", + "description": "Specifies whether the VMSize supporting local storage should be used to build Fleet or not." + }, + "localStorageInGiB": { + "$ref": "#/definitions/VMAttributeMinMaxDouble", + "description": "The range of local storage in GB specified from Min to Max." + }, + "localStorageDiskTypes": { + "type": "array", + "description": "The local storage disk types specified as a list. LocalStorageSupport should be set to \"Included\" or \"Required\" to use this VMAttribute. \nIf localStorageSupport is \"Excluded\", this VMAttribute can not be used.", + "items": { + "$ref": "#/definitions/LocalStorageDiskType" + }, + "x-ms-identifiers": [] + }, + "dataDiskCount": { + "$ref": "#/definitions/VMAttributeMinMaxInteger", + "description": "The range of data disk count specified from Min to Max. Optional parameter. Either Min or Max is required if specified." + }, + "networkInterfaceCount": { + "$ref": "#/definitions/VMAttributeMinMaxInteger", + "description": "The range of network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified." + }, + "networkBandwidthInMbps": { + "$ref": "#/definitions/VMAttributeMinMaxDouble", + "description": "The range of network bandwidth in Mbps specified from Min to Max. Optional parameter. Either Min or Max is required if specified." + }, + "rdmaSupport": { + "$ref": "#/definitions/VMAttributeSupport", + "description": "Specifies whether the VMSize supporting RDMA (Remote Direct Memory Access) should be used to build Fleet or not." + }, + "rdmaNetworkInterfaceCount": { + "$ref": "#/definitions/VMAttributeMinMaxInteger", + "description": "The range of RDMA (Remote Direct Memory Access) network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified." + }, + "acceleratorSupport": { + "$ref": "#/definitions/VMAttributeSupport", + "description": "Specifies whether the VMSize supporting accelerator should be used to build Fleet or not." + }, + "acceleratorManufacturers": { + "type": "array", + "description": "The accelerator manufacturers specified as a list. acceleratorSupport should be set to Included or Required to use this VMAttribute.", + "items": { + "$ref": "#/definitions/AcceleratorManufacturer" + }, + "x-ms-identifiers": [] + }, + "acceleratorTypes": { + "type": "array", + "description": "The accelerator types specified as a list. acceleratorSupport should be set to Included or Required to use this VMAttribute.", + "items": { + "$ref": "#/definitions/AcceleratorType" + }, + "x-ms-identifiers": [] + }, + "acceleratorCount": { + "$ref": "#/definitions/VMAttributeMinMaxInteger", + "description": "The range of accelerator count specified from min to max.. Optional parameter. Either Min or Max is required if specified." + }, + "vmCategories": { + "type": "array", + "description": "The VM category specified as a list. Optional parameter.", + "items": { + "$ref": "#/definitions/VMCategory" + }, + "x-ms-identifiers": [] + }, + "architectureTypes": { + "type": "array", + "description": "The VM architecture types specified as a list. Optional parameter.", + "items": { + "$ref": "#/definitions/ArchitectureType" + }, + "x-ms-identifiers": [] + }, + "cpuManufacturers": { + "type": "array", + "description": "The VM CPU manufacturers specified as a list. Optional parameter.", + "items": { + "$ref": "#/definitions/CpuManufacturer" + }, + "x-ms-identifiers": [] + }, + "burstableSupport": { + "$ref": "#/definitions/VMAttributeSupport", + "description": "Specifies whether the VMSize supporting burstable capability should be used to build Fleet or not." + }, + "excludedVMSizes": { + "type": "array", + "description": "Specifies which VMSizes should be excluded while building Fleet. Optional parameter.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "vCpuCount", + "memoryInGiB" + ] + }, + "VMCategory": { + "type": "string", + "description": "VMCategories defined for Azure VMs.\nSee: https://learn.microsoft.com/en-us/azure/virtual-machines/sizes/overview?tabs=breakdownseries%2Cgeneralsizelist%2Ccomputesizelist%2Cmemorysizelist%2Cstoragesizelist%2Cgpusizelist%2Cfpgasizelist%2Chpcsizelist#general-purpose", + "enum": [ + "GeneralPurpose", + "ComputeOptimized", + "MemoryOptimized", + "StorageOptimized", + "GpuAccelerated", + "FpgaAccelerated", + "HighPerformanceCompute" + ], + "x-ms-enum": { + "name": "VMCategory", + "modelAsString": true, + "values": [ + { + "name": "GeneralPurpose", + "value": "GeneralPurpose", + "description": "General purpose VM sizes provide balanced CPU-to-memory ratio. Ideal for testing and development, small to medium databases, and low to medium traffic web servers." + }, + { + "name": "ComputeOptimized", + "value": "ComputeOptimized", + "description": "Compute optimized VM sizes have a high CPU-to-memory ratio. These sizes are good for medium traffic web servers, network appliances, batch processes, and application servers." + }, + { + "name": "MemoryOptimized", + "value": "MemoryOptimized", + "description": "Memory optimized VM sizes offer a high memory-to-CPU ratio that is great for relational database servers, medium to large caches, and in-memory analytics." + }, + { + "name": "StorageOptimized", + "value": "StorageOptimized", + "description": "Storage optimized virtual machine (VM) sizes offer high disk throughput and IO, and are ideal for Big Data, SQL, NoSQL databases, data warehousing, and large transactional databases. \nExamples include Cassandra, MongoDB, Cloudera, and Redis." + }, + { + "name": "GpuAccelerated", + "value": "GpuAccelerated", + "description": "GPU optimized VM sizes are specialized virtual machines available with single, multiple, or fractional GPUs. \nThese sizes are designed for compute-intensive, graphics-intensive, and visualization workloads." + }, + { + "name": "FpgaAccelerated", + "value": "FpgaAccelerated", + "description": "FPGA optimized VM sizes are specialized virtual machines available with single or multiple FPGA. \nThese sizes are designed for compute-intensive workloads. This article provides information about the number and type of FPGA, vCPUs, data disks, and NICs. \nStorage throughput and network bandwidth are also included for each size in this grouping." + }, + { + "name": "HighPerformanceCompute", + "value": "HighPerformanceCompute", + "description": "Azure High Performance Compute VMs are optimized for various HPC workloads such as computational fluid dynamics, finite element analysis, frontend and backend EDA, \nrendering, molecular dynamics, computational geo science, weather simulation, and financial risk analysis." + } + ] + } + }, + "VMDiskSecurityProfile": { + "type": "object", + "description": "Specifies the security profile settings for the managed disk. **Note:** It can\nonly be set for Confidential VMs.", + "properties": { + "securityEncryptionType": { + "$ref": "#/definitions/SecurityEncryptionTypes", + "description": "Specifies the EncryptionType of the managed disk. It is set to\nDiskWithVMGuestState for encryption of the managed disk along with VMGuestState\nblob, VMGuestStateOnly for encryption of just the VMGuestState blob, and\nNonPersistedTPM for not persisting firmware state in the VMGuestState blob..\n**Note:** It can be set for only Confidential VMs." + }, + "diskEncryptionSet": { + "$ref": "#/definitions/DiskEncryptionSetParameters", + "description": "Specifies the customer managed disk encryption set resource id for the managed\ndisk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and\nVMGuest blob." + } + } + }, + "VMGalleryApplication": { + "type": "object", + "description": "Specifies the required information to reference a compute gallery application\nversion", + "properties": { + "tags": { + "type": "string", + "description": "Optional, Specifies a passthrough value for more generic context." + }, + "order": { + "type": "integer", + "format": "int32", + "description": "Optional, Specifies the order in which the packages have to be installed" + }, + "packageReferenceId": { + "type": "string", + "format": "arm-id", + "description": "Specifies the GalleryApplicationVersion resource id on the form of\n/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version}" + }, + "configurationReference": { + "type": "string", + "description": "Optional, Specifies the uri to an azure blob that will replace the default\nconfiguration for the package if provided" + }, + "treatFailureAsDeploymentFailure": { + "type": "boolean", + "description": "Optional, If true, any failure for any operation in the VmApplication will fail\nthe deployment" + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "If set to true, when a new Gallery Application version is available in PIR/SIG,\nit will be automatically updated for the VM/VMSS" + } + }, + "required": [ + "packageReferenceId" + ] + }, + "VMSizeProperties": { + "type": "object", + "description": "Specifies VM Size Property settings on the virtual machine.", + "properties": { + "vCPUsAvailable": { + "type": "integer", + "format": "int32", + "description": "Specifies the number of vCPUs available for the VM. When this property is not\nspecified in the request body the default behavior is to set it to the value of\nvCPUs available for that VM size exposed in api response of [List all available\nvirtual machine sizes in a\nregion](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list)." + }, + "vCPUsPerCore": { + "type": "integer", + "format": "int32", + "description": "Specifies the vCPU to physical core ratio. When this property is not specified\nin the request body the default behavior is set to the value of vCPUsPerCore\nfor the VM Size exposed in api response of [List all available virtual machine\nsizes in a\nregion](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list).\n**Setting this property to 1 also means that hyper-threading is disabled.**" + } + } + }, + "VaultCertificate": { + "type": "object", + "description": "Describes a single certificate reference in a Key Vault, and where the\ncertificate should reside on the VM.", + "properties": { + "certificateUrl": { + "type": "string", + "format": "uri", + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a\nsecret. For adding a secret to the Key Vault, see [Add a key or secret to the\nkey\nvault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add).\nIn this case, your certificate needs to be It is the Base64 encoding of the\nfollowing JSON Object which is encoded in UTF-8: <br><br> {<br>\n\"data\":\"<Base64-encoded-certificate>\",<br> \"dataType\":\"pfx\",<br>\n\"password\":\"<pfx-file-password>\"<br>} <br> To install certificates on a virtual\nmachine it is recommended to use the [Azure Key Vault virtual machine extension\nfor\nLinux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux)\nor the [Azure Key Vault virtual machine extension for\nWindows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)." + }, + "certificateStore": { + "type": "string", + "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to\nwhich the certificate should be added. The specified certificate store is\nimplicitly in the LocalMachine account. For Linux VMs, the certificate file is\nplaced under the /var/lib/waagent directory, with the file name\n<UppercaseThumbprint>.crt for the X509 certificate file and\n<UppercaseThumbprint>.prv for private key. Both of these files are .pem\nformatted." + } + } + }, + "VaultSecretGroup": { + "type": "object", + "description": "Describes a set of certificates which are all in the same Key Vault.", + "properties": { + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing all of the certificates in\nVaultCertificates." + }, + "vaultCertificates": { + "type": "array", + "description": "The list of key vault references in SourceVault which contain certificates.", + "items": { + "$ref": "#/definitions/VaultCertificate" + }, + "x-ms-identifiers": [ + "certificateUrl" + ] + } + } + }, + "VirtualHardDisk": { + "type": "object", + "description": "Describes the uri of a disk.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "Specifies the virtual hard disk's uri." + } + } + }, + "VirtualMachineScaleSet": { + "type": "object", + "description": "An AzureFleet's virtualMachineScaleSet", + "properties": { + "name": { + "type": "string", + "description": "The name of the virtualMachineScaleSet", + "readOnly": true + }, + "id": { + "type": "string", + "description": "The compute RP resource id of the virtualMachineScaleSet \n\"subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}\"", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Type of the virtualMachineScaleSet", + "readOnly": true + }, + "operationStatus": { + "$ref": "#/definitions/ProvisioningState", + "description": "This represents the operationStatus of the VMSS in response to the last operation that was performed on it by Azure Fleet resource.", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/ApiError", + "description": "Error Information when `operationStatus` is `Failed`", + "readOnly": true + } + }, + "required": [ + "name", + "id", + "operationStatus" + ] + }, + "VirtualMachineScaleSetDataDisk": { + "type": "object", + "description": "Describes a virtual machine scale set data disk.", + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to\nidentify data disks within the VM and therefore must be unique for each data\ndisk attached to a VM." + }, + "caching": { + "$ref": "#/definitions/CachingTypes", + "description": "Specifies the caching requirements. Possible values are: **None,**\n**ReadOnly,** **ReadWrite.** The default values are: **None for Standard\nstorage. ReadOnly for Premium storage.**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "#/definitions/DiskCreateOptionTypes", + "description": "The create option." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used\nto overwrite the size of the disk in a virtual machine image. The property\ndiskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be\nlarger than 1023." + }, + "managedDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters", + "description": "The managed disk parameters." + }, + "diskIOPSReadWrite": { + "type": "integer", + "format": "int64", + "description": "Specifies the Read-Write IOPS for the managed disk. Should be used only when\nStorageAccountType is UltraSSD_LRS. If not specified, a default value would be\nassigned based on diskSizeGB." + }, + "diskMBpsReadWrite": { + "type": "integer", + "format": "int64", + "description": "Specifies the bandwidth in MB per second for the managed disk. Should be used\nonly when StorageAccountType is UltraSSD_LRS. If not specified, a default value\nwould be assigned based on diskSizeGB." + }, + "deleteOption": { + "$ref": "#/definitions/DiskDeleteOptionTypes", + "description": "Specifies whether data disk should be deleted or detached upon VMSS Flex\ndeletion (This feature is available for VMSS with Flexible OrchestrationMode\nonly).<br><br> Possible values: <br><br> **Delete** If this value is used, the\ndata disk is deleted when the VMSS Flex VM is deleted.<br><br> **Detach** If\nthis value is used, the data disk is retained after VMSS Flex VM is\ndeleted.<br><br> The default value is set to **Delete**." + } + }, + "required": [ + "lun", + "createOption" + ] + }, + "VirtualMachineScaleSetExtension": { + "type": "object", + "description": "Describes a Virtual Machine Scale Set Extension.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "Resource Id", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the extension." + }, + "type": { + "type": "string", + "description": "Resource type", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties", + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + } + } + }, + "VirtualMachineScaleSetExtensionProfile": { + "type": "object", + "description": "Describes a virtual machine scale set extension profile.", + "properties": { + "extensions": { + "type": "array", + "description": "The virtual machine scale set child extension resources.", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + "extensionsTimeBudget": { + "type": "string", + "description": "Specifies the time alloted for all extensions to start. The time duration\nshould be between 15 minutes and 120 minutes (inclusive) and should be\nspecified in ISO 8601 format. The default value is 90 minutes (PT1H30M).\nMinimum api-version: 2020-06-01." + } + } + }, + "VirtualMachineScaleSetExtensionProperties": { + "type": "object", + "description": "Describes the properties of a Virtual Machine Scale Set Extension.", + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "If a value is provided and is different from the previous value, the extension\nhandler will be forced to update even if the extension configuration has not\nchanged." + }, + "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\navailable at deployment time. Once deployed, however, the extension will not\nupgrade minor versions unless redeployed, even with this property set to true." + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "Indicates whether the extension should be automatically upgraded by the\nplatform if there is a newer version of the extension available." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension.", + "additionalProperties": {} + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or\nprotectedSettingsFromKeyVault or no protected settings at all.", + "additionalProperties": {}, + "x-ms-mutability": [ + "update", + "create" + ], + "x-ms-secret": true + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state, which only appears in the response.", + "readOnly": true + }, + "provisionAfterExtensions": { + "type": "array", + "description": "Collection of extension names after which this extension needs to be\nprovisioned.", + "items": { + "type": "string" + } + }, + "suppressFailures": { + "type": "boolean", + "description": "Indicates whether failures stemming from the extension will be suppressed\n(Operational failures such as not connecting to the VM will not be suppressed\nregardless of this value). The default is false." + }, + "protectedSettingsFromKeyVault": { + "$ref": "#/definitions/KeyVaultSecretReference", + "description": "The extensions protected settings that are passed by reference, and consumed\nfrom key vault" + } + } + }, + "VirtualMachineScaleSetHardwareProfile": { + "type": "object", + "description": "Specifies the hardware settings for the virtual machine scale set.", + "properties": { + "vmSizeProperties": { + "$ref": "#/definitions/VMSizeProperties", + "description": "Specifies the properties for customizing the size of the virtual machine.\nMinimum api-version: 2021-11-01. Please follow the instructions in [VM\nCustomization](https://aka.ms/vmcustomization) for more details." + } + } + }, + "VirtualMachineScaleSetIPConfiguration": { + "type": "object", + "description": "Describes a virtual machine scale set network profile's IP configuration.", + "properties": { + "name": { + "type": "string", + "description": "The IP configuration name." + }, + "properties": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfigurationProperties", + "description": "Describes a virtual machine scale set network profile's IP configuration\nproperties." + } + }, + "required": [ + "name" + ] + }, + "VirtualMachineScaleSetIPConfigurationProperties": { + "type": "object", + "description": "Describes a virtual machine scale set network profile's IP configuration\nproperties.", + "properties": { + "subnet": { + "$ref": "#/definitions/ApiEntityReference", + "description": "Specifies the identifier of the subnet." + }, + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more\nthan 1 network interface." + }, + "publicIPAddressConfiguration": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration", + "description": "The publicIPAddressConfiguration." + }, + "privateIPAddressVersion": { + "$ref": "#/definitions/IPVersion", + "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the\nspecific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible\nvalues are: 'IPv4' and 'IPv6'." + }, + "applicationGatewayBackendAddressPools": { + "type": "array", + "description": "Specifies an array of references to backend address pools of application\ngateways. A scale set can reference backend address pools of multiple\napplication gateways. Multiple scale sets cannot use the same application\ngateway.", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + "applicationSecurityGroups": { + "type": "array", + "description": "Specifies an array of references to application security group.", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + "loadBalancerBackendAddressPools": { + "type": "array", + "description": "Specifies an array of references to backend address pools of load balancers. A\nscale set can reference backend address pools of one public and one internal\nload balancer. Multiple scale sets cannot use the same basic sku load balancer.", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + "loadBalancerInboundNatPools": { + "type": "array", + "description": "Specifies an array of references to inbound Nat pools of the load balancers. A\nscale set can reference inbound nat pools of one public and one internal load\nbalancer. Multiple scale sets cannot use the same basic sku load balancer.", + "items": { + "$ref": "#/definitions/SubResource" + } + } + } + }, + "VirtualMachineScaleSetIpTag": { + "type": "object", + "description": "Contains the IP tag associated with the public IP address.", + "properties": { + "ipTagType": { + "type": "string", + "description": "IP tag type. Example: FirstPartyUsage." + }, + "tag": { + "type": "string", + "description": "IP tag associated with the public IP. Example: SQL, Storage etc." + } + } + }, + "VirtualMachineScaleSetListResult": { + "type": "object", + "description": "The response of a VirtualMachineScaleSet list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VirtualMachineScaleSet items on this page", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VirtualMachineScaleSetManagedDiskParameters": { + "type": "object", + "description": "Describes the parameters of a ScaleSet managed disk.", + "properties": { + "storageAccountType": { + "$ref": "#/definitions/StorageAccountTypes", + "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can\nonly be used with data disks, it cannot be used with OS Disk." + }, + "diskEncryptionSet": { + "$ref": "#/definitions/DiskEncryptionSetParameters", + "description": "Specifies the customer managed disk encryption set resource id for the managed\ndisk." + }, + "securityProfile": { + "$ref": "#/definitions/VMDiskSecurityProfile", + "description": "Specifies the security profile for the managed disk." + } + } + }, + "VirtualMachineScaleSetNetworkConfiguration": { + "type": "object", + "description": "Describes a virtual machine scale set network profile's network configurations.", + "properties": { + "name": { + "type": "string", + "description": "The network configuration name." + }, + "properties": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationProperties", + "description": "Describes a virtual machine scale set network profile's IP configuration." + } + }, + "required": [ + "name" + ] + }, + "VirtualMachineScaleSetNetworkConfigurationDnsSettings": { + "type": "object", + "description": "Describes a virtual machines scale sets network configuration's DNS settings.", + "properties": { + "dnsServers": { + "type": "array", + "description": "List of DNS servers IP addresses", + "items": { + "type": "string" + } + } + } + }, + "VirtualMachineScaleSetNetworkConfigurationProperties": { + "type": "object", + "description": "Describes a virtual machine scale set network profile's IP configuration.", + "properties": { + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more\nthan 1 network interface." + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "Specifies whether the network interface is accelerated networking-enabled." + }, + "disableTcpStateTracking": { + "type": "boolean", + "description": "Specifies whether the network interface is disabled for tcp state tracking." + }, + "enableFpga": { + "type": "boolean", + "description": "Specifies whether the network interface is FPGA networking-enabled." + }, + "networkSecurityGroup": { + "$ref": "#/definitions/SubResource", + "description": "The network security group." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings", + "description": "The dns settings to be applied on the network interfaces." + }, + "ipConfigurations": { + "type": "array", + "description": "Specifies the IP configurations of the network interface.", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "enableIPForwarding": { + "type": "boolean", + "description": "Whether IP forwarding enabled on this NIC." + }, + "deleteOption": { + "$ref": "#/definitions/DeleteOptions", + "description": "Specify what happens to the network interface when the VM is deleted" + }, + "auxiliaryMode": { + "$ref": "#/definitions/NetworkInterfaceAuxiliaryMode", + "description": "Specifies whether the Auxiliary mode is enabled for the Network Interface\nresource." + }, + "auxiliarySku": { + "$ref": "#/definitions/NetworkInterfaceAuxiliarySku", + "description": "Specifies whether the Auxiliary sku is enabled for the Network Interface\nresource." + } + }, + "required": [ + "ipConfigurations" + ] + }, + "VirtualMachineScaleSetNetworkProfile": { + "type": "object", + "description": "Describes a virtual machine scale set network profile.", + "properties": { + "healthProbe": { + "$ref": "#/definitions/ApiEntityReference", + "description": "A reference to a load balancer probe used to determine the health of an\ninstance in the virtual machine scale set. The reference will be in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'." + }, + "networkInterfaceConfigurations": { + "type": "array", + "description": "The list of network configurations.", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" + }, + "x-ms-identifiers": [] + }, + "networkApiVersion": { + "$ref": "#/definitions/NetworkApiVersion", + "description": "specifies the Microsoft.Network API version used when creating networking\nresources in the Network Interface Configurations for Virtual Machine Scale Set\nwith orchestration mode 'Flexible'" + } + } + }, + "VirtualMachineScaleSetOSDisk": { + "type": "object", + "description": "Describes a virtual machine scale set operating system disk.", + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "caching": { + "$ref": "#/definitions/CachingTypes", + "description": "Specifies the caching requirements. Possible values are: **None,**\n**ReadOnly,** **ReadWrite.** The default values are: **None for Standard\nstorage. ReadOnly for Premium storage.**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "#/definitions/DiskCreateOptionTypes", + "description": "Specifies how the virtual machines in the scale set should be created. The only\nallowed value is: **FromImage.** This value is used when you are using an image\nto create the virtual machine. If you are using a platform image, you also use\nthe imageReference element described above. If you are using a marketplace\nimage, you also use the plan element previously described." + }, + "diffDiskSettings": { + "$ref": "#/definitions/DiffDiskSettings", + "description": "Specifies the ephemeral disk Settings for the operating system disk used by the\nvirtual machine scale set." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used\nto overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB'\nis the number of bytes x 1024^3 for the disk and the value cannot\nbe larger than 1023." + }, + "osType": { + "$ref": "#/definitions/OperatingSystemTypes", + "description": "This property allows you to specify the type of the OS that is included in the\ndisk if creating a VM from user-image or a specialized VHD. Possible values\nare: **Windows,** **Linux.**" + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "Specifies information about the unmanaged user image to base the scale set on." + }, + "vhdContainers": { + "type": "array", + "description": "Specifies the container urls that are used to store operating system disks for\nthe scale set.", + "items": { + "type": "string" + } + }, + "managedDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters", + "description": "The managed disk parameters." + }, + "deleteOption": { + "$ref": "#/definitions/DiskDeleteOptionTypes", + "description": "Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion\n(This feature is available for VMSS with Flexible OrchestrationMode only).\n<br><br> Possible values: <br><br> **Delete** If this value is used, the OS\ndisk is deleted when VMSS Flex VM is deleted.<br><br> **Detach** If this value\nis used, the OS disk is retained after VMSS Flex VM is deleted. <br><br> The\ndefault value is set to **Delete**. For an Ephemeral OS Disk, the default value\nis set to **Delete**. User cannot change the delete option for Ephemeral OS\nDisk." + } + }, + "required": [ + "createOption" + ] + }, + "VirtualMachineScaleSetOSProfile": { + "type": "object", + "description": "Describes a virtual machine scale set OS profile.", + "properties": { + "computerNamePrefix": { + "type": "string", + "description": "Specifies the computer name prefix for all of the virtual machines in the scale\nset. Computer name prefixes must be 1 to 15 characters long." + }, + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account. <br><br> **Windows-only\nrestriction:** Cannot end in \".\" <br><br> **Disallowed values:**\n\"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\",\n\"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\",\n\"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\",\n\"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\".\n<br><br> **Minimum-length (Linux):** 1 character <br><br> **Max-length\n(Linux):** 64 characters <br><br> **Max-length (Windows):** 20 characters" + }, + "adminPassword": { + "type": "string", + "format": "password", + "description": "Specifies the password of the administrator account. <br><br> **Minimum-length\n(Windows):** 8 characters <br><br> **Minimum-length (Linux):** 6 characters\n<br><br> **Max-length (Windows):** 123 characters <br><br> **Max-length\n(Linux):** 72 characters <br><br> **Complexity requirements:** 3 out of 4\nconditions below need to be fulfilled <br> Has lower characters <br>Has upper\ncharacters <br> Has a digit <br> Has a special character (Regex match [\\W_])\n<br><br> **Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\",\n\"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\",\n\"Password22\", \"iloveyou!\" <br><br> For resetting the password, see [How to\nreset the Remote Desktop service or its login password in a Windows\nVM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)\n<br><br> For resetting root password, see [Manage users, SSH, and check or\nrepair disks on Azure Linux VMs using the VMAccess\nExtension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection)", + "x-ms-mutability": [ + "update", + "create" + ], + "x-ms-secret": true + }, + "customData": { + "type": "string", + "format": "password", + "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string\nis decoded to a binary array that is saved as a file on the Virtual Machine.\nThe maximum length of the binary array is 65535 bytes. For using cloud-init for\nyour VM, see [Using cloud-init to customize a Linux VM during\ncreation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init)", + "x-ms-mutability": [ + "update", + "create" + ], + "x-ms-secret": true + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "linuxConfiguration": { + "$ref": "#/definitions/LinuxConfiguration", + "description": "Specifies the Linux operating system settings on the virtual machine. For a\nlist of supported Linux distributions, see [Linux on Azure-Endorsed\nDistributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros)." + }, + "secrets": { + "type": "array", + "description": "Specifies set of certificates that should be installed onto the virtual\nmachines in the scale set. To install certificates on a virtual machine it is\nrecommended to use the [Azure Key Vault virtual machine extension for\nLinux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux)\nor the [Azure Key Vault virtual machine extension for\nWindows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows).", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + }, + "x-ms-identifiers": [ + "sourceVault/id" + ] + }, + "allowExtensionOperations": { + "type": "boolean", + "description": "Specifies whether extension operations should be allowed on the virtual machine\nscale set. This may only be set to False when no extensions are present on the\nvirtual machine scale set." + }, + "requireGuestProvisionSignal": { + "type": "boolean", + "description": "Optional property which must either be set to True or omitted." + } + } + }, + "VirtualMachineScaleSetPublicIPAddressConfiguration": { + "type": "object", + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress\nconfiguration", + "properties": { + "name": { + "type": "string", + "description": "The publicIP address configuration name." + }, + "properties": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationProperties", + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress\nconfiguration" + }, + "sku": { + "$ref": "#/definitions/PublicIPAddressSku", + "description": "Describes the public IP Sku. It can only be set with OrchestrationMode as\nFlexible." + } + }, + "required": [ + "name" + ] + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings": { + "type": "object", + "description": "Describes a virtual machines scale sets network configuration's DNS settings.", + "properties": { + "domainNameLabel": { + "type": "string", + "description": "The Domain name label.The concatenation of the domain name label and vm index\nwill be the domain name labels of the PublicIPAddress resources that will be\ncreated" + }, + "domainNameLabelScope": { + "$ref": "#/definitions/DomainNameLabelScopeTypes", + "description": "The Domain name label scope.The concatenation of the hashed domain name label\nthat generated according to the policy from domain name label scope and vm\nindex will be the domain name labels of the PublicIPAddress resources that will\nbe created" + } + }, + "required": [ + "domainNameLabel" + ] + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationProperties": { + "type": "object", + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress\nconfiguration", + "properties": { + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The idle timeout of the public IP address." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings", + "description": "The dns settings to be applied on the publicIP addresses ." + }, + "ipTags": { + "type": "array", + "description": "The list of IP tags associated with the public IP address.", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIpTag" + }, + "x-ms-identifiers": [] + }, + "publicIPPrefix": { + "$ref": "#/definitions/SubResource", + "description": "The PublicIPPrefix from which to allocate publicIP addresses." + }, + "publicIPAddressVersion": { + "$ref": "#/definitions/IPVersion", + "description": "Available from Api-Version 2019-07-01 onwards, it represents whether the\nspecific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible\nvalues are: 'IPv4' and 'IPv6'." + }, + "deleteOption": { + "$ref": "#/definitions/DeleteOptions", + "description": "Specify what happens to the public IP when the VM is deleted" + } + } + }, + "VirtualMachineScaleSetStorageProfile": { + "type": "object", + "description": "Describes a virtual machine scale set storage profile.", + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Specifies information about the image to use. You can specify information about\nplatform images, marketplace images, or virtual machine images. This element is\nrequired when you want to use a platform image, marketplace image, or virtual\nmachine image, but is not used in other creation operations." + }, + "osDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetOSDisk", + "description": "Specifies information about the operating system disk used by the virtual\nmachines in the scale set. For more information about disks, see [About disks\nand VHDs for Azure virtual\nmachines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)." + }, + "dataDisks": { + "type": "array", + "description": "Specifies the parameters that are used to add data disks to the virtual\nmachines in the scale set. For more information about disks, see [About disks\nand VHDs for Azure virtual\nmachines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview).", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + }, + "x-ms-identifiers": [ + "name", + "lun" + ] + }, + "diskControllerType": { + "$ref": "#/definitions/DiskControllerTypes", + "description": "Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01" + } + } + }, + "VmSizeProfile": { + "type": "object", + "description": "Specifications about a VM Size. This will also contain the corresponding rank and weight in future.", + "properties": { + "name": { + "type": "string", + "description": "The Sku name (e.g. 'Standard_DS1_v2')" + }, + "rank": { + "type": "integer", + "format": "int32", + "description": "The rank of the VM size. This is used with 'RegularPriorityAllocationStrategy.Prioritized'\nThe lower the number, the higher the priority. Starting with 0.", + "minimum": 0, + "maximum": 65535 + } + }, + "required": [ + "name" + ] + }, + "WinRMConfiguration": { + "type": "object", + "description": "Describes Windows Remote Management configuration of the VM", + "properties": { + "listeners": { + "type": "array", + "description": "The list of Windows Remote Management listeners", + "items": { + "$ref": "#/definitions/WinRMListener" + }, + "x-ms-identifiers": [] + } + } + }, + "WinRMListener": { + "type": "object", + "description": "Describes Protocol and thumbprint of Windows Remote Management listener", + "properties": { + "protocol": { + "$ref": "#/definitions/ProtocolTypes", + "description": "Specifies the protocol of WinRM listener. Possible values are: **http,**\n**https.**" + }, + "certificateUrl": { + "type": "string", + "format": "uri", + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a\nsecret. For adding a secret to the Key Vault, see [Add a key or secret to the\nkey\nvault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add).\nIn this case, your certificate needs to be the Base64 encoding of the following\nJSON Object which is encoded in UTF-8: <br><br> {<br>\n\"data\":\"<Base64-encoded-certificate>\",<br> \"dataType\":\"pfx\",<br>\n\"password\":\"<pfx-file-password>\"<br>} <br> To install certificates on a virtual\nmachine it is recommended to use the [Azure Key Vault virtual machine extension\nfor\nLinux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux)\nor the [Azure Key Vault virtual machine extension for\nWindows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)." + } + } + }, + "WindowsConfiguration": { + "type": "object", + "description": "Specifies Windows operating system settings on the virtual machine.", + "properties": { + "provisionVMAgent": { + "type": "boolean", + "description": "Indicates whether virtual machine agent should be provisioned on the virtual\nmachine. When this property is not specified in the request body, it is set to\ntrue by default. This will ensure that VM Agent is installed on the VM so that\nextensions can be added to the VM later." + }, + "enableAutomaticUpdates": { + "type": "boolean", + "description": "Indicates whether Automatic Updates is enabled for the Windows virtual machine.\nDefault value is true. For virtual machine scale sets, this property can be\nupdated and updates will take effect on OS reprovisioning." + }, + "timeZone": { + "type": "string", + "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\".\nPossible values can be\n[TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id)\nvalue from time zones returned by\n[TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones)." + }, + "additionalUnattendContent": { + "type": "array", + "description": "Specifies additional base-64 encoded XML formatted information that can be\nincluded in the Unattend.xml file, which is used by Windows Setup.", + "items": { + "$ref": "#/definitions/AdditionalUnattendContent" + }, + "x-ms-identifiers": [] + }, + "patchSettings": { + "$ref": "#/definitions/PatchSettings", + "description": "[Preview Feature] Specifies settings related to VM Guest Patching on Windows." + }, + "winRM": { + "$ref": "#/definitions/WinRMConfiguration", + "description": "Specifies the Windows Remote Management listeners. This enables remote Windows\nPowerShell." + }, + "enableVMAgentPlatformUpdates": { + "type": "boolean", + "description": "Indicates whether VMAgent Platform Updates is enabled for the Windows virtual\nmachine. Default value is false." + } + } + }, + "WindowsPatchAssessmentMode": { + "type": "string", + "description": "Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.", + "enum": [ + "ImageDefault", + "AutomaticByPlatform" + ], + "x-ms-enum": { + "name": "WindowsPatchAssessmentMode", + "modelAsString": true, + "values": [ + { + "name": "ImageDefault", + "value": "ImageDefault", + "description": "You control the timing of patch assessments on a virtual machine." + }, + { + "name": "AutomaticByPlatform", + "value": "AutomaticByPlatform", + "description": "The platform will trigger periodic patch assessments. The property provisionVMAgent must be true." + } + ] + } + }, + "WindowsVMGuestPatchAutomaticByPlatformRebootSetting": { + "type": "string", + "description": "Specifies the reboot setting for all AutomaticByPlatform patch installation operations.", + "enum": [ + "Unknown", + "IfRequired", + "Never", + "Always" + ], + "x-ms-enum": { + "name": "WindowsVMGuestPatchAutomaticByPlatformRebootSetting", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Reboot setting" + }, + { + "name": "IfRequired", + "value": "IfRequired", + "description": "IfRequired Reboot setting" + }, + { + "name": "Never", + "value": "Never", + "description": "Never Reboot setting" + }, + { + "name": "Always", + "value": "Always", + "description": "Always Reboot setting" + } + ] + } + }, + "WindowsVMGuestPatchAutomaticByPlatformSettings": { + "type": "object", + "description": "Specifies additional settings to be applied when patch mode AutomaticByPlatform\nis selected in Windows patch settings.", + "properties": { + "rebootSetting": { + "$ref": "#/definitions/WindowsVMGuestPatchAutomaticByPlatformRebootSetting", + "description": "Specifies the reboot setting for all AutomaticByPlatform patch installation\noperations." + }, + "bypassPlatformSafetyChecksOnUserSchedule": { + "type": "boolean", + "description": "Enables customer to schedule patching without accidental upgrades" + } + } + }, + "WindowsVMGuestPatchMode": { + "type": "string", + "description": "Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual\nmachines associated to virtual machine scale set with OrchestrationMode as\nFlexible.", + "enum": [ + "Manual", + "AutomaticByOS", + "AutomaticByPlatform" + ], + "x-ms-enum": { + "name": "WindowsVMGuestPatchMode", + "modelAsString": true, + "values": [ + { + "name": "Manual", + "value": "Manual", + "description": "You control the application of patches to a virtual machine.\nYou do this by applying patches manually inside the VM. In this mode,\nautomatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates\nmust be false" + }, + { + "name": "AutomaticByOS", + "value": "AutomaticByOS", + "description": "The virtual machine will automatically be updated by the OS.\nThe property WindowsConfiguration.enableAutomaticUpdates must be true." + }, + { + "name": "AutomaticByPlatform", + "value": "AutomaticByPlatform", + "description": "The virtual machine will automatically updated by the platform. The properties\nprovisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true." + } + ] + } + } + }, + "parameters": {} +} diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_CreateOrUpdate.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_CreateOrUpdate.json new file mode 100644 index 000000000000..a76ad9c827a9 --- /dev/null +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_CreateOrUpdate.json @@ -0,0 +1,1174 @@ +{ + "title": "Fleets_CreateOrUpdate", + "operationId": "Fleets_CreateOrUpdate", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet", + "fleetName": "testFleet", + "resource": { + "properties": { + "spotPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "adminPassword": "adfbrdxpv", + "customData": "xjjib", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon", + "content": "bubmqbxjkj" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Https", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "protectedSettings": {}, + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myvaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } + } + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "configurationReference": "ulztmiavpojpbpbddgnuuiimxcpau", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + } + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + } + }, + "zones": [ + "zone1", + "zone2" + ], + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "key9851": {} + } + }, + "tags": { + "key3518": "luvrnuvsgdpbuofdskkcoqhfh" + }, + "location": "westus", + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "spotPriorityProfile": { + "capacity": 10, + "minCapacity": 20, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 10, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Https", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "exactVersion": "zjbntmiskjexlr", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "type": "cmeam", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "provisioningState": "Succeeded", + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + }, + "timeCreated": "2024-04-29T21:51:44.043Z" + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "zones": [ + "zone1", + "zone2" + ], + "identity": { + "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "type": "UserAssigned", + "userAssignedIdentities": { + "key9851": { + "principalId": "6d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "clientId": "7d508e5b-374b-4382-9a1c-01fb8b6cb37c" + } + } + }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, + "tags": { + "key3518": "luvrnuvsgdpbuofdskkcoqhfh" + }, + "location": "westus", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets", + "systemData": { + "createdBy": "rowegentrpoajsv", + "createdByType": "User", + "createdAt": "2024-04-29T21:51:44.043Z", + "lastModifiedBy": "edwuayhhaoepxzisfaqjhmrxjq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-29T21:51:44.043Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus", + "Retry-After": 30 + }, + "body": { + "properties": { + "provisioningState": "Creating", + "spotPriorityProfile": { + "capacity": 0, + "minCapacity": 0, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Https", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "exactVersion": "zjbntmiskjexlr", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "type": "cmeam", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "provisioningState": "Succeeded", + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + }, + "timeCreated": "2024-04-29T21:51:44.043Z" + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "zones": [ + "zone1", + "zone2" + ], + "identity": { + "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "type": "UserAssigned", + "userAssignedIdentities": { + "key9851": { + "principalId": "6d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "clientId": "7d508e5b-374b-4382-9a1c-01fb8b6cb37c" + } + } + }, + "tags": { + "key3518": "luvrnuvsgdpbuofdskkcoqhfh" + }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, + "location": "westus", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets", + "systemData": { + "createdBy": "rowegentrpoajsv", + "createdByType": "User", + "createdAt": "2024-04-29T21:51:44.043Z", + "lastModifiedBy": "edwuayhhaoepxzisfaqjhmrxjq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-29T21:51:44.043Z" + } + } + } + } +} diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_CreateOrUpdate_MinimumSet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_CreateOrUpdate_MinimumSet.json new file mode 100644 index 000000000000..e94c80506873 --- /dev/null +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_CreateOrUpdate_MinimumSet.json @@ -0,0 +1,300 @@ +{ + "title": "Fleets_CreateOrUpdate_MinimumSet", + "operationId": "Fleets_CreateOrUpdate", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet", + "fleetName": "testFleet", + "resource": { + "properties": { + "spotPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_D2s_v3" + }, + { + "name": "Standard_D4s_v3" + }, + { + "name": "Standard_E2s_v3" + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "storageProfile": { + "imageReference": { + "publisher": "canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts-gen2", + "version": "latest" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + } + }, + "osProfile": { + "computerNamePrefix": "prefix", + "adminUsername": "azureuser", + "adminPassword": "TestPassword$0", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "primary": true, + "enableAcceleratedNetworking": false, + "ipConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true + } + } + ], + "networkApiVersion": "2022-07-01" + } + }, + "computeApiVersion": "2023-09-01", + "platformFaultDomainCount": 1 + } + }, + "tags": { + "key": "fleets-test" + }, + "location": "eastus2euap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "spotPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_D2s_v3" + }, + { + "name": "Standard_D4s_v3" + }, + { + "name": "Standard_E2s_v3" + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "storageProfile": { + "imageReference": { + "publisher": "canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts-gen2", + "version": "latest" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + } + }, + "osProfile": { + "computerNamePrefix": "prefix", + "adminUsername": "azureuser", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "primary": true, + "enableAcceleratedNetworking": false, + "ipConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true + } + } + ], + "networkApiVersion": "2022-07-01" + } + }, + "computeApiVersion": "2023-09-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "tags": { + "key": "fleets-test" + }, + "location": "eastus2euap", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus", + "Retry-After": 30 + }, + "body": { + "properties": { + "provisioningState": "Creating", + "spotPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_D2s_v3" + }, + { + "name": "Standard_D4s_v3" + }, + { + "name": "Standard_E2s_v3" + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "storageProfile": { + "imageReference": { + "publisher": "canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts-gen2", + "version": "latest" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + } + }, + "osProfile": { + "computerNamePrefix": "prefix", + "adminUsername": "azureuser", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "primary": true, + "enableAcceleratedNetworking": false, + "ipConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true + } + } + ], + "networkApiVersion": "2022-07-01" + } + }, + "computeApiVersion": "2023-09-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "tags": { + "key": "fleets-test" + }, + "location": "eastus2euap", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets" + } + } + } +} diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_Delete.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_Delete.json new file mode 100644 index 000000000000..18f72eff408a --- /dev/null +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Fleets_Delete", + "operationId": "Fleets_Delete", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet", + "fleetName": "testFleet" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_Get.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_Get.json new file mode 100644 index 000000000000..5d9c7b54d0a9 --- /dev/null +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_Get.json @@ -0,0 +1,405 @@ +{ + "title": "Fleets_Get", + "operationId": "Fleets_Get", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet", + "fleetName": "testFleet" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Creating", + "spotPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "exactVersion": "zjbntmiskjexlr", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "type": "cmeam", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "provisioningState": "Succeeded", + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "mubredelfbshboaxrsxiajihahaa", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + }, + "timeCreated": "2024-04-29T21:51:44.043Z" + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "zones": [ + "zone1", + "zone2" + ], + "identity": { + "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "type": "UserAssigned", + "userAssignedIdentities": { + "key9851": { + "principalId": "6d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "clientId": "7d508e5b-374b-4382-9a1c-01fb8b6cb37c" + } + } + }, + "tags": { + "key3518": "luvrnuvsgdpbuofdskkcoqhfh" + }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, + "location": "westus", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets", + "systemData": { + "createdBy": "rowegentrpoajsv", + "createdByType": "User", + "createdAt": "2024-04-29T21:51:44.043Z", + "lastModifiedBy": "edwuayhhaoepxzisfaqjhmrxjq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-29T21:51:44.043Z" + } + } + } + } +} diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_ListByResourceGroup.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_ListByResourceGroup.json new file mode 100644 index 000000000000..3a834d56d590 --- /dev/null +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_ListByResourceGroup.json @@ -0,0 +1,409 @@ +{ + "title": "Fleets_ListByResourceGroup", + "operationId": "Fleets_ListByResourceGroup", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Creating", + "spotPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "exactVersion": "zjbntmiskjexlr", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "type": "cmeam", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "provisioningState": "Succeeded", + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "mubredelfbshboaxrsxiajihahaa", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + }, + "timeCreated": "2024-04-29T21:51:44.043Z" + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "zones": [ + "zone1", + "zone2" + ], + "identity": { + "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "type": "UserAssigned", + "userAssignedIdentities": { + "key9851": { + "principalId": "6d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "clientId": "7d508e5b-374b-4382-9a1c-01fb8b6cb37c" + } + } + }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, + "tags": { + "key3518": "luvrnuvsgdpbuofdskkcoqhfh" + }, + "location": "westus", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets", + "systemData": { + "createdBy": "rowegentrpoajsv", + "createdByType": "User", + "createdAt": "2024-04-29T21:51:44.043Z", + "lastModifiedBy": "edwuayhhaoepxzisfaqjhmrxjq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-29T21:51:44.043Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_ListBySubscription.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_ListBySubscription.json new file mode 100644 index 000000000000..e93f74bee6b9 --- /dev/null +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_ListBySubscription.json @@ -0,0 +1,408 @@ +{ + "title": "Fleets_ListBySubscription", + "operationId": "Fleets_ListBySubscription", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Creating", + "spotPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "exactVersion": "zjbntmiskjexlr", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "type": "cmeam", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "provisioningState": "Succeeded", + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "mubredelfbshboaxrsxiajihahaa", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + }, + "timeCreated": "2024-04-29T21:51:44.043Z" + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "zones": [ + "zone1", + "zone2" + ], + "identity": { + "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "type": "UserAssigned", + "userAssignedIdentities": { + "key9851": { + "principalId": "6d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "clientId": "7d508e5b-374b-4382-9a1c-01fb8b6cb37c" + } + } + }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, + "tags": { + "key3518": "luvrnuvsgdpbuofdskkcoqhfh" + }, + "location": "westus", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets", + "systemData": { + "createdBy": "rowegentrpoajsv", + "createdByType": "User", + "createdAt": "2024-04-29T21:51:44.043Z", + "lastModifiedBy": "edwuayhhaoepxzisfaqjhmrxjq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-29T21:51:44.043Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_ListVirtualMachineScaleSets.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_ListVirtualMachineScaleSets.json new file mode 100644 index 000000000000..96c7add60f74 --- /dev/null +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_ListVirtualMachineScaleSets.json @@ -0,0 +1,40 @@ +{ + "title": "Fleets_ListVirtualMachineScaleSets", + "operationId": "Fleets_ListVirtualMachineScaleSets", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet", + "name": "myFleet" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myVmss", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/myFleet/virtualMachineScaleSets/myVmss", + "type": "Microsoft.AzureFleet/fleets/virtualMachineScaleSets", + "operationStatus": "Creating", + "error": { + "details": [ + { + "code": "gzhtOverconstrainedAllocationRequestyosk", + "target": "qfthabhrmndhfizfnrwpgxvnokpy", + "message": "Allocation Failed" + } + ], + "innererror": { + "exceptionType": "sfaomfpoaptnbxchrfskm", + "errorDetail": "ihjwbwykq" + }, + "code": "OverconstrainedAllocationRequest", + "target": "nhaj", + "message": "Allocation Failed" + } + } + ] + } + } + } +} diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_Update.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_Update.json new file mode 100644 index 000000000000..73a8f4820114 --- /dev/null +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_Update.json @@ -0,0 +1,767 @@ +{ + "title": "Fleets_Update", + "operationId": "Fleets_Update", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet", + "fleetName": "testFleet", + "properties": { + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": {} + }, + "tags": {}, + "properties": { + "spotPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "adminPassword": "adfbrdxpv", + "customData": "xjjib", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon", + "content": "bubmqbxjkj" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "protectedSettings": {}, + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } + } + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "configurationReference": "ulztmiavpojpbpbddgnuuiimxcpau", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + } + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + } + }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "spotPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}", + "exactVersion": "zjbntmiskjexlr" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + }, + "settings": {}, + "provisioningState": "Succeeded" + }, + "type": "cmeam", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + }, + "timeCreated": "2024-04-29T21:51:44.043Z" + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + }, + "provisioningState": "Creating", + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "zones": [ + "zone1", + "zone2" + ], + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": {}, + "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c" + }, + "tags": {}, + "location": "westus", + "plan": { + "name": "uapfngmdekvpgjhomthtpxjfdmmll", + "publisher": "aqhles", + "product": "bfzbkdnbexmedxdc", + "promotionCode": "gspehogwfjxirz", + "version": "yza" + }, + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets", + "systemData": { + "createdBy": "rowegentrpoajsv", + "createdByType": "User", + "createdAt": "2024-04-29T21:51:44.043Z", + "lastModifiedBy": "edwuayhhaoepxzisfaqjhmrxjq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-29T21:51:44.043Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus", + "Retry-After": 30 + } + } + } +} diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Operations_List.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Operations_List.json new file mode 100644 index 000000000000..8acf291032fe --- /dev/null +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Operations_List.json @@ -0,0 +1,71 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "origin": "user,system", + "name": "Microsoft.AzureFleet/fleets/read", + "isDataAction": false, + "display": { + "provider": "Microsoft Azure Fleet", + "resource": "Fleets", + "operation": "Get Azure Fleet", + "description": "Get properties of Azure Fleet resource" + } + }, + { + "origin": "user,system", + "name": "Microsoft.AzureFleet/fleets/write", + "isDataAction": false, + "display": { + "provider": "Microsoft Azure Fleet", + "resource": "Fleets", + "operation": "Create or Update Azure Fleet", + "description": "Creates a new Azure Fleet resource or updates an existing one" + } + }, + { + "origin": "user,system", + "name": "Microsoft.AzureFleet/fleets/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft Azure Fleet", + "resource": "Fleets", + "operation": "Delete Virtual Machine and Virtual Machine scale sets in a Azure Fleet resource", + "description": "Deletes all compute resources of Azure Fleet resource" + } + }, + { + "origin": "user,system", + "name": "Microsoft.AzureFleet/register/action", + "isDataAction": false, + "display": { + "provider": "Microsoft Azure Fleet", + "resource": "Subscription", + "operation": "Register subscription for Microsoft.AzureFleet", + "description": "Registers Subscription with Microsoft.AzureFleet resource provider" + } + }, + { + "origin": "user,system", + "name": "Microsoft.AzureFleet/unregister/action", + "isDataAction": false, + "display": { + "provider": "Microsoft Azure Fleet", + "resource": "Subscription", + "operation": "Unregister Subscription for Microsoft.AzureFleet", + "description": "Unregisters Subscription with Microsoft.AzureFleet resource provider" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/azurefleet/resource-manager/readme.az.md b/specification/azurefleet/resource-manager/readme.az.md index 0e615e46472b..8b9544c437ef 100644 --- a/specification/azurefleet/resource-manager/readme.az.md +++ b/specification/azurefleet/resource-manager/readme.az.md @@ -15,8 +15,6 @@ python-sdk-output-folder: "$(az-output-folder)/azext_computefleet/vendored_sdks/ # refer to the faq.md for more details ``` - - This is for command modules that already in azure cli main repo. ``` yaml $(az) && $(target-mode) == 'core' az: diff --git a/specification/azurefleet/resource-manager/readme.cli.md b/specification/azurefleet/resource-manager/readme.cli.md index c6cf6ad37ea4..7d1cfb151245 100644 --- a/specification/azurefleet/resource-manager/readme.cli.md +++ b/specification/azurefleet/resource-manager/readme.cli.md @@ -1 +1,11 @@ -## CLI Common Settings for all the command line tools \ No newline at end of file +## CLI Common Settings for all the command line tools + +These settings apply only when `--cli` is specified on the command line. + +``` yaml $(cli) +cli: + cli-name: computefleet + package-name: azure-mgmt-computefleet + namespace: azure.mgmt.computefleet + +``` \ No newline at end of file diff --git a/specification/azurefleet/resource-manager/readme.go.md b/specification/azurefleet/resource-manager/readme.go.md index 309eb944f416..6f1409cb3b18 100644 --- a/specification/azurefleet/resource-manager/readme.go.md +++ b/specification/azurefleet/resource-manager/readme.go.md @@ -8,4 +8,4 @@ license-header: MICROSOFT_MIT_NO_VERSION module-name: sdk/resourcemanager/computefleet/armcomputefleet module: github.com/Azure/azure-sdk-for-go/$(module-name) output-folder: $(go-sdk-folder)/$(module-name) -``` +``` \ No newline at end of file diff --git a/specification/azurefleet/resource-manager/readme.java.md b/specification/azurefleet/resource-manager/readme.java.md new file mode 100644 index 000000000000..6e605c3e6742 --- /dev/null +++ b/specification/azurefleet/resource-manager/readme.java.md @@ -0,0 +1,13 @@ +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=<path to the root directory of your azure-libraries-for-java clone>`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.azurefleet +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/armcomputefleet +``` \ No newline at end of file diff --git a/specification/azurefleet/resource-manager/readme.md b/specification/azurefleet/resource-manager/readme.md index d6726ce99f11..660c328dcf26 100644 --- a/specification/azurefleet/resource-manager/readme.md +++ b/specification/azurefleet/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the computefleet. ```yaml openapi-type: arm -tag: package-preview-2024-05 +tag: package-2024-11-01 suppressions: - code: PatchBodyParametersSchema from: azurefleet.json @@ -44,8 +44,9 @@ suppressions: from: azurefleet.json where: - $.definitions.VirtualMachineScaleSetDataDisk.properties.diskIOPSReadWrite + - $.definitions.AdditionalCapabilities.properties.ultraSSDEnabled reason: Property "diskIOPSReadWrite" does not follow Camel Case and can't be changed as it is being - defined previously in Microsoft.Compute like this. + defined previously in Microsoft.Compute like this. ultraSSDEnabled - SSD doesn't follow camel case. ``` ### Tag: package-preview-2023-11 @@ -66,6 +67,15 @@ input-file: - Microsoft.AzureFleet/preview/2024-05-01-preview/azurefleet.json ``` +### Tag: package-2024-11-01 + +These settings apply only when `--tag=package-2024-11-01` is specified on the command line. + +```yaml $(tag) == 'package-2024-11-01' +input-file: + - Microsoft.AzureFleet/stable/2024-11-01/azurefleet.json +``` + --- # Code Generation @@ -106,3 +116,7 @@ See configuration in [readme.typescript.md](./readme.typescript.md) ## CSharp See configuration in [readme.csharp.md](./readme.csharp.md) + +## Java + +See configuration in [readme.java.md](./readme.java.md) diff --git a/specification/azurefleet/resource-manager/readme.python.md b/specification/azurefleet/resource-manager/readme.python.md index 6f2a97db3a13..38e083bbc4fa 100644 --- a/specification/azurefleet/resource-manager/readme.python.md +++ b/specification/azurefleet/resource-manager/readme.python.md @@ -15,4 +15,4 @@ clear-output-folder: true ``` yaml $(python) no-namespace-folders: true output-folder: $(python-sdks-folder)/computefleet/azure-mgmt-computefleet/azure/mgmt/computefleet -``` +``` \ No newline at end of file diff --git a/specification/azurefleet/resource-manager/sdk-suppressions.yaml b/specification/azurefleet/resource-manager/sdk-suppressions.yaml index 20c674093519..fe3e9fb6ccb1 100644 --- a/specification/azurefleet/resource-manager/sdk-suppressions.yaml +++ b/specification/azurefleet/resource-manager/sdk-suppressions.yaml @@ -3,7 +3,53 @@ suppressions: - package: azure-mgmt-computefleet breaking-changes: - The 'NetworkApiVersion' enum had its value 'ENUM_2020_11_01' deleted or renamed in the current version + - Deleted or renamed enum value `DiskControllerTypes.N_V_ME` + - Deleted or renamed enum value `NetworkApiVersion.ENUM_2020_11_01` + - Deleted or renamed enum value `SecurityEncryptionTypes.DISK_WITH_V_M_GUEST_STATE` + - Deleted or renamed enum value `SecurityEncryptionTypes.NON_PERSISTED_T_P_M` + - Deleted or renamed enum value `SecurityEncryptionTypes.V_M_GUEST_STATE_ONLY` + - Deleted or renamed enum value `SecurityTypes.CONFIDENTIAL_V_M` + - Deleted or renamed enum value `StorageAccountTypes.PREMIUM_L_R_S` + - Deleted or renamed enum value `StorageAccountTypes.PREMIUM_V2_L_R_S` + - Deleted or renamed enum value `StorageAccountTypes.PREMIUM_Z_R_S` + - Deleted or renamed enum value `StorageAccountTypes.STANDARD_L_R_S` + - Deleted or renamed enum value `StorageAccountTypes.STANDARD_S_S_D_L_R_S` + - Deleted or renamed enum value `StorageAccountTypes.STANDARD_S_S_D_Z_R_S` + - Deleted or renamed enum value `StorageAccountTypes.ULTRA_S_S_D_L_R_S` + - Deleted or renamed enum value `WindowsVMGuestPatchMode.AUTOMATIC_BY_O_S` + - Deleted or renamed method `LinuxConfiguration.enable_v_m_agent_platform_updates` + - Deleted or renamed method `LinuxConfiguration.provision_v_m_agent` + - Deleted or renamed method `SpotPriorityProfile.max_price_per_v_m` + - Deleted or renamed method `VMSizeProperties.v_c_p_us_available` + - Deleted or renamed method `VMSizeProperties.v_c_p_us_per_core` + - Deleted or renamed method `VirtualMachineScaleSetDataDisk.disk_i_o_p_s_read_write` + - Deleted or renamed method `VirtualMachineScaleSetDataDisk.disk_size_g_b` + - Deleted or renamed method `VirtualMachineScaleSetIPConfigurationProperties.private_i_p_address_version` + - Deleted or renamed method `VirtualMachineScaleSetIPConfigurationProperties.public_i_p_address_configuration` + - Deleted or renamed method `VirtualMachineScaleSetNetworkConfigurationProperties.enable_i_p_forwarding` + - Deleted or renamed method `VirtualMachineScaleSetOSDisk.disk_size_g_b` + - Deleted or renamed method `VirtualMachineScaleSetPublicIPAddressConfigurationProperties.public_i_p_address_version` + - Deleted or renamed method `VirtualMachineScaleSetPublicIPAddressConfigurationProperties.public_i_p_prefix` + - Deleted or renamed method `WindowsConfiguration.enable_v_m_agent_platform_updates` + - Deleted or renamed method `WindowsConfiguration.provision_v_m_agent` + - Deleted or renamed method `WindowsConfiguration.win_r_m` + - Model `LinuxConfiguration` deleted or renamed its instance variable `enable_v_m_agent_platform_updates` + - Model `LinuxConfiguration` deleted or renamed its instance variable `provision_v_m_agent` + - Model `SpotPriorityProfile` deleted or renamed its instance variable `max_price_per_v_m` + - Model `VMSizeProperties` deleted or renamed its instance variable `v_c_p_us_available` + - Model `VMSizeProperties` deleted or renamed its instance variable `v_c_p_us_per_core` + - Model `VirtualMachineScaleSetDataDisk` deleted or renamed its instance variable `disk_i_o_p_s_read_write` + - Model `VirtualMachineScaleSetDataDisk` deleted or renamed its instance variable `disk_size_g_b` + - Model `VirtualMachineScaleSetIPConfigurationProperties` deleted or renamed its instance variable `private_i_p_address_version` + - Model `VirtualMachineScaleSetIPConfigurationProperties` deleted or renamed its instance variable `public_i_p_address_configuration` + - Model `VirtualMachineScaleSetNetworkConfigurationProperties` deleted or renamed its instance variable `enable_i_p_forwarding` + - Model `VirtualMachineScaleSetOSDisk` deleted or renamed its instance variable `disk_size_g_b` + - Model `VirtualMachineScaleSetPublicIPAddressConfigurationProperties` deleted or renamed its instance variable `public_i_p_address_version` + - Model `VirtualMachineScaleSetPublicIPAddressConfigurationProperties` deleted or renamed its instance variable `public_i_p_prefix` + - Model `WindowsConfiguration` deleted or renamed its instance variable `enable_v_m_agent_platform_updates` + - Model `WindowsConfiguration` deleted or renamed its instance variable `provision_v_m_agent` + - Model `WindowsConfiguration` deleted or renamed its instance variable `win_r_m` azure-sdk-for-go: - package: 'sdk/resourcemanager/computefleet/armcomputefleet' breaking-changes: - - "`NetworkAPIVersion20201101` from enum `NetworkAPIVersion` has been removed" \ No newline at end of file + - "`NetworkAPIVersion20201101` from enum `NetworkAPIVersion` has been removed" From 5878127f088d84da9ca2098030cefdb4953c9ec7 Mon Sep 17 00:00:00 2001 From: steve munk <33468793+stevemunk@users.noreply.github.com> Date: Fri, 4 Oct 2024 16:23:46 -0700 Subject: [PATCH 46/47] Added: Note that sunrise and sunset times not returned when solar day is observed in the requested region (#30860) * Added: Note that the Timezone API does not return sunrise and sunset times when solar day is observed in the requested region. * Added TypeSpecRequirement suppression for timezone v1. --- .../maps/data-plane/Timezone/preview/1.0/timezone.json | 6 +++--- specification/maps/suppressions.yaml | 3 +++ 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/specification/maps/data-plane/Timezone/preview/1.0/timezone.json b/specification/maps/data-plane/Timezone/preview/1.0/timezone.json index a7d0d38b186d..642e4d7264ee 100644 --- a/specification/maps/data-plane/Timezone/preview/1.0/timezone.json +++ b/specification/maps/data-plane/Timezone/preview/1.0/timezone.json @@ -189,7 +189,7 @@ "/timezone/byCoordinates/{format}": { "get": { "summary": "Use to get the current, historical, and future time zone information for the specified latitude-longitude pair.", - "description": "\n\nThe `Get Timezone By Coordinates` API is an HTTP `GET` request that returns current, historical, and future time zone information for a specified latitude-longitude pair. In addition, the API provides sunset and sunrise times for a given location.", + "description": "\n\nThe `Get Timezone By Coordinates` API is an HTTP `GET` request that returns current, historical, and future time zone information for a specified latitude-longitude pair. In addition, the API provides sunset and sunrise times for a given location, with the exception of regions that observe solar days.", "operationId": "Timezone_GetTimezoneByCoordinates", "x-ms-examples": { "Successfully retrieve timezone by coordinates": { @@ -670,13 +670,13 @@ "readOnly": true }, "Sunrise": { - "description": "Sunrise at the given time zone as shown in the `Tag` property. The sunrise is described in the ISO8601 format. (Only be populated if the call is byCoordinates)", + "description": "Sunrise at the given time zone as shown in the `Tag` property, populated only when the call is `byCoordinates`. The sunrise is described in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Note that the Timezone API does not return sunrise and sunset times when solar day is observed in the requested region.", "type": "string", "format": "date-time", "readOnly": true }, "Sunset": { - "description": "Sunset at the given time zone as shown in the `Tag` property. The sunset is described in the ISO8601 format.(Only be populated if the call is byCoordinates)", + "description": "Sunset at the given time zone as shown in the `Tag` property, populated only when the call is `byCoordinates`. The sunset is described in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Note that the Timezone API does not return sunrise and sunset times when solar day is observed in the requested region.", "type": "string", "format": "date-time", "readOnly": true diff --git a/specification/maps/suppressions.yaml b/specification/maps/suppressions.yaml index 499e360ba175..cdffaf7392fd 100644 --- a/specification/maps/suppressions.yaml +++ b/specification/maps/suppressions.yaml @@ -1,3 +1,6 @@ - tool: TypeSpecRequirement path: ./data-plane/Route/preview/1.0/route.json reason: Brownfield service not ready to migrate +- tool: TypeSpecRequirement + path: ./data-plane/Timezone/preview/1.0/timezone.json + reason: Brownfield service not ready to migrate From 2d83740b5808d7f6d0e8839114af4812f6c84b6f Mon Sep 17 00:00:00 2001 From: Shakha Ismatullaeva <shakhzodai@microsoft.com> Date: Fri, 4 Oct 2024 21:14:16 -0700 Subject: [PATCH 47/47] adding IsZoneResilientProvisioningAllowed --- .../BackupShortTermRetentionPolicies.json | 14 +- .../2024-08-01-preview/BlobAuditing.json | 14 +- .../2024-08-01-preview/DatabaseAdvisors.json | 375 +++++++++--------- ...DatabaseEncryptionProtectorRevalidate.json | 9 +- .../DatabaseEncryptionProtectorRevert.json | 7 +- .../DatabaseExtensions.json | 7 +- .../DatabaseOperations.json | 4 +- .../DatabaseRecommendedActions.json | 4 +- ...SqlVulnerabilityAssessmentExecuteScan.json | 7 +- .../DatabaseVulnerabilityAssessmentScans.json | 7 +- .../preview/2024-08-01-preview/Databases.json | 83 +++- .../2024-08-01-preview/DeletedServers.json | 7 +- .../DistributedAvailabilityGroups.json | 35 +- .../2024-08-01-preview/ElasticPools.json | 38 +- .../EncryptionProtectors.json | 14 +- .../2024-08-01-preview/FailoverGroups.json | 35 +- .../InstanceFailoverGroups.json | 40 +- .../2024-08-01-preview/InstancePools.json | 23 +- .../preview/2024-08-01-preview/JobAgents.json | 21 +- .../2024-08-01-preview/JobExecutions.json | 14 +- .../JobPrivateEndpoints.json | 14 +- .../preview/2024-08-01-preview/Jobs.json | 4 +- .../LedgerDigestUploads.json | 22 +- .../LocationCapabilities.json | 5 + .../LongTermRetentionBackups.json | 56 ++- ...ngTermRetentionManagedInstanceBackups.json | 14 +- .../LongTermRetentionPolicies.json | 7 +- .../MaintenanceWindows.json | 16 +- ...nagedBackupShortTermRetentionPolicies.json | 14 +- .../ManagedDatabaseMoveOperations.json | 4 +- ...dDatabaseVulnerabilityAssessmentScans.json | 7 +- .../2024-08-01-preview/ManagedDatabases.json | 57 ++- .../ManagedInstanceAdministrators.json | 14 +- ...tanceAdvancedThreatProtectionSettings.json | 7 +- ...gedInstanceAzureADOnlyAuthentications.json | 14 +- .../ManagedInstanceEncryptionProtectors.json | 14 +- .../ManagedInstanceKeys.json | 14 +- ...agedInstanceLongTermRetentionPolicies.json | 7 +- .../ManagedInstanceOperations.json | 7 +- ...gedInstancePrivateEndpointConnections.json | 14 +- .../ManagedInstanceTdeCertificates.json | 7 +- .../2024-08-01-preview/ManagedInstances.json | 59 ++- .../ManagedLedgerDigestUploads.json | 22 +- ...abaseBackupShortTermRetentionPolicies.json | 14 +- .../ManagedServerDnsAliases.json | 21 +- .../ManagedServerSecurityAlertPolicies.json | 7 +- ...etworkSecurityPerimeterConfigurations.json | 7 +- .../OutboundFirewallRules.json | 14 +- .../PrivateEndpointConnections.json | 14 +- .../RecoverableManagedDatabases.json | 4 +- .../2024-08-01-preview/ReplicationLinks.json | 35 +- .../2024-08-01-preview/RestorePoints.json | 7 +- ...erverAdvancedThreatProtectionSettings.json | 7 +- .../2024-08-01-preview/ServerAdvisors.json | 4 +- .../ServerAzureADAdministrators.json | 14 +- .../ServerAzureADOnlyAuthentications.json | 14 +- .../ServerConnectionPolicies.json | 7 +- .../2024-08-01-preview/ServerDevOpsAudit.json | 7 +- .../2024-08-01-preview/ServerDnsAliases.json | 21 +- .../2024-08-01-preview/ServerKeys.json | 14 +- .../ServerSecurityAlertPolicies.json | 7 +- .../ServerTrustCertificates.json | 20 +- .../2024-08-01-preview/ServerTrustGroups.json | 14 +- .../preview/2024-08-01-preview/Servers.json | 43 +- ...SqlVulnerabilityAssessmentExecuteScan.json | 7 +- .../2024-08-01-preview/SyncAgents.json | 14 +- .../2024-08-01-preview/SyncGroups.json | 28 +- .../2024-08-01-preview/SyncMembers.json | 28 +- .../2024-08-01-preview/TdeCertificates.json | 7 +- .../preview/2024-08-01-preview/TimeZones.json | 4 +- .../TransparentDataEncryptions.json | 7 +- .../2024-08-01-preview/VirtualClusters.json | 21 +- .../VirtualNetworkRules.json | 14 +- .../WorkloadClassifiers.json | 14 +- .../2024-08-01-preview/WorkloadGroups.json | 14 +- ...atabaseSqlVulnerabilityAssessmentScan.json | 4 +- ...tyAssessmentScanRecordsListByDatabase.json | 12 +- .../LocationCapabilityListByLocation.json | 3 +- .../SqlVulnerabilityAssessmentScan.json | 4 +- ...tyAssessmentScanRecordsListByDatabase.json | 12 +- 80 files changed, 1221 insertions(+), 424 deletions(-) diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/BackupShortTermRetentionPolicies.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/BackupShortTermRetentionPolicies.json index 6b91eebd8298..2df2f55b2aad 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/BackupShortTermRetentionPolicies.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/BackupShortTermRetentionPolicies.json @@ -182,7 +182,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -252,7 +257,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/BlobAuditing.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/BlobAuditing.json index ef086b007ff2..f3465350a34e 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/BlobAuditing.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/BlobAuditing.json @@ -151,7 +151,12 @@ } }, "202": { - "description": "Updating the auditing settings is in progress." + "description": "Updating the auditing settings is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -626,7 +631,12 @@ } }, "202": { - "description": "Updating the extended auditing settings is in progress." + "description": "Updating the extended auditing settings is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseAdvisors.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseAdvisors.json index 02a09704752b..9a944f1bf7ba 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseAdvisors.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseAdvisors.json @@ -58,7 +58,10 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 DataWarehouseNotSupported - Automatic tuning is not supported for SQL Data Warehouse.\n\n * 404 DatabaseDoesNotExist - The requested database was not found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SubscriptionDoesNotHaveElasticPool - The requested elastic pool was not found\n\n * 404 AdvisorNotFound - The requested advisor was not found.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 Conflict - Request could not be processed because of conflict in the request.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable." + "description": "*** Error Responses: ***\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 DataWarehouseNotSupported - Automatic tuning is not supported for SQL Data Warehouse.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - The requested database was not found\n\n * 404 SubscriptionDoesNotHaveElasticPool - The requested elastic pool was not found\n\n * 404 AdvisorNotFound - The requested advisor was not found.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 Conflict - Request could not be processed because of conflict in the request.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } } }, "x-ms-examples": { @@ -110,7 +113,10 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 DataWarehouseNotSupported - Automatic tuning is not supported for SQL Data Warehouse.\n\n * 404 DatabaseDoesNotExist - The requested database was not found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SubscriptionDoesNotHaveElasticPool - The requested elastic pool was not found\n\n * 404 AdvisorNotFound - The requested advisor was not found.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 Conflict - Request could not be processed because of conflict in the request.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable." + "description": "*** Error Responses: ***\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 DataWarehouseNotSupported - Automatic tuning is not supported for SQL Data Warehouse.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - The requested database was not found\n\n * 404 SubscriptionDoesNotHaveElasticPool - The requested elastic pool was not found\n\n * 404 AdvisorNotFound - The requested advisor was not found.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 Conflict - Request could not be processed because of conflict in the request.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } } }, "x-ms-examples": { @@ -166,7 +172,10 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 DataWarehouseNotSupported - Automatic tuning is not supported for SQL Data Warehouse.\n\n * 400 InvalidAdvisorUpsertRequest - The update advisor request body does not exist or has no properties object.\n\n * 400 InvalidAdvisorAutoExecuteStatus - Specified auto-execute status for the advisor is not allowed.\n\n * 404 DatabaseDoesNotExist - The requested database was not found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SubscriptionDoesNotHaveElasticPool - The requested elastic pool was not found\n\n * 404 AdvisorNotFound - The requested advisor was not found.\n\n * 404 AutomaticTuningOptionNotFound - The requested automatic tuning option was not found.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 Conflict - Request could not be processed because of conflict in the request.\n\n * 409 DisabledBySystem - This option is disabled by system\n\n * 409 DefaultAdvisorStateNotAllowedInCustomDbMode - DEFAULT advisor state is not allowed in CUSTOM mode\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable." + "description": "*** Error Responses: ***\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 DataWarehouseNotSupported - Automatic tuning is not supported for SQL Data Warehouse.\n\n * 400 InvalidAdvisorUpsertRequest - The update advisor request body does not exist or has no properties object.\n\n * 400 InvalidAdvisorAutoExecuteStatus - Specified auto-execute status for the advisor is not allowed.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - The requested database was not found\n\n * 404 SubscriptionDoesNotHaveElasticPool - The requested elastic pool was not found\n\n * 404 AdvisorNotFound - The requested advisor was not found.\n\n * 404 AutomaticTuningOptionNotFound - The requested automatic tuning option was not found.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 Conflict - Request could not be processed because of conflict in the request.\n\n * 409 DisabledBySystem - This option is disabled by system\n\n * 409 DefaultAdvisorStateNotAllowedInCustomDbMode - DEFAULT advisor state is not allowed in CUSTOM mode\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } } }, "x-ms-examples": { @@ -178,6 +187,32 @@ } }, "definitions": { + "Advisor": { + "description": "Database, Server or Elastic Pool Advisor.", + "type": "object", + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "kind": { + "description": "Resource kind.", + "type": "string", + "readOnly": true + }, + "location": { + "description": "Resource location.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/AdvisorProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, "AdvisorProperties": { "description": "Properties for a Database, Server or Elastic Pool Advisor.", "required": [ @@ -250,6 +285,157 @@ } } }, + "RecommendedAction": { + "description": "Database, Server or Elastic Pool Recommended Action.", + "type": "object", + "properties": { + "kind": { + "description": "Resource kind.", + "type": "string", + "readOnly": true + }, + "location": { + "description": "Resource location.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/RecommendedActionProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + }, + "id": { + "description": "Resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type.", + "type": "string", + "readOnly": true + } + } + }, + "RecommendedActionErrorInfo": { + "description": "Contains error information for an Azure SQL Database, Server or Elastic Pool Recommended Action.", + "type": "object", + "properties": { + "errorCode": { + "description": "Gets the reason why the recommended action was put to error state. e.g., DatabaseHasQdsOff, IndexAlreadyExists", + "type": "string", + "readOnly": true + }, + "isRetryable": { + "description": "Gets whether the error could be ignored and recommended action could be retried. Possible values are: Yes/No", + "enum": [ + "Yes", + "No" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "IsRetryable", + "modelAsString": false + } + } + } + }, + "RecommendedActionImpactRecord": { + "description": "Contains information of estimated or observed impact on various metrics for an Azure SQL Database, Server or Elastic Pool Recommended Action.", + "type": "object", + "properties": { + "dimensionName": { + "description": "Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected.", + "type": "string", + "readOnly": true + }, + "unit": { + "description": "Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected.", + "type": "string", + "readOnly": true + }, + "absoluteValue": { + "format": "double", + "description": "Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected", + "type": "number", + "readOnly": true + }, + "changeValueAbsolute": { + "format": "double", + "description": "Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes", + "type": "number", + "readOnly": true + }, + "changeValueRelative": { + "format": "double", + "description": "Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage", + "type": "number", + "readOnly": true + } + } + }, + "RecommendedActionImplementationInfo": { + "description": "Contains information for manual implementation for an Azure SQL Database, Server or Elastic Pool Recommended Action.", + "type": "object", + "properties": { + "method": { + "description": "Gets the method in which this recommended action can be manually implemented. e.g., TSql, AzurePowerShell.", + "enum": [ + "TSql", + "AzurePowerShell" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ImplementationMethod", + "modelAsString": false + } + }, + "script": { + "description": "Gets the manual implementation script. e.g., T-SQL script that could be executed on the database.", + "type": "string", + "readOnly": true + } + } + }, + "RecommendedActionMetricInfo": { + "description": "Contains time series of various impacted metrics for an Azure SQL Database, Server or Elastic Pool Recommended Action.", + "type": "object", + "properties": { + "metricName": { + "description": "Gets the name of the metric. e.g., CPU, Number of Queries.", + "type": "string", + "readOnly": true + }, + "unit": { + "description": "Gets the unit in which metric is measured. e.g., DTU, Frequency", + "type": "string", + "readOnly": true + }, + "timeGrain": { + "description": "Gets the duration of time interval for the value given by this MetricInfo. e.g., PT1H (1 hour)", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Gets the start time of time interval given by this MetricInfo.", + "type": "string", + "readOnly": true + }, + "value": { + "format": "double", + "description": "Gets the value of the metric in the time interval given by this MetricInfo.", + "type": "number", + "readOnly": true + } + } + }, "RecommendedActionProperties": { "description": "Properties for a Database, Server or Elastic Pool Recommended Action.", "required": [ @@ -406,7 +592,9 @@ "details": { "description": "Gets additional details specific to this recommended action.", "type": "object", - "additionalProperties": true, + "additionalProperties": { + "type": "object" + }, "readOnly": true } } @@ -462,188 +650,21 @@ "readOnly": true } } - }, - "RecommendedActionImplementationInfo": { - "description": "Contains information for manual implementation for an Azure SQL Database, Server or Elastic Pool Recommended Action.", - "type": "object", - "properties": { - "method": { - "description": "Gets the method in which this recommended action can be manually implemented. e.g., TSql, AzurePowerShell.", - "enum": [ - "TSql", - "AzurePowerShell" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "ImplementationMethod", - "modelAsString": false - } - }, - "script": { - "description": "Gets the manual implementation script. e.g., T-SQL script that could be executed on the database.", - "type": "string", - "readOnly": true - } - } - }, - "RecommendedActionErrorInfo": { - "description": "Contains error information for an Azure SQL Database, Server or Elastic Pool Recommended Action.", - "type": "object", - "properties": { - "errorCode": { - "description": "Gets the reason why the recommended action was put to error state. e.g., DatabaseHasQdsOff, IndexAlreadyExists", - "type": "string", - "readOnly": true - }, - "isRetryable": { - "description": "Gets whether the error could be ignored and recommended action could be retried. Possible values are: Yes/No", - "enum": [ - "Yes", - "No" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "IsRetryable", - "modelAsString": false - } - } - } - }, - "RecommendedActionImpactRecord": { - "description": "Contains information of estimated or observed impact on various metrics for an Azure SQL Database, Server or Elastic Pool Recommended Action.", - "type": "object", - "properties": { - "dimensionName": { - "description": "Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected.", - "type": "string", - "readOnly": true - }, - "unit": { - "description": "Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected.", - "type": "string", - "readOnly": true - }, - "absoluteValue": { - "format": "double", - "description": "Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected", - "type": "number", - "readOnly": true - }, - "changeValueAbsolute": { - "format": "double", - "description": "Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes", - "type": "number", - "readOnly": true - }, - "changeValueRelative": { - "format": "double", - "description": "Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage", - "type": "number", - "readOnly": true - } - } - }, - "RecommendedActionMetricInfo": { - "description": "Contains time series of various impacted metrics for an Azure SQL Database, Server or Elastic Pool Recommended Action.", - "type": "object", - "properties": { - "metricName": { - "description": "Gets the name of the metric. e.g., CPU, Number of Queries.", - "type": "string", - "readOnly": true - }, - "unit": { - "description": "Gets the unit in which metric is measured. e.g., DTU, Frequency", - "type": "string", - "readOnly": true - }, - "timeGrain": { - "description": "Gets the duration of time interval for the value given by this MetricInfo. e.g., PT1H (1 hour)", - "type": "string", - "readOnly": true - }, - "startTime": { - "format": "date-time", - "description": "Gets the start time of time interval given by this MetricInfo.", - "type": "string", - "readOnly": true - }, - "value": { - "format": "double", - "description": "Gets the value of the metric in the time interval given by this MetricInfo.", - "type": "number", - "readOnly": true - } - } - }, - "RecommendedAction": { - "description": "Database, Server or Elastic Pool Recommended Action.", - "type": "object", - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "kind": { - "description": "Resource kind.", - "type": "string", - "readOnly": true - }, - "location": { - "description": "Resource location.", - "type": "string", - "readOnly": true - }, - "properties": { - "$ref": "#/definitions/RecommendedActionProperties", - "description": "Resource properties.", - "x-ms-client-flatten": true - } - } - }, - "Advisor": { - "description": "Database, Server or Elastic Pool Advisor.", - "type": "object", - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "kind": { - "description": "Resource kind.", - "type": "string", - "readOnly": true - }, - "location": { - "description": "Resource location.", - "type": "string", - "readOnly": true - }, - "properties": { - "$ref": "#/definitions/AdvisorProperties", - "description": "Resource properties.", - "x-ms-client-flatten": true - } - } } }, "parameters": { - "ServerNameParameter": { - "name": "serverName", + "DatabaseNameParameter": { + "name": "databaseName", "in": "path", - "description": "The name of the server.", + "description": "The name of the database.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, - "DatabaseNameParameter": { - "name": "databaseName", + "ServerNameParameter": { + "name": "serverName", "in": "path", - "description": "The name of the database.", + "description": "The name of the server.", "required": true, "type": "string", "x-ms-parameter-location": "method" diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseEncryptionProtectorRevalidate.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseEncryptionProtectorRevalidate.json index d493d8e8fb9f..b2dd50518dfc 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseEncryptionProtectorRevalidate.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseEncryptionProtectorRevalidate.json @@ -59,13 +59,18 @@ "description": "Successfully revalidated the encryption protector." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service-managed TDE keys are managed by the service. Service-managed TDE keys don't support Create or Update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 DatabaseLevelEncryptionProtectorDoesNotExist - Database-level encryption protector does not exist.\n\n * 400 RevertDatabaseLevelKeyOnlySupportedWithSMK - Database-level encryption protector can only be reverted to the server level encryption when the server is configured with Microsoft Managed Key.\n\n * 400 InvalidEncryptionProtectorName - The encryption protector key name is not supported.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 MissingKeyVaultUriForRestore - Azure Key Vault key URI '{0}' is required to successfully restore the database '{1}' under server '{2}'.\n\n * 400 AzureKeyVaultKeyUsedOnGeoPrimary - The operation could not be completed because the Azure Key Vault Key name {0} is currently set as encryption protector on geo-primary.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 SecurityAzureKeyVaultGeoChainError - Creating secondary of secondary (a process known as chaining) is not supported when enabling Transparent Data Encryption using Azure Key Vault (BYOK).\n\n * 400 PerDatabaseCMKDWNotSupported - Database-level CMK in preview is not supported for Datawarehouse edition.\n\n * 400 BlockSystemAssignedIdentityForCrossTenantCMK - Cross tenant CMK can only be configured when the server is configured with a User Assigned Managed Identity. Refer to https://aka.ms/sqltdebyokumi to configure User Assigned Managed Identity.\n\n * 400 CannotDropDatabaseAKVError - The database {0} on server {1} cannot be safely dropped because it is encrypted with a customer managed key that is no longer accessible to take the last backup before drop. Please restore Azure Key Vault Access on the server and revalidate the keys to make this database accessible and then proceed with the drop. For details see https://aka.ms/tdecmkrestorability\n\n * 400 CreateDatabaseAttemptedWithRotationInProgress - The create database operation can not be performed at this time due to ongoing Transparent Data Encryption (TDE) key rotation on the server. Please try the operation again later.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 PerDatabaseCMKRestoreNotSupported - Database restore is not supported when Database-level CMK is configured in preview.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 PerDatabaseCMKHSNotSupported - Database-level CMK in preview is not supported for Hyperscale edition.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 CMKOperationNotAllowed - User tried to perform an operation on the server when the server did not have Azure Key Vault Access.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 AzureKeyVaultKeyNameCurrentlyInUse - The operation could not be completed because the Azure Key Vault Key name {0} is currently in use.\n\n * 400 AzureKeyVaultKeyThumbprintIsDifferent - The operation could not be completed because the Azure Key Vault Key material is different than the current encryption protector key.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 OldGenerationOfAKVKeyBeingUsedError - Using an old version of AKV key as TDE protector is not allowed. Please use the latest version of the AKV key as the encryption protector\n\n * 400 PerDatabaseCMKMissingIdentityOnGeoSecondaryDatabase - Per Database CMK identity not setup on the target database.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 ManagementServiceManagedServerDisabled - Operation failed since Managed Instance '{0}' is disabled. Please enable Managed Instance and try again.\n\n * 400 MiGeoRestoreWithWrongBackupStorageRedundancy - Geo-Restore is not allowed for managed instances with LRS/ZRS backup storage redundancy.\n\n * 400 LastBackupNameHasNewline - Please do not use forbidden characters ('\\n', '\\r') in lastBackupName.\n\n * 400 LastBackupNameHasNonAsciiCharacter - The operation was aborted because the 'LastBackupName' parameter contains invalid characters. Only ASCII characters are allowed.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled.\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 UpdatingInstanceAndBackupRedundancy - Instance zone redundancy and backup storage redundancy cannot be updated in the same request.\n\n * 400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled.\n\n * 400 RequestCantLandOnPaaSv2Platform - Request needs to land on PaaSv2 platform but PaaSv2 is not enabled.\n\n * 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.\n\n * 400 DeleteOfVersion2VirtualClusterIsDisabled - Delete of virtual cluster with version 2 is not enabled.\n\n * 400 DeleteOfVirtualClusterIsDisabled - Delete of virtual cluster is not enabled.\n\n * 400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool.\n\n * 400 DnsRefreshOnVirtualClusterIsDisabled - Refresh of DNS records on virtual cluster is not enabled.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ServerKeyNotFound - The requested server key was not found on the current subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 EncryptionProtectorChangeInProgress - Cannot update database encryption key protector while protector change is already in progress\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 MiCreateFailedNonDelegatedSubnet - User tried to deploy Managed Instance or Managed Instance pool in subnet that is not delegated to Microsoft.Sql/managedInstances.\n\n * 409 ConflictingManagedInstanceOperation - An operation is currently in progress for the managed instance.\n\n * 409 BackupRedundancyUpdateAndInstanceRedundancyConflict - The instance is multi-az but backup storage is being updated from zone redundant to non-zone redundant.\n\n * 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress - Cannot update instance redundancy because backup storage redundancy update is in progress.\n\n * 409 InstanceRedundancyUpdateAndBackupRedundancyConflict - The backup storage is non-zone redundant but instance redundancy is being updated to zone redundant.\n\n * 409 BackupRedundancyUpdateConflict - Cannot update backup storage redundancy because a backup storage redundancy update is already in progress.\n\n * 409 MiDropFailedOnAuthLocks - User tried to drop last Managed Instance in subnet that has Lock applied on resource(s).\n\n * 412 InstanceNotReadyForBackupRedundancyUpdate - Cannot update backup storage redundancy because the instance is not ready.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service-managed TDE keys are managed by the service. Service-managed TDE keys don't support Create or Update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 DatabaseLevelEncryptionProtectorDoesNotExist - Database-level encryption protector does not exist.\n\n * 400 RevertDatabaseLevelKeyOnlySupportedWithSMK - Database-level encryption protector can only be reverted to the server level encryption when the server is configured with Microsoft Managed Key.\n\n * 400 InvalidEncryptionProtectorName - The encryption protector key name is not supported.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 MissingKeyVaultUriForRestore - Azure Key Vault key URI '{0}' is required to successfully restore the database '{1}' under server '{2}'.\n\n * 400 AzureKeyVaultKeyUsedOnGeoPrimary - The operation could not be completed because the Azure Key Vault Key name {0} is currently set as encryption protector on geo-primary.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 SecurityAzureKeyVaultGeoChainError - Creating secondary of secondary (a process known as chaining) is not supported when enabling Transparent Data Encryption using Azure Key Vault (BYOK).\n\n * 400 PerDatabaseCMKDWNotSupported - Database-level CMK in preview is not supported for Datawarehouse edition.\n\n * 400 BlockSystemAssignedIdentityForCrossTenantCMK - Cross tenant CMK can only be configured when the server is configured with a User Assigned Managed Identity. Refer to https://aka.ms/sqltdebyokumi to configure User Assigned Managed Identity.\n\n * 400 CannotDropDatabaseAKVError - The database {0} on server {1} cannot be safely dropped because it is encrypted with a customer managed key that is no longer accessible to take the last backup before drop. Please restore Azure Key Vault Access on the server and revalidate the keys to make this database accessible and then proceed with the drop. For details see https://aka.ms/tdecmkrestorability\n\n * 400 CreateDatabaseAttemptedWithRotationInProgress - The create database operation can not be performed at this time due to ongoing Transparent Data Encryption (TDE) key rotation on the server. Please try the operation again later.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 PerDatabaseCMKRestoreNotSupported - Database restore is not supported when Database-level CMK is configured in preview.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 PerDatabaseCMKHSNotSupported - Database-level CMK in preview is not supported for Hyperscale edition.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 CMKOperationNotAllowed - User tried to perform an operation on the server when the server did not have Azure Key Vault Access.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 AzureKeyVaultKeyNameCurrentlyInUse - The operation could not be completed because the Azure Key Vault Key name {0} is currently in use.\n\n * 400 AzureKeyVaultKeyThumbprintIsDifferent - The operation could not be completed because the Azure Key Vault Key material is different than the current encryption protector key.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 OldGenerationOfAKVKeyBeingUsedError - Using an old version of AKV key as TDE protector is not allowed. Please use the latest version of the AKV key as the encryption protector\n\n * 400 PerDatabaseCMKMissingIdentityOnGeoSecondaryDatabase - Per Database CMK identity not setup on the target database.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 ManagementServiceManagedServerDisabled - Operation failed since Managed Instance '{0}' is disabled. Please enable Managed Instance and try again.\n\n * 400 MiGeoRestoreWithWrongBackupStorageRedundancy - Geo-Restore is not allowed for managed instances with LRS/ZRS backup storage redundancy.\n\n * 400 LastBackupNameHasNewline - Please do not use forbidden characters ('\\n', '\\r') in lastBackupName.\n\n * 400 LastBackupNameHasNonAsciiCharacter - The operation was aborted because the 'LastBackupName' parameter contains invalid characters. Only ASCII characters are allowed.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 LRSCutoverDatabaseDoesNotExist - The operation was aborted because the database name specified in the request doesn't match any database name on the specified server.\n\n * 400 LRSCutoverDatabaseNotInRestoringState - The operation was aborted because the specified database is not in restoring state.\n\n * 400 LRSCutoverDatabaseAlreadyRestored - The operation was aborted because the specified database was already restored.\n\n * 400 LRSCutoverAlreadyInitiated - The operation was aborted because a cutover for the specified database is already in progress.\n\n * 400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled.\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 UpdatingInstanceAndBackupRedundancy - Instance zone redundancy and backup storage redundancy cannot be updated in the same request.\n\n * 400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled.\n\n * 400 RequestCantLandOnPaaSv2Platform - Request needs to land on PaaSv2 platform but PaaSv2 is not enabled.\n\n * 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.\n\n * 400 DeleteOfVersion2VirtualClusterIsDisabled - Delete of virtual cluster with version 2 is not enabled.\n\n * 400 DeleteOfVirtualClusterIsDisabled - Delete of virtual cluster is not enabled.\n\n * 400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool.\n\n * 400 DnsRefreshOnVirtualClusterIsDisabled - Refresh of DNS records on virtual cluster is not enabled.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ServerKeyNotFound - The requested server key was not found on the current subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 EncryptionProtectorChangeInProgress - Cannot update database encryption key protector while protector change is already in progress\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 MiCreateFailedNonDelegatedSubnet - User tried to deploy Managed Instance or Managed Instance pool in subnet that is not delegated to Microsoft.Sql/managedInstances.\n\n * 409 ConflictingManagedInstanceOperation - An operation is currently in progress for the managed instance.\n\n * 409 BackupRedundancyUpdateAndInstanceRedundancyConflict - The instance is multi-az but backup storage is being updated from zone redundant to non-zone redundant.\n\n * 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress - Cannot update instance redundancy because backup storage redundancy update is in progress.\n\n * 409 InstanceRedundancyUpdateAndBackupRedundancyConflict - The backup storage is non-zone redundant but instance redundancy is being updated to zone redundant.\n\n * 409 BackupRedundancyUpdateConflict - Cannot update backup storage redundancy because a backup storage redundancy update is already in progress.\n\n * 409 MiDropFailedOnAuthLocks - User tried to drop last Managed Instance in subnet that has Lock applied on resource(s).\n\n * 412 InstanceNotReadyForBackupRedundancyUpdate - Cannot update backup storage redundancy because the instance is not ready.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseEncryptionProtectorRevert.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseEncryptionProtectorRevert.json index 95872ee5f9cf..2edb94fdce6a 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseEncryptionProtectorRevert.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseEncryptionProtectorRevert.json @@ -65,7 +65,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseExtensions.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseExtensions.json index bdf9f1582653..cf64e0f8b88a 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseExtensions.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseExtensions.json @@ -163,7 +163,12 @@ } }, "202": { - "description": "Import/Export operation is in progress." + "description": "Import/Export operation is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseOperations.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseOperations.json index 239c7d185ce0..e389d6c83979 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseOperations.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseOperations.json @@ -69,7 +69,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 SourceDatabaseEncryptionProtectorKeyUriRequiredForPerDatabaseCMKCopyOrReplication - Geo secondary database missing AKV of geo primary database\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 CannotUpdateIsLedgerDatabase - The ledger property of an existing database cannot be updated.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 InvalidDatabaseCreateMode - Invalid request to create a database.\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 PartnerDBNotCompatibleForSGXEnclave - Attempt to set GeoDR link or update SLO for enclave enabled database is only supported when both database are running on DC-series hardware.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 TierChangeUnsupportedDueToCDCEnabledDatabase - The database cannot update its sku because it is enabled for CDC.\n\n * 400 IsLedgerDatabaseIsNotSupportedOnResourceType - Changing the ledger property is not supported for this resource type.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 UnableToCreateGeoChain - User attempted to create secondary database (chaining) even though automatic upload of ledger digests has been configured\n\n * 400 TargetElasticPoolDoesNotExist - The elastic pool does not exist on a server.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 ElasticPoolNameRequired - User tried to create or update database to elastic pool service objective without specifying the name of the elastic pool.\n\n * 400 InvalidReadScaleEdition - User attempted to enable read scale on a database type that does not support it.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 GeoSecondaryMaxSizeUpdateFailed - The geo-secondary database is of a SLO that does not support the requested maxsize value or the geo-secondary is in an unsupported region or an update operation is already in progress on the geo-secondary database.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 RequestedDatabaseSizeRequiresShrink - User attempted to ALTER DATABASE MODIFY MAXSIZE to modify the MAXSIZE for a database to a smaller size then the current size.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 CurrentDatabaseSizeExceedsDbMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 DatabaseNameInUse - Database already exists. Choose a different database name.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 SecurityAzureKeyVaultGeoChainError - Creating secondary of secondary (a process known as chaining) is not supported when enabling Transparent Data Encryption using Azure Key Vault (BYOK).\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 UnsupportedCapacity - User tried to create or update database with capacity which is not supported.\n\n * 400 RestoreToFreeEditionNotSupported - Restore and GeoRestore target cannot be free database.\n\n * 400 RestoreNotSupportedForFreeEdition - Restore and GeoRestore are not supported for free database.\n\n * 400 InvalidDroppedDatabase - Source database dropped does not exist on server within the supported recovery period.\n\n * 400 InvalidLiveDatabase - Source database does not exist on server within the supported recovery period. If restoring a dropped database, please specify its deletion date.\n\n * 400 InvalidVldbRecoverySlo - The Hyperscale edition recovery requires both source and target databases to use Hyperscale service level objective.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 InvalidVldbRestoreSlo - The Hyperscale edition Point-In-Time restore requires both source and target databases to use Hyperscale service level objective.\n\n * 400 CannotSpecifyPoolOrSlo - Specifying an elastic pool and/or changing the service level objective or edition is not supported for edition.\n\n * 400 InvalidBackupStorageAccountType - User passed zrs/lrs during create/update of a database but it failed either because the customer is not whitelisted or because zrs is not available in the specified region.\n\n * 400 DatabaseInvalidSkuPropertyCombination - The properties of the requested sku are inconsistent. Please check that a valid combination is specified. See https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability for more details.\n\n * 400 DatabaseNamedReplicaPerDatabaseLimitExceeded - User tried create a named replica that would exceed the allowed number per primary database\n\n * 400 UnsupportedBackupStorageRedundancyForEdition - The requested backup storage redundancy is not supported for edition\n\n * 400 DatabaseIsCurrentlyPinned - Microsoft has pinned your database SQL Server engine version. To ensure your database does not hit production issues, any future scale operations on your database will be blocked until it has been un-pinned. Please contact Microsoft support for assistance with scaling.\n\n * 400 RestoreTargetEditionSizeInsufficient - User attempted to restore a database to an edition that is a smaller size than the current allocated size of the source.\n\n * 400 DatabaseCreationBlockedForNonActivatedCMKServer - SQL Pool creations are blocked for CMK enabled workspaces until the workspace is activated. First, enable purge protection and grant the workspace Managed Identity the required permissions (Get, Wrap Key, Unwrap Key) on the Azure Key Vault of the workspace key. Next, activate your workspace after you have granted access.\n\n * 400 InvalidIdentityId - One or more identity id(s) provided are not valid ARM resource id(s). Please input valid id(s) and try again.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 InvalidNumberOfIdentities - Only one user assigned managed identity is supported at the Database Level.\n\n * 400 NoRestorePointAvailable - The source database has not yet accomplished its first backup in order to support restore operations. Please retry the restore request later.\n\n * 400 DatabaseNamedReplicaChainingNotAllowed - User tried to create a named replica of a named replica which is not allowed.\n\n * 400 DatabaseNamedReplicaInvalidOperation - User attempted an unsupported operation on a named replica.\n\n * 400 DatabaseNamedReplicaInvalidSourceDatabase - User attempted to create a named replica in a different subscription or region than the source database.\n\n * 400 DatabaseNamedReplicaSourceDatabaseNotZoneRedundant - Zone Redundancy cannot be enabled on this Named Replica since the primary Hyperscale Database is not zone redundant.\n\n * 400 CannotAssignIdentityToMaster - Cannot assign an identity to a system database. Database identity cannot be assigned to 'master', 'model', 'tempdb', 'msdb', or 'resource' databases.\n\n * 400 PerDatabaseCMKDWNotSupported - Database-level CMK in preview is not supported for Datawarehouse edition.\n\n * 400 MissingThumbprintCrm - The restore operation of a CRM database failed because a required TDE certificate was missing. Please retry the restore operation to an existing elastic pool.\n\n * 400 ElasticPoolOverStorage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 RestoreTargetEditionSizeInsufficientV2 - User attempted to restore a database to an edition that is a smaller size than the allocated size of the restored database.\n\n * 400 ResourcePoolStorageLimitHitDuringRestore - The restored database can't be restored into the resource pool due to the remaining storage capacity in the pool.\n\n * 400 PerDatabaseCMKRestoreNotSupported - Database restore is not supported when Database-level CMK is configured in preview.\n\n * 400 PerDatabaseCMKHSNotSupported - Database-level CMK in preview is not supported for Hyperscale edition.\n\n * 400 PerDatabaseCMKGeoReplicationNotSupported - Geo Replication and Database Copy is not supported when Database-level CMK is configured in preview.\n\n * 400 InvalidStandbyGeoEdition - User attempted to create a DTU based standby geo.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 GeoRestoreBackupStorageTypeNotSupported - Database recovery requests are invalid when issued against a database that is not configured to use geo-redundant backup storage.\n\n * 400 RestoreHyperscaleToNonHyperscale - Restoring a Hyperscale database backup to a non-Hyperscale service tier or vice versa is not supported.\n\n * 400 SubscriptionDoesNotHaveAccessToServer - The subscription does not have access to the specified server(s)\n\n * 400 RecoveryPointDoesNotExist - The specified recovery point either does not exist or is not valid.\n\n * 400 LtrBackupNotFound - The specified long term retention backup does not exist.\n\n * 400 InvalidPointInTime - The specified point in time is not valid for the database.\n\n * 400 GeoRestoreCannotResolveTargetCluster - Cannot resolve target cluster for server\n\n * 400 CannotSpecifyEditionOrSloWhenRestoringToPool - Specifying the target service level objective or edition is not supported when restoring to an elastic pool.\n\n * 400 RestoreNotSupportedForGeoDrSecondary - Point-in-time restore and database recovery operations are not supported on databases that are currently configured as geo-secondaries.\n\n * 400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported - User attempted configuring backup retention policy on a Named Replica.\n\n * 400 GeoRedundantBackupsNotPermittedForSubscription - Geo-redundant backup storage is blocked for all databases under subscription '{0}' by preview feature 'Azure SQL Database Block Geo-redundant Backup Storage'. Please select a different backup storage redundancy.\n\n * 400 RestoreHyperscaleToNonHyperscaleElasticPool - Restoring a Hyperscale database to an elastic pool which is not Hyperscale or restoring a database which is not Hyperscale to a Hyperscale elastic pool is not supported.\n\n * 400 RestoreIneligibleDatabaseName - The specified target database name, '{0}', is reserved and cannot be used in a restore operation.\n\n * 400 RestoreNotSupportedForSystemDb - Restore and database recovery are not supported for system databases.\n\n * 400 RestoreIneligibleDroppedDatabaseShortLifespan - The source database, '{0}', dropped on '{1}', has not existed long enough to support restores.\n\n * 400 RestoreIneligibleLiveDatabaseShortLifespan - The source database, '{0}', has not yet accomplished its first backup in order to support restore operations. Please wait until at least the indicated earliest restore date '{1}' and resubmit the request.\n\n * 400 RestoreCrossServerDisabled - For point-in-time restores, the target logical server must be the same as the source logical server. Consider restoring to the source database's server, or using database copy or database recovery.\n\n * 400 RestoreSameServerRecoveryDisabled - Same-server recovery is currently not supported. Consider using point-in-time restore or recovering to a different server.\n\n * 400 RestoreNotSupportedFromLtrBackupToEdition - Restore from long-term retention backup to '{0}' edition not supported.\n\n * 400 RestoreNotSupportedFromExternalBackupToEdition - Restore from external backup to '{0}' edition not supported.\n\n * 400 UpdateToServerlessIfLtrIsNotDisabled - Enabling auto-pause for a serverless database is not supported if long-term backup retention is enabled.\n\n * 400 DuplicateRestoreOperation - A restore request with the same target database name '{0}' on server '{1}' already exists.\n\n * 400 ExternalBackupUriMalformed - The external backup storage container URI is malformed.\n\n * 400 ExternalBackupUriHostNotAllowed - The host name for the external backup storage container URI is not allowed.\n\n * 400 ExternalBackupUriInvalidSchemeOrPort - The external backup storage container URI uses an invalid scheme or port. Please use https and port 443.\n\n * 400 ExternalBackupVldbUnsupported - Hyperscale does not support external backup restore requests.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 InvalidPitrPriorToVldbMigration - For database '{0}', specified point-in-time '{1}' is prior to the Hyperscale migration time of '{2}'. Please specify a target edition or service level objective which is not Hyperscale when restoring to a point earlier than the Hyperscale migration.\n\n * 400 MissingKeyVaultUriForRestore - Azure Key Vault key URI '{0}' is required to successfully restore the database '{1}' under server '{2}'.\n\n * 400 BlockRestoreOnVldbGeoSecondary - Restore of Hyperscale database where source database is geo-secondary is not allowed.\n\n * 400 BackupSetNotFound - No backups were found to restore the database. Please contact support to restore the database.\n\n * 400 IncorrectAccessToAzureKeyVault - Target server does not have access to all AKV Uris created during the backup time.\n\n * 400 RestoreFailureSqlInstanceUnhealthy - Unable to connect to the instance in order to perform restore operation.\n\n * 400 BackupSetBroken - Backup set is broken.\n\n * 400 TimeoutDuringRestore - A timeout was encountered while trying to connect to the restore target.\n\n * 400 BrokenRestorePlanGapInLogBackups - The restore plan is broken because firstLsn of current log backup is not equal to lastLsn of prev log backup.\n\n * 400 FullBackupMissingChecksum - Provided full backup is missing checksum.\n\n * 400 RequiredBackupIsNotLastRestored - Migration cannot be completed because provided backup file name is not the name of the last backup file that is restored.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineDataFilesExist - Database backup contains incompatible physical layout. Non-online data files exist.\n\n * 400 IncompatiblePhysicalLayoutWrongNumberOfLogFiles - Database backup contains incompatible physical layout. Multiple log files are not supported.\n\n * 400 BackupSetNotFoundRecentPit - No backups were found to restore the database to the specified point in time. Please retry the operation. If the problem persists, contact support to restore the database.\n\n * 400 InvalidPublicMaintenanceConfiguration - User tried to specify public maintenance configuration which cannot be converted to internal id (malformed or wrong region).\n\n * 400 MaintenanceWindowNotSupportedForNamedReplica - User tried to create or update named replica with non-default maintenance window which is not supported.\n\n * 400 InvalidStandbyGeoReadScale - User attempted to enable read scale on a standby geo database that does not support it.\n\n * 400 PerDatabaseCMKKeyRotationAttemptedWhileOldThumbprintInUse - Key Rotation for the TDE Protector at the database level is blocked when active transactions are holding up the log encrypted with old keys. Please refer to aka.ms/azuresqldbkeyrotation for possible strategies to workaround this issue.\n\n * 400 PerDBCMKNotSupportedWithLTR - Database-level CMK is not supported when Long-term Backup Retention is enabled on the database.\n\n * 400 VBSEnclaveNotSupportedForDW - The preferredEnclaveType is not supported for dedicated SQL Pools.\n\n * 400 VBSEnclaveNotSupportedForDCSeriesSLO - Configuring the 'VBS' preferredEnclaveType for databases using the DC-series hardware configuration is not supported. DC-series databases are pre-configured with Intel SGX enclaves. Virtualization based security (VBS) enclaves are not supported.\n\n * 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutDatabaseLevelEncryptionProtector - Database-level encryption protector must be set on the target database while attempting to copy or replicate a database encrypted with a database level key.\n\n * 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeys - While attempting to replicate a database configured with database level encryption protector, the current keys being used by the primary must be passed to the secondary database.\n\n * 400 PerDatabaseCMKGeoPrimaryIsNotConfiguredWithDatabaseLevelEncryptionProtector - The geo-primary database must be configured with a database level encryption protector before setting a database level encryption protector on the geo-secondary.\n\n * 400 ElasticJobsNotSupportedOnAutoPauseEnabledDatabase - Auto-pause enabled serverless database is not supported as an Elastic Jobs database because job agent would prevent that database from pausing. You can either disable auto-pause on this serverless database or delete the job agent that is using this database. See here for more details: https://docs.microsoft.com/azure/azure-sql/database/serverless-tier-overview#auto-pausing\n\n * 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave - Configuring geo-replication is not supported for databases using different values of the preferredEnclaveType property. The primary '{0}' database on the '{1}' server uses the '{2}' preferredEnclaveType, whereas the specified preferredEnclaveType for the secondary '{3}' database on the '{4}' server is '{5}'.\n\n * 400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes - Planned failover between primary and secondary database with different preferredEnclaveType is not supported for Virtualization-based security (VBS) enclaves.\n\n * 400 PerDatabaseCMKGeoPrimaryIsConfiguredWithDatabaseLevelEncryptionProtector - The geo-primary database must not be configured with a database level encryption protector when failing over to a geo-secondary without a database level encryption protector.\n\n * 400 CreateDatabaseAttemptedWithRotationInProgress - The create database operation can not be performed at this time due to ongoing Transparent Data Encryption (TDE) key rotation on the server. Please try the operation again later.\n\n * 400 VBSEnclaveResourcePoolInvalidCombination - Adding a database with '{0}' preferredEnclaveType to an elastic pool '{1}' with '{2}' preferredEnclaveType is not supported. \nBefore adding the database to the elastic pool, ensure that the preferredEnclaveType is the same for both the database and the elastic pool. More information can be found on https://aka.ms/AlwaysEncryptedEnableSecureEnclaves\n\n * 400 MissingAsymmetricKeyOnTargetServer - Target server does not have access to an asymmetric key.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MultipleDroppedDatabasesWithTheSameName - Found multiple dropped databases with the same name on server.\n\n * 400 AzureKeyVaultClientError - The Azure Key Vault client encountered an error.\n\n * 400 AzureKeyVaultClientInfoError - An error occurred while obtaining information for the Azure Key Vault client.\n\n * 400 AzureKeyVaultKeyThumbprintIsDifferent - The operation could not be completed because the Azure Key Vault Key material is different than the current encryption protector key.\n\n * 400 UnsupportedBackupStorageRedundancy - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 LTRSterlingToVldbMigrationNotSupported - Cannot change service objective for database to Hyperscale as long-term retention is not yet supported on Hyperscale. Please disable long-term retention on the database and retry.\n\n * 400 HyperscaleReverseMigrationNotSupported - Reverse migration of a Hyperscale database to Sterling hit an unsupported scenario.\n\n * 400 UpdateSloOperationIdDoesNotExist - The action failed because no active update-slo operation detected for server: {0}, database: {1};. Please retry the operation by specifying valid parameters.\n\n * 400 ManualCutoverUnsupported - Invalid use of manual-cutover option. Please check current and requested service objective and retry the operation by specifying valid parameters.\n\n * 400 LedgerNoDropPrimary - The Geo-primary database cannot be dropped because the database has Ledger Digest Uploads enabled. Disable Ledger Digest Uploads and retry the operation.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 CannotDropDatabaseAKVError - The database {0} on server {1} cannot be safely dropped because it is encrypted with a customer managed key that is no longer accessible to take the last backup before drop. Please restore Azure Key Vault Access on the server and revalidate the keys to make this database accessible and then proceed with the drop. For details see https://aka.ms/tdecmkrestorability\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 FreeDbAlreadyExists - Only one free database can exist for a subscription per region.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 UpdateSloFailedDatabaseTooBusy - Update SLO operation could not complete because database was too busy.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 TargetElasticPoolBeingUpdated - The update of elastic pool cannot be started because there is copy operation in progress for one of the databases in this elastic pool\n\n * 409 DatabaseCopyLimitPerReplicaReached - User reached the limit of concurrent database copies.\n\n * 409 ConflictRequestToUpdateBackupRedundancy - A conflict request to change backup storage redundancy is still in progress.\n\n * 409 DatabaseElasticPoolMaintenanceConflict - User tried to create or update a database with a specified maintenance configuration that conflicted with that of the elastic pool of the database.\n\n * 409 SubscriptionVcoreQuotaExceeded - Could not perform the operation because subscription would exceed the allowed vCore quota.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UnsupportedBackupStorageRedundancy - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 BackupSetNotFoundRecentPit - No backups were found to restore the database to the specified point in time. Please retry the operation. If the problem persists, contact support to restore the database.\n\n * 400 CannotUpdateIsLedgerDatabase - The ledger property of an existing database cannot be updated.\n\n * 400 LTRSterlingToVldbMigrationNotSupported - Cannot change service objective for database to Hyperscale as long-term retention is not yet supported on Hyperscale. Please disable long-term retention on the database and retry.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 InvalidPublicMaintenanceConfiguration - User tried to specify public maintenance configuration which cannot be converted to internal id (malformed or wrong region).\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 MaintenanceWindowNotSupportedForNamedReplica - User tried to create or update named replica with non-default maintenance window which is not supported.\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 InvalidStandbyGeoReadScale - User attempted to enable read scale on a standby geo database that does not support it.\n\n * 400 PerDatabaseCMKKeyRotationAttemptedWhileOldThumbprintInUse - Key Rotation for the TDE Protector at the database level is blocked when active transactions are holding up the log encrypted with old keys. Please refer to aka.ms/azuresqldbkeyrotation for possible strategies to workaround this issue.\n\n * 400 TierChangeUnsupportedDueToCDCEnabledDatabase - The database cannot update its sku because it is enabled for CDC.\n\n * 400 PerDBCMKNotSupportedWithLTR - Database-level CMK is not supported when Long-term Backup Retention is enabled on the database.\n\n * 400 VBSEnclaveNotSupportedForDW - The preferredEnclaveType is not supported for dedicated SQL Pools.\n\n * 400 VBSEnclaveNotSupportedForDCSeriesSLO - Configuring the 'VBS' preferredEnclaveType for databases using the DC-series hardware configuration is not supported. DC-series databases are pre-configured with Intel SGX enclaves. Virtualization based security (VBS) enclaves are not supported.\n\n * 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutDatabaseLevelEncryptionProtector - Database-level encryption protector must be set on the target database while attempting to copy or replicate a database encrypted with a database level key.\n\n * 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeys - While attempting to replicate a database configured with database level encryption protector, the current keys being used by the primary must be passed to the secondary database.\n\n * 400 PartnerDBNotCompatibleForSGXEnclave - Attempt to set GeoDR link or update SLO for enclave enabled database is only supported when both database are running on DC-series hardware.\n\n * 400 PerDatabaseCMKGeoPrimaryIsNotConfiguredWithDatabaseLevelEncryptionProtector - The geo-primary database must be configured with a database level encryption protector before setting a database level encryption protector on the geo-secondary.\n\n * 400 ElasticJobsNotSupportedOnAutoPauseEnabledDatabase - Auto-pause enabled serverless database is not supported as an Elastic Jobs database because job agent would prevent that database from pausing. You can either disable auto-pause on this serverless database or delete the job agent that is using this database. See here for more details: https://docs.microsoft.com/azure/azure-sql/database/serverless-tier-overview#auto-pausing\n\n * 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave - Configuring geo-replication is not supported for databases using different values of the preferredEnclaveType property. The primary '{0}' database on the '{1}' server uses the '{2}' preferredEnclaveType, whereas the specified preferredEnclaveType for the secondary '{3}' database on the '{4}' server is '{5}'.\n\n * 400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes - Planned failover between primary and secondary database with different preferredEnclaveType is not supported for Virtualization-based security (VBS) enclaves.\n\n * 400 PerDatabaseCMKGeoPrimaryIsConfiguredWithDatabaseLevelEncryptionProtector - The geo-primary database must not be configured with a database level encryption protector when failing over to a geo-secondary without a database level encryption protector.\n\n * 400 CreateDatabaseAttemptedWithRotationInProgress - The create database operation can not be performed at this time due to ongoing Transparent Data Encryption (TDE) key rotation on the server. Please try the operation again later.\n\n * 400 VBSEnclaveResourcePoolInvalidCombination - Adding a database with '{0}' preferredEnclaveType to an elastic pool '{1}' with '{2}' preferredEnclaveType is not supported. \nBefore adding the database to the elastic pool, ensure that the preferredEnclaveType is the same for both the database and the elastic pool. More information can be found on https://aka.ms/AlwaysEncryptedEnableSecureEnclaves\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 InvalidDatabaseCreateMode - Invalid request to create a database.\n\n * 400 MissingAsymmetricKeyOnTargetServer - Target server does not have access to an asymmetric key.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MultipleDroppedDatabasesWithTheSameName - Found multiple dropped databases with the same name on server.\n\n * 400 AzureKeyVaultClientError - The Azure Key Vault client encountered an error.\n\n * 400 AzureKeyVaultClientInfoError - An error occurred while obtaining information for the Azure Key Vault client.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 AzureKeyVaultKeyThumbprintIsDifferent - The operation could not be completed because the Azure Key Vault Key material is different than the current encryption protector key.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 HyperscaleReverseMigrationNotSupported - Reverse migration of a Hyperscale database to Sterling hit an unsupported scenario.\n\n * 400 UpdateSloOperationIdDoesNotExist - The action failed because no active update-slo operation detected for server: {0}, database: {1};. Please retry the operation by specifying valid parameters.\n\n * 400 ManualCutoverUnsupported - Invalid use of manual-cutover option. Please check current and requested service objective and retry the operation by specifying valid parameters.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 IsLedgerDatabaseIsNotSupportedOnResourceType - Changing the ledger property is not supported for this resource type.\n\n * 400 DatabaseNameInUse - Database already exists. Choose a different database name.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 UnableToCreateGeoChain - User attempted to create secondary database (chaining) even though automatic upload of ledger digests has been configured\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 TargetElasticPoolDoesNotExist - The elastic pool does not exist on a server.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 ElasticPoolNameRequired - User tried to create or update database to elastic pool service objective without specifying the name of the elastic pool.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 InvalidReadScaleEdition - User attempted to enable read scale on a database type that does not support it.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 GeoSecondaryMaxSizeUpdateFailed - The geo-secondary database is of a SLO that does not support the requested maxsize value or the geo-secondary is in an unsupported region or an update operation is already in progress on the geo-secondary database.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 SourceDatabaseEncryptionProtectorKeyUriRequiredForPerDatabaseCMKCopyOrReplication - Geo secondary database missing AKV of geo primary database\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 RequestedDatabaseSizeRequiresShrink - User attempted to ALTER DATABASE MODIFY MAXSIZE to modify the MAXSIZE for a database to a smaller size then the current size.\n\n * 400 CurrentDatabaseSizeExceedsDbMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 SecurityAzureKeyVaultGeoChainError - Creating secondary of secondary (a process known as chaining) is not supported when enabling Transparent Data Encryption using Azure Key Vault (BYOK).\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 UnsupportedCapacity - User tried to create or update database with capacity which is not supported.\n\n * 400 RestoreToFreeEditionNotSupported - Restore and GeoRestore target cannot be free database.\n\n * 400 RestoreNotSupportedForFreeEdition - Restore and GeoRestore are not supported for free database.\n\n * 400 InvalidDroppedDatabase - Source database dropped does not exist on server within the supported recovery period.\n\n * 400 InvalidLiveDatabase - Source database does not exist on server within the supported recovery period. If restoring a dropped database, please specify its deletion date.\n\n * 400 InvalidVldbRecoverySlo - The Hyperscale edition recovery requires both source and target databases to use Hyperscale service level objective.\n\n * 400 InvalidVldbRestoreSlo - The Hyperscale edition Point-In-Time restore requires both source and target databases to use Hyperscale service level objective.\n\n * 400 CannotSpecifyPoolOrSlo - Specifying an elastic pool and/or changing the service level objective or edition is not supported for edition.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 InvalidBackupStorageAccountType - User passed zrs/lrs during create/update of a database but it failed either because the customer is not whitelisted or because zrs is not available in the specified region.\n\n * 400 DatabaseInvalidSkuPropertyCombination - The properties of the requested sku are inconsistent. Please check that a valid combination is specified. See https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability for more details.\n\n * 400 DatabaseNamedReplicaPerDatabaseLimitExceeded - User tried create a named replica that would exceed the allowed number per primary database\n\n * 400 UnsupportedBackupStorageRedundancyForEdition - The requested backup storage redundancy is not supported for edition\n\n * 400 DatabaseIsCurrentlyPinned - Microsoft has pinned your database SQL Server engine version. To ensure your database does not hit production issues, any future scale operations on your database will be blocked until it has been un-pinned. Please contact Microsoft support for assistance with scaling.\n\n * 400 RestoreTargetEditionSizeInsufficient - User attempted to restore a database to an edition that is a smaller size than the current allocated size of the source.\n\n * 400 InvalidIdentityId - One or more identity id(s) provided are not valid ARM resource id(s). Please input valid id(s) and try again.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 DatabaseCreationBlockedForNonActivatedCMKServer - SQL Pool creations are blocked for CMK enabled workspaces until the workspace is activated. First, enable purge protection and grant the workspace Managed Identity the required permissions (Get, Wrap Key, Unwrap Key) on the Azure Key Vault of the workspace key. Next, activate your workspace after you have granted access.\n\n * 400 InvalidNumberOfIdentities - Only one user assigned managed identity is supported at the Database Level.\n\n * 400 NoRestorePointAvailable - The source database has not yet accomplished its first backup in order to support restore operations. Please retry the restore request later.\n\n * 400 DatabaseNamedReplicaChainingNotAllowed - User tried to create a named replica of a named replica which is not allowed.\n\n * 400 DatabaseNamedReplicaInvalidOperation - User attempted an unsupported operation on a named replica.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 DatabaseNamedReplicaInvalidSourceDatabase - User attempted to create a named replica in a different subscription or region than the source database.\n\n * 400 DatabaseNamedReplicaSourceDatabaseNotZoneRedundant - Zone Redundancy cannot be enabled on this Named Replica since the primary Hyperscale Database is not zone redundant.\n\n * 400 CannotAssignIdentityToMaster - Cannot assign an identity to a system database. Database identity cannot be assigned to 'master', 'model', 'tempdb', 'msdb', or 'resource' databases.\n\n * 400 PerDatabaseCMKDWNotSupported - Database-level CMK in preview is not supported for Datawarehouse edition.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 MissingThumbprintCrm - The restore operation of a CRM database failed because a required TDE certificate was missing. Please retry the restore operation to an existing elastic pool.\n\n * 400 ElasticPoolOverStorage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 RestoreTargetEditionSizeInsufficientV2 - User attempted to restore a database to an edition that is a smaller size than the allocated size of the restored database.\n\n * 400 ResourcePoolStorageLimitHitDuringRestore - The restored database can't be restored into the resource pool due to the remaining storage capacity in the pool.\n\n * 400 PerDatabaseCMKRestoreNotSupported - Database restore is not supported when Database-level CMK is configured in preview.\n\n * 400 PerDatabaseCMKHSNotSupported - Database-level CMK in preview is not supported for Hyperscale edition.\n\n * 400 PerDatabaseCMKGeoReplicationNotSupported - Geo Replication and Database Copy is not supported when Database-level CMK is configured in preview.\n\n * 400 InvalidStandbyGeoEdition - User attempted to create a DTU based standby geo.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 GeoRestoreBackupStorageTypeNotSupported - Database recovery requests are invalid when issued against a database that is not configured to use geo-redundant backup storage.\n\n * 400 RestoreHyperscaleToNonHyperscale - Restoring a Hyperscale database backup to a non-Hyperscale service tier or vice versa is not supported.\n\n * 400 SubscriptionDoesNotHaveAccessToServer - The subscription does not have access to the specified server(s)\n\n * 400 RecoveryPointDoesNotExist - The specified recovery point either does not exist or is not valid.\n\n * 400 LtrBackupNotFound - The specified long term retention backup does not exist.\n\n * 400 InvalidPointInTime - The specified point in time is not valid for the database.\n\n * 400 GeoRestoreCannotResolveTargetCluster - Cannot resolve target cluster for server\n\n * 400 CannotSpecifyEditionOrSloWhenRestoringToPool - Specifying the target service level objective or edition is not supported when restoring to an elastic pool.\n\n * 400 RestoreNotSupportedForGeoDrSecondary - Point-in-time restore and database recovery operations are not supported on databases that are currently configured as geo-secondaries.\n\n * 400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported - User attempted configuring backup retention policy on a Named Replica.\n\n * 400 GeoRedundantBackupsNotPermittedForSubscription - Geo-redundant backup storage is blocked for all databases under subscription '{0}' by preview feature 'Azure SQL Database Block Geo-redundant Backup Storage'. Please select a different backup storage redundancy.\n\n * 400 RestoreHyperscaleToNonHyperscaleElasticPool - Restoring a Hyperscale database to an elastic pool which is not Hyperscale or restoring a database which is not Hyperscale to a Hyperscale elastic pool is not supported.\n\n * 400 RestoreIneligibleDatabaseName - The specified target database name, '{0}', is reserved and cannot be used in a restore operation.\n\n * 400 RestoreNotSupportedForSystemDb - Restore and database recovery are not supported for system databases.\n\n * 400 RestoreIneligibleDroppedDatabaseShortLifespan - The source database, '{0}', dropped on '{1}', has not existed long enough to support restores.\n\n * 400 RestoreIneligibleLiveDatabaseShortLifespan - The source database, '{0}', has not yet accomplished its first backup in order to support restore operations. Please wait until at least the indicated earliest restore date '{1}' and resubmit the request.\n\n * 400 RestoreCrossServerDisabled - For point-in-time restores, the target logical server must be the same as the source logical server. Consider restoring to the source database's server, or using database copy or database recovery.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 RestoreSameServerRecoveryDisabled - Same-server recovery is currently not supported. Consider using point-in-time restore or recovering to a different server.\n\n * 400 RestoreNotSupportedFromLtrBackupToEdition - Restore from long-term retention backup to '{0}' edition not supported.\n\n * 400 RestoreNotSupportedFromExternalBackupToEdition - Restore from external backup to '{0}' edition not supported.\n\n * 400 UpdateToServerlessIfLtrIsNotDisabled - Enabling auto-pause for a serverless database is not supported if long-term backup retention is enabled.\n\n * 400 DuplicateRestoreOperation - A restore request with the same target database name '{0}' on server '{1}' already exists.\n\n * 400 ExternalBackupUriMalformed - The external backup storage container URI is malformed.\n\n * 400 ExternalBackupUriHostNotAllowed - The host name for the external backup storage container URI is not allowed.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 ExternalBackupUriInvalidSchemeOrPort - The external backup storage container URI uses an invalid scheme or port. Please use https and port 443.\n\n * 400 ExternalBackupVldbUnsupported - Hyperscale does not support external backup restore requests.\n\n * 400 InvalidPitrPriorToVldbMigration - For database '{0}', specified point-in-time '{1}' is prior to the Hyperscale migration time of '{2}'. Please specify a target edition or service level objective which is not Hyperscale when restoring to a point earlier than the Hyperscale migration.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 MissingKeyVaultUriForRestore - Azure Key Vault key URI '{0}' is required to successfully restore the database '{1}' under server '{2}'.\n\n * 400 BlockRestoreOnVldbGeoSecondary - Restore of Hyperscale database where source database is geo-secondary is not allowed.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 BackupSetNotFound - No backups were found to restore the database. Please contact support to restore the database.\n\n * 400 IncorrectAccessToAzureKeyVault - Target server does not have access to all AKV Uris created during the backup time.\n\n * 400 RestoreFailureSqlInstanceUnhealthy - Unable to connect to the instance in order to perform restore operation.\n\n * 400 BackupSetBroken - Backup set is broken.\n\n * 400 TimeoutDuringRestore - A timeout was encountered while trying to connect to the restore target.\n\n * 400 BrokenRestorePlanGapInLogBackups - The restore plan is broken because firstLsn of current log backup is not equal to lastLsn of prev log backup.\n\n * 400 FullBackupMissingChecksum - Provided full backup is missing checksum.\n\n * 400 RequiredBackupIsNotLastRestored - Migration cannot be completed because provided backup file name is not the name of the last backup file that is restored.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineDataFilesExist - Database backup contains incompatible physical layout. Non-online data files exist.\n\n * 400 IncompatiblePhysicalLayoutWrongNumberOfLogFiles - Database backup contains incompatible physical layout. Multiple log files are not supported.\n\n * 400 LedgerNoDropPrimary - The Geo-primary database cannot be dropped because the database has Ledger Digest Uploads enabled. Disable Ledger Digest Uploads and retry the operation.\n\n * 400 CannotDropDatabaseAKVError - The database {0} on server {1} cannot be safely dropped because it is encrypted with a customer managed key that is no longer accessible to take the last backup before drop. Please restore Azure Key Vault Access on the server and revalidate the keys to make this database accessible and then proceed with the drop. For details see https://aka.ms/tdecmkrestorability\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 FreeDbAlreadyExists - Only one free database can exist for a subscription per region.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 UpdateSloFailedDatabaseTooBusy - Update SLO operation could not complete because database was too busy.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 TargetElasticPoolBeingUpdated - The update of elastic pool cannot be started because there is copy operation in progress for one of the databases in this elastic pool\n\n * 409 DatabaseCopyLimitPerReplicaReached - User reached the limit of concurrent database copies.\n\n * 409 ConflictRequestToUpdateBackupRedundancy - A conflict request to change backup storage redundancy is still in progress.\n\n * 409 DatabaseElasticPoolMaintenanceConflict - User tried to create or update a database with a specified maintenance configuration that conflicted with that of the elastic pool of the database.\n\n * 409 SubscriptionVcoreQuotaExceeded - Could not perform the operation because subscription would exceed the allowed vCore quota.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -122,7 +122,7 @@ "description": "The request for cancel has been executed successfully." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 SourceDatabaseEncryptionProtectorKeyUriRequiredForPerDatabaseCMKCopyOrReplication - Geo secondary database missing AKV of geo primary database\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 CannotUpdateIsLedgerDatabase - The ledger property of an existing database cannot be updated.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 InvalidDatabaseCreateMode - Invalid request to create a database.\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 PartnerDBNotCompatibleForSGXEnclave - Attempt to set GeoDR link or update SLO for enclave enabled database is only supported when both database are running on DC-series hardware.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 TierChangeUnsupportedDueToCDCEnabledDatabase - The database cannot update its sku because it is enabled for CDC.\n\n * 400 IsLedgerDatabaseIsNotSupportedOnResourceType - Changing the ledger property is not supported for this resource type.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 UnableToCreateGeoChain - User attempted to create secondary database (chaining) even though automatic upload of ledger digests has been configured\n\n * 400 TargetElasticPoolDoesNotExist - The elastic pool does not exist on a server.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 ElasticPoolNameRequired - User tried to create or update database to elastic pool service objective without specifying the name of the elastic pool.\n\n * 400 InvalidReadScaleEdition - User attempted to enable read scale on a database type that does not support it.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 GeoSecondaryMaxSizeUpdateFailed - The geo-secondary database is of a SLO that does not support the requested maxsize value or the geo-secondary is in an unsupported region or an update operation is already in progress on the geo-secondary database.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 RequestedDatabaseSizeRequiresShrink - User attempted to ALTER DATABASE MODIFY MAXSIZE to modify the MAXSIZE for a database to a smaller size then the current size.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 CurrentDatabaseSizeExceedsDbMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 DatabaseNameInUse - Database already exists. Choose a different database name.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 SecurityAzureKeyVaultGeoChainError - Creating secondary of secondary (a process known as chaining) is not supported when enabling Transparent Data Encryption using Azure Key Vault (BYOK).\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 UnsupportedCapacity - User tried to create or update database with capacity which is not supported.\n\n * 400 RestoreToFreeEditionNotSupported - Restore and GeoRestore target cannot be free database.\n\n * 400 RestoreNotSupportedForFreeEdition - Restore and GeoRestore are not supported for free database.\n\n * 400 InvalidDroppedDatabase - Source database dropped does not exist on server within the supported recovery period.\n\n * 400 InvalidLiveDatabase - Source database does not exist on server within the supported recovery period. If restoring a dropped database, please specify its deletion date.\n\n * 400 InvalidVldbRecoverySlo - The Hyperscale edition recovery requires both source and target databases to use Hyperscale service level objective.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 InvalidVldbRestoreSlo - The Hyperscale edition Point-In-Time restore requires both source and target databases to use Hyperscale service level objective.\n\n * 400 CannotSpecifyPoolOrSlo - Specifying an elastic pool and/or changing the service level objective or edition is not supported for edition.\n\n * 400 InvalidBackupStorageAccountType - User passed zrs/lrs during create/update of a database but it failed either because the customer is not whitelisted or because zrs is not available in the specified region.\n\n * 400 DatabaseInvalidSkuPropertyCombination - The properties of the requested sku are inconsistent. Please check that a valid combination is specified. See https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability for more details.\n\n * 400 DatabaseNamedReplicaPerDatabaseLimitExceeded - User tried create a named replica that would exceed the allowed number per primary database\n\n * 400 UnsupportedBackupStorageRedundancyForEdition - The requested backup storage redundancy is not supported for edition\n\n * 400 DatabaseIsCurrentlyPinned - Microsoft has pinned your database SQL Server engine version. To ensure your database does not hit production issues, any future scale operations on your database will be blocked until it has been un-pinned. Please contact Microsoft support for assistance with scaling.\n\n * 400 RestoreTargetEditionSizeInsufficient - User attempted to restore a database to an edition that is a smaller size than the current allocated size of the source.\n\n * 400 DatabaseCreationBlockedForNonActivatedCMKServer - SQL Pool creations are blocked for CMK enabled workspaces until the workspace is activated. First, enable purge protection and grant the workspace Managed Identity the required permissions (Get, Wrap Key, Unwrap Key) on the Azure Key Vault of the workspace key. Next, activate your workspace after you have granted access.\n\n * 400 InvalidIdentityId - One or more identity id(s) provided are not valid ARM resource id(s). Please input valid id(s) and try again.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 InvalidNumberOfIdentities - Only one user assigned managed identity is supported at the Database Level.\n\n * 400 NoRestorePointAvailable - The source database has not yet accomplished its first backup in order to support restore operations. Please retry the restore request later.\n\n * 400 DatabaseNamedReplicaChainingNotAllowed - User tried to create a named replica of a named replica which is not allowed.\n\n * 400 DatabaseNamedReplicaInvalidOperation - User attempted an unsupported operation on a named replica.\n\n * 400 DatabaseNamedReplicaInvalidSourceDatabase - User attempted to create a named replica in a different subscription or region than the source database.\n\n * 400 DatabaseNamedReplicaSourceDatabaseNotZoneRedundant - Zone Redundancy cannot be enabled on this Named Replica since the primary Hyperscale Database is not zone redundant.\n\n * 400 CannotAssignIdentityToMaster - Cannot assign an identity to a system database. Database identity cannot be assigned to 'master', 'model', 'tempdb', 'msdb', or 'resource' databases.\n\n * 400 PerDatabaseCMKDWNotSupported - Database-level CMK in preview is not supported for Datawarehouse edition.\n\n * 400 MissingThumbprintCrm - The restore operation of a CRM database failed because a required TDE certificate was missing. Please retry the restore operation to an existing elastic pool.\n\n * 400 ElasticPoolOverStorage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 RestoreTargetEditionSizeInsufficientV2 - User attempted to restore a database to an edition that is a smaller size than the allocated size of the restored database.\n\n * 400 ResourcePoolStorageLimitHitDuringRestore - The restored database can't be restored into the resource pool due to the remaining storage capacity in the pool.\n\n * 400 PerDatabaseCMKRestoreNotSupported - Database restore is not supported when Database-level CMK is configured in preview.\n\n * 400 PerDatabaseCMKHSNotSupported - Database-level CMK in preview is not supported for Hyperscale edition.\n\n * 400 PerDatabaseCMKGeoReplicationNotSupported - Geo Replication and Database Copy is not supported when Database-level CMK is configured in preview.\n\n * 400 InvalidStandbyGeoEdition - User attempted to create a DTU based standby geo.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 GeoRestoreBackupStorageTypeNotSupported - Database recovery requests are invalid when issued against a database that is not configured to use geo-redundant backup storage.\n\n * 400 RestoreHyperscaleToNonHyperscale - Restoring a Hyperscale database backup to a non-Hyperscale service tier or vice versa is not supported.\n\n * 400 SubscriptionDoesNotHaveAccessToServer - The subscription does not have access to the specified server(s)\n\n * 400 RecoveryPointDoesNotExist - The specified recovery point either does not exist or is not valid.\n\n * 400 LtrBackupNotFound - The specified long term retention backup does not exist.\n\n * 400 InvalidPointInTime - The specified point in time is not valid for the database.\n\n * 400 GeoRestoreCannotResolveTargetCluster - Cannot resolve target cluster for server\n\n * 400 CannotSpecifyEditionOrSloWhenRestoringToPool - Specifying the target service level objective or edition is not supported when restoring to an elastic pool.\n\n * 400 RestoreNotSupportedForGeoDrSecondary - Point-in-time restore and database recovery operations are not supported on databases that are currently configured as geo-secondaries.\n\n * 400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported - User attempted configuring backup retention policy on a Named Replica.\n\n * 400 GeoRedundantBackupsNotPermittedForSubscription - Geo-redundant backup storage is blocked for all databases under subscription '{0}' by preview feature 'Azure SQL Database Block Geo-redundant Backup Storage'. Please select a different backup storage redundancy.\n\n * 400 RestoreHyperscaleToNonHyperscaleElasticPool - Restoring a Hyperscale database to an elastic pool which is not Hyperscale or restoring a database which is not Hyperscale to a Hyperscale elastic pool is not supported.\n\n * 400 RestoreIneligibleDatabaseName - The specified target database name, '{0}', is reserved and cannot be used in a restore operation.\n\n * 400 RestoreNotSupportedForSystemDb - Restore and database recovery are not supported for system databases.\n\n * 400 RestoreIneligibleDroppedDatabaseShortLifespan - The source database, '{0}', dropped on '{1}', has not existed long enough to support restores.\n\n * 400 RestoreIneligibleLiveDatabaseShortLifespan - The source database, '{0}', has not yet accomplished its first backup in order to support restore operations. Please wait until at least the indicated earliest restore date '{1}' and resubmit the request.\n\n * 400 RestoreCrossServerDisabled - For point-in-time restores, the target logical server must be the same as the source logical server. Consider restoring to the source database's server, or using database copy or database recovery.\n\n * 400 RestoreSameServerRecoveryDisabled - Same-server recovery is currently not supported. Consider using point-in-time restore or recovering to a different server.\n\n * 400 RestoreNotSupportedFromLtrBackupToEdition - Restore from long-term retention backup to '{0}' edition not supported.\n\n * 400 RestoreNotSupportedFromExternalBackupToEdition - Restore from external backup to '{0}' edition not supported.\n\n * 400 UpdateToServerlessIfLtrIsNotDisabled - Enabling auto-pause for a serverless database is not supported if long-term backup retention is enabled.\n\n * 400 DuplicateRestoreOperation - A restore request with the same target database name '{0}' on server '{1}' already exists.\n\n * 400 ExternalBackupUriMalformed - The external backup storage container URI is malformed.\n\n * 400 ExternalBackupUriHostNotAllowed - The host name for the external backup storage container URI is not allowed.\n\n * 400 ExternalBackupUriInvalidSchemeOrPort - The external backup storage container URI uses an invalid scheme or port. Please use https and port 443.\n\n * 400 ExternalBackupVldbUnsupported - Hyperscale does not support external backup restore requests.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 InvalidPitrPriorToVldbMigration - For database '{0}', specified point-in-time '{1}' is prior to the Hyperscale migration time of '{2}'. Please specify a target edition or service level objective which is not Hyperscale when restoring to a point earlier than the Hyperscale migration.\n\n * 400 MissingKeyVaultUriForRestore - Azure Key Vault key URI '{0}' is required to successfully restore the database '{1}' under server '{2}'.\n\n * 400 BlockRestoreOnVldbGeoSecondary - Restore of Hyperscale database where source database is geo-secondary is not allowed.\n\n * 400 BackupSetNotFound - No backups were found to restore the database. Please contact support to restore the database.\n\n * 400 IncorrectAccessToAzureKeyVault - Target server does not have access to all AKV Uris created during the backup time.\n\n * 400 RestoreFailureSqlInstanceUnhealthy - Unable to connect to the instance in order to perform restore operation.\n\n * 400 BackupSetBroken - Backup set is broken.\n\n * 400 TimeoutDuringRestore - A timeout was encountered while trying to connect to the restore target.\n\n * 400 BrokenRestorePlanGapInLogBackups - The restore plan is broken because firstLsn of current log backup is not equal to lastLsn of prev log backup.\n\n * 400 FullBackupMissingChecksum - Provided full backup is missing checksum.\n\n * 400 RequiredBackupIsNotLastRestored - Migration cannot be completed because provided backup file name is not the name of the last backup file that is restored.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineDataFilesExist - Database backup contains incompatible physical layout. Non-online data files exist.\n\n * 400 IncompatiblePhysicalLayoutWrongNumberOfLogFiles - Database backup contains incompatible physical layout. Multiple log files are not supported.\n\n * 400 BackupSetNotFoundRecentPit - No backups were found to restore the database to the specified point in time. Please retry the operation. If the problem persists, contact support to restore the database.\n\n * 400 InvalidPublicMaintenanceConfiguration - User tried to specify public maintenance configuration which cannot be converted to internal id (malformed or wrong region).\n\n * 400 MaintenanceWindowNotSupportedForNamedReplica - User tried to create or update named replica with non-default maintenance window which is not supported.\n\n * 400 InvalidStandbyGeoReadScale - User attempted to enable read scale on a standby geo database that does not support it.\n\n * 400 PerDatabaseCMKKeyRotationAttemptedWhileOldThumbprintInUse - Key Rotation for the TDE Protector at the database level is blocked when active transactions are holding up the log encrypted with old keys. Please refer to aka.ms/azuresqldbkeyrotation for possible strategies to workaround this issue.\n\n * 400 PerDBCMKNotSupportedWithLTR - Database-level CMK is not supported when Long-term Backup Retention is enabled on the database.\n\n * 400 VBSEnclaveNotSupportedForDW - The preferredEnclaveType is not supported for dedicated SQL Pools.\n\n * 400 VBSEnclaveNotSupportedForDCSeriesSLO - Configuring the 'VBS' preferredEnclaveType for databases using the DC-series hardware configuration is not supported. DC-series databases are pre-configured with Intel SGX enclaves. Virtualization based security (VBS) enclaves are not supported.\n\n * 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutDatabaseLevelEncryptionProtector - Database-level encryption protector must be set on the target database while attempting to copy or replicate a database encrypted with a database level key.\n\n * 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeys - While attempting to replicate a database configured with database level encryption protector, the current keys being used by the primary must be passed to the secondary database.\n\n * 400 PerDatabaseCMKGeoPrimaryIsNotConfiguredWithDatabaseLevelEncryptionProtector - The geo-primary database must be configured with a database level encryption protector before setting a database level encryption protector on the geo-secondary.\n\n * 400 ElasticJobsNotSupportedOnAutoPauseEnabledDatabase - Auto-pause enabled serverless database is not supported as an Elastic Jobs database because job agent would prevent that database from pausing. You can either disable auto-pause on this serverless database or delete the job agent that is using this database. See here for more details: https://docs.microsoft.com/azure/azure-sql/database/serverless-tier-overview#auto-pausing\n\n * 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave - Configuring geo-replication is not supported for databases using different values of the preferredEnclaveType property. The primary '{0}' database on the '{1}' server uses the '{2}' preferredEnclaveType, whereas the specified preferredEnclaveType for the secondary '{3}' database on the '{4}' server is '{5}'.\n\n * 400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes - Planned failover between primary and secondary database with different preferredEnclaveType is not supported for Virtualization-based security (VBS) enclaves.\n\n * 400 PerDatabaseCMKGeoPrimaryIsConfiguredWithDatabaseLevelEncryptionProtector - The geo-primary database must not be configured with a database level encryption protector when failing over to a geo-secondary without a database level encryption protector.\n\n * 400 CreateDatabaseAttemptedWithRotationInProgress - The create database operation can not be performed at this time due to ongoing Transparent Data Encryption (TDE) key rotation on the server. Please try the operation again later.\n\n * 400 VBSEnclaveResourcePoolInvalidCombination - Adding a database with '{0}' preferredEnclaveType to an elastic pool '{1}' with '{2}' preferredEnclaveType is not supported. \nBefore adding the database to the elastic pool, ensure that the preferredEnclaveType is the same for both the database and the elastic pool. More information can be found on https://aka.ms/AlwaysEncryptedEnableSecureEnclaves\n\n * 400 MissingAsymmetricKeyOnTargetServer - Target server does not have access to an asymmetric key.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MultipleDroppedDatabasesWithTheSameName - Found multiple dropped databases with the same name on server.\n\n * 400 AzureKeyVaultClientError - The Azure Key Vault client encountered an error.\n\n * 400 AzureKeyVaultClientInfoError - An error occurred while obtaining information for the Azure Key Vault client.\n\n * 400 AzureKeyVaultKeyThumbprintIsDifferent - The operation could not be completed because the Azure Key Vault Key material is different than the current encryption protector key.\n\n * 400 UnsupportedBackupStorageRedundancy - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 LTRSterlingToVldbMigrationNotSupported - Cannot change service objective for database to Hyperscale as long-term retention is not yet supported on Hyperscale. Please disable long-term retention on the database and retry.\n\n * 400 HyperscaleReverseMigrationNotSupported - Reverse migration of a Hyperscale database to Sterling hit an unsupported scenario.\n\n * 400 UpdateSloOperationIdDoesNotExist - The action failed because no active update-slo operation detected for server: {0}, database: {1};. Please retry the operation by specifying valid parameters.\n\n * 400 ManualCutoverUnsupported - Invalid use of manual-cutover option. Please check current and requested service objective and retry the operation by specifying valid parameters.\n\n * 400 LedgerNoDropPrimary - The Geo-primary database cannot be dropped because the database has Ledger Digest Uploads enabled. Disable Ledger Digest Uploads and retry the operation.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 CannotDropDatabaseAKVError - The database {0} on server {1} cannot be safely dropped because it is encrypted with a customer managed key that is no longer accessible to take the last backup before drop. Please restore Azure Key Vault Access on the server and revalidate the keys to make this database accessible and then proceed with the drop. For details see https://aka.ms/tdecmkrestorability\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 FreeDbAlreadyExists - Only one free database can exist for a subscription per region.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 UpdateSloFailedDatabaseTooBusy - Update SLO operation could not complete because database was too busy.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 TargetElasticPoolBeingUpdated - The update of elastic pool cannot be started because there is copy operation in progress for one of the databases in this elastic pool\n\n * 409 DatabaseCopyLimitPerReplicaReached - User reached the limit of concurrent database copies.\n\n * 409 ConflictRequestToUpdateBackupRedundancy - A conflict request to change backup storage redundancy is still in progress.\n\n * 409 DatabaseElasticPoolMaintenanceConflict - User tried to create or update a database with a specified maintenance configuration that conflicted with that of the elastic pool of the database.\n\n * 409 SubscriptionVcoreQuotaExceeded - Could not perform the operation because subscription would exceed the allowed vCore quota.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UnsupportedBackupStorageRedundancy - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 BackupSetNotFoundRecentPit - No backups were found to restore the database to the specified point in time. Please retry the operation. If the problem persists, contact support to restore the database.\n\n * 400 CannotUpdateIsLedgerDatabase - The ledger property of an existing database cannot be updated.\n\n * 400 LTRSterlingToVldbMigrationNotSupported - Cannot change service objective for database to Hyperscale as long-term retention is not yet supported on Hyperscale. Please disable long-term retention on the database and retry.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 InvalidPublicMaintenanceConfiguration - User tried to specify public maintenance configuration which cannot be converted to internal id (malformed or wrong region).\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 MaintenanceWindowNotSupportedForNamedReplica - User tried to create or update named replica with non-default maintenance window which is not supported.\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 InvalidStandbyGeoReadScale - User attempted to enable read scale on a standby geo database that does not support it.\n\n * 400 PerDatabaseCMKKeyRotationAttemptedWhileOldThumbprintInUse - Key Rotation for the TDE Protector at the database level is blocked when active transactions are holding up the log encrypted with old keys. Please refer to aka.ms/azuresqldbkeyrotation for possible strategies to workaround this issue.\n\n * 400 TierChangeUnsupportedDueToCDCEnabledDatabase - The database cannot update its sku because it is enabled for CDC.\n\n * 400 PerDBCMKNotSupportedWithLTR - Database-level CMK is not supported when Long-term Backup Retention is enabled on the database.\n\n * 400 VBSEnclaveNotSupportedForDW - The preferredEnclaveType is not supported for dedicated SQL Pools.\n\n * 400 VBSEnclaveNotSupportedForDCSeriesSLO - Configuring the 'VBS' preferredEnclaveType for databases using the DC-series hardware configuration is not supported. DC-series databases are pre-configured with Intel SGX enclaves. Virtualization based security (VBS) enclaves are not supported.\n\n * 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutDatabaseLevelEncryptionProtector - Database-level encryption protector must be set on the target database while attempting to copy or replicate a database encrypted with a database level key.\n\n * 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeys - While attempting to replicate a database configured with database level encryption protector, the current keys being used by the primary must be passed to the secondary database.\n\n * 400 PartnerDBNotCompatibleForSGXEnclave - Attempt to set GeoDR link or update SLO for enclave enabled database is only supported when both database are running on DC-series hardware.\n\n * 400 PerDatabaseCMKGeoPrimaryIsNotConfiguredWithDatabaseLevelEncryptionProtector - The geo-primary database must be configured with a database level encryption protector before setting a database level encryption protector on the geo-secondary.\n\n * 400 ElasticJobsNotSupportedOnAutoPauseEnabledDatabase - Auto-pause enabled serverless database is not supported as an Elastic Jobs database because job agent would prevent that database from pausing. You can either disable auto-pause on this serverless database or delete the job agent that is using this database. See here for more details: https://docs.microsoft.com/azure/azure-sql/database/serverless-tier-overview#auto-pausing\n\n * 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave - Configuring geo-replication is not supported for databases using different values of the preferredEnclaveType property. The primary '{0}' database on the '{1}' server uses the '{2}' preferredEnclaveType, whereas the specified preferredEnclaveType for the secondary '{3}' database on the '{4}' server is '{5}'.\n\n * 400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes - Planned failover between primary and secondary database with different preferredEnclaveType is not supported for Virtualization-based security (VBS) enclaves.\n\n * 400 PerDatabaseCMKGeoPrimaryIsConfiguredWithDatabaseLevelEncryptionProtector - The geo-primary database must not be configured with a database level encryption protector when failing over to a geo-secondary without a database level encryption protector.\n\n * 400 CreateDatabaseAttemptedWithRotationInProgress - The create database operation can not be performed at this time due to ongoing Transparent Data Encryption (TDE) key rotation on the server. Please try the operation again later.\n\n * 400 VBSEnclaveResourcePoolInvalidCombination - Adding a database with '{0}' preferredEnclaveType to an elastic pool '{1}' with '{2}' preferredEnclaveType is not supported. \nBefore adding the database to the elastic pool, ensure that the preferredEnclaveType is the same for both the database and the elastic pool. More information can be found on https://aka.ms/AlwaysEncryptedEnableSecureEnclaves\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 InvalidDatabaseCreateMode - Invalid request to create a database.\n\n * 400 MissingAsymmetricKeyOnTargetServer - Target server does not have access to an asymmetric key.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MultipleDroppedDatabasesWithTheSameName - Found multiple dropped databases with the same name on server.\n\n * 400 AzureKeyVaultClientError - The Azure Key Vault client encountered an error.\n\n * 400 AzureKeyVaultClientInfoError - An error occurred while obtaining information for the Azure Key Vault client.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 AzureKeyVaultKeyThumbprintIsDifferent - The operation could not be completed because the Azure Key Vault Key material is different than the current encryption protector key.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 HyperscaleReverseMigrationNotSupported - Reverse migration of a Hyperscale database to Sterling hit an unsupported scenario.\n\n * 400 UpdateSloOperationIdDoesNotExist - The action failed because no active update-slo operation detected for server: {0}, database: {1};. Please retry the operation by specifying valid parameters.\n\n * 400 ManualCutoverUnsupported - Invalid use of manual-cutover option. Please check current and requested service objective and retry the operation by specifying valid parameters.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 IsLedgerDatabaseIsNotSupportedOnResourceType - Changing the ledger property is not supported for this resource type.\n\n * 400 DatabaseNameInUse - Database already exists. Choose a different database name.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 UnableToCreateGeoChain - User attempted to create secondary database (chaining) even though automatic upload of ledger digests has been configured\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 TargetElasticPoolDoesNotExist - The elastic pool does not exist on a server.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 ElasticPoolNameRequired - User tried to create or update database to elastic pool service objective without specifying the name of the elastic pool.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 InvalidReadScaleEdition - User attempted to enable read scale on a database type that does not support it.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 GeoSecondaryMaxSizeUpdateFailed - The geo-secondary database is of a SLO that does not support the requested maxsize value or the geo-secondary is in an unsupported region or an update operation is already in progress on the geo-secondary database.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 SourceDatabaseEncryptionProtectorKeyUriRequiredForPerDatabaseCMKCopyOrReplication - Geo secondary database missing AKV of geo primary database\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 RequestedDatabaseSizeRequiresShrink - User attempted to ALTER DATABASE MODIFY MAXSIZE to modify the MAXSIZE for a database to a smaller size then the current size.\n\n * 400 CurrentDatabaseSizeExceedsDbMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 SecurityAzureKeyVaultGeoChainError - Creating secondary of secondary (a process known as chaining) is not supported when enabling Transparent Data Encryption using Azure Key Vault (BYOK).\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 UnsupportedCapacity - User tried to create or update database with capacity which is not supported.\n\n * 400 RestoreToFreeEditionNotSupported - Restore and GeoRestore target cannot be free database.\n\n * 400 RestoreNotSupportedForFreeEdition - Restore and GeoRestore are not supported for free database.\n\n * 400 InvalidDroppedDatabase - Source database dropped does not exist on server within the supported recovery period.\n\n * 400 InvalidLiveDatabase - Source database does not exist on server within the supported recovery period. If restoring a dropped database, please specify its deletion date.\n\n * 400 InvalidVldbRecoverySlo - The Hyperscale edition recovery requires both source and target databases to use Hyperscale service level objective.\n\n * 400 InvalidVldbRestoreSlo - The Hyperscale edition Point-In-Time restore requires both source and target databases to use Hyperscale service level objective.\n\n * 400 CannotSpecifyPoolOrSlo - Specifying an elastic pool and/or changing the service level objective or edition is not supported for edition.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 InvalidBackupStorageAccountType - User passed zrs/lrs during create/update of a database but it failed either because the customer is not whitelisted or because zrs is not available in the specified region.\n\n * 400 DatabaseInvalidSkuPropertyCombination - The properties of the requested sku are inconsistent. Please check that a valid combination is specified. See https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability for more details.\n\n * 400 DatabaseNamedReplicaPerDatabaseLimitExceeded - User tried create a named replica that would exceed the allowed number per primary database\n\n * 400 UnsupportedBackupStorageRedundancyForEdition - The requested backup storage redundancy is not supported for edition\n\n * 400 DatabaseIsCurrentlyPinned - Microsoft has pinned your database SQL Server engine version. To ensure your database does not hit production issues, any future scale operations on your database will be blocked until it has been un-pinned. Please contact Microsoft support for assistance with scaling.\n\n * 400 RestoreTargetEditionSizeInsufficient - User attempted to restore a database to an edition that is a smaller size than the current allocated size of the source.\n\n * 400 InvalidIdentityId - One or more identity id(s) provided are not valid ARM resource id(s). Please input valid id(s) and try again.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 DatabaseCreationBlockedForNonActivatedCMKServer - SQL Pool creations are blocked for CMK enabled workspaces until the workspace is activated. First, enable purge protection and grant the workspace Managed Identity the required permissions (Get, Wrap Key, Unwrap Key) on the Azure Key Vault of the workspace key. Next, activate your workspace after you have granted access.\n\n * 400 InvalidNumberOfIdentities - Only one user assigned managed identity is supported at the Database Level.\n\n * 400 NoRestorePointAvailable - The source database has not yet accomplished its first backup in order to support restore operations. Please retry the restore request later.\n\n * 400 DatabaseNamedReplicaChainingNotAllowed - User tried to create a named replica of a named replica which is not allowed.\n\n * 400 DatabaseNamedReplicaInvalidOperation - User attempted an unsupported operation on a named replica.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 DatabaseNamedReplicaInvalidSourceDatabase - User attempted to create a named replica in a different subscription or region than the source database.\n\n * 400 DatabaseNamedReplicaSourceDatabaseNotZoneRedundant - Zone Redundancy cannot be enabled on this Named Replica since the primary Hyperscale Database is not zone redundant.\n\n * 400 CannotAssignIdentityToMaster - Cannot assign an identity to a system database. Database identity cannot be assigned to 'master', 'model', 'tempdb', 'msdb', or 'resource' databases.\n\n * 400 PerDatabaseCMKDWNotSupported - Database-level CMK in preview is not supported for Datawarehouse edition.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 MissingThumbprintCrm - The restore operation of a CRM database failed because a required TDE certificate was missing. Please retry the restore operation to an existing elastic pool.\n\n * 400 ElasticPoolOverStorage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 RestoreTargetEditionSizeInsufficientV2 - User attempted to restore a database to an edition that is a smaller size than the allocated size of the restored database.\n\n * 400 ResourcePoolStorageLimitHitDuringRestore - The restored database can't be restored into the resource pool due to the remaining storage capacity in the pool.\n\n * 400 PerDatabaseCMKRestoreNotSupported - Database restore is not supported when Database-level CMK is configured in preview.\n\n * 400 PerDatabaseCMKHSNotSupported - Database-level CMK in preview is not supported for Hyperscale edition.\n\n * 400 PerDatabaseCMKGeoReplicationNotSupported - Geo Replication and Database Copy is not supported when Database-level CMK is configured in preview.\n\n * 400 InvalidStandbyGeoEdition - User attempted to create a DTU based standby geo.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 GeoRestoreBackupStorageTypeNotSupported - Database recovery requests are invalid when issued against a database that is not configured to use geo-redundant backup storage.\n\n * 400 RestoreHyperscaleToNonHyperscale - Restoring a Hyperscale database backup to a non-Hyperscale service tier or vice versa is not supported.\n\n * 400 SubscriptionDoesNotHaveAccessToServer - The subscription does not have access to the specified server(s)\n\n * 400 RecoveryPointDoesNotExist - The specified recovery point either does not exist or is not valid.\n\n * 400 LtrBackupNotFound - The specified long term retention backup does not exist.\n\n * 400 InvalidPointInTime - The specified point in time is not valid for the database.\n\n * 400 GeoRestoreCannotResolveTargetCluster - Cannot resolve target cluster for server\n\n * 400 CannotSpecifyEditionOrSloWhenRestoringToPool - Specifying the target service level objective or edition is not supported when restoring to an elastic pool.\n\n * 400 RestoreNotSupportedForGeoDrSecondary - Point-in-time restore and database recovery operations are not supported on databases that are currently configured as geo-secondaries.\n\n * 400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported - User attempted configuring backup retention policy on a Named Replica.\n\n * 400 GeoRedundantBackupsNotPermittedForSubscription - Geo-redundant backup storage is blocked for all databases under subscription '{0}' by preview feature 'Azure SQL Database Block Geo-redundant Backup Storage'. Please select a different backup storage redundancy.\n\n * 400 RestoreHyperscaleToNonHyperscaleElasticPool - Restoring a Hyperscale database to an elastic pool which is not Hyperscale or restoring a database which is not Hyperscale to a Hyperscale elastic pool is not supported.\n\n * 400 RestoreIneligibleDatabaseName - The specified target database name, '{0}', is reserved and cannot be used in a restore operation.\n\n * 400 RestoreNotSupportedForSystemDb - Restore and database recovery are not supported for system databases.\n\n * 400 RestoreIneligibleDroppedDatabaseShortLifespan - The source database, '{0}', dropped on '{1}', has not existed long enough to support restores.\n\n * 400 RestoreIneligibleLiveDatabaseShortLifespan - The source database, '{0}', has not yet accomplished its first backup in order to support restore operations. Please wait until at least the indicated earliest restore date '{1}' and resubmit the request.\n\n * 400 RestoreCrossServerDisabled - For point-in-time restores, the target logical server must be the same as the source logical server. Consider restoring to the source database's server, or using database copy or database recovery.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 RestoreSameServerRecoveryDisabled - Same-server recovery is currently not supported. Consider using point-in-time restore or recovering to a different server.\n\n * 400 RestoreNotSupportedFromLtrBackupToEdition - Restore from long-term retention backup to '{0}' edition not supported.\n\n * 400 RestoreNotSupportedFromExternalBackupToEdition - Restore from external backup to '{0}' edition not supported.\n\n * 400 UpdateToServerlessIfLtrIsNotDisabled - Enabling auto-pause for a serverless database is not supported if long-term backup retention is enabled.\n\n * 400 DuplicateRestoreOperation - A restore request with the same target database name '{0}' on server '{1}' already exists.\n\n * 400 ExternalBackupUriMalformed - The external backup storage container URI is malformed.\n\n * 400 ExternalBackupUriHostNotAllowed - The host name for the external backup storage container URI is not allowed.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 ExternalBackupUriInvalidSchemeOrPort - The external backup storage container URI uses an invalid scheme or port. Please use https and port 443.\n\n * 400 ExternalBackupVldbUnsupported - Hyperscale does not support external backup restore requests.\n\n * 400 InvalidPitrPriorToVldbMigration - For database '{0}', specified point-in-time '{1}' is prior to the Hyperscale migration time of '{2}'. Please specify a target edition or service level objective which is not Hyperscale when restoring to a point earlier than the Hyperscale migration.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 MissingKeyVaultUriForRestore - Azure Key Vault key URI '{0}' is required to successfully restore the database '{1}' under server '{2}'.\n\n * 400 BlockRestoreOnVldbGeoSecondary - Restore of Hyperscale database where source database is geo-secondary is not allowed.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 BackupSetNotFound - No backups were found to restore the database. Please contact support to restore the database.\n\n * 400 IncorrectAccessToAzureKeyVault - Target server does not have access to all AKV Uris created during the backup time.\n\n * 400 RestoreFailureSqlInstanceUnhealthy - Unable to connect to the instance in order to perform restore operation.\n\n * 400 BackupSetBroken - Backup set is broken.\n\n * 400 TimeoutDuringRestore - A timeout was encountered while trying to connect to the restore target.\n\n * 400 BrokenRestorePlanGapInLogBackups - The restore plan is broken because firstLsn of current log backup is not equal to lastLsn of prev log backup.\n\n * 400 FullBackupMissingChecksum - Provided full backup is missing checksum.\n\n * 400 RequiredBackupIsNotLastRestored - Migration cannot be completed because provided backup file name is not the name of the last backup file that is restored.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineDataFilesExist - Database backup contains incompatible physical layout. Non-online data files exist.\n\n * 400 IncompatiblePhysicalLayoutWrongNumberOfLogFiles - Database backup contains incompatible physical layout. Multiple log files are not supported.\n\n * 400 LedgerNoDropPrimary - The Geo-primary database cannot be dropped because the database has Ledger Digest Uploads enabled. Disable Ledger Digest Uploads and retry the operation.\n\n * 400 CannotDropDatabaseAKVError - The database {0} on server {1} cannot be safely dropped because it is encrypted with a customer managed key that is no longer accessible to take the last backup before drop. Please restore Azure Key Vault Access on the server and revalidate the keys to make this database accessible and then proceed with the drop. For details see https://aka.ms/tdecmkrestorability\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 FreeDbAlreadyExists - Only one free database can exist for a subscription per region.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 UpdateSloFailedDatabaseTooBusy - Update SLO operation could not complete because database was too busy.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 TargetElasticPoolBeingUpdated - The update of elastic pool cannot be started because there is copy operation in progress for one of the databases in this elastic pool\n\n * 409 DatabaseCopyLimitPerReplicaReached - User reached the limit of concurrent database copies.\n\n * 409 ConflictRequestToUpdateBackupRedundancy - A conflict request to change backup storage redundancy is still in progress.\n\n * 409 DatabaseElasticPoolMaintenanceConflict - User tried to create or update a database with a specified maintenance configuration that conflicted with that of the elastic pool of the database.\n\n * 409 SubscriptionVcoreQuotaExceeded - Could not perform the operation because subscription would exceed the allowed vCore quota.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseRecommendedActions.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseRecommendedActions.json index 514250461cd5..bc12f134d066 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseRecommendedActions.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseRecommendedActions.json @@ -495,7 +495,9 @@ "details": { "description": "Gets additional details specific to this recommended action.", "type": "object", - "additionalProperties": true, + "additionalProperties": { + "type": "object" + }, "readOnly": true } } diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseSqlVulnerabilityAssessmentExecuteScan.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseSqlVulnerabilityAssessmentExecuteScan.json index 473fdd8fb067..7323c225f1a4 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseSqlVulnerabilityAssessmentExecuteScan.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseSqlVulnerabilityAssessmentExecuteScan.json @@ -65,7 +65,12 @@ } }, "202": { - "description": "Successfully started a Vulnerability Assessment database scan." + "description": "Successfully started a Vulnerability Assessment database scan.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseVulnerabilityAssessmentScans.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseVulnerabilityAssessmentScans.json index eee72f0eb474..2c5e45611ae9 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseVulnerabilityAssessmentScans.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseVulnerabilityAssessmentScans.json @@ -276,7 +276,12 @@ } }, "202": { - "description": "Successfully started a Vulnerability Assessment database scan." + "description": "Successfully started a Vulnerability Assessment database scan.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/Databases.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/Databases.json index d131a5673da0..1beab79a3ec3 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/Databases.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/Databases.json @@ -51,7 +51,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found", + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -116,7 +116,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.", + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -181,13 +181,18 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidDatabaseCreateOrUpdateRequest - The request body for the create or update database operation is invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSourceDatabaseId - Invalid source database identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MissingCollation - Collation is required.\n\n * 400 MissingMaxSizeBytes - MaxSizeBytes is required.\n\n * 400 MissingSkuName - Sku name is required.\n\n * 400 MissingSourceDatabaseId - Missing source database identifier.\n\n * 400 InvalidLicenseType - The specified license type is invalid.\n\n * 400 InvalidSkuName - Invalid SKU name.\n\n * 400 MismatchedSkuNameAndCapacity - Mismatch between SKU name and capacity.\n\n * 400 MismatchedSkuNameAndTier - Mismatch between SKU name and tier.\n\n * 400 MismatchedSkuNameAndFamily - Mismatch between SKU name and family.\n\n * 400 LedgerNotAllowedWithSpecifiedCreateMode - IsLedgerOn is not allowed with the specified create mode.\n\n * 400 LedgerNotAllowedOnSampleDatabase - Database creation is not allowed with IsLedgerOn for a sample database.\n\n * 400 FreeLimitDatabaseNotAllowedInNonDefaultCreate - Free limit database creation is not allowed in non default create mode.\n\n * 400 AvailabilityZoneNotSupported - Requested availability zones for databases and elastic pools is not valid.\n\n * 400 DatabaseNameDoesNotMatchSourceDatabaseId - The database name specified doesn’t match the database name in sourceDatabaseId.\n\n * 400 ElasticPoolNotSupportedForExternalBackupRestore - Elastic pool is not supported for external backup restore\n\n * 400 InvalidRecoverableDatabaseId - Invalid recoverable database identifier.\n\n * 400 InvalidRecoveryServicesRecoveryPointId - Invalid recovery services recovery point identifier.\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 MissingRecoverableDatabaseId - Missing recoverable database identifier.\n\n * 400 MissingRecoveryServicesRecoveryPointId - Missing recovery services recovery point Id.\n\n * 400 MissingRestorableDroppedDatabaseId - Missing restorableDroppedDatabaseId\n\n * 400 MissingRestorePointInTime - Missing restore point in time\n\n * 400 MissingSourceDatabaseDeletionDate - Missing source database deletion date\n\n * 400 MissingStorageContainerSasToken - Missing storage container SAS token\n\n * 400 MissingStorageContainerUri - Missing storage container URI\n\n * 400 RestorableDroppedDatabaseIdGivenForRestoreWithSourceDatabaseId - Cannot specify restorableDroppedDatabaseId when sourceDatabaseId is already given in restore create mode\n\n * 400 MultipleIdentitiesOnDatabase - Only one user assigned managed identity is supported at the Database Level.\n\n * 400 MultipleIdentityDelegationsOnDatabase - Only one identity delegation is supported at the Database Level.\n\n * 400 MissingPrimaryDelegatedIdentityClientId - In order to use delegated identities please provide a primary delegated identity client id.\n\n * 400 UnsupportedBackupStorageRedundancy - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 BackupSetNotFoundRecentPit - No backups were found to restore the database to the specified point in time. Please retry the operation. If the problem persists, contact support to restore the database.\n\n * 400 CannotUpdateIsLedgerDatabase - The ledger property of an existing database cannot be updated.\n\n * 400 LTRSterlingToVldbMigrationNotSupported - Cannot change service objective for database to Hyperscale as long-term retention is not yet supported on Hyperscale. Please disable long-term retention on the database and retry.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 InvalidPublicMaintenanceConfiguration - User tried to specify public maintenance configuration which cannot be converted to internal id (malformed or wrong region).\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 MaintenanceWindowNotSupportedForNamedReplica - User tried to create or update named replica with non-default maintenance window which is not supported.\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 InvalidStandbyGeoReadScale - User attempted to enable read scale on a standby geo database that does not support it.\n\n * 400 PerDatabaseCMKKeyRotationAttemptedWhileOldThumbprintInUse - Key Rotation for the TDE Protector at the database level is blocked when active transactions are holding up the log encrypted with old keys. Please refer to aka.ms/azuresqldbkeyrotation for possible strategies to workaround this issue.\n\n * 400 TierChangeUnsupportedDueToCDCEnabledDatabase - The database cannot update its sku because it is enabled for CDC.\n\n * 400 PerDBCMKNotSupportedWithLTR - Database-level CMK is not supported when Long-term Backup Retention is enabled on the database.\n\n * 400 VBSEnclaveNotSupportedForDW - The preferredEnclaveType is not supported for dedicated SQL Pools.\n\n * 400 VBSEnclaveNotSupportedForDCSeriesSLO - Configuring the 'VBS' preferredEnclaveType for databases using the DC-series hardware configuration is not supported. DC-series databases are pre-configured with Intel SGX enclaves. Virtualization based security (VBS) enclaves are not supported.\n\n * 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutDatabaseLevelEncryptionProtector - Database-level encryption protector must be set on the target database while attempting to copy or replicate a database encrypted with a database level key.\n\n * 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeys - While attempting to replicate a database configured with database level encryption protector, the current keys being used by the primary must be passed to the secondary database.\n\n * 400 PartnerDBNotCompatibleForSGXEnclave - Attempt to set GeoDR link or update SLO for enclave enabled database is only supported when both database are running on DC-series hardware.\n\n * 400 PerDatabaseCMKGeoPrimaryIsNotConfiguredWithDatabaseLevelEncryptionProtector - The geo-primary database must be configured with a database level encryption protector before setting a database level encryption protector on the geo-secondary.\n\n * 400 ElasticJobsNotSupportedOnAutoPauseEnabledDatabase - Auto-pause enabled serverless database is not supported as an Elastic Jobs database because job agent would prevent that database from pausing. You can either disable auto-pause on this serverless database or delete the job agent that is using this database. See here for more details: https://docs.microsoft.com/azure/azure-sql/database/serverless-tier-overview#auto-pausing\n\n * 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave - Configuring geo-replication is not supported for databases using different values of the preferredEnclaveType property. The primary '{0}' database on the '{1}' server uses the '{2}' preferredEnclaveType, whereas the specified preferredEnclaveType for the secondary '{3}' database on the '{4}' server is '{5}'.\n\n * 400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes - Planned failover between primary and secondary database with different preferredEnclaveType is not supported for Virtualization-based security (VBS) enclaves.\n\n * 400 PerDatabaseCMKGeoPrimaryIsConfiguredWithDatabaseLevelEncryptionProtector - The geo-primary database must not be configured with a database level encryption protector when failing over to a geo-secondary without a database level encryption protector.\n\n * 400 CreateDatabaseAttemptedWithRotationInProgress - The create database operation can not be performed at this time due to ongoing Transparent Data Encryption (TDE) key rotation on the server. Please try the operation again later.\n\n * 400 VBSEnclaveResourcePoolInvalidCombination - Adding a database with '{0}' preferredEnclaveType to an elastic pool '{1}' with '{2}' preferredEnclaveType is not supported. \nBefore adding the database to the elastic pool, ensure that the preferredEnclaveType is the same for both the database and the elastic pool. More information can be found on https://aka.ms/AlwaysEncryptedEnableSecureEnclaves\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 InvalidDatabaseCreateMode - Invalid request to create a database.\n\n * 400 MissingAsymmetricKeyOnTargetServer - Target server does not have access to an asymmetric key.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MultipleDroppedDatabasesWithTheSameName - Found multiple dropped databases with the same name on server.\n\n * 400 AzureKeyVaultClientError - The Azure Key Vault client encountered an error.\n\n * 400 AzureKeyVaultClientInfoError - An error occurred while obtaining information for the Azure Key Vault client.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 AzureKeyVaultKeyThumbprintIsDifferent - The operation could not be completed because the Azure Key Vault Key material is different than the current encryption protector key.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 HyperscaleReverseMigrationNotSupported - Reverse migration of a Hyperscale database to Sterling hit an unsupported scenario.\n\n * 400 UpdateSloOperationIdDoesNotExist - The action failed because no active update-slo operation detected for server: {0}, database: {1};. Please retry the operation by specifying valid parameters.\n\n * 400 ManualCutoverUnsupported - Invalid use of manual-cutover option. Please check current and requested service objective and retry the operation by specifying valid parameters.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 IsLedgerDatabaseIsNotSupportedOnResourceType - Changing the ledger property is not supported for this resource type.\n\n * 400 DatabaseNameInUse - Database already exists. Choose a different database name.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 UnableToCreateGeoChain - User attempted to create secondary database (chaining) even though automatic upload of ledger digests has been configured\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 TargetElasticPoolDoesNotExist - The elastic pool does not exist on a server.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 ElasticPoolNameRequired - User tried to create or update database to elastic pool service objective without specifying the name of the elastic pool.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 InvalidReadScaleEdition - User attempted to enable read scale on a database type that does not support it.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 GeoSecondaryMaxSizeUpdateFailed - The geo-secondary database is of a SLO that does not support the requested maxsize value or the geo-secondary is in an unsupported region or an update operation is already in progress on the geo-secondary database.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 SourceDatabaseEncryptionProtectorKeyUriRequiredForPerDatabaseCMKCopyOrReplication - Geo secondary database missing AKV of geo primary database\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 RequestedDatabaseSizeRequiresShrink - User attempted to ALTER DATABASE MODIFY MAXSIZE to modify the MAXSIZE for a database to a smaller size then the current size.\n\n * 400 CurrentDatabaseSizeExceedsDbMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 SecurityAzureKeyVaultGeoChainError - Creating secondary of secondary (a process known as chaining) is not supported when enabling Transparent Data Encryption using Azure Key Vault (BYOK).\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 UnsupportedCapacity - User tried to create or update database with capacity which is not supported.\n\n * 400 RestoreToFreeEditionNotSupported - Restore and GeoRestore target cannot be free database.\n\n * 400 RestoreNotSupportedForFreeEdition - Restore and GeoRestore are not supported for free database.\n\n * 400 InvalidDroppedDatabase - Source database dropped does not exist on server within the supported recovery period.\n\n * 400 InvalidLiveDatabase - Source database does not exist on server within the supported recovery period. If restoring a dropped database, please specify its deletion date.\n\n * 400 InvalidVldbRecoverySlo - The Hyperscale edition recovery requires both source and target databases to use Hyperscale service level objective.\n\n * 400 InvalidVldbRestoreSlo - The Hyperscale edition Point-In-Time restore requires both source and target databases to use Hyperscale service level objective.\n\n * 400 CannotSpecifyPoolOrSlo - Specifying an elastic pool and/or changing the service level objective or edition is not supported for edition.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 InvalidBackupStorageAccountType - User passed zrs/lrs during create/update of a database but it failed either because the customer is not whitelisted or because zrs is not available in the specified region.\n\n * 400 DatabaseInvalidSkuPropertyCombination - The properties of the requested sku are inconsistent. Please check that a valid combination is specified. See https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability for more details.\n\n * 400 DatabaseNamedReplicaPerDatabaseLimitExceeded - User tried create a named replica that would exceed the allowed number per primary database\n\n * 400 UnsupportedBackupStorageRedundancyForEdition - The requested backup storage redundancy is not supported for edition\n\n * 400 DatabaseIsCurrentlyPinned - Microsoft has pinned your database SQL Server engine version. To ensure your database does not hit production issues, any future scale operations on your database will be blocked until it has been un-pinned. Please contact Microsoft support for assistance with scaling.\n\n * 400 RestoreTargetEditionSizeInsufficient - User attempted to restore a database to an edition that is a smaller size than the current allocated size of the source.\n\n * 400 InvalidIdentityId - One or more identity id(s) provided are not valid ARM resource id(s). Please input valid id(s) and try again.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 DatabaseCreationBlockedForNonActivatedCMKServer - SQL Pool creations are blocked for CMK enabled workspaces until the workspace is activated. First, enable purge protection and grant the workspace Managed Identity the required permissions (Get, Wrap Key, Unwrap Key) on the Azure Key Vault of the workspace key. Next, activate your workspace after you have granted access.\n\n * 400 InvalidNumberOfIdentities - Only one user assigned managed identity is supported at the Database Level.\n\n * 400 NoRestorePointAvailable - The source database has not yet accomplished its first backup in order to support restore operations. Please retry the restore request later.\n\n * 400 DatabaseNamedReplicaChainingNotAllowed - User tried to create a named replica of a named replica which is not allowed.\n\n * 400 DatabaseNamedReplicaInvalidOperation - User attempted an unsupported operation on a named replica.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 DatabaseNamedReplicaInvalidSourceDatabase - User attempted to create a named replica in a different subscription or region than the source database.\n\n * 400 DatabaseNamedReplicaSourceDatabaseNotZoneRedundant - Zone Redundancy cannot be enabled on this Named Replica since the primary Hyperscale Database is not zone redundant.\n\n * 400 CannotAssignIdentityToMaster - Cannot assign an identity to a system database. Database identity cannot be assigned to 'master', 'model', 'tempdb', 'msdb', or 'resource' databases.\n\n * 400 PerDatabaseCMKDWNotSupported - Database-level CMK in preview is not supported for Datawarehouse edition.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 MissingThumbprintCrm - The restore operation of a CRM database failed because a required TDE certificate was missing. Please retry the restore operation to an existing elastic pool.\n\n * 400 ElasticPoolOverStorage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 RestoreTargetEditionSizeInsufficientV2 - User attempted to restore a database to an edition that is a smaller size than the allocated size of the restored database.\n\n * 400 ResourcePoolStorageLimitHitDuringRestore - The restored database can't be restored into the resource pool due to the remaining storage capacity in the pool.\n\n * 400 PerDatabaseCMKRestoreNotSupported - Database restore is not supported when Database-level CMK is configured in preview.\n\n * 400 PerDatabaseCMKHSNotSupported - Database-level CMK in preview is not supported for Hyperscale edition.\n\n * 400 PerDatabaseCMKGeoReplicationNotSupported - Geo Replication and Database Copy is not supported when Database-level CMK is configured in preview.\n\n * 400 InvalidStandbyGeoEdition - User attempted to create a DTU based standby geo.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 GeoRestoreBackupStorageTypeNotSupported - Database recovery requests are invalid when issued against a database that is not configured to use geo-redundant backup storage.\n\n * 400 RestoreHyperscaleToNonHyperscale - Restoring a Hyperscale database backup to a non-Hyperscale service tier or vice versa is not supported.\n\n * 400 SubscriptionDoesNotHaveAccessToServer - The subscription does not have access to the specified server(s)\n\n * 400 RecoveryPointDoesNotExist - The specified recovery point either does not exist or is not valid.\n\n * 400 LtrBackupNotFound - The specified long term retention backup does not exist.\n\n * 400 InvalidPointInTime - The specified point in time is not valid for the database.\n\n * 400 GeoRestoreCannotResolveTargetCluster - Cannot resolve target cluster for server\n\n * 400 CannotSpecifyEditionOrSloWhenRestoringToPool - Specifying the target service level objective or edition is not supported when restoring to an elastic pool.\n\n * 400 RestoreNotSupportedForGeoDrSecondary - Point-in-time restore and database recovery operations are not supported on databases that are currently configured as geo-secondaries.\n\n * 400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported - User attempted configuring backup retention policy on a Named Replica.\n\n * 400 GeoRedundantBackupsNotPermittedForSubscription - Geo-redundant backup storage is blocked for all databases under subscription '{0}' by preview feature 'Azure SQL Database Block Geo-redundant Backup Storage'. Please select a different backup storage redundancy.\n\n * 400 RestoreHyperscaleToNonHyperscaleElasticPool - Restoring a Hyperscale database to an elastic pool which is not Hyperscale or restoring a database which is not Hyperscale to a Hyperscale elastic pool is not supported.\n\n * 400 RestoreIneligibleDatabaseName - The specified target database name, '{0}', is reserved and cannot be used in a restore operation.\n\n * 400 RestoreNotSupportedForSystemDb - Restore and database recovery are not supported for system databases.\n\n * 400 RestoreIneligibleDroppedDatabaseShortLifespan - The source database, '{0}', dropped on '{1}', has not existed long enough to support restores.\n\n * 400 RestoreIneligibleLiveDatabaseShortLifespan - The source database, '{0}', has not yet accomplished its first backup in order to support restore operations. Please wait until at least the indicated earliest restore date '{1}' and resubmit the request.\n\n * 400 RestoreCrossServerDisabled - For point-in-time restores, the target logical server must be the same as the source logical server. Consider restoring to the source database's server, or using database copy or database recovery.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 RestoreSameServerRecoveryDisabled - Same-server recovery is currently not supported. Consider using point-in-time restore or recovering to a different server.\n\n * 400 RestoreNotSupportedFromLtrBackupToEdition - Restore from long-term retention backup to '{0}' edition not supported.\n\n * 400 RestoreNotSupportedFromExternalBackupToEdition - Restore from external backup to '{0}' edition not supported.\n\n * 400 UpdateToServerlessIfLtrIsNotDisabled - Enabling auto-pause for a serverless database is not supported if long-term backup retention is enabled.\n\n * 400 DuplicateRestoreOperation - A restore request with the same target database name '{0}' on server '{1}' already exists.\n\n * 400 ExternalBackupUriMalformed - The external backup storage container URI is malformed.\n\n * 400 ExternalBackupUriHostNotAllowed - The host name for the external backup storage container URI is not allowed.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 ExternalBackupUriInvalidSchemeOrPort - The external backup storage container URI uses an invalid scheme or port. Please use https and port 443.\n\n * 400 ExternalBackupVldbUnsupported - Hyperscale does not support external backup restore requests.\n\n * 400 InvalidPitrPriorToVldbMigration - For database '{0}', specified point-in-time '{1}' is prior to the Hyperscale migration time of '{2}'. Please specify a target edition or service level objective which is not Hyperscale when restoring to a point earlier than the Hyperscale migration.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 MissingKeyVaultUriForRestore - Azure Key Vault key URI '{0}' is required to successfully restore the database '{1}' under server '{2}'.\n\n * 400 BlockRestoreOnVldbGeoSecondary - Restore of Hyperscale database where source database is geo-secondary is not allowed.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 BackupSetNotFound - No backups were found to restore the database. Please contact support to restore the database.\n\n * 400 IncorrectAccessToAzureKeyVault - Target server does not have access to all AKV Uris created during the backup time.\n\n * 400 RestoreFailureSqlInstanceUnhealthy - Unable to connect to the instance in order to perform restore operation.\n\n * 400 BackupSetBroken - Backup set is broken.\n\n * 400 TimeoutDuringRestore - A timeout was encountered while trying to connect to the restore target.\n\n * 400 BrokenRestorePlanGapInLogBackups - The restore plan is broken because firstLsn of current log backup is not equal to lastLsn of prev log backup.\n\n * 400 FullBackupMissingChecksum - Provided full backup is missing checksum.\n\n * 400 RequiredBackupIsNotLastRestored - Migration cannot be completed because provided backup file name is not the name of the last backup file that is restored.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineDataFilesExist - Database backup contains incompatible physical layout. Non-online data files exist.\n\n * 400 IncompatiblePhysicalLayoutWrongNumberOfLogFiles - Database backup contains incompatible physical layout. Multiple log files are not supported.\n\n * 400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed - Changing backup storage redundancy is not allowed for LTR Copy operations.\n\n * 400 LtrRestoreFailedArchiveStorageTier - Restoring archived long-term retention backup is not supported. Restore can be performed only on rehydrated or regular long-term retention backups.\n\n * 400 LtrArchiveStorageTierNotEnabled - Archiving long-term retention backups is not enabled.\n\n * 400 LtrArchiveWrongParameters - ChangeLongTermRetentionBackupAccessTier is not supported for the desired (backupStorageAccessTier, operationMode) combination. Only (Archive, Move) and (Hot, Copy) are allowed.\n\n * 400 LTRArchiveRedundancyChangeFailed - Updating the backup storage redundancy type to zone-redundant storage is not supported when a long-term retention policy with the 'archive' backup storage access tier is set\n\n * 400 LongTermRetentionMigrationSubscriptionNotFound - The subscription could not be found.\n\n * 400 LtrOperationFailedBackupImmutable - Deleting Long Term Retention backup failed because the backup is immutable.\n\n * 400 LongTermRetentionMigrationRequestNotSupported - Subscription is not allowed LTR backup Migration feature.\n\n * 400 LongTermRetentionMigrationCrossClusterRequestNotSupported - Source and target subscriptions are not allowed to communicate for LTR backup copy feature.\n\n * 400 LongTermRetentionMigrationParameterMissing - Required parameter missing for the operation.\n\n * 400 LongTermRetentionMigrationSameServerNotSupported - LTR Copy feature is not supported to copy LTR backups within same server.\n\n * 400 LongTermRetentionMigrationTargetServerNotFound - Target server does not exists or is not ready for LTR backup copy operation.\n\n * 400 LongTermRetentionMigrationTargetDatabaseNotFound - Target Database does not exists on the server.\n\n * 400 LongTermRetentionMigrationStorageTypeNotSupported - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 LongTermRetentionMigrationStorageMismatch - Active backup redundancy of database does not match backup redundancy requested by customer.\n\n * 400 LongTermRetentionMigrationDatabaseTypeNotSupported - LTR migration is only supported for managed instance and Azure SQL DB LTR backups.\n\n * 400 VBSEnclaveResourcePoolInvalidCombination - Adding a database with '{0}' preferredEnclaveType to an elastic pool '{1}' with '{2}' preferredEnclaveType is not supported. \nBefore adding the database to the elastic pool, ensure that the preferredEnclaveType is the same for both the database and the elastic pool. More information can be found on https://aka.ms/AlwaysEncryptedEnableSecureEnclaves\n\n * 400 VBSEnclaveNotSupportedForDW - The preferredEnclaveType is not supported for dedicated SQL Pools.\n\n * 400 VBSEnclaveNotSupportedForDCSeriesSLO - Configuring the 'VBS' preferredEnclaveType for databases using the DC-series hardware configuration is not supported. DC-series databases are pre-configured with Intel SGX enclaves. Virtualization based security (VBS) enclaves are not supported.\n\n * 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave - Configuring geo-replication is not supported for databases using different values of the preferredEnclaveType property. The primary '{0}' database on the '{1}' server uses the '{2}' preferredEnclaveType, whereas the specified preferredEnclaveType for the secondary '{3}' database on the '{4}' server is '{5}'.\n\n * 400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes - Planned failover between primary and secondary database with different preferredEnclaveType is not supported for Virtualization-based security (VBS) enclaves.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 LongTermRetentionMigrationBackupNotFound - LTR backup specified does not exists.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 FreeDbAlreadyExists - Only one free database can exist for a subscription per region.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 UpdateSloFailedDatabaseTooBusy - Update SLO operation could not complete because database was too busy.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 TargetElasticPoolBeingUpdated - The update of elastic pool cannot be started because there is copy operation in progress for one of the databases in this elastic pool\n\n * 409 DatabaseCopyLimitPerReplicaReached - User reached the limit of concurrent database copies.\n\n * 409 ConflictRequestToUpdateBackupRedundancy - A conflict request to change backup storage redundancy is still in progress.\n\n * 409 DatabaseElasticPoolMaintenanceConflict - User tried to create or update a database with a specified maintenance configuration that conflicted with that of the elastic pool of the database.\n\n * 409 SubscriptionVcoreQuotaExceeded - Could not perform the operation because subscription would exceed the allowed vCore quota.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 LongTermRetentionMigrationRequestConflict - A conflict operation on this LTR backup is still in progress.\n\n * 409 LongTermRetentionMigrationBackupConflict - Another LTR backup with same backup time for target database exists.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 500 LongTermRetentionMigrationRequestCopyFailed - Copy operation failed for LTR backup blobs.\n\n * 500 LongTermRetentionMigrationRestoreVerExceeded - Restore verification failed after max attempts were reached.\n\n * 500 LongTermRetentionMigrationRestoreVerFailed - Restore verification failed.\n\n * 500 LongTermRetentionMigrationRequestFailedToStartOnTarget - Failed to start LTR backup copy request in target region.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidDatabaseCreateOrUpdateRequest - The request body for the create or update database operation is invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSourceDatabaseId - Invalid source database identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MissingCollation - Collation is required.\n\n * 400 MissingMaxSizeBytes - MaxSizeBytes is required.\n\n * 400 MissingSkuName - Sku name is required.\n\n * 400 MissingSourceDatabaseId - Missing source database identifier.\n\n * 400 InvalidLicenseType - The specified license type is invalid.\n\n * 400 InvalidSkuName - Invalid SKU name.\n\n * 400 MismatchedSkuNameAndCapacity - Mismatch between SKU name and capacity.\n\n * 400 MismatchedSkuNameAndTier - Mismatch between SKU name and tier.\n\n * 400 MismatchedSkuNameAndFamily - Mismatch between SKU name and family.\n\n * 400 LedgerNotAllowedWithSpecifiedCreateMode - IsLedgerOn is not allowed with the specified create mode.\n\n * 400 LedgerNotAllowedOnSampleDatabase - Database creation is not allowed with IsLedgerOn for a sample database.\n\n * 400 FreeLimitDatabaseNotAllowedInNonDefaultCreate - Free limit database creation is not allowed in non default create mode.\n\n * 400 AvailabilityZoneNotSupported - Requested availability zones for databases and elastic pools is not valid.\n\n * 400 MethodNotAllowedOnSpecifiedCreateMode - Http Patch or Merge not allowed on the specified create mode\n\n * 400 DatabaseNameDoesNotMatchSourceDatabaseId - The database name specified doesn’t match the database name in sourceDatabaseId.\n\n * 400 ElasticPoolNotSupportedForExternalBackupRestore - Elastic pool is not supported for external backup restore\n\n * 400 InvalidRecoverableDatabaseId - Invalid recoverable database identifier.\n\n * 400 InvalidRecoveryServicesRecoveryPointId - Invalid recovery services recovery point identifier.\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 MissingRecoverableDatabaseId - Missing recoverable database identifier.\n\n * 400 MissingRecoveryServicesRecoveryPointId - Missing recovery services recovery point Id.\n\n * 400 MissingRestorableDroppedDatabaseId - Missing restorableDroppedDatabaseId\n\n * 400 MissingRestorePointInTime - Missing restore point in time\n\n * 400 MissingSourceDatabaseDeletionDate - Missing source database deletion date\n\n * 400 MissingStorageContainerSasToken - Missing storage container SAS token\n\n * 400 MissingStorageContainerUri - Missing storage container URI\n\n * 400 RestorableDroppedDatabaseIdGivenForRestoreWithSourceDatabaseId - Cannot specify restorableDroppedDatabaseId when sourceDatabaseId is already given in restore create mode\n\n * 400 MultipleIdentitiesOnDatabase - Only one user assigned managed identity is supported at the Database Level.\n\n * 400 MultipleIdentityDelegationsOnDatabase - Only one identity delegation is supported at the Database Level.\n\n * 400 MissingPrimaryDelegatedIdentityClientId - In order to use delegated identities please provide a primary delegated identity client id.\n\n * 400 UnsupportedBackupStorageRedundancy - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 BackupSetNotFoundRecentPit - No backups were found to restore the database to the specified point in time. Please retry the operation. If the problem persists, contact support to restore the database.\n\n * 400 CannotUpdateIsLedgerDatabase - The ledger property of an existing database cannot be updated.\n\n * 400 LTRSterlingToVldbMigrationNotSupported - Cannot change service objective for database to Hyperscale as long-term retention is not yet supported on Hyperscale. Please disable long-term retention on the database and retry.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 InvalidPublicMaintenanceConfiguration - User tried to specify public maintenance configuration which cannot be converted to internal id (malformed or wrong region).\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 MaintenanceWindowNotSupportedForNamedReplica - User tried to create or update named replica with non-default maintenance window which is not supported.\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 InvalidStandbyGeoReadScale - User attempted to enable read scale on a standby geo database that does not support it.\n\n * 400 PerDatabaseCMKKeyRotationAttemptedWhileOldThumbprintInUse - Key Rotation for the TDE Protector at the database level is blocked when active transactions are holding up the log encrypted with old keys. Please refer to aka.ms/azuresqldbkeyrotation for possible strategies to workaround this issue.\n\n * 400 TierChangeUnsupportedDueToCDCEnabledDatabase - The database cannot update its sku because it is enabled for CDC.\n\n * 400 PerDBCMKNotSupportedWithLTR - Database-level CMK is not supported when Long-term Backup Retention is enabled on the database.\n\n * 400 VBSEnclaveNotSupportedForDW - The preferredEnclaveType is not supported for dedicated SQL Pools.\n\n * 400 VBSEnclaveNotSupportedForDCSeriesSLO - Configuring the 'VBS' preferredEnclaveType for databases using the DC-series hardware configuration is not supported. DC-series databases are pre-configured with Intel SGX enclaves. Virtualization based security (VBS) enclaves are not supported.\n\n * 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutDatabaseLevelEncryptionProtector - Database-level encryption protector must be set on the target database while attempting to copy or replicate a database encrypted with a database level key.\n\n * 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeys - While attempting to replicate a database configured with database level encryption protector, the current keys being used by the primary must be passed to the secondary database.\n\n * 400 PartnerDBNotCompatibleForSGXEnclave - Attempt to set GeoDR link or update SLO for enclave enabled database is only supported when both database are running on DC-series hardware.\n\n * 400 PerDatabaseCMKGeoPrimaryIsNotConfiguredWithDatabaseLevelEncryptionProtector - The geo-primary database must be configured with a database level encryption protector before setting a database level encryption protector on the geo-secondary.\n\n * 400 ElasticJobsNotSupportedOnAutoPauseEnabledDatabase - Auto-pause enabled serverless database is not supported as an Elastic Jobs database because job agent would prevent that database from pausing. You can either disable auto-pause on this serverless database or delete the job agent that is using this database. See here for more details: https://docs.microsoft.com/azure/azure-sql/database/serverless-tier-overview#auto-pausing\n\n * 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave - Configuring geo-replication is not supported for databases using different values of the preferredEnclaveType property. The primary '{0}' database on the '{1}' server uses the '{2}' preferredEnclaveType, whereas the specified preferredEnclaveType for the secondary '{3}' database on the '{4}' server is '{5}'.\n\n * 400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes - Planned failover between primary and secondary database with different preferredEnclaveType is not supported for Virtualization-based security (VBS) enclaves.\n\n * 400 PerDatabaseCMKGeoPrimaryIsConfiguredWithDatabaseLevelEncryptionProtector - The geo-primary database must not be configured with a database level encryption protector when failing over to a geo-secondary without a database level encryption protector.\n\n * 400 CreateDatabaseAttemptedWithRotationInProgress - The create database operation can not be performed at this time due to ongoing Transparent Data Encryption (TDE) key rotation on the server. Please try the operation again later.\n\n * 400 VBSEnclaveResourcePoolInvalidCombination - Adding a database with '{0}' preferredEnclaveType to an elastic pool '{1}' with '{2}' preferredEnclaveType is not supported. \nBefore adding the database to the elastic pool, ensure that the preferredEnclaveType is the same for both the database and the elastic pool. More information can be found on https://aka.ms/AlwaysEncryptedEnableSecureEnclaves\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 InvalidDatabaseCreateMode - Invalid request to create a database.\n\n * 400 MissingAsymmetricKeyOnTargetServer - Target server does not have access to an asymmetric key.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MultipleDroppedDatabasesWithTheSameName - Found multiple dropped databases with the same name on server.\n\n * 400 AzureKeyVaultClientError - The Azure Key Vault client encountered an error.\n\n * 400 AzureKeyVaultClientInfoError - An error occurred while obtaining information for the Azure Key Vault client.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 AzureKeyVaultKeyThumbprintIsDifferent - The operation could not be completed because the Azure Key Vault Key material is different than the current encryption protector key.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 HyperscaleReverseMigrationNotSupported - Reverse migration of a Hyperscale database to Sterling hit an unsupported scenario.\n\n * 400 UpdateSloOperationIdDoesNotExist - The action failed because no active update-slo operation detected for server: {0}, database: {1};. Please retry the operation by specifying valid parameters.\n\n * 400 ManualCutoverUnsupported - Invalid use of manual-cutover option. Please check current and requested service objective and retry the operation by specifying valid parameters.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 IsLedgerDatabaseIsNotSupportedOnResourceType - Changing the ledger property is not supported for this resource type.\n\n * 400 DatabaseNameInUse - Database already exists. Choose a different database name.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 UnableToCreateGeoChain - User attempted to create secondary database (chaining) even though automatic upload of ledger digests has been configured\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 TargetElasticPoolDoesNotExist - The elastic pool does not exist on a server.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 ElasticPoolNameRequired - User tried to create or update database to elastic pool service objective without specifying the name of the elastic pool.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 InvalidReadScaleEdition - User attempted to enable read scale on a database type that does not support it.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 GeoSecondaryMaxSizeUpdateFailed - The geo-secondary database is of a SLO that does not support the requested maxsize value or the geo-secondary is in an unsupported region or an update operation is already in progress on the geo-secondary database.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 SourceDatabaseEncryptionProtectorKeyUriRequiredForPerDatabaseCMKCopyOrReplication - Geo secondary database missing AKV of geo primary database\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 RequestedDatabaseSizeRequiresShrink - User attempted to ALTER DATABASE MODIFY MAXSIZE to modify the MAXSIZE for a database to a smaller size then the current size.\n\n * 400 CurrentDatabaseSizeExceedsDbMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 SecurityAzureKeyVaultGeoChainError - Creating secondary of secondary (a process known as chaining) is not supported when enabling Transparent Data Encryption using Azure Key Vault (BYOK).\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 UnsupportedCapacity - User tried to create or update database with capacity which is not supported.\n\n * 400 RestoreToFreeEditionNotSupported - Restore and GeoRestore target cannot be free database.\n\n * 400 RestoreNotSupportedForFreeEdition - Restore and GeoRestore are not supported for free database.\n\n * 400 InvalidDroppedDatabase - Source database dropped does not exist on server within the supported recovery period.\n\n * 400 InvalidLiveDatabase - Source database does not exist on server within the supported recovery period. If restoring a dropped database, please specify its deletion date.\n\n * 400 InvalidVldbRecoverySlo - The Hyperscale edition recovery requires both source and target databases to use Hyperscale service level objective.\n\n * 400 InvalidVldbRestoreSlo - The Hyperscale edition Point-In-Time restore requires both source and target databases to use Hyperscale service level objective.\n\n * 400 CannotSpecifyPoolOrSlo - Specifying an elastic pool and/or changing the service level objective or edition is not supported for edition.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 InvalidBackupStorageAccountType - User passed zrs/lrs during create/update of a database but it failed either because the customer is not whitelisted or because zrs is not available in the specified region.\n\n * 400 DatabaseInvalidSkuPropertyCombination - The properties of the requested sku are inconsistent. Please check that a valid combination is specified. See https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability for more details.\n\n * 400 DatabaseNamedReplicaPerDatabaseLimitExceeded - User tried create a named replica that would exceed the allowed number per primary database\n\n * 400 UnsupportedBackupStorageRedundancyForEdition - The requested backup storage redundancy is not supported for edition\n\n * 400 DatabaseIsCurrentlyPinned - Microsoft has pinned your database SQL Server engine version. To ensure your database does not hit production issues, any future scale operations on your database will be blocked until it has been un-pinned. Please contact Microsoft support for assistance with scaling.\n\n * 400 RestoreTargetEditionSizeInsufficient - User attempted to restore a database to an edition that is a smaller size than the current allocated size of the source.\n\n * 400 InvalidIdentityId - One or more identity id(s) provided are not valid ARM resource id(s). Please input valid id(s) and try again.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 DatabaseCreationBlockedForNonActivatedCMKServer - SQL Pool creations are blocked for CMK enabled workspaces until the workspace is activated. First, enable purge protection and grant the workspace Managed Identity the required permissions (Get, Wrap Key, Unwrap Key) on the Azure Key Vault of the workspace key. Next, activate your workspace after you have granted access.\n\n * 400 InvalidNumberOfIdentities - Only one user assigned managed identity is supported at the Database Level.\n\n * 400 NoRestorePointAvailable - The source database has not yet accomplished its first backup in order to support restore operations. Please retry the restore request later.\n\n * 400 DatabaseNamedReplicaChainingNotAllowed - User tried to create a named replica of a named replica which is not allowed.\n\n * 400 DatabaseNamedReplicaInvalidOperation - User attempted an unsupported operation on a named replica.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 DatabaseNamedReplicaInvalidSourceDatabase - User attempted to create a named replica in a different subscription or region than the source database.\n\n * 400 DatabaseNamedReplicaSourceDatabaseNotZoneRedundant - Zone Redundancy cannot be enabled on this Named Replica since the primary Hyperscale Database is not zone redundant.\n\n * 400 CannotAssignIdentityToMaster - Cannot assign an identity to a system database. Database identity cannot be assigned to 'master', 'model', 'tempdb', 'msdb', or 'resource' databases.\n\n * 400 PerDatabaseCMKDWNotSupported - Database-level CMK in preview is not supported for Datawarehouse edition.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 MissingThumbprintCrm - The restore operation of a CRM database failed because a required TDE certificate was missing. Please retry the restore operation to an existing elastic pool.\n\n * 400 ElasticPoolOverStorage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 RestoreTargetEditionSizeInsufficientV2 - User attempted to restore a database to an edition that is a smaller size than the allocated size of the restored database.\n\n * 400 ResourcePoolStorageLimitHitDuringRestore - The restored database can't be restored into the resource pool due to the remaining storage capacity in the pool.\n\n * 400 PerDatabaseCMKRestoreNotSupported - Database restore is not supported when Database-level CMK is configured in preview.\n\n * 400 PerDatabaseCMKHSNotSupported - Database-level CMK in preview is not supported for Hyperscale edition.\n\n * 400 PerDatabaseCMKGeoReplicationNotSupported - Geo Replication and Database Copy is not supported when Database-level CMK is configured in preview.\n\n * 400 InvalidStandbyGeoEdition - User attempted to create a DTU based standby geo.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 GeoRestoreBackupStorageTypeNotSupported - Database recovery requests are invalid when issued against a database that is not configured to use geo-redundant backup storage.\n\n * 400 RestoreHyperscaleToNonHyperscale - Restoring a Hyperscale database backup to a non-Hyperscale service tier or vice versa is not supported.\n\n * 400 SubscriptionDoesNotHaveAccessToServer - The subscription does not have access to the specified server(s)\n\n * 400 RecoveryPointDoesNotExist - The specified recovery point either does not exist or is not valid.\n\n * 400 LtrBackupNotFound - The specified long term retention backup does not exist.\n\n * 400 InvalidPointInTime - The specified point in time is not valid for the database.\n\n * 400 GeoRestoreCannotResolveTargetCluster - Cannot resolve target cluster for server\n\n * 400 CannotSpecifyEditionOrSloWhenRestoringToPool - Specifying the target service level objective or edition is not supported when restoring to an elastic pool.\n\n * 400 RestoreNotSupportedForGeoDrSecondary - Point-in-time restore and database recovery operations are not supported on databases that are currently configured as geo-secondaries.\n\n * 400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported - User attempted configuring backup retention policy on a Named Replica.\n\n * 400 GeoRedundantBackupsNotPermittedForSubscription - Geo-redundant backup storage is blocked for all databases under subscription '{0}' by preview feature 'Azure SQL Database Block Geo-redundant Backup Storage'. Please select a different backup storage redundancy.\n\n * 400 RestoreHyperscaleToNonHyperscaleElasticPool - Restoring a Hyperscale database to an elastic pool which is not Hyperscale or restoring a database which is not Hyperscale to a Hyperscale elastic pool is not supported.\n\n * 400 RestoreIneligibleDatabaseName - The specified target database name, '{0}', is reserved and cannot be used in a restore operation.\n\n * 400 RestoreNotSupportedForSystemDb - Restore and database recovery are not supported for system databases.\n\n * 400 RestoreIneligibleDroppedDatabaseShortLifespan - The source database, '{0}', dropped on '{1}', has not existed long enough to support restores.\n\n * 400 RestoreIneligibleLiveDatabaseShortLifespan - The source database, '{0}', has not yet accomplished its first backup in order to support restore operations. Please wait until at least the indicated earliest restore date '{1}' and resubmit the request.\n\n * 400 RestoreCrossServerDisabled - For point-in-time restores, the target logical server must be the same as the source logical server. Consider restoring to the source database's server, or using database copy or database recovery.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 RestoreSameServerRecoveryDisabled - Same-server recovery is currently not supported. Consider using point-in-time restore or recovering to a different server.\n\n * 400 RestoreNotSupportedFromLtrBackupToEdition - Restore from long-term retention backup to '{0}' edition not supported.\n\n * 400 RestoreNotSupportedFromExternalBackupToEdition - Restore from external backup to '{0}' edition not supported.\n\n * 400 UpdateToServerlessIfLtrIsNotDisabled - Enabling auto-pause for a serverless database is not supported if long-term backup retention is enabled.\n\n * 400 DuplicateRestoreOperation - A restore request with the same target database name '{0}' on server '{1}' already exists.\n\n * 400 ExternalBackupUriMalformed - The external backup storage container URI is malformed.\n\n * 400 ExternalBackupUriHostNotAllowed - The host name for the external backup storage container URI is not allowed.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 ExternalBackupUriInvalidSchemeOrPort - The external backup storage container URI uses an invalid scheme or port. Please use https and port 443.\n\n * 400 ExternalBackupVldbUnsupported - Hyperscale does not support external backup restore requests.\n\n * 400 InvalidPitrPriorToVldbMigration - For database '{0}', specified point-in-time '{1}' is prior to the Hyperscale migration time of '{2}'. Please specify a target edition or service level objective which is not Hyperscale when restoring to a point earlier than the Hyperscale migration.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 MissingKeyVaultUriForRestore - Azure Key Vault key URI '{0}' is required to successfully restore the database '{1}' under server '{2}'.\n\n * 400 BlockRestoreOnVldbGeoSecondary - Restore of Hyperscale database where source database is geo-secondary is not allowed.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 BackupSetNotFound - No backups were found to restore the database. Please contact support to restore the database.\n\n * 400 IncorrectAccessToAzureKeyVault - Target server does not have access to all AKV Uris created during the backup time.\n\n * 400 RestoreFailureSqlInstanceUnhealthy - Unable to connect to the instance in order to perform restore operation.\n\n * 400 BackupSetBroken - Backup set is broken.\n\n * 400 TimeoutDuringRestore - A timeout was encountered while trying to connect to the restore target.\n\n * 400 BrokenRestorePlanGapInLogBackups - The restore plan is broken because firstLsn of current log backup is not equal to lastLsn of prev log backup.\n\n * 400 FullBackupMissingChecksum - Provided full backup is missing checksum.\n\n * 400 RequiredBackupIsNotLastRestored - Migration cannot be completed because provided backup file name is not the name of the last backup file that is restored.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineDataFilesExist - Database backup contains incompatible physical layout. Non-online data files exist.\n\n * 400 IncompatiblePhysicalLayoutWrongNumberOfLogFiles - Database backup contains incompatible physical layout. Multiple log files are not supported.\n\n * 400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed - Changing backup storage redundancy is not allowed for LTR Copy operations.\n\n * 400 LtrRestoreFailedArchiveStorageTier - Restoring archived long-term retention backup is not supported. Restore can be performed only on rehydrated or regular long-term retention backups.\n\n * 400 LtrArchiveStorageTierNotEnabled - Archiving long-term retention backups is not enabled.\n\n * 400 LtrArchiveWrongParameters - ChangeLongTermRetentionBackupAccessTier is not supported for the desired (backupStorageAccessTier, operationMode) combination. Only (Archive, Move) and (Hot, Copy) are allowed.\n\n * 400 LTRArchiveRedundancyChangeFailed - Updating the backup storage redundancy type to zone-redundant storage is not supported when a long-term retention policy with the 'archive' backup storage access tier is set\n\n * 400 LongTermRetentionMigrationSubscriptionNotFound - The subscription could not be found.\n\n * 400 LtrOperationFailedBackupImmutable - Deleting Long Term Retention backup failed because the backup is immutable.\n\n * 400 LongTermRetentionMigrationRequestNotSupported - Subscription is not allowed LTR backup Migration feature.\n\n * 400 LongTermRetentionMigrationCrossClusterRequestNotSupported - Source and target subscriptions are not allowed to communicate for LTR backup copy feature.\n\n * 400 LongTermRetentionMigrationParameterMissing - Required parameter missing for the operation.\n\n * 400 LongTermRetentionMigrationSameServerNotSupported - LTR Copy feature is not supported to copy LTR backups within same server.\n\n * 400 LongTermRetentionMigrationTargetServerNotFound - Target server does not exists or is not ready for LTR backup copy operation.\n\n * 400 LongTermRetentionMigrationTargetDatabaseNotFound - Target Database does not exists on the server.\n\n * 400 LongTermRetentionMigrationStorageTypeNotSupported - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 LongTermRetentionMigrationStorageMismatch - Active backup redundancy of database does not match backup redundancy requested by customer.\n\n * 400 LongTermRetentionMigrationDatabaseTypeNotSupported - LTR migration is only supported for managed instance and Azure SQL DB LTR backups.\n\n * 400 VBSEnclaveResourcePoolInvalidCombination - Adding a database with '{0}' preferredEnclaveType to an elastic pool '{1}' with '{2}' preferredEnclaveType is not supported. \nBefore adding the database to the elastic pool, ensure that the preferredEnclaveType is the same for both the database and the elastic pool. More information can be found on https://aka.ms/AlwaysEncryptedEnableSecureEnclaves\n\n * 400 VBSEnclaveNotSupportedForDW - The preferredEnclaveType is not supported for dedicated SQL Pools.\n\n * 400 VBSEnclaveNotSupportedForDCSeriesSLO - Configuring the 'VBS' preferredEnclaveType for databases using the DC-series hardware configuration is not supported. DC-series databases are pre-configured with Intel SGX enclaves. Virtualization based security (VBS) enclaves are not supported.\n\n * 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave - Configuring geo-replication is not supported for databases using different values of the preferredEnclaveType property. The primary '{0}' database on the '{1}' server uses the '{2}' preferredEnclaveType, whereas the specified preferredEnclaveType for the secondary '{3}' database on the '{4}' server is '{5}'.\n\n * 400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes - Planned failover between primary and secondary database with different preferredEnclaveType is not supported for Virtualization-based security (VBS) enclaves.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 LongTermRetentionMigrationBackupNotFound - LTR backup specified does not exists.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 FreeDbAlreadyExists - Only one free database can exist for a subscription per region.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 UpdateSloFailedDatabaseTooBusy - Update SLO operation could not complete because database was too busy.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 TargetElasticPoolBeingUpdated - The update of elastic pool cannot be started because there is copy operation in progress for one of the databases in this elastic pool\n\n * 409 DatabaseCopyLimitPerReplicaReached - User reached the limit of concurrent database copies.\n\n * 409 ConflictRequestToUpdateBackupRedundancy - A conflict request to change backup storage redundancy is still in progress.\n\n * 409 DatabaseElasticPoolMaintenanceConflict - User tried to create or update a database with a specified maintenance configuration that conflicted with that of the elastic pool of the database.\n\n * 409 SubscriptionVcoreQuotaExceeded - Could not perform the operation because subscription would exceed the allowed vCore quota.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 LongTermRetentionMigrationRequestConflict - A conflict operation on this LTR backup is still in progress.\n\n * 409 LongTermRetentionMigrationBackupConflict - Another LTR backup with same backup time for target database exists.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 500 LongTermRetentionMigrationRequestCopyFailed - Copy operation failed for LTR backup blobs.\n\n * 500 LongTermRetentionMigrationRestoreVerExceeded - Restore verification failed after max attempts were reached.\n\n * 500 LongTermRetentionMigrationRestoreVerFailed - Restore verification failed.\n\n * 500 LongTermRetentionMigrationRequestFailedToStartOnTarget - Failed to start LTR backup copy request in target region.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Creating or updating the database is in progress." + "description": "Creating or updating the database is in progress.", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully created the database.", @@ -297,13 +302,18 @@ "description": "Successfully deleted the database." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 LedgerNoDropPrimary - The Geo-primary database cannot be dropped because the database has Ledger Digest Uploads enabled. Disable Ledger Digest Uploads and retry the operation.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 CannotDropDatabaseAKVError - The database {0} on server {1} cannot be safely dropped because it is encrypted with a customer managed key that is no longer accessible to take the last backup before drop. Please restore Azure Key Vault Access on the server and revalidate the keys to make this database accessible and then proceed with the drop. For details see https://aka.ms/tdecmkrestorability\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "description": "*** Error Responses: ***\n\n * 400 LedgerNoDropPrimary - The Geo-primary database cannot be dropped because the database has Ledger Digest Uploads enabled. Disable Ledger Digest Uploads and retry the operation.\n\n * 400 CannotDropDatabaseAKVError - The database {0} on server {1} cannot be safely dropped because it is encrypted with a customer managed key that is no longer accessible to take the last backup before drop. Please restore Azure Key Vault Access on the server and revalidate the keys to make this database accessible and then proceed with the drop. For details see https://aka.ms/tdecmkrestorability\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Deleting the database is in progress." + "description": "Deleting the database is in progress.", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "The specified database does not exist." @@ -359,13 +369,18 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidDatabaseCreateOrUpdateRequest - The request body for the create or update database operation is invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSourceDatabaseId - Invalid source database identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MissingCollation - Collation is required.\n\n * 400 MissingMaxSizeBytes - MaxSizeBytes is required.\n\n * 400 MissingSkuName - Sku name is required.\n\n * 400 MissingSourceDatabaseId - Missing source database identifier.\n\n * 400 InvalidLicenseType - The specified license type is invalid.\n\n * 400 InvalidSkuName - Invalid SKU name.\n\n * 400 MismatchedSkuNameAndCapacity - Mismatch between SKU name and capacity.\n\n * 400 MismatchedSkuNameAndTier - Mismatch between SKU name and tier.\n\n * 400 MismatchedSkuNameAndFamily - Mismatch between SKU name and family.\n\n * 400 LedgerNotAllowedWithSpecifiedCreateMode - IsLedgerOn is not allowed with the specified create mode.\n\n * 400 LedgerNotAllowedOnSampleDatabase - Database creation is not allowed with IsLedgerOn for a sample database.\n\n * 400 FreeLimitDatabaseNotAllowedInNonDefaultCreate - Free limit database creation is not allowed in non default create mode.\n\n * 400 AvailabilityZoneNotSupported - Requested availability zones for databases and elastic pools is not valid.\n\n * 400 DatabaseNameDoesNotMatchSourceDatabaseId - The database name specified doesn’t match the database name in sourceDatabaseId.\n\n * 400 ElasticPoolNotSupportedForExternalBackupRestore - Elastic pool is not supported for external backup restore\n\n * 400 InvalidRecoverableDatabaseId - Invalid recoverable database identifier.\n\n * 400 InvalidRecoveryServicesRecoveryPointId - Invalid recovery services recovery point identifier.\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 MissingRecoverableDatabaseId - Missing recoverable database identifier.\n\n * 400 MissingRecoveryServicesRecoveryPointId - Missing recovery services recovery point Id.\n\n * 400 MissingRestorableDroppedDatabaseId - Missing restorableDroppedDatabaseId\n\n * 400 MissingRestorePointInTime - Missing restore point in time\n\n * 400 MissingSourceDatabaseDeletionDate - Missing source database deletion date\n\n * 400 MissingStorageContainerSasToken - Missing storage container SAS token\n\n * 400 MissingStorageContainerUri - Missing storage container URI\n\n * 400 RestorableDroppedDatabaseIdGivenForRestoreWithSourceDatabaseId - Cannot specify restorableDroppedDatabaseId when sourceDatabaseId is already given in restore create mode\n\n * 400 MultipleIdentitiesOnDatabase - Only one user assigned managed identity is supported at the Database Level.\n\n * 400 MultipleIdentityDelegationsOnDatabase - Only one identity delegation is supported at the Database Level.\n\n * 400 MissingPrimaryDelegatedIdentityClientId - In order to use delegated identities please provide a primary delegated identity client id.\n\n * 400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed - Changing backup storage redundancy is not allowed for LTR Copy operations.\n\n * 400 LtrRestoreFailedArchiveStorageTier - Restoring archived long-term retention backup is not supported. Restore can be performed only on rehydrated or regular long-term retention backups.\n\n * 400 LtrArchiveStorageTierNotEnabled - Archiving long-term retention backups is not enabled.\n\n * 400 LtrArchiveWrongParameters - ChangeLongTermRetentionBackupAccessTier is not supported for the desired (backupStorageAccessTier, operationMode) combination. Only (Archive, Move) and (Hot, Copy) are allowed.\n\n * 400 LTRArchiveRedundancyChangeFailed - Updating the backup storage redundancy type to zone-redundant storage is not supported when a long-term retention policy with the 'archive' backup storage access tier is set\n\n * 400 LongTermRetentionMigrationSubscriptionNotFound - The subscription could not be found.\n\n * 400 LtrOperationFailedBackupImmutable - Deleting Long Term Retention backup failed because the backup is immutable.\n\n * 400 LongTermRetentionMigrationRequestNotSupported - Subscription is not allowed LTR backup Migration feature.\n\n * 400 LongTermRetentionMigrationCrossClusterRequestNotSupported - Source and target subscriptions are not allowed to communicate for LTR backup copy feature.\n\n * 400 LongTermRetentionMigrationParameterMissing - Required parameter missing for the operation.\n\n * 400 LongTermRetentionMigrationSameServerNotSupported - LTR Copy feature is not supported to copy LTR backups within same server.\n\n * 400 LongTermRetentionMigrationTargetServerNotFound - Target server does not exists or is not ready for LTR backup copy operation.\n\n * 400 LongTermRetentionMigrationTargetDatabaseNotFound - Target Database does not exists on the server.\n\n * 400 LongTermRetentionMigrationStorageTypeNotSupported - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 LongTermRetentionMigrationStorageMismatch - Active backup redundancy of database does not match backup redundancy requested by customer.\n\n * 400 LongTermRetentionMigrationDatabaseTypeNotSupported - LTR migration is only supported for managed instance and Azure SQL DB LTR backups.\n\n * 400 UnsupportedBackupStorageRedundancy - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 BackupSetNotFoundRecentPit - No backups were found to restore the database to the specified point in time. Please retry the operation. If the problem persists, contact support to restore the database.\n\n * 400 CannotUpdateIsLedgerDatabase - The ledger property of an existing database cannot be updated.\n\n * 400 LTRSterlingToVldbMigrationNotSupported - Cannot change service objective for database to Hyperscale as long-term retention is not yet supported on Hyperscale. Please disable long-term retention on the database and retry.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 InvalidPublicMaintenanceConfiguration - User tried to specify public maintenance configuration which cannot be converted to internal id (malformed or wrong region).\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 MaintenanceWindowNotSupportedForNamedReplica - User tried to create or update named replica with non-default maintenance window which is not supported.\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 InvalidStandbyGeoReadScale - User attempted to enable read scale on a standby geo database that does not support it.\n\n * 400 PerDatabaseCMKKeyRotationAttemptedWhileOldThumbprintInUse - Key Rotation for the TDE Protector at the database level is blocked when active transactions are holding up the log encrypted with old keys. Please refer to aka.ms/azuresqldbkeyrotation for possible strategies to workaround this issue.\n\n * 400 TierChangeUnsupportedDueToCDCEnabledDatabase - The database cannot update its sku because it is enabled for CDC.\n\n * 400 PerDBCMKNotSupportedWithLTR - Database-level CMK is not supported when Long-term Backup Retention is enabled on the database.\n\n * 400 VBSEnclaveNotSupportedForDW - The preferredEnclaveType is not supported for dedicated SQL Pools.\n\n * 400 VBSEnclaveNotSupportedForDCSeriesSLO - Configuring the 'VBS' preferredEnclaveType for databases using the DC-series hardware configuration is not supported. DC-series databases are pre-configured with Intel SGX enclaves. Virtualization based security (VBS) enclaves are not supported.\n\n * 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutDatabaseLevelEncryptionProtector - Database-level encryption protector must be set on the target database while attempting to copy or replicate a database encrypted with a database level key.\n\n * 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeys - While attempting to replicate a database configured with database level encryption protector, the current keys being used by the primary must be passed to the secondary database.\n\n * 400 PartnerDBNotCompatibleForSGXEnclave - Attempt to set GeoDR link or update SLO for enclave enabled database is only supported when both database are running on DC-series hardware.\n\n * 400 PerDatabaseCMKGeoPrimaryIsNotConfiguredWithDatabaseLevelEncryptionProtector - The geo-primary database must be configured with a database level encryption protector before setting a database level encryption protector on the geo-secondary.\n\n * 400 ElasticJobsNotSupportedOnAutoPauseEnabledDatabase - Auto-pause enabled serverless database is not supported as an Elastic Jobs database because job agent would prevent that database from pausing. You can either disable auto-pause on this serverless database or delete the job agent that is using this database. See here for more details: https://docs.microsoft.com/azure/azure-sql/database/serverless-tier-overview#auto-pausing\n\n * 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave - Configuring geo-replication is not supported for databases using different values of the preferredEnclaveType property. The primary '{0}' database on the '{1}' server uses the '{2}' preferredEnclaveType, whereas the specified preferredEnclaveType for the secondary '{3}' database on the '{4}' server is '{5}'.\n\n * 400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes - Planned failover between primary and secondary database with different preferredEnclaveType is not supported for Virtualization-based security (VBS) enclaves.\n\n * 400 PerDatabaseCMKGeoPrimaryIsConfiguredWithDatabaseLevelEncryptionProtector - The geo-primary database must not be configured with a database level encryption protector when failing over to a geo-secondary without a database level encryption protector.\n\n * 400 CreateDatabaseAttemptedWithRotationInProgress - The create database operation can not be performed at this time due to ongoing Transparent Data Encryption (TDE) key rotation on the server. Please try the operation again later.\n\n * 400 VBSEnclaveResourcePoolInvalidCombination - Adding a database with '{0}' preferredEnclaveType to an elastic pool '{1}' with '{2}' preferredEnclaveType is not supported. \nBefore adding the database to the elastic pool, ensure that the preferredEnclaveType is the same for both the database and the elastic pool. More information can be found on https://aka.ms/AlwaysEncryptedEnableSecureEnclaves\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 InvalidDatabaseCreateMode - Invalid request to create a database.\n\n * 400 MissingAsymmetricKeyOnTargetServer - Target server does not have access to an asymmetric key.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MultipleDroppedDatabasesWithTheSameName - Found multiple dropped databases with the same name on server.\n\n * 400 AzureKeyVaultClientError - The Azure Key Vault client encountered an error.\n\n * 400 AzureKeyVaultClientInfoError - An error occurred while obtaining information for the Azure Key Vault client.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 AzureKeyVaultKeyThumbprintIsDifferent - The operation could not be completed because the Azure Key Vault Key material is different than the current encryption protector key.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 HyperscaleReverseMigrationNotSupported - Reverse migration of a Hyperscale database to Sterling hit an unsupported scenario.\n\n * 400 UpdateSloOperationIdDoesNotExist - The action failed because no active update-slo operation detected for server: {0}, database: {1};. Please retry the operation by specifying valid parameters.\n\n * 400 ManualCutoverUnsupported - Invalid use of manual-cutover option. Please check current and requested service objective and retry the operation by specifying valid parameters.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 IsLedgerDatabaseIsNotSupportedOnResourceType - Changing the ledger property is not supported for this resource type.\n\n * 400 DatabaseNameInUse - Database already exists. Choose a different database name.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 UnableToCreateGeoChain - User attempted to create secondary database (chaining) even though automatic upload of ledger digests has been configured\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 TargetElasticPoolDoesNotExist - The elastic pool does not exist on a server.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 ElasticPoolNameRequired - User tried to create or update database to elastic pool service objective without specifying the name of the elastic pool.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 InvalidReadScaleEdition - User attempted to enable read scale on a database type that does not support it.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 GeoSecondaryMaxSizeUpdateFailed - The geo-secondary database is of a SLO that does not support the requested maxsize value or the geo-secondary is in an unsupported region or an update operation is already in progress on the geo-secondary database.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 SourceDatabaseEncryptionProtectorKeyUriRequiredForPerDatabaseCMKCopyOrReplication - Geo secondary database missing AKV of geo primary database\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 RequestedDatabaseSizeRequiresShrink - User attempted to ALTER DATABASE MODIFY MAXSIZE to modify the MAXSIZE for a database to a smaller size then the current size.\n\n * 400 CurrentDatabaseSizeExceedsDbMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 SecurityAzureKeyVaultGeoChainError - Creating secondary of secondary (a process known as chaining) is not supported when enabling Transparent Data Encryption using Azure Key Vault (BYOK).\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 UnsupportedCapacity - User tried to create or update database with capacity which is not supported.\n\n * 400 RestoreToFreeEditionNotSupported - Restore and GeoRestore target cannot be free database.\n\n * 400 RestoreNotSupportedForFreeEdition - Restore and GeoRestore are not supported for free database.\n\n * 400 InvalidDroppedDatabase - Source database dropped does not exist on server within the supported recovery period.\n\n * 400 InvalidLiveDatabase - Source database does not exist on server within the supported recovery period. If restoring a dropped database, please specify its deletion date.\n\n * 400 InvalidVldbRecoverySlo - The Hyperscale edition recovery requires both source and target databases to use Hyperscale service level objective.\n\n * 400 InvalidVldbRestoreSlo - The Hyperscale edition Point-In-Time restore requires both source and target databases to use Hyperscale service level objective.\n\n * 400 CannotSpecifyPoolOrSlo - Specifying an elastic pool and/or changing the service level objective or edition is not supported for edition.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 InvalidBackupStorageAccountType - User passed zrs/lrs during create/update of a database but it failed either because the customer is not whitelisted or because zrs is not available in the specified region.\n\n * 400 DatabaseInvalidSkuPropertyCombination - The properties of the requested sku are inconsistent. Please check that a valid combination is specified. See https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability for more details.\n\n * 400 DatabaseNamedReplicaPerDatabaseLimitExceeded - User tried create a named replica that would exceed the allowed number per primary database\n\n * 400 UnsupportedBackupStorageRedundancyForEdition - The requested backup storage redundancy is not supported for edition\n\n * 400 DatabaseIsCurrentlyPinned - Microsoft has pinned your database SQL Server engine version. To ensure your database does not hit production issues, any future scale operations on your database will be blocked until it has been un-pinned. Please contact Microsoft support for assistance with scaling.\n\n * 400 RestoreTargetEditionSizeInsufficient - User attempted to restore a database to an edition that is a smaller size than the current allocated size of the source.\n\n * 400 InvalidIdentityId - One or more identity id(s) provided are not valid ARM resource id(s). Please input valid id(s) and try again.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 DatabaseCreationBlockedForNonActivatedCMKServer - SQL Pool creations are blocked for CMK enabled workspaces until the workspace is activated. First, enable purge protection and grant the workspace Managed Identity the required permissions (Get, Wrap Key, Unwrap Key) on the Azure Key Vault of the workspace key. Next, activate your workspace after you have granted access.\n\n * 400 InvalidNumberOfIdentities - Only one user assigned managed identity is supported at the Database Level.\n\n * 400 NoRestorePointAvailable - The source database has not yet accomplished its first backup in order to support restore operations. Please retry the restore request later.\n\n * 400 DatabaseNamedReplicaChainingNotAllowed - User tried to create a named replica of a named replica which is not allowed.\n\n * 400 DatabaseNamedReplicaInvalidOperation - User attempted an unsupported operation on a named replica.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 DatabaseNamedReplicaInvalidSourceDatabase - User attempted to create a named replica in a different subscription or region than the source database.\n\n * 400 DatabaseNamedReplicaSourceDatabaseNotZoneRedundant - Zone Redundancy cannot be enabled on this Named Replica since the primary Hyperscale Database is not zone redundant.\n\n * 400 CannotAssignIdentityToMaster - Cannot assign an identity to a system database. Database identity cannot be assigned to 'master', 'model', 'tempdb', 'msdb', or 'resource' databases.\n\n * 400 PerDatabaseCMKDWNotSupported - Database-level CMK in preview is not supported for Datawarehouse edition.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 MissingThumbprintCrm - The restore operation of a CRM database failed because a required TDE certificate was missing. Please retry the restore operation to an existing elastic pool.\n\n * 400 ElasticPoolOverStorage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 RestoreTargetEditionSizeInsufficientV2 - User attempted to restore a database to an edition that is a smaller size than the allocated size of the restored database.\n\n * 400 ResourcePoolStorageLimitHitDuringRestore - The restored database can't be restored into the resource pool due to the remaining storage capacity in the pool.\n\n * 400 PerDatabaseCMKRestoreNotSupported - Database restore is not supported when Database-level CMK is configured in preview.\n\n * 400 PerDatabaseCMKHSNotSupported - Database-level CMK in preview is not supported for Hyperscale edition.\n\n * 400 PerDatabaseCMKGeoReplicationNotSupported - Geo Replication and Database Copy is not supported when Database-level CMK is configured in preview.\n\n * 400 InvalidStandbyGeoEdition - User attempted to create a DTU based standby geo.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 GeoRestoreBackupStorageTypeNotSupported - Database recovery requests are invalid when issued against a database that is not configured to use geo-redundant backup storage.\n\n * 400 RestoreHyperscaleToNonHyperscale - Restoring a Hyperscale database backup to a non-Hyperscale service tier or vice versa is not supported.\n\n * 400 SubscriptionDoesNotHaveAccessToServer - The subscription does not have access to the specified server(s)\n\n * 400 RecoveryPointDoesNotExist - The specified recovery point either does not exist or is not valid.\n\n * 400 LtrBackupNotFound - The specified long term retention backup does not exist.\n\n * 400 InvalidPointInTime - The specified point in time is not valid for the database.\n\n * 400 GeoRestoreCannotResolveTargetCluster - Cannot resolve target cluster for server\n\n * 400 CannotSpecifyEditionOrSloWhenRestoringToPool - Specifying the target service level objective or edition is not supported when restoring to an elastic pool.\n\n * 400 RestoreNotSupportedForGeoDrSecondary - Point-in-time restore and database recovery operations are not supported on databases that are currently configured as geo-secondaries.\n\n * 400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported - User attempted configuring backup retention policy on a Named Replica.\n\n * 400 GeoRedundantBackupsNotPermittedForSubscription - Geo-redundant backup storage is blocked for all databases under subscription '{0}' by preview feature 'Azure SQL Database Block Geo-redundant Backup Storage'. Please select a different backup storage redundancy.\n\n * 400 RestoreHyperscaleToNonHyperscaleElasticPool - Restoring a Hyperscale database to an elastic pool which is not Hyperscale or restoring a database which is not Hyperscale to a Hyperscale elastic pool is not supported.\n\n * 400 RestoreIneligibleDatabaseName - The specified target database name, '{0}', is reserved and cannot be used in a restore operation.\n\n * 400 RestoreNotSupportedForSystemDb - Restore and database recovery are not supported for system databases.\n\n * 400 RestoreIneligibleDroppedDatabaseShortLifespan - The source database, '{0}', dropped on '{1}', has not existed long enough to support restores.\n\n * 400 RestoreIneligibleLiveDatabaseShortLifespan - The source database, '{0}', has not yet accomplished its first backup in order to support restore operations. Please wait until at least the indicated earliest restore date '{1}' and resubmit the request.\n\n * 400 RestoreCrossServerDisabled - For point-in-time restores, the target logical server must be the same as the source logical server. Consider restoring to the source database's server, or using database copy or database recovery.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 RestoreSameServerRecoveryDisabled - Same-server recovery is currently not supported. Consider using point-in-time restore or recovering to a different server.\n\n * 400 RestoreNotSupportedFromLtrBackupToEdition - Restore from long-term retention backup to '{0}' edition not supported.\n\n * 400 RestoreNotSupportedFromExternalBackupToEdition - Restore from external backup to '{0}' edition not supported.\n\n * 400 UpdateToServerlessIfLtrIsNotDisabled - Enabling auto-pause for a serverless database is not supported if long-term backup retention is enabled.\n\n * 400 DuplicateRestoreOperation - A restore request with the same target database name '{0}' on server '{1}' already exists.\n\n * 400 ExternalBackupUriMalformed - The external backup storage container URI is malformed.\n\n * 400 ExternalBackupUriHostNotAllowed - The host name for the external backup storage container URI is not allowed.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 ExternalBackupUriInvalidSchemeOrPort - The external backup storage container URI uses an invalid scheme or port. Please use https and port 443.\n\n * 400 ExternalBackupVldbUnsupported - Hyperscale does not support external backup restore requests.\n\n * 400 InvalidPitrPriorToVldbMigration - For database '{0}', specified point-in-time '{1}' is prior to the Hyperscale migration time of '{2}'. Please specify a target edition or service level objective which is not Hyperscale when restoring to a point earlier than the Hyperscale migration.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 MissingKeyVaultUriForRestore - Azure Key Vault key URI '{0}' is required to successfully restore the database '{1}' under server '{2}'.\n\n * 400 BlockRestoreOnVldbGeoSecondary - Restore of Hyperscale database where source database is geo-secondary is not allowed.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 BackupSetNotFound - No backups were found to restore the database. Please contact support to restore the database.\n\n * 400 IncorrectAccessToAzureKeyVault - Target server does not have access to all AKV Uris created during the backup time.\n\n * 400 RestoreFailureSqlInstanceUnhealthy - Unable to connect to the instance in order to perform restore operation.\n\n * 400 BackupSetBroken - Backup set is broken.\n\n * 400 TimeoutDuringRestore - A timeout was encountered while trying to connect to the restore target.\n\n * 400 BrokenRestorePlanGapInLogBackups - The restore plan is broken because firstLsn of current log backup is not equal to lastLsn of prev log backup.\n\n * 400 FullBackupMissingChecksum - Provided full backup is missing checksum.\n\n * 400 RequiredBackupIsNotLastRestored - Migration cannot be completed because provided backup file name is not the name of the last backup file that is restored.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineDataFilesExist - Database backup contains incompatible physical layout. Non-online data files exist.\n\n * 400 IncompatiblePhysicalLayoutWrongNumberOfLogFiles - Database backup contains incompatible physical layout. Multiple log files are not supported.\n\n * 400 VBSEnclaveResourcePoolInvalidCombination - Adding a database with '{0}' preferredEnclaveType to an elastic pool '{1}' with '{2}' preferredEnclaveType is not supported. \nBefore adding the database to the elastic pool, ensure that the preferredEnclaveType is the same for both the database and the elastic pool. More information can be found on https://aka.ms/AlwaysEncryptedEnableSecureEnclaves\n\n * 400 VBSEnclaveNotSupportedForDW - The preferredEnclaveType is not supported for dedicated SQL Pools.\n\n * 400 VBSEnclaveNotSupportedForDCSeriesSLO - Configuring the 'VBS' preferredEnclaveType for databases using the DC-series hardware configuration is not supported. DC-series databases are pre-configured with Intel SGX enclaves. Virtualization based security (VBS) enclaves are not supported.\n\n * 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave - Configuring geo-replication is not supported for databases using different values of the preferredEnclaveType property. The primary '{0}' database on the '{1}' server uses the '{2}' preferredEnclaveType, whereas the specified preferredEnclaveType for the secondary '{3}' database on the '{4}' server is '{5}'.\n\n * 400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes - Planned failover between primary and secondary database with different preferredEnclaveType is not supported for Virtualization-based security (VBS) enclaves.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 LongTermRetentionMigrationBackupNotFound - LTR backup specified does not exists.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 LongTermRetentionMigrationRequestConflict - A conflict operation on this LTR backup is still in progress.\n\n * 409 LongTermRetentionMigrationBackupConflict - Another LTR backup with same backup time for target database exists.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 FreeDbAlreadyExists - Only one free database can exist for a subscription per region.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 UpdateSloFailedDatabaseTooBusy - Update SLO operation could not complete because database was too busy.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 TargetElasticPoolBeingUpdated - The update of elastic pool cannot be started because there is copy operation in progress for one of the databases in this elastic pool\n\n * 409 DatabaseCopyLimitPerReplicaReached - User reached the limit of concurrent database copies.\n\n * 409 ConflictRequestToUpdateBackupRedundancy - A conflict request to change backup storage redundancy is still in progress.\n\n * 409 DatabaseElasticPoolMaintenanceConflict - User tried to create or update a database with a specified maintenance configuration that conflicted with that of the elastic pool of the database.\n\n * 409 SubscriptionVcoreQuotaExceeded - Could not perform the operation because subscription would exceed the allowed vCore quota.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 LongTermRetentionMigrationRequestCopyFailed - Copy operation failed for LTR backup blobs.\n\n * 500 LongTermRetentionMigrationRestoreVerExceeded - Restore verification failed after max attempts were reached.\n\n * 500 LongTermRetentionMigrationRestoreVerFailed - Restore verification failed.\n\n * 500 LongTermRetentionMigrationRequestFailedToStartOnTarget - Failed to start LTR backup copy request in target region.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidDatabaseCreateOrUpdateRequest - The request body for the create or update database operation is invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSourceDatabaseId - Invalid source database identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MissingCollation - Collation is required.\n\n * 400 MissingMaxSizeBytes - MaxSizeBytes is required.\n\n * 400 MissingSkuName - Sku name is required.\n\n * 400 MissingSourceDatabaseId - Missing source database identifier.\n\n * 400 InvalidLicenseType - The specified license type is invalid.\n\n * 400 InvalidSkuName - Invalid SKU name.\n\n * 400 MismatchedSkuNameAndCapacity - Mismatch between SKU name and capacity.\n\n * 400 MismatchedSkuNameAndTier - Mismatch between SKU name and tier.\n\n * 400 MismatchedSkuNameAndFamily - Mismatch between SKU name and family.\n\n * 400 LedgerNotAllowedWithSpecifiedCreateMode - IsLedgerOn is not allowed with the specified create mode.\n\n * 400 LedgerNotAllowedOnSampleDatabase - Database creation is not allowed with IsLedgerOn for a sample database.\n\n * 400 FreeLimitDatabaseNotAllowedInNonDefaultCreate - Free limit database creation is not allowed in non default create mode.\n\n * 400 AvailabilityZoneNotSupported - Requested availability zones for databases and elastic pools is not valid.\n\n * 400 MethodNotAllowedOnSpecifiedCreateMode - Http Patch or Merge not allowed on the specified create mode\n\n * 400 DatabaseNameDoesNotMatchSourceDatabaseId - The database name specified doesn’t match the database name in sourceDatabaseId.\n\n * 400 ElasticPoolNotSupportedForExternalBackupRestore - Elastic pool is not supported for external backup restore\n\n * 400 InvalidRecoverableDatabaseId - Invalid recoverable database identifier.\n\n * 400 InvalidRecoveryServicesRecoveryPointId - Invalid recovery services recovery point identifier.\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 MissingRecoverableDatabaseId - Missing recoverable database identifier.\n\n * 400 MissingRecoveryServicesRecoveryPointId - Missing recovery services recovery point Id.\n\n * 400 MissingRestorableDroppedDatabaseId - Missing restorableDroppedDatabaseId\n\n * 400 MissingRestorePointInTime - Missing restore point in time\n\n * 400 MissingSourceDatabaseDeletionDate - Missing source database deletion date\n\n * 400 MissingStorageContainerSasToken - Missing storage container SAS token\n\n * 400 MissingStorageContainerUri - Missing storage container URI\n\n * 400 RestorableDroppedDatabaseIdGivenForRestoreWithSourceDatabaseId - Cannot specify restorableDroppedDatabaseId when sourceDatabaseId is already given in restore create mode\n\n * 400 MultipleIdentitiesOnDatabase - Only one user assigned managed identity is supported at the Database Level.\n\n * 400 MultipleIdentityDelegationsOnDatabase - Only one identity delegation is supported at the Database Level.\n\n * 400 MissingPrimaryDelegatedIdentityClientId - In order to use delegated identities please provide a primary delegated identity client id.\n\n * 400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed - Changing backup storage redundancy is not allowed for LTR Copy operations.\n\n * 400 LtrRestoreFailedArchiveStorageTier - Restoring archived long-term retention backup is not supported. Restore can be performed only on rehydrated or regular long-term retention backups.\n\n * 400 LtrArchiveStorageTierNotEnabled - Archiving long-term retention backups is not enabled.\n\n * 400 LtrArchiveWrongParameters - ChangeLongTermRetentionBackupAccessTier is not supported for the desired (backupStorageAccessTier, operationMode) combination. Only (Archive, Move) and (Hot, Copy) are allowed.\n\n * 400 LTRArchiveRedundancyChangeFailed - Updating the backup storage redundancy type to zone-redundant storage is not supported when a long-term retention policy with the 'archive' backup storage access tier is set\n\n * 400 LongTermRetentionMigrationSubscriptionNotFound - The subscription could not be found.\n\n * 400 LtrOperationFailedBackupImmutable - Deleting Long Term Retention backup failed because the backup is immutable.\n\n * 400 LongTermRetentionMigrationRequestNotSupported - Subscription is not allowed LTR backup Migration feature.\n\n * 400 LongTermRetentionMigrationCrossClusterRequestNotSupported - Source and target subscriptions are not allowed to communicate for LTR backup copy feature.\n\n * 400 LongTermRetentionMigrationParameterMissing - Required parameter missing for the operation.\n\n * 400 LongTermRetentionMigrationSameServerNotSupported - LTR Copy feature is not supported to copy LTR backups within same server.\n\n * 400 LongTermRetentionMigrationTargetServerNotFound - Target server does not exists or is not ready for LTR backup copy operation.\n\n * 400 LongTermRetentionMigrationTargetDatabaseNotFound - Target Database does not exists on the server.\n\n * 400 LongTermRetentionMigrationStorageTypeNotSupported - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 LongTermRetentionMigrationStorageMismatch - Active backup redundancy of database does not match backup redundancy requested by customer.\n\n * 400 LongTermRetentionMigrationDatabaseTypeNotSupported - LTR migration is only supported for managed instance and Azure SQL DB LTR backups.\n\n * 400 UnsupportedBackupStorageRedundancy - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 BackupSetNotFoundRecentPit - No backups were found to restore the database to the specified point in time. Please retry the operation. If the problem persists, contact support to restore the database.\n\n * 400 CannotUpdateIsLedgerDatabase - The ledger property of an existing database cannot be updated.\n\n * 400 LTRSterlingToVldbMigrationNotSupported - Cannot change service objective for database to Hyperscale as long-term retention is not yet supported on Hyperscale. Please disable long-term retention on the database and retry.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 InvalidPublicMaintenanceConfiguration - User tried to specify public maintenance configuration which cannot be converted to internal id (malformed or wrong region).\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 MaintenanceWindowNotSupportedForNamedReplica - User tried to create or update named replica with non-default maintenance window which is not supported.\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 InvalidStandbyGeoReadScale - User attempted to enable read scale on a standby geo database that does not support it.\n\n * 400 PerDatabaseCMKKeyRotationAttemptedWhileOldThumbprintInUse - Key Rotation for the TDE Protector at the database level is blocked when active transactions are holding up the log encrypted with old keys. Please refer to aka.ms/azuresqldbkeyrotation for possible strategies to workaround this issue.\n\n * 400 TierChangeUnsupportedDueToCDCEnabledDatabase - The database cannot update its sku because it is enabled for CDC.\n\n * 400 PerDBCMKNotSupportedWithLTR - Database-level CMK is not supported when Long-term Backup Retention is enabled on the database.\n\n * 400 VBSEnclaveNotSupportedForDW - The preferredEnclaveType is not supported for dedicated SQL Pools.\n\n * 400 VBSEnclaveNotSupportedForDCSeriesSLO - Configuring the 'VBS' preferredEnclaveType for databases using the DC-series hardware configuration is not supported. DC-series databases are pre-configured with Intel SGX enclaves. Virtualization based security (VBS) enclaves are not supported.\n\n * 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutDatabaseLevelEncryptionProtector - Database-level encryption protector must be set on the target database while attempting to copy or replicate a database encrypted with a database level key.\n\n * 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeys - While attempting to replicate a database configured with database level encryption protector, the current keys being used by the primary must be passed to the secondary database.\n\n * 400 PartnerDBNotCompatibleForSGXEnclave - Attempt to set GeoDR link or update SLO for enclave enabled database is only supported when both database are running on DC-series hardware.\n\n * 400 PerDatabaseCMKGeoPrimaryIsNotConfiguredWithDatabaseLevelEncryptionProtector - The geo-primary database must be configured with a database level encryption protector before setting a database level encryption protector on the geo-secondary.\n\n * 400 ElasticJobsNotSupportedOnAutoPauseEnabledDatabase - Auto-pause enabled serverless database is not supported as an Elastic Jobs database because job agent would prevent that database from pausing. You can either disable auto-pause on this serverless database or delete the job agent that is using this database. See here for more details: https://docs.microsoft.com/azure/azure-sql/database/serverless-tier-overview#auto-pausing\n\n * 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave - Configuring geo-replication is not supported for databases using different values of the preferredEnclaveType property. The primary '{0}' database on the '{1}' server uses the '{2}' preferredEnclaveType, whereas the specified preferredEnclaveType for the secondary '{3}' database on the '{4}' server is '{5}'.\n\n * 400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes - Planned failover between primary and secondary database with different preferredEnclaveType is not supported for Virtualization-based security (VBS) enclaves.\n\n * 400 PerDatabaseCMKGeoPrimaryIsConfiguredWithDatabaseLevelEncryptionProtector - The geo-primary database must not be configured with a database level encryption protector when failing over to a geo-secondary without a database level encryption protector.\n\n * 400 CreateDatabaseAttemptedWithRotationInProgress - The create database operation can not be performed at this time due to ongoing Transparent Data Encryption (TDE) key rotation on the server. Please try the operation again later.\n\n * 400 VBSEnclaveResourcePoolInvalidCombination - Adding a database with '{0}' preferredEnclaveType to an elastic pool '{1}' with '{2}' preferredEnclaveType is not supported. \nBefore adding the database to the elastic pool, ensure that the preferredEnclaveType is the same for both the database and the elastic pool. More information can be found on https://aka.ms/AlwaysEncryptedEnableSecureEnclaves\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 InvalidDatabaseCreateMode - Invalid request to create a database.\n\n * 400 MissingAsymmetricKeyOnTargetServer - Target server does not have access to an asymmetric key.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MultipleDroppedDatabasesWithTheSameName - Found multiple dropped databases with the same name on server.\n\n * 400 AzureKeyVaultClientError - The Azure Key Vault client encountered an error.\n\n * 400 AzureKeyVaultClientInfoError - An error occurred while obtaining information for the Azure Key Vault client.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 AzureKeyVaultKeyThumbprintIsDifferent - The operation could not be completed because the Azure Key Vault Key material is different than the current encryption protector key.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 HyperscaleReverseMigrationNotSupported - Reverse migration of a Hyperscale database to Sterling hit an unsupported scenario.\n\n * 400 UpdateSloOperationIdDoesNotExist - The action failed because no active update-slo operation detected for server: {0}, database: {1};. Please retry the operation by specifying valid parameters.\n\n * 400 ManualCutoverUnsupported - Invalid use of manual-cutover option. Please check current and requested service objective and retry the operation by specifying valid parameters.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 IsLedgerDatabaseIsNotSupportedOnResourceType - Changing the ledger property is not supported for this resource type.\n\n * 400 DatabaseNameInUse - Database already exists. Choose a different database name.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 UnableToCreateGeoChain - User attempted to create secondary database (chaining) even though automatic upload of ledger digests has been configured\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 TargetElasticPoolDoesNotExist - The elastic pool does not exist on a server.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 ElasticPoolNameRequired - User tried to create or update database to elastic pool service objective without specifying the name of the elastic pool.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 InvalidReadScaleEdition - User attempted to enable read scale on a database type that does not support it.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 GeoSecondaryMaxSizeUpdateFailed - The geo-secondary database is of a SLO that does not support the requested maxsize value or the geo-secondary is in an unsupported region or an update operation is already in progress on the geo-secondary database.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 SourceDatabaseEncryptionProtectorKeyUriRequiredForPerDatabaseCMKCopyOrReplication - Geo secondary database missing AKV of geo primary database\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 RequestedDatabaseSizeRequiresShrink - User attempted to ALTER DATABASE MODIFY MAXSIZE to modify the MAXSIZE for a database to a smaller size then the current size.\n\n * 400 CurrentDatabaseSizeExceedsDbMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 SecurityAzureKeyVaultGeoChainError - Creating secondary of secondary (a process known as chaining) is not supported when enabling Transparent Data Encryption using Azure Key Vault (BYOK).\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 UnsupportedCapacity - User tried to create or update database with capacity which is not supported.\n\n * 400 RestoreToFreeEditionNotSupported - Restore and GeoRestore target cannot be free database.\n\n * 400 RestoreNotSupportedForFreeEdition - Restore and GeoRestore are not supported for free database.\n\n * 400 InvalidDroppedDatabase - Source database dropped does not exist on server within the supported recovery period.\n\n * 400 InvalidLiveDatabase - Source database does not exist on server within the supported recovery period. If restoring a dropped database, please specify its deletion date.\n\n * 400 InvalidVldbRecoverySlo - The Hyperscale edition recovery requires both source and target databases to use Hyperscale service level objective.\n\n * 400 InvalidVldbRestoreSlo - The Hyperscale edition Point-In-Time restore requires both source and target databases to use Hyperscale service level objective.\n\n * 400 CannotSpecifyPoolOrSlo - Specifying an elastic pool and/or changing the service level objective or edition is not supported for edition.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 InvalidBackupStorageAccountType - User passed zrs/lrs during create/update of a database but it failed either because the customer is not whitelisted or because zrs is not available in the specified region.\n\n * 400 DatabaseInvalidSkuPropertyCombination - The properties of the requested sku are inconsistent. Please check that a valid combination is specified. See https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability for more details.\n\n * 400 DatabaseNamedReplicaPerDatabaseLimitExceeded - User tried create a named replica that would exceed the allowed number per primary database\n\n * 400 UnsupportedBackupStorageRedundancyForEdition - The requested backup storage redundancy is not supported for edition\n\n * 400 DatabaseIsCurrentlyPinned - Microsoft has pinned your database SQL Server engine version. To ensure your database does not hit production issues, any future scale operations on your database will be blocked until it has been un-pinned. Please contact Microsoft support for assistance with scaling.\n\n * 400 RestoreTargetEditionSizeInsufficient - User attempted to restore a database to an edition that is a smaller size than the current allocated size of the source.\n\n * 400 InvalidIdentityId - One or more identity id(s) provided are not valid ARM resource id(s). Please input valid id(s) and try again.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 DatabaseCreationBlockedForNonActivatedCMKServer - SQL Pool creations are blocked for CMK enabled workspaces until the workspace is activated. First, enable purge protection and grant the workspace Managed Identity the required permissions (Get, Wrap Key, Unwrap Key) on the Azure Key Vault of the workspace key. Next, activate your workspace after you have granted access.\n\n * 400 InvalidNumberOfIdentities - Only one user assigned managed identity is supported at the Database Level.\n\n * 400 NoRestorePointAvailable - The source database has not yet accomplished its first backup in order to support restore operations. Please retry the restore request later.\n\n * 400 DatabaseNamedReplicaChainingNotAllowed - User tried to create a named replica of a named replica which is not allowed.\n\n * 400 DatabaseNamedReplicaInvalidOperation - User attempted an unsupported operation on a named replica.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 DatabaseNamedReplicaInvalidSourceDatabase - User attempted to create a named replica in a different subscription or region than the source database.\n\n * 400 DatabaseNamedReplicaSourceDatabaseNotZoneRedundant - Zone Redundancy cannot be enabled on this Named Replica since the primary Hyperscale Database is not zone redundant.\n\n * 400 CannotAssignIdentityToMaster - Cannot assign an identity to a system database. Database identity cannot be assigned to 'master', 'model', 'tempdb', 'msdb', or 'resource' databases.\n\n * 400 PerDatabaseCMKDWNotSupported - Database-level CMK in preview is not supported for Datawarehouse edition.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 MissingThumbprintCrm - The restore operation of a CRM database failed because a required TDE certificate was missing. Please retry the restore operation to an existing elastic pool.\n\n * 400 ElasticPoolOverStorage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 RestoreTargetEditionSizeInsufficientV2 - User attempted to restore a database to an edition that is a smaller size than the allocated size of the restored database.\n\n * 400 ResourcePoolStorageLimitHitDuringRestore - The restored database can't be restored into the resource pool due to the remaining storage capacity in the pool.\n\n * 400 PerDatabaseCMKRestoreNotSupported - Database restore is not supported when Database-level CMK is configured in preview.\n\n * 400 PerDatabaseCMKHSNotSupported - Database-level CMK in preview is not supported for Hyperscale edition.\n\n * 400 PerDatabaseCMKGeoReplicationNotSupported - Geo Replication and Database Copy is not supported when Database-level CMK is configured in preview.\n\n * 400 InvalidStandbyGeoEdition - User attempted to create a DTU based standby geo.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 GeoRestoreBackupStorageTypeNotSupported - Database recovery requests are invalid when issued against a database that is not configured to use geo-redundant backup storage.\n\n * 400 RestoreHyperscaleToNonHyperscale - Restoring a Hyperscale database backup to a non-Hyperscale service tier or vice versa is not supported.\n\n * 400 SubscriptionDoesNotHaveAccessToServer - The subscription does not have access to the specified server(s)\n\n * 400 RecoveryPointDoesNotExist - The specified recovery point either does not exist or is not valid.\n\n * 400 LtrBackupNotFound - The specified long term retention backup does not exist.\n\n * 400 InvalidPointInTime - The specified point in time is not valid for the database.\n\n * 400 GeoRestoreCannotResolveTargetCluster - Cannot resolve target cluster for server\n\n * 400 CannotSpecifyEditionOrSloWhenRestoringToPool - Specifying the target service level objective or edition is not supported when restoring to an elastic pool.\n\n * 400 RestoreNotSupportedForGeoDrSecondary - Point-in-time restore and database recovery operations are not supported on databases that are currently configured as geo-secondaries.\n\n * 400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported - User attempted configuring backup retention policy on a Named Replica.\n\n * 400 GeoRedundantBackupsNotPermittedForSubscription - Geo-redundant backup storage is blocked for all databases under subscription '{0}' by preview feature 'Azure SQL Database Block Geo-redundant Backup Storage'. Please select a different backup storage redundancy.\n\n * 400 RestoreHyperscaleToNonHyperscaleElasticPool - Restoring a Hyperscale database to an elastic pool which is not Hyperscale or restoring a database which is not Hyperscale to a Hyperscale elastic pool is not supported.\n\n * 400 RestoreIneligibleDatabaseName - The specified target database name, '{0}', is reserved and cannot be used in a restore operation.\n\n * 400 RestoreNotSupportedForSystemDb - Restore and database recovery are not supported for system databases.\n\n * 400 RestoreIneligibleDroppedDatabaseShortLifespan - The source database, '{0}', dropped on '{1}', has not existed long enough to support restores.\n\n * 400 RestoreIneligibleLiveDatabaseShortLifespan - The source database, '{0}', has not yet accomplished its first backup in order to support restore operations. Please wait until at least the indicated earliest restore date '{1}' and resubmit the request.\n\n * 400 RestoreCrossServerDisabled - For point-in-time restores, the target logical server must be the same as the source logical server. Consider restoring to the source database's server, or using database copy or database recovery.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 RestoreSameServerRecoveryDisabled - Same-server recovery is currently not supported. Consider using point-in-time restore or recovering to a different server.\n\n * 400 RestoreNotSupportedFromLtrBackupToEdition - Restore from long-term retention backup to '{0}' edition not supported.\n\n * 400 RestoreNotSupportedFromExternalBackupToEdition - Restore from external backup to '{0}' edition not supported.\n\n * 400 UpdateToServerlessIfLtrIsNotDisabled - Enabling auto-pause for a serverless database is not supported if long-term backup retention is enabled.\n\n * 400 DuplicateRestoreOperation - A restore request with the same target database name '{0}' on server '{1}' already exists.\n\n * 400 ExternalBackupUriMalformed - The external backup storage container URI is malformed.\n\n * 400 ExternalBackupUriHostNotAllowed - The host name for the external backup storage container URI is not allowed.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 ExternalBackupUriInvalidSchemeOrPort - The external backup storage container URI uses an invalid scheme or port. Please use https and port 443.\n\n * 400 ExternalBackupVldbUnsupported - Hyperscale does not support external backup restore requests.\n\n * 400 InvalidPitrPriorToVldbMigration - For database '{0}', specified point-in-time '{1}' is prior to the Hyperscale migration time of '{2}'. Please specify a target edition or service level objective which is not Hyperscale when restoring to a point earlier than the Hyperscale migration.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 MissingKeyVaultUriForRestore - Azure Key Vault key URI '{0}' is required to successfully restore the database '{1}' under server '{2}'.\n\n * 400 BlockRestoreOnVldbGeoSecondary - Restore of Hyperscale database where source database is geo-secondary is not allowed.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 BackupSetNotFound - No backups were found to restore the database. Please contact support to restore the database.\n\n * 400 IncorrectAccessToAzureKeyVault - Target server does not have access to all AKV Uris created during the backup time.\n\n * 400 RestoreFailureSqlInstanceUnhealthy - Unable to connect to the instance in order to perform restore operation.\n\n * 400 BackupSetBroken - Backup set is broken.\n\n * 400 TimeoutDuringRestore - A timeout was encountered while trying to connect to the restore target.\n\n * 400 BrokenRestorePlanGapInLogBackups - The restore plan is broken because firstLsn of current log backup is not equal to lastLsn of prev log backup.\n\n * 400 FullBackupMissingChecksum - Provided full backup is missing checksum.\n\n * 400 RequiredBackupIsNotLastRestored - Migration cannot be completed because provided backup file name is not the name of the last backup file that is restored.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineDataFilesExist - Database backup contains incompatible physical layout. Non-online data files exist.\n\n * 400 IncompatiblePhysicalLayoutWrongNumberOfLogFiles - Database backup contains incompatible physical layout. Multiple log files are not supported.\n\n * 400 VBSEnclaveResourcePoolInvalidCombination - Adding a database with '{0}' preferredEnclaveType to an elastic pool '{1}' with '{2}' preferredEnclaveType is not supported. \nBefore adding the database to the elastic pool, ensure that the preferredEnclaveType is the same for both the database and the elastic pool. More information can be found on https://aka.ms/AlwaysEncryptedEnableSecureEnclaves\n\n * 400 VBSEnclaveNotSupportedForDW - The preferredEnclaveType is not supported for dedicated SQL Pools.\n\n * 400 VBSEnclaveNotSupportedForDCSeriesSLO - Configuring the 'VBS' preferredEnclaveType for databases using the DC-series hardware configuration is not supported. DC-series databases are pre-configured with Intel SGX enclaves. Virtualization based security (VBS) enclaves are not supported.\n\n * 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave - Configuring geo-replication is not supported for databases using different values of the preferredEnclaveType property. The primary '{0}' database on the '{1}' server uses the '{2}' preferredEnclaveType, whereas the specified preferredEnclaveType for the secondary '{3}' database on the '{4}' server is '{5}'.\n\n * 400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes - Planned failover between primary and secondary database with different preferredEnclaveType is not supported for Virtualization-based security (VBS) enclaves.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 LongTermRetentionMigrationBackupNotFound - LTR backup specified does not exists.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 LongTermRetentionMigrationRequestConflict - A conflict operation on this LTR backup is still in progress.\n\n * 409 LongTermRetentionMigrationBackupConflict - Another LTR backup with same backup time for target database exists.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 FreeDbAlreadyExists - Only one free database can exist for a subscription per region.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 UpdateSloFailedDatabaseTooBusy - Update SLO operation could not complete because database was too busy.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 TargetElasticPoolBeingUpdated - The update of elastic pool cannot be started because there is copy operation in progress for one of the databases in this elastic pool\n\n * 409 DatabaseCopyLimitPerReplicaReached - User reached the limit of concurrent database copies.\n\n * 409 ConflictRequestToUpdateBackupRedundancy - A conflict request to change backup storage redundancy is still in progress.\n\n * 409 DatabaseElasticPoolMaintenanceConflict - User tried to create or update a database with a specified maintenance configuration that conflicted with that of the elastic pool of the database.\n\n * 409 SubscriptionVcoreQuotaExceeded - Could not perform the operation because subscription would exceed the allowed vCore quota.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 LongTermRetentionMigrationRequestCopyFailed - Copy operation failed for LTR backup blobs.\n\n * 500 LongTermRetentionMigrationRestoreVerExceeded - Restore verification failed after max attempts were reached.\n\n * 500 LongTermRetentionMigrationRestoreVerFailed - Restore verification failed.\n\n * 500 LongTermRetentionMigrationRequestFailedToStartOnTarget - Failed to start LTR backup copy request in target region.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Updating the database is in progress." + "description": "Updating the database is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -441,7 +456,12 @@ } }, "202": { - "description": "Exporting the database is in progress." + "description": "Exporting the database is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -506,13 +526,18 @@ "description": "Successfully completed database failover." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 DatabaseFailoverNotSupportedOnSKU - This type of customer initiated failover is not supported on the given SKU.\n\n * 400 DatabaseFailoverThrottled - There was a recent failover on the database or pool if database belongs in an elastic pool.\n\n * 400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 DatabaseNotInStateToFailover - The database is currently in a state such that failover cannot be issued.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "description": "*** Error Responses: ***\n\n * 400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled.\n\n * 400 DatabaseFailoverThrottled - There was a recent failover on the database or pool if database belongs in an elastic pool.\n\n * 400 DatabaseFailoverNotSupportedOnSKU - This type of customer initiated failover is not supported on the given SKU.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 DatabaseNotInStateToFailover - The database is currently in a state such that failover cannot be issued.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Database failover is in progress." + "description": "Database failover is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -570,7 +595,12 @@ } }, "202": { - "description": "Importing the database is in progress." + "description": "Importing the database is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -629,7 +659,7 @@ "description": "Successfully renamed the database." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidResourceMoveRequest - The resource move request is invalid.\n\n * 400 InvalidMoveTargetResourceId - The target resource identifier in move request is invalid.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 DatabaseNameInUse - Database already exists. Choose a different database name.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.", + "description": "*** Error Responses: ***\n\n * 400 InvalidResourceMoveRequest - The resource move request is invalid.\n\n * 400 InvalidMoveTargetResourceId - The target resource identifier in move request is invalid.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 DatabaseNameInUse - Database already exists. Choose a different database name.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -678,13 +708,18 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 CannotDeactivateWhenDeactivatingInProgress - Deactivation workflow failed because there is a deactivate workflow already running.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "description": "*** Error Responses: ***\n\n * 400 CannotDeactivateWhenDeactivatingInProgress - Deactivation workflow failed because there is a deactivate workflow already running.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Pausing the database is in progress." + "description": "Pausing the database is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -737,7 +772,12 @@ } }, "202": { - "description": "Resuming the database is in progress." + "description": "Resuming the database is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -787,7 +827,12 @@ } }, "202": { - "description": "Upgrading the data warehouse is in progress." + "description": "Upgrading the data warehouse is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -834,7 +879,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -879,7 +924,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found", + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DeletedServers.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DeletedServers.json index c8f07ebc6856..2ac8363d3bc2 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DeletedServers.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DeletedServers.json @@ -194,7 +194,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DistributedAvailabilityGroups.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DistributedAvailabilityGroups.json index f3244e767457..9f9d17c8b4d6 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DistributedAvailabilityGroups.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DistributedAvailabilityGroups.json @@ -45,7 +45,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidDnsZone - The operation has failed because you are attempting to deploy managed instance as a geo-replication secondary to the subnet {0} in which there already exists a managed instance. Deploying managed instance as a geo-replication secondary is supported only in cases when managed instance is the first instance deployed in a subnet. Consider deploying managed instance as a geo-replication secondary to a different subnet in which there are no existing managed instances, or if deploying to a subnet with existing managed instance disable the geo-replication option.\n\n * 400 HkCannotSwitchToInactive - The database cannot proceed with pricing-tier update as it has memory-optimized objects. Please drop such objects and try again.\n\n * 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - Invalid storage size: Storage size limit ({0} GB) is less that current storage used ({1} GB). Please specify higher storage size limit.\n\n * 400 InstanceTimezoneUpdateNotSupported - Instance timezone update not supported.\n\n * 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - Create Managed Instance with non-default timezone not supported.\n\n * 400 ManagedInstanceIpAddressRangeLimit - Cannot perform creation/scaling of the managed instance as there are not enough available IP addresses in the subnet for performing the operation.\n\n * 400 VnetDelegationNotAllowed - User tried to inject Managed Server to subnet which is delegated.\n\n * 400 SubnetHasResourcesOfDifferentType - User tried to create MI in subnet that has resources of different type.\n\n * 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - Update of Managed Instance with maintenance window settings is not allowed.\n\n * 400 OperationNotAllowedInCurrentGeodrConfiguration - The operation is not allowed because the current geo-replication configuration does not allow this combination of {0}. Change the setting on the geo-replication partner before applying the change on this instance.\n\n * 400 VnetPrepareNIPFailed - User tried to prepare subnet that has a conflict with NetworkIntentPolicy.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 ManagedInstanceDeprecatedHardwareFamily - Changing the hardware generation to deprecated {0} generation is not possible.\n\n * 400 ManagedInstanceBackupStorageTypeNotSupported - Backup storage type parameter is not allowed in the instance update operation.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 EmptyPDCInvalidDnsZone - This managed instance cannot be deployed because its DNS-zone does not match the DNS-prefix of its intended virtual cluster for subnet {0}. Although this virtual cluster is empty, its DNS-prefix cannot be changed. Empty virtual clusters will be automatically removed after several hours. Consider waiting for this virtual cluster to expire or manually deleting this virtual cluster and then creating the managed instance.\n\n * 400 InstancePoolNotEnoughCapacity - An instance pool does not have enough capacity\n\n * 400 ManagedInstanceFreemiumNotAvailableForInputParameters - Managed instance creation or update executed with SLO that is not allowed for freemium.\n\n * 400 ManagedInstanceFreemiumNotAvailableOnRegion - Creation of a freemium managed instance on a region that is not allowlisted for freemium.\n\n * 400 ManagementServiceSubnetMaintenanceInProgress - User tried to initiate managed instance create/update while incompatible maintenance is in progress.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ManagedInstanceFreemiumNotAvailableForSubscription - Freemium is not enabled for this subscription type.\n\n * 400 ManagedInstanceInvalidEditionForInstancePool - User tried to select invalid service tier for managed instance inside an existing instance pool.\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 ManagedInstanceInvalidSubnetForInstancePool - User tried to select invalid subnet for managed instance inside an existing instance pool.\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 ManagedInstanceZoneRedudantFeatureNotSupported - ZoneRedundant feature is not supported for the selected service tier. For more details visit aka.ms/sqlmi-service-tier-characteristics.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - Enabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - Disabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SubnetIdCantBeUpdated - Changing managed instance subnet is not supported operation. Please remove this parameter from the request.\n\n * 400 MigrationToAnotherVNetNotSupported - Selected subnet is in another Virtual Network. Moving managed instance to another Virtual Network is not possible. Please provide subnet from Virtual Network {0}.\n\n * 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - Provided subnet is having different DNS zone from the current. Changing instance DNS zone is not supported. Please provide subnet with same DNS zone, create a new subnet or provide empty one.\n\n * 400 MigrationToGen4SubnetNotSupported - It is not possible to update subnet while running on Gen4 hardware as it is being deprecated. Please upgrade your hardware from Gen4 to Gen5 as part of the changing managed instance subnet operation by specifying both parameters at the same time: destination subnet and hardware generation.\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - The operation could not be completed because some of the database files are exceeding maximum General Purpose file size limit of {0} GB.\n\n * 400 CloudLifterUnsupportedFeature - The functionality is not available on the Managed Instance at this time.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 OperationCanNotStartDueToMiLink - The '{0}' operation cannot be completed as there exists a database in a process of creation through Managed Instance link. Please wait for the link creation to complete, or delete the link, and retry the operation again.\n\n * 400 ManagedInstanceSloUpdateFailed - SLO '{0}' operation cannot succeed as the memory usage of '{1}' exceeds the quota.\n\n * 400 SourceAndTargetSubnetsMustBeVnetPeered - Subnet currently used by managed instance and provided destination subnet are part of the virtual networks that are not connected with virtual network peering, or have peering established but don't have allowed traffic. In order to move managed instance from one subnet to another, virtual network peering needs to be established from both source and target virtual network. Please configure virtual network requirements and then try the operation again. Learn more https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks. \n\n * 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - Subnet provided for managed instance deployment is located on subscription different than the one submitted for managed instance. Managed instance and subnet used for deploying the instance must be on the same subscription. Please provide another subnet or switch to the subnet subscription and then try the operation again.\n\n * 400 CreateManagedInstanceInvalidSubnetSize - User attempted to create managed instance in a subnet that is smaller than the allowed minimal subnet size.\n\n * 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - Subnet selected for managed instance migration has address range that overlaps with address range of subnet that holds geo replicated secondary instance. Please verify that your subnet is configured according to guidelines in https://aka.ms/move-managed-instance. \n\n * 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - Subnet selected for managed instance migration is not configured to enable communication with a geo replicated secondary instance. Please check if all of the required ports are open. To properly configure your subnet read the guidelines in https://aka.ms/move-managed-instance. \n\n * 400 ManagedInstanceLocalStorageUpdateSloDisabled - Update SLO for managed instances with local storage is not supported yet.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 GatewayInvalidEdition - '{0}' is not a valid database edition in this version of SQL Server.\n\n * 400 ManagedInstanceInvalidHardwareFamilyForInstancePool - User tried to select invalid hardware family for managed instance inside an existing instance pool.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 ManagedInstanceInvalidLicenseTypeForInstancePool - User tried to select invalid license type for managed instance inside an existing instance pool.\n\n * 400 ManagedInstanceUpdateSloFromVersionlessToVersionedNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 ManagedInstanceUpdateSloFromNewerToOlderVersionEditionNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 ManagedInstanceUpdateSloFromVersionedToVersionlessWorkerCLNotAllowed - Changing the database format is not supported for this managed instance. Check the database format property value specified and visit https://aka.ms/sqlmi-fwnov2022 for more details.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 ManagedInstanceVersionEditionParameterNotAllowedForUsing - Specifying the database format property value is not supported at this time.\n\n * 400 ManagedInstanceFreemiumInvalidArchitecture - A freemium instance can not be created in the specified subnet '(0)'.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ManagedInstanceGeoDRNotAllowedForInstancePool - Creating auto-failover group (GeoDR) is not supported for Managed Instances provisioned inside instance pools. Auto failover groups can be created only for standalone Managed Instances.\n\n * 400 ManagedInstanceWithGeoDRMoveToInstancePoolNotAllowed - Customer has attempted to move a standalone Managed Instance with an existing auto-failover group configured into an instance pool, which is not supported. Only standalone instances without existing auto-failover groups configured can be moved to instance pools.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerRegion - Creation of ZoneRedundant SQL MI is temporarily disabled on this region. You can create Zone Redundant SQL Managed Instances in many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerHardwareGeneration - Creation of ZoneRedundant SQL MI is temporarily disabled for this hardware generation on this region. You can create Zone Redundant SQL Managed Instances with different hardware generation on this region or many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceUpdateSloGeoPrimaryWithNewerVersionEditionThanSecondary - Database format change must be performed on the secondary instance of the failover group first. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 ManagedInstanceFreemiumInstanceAlreadyExists - Only one free SQL Managed Instance is allowed per subscription.\n\n * 400 ManagementServiceGeodrSecondaryDatabaseInCreation - The '{0}' operation cannot be completed as there exists a database in a process of creation through failover group deployment. Please wait for the failover group deployment to complete, or alternatively delete the failover group and retry the operation again.\n\n * 400 ManagedInstanceConversionRegularToFreemiumNotAllowed - User tried converting a Regular SQL Managed Instance to Free SQL Managed Instance.\n\n * 400 ManagedInstanceConversionFreemiumToRegularAndUpdateSLOWhileStoppedNotAllowed - User tried converting a Free SQL Managed Instance to Regular SQL Managed Instance and Update SLO in same request, while Instance is stopped.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 ManagedInstanceMaintenanceWindowChangeNotAllowedWhenInInstancePool - Maintenance window is set at instance pool level and cannot be set individually per pooled instance.\n\n * 400 ManagedInstanceMoveToInstancePoolExceedsDbCountLimit - Cannot move the instance into the pool due to pool database count limit.\n\n * 400 StorageIOpsNotSupported - Storage IOps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidCollation - Invalid collation.\n\n * 400 StorageThroughputMBpsNotSupported - Storage throughput MBps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 StorageIOpsNotSupportedForSpecifiedEdition - Storage IOps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 StorageThroughputMBpsNotSupportedForSpecifiedEdition - Storage throughput MBps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 ManagedInstanceClassicVnetNotSupported - Managed Instance cannot be joined to a classic virtual network.\n\n * 400 AlterDbDeactivatedNotSupported - Database Operation failed for Server '{0}', Database '{1}' due to unexpected delay. Please try again.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetConfigHasNsg - User tried to inject Managed Server subnet with Network Security Groups.\n\n * 400 VnetConfigHasNoUdr - User tried to inject Managed Server subnet without default User Defined Route Table.\n\n * 400 VnetConfigHasInvalidUdr - User tried to inject Managed Server subnet with invalid User Defined Route Table.\n\n * 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.\n\n * 400 VnetConfigHasServiceEndpoints - User tried to inject Managed Server subnet with service endpoints.\n\n * 400 VnetSubnetIsInUse - User tried to inject Managed Server subnet that is not empty.\n\n * 400 VnetSubnetIsLocked - User tried to inject Managed Server subnet that is in locked scope.\n\n * 400 VnetSubnetIsGateway - User tried to inject Managed Server subnet that is Gateway subnet.\n\n * 400 VnetSubnetIsUnknown - User tried to inject Managed Server subnet that does not exist.\n\n * 400 VnetSubnetConflictWithIntendedPolicy - User tried to inject Managed Server subnet that has a conflict with IntendedPolicy.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 ManagedInstanceInvalidEditionForSku - The specified edition {0} is not consistent with the specified SKU {1}.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInCreateOfMI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the create operation.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagedInstanceInvalidLicenseType - The specified license type {0} is not valid.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInUpdateOfGPV1MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V1 Managed Instance.\n\n * 400 UnspecifiedTargetEditionAndFalseGPV2NotAllowedInUpdateOfGPV2MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value FALSE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 GPTargetEditionAndUnspecifiedGPV2NotAllowedInUpdateOFGPV2MI - Combination of General Purpose target edition (sku.name/sku.tier parameters) and unspecified value for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 BCTargetEditionAndSpecifiedGPV2ParamNotAllowedInCreateUpdateOfMI - Combination of Business Critical target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the create/update operation.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 UnspecifiedTargetEditionAndSpecifiedGPV2ParamNotAllowedInUpdateOfBCMI - Combination of unspecified target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the update operation of Business Critical Managed Instance.\n\n * 400 TotalMemoryMBNotSupported - Total memory MB parameter is not allowed in the instance create/update operation.\n\n * 400 TotalMemoryMBNotSupportedForSpecifiedEdition - Total memory MB parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 VnetResourceNotFound - Resource not found: '{0}'.\n\n * 400 InvalidTimezone - Invalid timezone.\n\n * 400 InvalidSubnetForGPV2Edition - General Purpose v2 edition of Managed Instance is not compatible with the specified subnet. Target subnet must be either empty, or all instances in it must run with November 2022 Feature Wave.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 TotalMemoryMBInvalidLimit - Total memory MB parameter has been set to an invalid limit.\n\n * 400 ManagedInstanceUpdateSloGPv2PerDatabaseFileLimitExceeded - The operation could not be completed because there is at least one database whose number of files is exceeding the limit of {0} files per database on General Purpose v2 edition.\n\n * 400 InstanceCollationUpdateNotSupported - User cannot change instance collation on Managed Instance.\n\n * 400 NextGenGPNotSupportedForCmwCustomers - Next-Gen General Purpose edition of Managed Instance does not support Custom Maintenance Window.\n\n * 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - User can create a Managed Instance only with collation 'SQL_Latin1_General_CP1_CI_AS'.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedInstanceExceedMaxAzureStorage - The operation could not be completed because total allocated storage size for General Purpose instance would exceed {0}. Please reduce the number of database files and retry operation.\n\n * 400 ManagedInstanceHasGeoReplica - The operation could not be completed because instance has configured geo replicated secondary instance.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 405 InvalidStorageIOpsLimitValue - Invalid storage IOps limit: {0} IOps. Storage IOps limit must be specified between {1} IOps and {2} IOps, in increments of {3} IOps.\n\n * 405 InvalidStorageThroughputMBpsLimitValue - Invalid storage throughput limit: {0} MBps. Storage throughput limit must be specified between {1} MBps and {2} MBps, in increments of {3} MBps.\n\n * 405 InvalidVcoreValue - vCore value {0} is not valid. Please specify a valid vCore value.\n\n * 405 InvalidHardwareGenerationValue - HardwareGeneration {0} is not valid. Please specify a valid HardwareGeneration value.\n\n * 405 InvalidStorageSizeValue - \"Invalid storage size: {0} GB. Storage size must be specified between {1} and {2} gigabytes, in increments of {3} GB.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 409 ServerOverridePreconditionFailed - Failed to apply server override on category '{0}', because physical db or instance '{1}' in server '{2}' is currently not in 'Ready' or 'Deactivated' state.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ManagedInstanceIsBusy - The server '{0}' is currently busy. Please wait a few minutes before trying again.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 GatewayInternalServerError - The server encountered an unexpected exception.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 InvalidDnsZone - The operation has failed because you are attempting to deploy managed instance as a geo-replication secondary to the subnet {0} in which there already exists a managed instance. Deploying managed instance as a geo-replication secondary is supported only in cases when managed instance is the first instance deployed in a subnet. Consider deploying managed instance as a geo-replication secondary to a different subnet in which there are no existing managed instances, or if deploying to a subnet with existing managed instance disable the geo-replication option.\n\n * 400 HkCannotSwitchToInactive - The database cannot proceed with pricing-tier update as it has memory-optimized objects. Please drop such objects and try again.\n\n * 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - Invalid storage size: Storage size limit ({0} GB) is less that current storage used ({1} GB). Please specify higher storage size limit.\n\n * 400 InstanceTimezoneUpdateNotSupported - Instance timezone update not supported.\n\n * 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - Create Managed Instance with non-default timezone not supported.\n\n * 400 ManagedInstanceIpAddressRangeLimit - Cannot perform creation/scaling of the managed instance as there are not enough available IP addresses in the subnet for performing the operation.\n\n * 400 VnetDelegationNotAllowed - User tried to inject Managed Server to subnet which is delegated.\n\n * 400 SubnetHasResourcesOfDifferentType - User tried to create MI in subnet that has resources of different type.\n\n * 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - Update of Managed Instance with maintenance window settings is not allowed.\n\n * 400 OperationNotAllowedInCurrentGeodrConfiguration - The operation is not allowed because the current geo-replication configuration does not allow this combination of {0}. Change the setting on the geo-replication partner before applying the change on this instance.\n\n * 400 VnetPrepareNIPFailed - User tried to prepare subnet that has a conflict with NetworkIntentPolicy.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 ManagedInstanceDeprecatedHardwareFamily - Changing the hardware generation to deprecated {0} generation is not possible.\n\n * 400 ManagedInstanceBackupStorageTypeNotSupported - Backup storage type parameter is not allowed in the instance update operation.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 EmptyPDCInvalidDnsZone - This managed instance cannot be deployed because its DNS-zone does not match the DNS-prefix of its intended virtual cluster for subnet {0}. Although this virtual cluster is empty, its DNS-prefix cannot be changed. Empty virtual clusters will be automatically removed after several hours. Consider waiting for this virtual cluster to expire or manually deleting this virtual cluster and then creating the managed instance.\n\n * 400 InstancePoolNotEnoughCapacity - An instance pool does not have enough capacity\n\n * 400 ManagedInstanceFreemiumNotAvailableForInputParameters - Managed instance creation or update executed with SLO that is not allowed for freemium.\n\n * 400 ManagedInstanceFreemiumNotAvailableOnRegion - Creation of a freemium managed instance on a region that is not allowlisted for freemium.\n\n * 400 ManagementServiceSubnetMaintenanceInProgress - User tried to initiate managed instance create/update while incompatible maintenance is in progress.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ManagedInstanceFreemiumNotAvailableForSubscription - Freemium is not enabled for this subscription type.\n\n * 400 ManagedInstanceInvalidEditionForInstancePool - User tried to select invalid service tier for managed instance inside an existing instance pool.\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 ManagedInstanceInvalidSubnetForInstancePool - User tried to select invalid subnet for managed instance inside an existing instance pool.\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 ManagedInstanceZoneRedudantFeatureNotSupported - ZoneRedundant feature is not supported for the selected service tier. For more details visit aka.ms/sqlmi-service-tier-characteristics.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - Enabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - Disabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SubnetIdCantBeUpdated - Changing managed instance subnet is not supported operation. Please remove this parameter from the request.\n\n * 400 MigrationToAnotherVNetNotSupported - Selected subnet is in another Virtual Network. Moving managed instance to another Virtual Network is not possible. Please provide subnet from Virtual Network {0}.\n\n * 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - Provided subnet is having different DNS zone from the current. Changing instance DNS zone is not supported. Please provide subnet with same DNS zone, create a new subnet or provide empty one.\n\n * 400 MigrationToGen4SubnetNotSupported - It is not possible to update subnet while running on Gen4 hardware as it is being deprecated. Please upgrade your hardware from Gen4 to Gen5 as part of the changing managed instance subnet operation by specifying both parameters at the same time: destination subnet and hardware generation.\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - The operation could not be completed because some of the database files are exceeding maximum General Purpose file size limit of {0} GB.\n\n * 400 CloudLifterUnsupportedFeature - The functionality is not available on the Managed Instance at this time.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 OperationCanNotStartDueToMiLink - The '{0}' operation cannot be completed as there exists a database in a process of creation through Managed Instance link. Please wait for the link creation to complete, or delete the link, and retry the operation again.\n\n * 400 ManagedInstanceSloUpdateFailed - SLO '{0}' operation cannot succeed as the memory usage of '{1}' exceeds the quota.\n\n * 400 SourceAndTargetSubnetsMustBeVnetPeered - Subnet currently used by managed instance and provided destination subnet are part of the virtual networks that are not connected with virtual network peering, or have peering established but don't have allowed traffic. In order to move managed instance from one subnet to another, virtual network peering needs to be established from both source and target virtual network. Please configure virtual network requirements and then try the operation again. Learn more https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks. \n\n * 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - Subnet provided for managed instance deployment is located on subscription different than the one submitted for managed instance. Managed instance and subnet used for deploying the instance must be on the same subscription. Please provide another subnet or switch to the subnet subscription and then try the operation again.\n\n * 400 CreateManagedInstanceInvalidSubnetSize - User attempted to create managed instance in a subnet that is smaller than the allowed minimal subnet size.\n\n * 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - Subnet selected for managed instance migration has address range that overlaps with address range of subnet that holds geo replicated secondary instance. Please verify that your subnet is configured according to guidelines in https://aka.ms/move-managed-instance. \n\n * 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - Subnet selected for managed instance migration is not configured to enable communication with a geo replicated secondary instance. Please check if all of the required ports are open. To properly configure your subnet read the guidelines in https://aka.ms/move-managed-instance. \n\n * 400 ManagedInstanceLocalStorageUpdateSloDisabled - Update SLO for managed instances with local storage is not supported yet.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 GatewayInvalidEdition - '{0}' is not a valid database edition in this version of SQL Server.\n\n * 400 ManagedInstanceInvalidHardwareFamilyForInstancePool - User tried to select invalid hardware family for managed instance inside an existing instance pool.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 ManagedInstanceInvalidLicenseTypeForInstancePool - User tried to select invalid license type for managed instance inside an existing instance pool.\n\n * 400 ManagedInstanceUpdateSloFromVersionlessToVersionedNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 ManagedInstanceUpdateSloFromNewerToOlderVersionEditionNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 ManagedInstanceUpdateSloFromVersionedToVersionlessWorkerCLNotAllowed - Changing the database format is not supported for this managed instance. Check the database format property value specified and visit https://aka.ms/sqlmi-fwnov2022 for more details.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 ManagedInstanceVersionEditionParameterNotAllowedForUsing - Specifying the database format property value is not supported at this time.\n\n * 400 ManagedInstanceFreemiumInvalidArchitecture - A freemium instance can not be created in the specified subnet '(0)'.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ManagedInstanceWithGeoDRMoveToInstancePoolNotAllowed - Customer has attempted to move a standalone Managed Instance with an existing auto-failover group configured into an instance pool, which is not supported. Only standalone instances without existing auto-failover groups configured can be moved to instance pools.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerRegion - Creation of ZoneRedundant SQL MI is temporarily disabled on this region. You can create Zone Redundant SQL Managed Instances in many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerHardwareGeneration - Creation of ZoneRedundant SQL MI is temporarily disabled for this hardware generation on this region. You can create Zone Redundant SQL Managed Instances with different hardware generation on this region or many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceUpdateSloGeoPrimaryWithNewerVersionEditionThanSecondary - Database format change must be performed on the secondary instance of the failover group first. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 ManagedInstanceFreemiumInstanceAlreadyExists - Only one free SQL Managed Instance is allowed per subscription.\n\n * 400 ManagementServiceGeodrSecondaryDatabaseInCreation - The '{0}' operation cannot be completed as there exists a database in a process of creation through failover group deployment. Please wait for the failover group deployment to complete, or alternatively delete the failover group and retry the operation again.\n\n * 400 ManagedInstanceConversionRegularToFreemiumNotAllowed - User tried converting a Regular SQL Managed Instance to Free SQL Managed Instance.\n\n * 400 ManagedInstanceConversionFreemiumToRegularAndUpdateSLOWhileStoppedNotAllowed - User tried converting a Free SQL Managed Instance to Regular SQL Managed Instance and Update SLO in same request, while Instance is stopped.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 ManagedInstanceMaintenanceWindowChangeNotAllowedWhenInInstancePool - Maintenance window is set at instance pool level and cannot be set individually per pooled instance.\n\n * 400 ManagedInstanceMoveToInstancePoolExceedsDbCountLimit - Cannot move the instance into the pool due to pool database count limit.\n\n * 400 ManagedInstancePoolZoneRedundancyNotSupported - Cannot move a zone-redundant instance into the pool as zone-redundancy is not supported in pools.\n\n * 400 DeploymentIntoPrivateSubnetsNotAllowed - Deploying managed instances and instance pools into private subnets is not supported.\n\n * 400 StorageIOpsNotSupported - Storage IOps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidCollation - Invalid collation.\n\n * 400 StorageThroughputMBpsNotSupported - Storage throughput MBps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 StorageIOpsNotSupportedForSpecifiedEdition - Storage IOps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 StorageThroughputMBpsNotSupportedForSpecifiedEdition - Storage throughput MBps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 ManagedInstanceClassicVnetNotSupported - Managed Instance cannot be joined to a classic virtual network.\n\n * 400 AlterDbDeactivatedNotSupported - Database Operation failed for Server '{0}', Database '{1}' due to unexpected delay. Please try again.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetConfigHasNsg - User tried to inject Managed Server subnet with Network Security Groups.\n\n * 400 VnetConfigHasNoUdr - User tried to inject Managed Server subnet without default User Defined Route Table.\n\n * 400 VnetConfigHasInvalidUdr - User tried to inject Managed Server subnet with invalid User Defined Route Table.\n\n * 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.\n\n * 400 VnetConfigHasServiceEndpoints - User tried to inject Managed Server subnet with service endpoints.\n\n * 400 VnetSubnetIsInUse - User tried to inject Managed Server subnet that is not empty.\n\n * 400 VnetSubnetIsLocked - User tried to inject Managed Server subnet that is in locked scope.\n\n * 400 VnetSubnetIsGateway - User tried to inject Managed Server subnet that is Gateway subnet.\n\n * 400 VnetSubnetIsUnknown - User tried to inject Managed Server subnet that does not exist.\n\n * 400 VnetSubnetConflictWithIntendedPolicy - User tried to inject Managed Server subnet that has a conflict with IntendedPolicy.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 ManagedInstanceInvalidEditionForSku - The specified edition {0} is not consistent with the specified SKU {1}.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInCreateOfMI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the create operation.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagedInstanceInvalidLicenseType - The specified license type {0} is not valid.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInUpdateOfGPV1MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V1 Managed Instance.\n\n * 400 UnspecifiedTargetEditionAndFalseGPV2NotAllowedInUpdateOfGPV2MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value FALSE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 GPTargetEditionAndUnspecifiedGPV2NotAllowedInUpdateOFGPV2MI - Combination of General Purpose target edition (sku.name/sku.tier parameters) and unspecified value for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 BCTargetEditionAndSpecifiedGPV2ParamNotAllowedInCreateUpdateOfMI - Combination of Business Critical target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the create/update operation.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 UnspecifiedTargetEditionAndSpecifiedGPV2ParamNotAllowedInUpdateOfBCMI - Combination of unspecified target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the update operation of Business Critical Managed Instance.\n\n * 400 TotalMemoryMBNotSupported - Total memory MB parameter is not allowed in the instance create/update operation.\n\n * 400 TotalMemoryMBNotSupportedForSpecifiedEdition - Total memory MB parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 VnetResourceNotFound - Resource not found: '{0}'.\n\n * 400 InvalidTimezone - Invalid timezone.\n\n * 400 InvalidSubnetForGPV2Edition - General Purpose v2 edition of Managed Instance is not compatible with the specified subnet. Target subnet must be either empty, or all instances in it must run with November 2022 Feature Wave.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 TotalMemoryMBInvalidLimit - Total memory MB parameter has been set to an invalid limit.\n\n * 400 ManagedInstanceUpdateSloGPv2PerDatabaseFileLimitExceeded - The operation could not be completed because there is at least one database whose number of files is exceeding the limit of {0} files per database on General Purpose v2 edition.\n\n * 400 InstanceCollationUpdateNotSupported - User cannot change instance collation on Managed Instance.\n\n * 400 NextGenGPNotSupportedForCmwCustomers - Next-Gen General Purpose edition of Managed Instance does not support Custom Maintance Window.\n\n * 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - User can create a Managed Instance only with collation 'SQL_Latin1_General_CP1_CI_AS'.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedInstanceExceedMaxAzureStorage - The operation could not be completed because total allocated storage size for General Purpose instance would exceed {0}. Please reduce the number of database files and retry operation.\n\n * 400 ManagedInstanceHasGeoReplica - The operation could not be completed because instance has configured geo replicated secondary instance.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 405 InvalidStorageIOpsLimitValue - Invalid storage IOps limit: {0} IOps. Storage IOps limit must be specified between {1} IOps and {2} IOps, in increments of {3} IOps.\n\n * 405 InvalidStorageThroughputMBpsLimitValue - Invalid storage throughput limit: {0} MBps. Storage throughput limit must be specified between {1} MBps and {2} MBps, in increments of {3} MBps.\n\n * 405 InvalidVcoreValue - vCore value {0} is not valid. Please specify a valid vCore value.\n\n * 405 InvalidHardwareGenerationValue - HardwareGeneration {0} is not valid. Please specify a valid HardwareGeneration value.\n\n * 405 InvalidStorageSizeValue - \"Invalid storage size: {0} GB. Storage size must be specified between {1} and {2} gigabytes, in increments of {3} GB.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 409 ServerOverridePreconditionFailed - Failed to apply server override on category '{0}', because physical db or instance '{1}' in server '{2}' is currently not in 'Ready' or 'Deactivated' state.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ManagedInstanceIsBusy - The server '{0}' is currently busy. Please wait a few minutes before trying again.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 GatewayInternalServerError - The server encountered an unexpected exception.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -97,7 +97,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidDnsZone - The operation has failed because you are attempting to deploy managed instance as a geo-replication secondary to the subnet {0} in which there already exists a managed instance. Deploying managed instance as a geo-replication secondary is supported only in cases when managed instance is the first instance deployed in a subnet. Consider deploying managed instance as a geo-replication secondary to a different subnet in which there are no existing managed instances, or if deploying to a subnet with existing managed instance disable the geo-replication option.\n\n * 400 HkCannotSwitchToInactive - The database cannot proceed with pricing-tier update as it has memory-optimized objects. Please drop such objects and try again.\n\n * 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - Invalid storage size: Storage size limit ({0} GB) is less that current storage used ({1} GB). Please specify higher storage size limit.\n\n * 400 InstanceTimezoneUpdateNotSupported - Instance timezone update not supported.\n\n * 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - Create Managed Instance with non-default timezone not supported.\n\n * 400 ManagedInstanceIpAddressRangeLimit - Cannot perform creation/scaling of the managed instance as there are not enough available IP addresses in the subnet for performing the operation.\n\n * 400 VnetDelegationNotAllowed - User tried to inject Managed Server to subnet which is delegated.\n\n * 400 SubnetHasResourcesOfDifferentType - User tried to create MI in subnet that has resources of different type.\n\n * 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - Update of Managed Instance with maintenance window settings is not allowed.\n\n * 400 OperationNotAllowedInCurrentGeodrConfiguration - The operation is not allowed because the current geo-replication configuration does not allow this combination of {0}. Change the setting on the geo-replication partner before applying the change on this instance.\n\n * 400 VnetPrepareNIPFailed - User tried to prepare subnet that has a conflict with NetworkIntentPolicy.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 ManagedInstanceDeprecatedHardwareFamily - Changing the hardware generation to deprecated {0} generation is not possible.\n\n * 400 ManagedInstanceBackupStorageTypeNotSupported - Backup storage type parameter is not allowed in the instance update operation.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 EmptyPDCInvalidDnsZone - This managed instance cannot be deployed because its DNS-zone does not match the DNS-prefix of its intended virtual cluster for subnet {0}. Although this virtual cluster is empty, its DNS-prefix cannot be changed. Empty virtual clusters will be automatically removed after several hours. Consider waiting for this virtual cluster to expire or manually deleting this virtual cluster and then creating the managed instance.\n\n * 400 InstancePoolNotEnoughCapacity - An instance pool does not have enough capacity\n\n * 400 ManagedInstanceFreemiumNotAvailableForInputParameters - Managed instance creation or update executed with SLO that is not allowed for freemium.\n\n * 400 ManagedInstanceFreemiumNotAvailableOnRegion - Creation of a freemium managed instance on a region that is not allowlisted for freemium.\n\n * 400 ManagementServiceSubnetMaintenanceInProgress - User tried to initiate managed instance create/update while incompatible maintenance is in progress.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ManagedInstanceFreemiumNotAvailableForSubscription - Freemium is not enabled for this subscription type.\n\n * 400 ManagedInstanceInvalidEditionForInstancePool - User tried to select invalid service tier for managed instance inside an existing instance pool.\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 ManagedInstanceInvalidSubnetForInstancePool - User tried to select invalid subnet for managed instance inside an existing instance pool.\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 ManagedInstanceZoneRedudantFeatureNotSupported - ZoneRedundant feature is not supported for the selected service tier. For more details visit aka.ms/sqlmi-service-tier-characteristics.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - Enabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - Disabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SubnetIdCantBeUpdated - Changing managed instance subnet is not supported operation. Please remove this parameter from the request.\n\n * 400 MigrationToAnotherVNetNotSupported - Selected subnet is in another Virtual Network. Moving managed instance to another Virtual Network is not possible. Please provide subnet from Virtual Network {0}.\n\n * 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - Provided subnet is having different DNS zone from the current. Changing instance DNS zone is not supported. Please provide subnet with same DNS zone, create a new subnet or provide empty one.\n\n * 400 MigrationToGen4SubnetNotSupported - It is not possible to update subnet while running on Gen4 hardware as it is being deprecated. Please upgrade your hardware from Gen4 to Gen5 as part of the changing managed instance subnet operation by specifying both parameters at the same time: destination subnet and hardware generation.\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - The operation could not be completed because some of the database files are exceeding maximum General Purpose file size limit of {0} GB.\n\n * 400 CloudLifterUnsupportedFeature - The functionality is not available on the Managed Instance at this time.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 OperationCanNotStartDueToMiLink - The '{0}' operation cannot be completed as there exists a database in a process of creation through Managed Instance link. Please wait for the link creation to complete, or delete the link, and retry the operation again.\n\n * 400 ManagedInstanceSloUpdateFailed - SLO '{0}' operation cannot succeed as the memory usage of '{1}' exceeds the quota.\n\n * 400 SourceAndTargetSubnetsMustBeVnetPeered - Subnet currently used by managed instance and provided destination subnet are part of the virtual networks that are not connected with virtual network peering, or have peering established but don't have allowed traffic. In order to move managed instance from one subnet to another, virtual network peering needs to be established from both source and target virtual network. Please configure virtual network requirements and then try the operation again. Learn more https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks. \n\n * 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - Subnet provided for managed instance deployment is located on subscription different than the one submitted for managed instance. Managed instance and subnet used for deploying the instance must be on the same subscription. Please provide another subnet or switch to the subnet subscription and then try the operation again.\n\n * 400 CreateManagedInstanceInvalidSubnetSize - User attempted to create managed instance in a subnet that is smaller than the allowed minimal subnet size.\n\n * 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - Subnet selected for managed instance migration has address range that overlaps with address range of subnet that holds geo replicated secondary instance. Please verify that your subnet is configured according to guidelines in https://aka.ms/move-managed-instance. \n\n * 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - Subnet selected for managed instance migration is not configured to enable communication with a geo replicated secondary instance. Please check if all of the required ports are open. To properly configure your subnet read the guidelines in https://aka.ms/move-managed-instance. \n\n * 400 ManagedInstanceLocalStorageUpdateSloDisabled - Update SLO for managed instances with local storage is not supported yet.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 GatewayInvalidEdition - '{0}' is not a valid database edition in this version of SQL Server.\n\n * 400 ManagedInstanceInvalidHardwareFamilyForInstancePool - User tried to select invalid hardware family for managed instance inside an existing instance pool.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 ManagedInstanceInvalidLicenseTypeForInstancePool - User tried to select invalid license type for managed instance inside an existing instance pool.\n\n * 400 ManagedInstanceUpdateSloFromVersionlessToVersionedNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 ManagedInstanceUpdateSloFromNewerToOlderVersionEditionNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 ManagedInstanceUpdateSloFromVersionedToVersionlessWorkerCLNotAllowed - Changing the database format is not supported for this managed instance. Check the database format property value specified and visit https://aka.ms/sqlmi-fwnov2022 for more details.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 ManagedInstanceVersionEditionParameterNotAllowedForUsing - Specifying the database format property value is not supported at this time.\n\n * 400 ManagedInstanceFreemiumInvalidArchitecture - A freemium instance can not be created in the specified subnet '(0)'.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ManagedInstanceGeoDRNotAllowedForInstancePool - Creating auto-failover group (GeoDR) is not supported for Managed Instances provisioned inside instance pools. Auto failover groups can be created only for standalone Managed Instances.\n\n * 400 ManagedInstanceWithGeoDRMoveToInstancePoolNotAllowed - Customer has attempted to move a standalone Managed Instance with an existing auto-failover group configured into an instance pool, which is not supported. Only standalone instances without existing auto-failover groups configured can be moved to instance pools.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerRegion - Creation of ZoneRedundant SQL MI is temporarily disabled on this region. You can create Zone Redundant SQL Managed Instances in many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerHardwareGeneration - Creation of ZoneRedundant SQL MI is temporarily disabled for this hardware generation on this region. You can create Zone Redundant SQL Managed Instances with different hardware generation on this region or many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceUpdateSloGeoPrimaryWithNewerVersionEditionThanSecondary - Database format change must be performed on the secondary instance of the failover group first. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 ManagedInstanceFreemiumInstanceAlreadyExists - Only one free SQL Managed Instance is allowed per subscription.\n\n * 400 ManagementServiceGeodrSecondaryDatabaseInCreation - The '{0}' operation cannot be completed as there exists a database in a process of creation through failover group deployment. Please wait for the failover group deployment to complete, or alternatively delete the failover group and retry the operation again.\n\n * 400 ManagedInstanceConversionRegularToFreemiumNotAllowed - User tried converting a Regular SQL Managed Instance to Free SQL Managed Instance.\n\n * 400 ManagedInstanceConversionFreemiumToRegularAndUpdateSLOWhileStoppedNotAllowed - User tried converting a Free SQL Managed Instance to Regular SQL Managed Instance and Update SLO in same request, while Instance is stopped.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 ManagedInstanceMaintenanceWindowChangeNotAllowedWhenInInstancePool - Maintenance window is set at instance pool level and cannot be set individually per pooled instance.\n\n * 400 ManagedInstanceMoveToInstancePoolExceedsDbCountLimit - Cannot move the instance into the pool due to pool database count limit.\n\n * 400 StorageIOpsNotSupported - Storage IOps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidCollation - Invalid collation.\n\n * 400 StorageThroughputMBpsNotSupported - Storage throughput MBps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 StorageIOpsNotSupportedForSpecifiedEdition - Storage IOps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 StorageThroughputMBpsNotSupportedForSpecifiedEdition - Storage throughput MBps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 ManagedInstanceClassicVnetNotSupported - Managed Instance cannot be joined to a classic virtual network.\n\n * 400 AlterDbDeactivatedNotSupported - Database Operation failed for Server '{0}', Database '{1}' due to unexpected delay. Please try again.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetConfigHasNsg - User tried to inject Managed Server subnet with Network Security Groups.\n\n * 400 VnetConfigHasNoUdr - User tried to inject Managed Server subnet without default User Defined Route Table.\n\n * 400 VnetConfigHasInvalidUdr - User tried to inject Managed Server subnet with invalid User Defined Route Table.\n\n * 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.\n\n * 400 VnetConfigHasServiceEndpoints - User tried to inject Managed Server subnet with service endpoints.\n\n * 400 VnetSubnetIsInUse - User tried to inject Managed Server subnet that is not empty.\n\n * 400 VnetSubnetIsLocked - User tried to inject Managed Server subnet that is in locked scope.\n\n * 400 VnetSubnetIsGateway - User tried to inject Managed Server subnet that is Gateway subnet.\n\n * 400 VnetSubnetIsUnknown - User tried to inject Managed Server subnet that does not exist.\n\n * 400 VnetSubnetConflictWithIntendedPolicy - User tried to inject Managed Server subnet that has a conflict with IntendedPolicy.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 ManagedInstanceInvalidEditionForSku - The specified edition {0} is not consistent with the specified SKU {1}.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInCreateOfMI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the create operation.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagedInstanceInvalidLicenseType - The specified license type {0} is not valid.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInUpdateOfGPV1MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V1 Managed Instance.\n\n * 400 UnspecifiedTargetEditionAndFalseGPV2NotAllowedInUpdateOfGPV2MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value FALSE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 GPTargetEditionAndUnspecifiedGPV2NotAllowedInUpdateOFGPV2MI - Combination of General Purpose target edition (sku.name/sku.tier parameters) and unspecified value for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 BCTargetEditionAndSpecifiedGPV2ParamNotAllowedInCreateUpdateOfMI - Combination of Business Critical target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the create/update operation.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 UnspecifiedTargetEditionAndSpecifiedGPV2ParamNotAllowedInUpdateOfBCMI - Combination of unspecified target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the update operation of Business Critical Managed Instance.\n\n * 400 TotalMemoryMBNotSupported - Total memory MB parameter is not allowed in the instance create/update operation.\n\n * 400 TotalMemoryMBNotSupportedForSpecifiedEdition - Total memory MB parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 VnetResourceNotFound - Resource not found: '{0}'.\n\n * 400 InvalidTimezone - Invalid timezone.\n\n * 400 InvalidSubnetForGPV2Edition - General Purpose v2 edition of Managed Instance is not compatible with the specified subnet. Target subnet must be either empty, or all instances in it must run with November 2022 Feature Wave.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 TotalMemoryMBInvalidLimit - Total memory MB parameter has been set to an invalid limit.\n\n * 400 ManagedInstanceUpdateSloGPv2PerDatabaseFileLimitExceeded - The operation could not be completed because there is at least one database whose number of files is exceeding the limit of {0} files per database on General Purpose v2 edition.\n\n * 400 InstanceCollationUpdateNotSupported - User cannot change instance collation on Managed Instance.\n\n * 400 NextGenGPNotSupportedForCmwCustomers - Next-Gen General Purpose edition of Managed Instance does not support Custom Maintenance Window.\n\n * 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - User can create a Managed Instance only with collation 'SQL_Latin1_General_CP1_CI_AS'.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedInstanceExceedMaxAzureStorage - The operation could not be completed because total allocated storage size for General Purpose instance would exceed {0}. Please reduce the number of database files and retry operation.\n\n * 400 ManagedInstanceHasGeoReplica - The operation could not be completed because instance has configured geo replicated secondary instance.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 405 InvalidStorageIOpsLimitValue - Invalid storage IOps limit: {0} IOps. Storage IOps limit must be specified between {1} IOps and {2} IOps, in increments of {3} IOps.\n\n * 405 InvalidStorageThroughputMBpsLimitValue - Invalid storage throughput limit: {0} MBps. Storage throughput limit must be specified between {1} MBps and {2} MBps, in increments of {3} MBps.\n\n * 405 InvalidVcoreValue - vCore value {0} is not valid. Please specify a valid vCore value.\n\n * 405 InvalidHardwareGenerationValue - HardwareGeneration {0} is not valid. Please specify a valid HardwareGeneration value.\n\n * 405 InvalidStorageSizeValue - \"Invalid storage size: {0} GB. Storage size must be specified between {1} and {2} gigabytes, in increments of {3} GB.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 409 ServerOverridePreconditionFailed - Failed to apply server override on category '{0}', because physical db or instance '{1}' in server '{2}' is currently not in 'Ready' or 'Deactivated' state.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ManagedInstanceIsBusy - The server '{0}' is currently busy. Please wait a few minutes before trying again.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 GatewayInternalServerError - The server encountered an unexpected exception.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 InvalidDnsZone - The operation has failed because you are attempting to deploy managed instance as a geo-replication secondary to the subnet {0} in which there already exists a managed instance. Deploying managed instance as a geo-replication secondary is supported only in cases when managed instance is the first instance deployed in a subnet. Consider deploying managed instance as a geo-replication secondary to a different subnet in which there are no existing managed instances, or if deploying to a subnet with existing managed instance disable the geo-replication option.\n\n * 400 HkCannotSwitchToInactive - The database cannot proceed with pricing-tier update as it has memory-optimized objects. Please drop such objects and try again.\n\n * 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - Invalid storage size: Storage size limit ({0} GB) is less that current storage used ({1} GB). Please specify higher storage size limit.\n\n * 400 InstanceTimezoneUpdateNotSupported - Instance timezone update not supported.\n\n * 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - Create Managed Instance with non-default timezone not supported.\n\n * 400 ManagedInstanceIpAddressRangeLimit - Cannot perform creation/scaling of the managed instance as there are not enough available IP addresses in the subnet for performing the operation.\n\n * 400 VnetDelegationNotAllowed - User tried to inject Managed Server to subnet which is delegated.\n\n * 400 SubnetHasResourcesOfDifferentType - User tried to create MI in subnet that has resources of different type.\n\n * 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - Update of Managed Instance with maintenance window settings is not allowed.\n\n * 400 OperationNotAllowedInCurrentGeodrConfiguration - The operation is not allowed because the current geo-replication configuration does not allow this combination of {0}. Change the setting on the geo-replication partner before applying the change on this instance.\n\n * 400 VnetPrepareNIPFailed - User tried to prepare subnet that has a conflict with NetworkIntentPolicy.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 ManagedInstanceDeprecatedHardwareFamily - Changing the hardware generation to deprecated {0} generation is not possible.\n\n * 400 ManagedInstanceBackupStorageTypeNotSupported - Backup storage type parameter is not allowed in the instance update operation.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 EmptyPDCInvalidDnsZone - This managed instance cannot be deployed because its DNS-zone does not match the DNS-prefix of its intended virtual cluster for subnet {0}. Although this virtual cluster is empty, its DNS-prefix cannot be changed. Empty virtual clusters will be automatically removed after several hours. Consider waiting for this virtual cluster to expire or manually deleting this virtual cluster and then creating the managed instance.\n\n * 400 InstancePoolNotEnoughCapacity - An instance pool does not have enough capacity\n\n * 400 ManagedInstanceFreemiumNotAvailableForInputParameters - Managed instance creation or update executed with SLO that is not allowed for freemium.\n\n * 400 ManagedInstanceFreemiumNotAvailableOnRegion - Creation of a freemium managed instance on a region that is not allowlisted for freemium.\n\n * 400 ManagementServiceSubnetMaintenanceInProgress - User tried to initiate managed instance create/update while incompatible maintenance is in progress.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ManagedInstanceFreemiumNotAvailableForSubscription - Freemium is not enabled for this subscription type.\n\n * 400 ManagedInstanceInvalidEditionForInstancePool - User tried to select invalid service tier for managed instance inside an existing instance pool.\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 ManagedInstanceInvalidSubnetForInstancePool - User tried to select invalid subnet for managed instance inside an existing instance pool.\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 ManagedInstanceZoneRedudantFeatureNotSupported - ZoneRedundant feature is not supported for the selected service tier. For more details visit aka.ms/sqlmi-service-tier-characteristics.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - Enabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - Disabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SubnetIdCantBeUpdated - Changing managed instance subnet is not supported operation. Please remove this parameter from the request.\n\n * 400 MigrationToAnotherVNetNotSupported - Selected subnet is in another Virtual Network. Moving managed instance to another Virtual Network is not possible. Please provide subnet from Virtual Network {0}.\n\n * 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - Provided subnet is having different DNS zone from the current. Changing instance DNS zone is not supported. Please provide subnet with same DNS zone, create a new subnet or provide empty one.\n\n * 400 MigrationToGen4SubnetNotSupported - It is not possible to update subnet while running on Gen4 hardware as it is being deprecated. Please upgrade your hardware from Gen4 to Gen5 as part of the changing managed instance subnet operation by specifying both parameters at the same time: destination subnet and hardware generation.\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - The operation could not be completed because some of the database files are exceeding maximum General Purpose file size limit of {0} GB.\n\n * 400 CloudLifterUnsupportedFeature - The functionality is not available on the Managed Instance at this time.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 OperationCanNotStartDueToMiLink - The '{0}' operation cannot be completed as there exists a database in a process of creation through Managed Instance link. Please wait for the link creation to complete, or delete the link, and retry the operation again.\n\n * 400 ManagedInstanceSloUpdateFailed - SLO '{0}' operation cannot succeed as the memory usage of '{1}' exceeds the quota.\n\n * 400 SourceAndTargetSubnetsMustBeVnetPeered - Subnet currently used by managed instance and provided destination subnet are part of the virtual networks that are not connected with virtual network peering, or have peering established but don't have allowed traffic. In order to move managed instance from one subnet to another, virtual network peering needs to be established from both source and target virtual network. Please configure virtual network requirements and then try the operation again. Learn more https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks. \n\n * 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - Subnet provided for managed instance deployment is located on subscription different than the one submitted for managed instance. Managed instance and subnet used for deploying the instance must be on the same subscription. Please provide another subnet or switch to the subnet subscription and then try the operation again.\n\n * 400 CreateManagedInstanceInvalidSubnetSize - User attempted to create managed instance in a subnet that is smaller than the allowed minimal subnet size.\n\n * 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - Subnet selected for managed instance migration has address range that overlaps with address range of subnet that holds geo replicated secondary instance. Please verify that your subnet is configured according to guidelines in https://aka.ms/move-managed-instance. \n\n * 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - Subnet selected for managed instance migration is not configured to enable communication with a geo replicated secondary instance. Please check if all of the required ports are open. To properly configure your subnet read the guidelines in https://aka.ms/move-managed-instance. \n\n * 400 ManagedInstanceLocalStorageUpdateSloDisabled - Update SLO for managed instances with local storage is not supported yet.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 GatewayInvalidEdition - '{0}' is not a valid database edition in this version of SQL Server.\n\n * 400 ManagedInstanceInvalidHardwareFamilyForInstancePool - User tried to select invalid hardware family for managed instance inside an existing instance pool.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 ManagedInstanceInvalidLicenseTypeForInstancePool - User tried to select invalid license type for managed instance inside an existing instance pool.\n\n * 400 ManagedInstanceUpdateSloFromVersionlessToVersionedNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 ManagedInstanceUpdateSloFromNewerToOlderVersionEditionNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 ManagedInstanceUpdateSloFromVersionedToVersionlessWorkerCLNotAllowed - Changing the database format is not supported for this managed instance. Check the database format property value specified and visit https://aka.ms/sqlmi-fwnov2022 for more details.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 ManagedInstanceVersionEditionParameterNotAllowedForUsing - Specifying the database format property value is not supported at this time.\n\n * 400 ManagedInstanceFreemiumInvalidArchitecture - A freemium instance can not be created in the specified subnet '(0)'.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ManagedInstanceWithGeoDRMoveToInstancePoolNotAllowed - Customer has attempted to move a standalone Managed Instance with an existing auto-failover group configured into an instance pool, which is not supported. Only standalone instances without existing auto-failover groups configured can be moved to instance pools.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerRegion - Creation of ZoneRedundant SQL MI is temporarily disabled on this region. You can create Zone Redundant SQL Managed Instances in many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerHardwareGeneration - Creation of ZoneRedundant SQL MI is temporarily disabled for this hardware generation on this region. You can create Zone Redundant SQL Managed Instances with different hardware generation on this region or many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceUpdateSloGeoPrimaryWithNewerVersionEditionThanSecondary - Database format change must be performed on the secondary instance of the failover group first. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 ManagedInstanceFreemiumInstanceAlreadyExists - Only one free SQL Managed Instance is allowed per subscription.\n\n * 400 ManagementServiceGeodrSecondaryDatabaseInCreation - The '{0}' operation cannot be completed as there exists a database in a process of creation through failover group deployment. Please wait for the failover group deployment to complete, or alternatively delete the failover group and retry the operation again.\n\n * 400 ManagedInstanceConversionRegularToFreemiumNotAllowed - User tried converting a Regular SQL Managed Instance to Free SQL Managed Instance.\n\n * 400 ManagedInstanceConversionFreemiumToRegularAndUpdateSLOWhileStoppedNotAllowed - User tried converting a Free SQL Managed Instance to Regular SQL Managed Instance and Update SLO in same request, while Instance is stopped.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 ManagedInstanceMaintenanceWindowChangeNotAllowedWhenInInstancePool - Maintenance window is set at instance pool level and cannot be set individually per pooled instance.\n\n * 400 ManagedInstanceMoveToInstancePoolExceedsDbCountLimit - Cannot move the instance into the pool due to pool database count limit.\n\n * 400 ManagedInstancePoolZoneRedundancyNotSupported - Cannot move a zone-redundant instance into the pool as zone-redundancy is not supported in pools.\n\n * 400 DeploymentIntoPrivateSubnetsNotAllowed - Deploying managed instances and instance pools into private subnets is not supported.\n\n * 400 StorageIOpsNotSupported - Storage IOps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidCollation - Invalid collation.\n\n * 400 StorageThroughputMBpsNotSupported - Storage throughput MBps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 StorageIOpsNotSupportedForSpecifiedEdition - Storage IOps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 StorageThroughputMBpsNotSupportedForSpecifiedEdition - Storage throughput MBps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 ManagedInstanceClassicVnetNotSupported - Managed Instance cannot be joined to a classic virtual network.\n\n * 400 AlterDbDeactivatedNotSupported - Database Operation failed for Server '{0}', Database '{1}' due to unexpected delay. Please try again.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetConfigHasNsg - User tried to inject Managed Server subnet with Network Security Groups.\n\n * 400 VnetConfigHasNoUdr - User tried to inject Managed Server subnet without default User Defined Route Table.\n\n * 400 VnetConfigHasInvalidUdr - User tried to inject Managed Server subnet with invalid User Defined Route Table.\n\n * 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.\n\n * 400 VnetConfigHasServiceEndpoints - User tried to inject Managed Server subnet with service endpoints.\n\n * 400 VnetSubnetIsInUse - User tried to inject Managed Server subnet that is not empty.\n\n * 400 VnetSubnetIsLocked - User tried to inject Managed Server subnet that is in locked scope.\n\n * 400 VnetSubnetIsGateway - User tried to inject Managed Server subnet that is Gateway subnet.\n\n * 400 VnetSubnetIsUnknown - User tried to inject Managed Server subnet that does not exist.\n\n * 400 VnetSubnetConflictWithIntendedPolicy - User tried to inject Managed Server subnet that has a conflict with IntendedPolicy.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 ManagedInstanceInvalidEditionForSku - The specified edition {0} is not consistent with the specified SKU {1}.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInCreateOfMI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the create operation.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagedInstanceInvalidLicenseType - The specified license type {0} is not valid.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInUpdateOfGPV1MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V1 Managed Instance.\n\n * 400 UnspecifiedTargetEditionAndFalseGPV2NotAllowedInUpdateOfGPV2MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value FALSE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 GPTargetEditionAndUnspecifiedGPV2NotAllowedInUpdateOFGPV2MI - Combination of General Purpose target edition (sku.name/sku.tier parameters) and unspecified value for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 BCTargetEditionAndSpecifiedGPV2ParamNotAllowedInCreateUpdateOfMI - Combination of Business Critical target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the create/update operation.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 UnspecifiedTargetEditionAndSpecifiedGPV2ParamNotAllowedInUpdateOfBCMI - Combination of unspecified target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the update operation of Business Critical Managed Instance.\n\n * 400 TotalMemoryMBNotSupported - Total memory MB parameter is not allowed in the instance create/update operation.\n\n * 400 TotalMemoryMBNotSupportedForSpecifiedEdition - Total memory MB parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 VnetResourceNotFound - Resource not found: '{0}'.\n\n * 400 InvalidTimezone - Invalid timezone.\n\n * 400 InvalidSubnetForGPV2Edition - General Purpose v2 edition of Managed Instance is not compatible with the specified subnet. Target subnet must be either empty, or all instances in it must run with November 2022 Feature Wave.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 TotalMemoryMBInvalidLimit - Total memory MB parameter has been set to an invalid limit.\n\n * 400 ManagedInstanceUpdateSloGPv2PerDatabaseFileLimitExceeded - The operation could not be completed because there is at least one database whose number of files is exceeding the limit of {0} files per database on General Purpose v2 edition.\n\n * 400 InstanceCollationUpdateNotSupported - User cannot change instance collation on Managed Instance.\n\n * 400 NextGenGPNotSupportedForCmwCustomers - Next-Gen General Purpose edition of Managed Instance does not support Custom Maintance Window.\n\n * 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - User can create a Managed Instance only with collation 'SQL_Latin1_General_CP1_CI_AS'.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedInstanceExceedMaxAzureStorage - The operation could not be completed because total allocated storage size for General Purpose instance would exceed {0}. Please reduce the number of database files and retry operation.\n\n * 400 ManagedInstanceHasGeoReplica - The operation could not be completed because instance has configured geo replicated secondary instance.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 405 InvalidStorageIOpsLimitValue - Invalid storage IOps limit: {0} IOps. Storage IOps limit must be specified between {1} IOps and {2} IOps, in increments of {3} IOps.\n\n * 405 InvalidStorageThroughputMBpsLimitValue - Invalid storage throughput limit: {0} MBps. Storage throughput limit must be specified between {1} MBps and {2} MBps, in increments of {3} MBps.\n\n * 405 InvalidVcoreValue - vCore value {0} is not valid. Please specify a valid vCore value.\n\n * 405 InvalidHardwareGenerationValue - HardwareGeneration {0} is not valid. Please specify a valid HardwareGeneration value.\n\n * 405 InvalidStorageSizeValue - \"Invalid storage size: {0} GB. Storage size must be specified between {1} and {2} gigabytes, in increments of {3} GB.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 409 ServerOverridePreconditionFailed - Failed to apply server override on category '{0}', because physical db or instance '{1}' in server '{2}' is currently not in 'Ready' or 'Deactivated' state.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ManagedInstanceIsBusy - The server '{0}' is currently busy. Please wait a few minutes before trying again.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 GatewayInternalServerError - The server encountered an unexpected exception.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -153,13 +153,18 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidDnsZone - The operation has failed because you are attempting to deploy managed instance as a geo-replication secondary to the subnet {0} in which there already exists a managed instance. Deploying managed instance as a geo-replication secondary is supported only in cases when managed instance is the first instance deployed in a subnet. Consider deploying managed instance as a geo-replication secondary to a different subnet in which there are no existing managed instances, or if deploying to a subnet with existing managed instance disable the geo-replication option.\n\n * 400 HkCannotSwitchToInactive - The database cannot proceed with pricing-tier update as it has memory-optimized objects. Please drop such objects and try again.\n\n * 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - Invalid storage size: Storage size limit ({0} GB) is less that current storage used ({1} GB). Please specify higher storage size limit.\n\n * 400 InstanceTimezoneUpdateNotSupported - Instance timezone update not supported.\n\n * 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - Create Managed Instance with non-default timezone not supported.\n\n * 400 ManagedInstanceIpAddressRangeLimit - Cannot perform creation/scaling of the managed instance as there are not enough available IP addresses in the subnet for performing the operation.\n\n * 400 VnetDelegationNotAllowed - User tried to inject Managed Server to subnet which is delegated.\n\n * 400 SubnetHasResourcesOfDifferentType - User tried to create MI in subnet that has resources of different type.\n\n * 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - Update of Managed Instance with maintenance window settings is not allowed.\n\n * 400 OperationNotAllowedInCurrentGeodrConfiguration - The operation is not allowed because the current geo-replication configuration does not allow this combination of {0}. Change the setting on the geo-replication partner before applying the change on this instance.\n\n * 400 VnetPrepareNIPFailed - User tried to prepare subnet that has a conflict with NetworkIntentPolicy.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 ManagedInstanceDeprecatedHardwareFamily - Changing the hardware generation to deprecated {0} generation is not possible.\n\n * 400 ManagedInstanceBackupStorageTypeNotSupported - Backup storage type parameter is not allowed in the instance update operation.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 EmptyPDCInvalidDnsZone - This managed instance cannot be deployed because its DNS-zone does not match the DNS-prefix of its intended virtual cluster for subnet {0}. Although this virtual cluster is empty, its DNS-prefix cannot be changed. Empty virtual clusters will be automatically removed after several hours. Consider waiting for this virtual cluster to expire or manually deleting this virtual cluster and then creating the managed instance.\n\n * 400 InstancePoolNotEnoughCapacity - An instance pool does not have enough capacity\n\n * 400 ManagedInstanceFreemiumNotAvailableForInputParameters - Managed instance creation or update executed with SLO that is not allowed for freemium.\n\n * 400 ManagedInstanceFreemiumNotAvailableOnRegion - Creation of a freemium managed instance on a region that is not allowlisted for freemium.\n\n * 400 ManagementServiceSubnetMaintenanceInProgress - User tried to initiate managed instance create/update while incompatible maintenance is in progress.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ManagedInstanceFreemiumNotAvailableForSubscription - Freemium is not enabled for this subscription type.\n\n * 400 ManagedInstanceInvalidEditionForInstancePool - User tried to select invalid service tier for managed instance inside an existing instance pool.\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 ManagedInstanceInvalidSubnetForInstancePool - User tried to select invalid subnet for managed instance inside an existing instance pool.\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 ManagedInstanceZoneRedudantFeatureNotSupported - ZoneRedundant feature is not supported for the selected service tier. For more details visit aka.ms/sqlmi-service-tier-characteristics.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - Enabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - Disabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SubnetIdCantBeUpdated - Changing managed instance subnet is not supported operation. Please remove this parameter from the request.\n\n * 400 MigrationToAnotherVNetNotSupported - Selected subnet is in another Virtual Network. Moving managed instance to another Virtual Network is not possible. Please provide subnet from Virtual Network {0}.\n\n * 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - Provided subnet is having different DNS zone from the current. Changing instance DNS zone is not supported. Please provide subnet with same DNS zone, create a new subnet or provide empty one.\n\n * 400 MigrationToGen4SubnetNotSupported - It is not possible to update subnet while running on Gen4 hardware as it is being deprecated. Please upgrade your hardware from Gen4 to Gen5 as part of the changing managed instance subnet operation by specifying both parameters at the same time: destination subnet and hardware generation.\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - The operation could not be completed because some of the database files are exceeding maximum General Purpose file size limit of {0} GB.\n\n * 400 CloudLifterUnsupportedFeature - The functionality is not available on the Managed Instance at this time.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 OperationCanNotStartDueToMiLink - The '{0}' operation cannot be completed as there exists a database in a process of creation through Managed Instance link. Please wait for the link creation to complete, or delete the link, and retry the operation again.\n\n * 400 ManagedInstanceSloUpdateFailed - SLO '{0}' operation cannot succeed as the memory usage of '{1}' exceeds the quota.\n\n * 400 SourceAndTargetSubnetsMustBeVnetPeered - Subnet currently used by managed instance and provided destination subnet are part of the virtual networks that are not connected with virtual network peering, or have peering established but don't have allowed traffic. In order to move managed instance from one subnet to another, virtual network peering needs to be established from both source and target virtual network. Please configure virtual network requirements and then try the operation again. Learn more https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks. \n\n * 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - Subnet provided for managed instance deployment is located on subscription different than the one submitted for managed instance. Managed instance and subnet used for deploying the instance must be on the same subscription. Please provide another subnet or switch to the subnet subscription and then try the operation again.\n\n * 400 CreateManagedInstanceInvalidSubnetSize - User attempted to create managed instance in a subnet that is smaller than the allowed minimal subnet size.\n\n * 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - Subnet selected for managed instance migration has address range that overlaps with address range of subnet that holds geo replicated secondary instance. Please verify that your subnet is configured according to guidelines in https://aka.ms/move-managed-instance. \n\n * 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - Subnet selected for managed instance migration is not configured to enable communication with a geo replicated secondary instance. Please check if all of the required ports are open. To properly configure your subnet read the guidelines in https://aka.ms/move-managed-instance. \n\n * 400 ManagedInstanceLocalStorageUpdateSloDisabled - Update SLO for managed instances with local storage is not supported yet.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 GatewayInvalidEdition - '{0}' is not a valid database edition in this version of SQL Server.\n\n * 400 ManagedInstanceInvalidHardwareFamilyForInstancePool - User tried to select invalid hardware family for managed instance inside an existing instance pool.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 ManagedInstanceInvalidLicenseTypeForInstancePool - User tried to select invalid license type for managed instance inside an existing instance pool.\n\n * 400 ManagedInstanceUpdateSloFromVersionlessToVersionedNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 ManagedInstanceUpdateSloFromNewerToOlderVersionEditionNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 ManagedInstanceUpdateSloFromVersionedToVersionlessWorkerCLNotAllowed - Changing the database format is not supported for this managed instance. Check the database format property value specified and visit https://aka.ms/sqlmi-fwnov2022 for more details.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 ManagedInstanceVersionEditionParameterNotAllowedForUsing - Specifying the database format property value is not supported at this time.\n\n * 400 ManagedInstanceFreemiumInvalidArchitecture - A freemium instance can not be created in the specified subnet '(0)'.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ManagedInstanceGeoDRNotAllowedForInstancePool - Creating auto-failover group (GeoDR) is not supported for Managed Instances provisioned inside instance pools. Auto failover groups can be created only for standalone Managed Instances.\n\n * 400 ManagedInstanceWithGeoDRMoveToInstancePoolNotAllowed - Customer has attempted to move a standalone Managed Instance with an existing auto-failover group configured into an instance pool, which is not supported. Only standalone instances without existing auto-failover groups configured can be moved to instance pools.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerRegion - Creation of ZoneRedundant SQL MI is temporarily disabled on this region. You can create Zone Redundant SQL Managed Instances in many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerHardwareGeneration - Creation of ZoneRedundant SQL MI is temporarily disabled for this hardware generation on this region. You can create Zone Redundant SQL Managed Instances with different hardware generation on this region or many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceUpdateSloGeoPrimaryWithNewerVersionEditionThanSecondary - Database format change must be performed on the secondary instance of the failover group first. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 ManagedInstanceFreemiumInstanceAlreadyExists - Only one free SQL Managed Instance is allowed per subscription.\n\n * 400 ManagementServiceGeodrSecondaryDatabaseInCreation - The '{0}' operation cannot be completed as there exists a database in a process of creation through failover group deployment. Please wait for the failover group deployment to complete, or alternatively delete the failover group and retry the operation again.\n\n * 400 ManagedInstanceConversionRegularToFreemiumNotAllowed - User tried converting a Regular SQL Managed Instance to Free SQL Managed Instance.\n\n * 400 ManagedInstanceConversionFreemiumToRegularAndUpdateSLOWhileStoppedNotAllowed - User tried converting a Free SQL Managed Instance to Regular SQL Managed Instance and Update SLO in same request, while Instance is stopped.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 ManagedInstanceMaintenanceWindowChangeNotAllowedWhenInInstancePool - Maintenance window is set at instance pool level and cannot be set individually per pooled instance.\n\n * 400 ManagedInstanceMoveToInstancePoolExceedsDbCountLimit - Cannot move the instance into the pool due to pool database count limit.\n\n * 400 StorageIOpsNotSupported - Storage IOps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidCollation - Invalid collation.\n\n * 400 StorageThroughputMBpsNotSupported - Storage throughput MBps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 StorageIOpsNotSupportedForSpecifiedEdition - Storage IOps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 StorageThroughputMBpsNotSupportedForSpecifiedEdition - Storage throughput MBps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 ManagedInstanceClassicVnetNotSupported - Managed Instance cannot be joined to a classic virtual network.\n\n * 400 AlterDbDeactivatedNotSupported - Database Operation failed for Server '{0}', Database '{1}' due to unexpected delay. Please try again.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetConfigHasNsg - User tried to inject Managed Server subnet with Network Security Groups.\n\n * 400 VnetConfigHasNoUdr - User tried to inject Managed Server subnet without default User Defined Route Table.\n\n * 400 VnetConfigHasInvalidUdr - User tried to inject Managed Server subnet with invalid User Defined Route Table.\n\n * 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.\n\n * 400 VnetConfigHasServiceEndpoints - User tried to inject Managed Server subnet with service endpoints.\n\n * 400 VnetSubnetIsInUse - User tried to inject Managed Server subnet that is not empty.\n\n * 400 VnetSubnetIsLocked - User tried to inject Managed Server subnet that is in locked scope.\n\n * 400 VnetSubnetIsGateway - User tried to inject Managed Server subnet that is Gateway subnet.\n\n * 400 VnetSubnetIsUnknown - User tried to inject Managed Server subnet that does not exist.\n\n * 400 VnetSubnetConflictWithIntendedPolicy - User tried to inject Managed Server subnet that has a conflict with IntendedPolicy.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 ManagedInstanceInvalidEditionForSku - The specified edition {0} is not consistent with the specified SKU {1}.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInCreateOfMI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the create operation.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagedInstanceInvalidLicenseType - The specified license type {0} is not valid.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInUpdateOfGPV1MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V1 Managed Instance.\n\n * 400 UnspecifiedTargetEditionAndFalseGPV2NotAllowedInUpdateOfGPV2MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value FALSE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 GPTargetEditionAndUnspecifiedGPV2NotAllowedInUpdateOFGPV2MI - Combination of General Purpose target edition (sku.name/sku.tier parameters) and unspecified value for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 BCTargetEditionAndSpecifiedGPV2ParamNotAllowedInCreateUpdateOfMI - Combination of Business Critical target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the create/update operation.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 UnspecifiedTargetEditionAndSpecifiedGPV2ParamNotAllowedInUpdateOfBCMI - Combination of unspecified target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the update operation of Business Critical Managed Instance.\n\n * 400 TotalMemoryMBNotSupported - Total memory MB parameter is not allowed in the instance create/update operation.\n\n * 400 TotalMemoryMBNotSupportedForSpecifiedEdition - Total memory MB parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 VnetResourceNotFound - Resource not found: '{0}'.\n\n * 400 InvalidTimezone - Invalid timezone.\n\n * 400 InvalidSubnetForGPV2Edition - General Purpose v2 edition of Managed Instance is not compatible with the specified subnet. Target subnet must be either empty, or all instances in it must run with November 2022 Feature Wave.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 TotalMemoryMBInvalidLimit - Total memory MB parameter has been set to an invalid limit.\n\n * 400 ManagedInstanceUpdateSloGPv2PerDatabaseFileLimitExceeded - The operation could not be completed because there is at least one database whose number of files is exceeding the limit of {0} files per database on General Purpose v2 edition.\n\n * 400 InstanceCollationUpdateNotSupported - User cannot change instance collation on Managed Instance.\n\n * 400 NextGenGPNotSupportedForCmwCustomers - Next-Gen General Purpose edition of Managed Instance does not support Custom Maintenance Window.\n\n * 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - User can create a Managed Instance only with collation 'SQL_Latin1_General_CP1_CI_AS'.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedInstanceExceedMaxAzureStorage - The operation could not be completed because total allocated storage size for General Purpose instance would exceed {0}. Please reduce the number of database files and retry operation.\n\n * 400 ManagedInstanceHasGeoReplica - The operation could not be completed because instance has configured geo replicated secondary instance.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 StorageAccountFull - Managed Instance has reached the total capacity of underlying Azure storage account. Azure Premium Storage account is limited to 35TB of allocated space.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 ManagedInstanceRestoreToInstanceWithOlderVersionEdition - Restore operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 InvalidDistributedAvailabilityGroupsCreateOrUpdateRequest - Distributed Availability Group Create or Update request body is empty or invalid.\n\n * 400 InvalidDistributedAvailabilityGroupsCreateOrUpdateRequestInstanceAvailabilityGroupName - Distributed Availability Group Create or Update request body has empty or Invalid Instance Availability Group Name.\n\n * 400 InvalidDistributedAvailabilityGroupsCreateOrUpdateRequestPartnerAvailabilityGroupName - Distributed Availability Group Create or Update request body has empty or Invalid Partner Availability Group Name.\n\n * 400 InvalidDistributedAvailabilityGroupsCreateOrUpdateRequestPartnerEndpoint - Distributed Availability Group Create or Update request body has empty or Invalid Partner Endpoint.\n\n * 400 InvalidDistributedAvailabilityGroupsCreateOrUpdateRequestDatabases - Distributed Availability Group Create or Update request body has empty or Invalid Databases.\n\n * 400 InstanceAvailabilityGroupNamePartnerAvailabilityGroupNameMatch - Distributed Availability Group Create or Update request body has equal Instance and Partner Availability Group Names.\n\n * 400 InvalidDistributedAvailabilityGroupsCreateOrUpdateRequestSeedingMode - Distributed Availability Group Create or Update request body has empty or Invalid Seeding Mode. Currently, only the 'Automatic' mode is supported.\n\n * 400 ManagedInstanceLinkSourceDbHasHekatonFile - Memory-optimized filegroup must be empty on the SQL Server source database when replicated to Azure SQL Managed Instance General Purpose service tier. Consider emptying the memory optimized filegroup on the source database and try again. Alternatively consider using Managed Instance Business Critical service tier without making any changes.\n\n * 400 ManagedInstanceLinkSourceDbHasMultipleLogFiles - Source database on SQL Server needs to have a single log file instead of multiple log files for data replication to Azure SQL Managed Instance. Consider using a single log file on the source database and try again.\n\n * 400 ManagedInstanceLinkUnsupportedNumberOfFilesOnSourceDb - Maximum number of '{0}' files was reached on Azure SQL Managed Instance preventing data replication. Consider reducing the number of files on the source and try again.\n\n * 400 ManagedInstanceLinkSourceDbHasFilestream - Source database on SQL Server must not use FileStream or FileTables for data replication to Azure SQL Managed Instance. Consider removing FileStream and FileTables on the source database on SQL Server and try again.\n\n * 400 ManagedInstanceLinkSourceDbHasDefunctFiles - Source database '{0}' on SQL Server must not contain files in DEFUNCT state for data replication to Azure SQL Managed Instance to work.\n\n * 400 ManagedInstanceLinkTdeCertificateMissing - Azure SQL Managed Instance link cannot be created with source database on SQL Server, because the database is using Transparent Data Encryption (TDE) and the destination managed instance does not have the encryption key for this database. Ensure that the database encryption key from SQL Server is exported and uploaded to Azure Key vault, then selected for use in managed instance TDE configuration and try again.\n\n * 400 ManagedInstanceLinkConnectivityIsNotEstablished - Operation was aborted as replication to Azure SQL Managed Instance did not start within '{0}' minutes since it was initiated. Please verify the network connectivity and firewall rules are configured according to the guidelines described at https://aka.ms/mi-link-troubleshooting, and retry the operation.\n\n * 400 ManagedInstanceLinkForProvidedAvailabilityGroupsAlreadyExists - It is not possible to add an additional database to an existing Managed Instance link as a single link can contain only one database. Please use a different distributed availability group name and try again.\n\n * 400 ManagedInstanceLinkIsNotFound - The link with Managed Instance was not successfully created or was deleted before data copy operation has completed.\n\n * 400 ManagedInstanceLinkIsNotInTheCatchupState - The link with Managed Instance is not in the catchup state after the data copy link operation completed.\n\n * 400 ManagedInstanceLinkCertificateNotFoundOnManagedInstance - Managed instance link connection can not be established due to certificate missing on the managed instance.\n\n * 400 ManagedInstanceLinkCertificateNotFoundOnSqlServer - Managed instance link connection can not be established due to certificate missing on the on-prem sql server.\n\n * 400 CloudLifterChimeraAvailabilityGroupConnectionCannotBeEstablished - Connection with availability group cannot be established as it is not responding. Possible causes could be nonexistence of availability group or distributed availability group on the partner server, incorrectly specified names or configuration parameters.\n\n * 400 CloudLifterChimeraEstablishDbConnectionNotEstablished - Connection with availability group is established, but there is no response from the target database. Possible causes could be errors with creating a database on the partner server, incorrectly specified names or configuration parameters.\n\n * 400 CloudLifterChimeraMIAgNameIsAlreadyUsed - Managed Instance link cannot be created because Managed Instance side AG name '{0}' is already used on Managed Instance '{1}'. Choose different name and retry to create link.\n\n * 400 CloudLifterChimeraBoxAndMiOnDifferentDbVersionsFailoverModeManual - The link supporting bi-directional failover requires matching database formats on source and target server.\n\n * 400 StorageAccountFull - Managed Instance has reached the total capacity of underlying Azure storage account. Azure Premium Storage account is limited to 35TB of allocated space.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 MissingKeyVaultUriForRestore - Azure Key Vault key URI '{0}' is required to successfully restore the database '{1}' under server '{2}'.\n\n * 400 AzureKeyVaultKeyUsedOnGeoPrimary - The operation could not be completed because the Azure Key Vault Key name {0} is currently set as encryption protector on geo-primary.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 SecurityAzureKeyVaultGeoChainError - Creating secondary of secondary (a process known as chaining) is not supported when enabling Transparent Data Encryption using Azure Key Vault (BYOK).\n\n * 400 PerDatabaseCMKDWNotSupported - Database-level CMK in preview is not supported for Datawarehouse edition.\n\n * 400 BlockSystemAssignedIdentityForCrossTenantCMK - Cross tenant CMK can only be configured when the server is configured with a User Assigned Managed Identity. Refer to https://aka.ms/sqltdebyokumi to configure User Assigned Managed Identity.\n\n * 400 CannotDropDatabaseAKVError - The database {0} on server {1} cannot be safely dropped because it is encrypted with a customer managed key that is no longer accessible to take the last backup before drop. Please restore Azure Key Vault Access on the server and revalidate the keys to make this database accessible and then proceed with the drop. For details see https://aka.ms/tdecmkrestorability\n\n * 400 CreateDatabaseAttemptedWithRotationInProgress - The create database operation can not be performed at this time due to ongoing Transparent Data Encryption (TDE) key rotation on the server. Please try the operation again later.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 PerDatabaseCMKRestoreNotSupported - Database restore is not supported when Database-level CMK is configured in preview.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 PerDatabaseCMKHSNotSupported - Database-level CMK in preview is not supported for Hyperscale edition.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 CMKOperationNotAllowed - User tried to perform an operation on the server when the server did not have Azure Key Vault Access.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 AzureKeyVaultKeyNameCurrentlyInUse - The operation could not be completed because the Azure Key Vault Key name {0} is currently in use.\n\n * 400 AzureKeyVaultKeyThumbprintIsDifferent - The operation could not be completed because the Azure Key Vault Key material is different than the current encryption protector key.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 OldGenerationOfAKVKeyBeingUsedError - Using an old version of AKV key as TDE protector is not allowed. Please use the latest version of the AKV key as the encryption protector\n\n * 400 PerDatabaseCMKMissingIdentityOnGeoSecondaryDatabase - Per Database CMK identity not setup on the target database.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 405 InvalidStorageIOpsLimitValue - Invalid storage IOps limit: {0} IOps. Storage IOps limit must be specified between {1} IOps and {2} IOps, in increments of {3} IOps.\n\n * 405 InvalidStorageThroughputMBpsLimitValue - Invalid storage throughput limit: {0} MBps. Storage throughput limit must be specified between {1} MBps and {2} MBps, in increments of {3} MBps.\n\n * 405 InvalidVcoreValue - vCore value {0} is not valid. Please specify a valid vCore value.\n\n * 405 InvalidHardwareGenerationValue - HardwareGeneration {0} is not valid. Please specify a valid HardwareGeneration value.\n\n * 405 InvalidStorageSizeValue - \"Invalid storage size: {0} GB. Storage size must be specified between {1} and {2} gigabytes, in increments of {3} GB.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 409 ServerOverridePreconditionFailed - Failed to apply server override on category '{0}', because physical db or instance '{1}' in server '{2}' is currently not in 'Ready' or 'Deactivated' state.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ManagedInstanceIsBusy - The server '{0}' is currently busy. Please wait a few minutes before trying again.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 GatewayInternalServerError - The server encountered an unexpected exception.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidDnsZone - The operation has failed because you are attempting to deploy managed instance as a geo-replication secondary to the subnet {0} in which there already exists a managed instance. Deploying managed instance as a geo-replication secondary is supported only in cases when managed instance is the first instance deployed in a subnet. Consider deploying managed instance as a geo-replication secondary to a different subnet in which there are no existing managed instances, or if deploying to a subnet with existing managed instance disable the geo-replication option.\n\n * 400 HkCannotSwitchToInactive - The database cannot proceed with pricing-tier update as it has memory-optimized objects. Please drop such objects and try again.\n\n * 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - Invalid storage size: Storage size limit ({0} GB) is less that current storage used ({1} GB). Please specify higher storage size limit.\n\n * 400 InstanceTimezoneUpdateNotSupported - Instance timezone update not supported.\n\n * 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - Create Managed Instance with non-default timezone not supported.\n\n * 400 ManagedInstanceIpAddressRangeLimit - Cannot perform creation/scaling of the managed instance as there are not enough available IP addresses in the subnet for performing the operation.\n\n * 400 VnetDelegationNotAllowed - User tried to inject Managed Server to subnet which is delegated.\n\n * 400 SubnetHasResourcesOfDifferentType - User tried to create MI in subnet that has resources of different type.\n\n * 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - Update of Managed Instance with maintenance window settings is not allowed.\n\n * 400 OperationNotAllowedInCurrentGeodrConfiguration - The operation is not allowed because the current geo-replication configuration does not allow this combination of {0}. Change the setting on the geo-replication partner before applying the change on this instance.\n\n * 400 VnetPrepareNIPFailed - User tried to prepare subnet that has a conflict with NetworkIntentPolicy.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 ManagedInstanceDeprecatedHardwareFamily - Changing the hardware generation to deprecated {0} generation is not possible.\n\n * 400 ManagedInstanceBackupStorageTypeNotSupported - Backup storage type parameter is not allowed in the instance update operation.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 EmptyPDCInvalidDnsZone - This managed instance cannot be deployed because its DNS-zone does not match the DNS-prefix of its intended virtual cluster for subnet {0}. Although this virtual cluster is empty, its DNS-prefix cannot be changed. Empty virtual clusters will be automatically removed after several hours. Consider waiting for this virtual cluster to expire or manually deleting this virtual cluster and then creating the managed instance.\n\n * 400 InstancePoolNotEnoughCapacity - An instance pool does not have enough capacity\n\n * 400 ManagedInstanceFreemiumNotAvailableForInputParameters - Managed instance creation or update executed with SLO that is not allowed for freemium.\n\n * 400 ManagedInstanceFreemiumNotAvailableOnRegion - Creation of a freemium managed instance on a region that is not allowlisted for freemium.\n\n * 400 ManagementServiceSubnetMaintenanceInProgress - User tried to initiate managed instance create/update while incompatible maintenance is in progress.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ManagedInstanceFreemiumNotAvailableForSubscription - Freemium is not enabled for this subscription type.\n\n * 400 ManagedInstanceInvalidEditionForInstancePool - User tried to select invalid service tier for managed instance inside an existing instance pool.\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 ManagedInstanceInvalidSubnetForInstancePool - User tried to select invalid subnet for managed instance inside an existing instance pool.\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 ManagedInstanceZoneRedudantFeatureNotSupported - ZoneRedundant feature is not supported for the selected service tier. For more details visit aka.ms/sqlmi-service-tier-characteristics.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - Enabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - Disabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SubnetIdCantBeUpdated - Changing managed instance subnet is not supported operation. Please remove this parameter from the request.\n\n * 400 MigrationToAnotherVNetNotSupported - Selected subnet is in another Virtual Network. Moving managed instance to another Virtual Network is not possible. Please provide subnet from Virtual Network {0}.\n\n * 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - Provided subnet is having different DNS zone from the current. Changing instance DNS zone is not supported. Please provide subnet with same DNS zone, create a new subnet or provide empty one.\n\n * 400 MigrationToGen4SubnetNotSupported - It is not possible to update subnet while running on Gen4 hardware as it is being deprecated. Please upgrade your hardware from Gen4 to Gen5 as part of the changing managed instance subnet operation by specifying both parameters at the same time: destination subnet and hardware generation.\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - The operation could not be completed because some of the database files are exceeding maximum General Purpose file size limit of {0} GB.\n\n * 400 CloudLifterUnsupportedFeature - The functionality is not available on the Managed Instance at this time.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 OperationCanNotStartDueToMiLink - The '{0}' operation cannot be completed as there exists a database in a process of creation through Managed Instance link. Please wait for the link creation to complete, or delete the link, and retry the operation again.\n\n * 400 ManagedInstanceSloUpdateFailed - SLO '{0}' operation cannot succeed as the memory usage of '{1}' exceeds the quota.\n\n * 400 SourceAndTargetSubnetsMustBeVnetPeered - Subnet currently used by managed instance and provided destination subnet are part of the virtual networks that are not connected with virtual network peering, or have peering established but don't have allowed traffic. In order to move managed instance from one subnet to another, virtual network peering needs to be established from both source and target virtual network. Please configure virtual network requirements and then try the operation again. Learn more https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks. \n\n * 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - Subnet provided for managed instance deployment is located on subscription different than the one submitted for managed instance. Managed instance and subnet used for deploying the instance must be on the same subscription. Please provide another subnet or switch to the subnet subscription and then try the operation again.\n\n * 400 CreateManagedInstanceInvalidSubnetSize - User attempted to create managed instance in a subnet that is smaller than the allowed minimal subnet size.\n\n * 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - Subnet selected for managed instance migration has address range that overlaps with address range of subnet that holds geo replicated secondary instance. Please verify that your subnet is configured according to guidelines in https://aka.ms/move-managed-instance. \n\n * 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - Subnet selected for managed instance migration is not configured to enable communication with a geo replicated secondary instance. Please check if all of the required ports are open. To properly configure your subnet read the guidelines in https://aka.ms/move-managed-instance. \n\n * 400 ManagedInstanceLocalStorageUpdateSloDisabled - Update SLO for managed instances with local storage is not supported yet.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 GatewayInvalidEdition - '{0}' is not a valid database edition in this version of SQL Server.\n\n * 400 ManagedInstanceInvalidHardwareFamilyForInstancePool - User tried to select invalid hardware family for managed instance inside an existing instance pool.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 ManagedInstanceInvalidLicenseTypeForInstancePool - User tried to select invalid license type for managed instance inside an existing instance pool.\n\n * 400 ManagedInstanceUpdateSloFromVersionlessToVersionedNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 ManagedInstanceUpdateSloFromNewerToOlderVersionEditionNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 ManagedInstanceUpdateSloFromVersionedToVersionlessWorkerCLNotAllowed - Changing the database format is not supported for this managed instance. Check the database format property value specified and visit https://aka.ms/sqlmi-fwnov2022 for more details.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 ManagedInstanceVersionEditionParameterNotAllowedForUsing - Specifying the database format property value is not supported at this time.\n\n * 400 ManagedInstanceFreemiumInvalidArchitecture - A freemium instance can not be created in the specified subnet '(0)'.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ManagedInstanceWithGeoDRMoveToInstancePoolNotAllowed - Customer has attempted to move a standalone Managed Instance with an existing auto-failover group configured into an instance pool, which is not supported. Only standalone instances without existing auto-failover groups configured can be moved to instance pools.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerRegion - Creation of ZoneRedundant SQL MI is temporarily disabled on this region. You can create Zone Redundant SQL Managed Instances in many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerHardwareGeneration - Creation of ZoneRedundant SQL MI is temporarily disabled for this hardware generation on this region. You can create Zone Redundant SQL Managed Instances with different hardware generation on this region or many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceUpdateSloGeoPrimaryWithNewerVersionEditionThanSecondary - Database format change must be performed on the secondary instance of the failover group first. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 ManagedInstanceFreemiumInstanceAlreadyExists - Only one free SQL Managed Instance is allowed per subscription.\n\n * 400 ManagementServiceGeodrSecondaryDatabaseInCreation - The '{0}' operation cannot be completed as there exists a database in a process of creation through failover group deployment. Please wait for the failover group deployment to complete, or alternatively delete the failover group and retry the operation again.\n\n * 400 ManagedInstanceConversionRegularToFreemiumNotAllowed - User tried converting a Regular SQL Managed Instance to Free SQL Managed Instance.\n\n * 400 ManagedInstanceConversionFreemiumToRegularAndUpdateSLOWhileStoppedNotAllowed - User tried converting a Free SQL Managed Instance to Regular SQL Managed Instance and Update SLO in same request, while Instance is stopped.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 ManagedInstanceMaintenanceWindowChangeNotAllowedWhenInInstancePool - Maintenance window is set at instance pool level and cannot be set individually per pooled instance.\n\n * 400 ManagedInstanceMoveToInstancePoolExceedsDbCountLimit - Cannot move the instance into the pool due to pool database count limit.\n\n * 400 ManagedInstancePoolZoneRedundancyNotSupported - Cannot move a zone-redundant instance into the pool as zone-redundancy is not supported in pools.\n\n * 400 DeploymentIntoPrivateSubnetsNotAllowed - Deploying managed instances and instance pools into private subnets is not supported.\n\n * 400 StorageIOpsNotSupported - Storage IOps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidCollation - Invalid collation.\n\n * 400 StorageThroughputMBpsNotSupported - Storage throughput MBps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 StorageIOpsNotSupportedForSpecifiedEdition - Storage IOps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 StorageThroughputMBpsNotSupportedForSpecifiedEdition - Storage throughput MBps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 ManagedInstanceClassicVnetNotSupported - Managed Instance cannot be joined to a classic virtual network.\n\n * 400 AlterDbDeactivatedNotSupported - Database Operation failed for Server '{0}', Database '{1}' due to unexpected delay. Please try again.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetConfigHasNsg - User tried to inject Managed Server subnet with Network Security Groups.\n\n * 400 VnetConfigHasNoUdr - User tried to inject Managed Server subnet without default User Defined Route Table.\n\n * 400 VnetConfigHasInvalidUdr - User tried to inject Managed Server subnet with invalid User Defined Route Table.\n\n * 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.\n\n * 400 VnetConfigHasServiceEndpoints - User tried to inject Managed Server subnet with service endpoints.\n\n * 400 VnetSubnetIsInUse - User tried to inject Managed Server subnet that is not empty.\n\n * 400 VnetSubnetIsLocked - User tried to inject Managed Server subnet that is in locked scope.\n\n * 400 VnetSubnetIsGateway - User tried to inject Managed Server subnet that is Gateway subnet.\n\n * 400 VnetSubnetIsUnknown - User tried to inject Managed Server subnet that does not exist.\n\n * 400 VnetSubnetConflictWithIntendedPolicy - User tried to inject Managed Server subnet that has a conflict with IntendedPolicy.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 ManagedInstanceInvalidEditionForSku - The specified edition {0} is not consistent with the specified SKU {1}.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInCreateOfMI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the create operation.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagedInstanceInvalidLicenseType - The specified license type {0} is not valid.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInUpdateOfGPV1MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V1 Managed Instance.\n\n * 400 UnspecifiedTargetEditionAndFalseGPV2NotAllowedInUpdateOfGPV2MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value FALSE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 GPTargetEditionAndUnspecifiedGPV2NotAllowedInUpdateOFGPV2MI - Combination of General Purpose target edition (sku.name/sku.tier parameters) and unspecified value for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 BCTargetEditionAndSpecifiedGPV2ParamNotAllowedInCreateUpdateOfMI - Combination of Business Critical target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the create/update operation.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 UnspecifiedTargetEditionAndSpecifiedGPV2ParamNotAllowedInUpdateOfBCMI - Combination of unspecified target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the update operation of Business Critical Managed Instance.\n\n * 400 TotalMemoryMBNotSupported - Total memory MB parameter is not allowed in the instance create/update operation.\n\n * 400 TotalMemoryMBNotSupportedForSpecifiedEdition - Total memory MB parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 VnetResourceNotFound - Resource not found: '{0}'.\n\n * 400 InvalidTimezone - Invalid timezone.\n\n * 400 InvalidSubnetForGPV2Edition - General Purpose v2 edition of Managed Instance is not compatible with the specified subnet. Target subnet must be either empty, or all instances in it must run with November 2022 Feature Wave.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 TotalMemoryMBInvalidLimit - Total memory MB parameter has been set to an invalid limit.\n\n * 400 ManagedInstanceUpdateSloGPv2PerDatabaseFileLimitExceeded - The operation could not be completed because there is at least one database whose number of files is exceeding the limit of {0} files per database on General Purpose v2 edition.\n\n * 400 InstanceCollationUpdateNotSupported - User cannot change instance collation on Managed Instance.\n\n * 400 NextGenGPNotSupportedForCmwCustomers - Next-Gen General Purpose edition of Managed Instance does not support Custom Maintance Window.\n\n * 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - User can create a Managed Instance only with collation 'SQL_Latin1_General_CP1_CI_AS'.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedInstanceExceedMaxAzureStorage - The operation could not be completed because total allocated storage size for General Purpose instance would exceed {0}. Please reduce the number of database files and retry operation.\n\n * 400 ManagedInstanceHasGeoReplica - The operation could not be completed because instance has configured geo replicated secondary instance.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 StorageAccountFull - Managed Instance has reached the total capacity of underlying Azure storage account. Azure Premium Storage account is limited to 35TB of allocated space.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 ManagedInstanceRestoreToInstanceWithOlderVersionEdition - Restore operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 InvalidDistributedAvailabilityGroupsCreateOrUpdateRequest - Distributed Availability Group Create or Update request body is empty or invalid.\n\n * 400 InvalidDistributedAvailabilityGroupsCreateOrUpdateRequestInstanceAvailabilityGroupName - Distributed Availability Group Create or Update request body has empty or Invalid Instance Availability Group Name.\n\n * 400 InvalidDistributedAvailabilityGroupsCreateOrUpdateRequestPartnerAvailabilityGroupName - Distributed Availability Group Create or Update request body has empty or Invalid Partner Availability Group Name.\n\n * 400 InvalidDistributedAvailabilityGroupsCreateOrUpdateRequestPartnerEndpoint - Distributed Availability Group Create or Update request body has empty or Invalid Partner Endpoint.\n\n * 400 InvalidDistributedAvailabilityGroupsCreateOrUpdateRequestDatabases - Distributed Availability Group Create or Update request body has empty or Invalid Databases.\n\n * 400 InstanceAvailabilityGroupNamePartnerAvailabilityGroupNameMatch - Distributed Availability Group Create or Update request body has equal Instance and Partner Availability Group Names.\n\n * 400 InvalidDistributedAvailabilityGroupsCreateOrUpdateRequestSeedingMode - Distributed Availability Group Create or Update request body has empty or Invalid Seeding Mode. Currently, only the 'Automatic' mode is supported.\n\n * 400 ManagedInstanceLinkSourceDbHasHekatonFile - Memory-optimized filegroup must be empty on the SQL Server source database when replicated to Azure SQL Managed Instance General Purpose service tier. Consider emptying the memory optimized filegroup on the source database and try again. Alternatively consider using Managed Instance Business Critical service tier without making any changes.\n\n * 400 ManagedInstanceLinkSourceDbHasMultipleLogFiles - Source database on SQL Server needs to have a single log file instead of multiple log files for data replication to Azure SQL Managed Instance. Consider using a single log file on the source database and try again.\n\n * 400 ManagedInstanceLinkUnsupportedNumberOfFilesOnSourceDb - Maximum number of '{0}' files was reached on Azure SQL Managed Instance preventing data replication. Consider reducing the number of files on the source and try again.\n\n * 400 ManagedInstanceLinkSourceDbHasFilestream - Source database on SQL Server must not use FileStream or FileTables for data replication to Azure SQL Managed Instance. Consider removing FileStream and FileTables on the source database on SQL Server and try again.\n\n * 400 ManagedInstanceLinkSourceDbHasDefunctFiles - Source database '{0}' on SQL Server must not contain files in DEFUNCT state for data replication to Azure SQL Managed Instance to work.\n\n * 400 ManagedInstanceLinkTdeCertificateMissing - Azure SQL Managed Instance link cannot be created with source database on SQL Server, because the database is using Transparent Data Encryption (TDE) and the destination managed instance does not have the encryption key for this database. Ensure that the database encryption key from SQL Server is exported and uploaded to Azure Key vault, then selected for use in managed instance TDE configuration and try again.\n\n * 400 ManagedInstanceLinkConnectivityIsNotEstablished - Operation was aborted as replication to Azure SQL Managed Instance did not start within '{0}' minutes since it was initiated. Please verify the network connectivity and firewall rules are configured according to the guidelines described at https://aka.ms/mi-link-troubleshooting, and retry the operation.\n\n * 400 ManagedInstanceLinkForProvidedAvailabilityGroupsAlreadyExists - It is not possible to add an additional database to an existing Managed Instance link as a single link can contain only one database. Please use a different distributed availability group name and try again.\n\n * 400 ManagedInstanceLinkIsNotFound - The link with Managed Instance was not successfully created or was deleted before data copy operation has completed.\n\n * 400 ManagedInstanceLinkIsNotInTheCatchupState - The link with Managed Instance is not in the catchup state after the data copy link operation completed.\n\n * 400 ManagedInstanceLinkCertificateNotFoundOnManagedInstance - Managed instance link connection can not be established due to certificate missing on the managed instance.\n\n * 400 ManagedInstanceLinkCertificateNotFoundOnSqlServer - Managed instance link connection can not be established due to certificate missing on the on-prem sql server.\n\n * 400 CloudLifterChimeraAvailabilityGroupConnectionCannotBeEstablished - Connection with availability group cannot be established as it is not responding. Possible causes could be nonexistence of availability group or distributed availability group on the partner server, incorrectly specified names or configuration parameters.\n\n * 400 CloudLifterChimeraEstablishDbConnectionNotEstablished - Connection with availability group is established, but there is no response from the target database. Possible causes could be errors with creating a database on the partner server, incorrectly specified names or configuration parameters.\n\n * 400 CloudLifterChimeraMIAgNameIsAlreadyUsed - Managed Instance link cannot be created because Managed Instance side AG name '{0}' is already used on Managed Instance '{1}'. Choose different name and retry to create link.\n\n * 400 CloudLifterChimeraBoxAndMiOnDifferentDbVersionsFailoverModeManual - The link supporting bi-directional failover requires matching database formats on source and target server.\n\n * 400 StorageAccountFull - Managed Instance has reached the total capacity of underlying Azure storage account. Azure Premium Storage account is limited to 35TB of allocated space.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 MissingKeyVaultUriForRestore - Azure Key Vault key URI '{0}' is required to successfully restore the database '{1}' under server '{2}'.\n\n * 400 AzureKeyVaultKeyUsedOnGeoPrimary - The operation could not be completed because the Azure Key Vault Key name {0} is currently set as encryption protector on geo-primary.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 SecurityAzureKeyVaultGeoChainError - Creating secondary of secondary (a process known as chaining) is not supported when enabling Transparent Data Encryption using Azure Key Vault (BYOK).\n\n * 400 PerDatabaseCMKDWNotSupported - Database-level CMK in preview is not supported for Datawarehouse edition.\n\n * 400 BlockSystemAssignedIdentityForCrossTenantCMK - Cross tenant CMK can only be configured when the server is configured with a User Assigned Managed Identity. Refer to https://aka.ms/sqltdebyokumi to configure User Assigned Managed Identity.\n\n * 400 CannotDropDatabaseAKVError - The database {0} on server {1} cannot be safely dropped because it is encrypted with a customer managed key that is no longer accessible to take the last backup before drop. Please restore Azure Key Vault Access on the server and revalidate the keys to make this database accessible and then proceed with the drop. For details see https://aka.ms/tdecmkrestorability\n\n * 400 CreateDatabaseAttemptedWithRotationInProgress - The create database operation can not be performed at this time due to ongoing Transparent Data Encryption (TDE) key rotation on the server. Please try the operation again later.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 PerDatabaseCMKRestoreNotSupported - Database restore is not supported when Database-level CMK is configured in preview.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 PerDatabaseCMKHSNotSupported - Database-level CMK in preview is not supported for Hyperscale edition.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 CMKOperationNotAllowed - User tried to perform an operation on the server when the server did not have Azure Key Vault Access.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 AzureKeyVaultKeyNameCurrentlyInUse - The operation could not be completed because the Azure Key Vault Key name {0} is currently in use.\n\n * 400 AzureKeyVaultKeyThumbprintIsDifferent - The operation could not be completed because the Azure Key Vault Key material is different than the current encryption protector key.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 OldGenerationOfAKVKeyBeingUsedError - Using an old version of AKV key as TDE protector is not allowed. Please use the latest version of the AKV key as the encryption protector\n\n * 400 PerDatabaseCMKMissingIdentityOnGeoSecondaryDatabase - Per Database CMK identity not setup on the target database.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 405 InvalidStorageIOpsLimitValue - Invalid storage IOps limit: {0} IOps. Storage IOps limit must be specified between {1} IOps and {2} IOps, in increments of {3} IOps.\n\n * 405 InvalidStorageThroughputMBpsLimitValue - Invalid storage throughput limit: {0} MBps. Storage throughput limit must be specified between {1} MBps and {2} MBps, in increments of {3} MBps.\n\n * 405 InvalidVcoreValue - vCore value {0} is not valid. Please specify a valid vCore value.\n\n * 405 InvalidHardwareGenerationValue - HardwareGeneration {0} is not valid. Please specify a valid HardwareGeneration value.\n\n * 405 InvalidStorageSizeValue - \"Invalid storage size: {0} GB. Storage size must be specified between {1} and {2} gigabytes, in increments of {3} GB.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 409 ServerOverridePreconditionFailed - Failed to apply server override on category '{0}', because physical db or instance '{1}' in server '{2}' is currently not in 'Ready' or 'Deactivated' state.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ManagedInstanceIsBusy - The server '{0}' is currently busy. Please wait a few minutes before trying again.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 GatewayInternalServerError - The server encountered an unexpected exception.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Accepted request for creating the distributed availability group." + "description": "Accepted request for creating the distributed availability group.", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully created the distributed availability group.", @@ -210,13 +215,18 @@ "description": "Successfully deleted distributed availability group." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidDnsZone - The operation has failed because you are attempting to deploy managed instance as a geo-replication secondary to the subnet {0} in which there already exists a managed instance. Deploying managed instance as a geo-replication secondary is supported only in cases when managed instance is the first instance deployed in a subnet. Consider deploying managed instance as a geo-replication secondary to a different subnet in which there are no existing managed instances, or if deploying to a subnet with existing managed instance disable the geo-replication option.\n\n * 400 HkCannotSwitchToInactive - The database cannot proceed with pricing-tier update as it has memory-optimized objects. Please drop such objects and try again.\n\n * 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - Invalid storage size: Storage size limit ({0} GB) is less that current storage used ({1} GB). Please specify higher storage size limit.\n\n * 400 InstanceTimezoneUpdateNotSupported - Instance timezone update not supported.\n\n * 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - Create Managed Instance with non-default timezone not supported.\n\n * 400 ManagedInstanceIpAddressRangeLimit - Cannot perform creation/scaling of the managed instance as there are not enough available IP addresses in the subnet for performing the operation.\n\n * 400 VnetDelegationNotAllowed - User tried to inject Managed Server to subnet which is delegated.\n\n * 400 SubnetHasResourcesOfDifferentType - User tried to create MI in subnet that has resources of different type.\n\n * 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - Update of Managed Instance with maintenance window settings is not allowed.\n\n * 400 OperationNotAllowedInCurrentGeodrConfiguration - The operation is not allowed because the current geo-replication configuration does not allow this combination of {0}. Change the setting on the geo-replication partner before applying the change on this instance.\n\n * 400 VnetPrepareNIPFailed - User tried to prepare subnet that has a conflict with NetworkIntentPolicy.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 ManagedInstanceDeprecatedHardwareFamily - Changing the hardware generation to deprecated {0} generation is not possible.\n\n * 400 ManagedInstanceBackupStorageTypeNotSupported - Backup storage type parameter is not allowed in the instance update operation.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 EmptyPDCInvalidDnsZone - This managed instance cannot be deployed because its DNS-zone does not match the DNS-prefix of its intended virtual cluster for subnet {0}. Although this virtual cluster is empty, its DNS-prefix cannot be changed. Empty virtual clusters will be automatically removed after several hours. Consider waiting for this virtual cluster to expire or manually deleting this virtual cluster and then creating the managed instance.\n\n * 400 InstancePoolNotEnoughCapacity - An instance pool does not have enough capacity\n\n * 400 ManagedInstanceFreemiumNotAvailableForInputParameters - Managed instance creation or update executed with SLO that is not allowed for freemium.\n\n * 400 ManagedInstanceFreemiumNotAvailableOnRegion - Creation of a freemium managed instance on a region that is not allowlisted for freemium.\n\n * 400 ManagementServiceSubnetMaintenanceInProgress - User tried to initiate managed instance create/update while incompatible maintenance is in progress.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ManagedInstanceFreemiumNotAvailableForSubscription - Freemium is not enabled for this subscription type.\n\n * 400 ManagedInstanceInvalidEditionForInstancePool - User tried to select invalid service tier for managed instance inside an existing instance pool.\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 ManagedInstanceInvalidSubnetForInstancePool - User tried to select invalid subnet for managed instance inside an existing instance pool.\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 ManagedInstanceZoneRedudantFeatureNotSupported - ZoneRedundant feature is not supported for the selected service tier. For more details visit aka.ms/sqlmi-service-tier-characteristics.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - Enabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - Disabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SubnetIdCantBeUpdated - Changing managed instance subnet is not supported operation. Please remove this parameter from the request.\n\n * 400 MigrationToAnotherVNetNotSupported - Selected subnet is in another Virtual Network. Moving managed instance to another Virtual Network is not possible. Please provide subnet from Virtual Network {0}.\n\n * 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - Provided subnet is having different DNS zone from the current. Changing instance DNS zone is not supported. Please provide subnet with same DNS zone, create a new subnet or provide empty one.\n\n * 400 MigrationToGen4SubnetNotSupported - It is not possible to update subnet while running on Gen4 hardware as it is being deprecated. Please upgrade your hardware from Gen4 to Gen5 as part of the changing managed instance subnet operation by specifying both parameters at the same time: destination subnet and hardware generation.\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - The operation could not be completed because some of the database files are exceeding maximum General Purpose file size limit of {0} GB.\n\n * 400 CloudLifterUnsupportedFeature - The functionality is not available on the Managed Instance at this time.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 OperationCanNotStartDueToMiLink - The '{0}' operation cannot be completed as there exists a database in a process of creation through Managed Instance link. Please wait for the link creation to complete, or delete the link, and retry the operation again.\n\n * 400 ManagedInstanceSloUpdateFailed - SLO '{0}' operation cannot succeed as the memory usage of '{1}' exceeds the quota.\n\n * 400 SourceAndTargetSubnetsMustBeVnetPeered - Subnet currently used by managed instance and provided destination subnet are part of the virtual networks that are not connected with virtual network peering, or have peering established but don't have allowed traffic. In order to move managed instance from one subnet to another, virtual network peering needs to be established from both source and target virtual network. Please configure virtual network requirements and then try the operation again. Learn more https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks. \n\n * 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - Subnet provided for managed instance deployment is located on subscription different than the one submitted for managed instance. Managed instance and subnet used for deploying the instance must be on the same subscription. Please provide another subnet or switch to the subnet subscription and then try the operation again.\n\n * 400 CreateManagedInstanceInvalidSubnetSize - User attempted to create managed instance in a subnet that is smaller than the allowed minimal subnet size.\n\n * 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - Subnet selected for managed instance migration has address range that overlaps with address range of subnet that holds geo replicated secondary instance. Please verify that your subnet is configured according to guidelines in https://aka.ms/move-managed-instance. \n\n * 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - Subnet selected for managed instance migration is not configured to enable communication with a geo replicated secondary instance. Please check if all of the required ports are open. To properly configure your subnet read the guidelines in https://aka.ms/move-managed-instance. \n\n * 400 ManagedInstanceLocalStorageUpdateSloDisabled - Update SLO for managed instances with local storage is not supported yet.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 GatewayInvalidEdition - '{0}' is not a valid database edition in this version of SQL Server.\n\n * 400 ManagedInstanceInvalidHardwareFamilyForInstancePool - User tried to select invalid hardware family for managed instance inside an existing instance pool.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 ManagedInstanceInvalidLicenseTypeForInstancePool - User tried to select invalid license type for managed instance inside an existing instance pool.\n\n * 400 ManagedInstanceUpdateSloFromVersionlessToVersionedNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 ManagedInstanceUpdateSloFromNewerToOlderVersionEditionNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 ManagedInstanceUpdateSloFromVersionedToVersionlessWorkerCLNotAllowed - Changing the database format is not supported for this managed instance. Check the database format property value specified and visit https://aka.ms/sqlmi-fwnov2022 for more details.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 ManagedInstanceVersionEditionParameterNotAllowedForUsing - Specifying the database format property value is not supported at this time.\n\n * 400 ManagedInstanceFreemiumInvalidArchitecture - A freemium instance can not be created in the specified subnet '(0)'.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ManagedInstanceGeoDRNotAllowedForInstancePool - Creating auto-failover group (GeoDR) is not supported for Managed Instances provisioned inside instance pools. Auto failover groups can be created only for standalone Managed Instances.\n\n * 400 ManagedInstanceWithGeoDRMoveToInstancePoolNotAllowed - Customer has attempted to move a standalone Managed Instance with an existing auto-failover group configured into an instance pool, which is not supported. Only standalone instances without existing auto-failover groups configured can be moved to instance pools.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerRegion - Creation of ZoneRedundant SQL MI is temporarily disabled on this region. You can create Zone Redundant SQL Managed Instances in many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerHardwareGeneration - Creation of ZoneRedundant SQL MI is temporarily disabled for this hardware generation on this region. You can create Zone Redundant SQL Managed Instances with different hardware generation on this region or many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceUpdateSloGeoPrimaryWithNewerVersionEditionThanSecondary - Database format change must be performed on the secondary instance of the failover group first. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 ManagedInstanceFreemiumInstanceAlreadyExists - Only one free SQL Managed Instance is allowed per subscription.\n\n * 400 ManagementServiceGeodrSecondaryDatabaseInCreation - The '{0}' operation cannot be completed as there exists a database in a process of creation through failover group deployment. Please wait for the failover group deployment to complete, or alternatively delete the failover group and retry the operation again.\n\n * 400 ManagedInstanceConversionRegularToFreemiumNotAllowed - User tried converting a Regular SQL Managed Instance to Free SQL Managed Instance.\n\n * 400 ManagedInstanceConversionFreemiumToRegularAndUpdateSLOWhileStoppedNotAllowed - User tried converting a Free SQL Managed Instance to Regular SQL Managed Instance and Update SLO in same request, while Instance is stopped.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 ManagedInstanceMaintenanceWindowChangeNotAllowedWhenInInstancePool - Maintenance window is set at instance pool level and cannot be set individually per pooled instance.\n\n * 400 ManagedInstanceMoveToInstancePoolExceedsDbCountLimit - Cannot move the instance into the pool due to pool database count limit.\n\n * 400 StorageIOpsNotSupported - Storage IOps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidCollation - Invalid collation.\n\n * 400 StorageThroughputMBpsNotSupported - Storage throughput MBps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 StorageIOpsNotSupportedForSpecifiedEdition - Storage IOps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 StorageThroughputMBpsNotSupportedForSpecifiedEdition - Storage throughput MBps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 ManagedInstanceClassicVnetNotSupported - Managed Instance cannot be joined to a classic virtual network.\n\n * 400 AlterDbDeactivatedNotSupported - Database Operation failed for Server '{0}', Database '{1}' due to unexpected delay. Please try again.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetConfigHasNsg - User tried to inject Managed Server subnet with Network Security Groups.\n\n * 400 VnetConfigHasNoUdr - User tried to inject Managed Server subnet without default User Defined Route Table.\n\n * 400 VnetConfigHasInvalidUdr - User tried to inject Managed Server subnet with invalid User Defined Route Table.\n\n * 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.\n\n * 400 VnetConfigHasServiceEndpoints - User tried to inject Managed Server subnet with service endpoints.\n\n * 400 VnetSubnetIsInUse - User tried to inject Managed Server subnet that is not empty.\n\n * 400 VnetSubnetIsLocked - User tried to inject Managed Server subnet that is in locked scope.\n\n * 400 VnetSubnetIsGateway - User tried to inject Managed Server subnet that is Gateway subnet.\n\n * 400 VnetSubnetIsUnknown - User tried to inject Managed Server subnet that does not exist.\n\n * 400 VnetSubnetConflictWithIntendedPolicy - User tried to inject Managed Server subnet that has a conflict with IntendedPolicy.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 ManagedInstanceInvalidEditionForSku - The specified edition {0} is not consistent with the specified SKU {1}.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInCreateOfMI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the create operation.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagedInstanceInvalidLicenseType - The specified license type {0} is not valid.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInUpdateOfGPV1MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V1 Managed Instance.\n\n * 400 UnspecifiedTargetEditionAndFalseGPV2NotAllowedInUpdateOfGPV2MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value FALSE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 GPTargetEditionAndUnspecifiedGPV2NotAllowedInUpdateOFGPV2MI - Combination of General Purpose target edition (sku.name/sku.tier parameters) and unspecified value for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 BCTargetEditionAndSpecifiedGPV2ParamNotAllowedInCreateUpdateOfMI - Combination of Business Critical target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the create/update operation.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 UnspecifiedTargetEditionAndSpecifiedGPV2ParamNotAllowedInUpdateOfBCMI - Combination of unspecified target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the update operation of Business Critical Managed Instance.\n\n * 400 TotalMemoryMBNotSupported - Total memory MB parameter is not allowed in the instance create/update operation.\n\n * 400 TotalMemoryMBNotSupportedForSpecifiedEdition - Total memory MB parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 VnetResourceNotFound - Resource not found: '{0}'.\n\n * 400 InvalidTimezone - Invalid timezone.\n\n * 400 InvalidSubnetForGPV2Edition - General Purpose v2 edition of Managed Instance is not compatible with the specified subnet. Target subnet must be either empty, or all instances in it must run with November 2022 Feature Wave.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 TotalMemoryMBInvalidLimit - Total memory MB parameter has been set to an invalid limit.\n\n * 400 ManagedInstanceUpdateSloGPv2PerDatabaseFileLimitExceeded - The operation could not be completed because there is at least one database whose number of files is exceeding the limit of {0} files per database on General Purpose v2 edition.\n\n * 400 InstanceCollationUpdateNotSupported - User cannot change instance collation on Managed Instance.\n\n * 400 NextGenGPNotSupportedForCmwCustomers - Next-Gen General Purpose edition of Managed Instance does not support Custom Maintenance Window.\n\n * 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - User can create a Managed Instance only with collation 'SQL_Latin1_General_CP1_CI_AS'.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedInstanceExceedMaxAzureStorage - The operation could not be completed because total allocated storage size for General Purpose instance would exceed {0}. Please reduce the number of database files and retry operation.\n\n * 400 ManagedInstanceHasGeoReplica - The operation could not be completed because instance has configured geo replicated secondary instance.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 StorageAccountFull - Managed Instance has reached the total capacity of underlying Azure storage account. Azure Premium Storage account is limited to 35TB of allocated space.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 ManagedInstanceRestoreToInstanceWithOlderVersionEdition - Restore operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 405 InvalidStorageIOpsLimitValue - Invalid storage IOps limit: {0} IOps. Storage IOps limit must be specified between {1} IOps and {2} IOps, in increments of {3} IOps.\n\n * 405 InvalidStorageThroughputMBpsLimitValue - Invalid storage throughput limit: {0} MBps. Storage throughput limit must be specified between {1} MBps and {2} MBps, in increments of {3} MBps.\n\n * 405 InvalidVcoreValue - vCore value {0} is not valid. Please specify a valid vCore value.\n\n * 405 InvalidHardwareGenerationValue - HardwareGeneration {0} is not valid. Please specify a valid HardwareGeneration value.\n\n * 405 InvalidStorageSizeValue - \"Invalid storage size: {0} GB. Storage size must be specified between {1} and {2} gigabytes, in increments of {3} GB.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 409 ServerOverridePreconditionFailed - Failed to apply server override on category '{0}', because physical db or instance '{1}' in server '{2}' is currently not in 'Ready' or 'Deactivated' state.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ManagedInstanceIsBusy - The server '{0}' is currently busy. Please wait a few minutes before trying again.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 GatewayInternalServerError - The server encountered an unexpected exception.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidDnsZone - The operation has failed because you are attempting to deploy managed instance as a geo-replication secondary to the subnet {0} in which there already exists a managed instance. Deploying managed instance as a geo-replication secondary is supported only in cases when managed instance is the first instance deployed in a subnet. Consider deploying managed instance as a geo-replication secondary to a different subnet in which there are no existing managed instances, or if deploying to a subnet with existing managed instance disable the geo-replication option.\n\n * 400 HkCannotSwitchToInactive - The database cannot proceed with pricing-tier update as it has memory-optimized objects. Please drop such objects and try again.\n\n * 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - Invalid storage size: Storage size limit ({0} GB) is less that current storage used ({1} GB). Please specify higher storage size limit.\n\n * 400 InstanceTimezoneUpdateNotSupported - Instance timezone update not supported.\n\n * 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - Create Managed Instance with non-default timezone not supported.\n\n * 400 ManagedInstanceIpAddressRangeLimit - Cannot perform creation/scaling of the managed instance as there are not enough available IP addresses in the subnet for performing the operation.\n\n * 400 VnetDelegationNotAllowed - User tried to inject Managed Server to subnet which is delegated.\n\n * 400 SubnetHasResourcesOfDifferentType - User tried to create MI in subnet that has resources of different type.\n\n * 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - Update of Managed Instance with maintenance window settings is not allowed.\n\n * 400 OperationNotAllowedInCurrentGeodrConfiguration - The operation is not allowed because the current geo-replication configuration does not allow this combination of {0}. Change the setting on the geo-replication partner before applying the change on this instance.\n\n * 400 VnetPrepareNIPFailed - User tried to prepare subnet that has a conflict with NetworkIntentPolicy.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 ManagedInstanceDeprecatedHardwareFamily - Changing the hardware generation to deprecated {0} generation is not possible.\n\n * 400 ManagedInstanceBackupStorageTypeNotSupported - Backup storage type parameter is not allowed in the instance update operation.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 EmptyPDCInvalidDnsZone - This managed instance cannot be deployed because its DNS-zone does not match the DNS-prefix of its intended virtual cluster for subnet {0}. Although this virtual cluster is empty, its DNS-prefix cannot be changed. Empty virtual clusters will be automatically removed after several hours. Consider waiting for this virtual cluster to expire or manually deleting this virtual cluster and then creating the managed instance.\n\n * 400 InstancePoolNotEnoughCapacity - An instance pool does not have enough capacity\n\n * 400 ManagedInstanceFreemiumNotAvailableForInputParameters - Managed instance creation or update executed with SLO that is not allowed for freemium.\n\n * 400 ManagedInstanceFreemiumNotAvailableOnRegion - Creation of a freemium managed instance on a region that is not allowlisted for freemium.\n\n * 400 ManagementServiceSubnetMaintenanceInProgress - User tried to initiate managed instance create/update while incompatible maintenance is in progress.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ManagedInstanceFreemiumNotAvailableForSubscription - Freemium is not enabled for this subscription type.\n\n * 400 ManagedInstanceInvalidEditionForInstancePool - User tried to select invalid service tier for managed instance inside an existing instance pool.\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 ManagedInstanceInvalidSubnetForInstancePool - User tried to select invalid subnet for managed instance inside an existing instance pool.\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 ManagedInstanceZoneRedudantFeatureNotSupported - ZoneRedundant feature is not supported for the selected service tier. For more details visit aka.ms/sqlmi-service-tier-characteristics.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - Enabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - Disabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SubnetIdCantBeUpdated - Changing managed instance subnet is not supported operation. Please remove this parameter from the request.\n\n * 400 MigrationToAnotherVNetNotSupported - Selected subnet is in another Virtual Network. Moving managed instance to another Virtual Network is not possible. Please provide subnet from Virtual Network {0}.\n\n * 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - Provided subnet is having different DNS zone from the current. Changing instance DNS zone is not supported. Please provide subnet with same DNS zone, create a new subnet or provide empty one.\n\n * 400 MigrationToGen4SubnetNotSupported - It is not possible to update subnet while running on Gen4 hardware as it is being deprecated. Please upgrade your hardware from Gen4 to Gen5 as part of the changing managed instance subnet operation by specifying both parameters at the same time: destination subnet and hardware generation.\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - The operation could not be completed because some of the database files are exceeding maximum General Purpose file size limit of {0} GB.\n\n * 400 CloudLifterUnsupportedFeature - The functionality is not available on the Managed Instance at this time.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 OperationCanNotStartDueToMiLink - The '{0}' operation cannot be completed as there exists a database in a process of creation through Managed Instance link. Please wait for the link creation to complete, or delete the link, and retry the operation again.\n\n * 400 ManagedInstanceSloUpdateFailed - SLO '{0}' operation cannot succeed as the memory usage of '{1}' exceeds the quota.\n\n * 400 SourceAndTargetSubnetsMustBeVnetPeered - Subnet currently used by managed instance and provided destination subnet are part of the virtual networks that are not connected with virtual network peering, or have peering established but don't have allowed traffic. In order to move managed instance from one subnet to another, virtual network peering needs to be established from both source and target virtual network. Please configure virtual network requirements and then try the operation again. Learn more https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks. \n\n * 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - Subnet provided for managed instance deployment is located on subscription different than the one submitted for managed instance. Managed instance and subnet used for deploying the instance must be on the same subscription. Please provide another subnet or switch to the subnet subscription and then try the operation again.\n\n * 400 CreateManagedInstanceInvalidSubnetSize - User attempted to create managed instance in a subnet that is smaller than the allowed minimal subnet size.\n\n * 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - Subnet selected for managed instance migration has address range that overlaps with address range of subnet that holds geo replicated secondary instance. Please verify that your subnet is configured according to guidelines in https://aka.ms/move-managed-instance. \n\n * 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - Subnet selected for managed instance migration is not configured to enable communication with a geo replicated secondary instance. Please check if all of the required ports are open. To properly configure your subnet read the guidelines in https://aka.ms/move-managed-instance. \n\n * 400 ManagedInstanceLocalStorageUpdateSloDisabled - Update SLO for managed instances with local storage is not supported yet.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 GatewayInvalidEdition - '{0}' is not a valid database edition in this version of SQL Server.\n\n * 400 ManagedInstanceInvalidHardwareFamilyForInstancePool - User tried to select invalid hardware family for managed instance inside an existing instance pool.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 ManagedInstanceInvalidLicenseTypeForInstancePool - User tried to select invalid license type for managed instance inside an existing instance pool.\n\n * 400 ManagedInstanceUpdateSloFromVersionlessToVersionedNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 ManagedInstanceUpdateSloFromNewerToOlderVersionEditionNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 ManagedInstanceUpdateSloFromVersionedToVersionlessWorkerCLNotAllowed - Changing the database format is not supported for this managed instance. Check the database format property value specified and visit https://aka.ms/sqlmi-fwnov2022 for more details.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 ManagedInstanceVersionEditionParameterNotAllowedForUsing - Specifying the database format property value is not supported at this time.\n\n * 400 ManagedInstanceFreemiumInvalidArchitecture - A freemium instance can not be created in the specified subnet '(0)'.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ManagedInstanceWithGeoDRMoveToInstancePoolNotAllowed - Customer has attempted to move a standalone Managed Instance with an existing auto-failover group configured into an instance pool, which is not supported. Only standalone instances without existing auto-failover groups configured can be moved to instance pools.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerRegion - Creation of ZoneRedundant SQL MI is temporarily disabled on this region. You can create Zone Redundant SQL Managed Instances in many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerHardwareGeneration - Creation of ZoneRedundant SQL MI is temporarily disabled for this hardware generation on this region. You can create Zone Redundant SQL Managed Instances with different hardware generation on this region or many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceUpdateSloGeoPrimaryWithNewerVersionEditionThanSecondary - Database format change must be performed on the secondary instance of the failover group first. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 ManagedInstanceFreemiumInstanceAlreadyExists - Only one free SQL Managed Instance is allowed per subscription.\n\n * 400 ManagementServiceGeodrSecondaryDatabaseInCreation - The '{0}' operation cannot be completed as there exists a database in a process of creation through failover group deployment. Please wait for the failover group deployment to complete, or alternatively delete the failover group and retry the operation again.\n\n * 400 ManagedInstanceConversionRegularToFreemiumNotAllowed - User tried converting a Regular SQL Managed Instance to Free SQL Managed Instance.\n\n * 400 ManagedInstanceConversionFreemiumToRegularAndUpdateSLOWhileStoppedNotAllowed - User tried converting a Free SQL Managed Instance to Regular SQL Managed Instance and Update SLO in same request, while Instance is stopped.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 ManagedInstanceMaintenanceWindowChangeNotAllowedWhenInInstancePool - Maintenance window is set at instance pool level and cannot be set individually per pooled instance.\n\n * 400 ManagedInstanceMoveToInstancePoolExceedsDbCountLimit - Cannot move the instance into the pool due to pool database count limit.\n\n * 400 ManagedInstancePoolZoneRedundancyNotSupported - Cannot move a zone-redundant instance into the pool as zone-redundancy is not supported in pools.\n\n * 400 DeploymentIntoPrivateSubnetsNotAllowed - Deploying managed instances and instance pools into private subnets is not supported.\n\n * 400 StorageIOpsNotSupported - Storage IOps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidCollation - Invalid collation.\n\n * 400 StorageThroughputMBpsNotSupported - Storage throughput MBps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 StorageIOpsNotSupportedForSpecifiedEdition - Storage IOps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 StorageThroughputMBpsNotSupportedForSpecifiedEdition - Storage throughput MBps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 ManagedInstanceClassicVnetNotSupported - Managed Instance cannot be joined to a classic virtual network.\n\n * 400 AlterDbDeactivatedNotSupported - Database Operation failed for Server '{0}', Database '{1}' due to unexpected delay. Please try again.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetConfigHasNsg - User tried to inject Managed Server subnet with Network Security Groups.\n\n * 400 VnetConfigHasNoUdr - User tried to inject Managed Server subnet without default User Defined Route Table.\n\n * 400 VnetConfigHasInvalidUdr - User tried to inject Managed Server subnet with invalid User Defined Route Table.\n\n * 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.\n\n * 400 VnetConfigHasServiceEndpoints - User tried to inject Managed Server subnet with service endpoints.\n\n * 400 VnetSubnetIsInUse - User tried to inject Managed Server subnet that is not empty.\n\n * 400 VnetSubnetIsLocked - User tried to inject Managed Server subnet that is in locked scope.\n\n * 400 VnetSubnetIsGateway - User tried to inject Managed Server subnet that is Gateway subnet.\n\n * 400 VnetSubnetIsUnknown - User tried to inject Managed Server subnet that does not exist.\n\n * 400 VnetSubnetConflictWithIntendedPolicy - User tried to inject Managed Server subnet that has a conflict with IntendedPolicy.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 ManagedInstanceInvalidEditionForSku - The specified edition {0} is not consistent with the specified SKU {1}.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInCreateOfMI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the create operation.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagedInstanceInvalidLicenseType - The specified license type {0} is not valid.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInUpdateOfGPV1MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V1 Managed Instance.\n\n * 400 UnspecifiedTargetEditionAndFalseGPV2NotAllowedInUpdateOfGPV2MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value FALSE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 GPTargetEditionAndUnspecifiedGPV2NotAllowedInUpdateOFGPV2MI - Combination of General Purpose target edition (sku.name/sku.tier parameters) and unspecified value for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 BCTargetEditionAndSpecifiedGPV2ParamNotAllowedInCreateUpdateOfMI - Combination of Business Critical target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the create/update operation.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 UnspecifiedTargetEditionAndSpecifiedGPV2ParamNotAllowedInUpdateOfBCMI - Combination of unspecified target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the update operation of Business Critical Managed Instance.\n\n * 400 TotalMemoryMBNotSupported - Total memory MB parameter is not allowed in the instance create/update operation.\n\n * 400 TotalMemoryMBNotSupportedForSpecifiedEdition - Total memory MB parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 VnetResourceNotFound - Resource not found: '{0}'.\n\n * 400 InvalidTimezone - Invalid timezone.\n\n * 400 InvalidSubnetForGPV2Edition - General Purpose v2 edition of Managed Instance is not compatible with the specified subnet. Target subnet must be either empty, or all instances in it must run with November 2022 Feature Wave.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 TotalMemoryMBInvalidLimit - Total memory MB parameter has been set to an invalid limit.\n\n * 400 ManagedInstanceUpdateSloGPv2PerDatabaseFileLimitExceeded - The operation could not be completed because there is at least one database whose number of files is exceeding the limit of {0} files per database on General Purpose v2 edition.\n\n * 400 InstanceCollationUpdateNotSupported - User cannot change instance collation on Managed Instance.\n\n * 400 NextGenGPNotSupportedForCmwCustomers - Next-Gen General Purpose edition of Managed Instance does not support Custom Maintance Window.\n\n * 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - User can create a Managed Instance only with collation 'SQL_Latin1_General_CP1_CI_AS'.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedInstanceExceedMaxAzureStorage - The operation could not be completed because total allocated storage size for General Purpose instance would exceed {0}. Please reduce the number of database files and retry operation.\n\n * 400 ManagedInstanceHasGeoReplica - The operation could not be completed because instance has configured geo replicated secondary instance.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 StorageAccountFull - Managed Instance has reached the total capacity of underlying Azure storage account. Azure Premium Storage account is limited to 35TB of allocated space.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 ManagedInstanceRestoreToInstanceWithOlderVersionEdition - Restore operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 405 InvalidStorageIOpsLimitValue - Invalid storage IOps limit: {0} IOps. Storage IOps limit must be specified between {1} IOps and {2} IOps, in increments of {3} IOps.\n\n * 405 InvalidStorageThroughputMBpsLimitValue - Invalid storage throughput limit: {0} MBps. Storage throughput limit must be specified between {1} MBps and {2} MBps, in increments of {3} MBps.\n\n * 405 InvalidVcoreValue - vCore value {0} is not valid. Please specify a valid vCore value.\n\n * 405 InvalidHardwareGenerationValue - HardwareGeneration {0} is not valid. Please specify a valid HardwareGeneration value.\n\n * 405 InvalidStorageSizeValue - \"Invalid storage size: {0} GB. Storage size must be specified between {1} and {2} gigabytes, in increments of {3} GB.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 409 ServerOverridePreconditionFailed - Failed to apply server override on category '{0}', because physical db or instance '{1}' in server '{2}' is currently not in 'Ready' or 'Deactivated' state.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ManagedInstanceIsBusy - The server '{0}' is currently busy. Please wait a few minutes before trying again.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 GatewayInternalServerError - The server encountered an unexpected exception.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Accepted request for deleting the distributed availability group." + "description": "Accepted request for deleting the distributed availability group.", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "Distributed availability group was not found." @@ -273,13 +283,18 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidDnsZone - The operation has failed because you are attempting to deploy managed instance as a geo-replication secondary to the subnet {0} in which there already exists a managed instance. Deploying managed instance as a geo-replication secondary is supported only in cases when managed instance is the first instance deployed in a subnet. Consider deploying managed instance as a geo-replication secondary to a different subnet in which there are no existing managed instances, or if deploying to a subnet with existing managed instance disable the geo-replication option.\n\n * 400 HkCannotSwitchToInactive - The database cannot proceed with pricing-tier update as it has memory-optimized objects. Please drop such objects and try again.\n\n * 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - Invalid storage size: Storage size limit ({0} GB) is less that current storage used ({1} GB). Please specify higher storage size limit.\n\n * 400 InstanceTimezoneUpdateNotSupported - Instance timezone update not supported.\n\n * 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - Create Managed Instance with non-default timezone not supported.\n\n * 400 ManagedInstanceIpAddressRangeLimit - Cannot perform creation/scaling of the managed instance as there are not enough available IP addresses in the subnet for performing the operation.\n\n * 400 VnetDelegationNotAllowed - User tried to inject Managed Server to subnet which is delegated.\n\n * 400 SubnetHasResourcesOfDifferentType - User tried to create MI in subnet that has resources of different type.\n\n * 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - Update of Managed Instance with maintenance window settings is not allowed.\n\n * 400 OperationNotAllowedInCurrentGeodrConfiguration - The operation is not allowed because the current geo-replication configuration does not allow this combination of {0}. Change the setting on the geo-replication partner before applying the change on this instance.\n\n * 400 VnetPrepareNIPFailed - User tried to prepare subnet that has a conflict with NetworkIntentPolicy.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 ManagedInstanceDeprecatedHardwareFamily - Changing the hardware generation to deprecated {0} generation is not possible.\n\n * 400 ManagedInstanceBackupStorageTypeNotSupported - Backup storage type parameter is not allowed in the instance update operation.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 EmptyPDCInvalidDnsZone - This managed instance cannot be deployed because its DNS-zone does not match the DNS-prefix of its intended virtual cluster for subnet {0}. Although this virtual cluster is empty, its DNS-prefix cannot be changed. Empty virtual clusters will be automatically removed after several hours. Consider waiting for this virtual cluster to expire or manually deleting this virtual cluster and then creating the managed instance.\n\n * 400 InstancePoolNotEnoughCapacity - An instance pool does not have enough capacity\n\n * 400 ManagedInstanceFreemiumNotAvailableForInputParameters - Managed instance creation or update executed with SLO that is not allowed for freemium.\n\n * 400 ManagedInstanceFreemiumNotAvailableOnRegion - Creation of a freemium managed instance on a region that is not allowlisted for freemium.\n\n * 400 ManagementServiceSubnetMaintenanceInProgress - User tried to initiate managed instance create/update while incompatible maintenance is in progress.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ManagedInstanceFreemiumNotAvailableForSubscription - Freemium is not enabled for this subscription type.\n\n * 400 ManagedInstanceInvalidEditionForInstancePool - User tried to select invalid service tier for managed instance inside an existing instance pool.\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 ManagedInstanceInvalidSubnetForInstancePool - User tried to select invalid subnet for managed instance inside an existing instance pool.\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 ManagedInstanceZoneRedudantFeatureNotSupported - ZoneRedundant feature is not supported for the selected service tier. For more details visit aka.ms/sqlmi-service-tier-characteristics.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - Enabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - Disabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SubnetIdCantBeUpdated - Changing managed instance subnet is not supported operation. Please remove this parameter from the request.\n\n * 400 MigrationToAnotherVNetNotSupported - Selected subnet is in another Virtual Network. Moving managed instance to another Virtual Network is not possible. Please provide subnet from Virtual Network {0}.\n\n * 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - Provided subnet is having different DNS zone from the current. Changing instance DNS zone is not supported. Please provide subnet with same DNS zone, create a new subnet or provide empty one.\n\n * 400 MigrationToGen4SubnetNotSupported - It is not possible to update subnet while running on Gen4 hardware as it is being deprecated. Please upgrade your hardware from Gen4 to Gen5 as part of the changing managed instance subnet operation by specifying both parameters at the same time: destination subnet and hardware generation.\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - The operation could not be completed because some of the database files are exceeding maximum General Purpose file size limit of {0} GB.\n\n * 400 CloudLifterUnsupportedFeature - The functionality is not available on the Managed Instance at this time.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 OperationCanNotStartDueToMiLink - The '{0}' operation cannot be completed as there exists a database in a process of creation through Managed Instance link. Please wait for the link creation to complete, or delete the link, and retry the operation again.\n\n * 400 ManagedInstanceSloUpdateFailed - SLO '{0}' operation cannot succeed as the memory usage of '{1}' exceeds the quota.\n\n * 400 SourceAndTargetSubnetsMustBeVnetPeered - Subnet currently used by managed instance and provided destination subnet are part of the virtual networks that are not connected with virtual network peering, or have peering established but don't have allowed traffic. In order to move managed instance from one subnet to another, virtual network peering needs to be established from both source and target virtual network. Please configure virtual network requirements and then try the operation again. Learn more https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks. \n\n * 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - Subnet provided for managed instance deployment is located on subscription different than the one submitted for managed instance. Managed instance and subnet used for deploying the instance must be on the same subscription. Please provide another subnet or switch to the subnet subscription and then try the operation again.\n\n * 400 CreateManagedInstanceInvalidSubnetSize - User attempted to create managed instance in a subnet that is smaller than the allowed minimal subnet size.\n\n * 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - Subnet selected for managed instance migration has address range that overlaps with address range of subnet that holds geo replicated secondary instance. Please verify that your subnet is configured according to guidelines in https://aka.ms/move-managed-instance. \n\n * 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - Subnet selected for managed instance migration is not configured to enable communication with a geo replicated secondary instance. Please check if all of the required ports are open. To properly configure your subnet read the guidelines in https://aka.ms/move-managed-instance. \n\n * 400 ManagedInstanceLocalStorageUpdateSloDisabled - Update SLO for managed instances with local storage is not supported yet.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 GatewayInvalidEdition - '{0}' is not a valid database edition in this version of SQL Server.\n\n * 400 ManagedInstanceInvalidHardwareFamilyForInstancePool - User tried to select invalid hardware family for managed instance inside an existing instance pool.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 ManagedInstanceInvalidLicenseTypeForInstancePool - User tried to select invalid license type for managed instance inside an existing instance pool.\n\n * 400 ManagedInstanceUpdateSloFromVersionlessToVersionedNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 ManagedInstanceUpdateSloFromNewerToOlderVersionEditionNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 ManagedInstanceUpdateSloFromVersionedToVersionlessWorkerCLNotAllowed - Changing the database format is not supported for this managed instance. Check the database format property value specified and visit https://aka.ms/sqlmi-fwnov2022 for more details.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 ManagedInstanceVersionEditionParameterNotAllowedForUsing - Specifying the database format property value is not supported at this time.\n\n * 400 ManagedInstanceFreemiumInvalidArchitecture - A freemium instance can not be created in the specified subnet '(0)'.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ManagedInstanceGeoDRNotAllowedForInstancePool - Creating auto-failover group (GeoDR) is not supported for Managed Instances provisioned inside instance pools. Auto failover groups can be created only for standalone Managed Instances.\n\n * 400 ManagedInstanceWithGeoDRMoveToInstancePoolNotAllowed - Customer has attempted to move a standalone Managed Instance with an existing auto-failover group configured into an instance pool, which is not supported. Only standalone instances without existing auto-failover groups configured can be moved to instance pools.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerRegion - Creation of ZoneRedundant SQL MI is temporarily disabled on this region. You can create Zone Redundant SQL Managed Instances in many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerHardwareGeneration - Creation of ZoneRedundant SQL MI is temporarily disabled for this hardware generation on this region. You can create Zone Redundant SQL Managed Instances with different hardware generation on this region or many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceUpdateSloGeoPrimaryWithNewerVersionEditionThanSecondary - Database format change must be performed on the secondary instance of the failover group first. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 ManagedInstanceFreemiumInstanceAlreadyExists - Only one free SQL Managed Instance is allowed per subscription.\n\n * 400 ManagementServiceGeodrSecondaryDatabaseInCreation - The '{0}' operation cannot be completed as there exists a database in a process of creation through failover group deployment. Please wait for the failover group deployment to complete, or alternatively delete the failover group and retry the operation again.\n\n * 400 ManagedInstanceConversionRegularToFreemiumNotAllowed - User tried converting a Regular SQL Managed Instance to Free SQL Managed Instance.\n\n * 400 ManagedInstanceConversionFreemiumToRegularAndUpdateSLOWhileStoppedNotAllowed - User tried converting a Free SQL Managed Instance to Regular SQL Managed Instance and Update SLO in same request, while Instance is stopped.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 ManagedInstanceMaintenanceWindowChangeNotAllowedWhenInInstancePool - Maintenance window is set at instance pool level and cannot be set individually per pooled instance.\n\n * 400 ManagedInstanceMoveToInstancePoolExceedsDbCountLimit - Cannot move the instance into the pool due to pool database count limit.\n\n * 400 StorageIOpsNotSupported - Storage IOps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidCollation - Invalid collation.\n\n * 400 StorageThroughputMBpsNotSupported - Storage throughput MBps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 StorageIOpsNotSupportedForSpecifiedEdition - Storage IOps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 StorageThroughputMBpsNotSupportedForSpecifiedEdition - Storage throughput MBps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 ManagedInstanceClassicVnetNotSupported - Managed Instance cannot be joined to a classic virtual network.\n\n * 400 AlterDbDeactivatedNotSupported - Database Operation failed for Server '{0}', Database '{1}' due to unexpected delay. Please try again.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetConfigHasNsg - User tried to inject Managed Server subnet with Network Security Groups.\n\n * 400 VnetConfigHasNoUdr - User tried to inject Managed Server subnet without default User Defined Route Table.\n\n * 400 VnetConfigHasInvalidUdr - User tried to inject Managed Server subnet with invalid User Defined Route Table.\n\n * 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.\n\n * 400 VnetConfigHasServiceEndpoints - User tried to inject Managed Server subnet with service endpoints.\n\n * 400 VnetSubnetIsInUse - User tried to inject Managed Server subnet that is not empty.\n\n * 400 VnetSubnetIsLocked - User tried to inject Managed Server subnet that is in locked scope.\n\n * 400 VnetSubnetIsGateway - User tried to inject Managed Server subnet that is Gateway subnet.\n\n * 400 VnetSubnetIsUnknown - User tried to inject Managed Server subnet that does not exist.\n\n * 400 VnetSubnetConflictWithIntendedPolicy - User tried to inject Managed Server subnet that has a conflict with IntendedPolicy.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 ManagedInstanceInvalidEditionForSku - The specified edition {0} is not consistent with the specified SKU {1}.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInCreateOfMI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the create operation.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagedInstanceInvalidLicenseType - The specified license type {0} is not valid.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInUpdateOfGPV1MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V1 Managed Instance.\n\n * 400 UnspecifiedTargetEditionAndFalseGPV2NotAllowedInUpdateOfGPV2MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value FALSE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 GPTargetEditionAndUnspecifiedGPV2NotAllowedInUpdateOFGPV2MI - Combination of General Purpose target edition (sku.name/sku.tier parameters) and unspecified value for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 BCTargetEditionAndSpecifiedGPV2ParamNotAllowedInCreateUpdateOfMI - Combination of Business Critical target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the create/update operation.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 UnspecifiedTargetEditionAndSpecifiedGPV2ParamNotAllowedInUpdateOfBCMI - Combination of unspecified target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the update operation of Business Critical Managed Instance.\n\n * 400 TotalMemoryMBNotSupported - Total memory MB parameter is not allowed in the instance create/update operation.\n\n * 400 TotalMemoryMBNotSupportedForSpecifiedEdition - Total memory MB parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 VnetResourceNotFound - Resource not found: '{0}'.\n\n * 400 InvalidTimezone - Invalid timezone.\n\n * 400 InvalidSubnetForGPV2Edition - General Purpose v2 edition of Managed Instance is not compatible with the specified subnet. Target subnet must be either empty, or all instances in it must run with November 2022 Feature Wave.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 TotalMemoryMBInvalidLimit - Total memory MB parameter has been set to an invalid limit.\n\n * 400 ManagedInstanceUpdateSloGPv2PerDatabaseFileLimitExceeded - The operation could not be completed because there is at least one database whose number of files is exceeding the limit of {0} files per database on General Purpose v2 edition.\n\n * 400 InstanceCollationUpdateNotSupported - User cannot change instance collation on Managed Instance.\n\n * 400 NextGenGPNotSupportedForCmwCustomers - Next-Gen General Purpose edition of Managed Instance does not support Custom Maintenance Window.\n\n * 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - User can create a Managed Instance only with collation 'SQL_Latin1_General_CP1_CI_AS'.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedInstanceExceedMaxAzureStorage - The operation could not be completed because total allocated storage size for General Purpose instance would exceed {0}. Please reduce the number of database files and retry operation.\n\n * 400 ManagedInstanceHasGeoReplica - The operation could not be completed because instance has configured geo replicated secondary instance.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 StorageAccountFull - Managed Instance has reached the total capacity of underlying Azure storage account. Azure Premium Storage account is limited to 35TB of allocated space.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 ManagedInstanceRestoreToInstanceWithOlderVersionEdition - Restore operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 405 InvalidStorageIOpsLimitValue - Invalid storage IOps limit: {0} IOps. Storage IOps limit must be specified between {1} IOps and {2} IOps, in increments of {3} IOps.\n\n * 405 InvalidStorageThroughputMBpsLimitValue - Invalid storage throughput limit: {0} MBps. Storage throughput limit must be specified between {1} MBps and {2} MBps, in increments of {3} MBps.\n\n * 405 InvalidVcoreValue - vCore value {0} is not valid. Please specify a valid vCore value.\n\n * 405 InvalidHardwareGenerationValue - HardwareGeneration {0} is not valid. Please specify a valid HardwareGeneration value.\n\n * 405 InvalidStorageSizeValue - \"Invalid storage size: {0} GB. Storage size must be specified between {1} and {2} gigabytes, in increments of {3} GB.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 409 ServerOverridePreconditionFailed - Failed to apply server override on category '{0}', because physical db or instance '{1}' in server '{2}' is currently not in 'Ready' or 'Deactivated' state.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ManagedInstanceIsBusy - The server '{0}' is currently busy. Please wait a few minutes before trying again.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 GatewayInternalServerError - The server encountered an unexpected exception.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidDnsZone - The operation has failed because you are attempting to deploy managed instance as a geo-replication secondary to the subnet {0} in which there already exists a managed instance. Deploying managed instance as a geo-replication secondary is supported only in cases when managed instance is the first instance deployed in a subnet. Consider deploying managed instance as a geo-replication secondary to a different subnet in which there are no existing managed instances, or if deploying to a subnet with existing managed instance disable the geo-replication option.\n\n * 400 HkCannotSwitchToInactive - The database cannot proceed with pricing-tier update as it has memory-optimized objects. Please drop such objects and try again.\n\n * 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - Invalid storage size: Storage size limit ({0} GB) is less that current storage used ({1} GB). Please specify higher storage size limit.\n\n * 400 InstanceTimezoneUpdateNotSupported - Instance timezone update not supported.\n\n * 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - Create Managed Instance with non-default timezone not supported.\n\n * 400 ManagedInstanceIpAddressRangeLimit - Cannot perform creation/scaling of the managed instance as there are not enough available IP addresses in the subnet for performing the operation.\n\n * 400 VnetDelegationNotAllowed - User tried to inject Managed Server to subnet which is delegated.\n\n * 400 SubnetHasResourcesOfDifferentType - User tried to create MI in subnet that has resources of different type.\n\n * 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - Update of Managed Instance with maintenance window settings is not allowed.\n\n * 400 OperationNotAllowedInCurrentGeodrConfiguration - The operation is not allowed because the current geo-replication configuration does not allow this combination of {0}. Change the setting on the geo-replication partner before applying the change on this instance.\n\n * 400 VnetPrepareNIPFailed - User tried to prepare subnet that has a conflict with NetworkIntentPolicy.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 ManagedInstanceDeprecatedHardwareFamily - Changing the hardware generation to deprecated {0} generation is not possible.\n\n * 400 ManagedInstanceBackupStorageTypeNotSupported - Backup storage type parameter is not allowed in the instance update operation.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 EmptyPDCInvalidDnsZone - This managed instance cannot be deployed because its DNS-zone does not match the DNS-prefix of its intended virtual cluster for subnet {0}. Although this virtual cluster is empty, its DNS-prefix cannot be changed. Empty virtual clusters will be automatically removed after several hours. Consider waiting for this virtual cluster to expire or manually deleting this virtual cluster and then creating the managed instance.\n\n * 400 InstancePoolNotEnoughCapacity - An instance pool does not have enough capacity\n\n * 400 ManagedInstanceFreemiumNotAvailableForInputParameters - Managed instance creation or update executed with SLO that is not allowed for freemium.\n\n * 400 ManagedInstanceFreemiumNotAvailableOnRegion - Creation of a freemium managed instance on a region that is not allowlisted for freemium.\n\n * 400 ManagementServiceSubnetMaintenanceInProgress - User tried to initiate managed instance create/update while incompatible maintenance is in progress.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ManagedInstanceFreemiumNotAvailableForSubscription - Freemium is not enabled for this subscription type.\n\n * 400 ManagedInstanceInvalidEditionForInstancePool - User tried to select invalid service tier for managed instance inside an existing instance pool.\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 ManagedInstanceInvalidSubnetForInstancePool - User tried to select invalid subnet for managed instance inside an existing instance pool.\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 ManagedInstanceZoneRedudantFeatureNotSupported - ZoneRedundant feature is not supported for the selected service tier. For more details visit aka.ms/sqlmi-service-tier-characteristics.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - Enabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - Disabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SubnetIdCantBeUpdated - Changing managed instance subnet is not supported operation. Please remove this parameter from the request.\n\n * 400 MigrationToAnotherVNetNotSupported - Selected subnet is in another Virtual Network. Moving managed instance to another Virtual Network is not possible. Please provide subnet from Virtual Network {0}.\n\n * 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - Provided subnet is having different DNS zone from the current. Changing instance DNS zone is not supported. Please provide subnet with same DNS zone, create a new subnet or provide empty one.\n\n * 400 MigrationToGen4SubnetNotSupported - It is not possible to update subnet while running on Gen4 hardware as it is being deprecated. Please upgrade your hardware from Gen4 to Gen5 as part of the changing managed instance subnet operation by specifying both parameters at the same time: destination subnet and hardware generation.\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - The operation could not be completed because some of the database files are exceeding maximum General Purpose file size limit of {0} GB.\n\n * 400 CloudLifterUnsupportedFeature - The functionality is not available on the Managed Instance at this time.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 OperationCanNotStartDueToMiLink - The '{0}' operation cannot be completed as there exists a database in a process of creation through Managed Instance link. Please wait for the link creation to complete, or delete the link, and retry the operation again.\n\n * 400 ManagedInstanceSloUpdateFailed - SLO '{0}' operation cannot succeed as the memory usage of '{1}' exceeds the quota.\n\n * 400 SourceAndTargetSubnetsMustBeVnetPeered - Subnet currently used by managed instance and provided destination subnet are part of the virtual networks that are not connected with virtual network peering, or have peering established but don't have allowed traffic. In order to move managed instance from one subnet to another, virtual network peering needs to be established from both source and target virtual network. Please configure virtual network requirements and then try the operation again. Learn more https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks. \n\n * 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - Subnet provided for managed instance deployment is located on subscription different than the one submitted for managed instance. Managed instance and subnet used for deploying the instance must be on the same subscription. Please provide another subnet or switch to the subnet subscription and then try the operation again.\n\n * 400 CreateManagedInstanceInvalidSubnetSize - User attempted to create managed instance in a subnet that is smaller than the allowed minimal subnet size.\n\n * 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - Subnet selected for managed instance migration has address range that overlaps with address range of subnet that holds geo replicated secondary instance. Please verify that your subnet is configured according to guidelines in https://aka.ms/move-managed-instance. \n\n * 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - Subnet selected for managed instance migration is not configured to enable communication with a geo replicated secondary instance. Please check if all of the required ports are open. To properly configure your subnet read the guidelines in https://aka.ms/move-managed-instance. \n\n * 400 ManagedInstanceLocalStorageUpdateSloDisabled - Update SLO for managed instances with local storage is not supported yet.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 GatewayInvalidEdition - '{0}' is not a valid database edition in this version of SQL Server.\n\n * 400 ManagedInstanceInvalidHardwareFamilyForInstancePool - User tried to select invalid hardware family for managed instance inside an existing instance pool.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 ManagedInstanceInvalidLicenseTypeForInstancePool - User tried to select invalid license type for managed instance inside an existing instance pool.\n\n * 400 ManagedInstanceUpdateSloFromVersionlessToVersionedNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 ManagedInstanceUpdateSloFromNewerToOlderVersionEditionNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 ManagedInstanceUpdateSloFromVersionedToVersionlessWorkerCLNotAllowed - Changing the database format is not supported for this managed instance. Check the database format property value specified and visit https://aka.ms/sqlmi-fwnov2022 for more details.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 ManagedInstanceVersionEditionParameterNotAllowedForUsing - Specifying the database format property value is not supported at this time.\n\n * 400 ManagedInstanceFreemiumInvalidArchitecture - A freemium instance can not be created in the specified subnet '(0)'.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ManagedInstanceWithGeoDRMoveToInstancePoolNotAllowed - Customer has attempted to move a standalone Managed Instance with an existing auto-failover group configured into an instance pool, which is not supported. Only standalone instances without existing auto-failover groups configured can be moved to instance pools.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerRegion - Creation of ZoneRedundant SQL MI is temporarily disabled on this region. You can create Zone Redundant SQL Managed Instances in many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerHardwareGeneration - Creation of ZoneRedundant SQL MI is temporarily disabled for this hardware generation on this region. You can create Zone Redundant SQL Managed Instances with different hardware generation on this region or many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceUpdateSloGeoPrimaryWithNewerVersionEditionThanSecondary - Database format change must be performed on the secondary instance of the failover group first. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 ManagedInstanceFreemiumInstanceAlreadyExists - Only one free SQL Managed Instance is allowed per subscription.\n\n * 400 ManagementServiceGeodrSecondaryDatabaseInCreation - The '{0}' operation cannot be completed as there exists a database in a process of creation through failover group deployment. Please wait for the failover group deployment to complete, or alternatively delete the failover group and retry the operation again.\n\n * 400 ManagedInstanceConversionRegularToFreemiumNotAllowed - User tried converting a Regular SQL Managed Instance to Free SQL Managed Instance.\n\n * 400 ManagedInstanceConversionFreemiumToRegularAndUpdateSLOWhileStoppedNotAllowed - User tried converting a Free SQL Managed Instance to Regular SQL Managed Instance and Update SLO in same request, while Instance is stopped.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 ManagedInstanceMaintenanceWindowChangeNotAllowedWhenInInstancePool - Maintenance window is set at instance pool level and cannot be set individually per pooled instance.\n\n * 400 ManagedInstanceMoveToInstancePoolExceedsDbCountLimit - Cannot move the instance into the pool due to pool database count limit.\n\n * 400 ManagedInstancePoolZoneRedundancyNotSupported - Cannot move a zone-redundant instance into the pool as zone-redundancy is not supported in pools.\n\n * 400 DeploymentIntoPrivateSubnetsNotAllowed - Deploying managed instances and instance pools into private subnets is not supported.\n\n * 400 StorageIOpsNotSupported - Storage IOps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidCollation - Invalid collation.\n\n * 400 StorageThroughputMBpsNotSupported - Storage throughput MBps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 StorageIOpsNotSupportedForSpecifiedEdition - Storage IOps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 StorageThroughputMBpsNotSupportedForSpecifiedEdition - Storage throughput MBps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 ManagedInstanceClassicVnetNotSupported - Managed Instance cannot be joined to a classic virtual network.\n\n * 400 AlterDbDeactivatedNotSupported - Database Operation failed for Server '{0}', Database '{1}' due to unexpected delay. Please try again.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetConfigHasNsg - User tried to inject Managed Server subnet with Network Security Groups.\n\n * 400 VnetConfigHasNoUdr - User tried to inject Managed Server subnet without default User Defined Route Table.\n\n * 400 VnetConfigHasInvalidUdr - User tried to inject Managed Server subnet with invalid User Defined Route Table.\n\n * 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.\n\n * 400 VnetConfigHasServiceEndpoints - User tried to inject Managed Server subnet with service endpoints.\n\n * 400 VnetSubnetIsInUse - User tried to inject Managed Server subnet that is not empty.\n\n * 400 VnetSubnetIsLocked - User tried to inject Managed Server subnet that is in locked scope.\n\n * 400 VnetSubnetIsGateway - User tried to inject Managed Server subnet that is Gateway subnet.\n\n * 400 VnetSubnetIsUnknown - User tried to inject Managed Server subnet that does not exist.\n\n * 400 VnetSubnetConflictWithIntendedPolicy - User tried to inject Managed Server subnet that has a conflict with IntendedPolicy.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 ManagedInstanceInvalidEditionForSku - The specified edition {0} is not consistent with the specified SKU {1}.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInCreateOfMI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the create operation.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagedInstanceInvalidLicenseType - The specified license type {0} is not valid.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInUpdateOfGPV1MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V1 Managed Instance.\n\n * 400 UnspecifiedTargetEditionAndFalseGPV2NotAllowedInUpdateOfGPV2MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value FALSE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 GPTargetEditionAndUnspecifiedGPV2NotAllowedInUpdateOFGPV2MI - Combination of General Purpose target edition (sku.name/sku.tier parameters) and unspecified value for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 BCTargetEditionAndSpecifiedGPV2ParamNotAllowedInCreateUpdateOfMI - Combination of Business Critical target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the create/update operation.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 UnspecifiedTargetEditionAndSpecifiedGPV2ParamNotAllowedInUpdateOfBCMI - Combination of unspecified target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the update operation of Business Critical Managed Instance.\n\n * 400 TotalMemoryMBNotSupported - Total memory MB parameter is not allowed in the instance create/update operation.\n\n * 400 TotalMemoryMBNotSupportedForSpecifiedEdition - Total memory MB parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 VnetResourceNotFound - Resource not found: '{0}'.\n\n * 400 InvalidTimezone - Invalid timezone.\n\n * 400 InvalidSubnetForGPV2Edition - General Purpose v2 edition of Managed Instance is not compatible with the specified subnet. Target subnet must be either empty, or all instances in it must run with November 2022 Feature Wave.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 TotalMemoryMBInvalidLimit - Total memory MB parameter has been set to an invalid limit.\n\n * 400 ManagedInstanceUpdateSloGPv2PerDatabaseFileLimitExceeded - The operation could not be completed because there is at least one database whose number of files is exceeding the limit of {0} files per database on General Purpose v2 edition.\n\n * 400 InstanceCollationUpdateNotSupported - User cannot change instance collation on Managed Instance.\n\n * 400 NextGenGPNotSupportedForCmwCustomers - Next-Gen General Purpose edition of Managed Instance does not support Custom Maintance Window.\n\n * 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - User can create a Managed Instance only with collation 'SQL_Latin1_General_CP1_CI_AS'.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedInstanceExceedMaxAzureStorage - The operation could not be completed because total allocated storage size for General Purpose instance would exceed {0}. Please reduce the number of database files and retry operation.\n\n * 400 ManagedInstanceHasGeoReplica - The operation could not be completed because instance has configured geo replicated secondary instance.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 StorageAccountFull - Managed Instance has reached the total capacity of underlying Azure storage account. Azure Premium Storage account is limited to 35TB of allocated space.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 ManagedInstanceRestoreToInstanceWithOlderVersionEdition - Restore operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 405 InvalidStorageIOpsLimitValue - Invalid storage IOps limit: {0} IOps. Storage IOps limit must be specified between {1} IOps and {2} IOps, in increments of {3} IOps.\n\n * 405 InvalidStorageThroughputMBpsLimitValue - Invalid storage throughput limit: {0} MBps. Storage throughput limit must be specified between {1} MBps and {2} MBps, in increments of {3} MBps.\n\n * 405 InvalidVcoreValue - vCore value {0} is not valid. Please specify a valid vCore value.\n\n * 405 InvalidHardwareGenerationValue - HardwareGeneration {0} is not valid. Please specify a valid HardwareGeneration value.\n\n * 405 InvalidStorageSizeValue - \"Invalid storage size: {0} GB. Storage size must be specified between {1} and {2} gigabytes, in increments of {3} GB.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 409 ServerOverridePreconditionFailed - Failed to apply server override on category '{0}', because physical db or instance '{1}' in server '{2}' is currently not in 'Ready' or 'Deactivated' state.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ManagedInstanceIsBusy - The server '{0}' is currently busy. Please wait a few minutes before trying again.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 GatewayInternalServerError - The server encountered an unexpected exception.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Accepted request for updating the distributed availability group replication mode." + "description": "Accepted request for updating the distributed availability group replication mode.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -345,7 +360,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidDistributedAvailabilityGroupFailoverRequest - Distributed Availability Group Failover request body is empty or invalid.\n\n * 400 InvalidDistributedAvailabilityGroupFailoverInstanceRole - Planned failover can be executed on a link in the primary role only. Current state of the specified link is secondary.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidDnsZone - The operation has failed because you are attempting to deploy managed instance as a geo-replication secondary to the subnet {0} in which there already exists a managed instance. Deploying managed instance as a geo-replication secondary is supported only in cases when managed instance is the first instance deployed in a subnet. Consider deploying managed instance as a geo-replication secondary to a different subnet in which there are no existing managed instances, or if deploying to a subnet with existing managed instance disable the geo-replication option.\n\n * 400 HkCannotSwitchToInactive - The database cannot proceed with pricing-tier update as it has memory-optimized objects. Please drop such objects and try again.\n\n * 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - Invalid storage size: Storage size limit ({0} GB) is less that current storage used ({1} GB). Please specify higher storage size limit.\n\n * 400 InstanceTimezoneUpdateNotSupported - Instance timezone update not supported.\n\n * 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - Create Managed Instance with non-default timezone not supported.\n\n * 400 ManagedInstanceIpAddressRangeLimit - Cannot perform creation/scaling of the managed instance as there are not enough available IP addresses in the subnet for performing the operation.\n\n * 400 VnetDelegationNotAllowed - User tried to inject Managed Server to subnet which is delegated.\n\n * 400 SubnetHasResourcesOfDifferentType - User tried to create MI in subnet that has resources of different type.\n\n * 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - Update of Managed Instance with maintenance window settings is not allowed.\n\n * 400 OperationNotAllowedInCurrentGeodrConfiguration - The operation is not allowed because the current geo-replication configuration does not allow this combination of {0}. Change the setting on the geo-replication partner before applying the change on this instance.\n\n * 400 VnetPrepareNIPFailed - User tried to prepare subnet that has a conflict with NetworkIntentPolicy.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 ManagedInstanceDeprecatedHardwareFamily - Changing the hardware generation to deprecated {0} generation is not possible.\n\n * 400 ManagedInstanceBackupStorageTypeNotSupported - Backup storage type parameter is not allowed in the instance update operation.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 EmptyPDCInvalidDnsZone - This managed instance cannot be deployed because its DNS-zone does not match the DNS-prefix of its intended virtual cluster for subnet {0}. Although this virtual cluster is empty, its DNS-prefix cannot be changed. Empty virtual clusters will be automatically removed after several hours. Consider waiting for this virtual cluster to expire or manually deleting this virtual cluster and then creating the managed instance.\n\n * 400 InstancePoolNotEnoughCapacity - An instance pool does not have enough capacity\n\n * 400 ManagedInstanceFreemiumNotAvailableForInputParameters - Managed instance creation or update executed with SLO that is not allowed for freemium.\n\n * 400 ManagedInstanceFreemiumNotAvailableOnRegion - Creation of a freemium managed instance on a region that is not allowlisted for freemium.\n\n * 400 ManagementServiceSubnetMaintenanceInProgress - User tried to initiate managed instance create/update while incompatible maintenance is in progress.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ManagedInstanceFreemiumNotAvailableForSubscription - Freemium is not enabled for this subscription type.\n\n * 400 ManagedInstanceInvalidEditionForInstancePool - User tried to select invalid service tier for managed instance inside an existing instance pool.\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 ManagedInstanceInvalidSubnetForInstancePool - User tried to select invalid subnet for managed instance inside an existing instance pool.\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 ManagedInstanceZoneRedudantFeatureNotSupported - ZoneRedundant feature is not supported for the selected service tier. For more details visit aka.ms/sqlmi-service-tier-characteristics.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - Enabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - Disabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SubnetIdCantBeUpdated - Changing managed instance subnet is not supported operation. Please remove this parameter from the request.\n\n * 400 MigrationToAnotherVNetNotSupported - Selected subnet is in another Virtual Network. Moving managed instance to another Virtual Network is not possible. Please provide subnet from Virtual Network {0}.\n\n * 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - Provided subnet is having different DNS zone from the current. Changing instance DNS zone is not supported. Please provide subnet with same DNS zone, create a new subnet or provide empty one.\n\n * 400 MigrationToGen4SubnetNotSupported - It is not possible to update subnet while running on Gen4 hardware as it is being deprecated. Please upgrade your hardware from Gen4 to Gen5 as part of the changing managed instance subnet operation by specifying both parameters at the same time: destination subnet and hardware generation.\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - The operation could not be completed because some of the database files are exceeding maximum General Purpose file size limit of {0} GB.\n\n * 400 CloudLifterUnsupportedFeature - The functionality is not available on the Managed Instance at this time.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 OperationCanNotStartDueToMiLink - The '{0}' operation cannot be completed as there exists a database in a process of creation through Managed Instance link. Please wait for the link creation to complete, or delete the link, and retry the operation again.\n\n * 400 ManagedInstanceSloUpdateFailed - SLO '{0}' operation cannot succeed as the memory usage of '{1}' exceeds the quota.\n\n * 400 SourceAndTargetSubnetsMustBeVnetPeered - Subnet currently used by managed instance and provided destination subnet are part of the virtual networks that are not connected with virtual network peering, or have peering established but don't have allowed traffic. In order to move managed instance from one subnet to another, virtual network peering needs to be established from both source and target virtual network. Please configure virtual network requirements and then try the operation again. Learn more https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks. \n\n * 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - Subnet provided for managed instance deployment is located on subscription different than the one submitted for managed instance. Managed instance and subnet used for deploying the instance must be on the same subscription. Please provide another subnet or switch to the subnet subscription and then try the operation again.\n\n * 400 CreateManagedInstanceInvalidSubnetSize - User attempted to create managed instance in a subnet that is smaller than the allowed minimal subnet size.\n\n * 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - Subnet selected for managed instance migration has address range that overlaps with address range of subnet that holds geo replicated secondary instance. Please verify that your subnet is configured according to guidelines in https://aka.ms/move-managed-instance. \n\n * 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - Subnet selected for managed instance migration is not configured to enable communication with a geo replicated secondary instance. Please check if all of the required ports are open. To properly configure your subnet read the guidelines in https://aka.ms/move-managed-instance. \n\n * 400 ManagedInstanceLocalStorageUpdateSloDisabled - Update SLO for managed instances with local storage is not supported yet.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 GatewayInvalidEdition - '{0}' is not a valid database edition in this version of SQL Server.\n\n * 400 ManagedInstanceInvalidHardwareFamilyForInstancePool - User tried to select invalid hardware family for managed instance inside an existing instance pool.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 ManagedInstanceInvalidLicenseTypeForInstancePool - User tried to select invalid license type for managed instance inside an existing instance pool.\n\n * 400 ManagedInstanceUpdateSloFromVersionlessToVersionedNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 ManagedInstanceUpdateSloFromNewerToOlderVersionEditionNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 ManagedInstanceUpdateSloFromVersionedToVersionlessWorkerCLNotAllowed - Changing the database format is not supported for this managed instance. Check the database format property value specified and visit https://aka.ms/sqlmi-fwnov2022 for more details.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 ManagedInstanceVersionEditionParameterNotAllowedForUsing - Specifying the database format property value is not supported at this time.\n\n * 400 ManagedInstanceFreemiumInvalidArchitecture - A freemium instance can not be created in the specified subnet '(0)'.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ManagedInstanceGeoDRNotAllowedForInstancePool - Creating auto-failover group (GeoDR) is not supported for Managed Instances provisioned inside instance pools. Auto failover groups can be created only for standalone Managed Instances.\n\n * 400 ManagedInstanceWithGeoDRMoveToInstancePoolNotAllowed - Customer has attempted to move a standalone Managed Instance with an existing auto-failover group configured into an instance pool, which is not supported. Only standalone instances without existing auto-failover groups configured can be moved to instance pools.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerRegion - Creation of ZoneRedundant SQL MI is temporarily disabled on this region. You can create Zone Redundant SQL Managed Instances in many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerHardwareGeneration - Creation of ZoneRedundant SQL MI is temporarily disabled for this hardware generation on this region. You can create Zone Redundant SQL Managed Instances with different hardware generation on this region or many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceUpdateSloGeoPrimaryWithNewerVersionEditionThanSecondary - Database format change must be performed on the secondary instance of the failover group first. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 ManagedInstanceFreemiumInstanceAlreadyExists - Only one free SQL Managed Instance is allowed per subscription.\n\n * 400 ManagementServiceGeodrSecondaryDatabaseInCreation - The '{0}' operation cannot be completed as there exists a database in a process of creation through failover group deployment. Please wait for the failover group deployment to complete, or alternatively delete the failover group and retry the operation again.\n\n * 400 ManagedInstanceConversionRegularToFreemiumNotAllowed - User tried converting a Regular SQL Managed Instance to Free SQL Managed Instance.\n\n * 400 ManagedInstanceConversionFreemiumToRegularAndUpdateSLOWhileStoppedNotAllowed - User tried converting a Free SQL Managed Instance to Regular SQL Managed Instance and Update SLO in same request, while Instance is stopped.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 ManagedInstanceMaintenanceWindowChangeNotAllowedWhenInInstancePool - Maintenance window is set at instance pool level and cannot be set individually per pooled instance.\n\n * 400 ManagedInstanceMoveToInstancePoolExceedsDbCountLimit - Cannot move the instance into the pool due to pool database count limit.\n\n * 400 StorageIOpsNotSupported - Storage IOps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidCollation - Invalid collation.\n\n * 400 StorageThroughputMBpsNotSupported - Storage throughput MBps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 StorageIOpsNotSupportedForSpecifiedEdition - Storage IOps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 StorageThroughputMBpsNotSupportedForSpecifiedEdition - Storage throughput MBps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 ManagedInstanceClassicVnetNotSupported - Managed Instance cannot be joined to a classic virtual network.\n\n * 400 AlterDbDeactivatedNotSupported - Database Operation failed for Server '{0}', Database '{1}' due to unexpected delay. Please try again.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetConfigHasNsg - User tried to inject Managed Server subnet with Network Security Groups.\n\n * 400 VnetConfigHasNoUdr - User tried to inject Managed Server subnet without default User Defined Route Table.\n\n * 400 VnetConfigHasInvalidUdr - User tried to inject Managed Server subnet with invalid User Defined Route Table.\n\n * 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.\n\n * 400 VnetConfigHasServiceEndpoints - User tried to inject Managed Server subnet with service endpoints.\n\n * 400 VnetSubnetIsInUse - User tried to inject Managed Server subnet that is not empty.\n\n * 400 VnetSubnetIsLocked - User tried to inject Managed Server subnet that is in locked scope.\n\n * 400 VnetSubnetIsGateway - User tried to inject Managed Server subnet that is Gateway subnet.\n\n * 400 VnetSubnetIsUnknown - User tried to inject Managed Server subnet that does not exist.\n\n * 400 VnetSubnetConflictWithIntendedPolicy - User tried to inject Managed Server subnet that has a conflict with IntendedPolicy.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 ManagedInstanceInvalidEditionForSku - The specified edition {0} is not consistent with the specified SKU {1}.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInCreateOfMI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the create operation.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagedInstanceInvalidLicenseType - The specified license type {0} is not valid.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInUpdateOfGPV1MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V1 Managed Instance.\n\n * 400 UnspecifiedTargetEditionAndFalseGPV2NotAllowedInUpdateOfGPV2MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value FALSE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 GPTargetEditionAndUnspecifiedGPV2NotAllowedInUpdateOFGPV2MI - Combination of General Purpose target edition (sku.name/sku.tier parameters) and unspecified value for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 BCTargetEditionAndSpecifiedGPV2ParamNotAllowedInCreateUpdateOfMI - Combination of Business Critical target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the create/update operation.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 UnspecifiedTargetEditionAndSpecifiedGPV2ParamNotAllowedInUpdateOfBCMI - Combination of unspecified target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the update operation of Business Critical Managed Instance.\n\n * 400 TotalMemoryMBNotSupported - Total memory MB parameter is not allowed in the instance create/update operation.\n\n * 400 TotalMemoryMBNotSupportedForSpecifiedEdition - Total memory MB parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 VnetResourceNotFound - Resource not found: '{0}'.\n\n * 400 InvalidTimezone - Invalid timezone.\n\n * 400 InvalidSubnetForGPV2Edition - General Purpose v2 edition of Managed Instance is not compatible with the specified subnet. Target subnet must be either empty, or all instances in it must run with November 2022 Feature Wave.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 TotalMemoryMBInvalidLimit - Total memory MB parameter has been set to an invalid limit.\n\n * 400 ManagedInstanceUpdateSloGPv2PerDatabaseFileLimitExceeded - The operation could not be completed because there is at least one database whose number of files is exceeding the limit of {0} files per database on General Purpose v2 edition.\n\n * 400 InstanceCollationUpdateNotSupported - User cannot change instance collation on Managed Instance.\n\n * 400 NextGenGPNotSupportedForCmwCustomers - Next-Gen General Purpose edition of Managed Instance does not support Custom Maintenance Window.\n\n * 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - User can create a Managed Instance only with collation 'SQL_Latin1_General_CP1_CI_AS'.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedInstanceExceedMaxAzureStorage - The operation could not be completed because total allocated storage size for General Purpose instance would exceed {0}. Please reduce the number of database files and retry operation.\n\n * 400 ManagedInstanceHasGeoReplica - The operation could not be completed because instance has configured geo replicated secondary instance.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 StorageAccountFull - Managed Instance has reached the total capacity of underlying Azure storage account. Azure Premium Storage account is limited to 35TB of allocated space.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 ManagedInstanceRestoreToInstanceWithOlderVersionEdition - Restore operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 405 InvalidStorageIOpsLimitValue - Invalid storage IOps limit: {0} IOps. Storage IOps limit must be specified between {1} IOps and {2} IOps, in increments of {3} IOps.\n\n * 405 InvalidStorageThroughputMBpsLimitValue - Invalid storage throughput limit: {0} MBps. Storage throughput limit must be specified between {1} MBps and {2} MBps, in increments of {3} MBps.\n\n * 405 InvalidVcoreValue - vCore value {0} is not valid. Please specify a valid vCore value.\n\n * 405 InvalidHardwareGenerationValue - HardwareGeneration {0} is not valid. Please specify a valid HardwareGeneration value.\n\n * 405 InvalidStorageSizeValue - \"Invalid storage size: {0} GB. Storage size must be specified between {1} and {2} gigabytes, in increments of {3} GB.\n\n * 409 DistributedAvailabilityGroupDbEncryptedWithSmk - Managed database cannot be replicated from Managed Instance to SQL Server, as this managed database is encrypted with service managed key. Either decrypt the database on Managed Instance, or switch the encryption service protector to customer-managed (BYOK) and try again.\n\n * 409 DistributedAvailabilityGroupDbCannotBeEncryptedWhenPrimaryInMiLink - Database cannot be encrypted using the service managed key as it is being replicated from Managed Instance to SQL Server. Switch the encryption protector from service managed to customer managed (BYOK) on Managed Instance and ensure the encryption key from Managed Instance is imported on SQL Server.\n\n * 409 DistributedAvailabilityGroupProtectorCannotBeUpdtedToSmk - Switching the encryption protector from customer managed (BYOK) to service managed is not allowed as there exists database replication from Managed Instance to SQL Server supporting customer managed encryption only.\n\n * 409 DistributedAvailabilityGroupMiPrimaryWithGeodr - Database cannot be replicated from Managed Instance to SQL Server as there already exists database geo-replication from this Managed Instance to another Managed Instance using auto-failover groups. Disconnect this Managed Instance from the failover group, and try again.\n\n * 409 DistributedAvailabilityGroupFailoverSecondariesNotSynchronizing - Planned failover cannot be executed if secondaries are not synchronizing.\n\n * 409 DistributedAvailabilityGroupSetRoleInstanceAlreadyInRequestedRole - User attempted to perform setRole operation while managed instance link is already in requested role.\n\n * 409 DistributedAvailabilityGroupFailoverLogSendQueueSizeTooBig - Planned failover cannot be executed if send queue is too large.\n\n * 409 DistributedAvailabilityGroupFailoverRedoQueueSizeTooBig - Planned failover cannot be executed if redo queue is too large on secondary.\n\n * 409 DistributedAvailabilityGroupSetRoleChangeRoleAlreadyInProgress - Changing the server role cannot be executed at this time as there exist a previous role change in progress on Azure SQL Managed Instance. Only when the previous role change completes, a new request could be submitted. Please wait for the previous role change to complete and retry again.\n\n * 409 DistributedAvailabilityGroupSetRoleFailed - Setting the role has failed due to an unknown reason. Please check the error log file. If the issue persists, contact Azure support.\n\n * 409 DistributedAvailabilityGroupSetRolePrimaryPlannedNotSupported - User attempted to perform setRole operation to primary in planned fashion and that is not supported.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 409 ServerOverridePreconditionFailed - Failed to apply server override on category '{0}', because physical db or instance '{1}' in server '{2}' is currently not in 'Ready' or 'Deactivated' state.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ManagedInstanceIsBusy - The server '{0}' is currently busy. Please wait a few minutes before trying again.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 GatewayInternalServerError - The server encountered an unexpected exception.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 InvalidDistributedAvailabilityGroupFailoverRequest - Distributed Availability Group Failover request body is empty or invalid.\n\n * 400 InvalidDistributedAvailabilityGroupFailoverInstanceRole - Planned failover can be executed on a link in the primary role only. Current state of the specified link is secondary.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidDnsZone - The operation has failed because you are attempting to deploy managed instance as a geo-replication secondary to the subnet {0} in which there already exists a managed instance. Deploying managed instance as a geo-replication secondary is supported only in cases when managed instance is the first instance deployed in a subnet. Consider deploying managed instance as a geo-replication secondary to a different subnet in which there are no existing managed instances, or if deploying to a subnet with existing managed instance disable the geo-replication option.\n\n * 400 HkCannotSwitchToInactive - The database cannot proceed with pricing-tier update as it has memory-optimized objects. Please drop such objects and try again.\n\n * 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - Invalid storage size: Storage size limit ({0} GB) is less that current storage used ({1} GB). Please specify higher storage size limit.\n\n * 400 InstanceTimezoneUpdateNotSupported - Instance timezone update not supported.\n\n * 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - Create Managed Instance with non-default timezone not supported.\n\n * 400 ManagedInstanceIpAddressRangeLimit - Cannot perform creation/scaling of the managed instance as there are not enough available IP addresses in the subnet for performing the operation.\n\n * 400 VnetDelegationNotAllowed - User tried to inject Managed Server to subnet which is delegated.\n\n * 400 SubnetHasResourcesOfDifferentType - User tried to create MI in subnet that has resources of different type.\n\n * 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - Update of Managed Instance with maintenance window settings is not allowed.\n\n * 400 OperationNotAllowedInCurrentGeodrConfiguration - The operation is not allowed because the current geo-replication configuration does not allow this combination of {0}. Change the setting on the geo-replication partner before applying the change on this instance.\n\n * 400 VnetPrepareNIPFailed - User tried to prepare subnet that has a conflict with NetworkIntentPolicy.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 ManagedInstanceDeprecatedHardwareFamily - Changing the hardware generation to deprecated {0} generation is not possible.\n\n * 400 ManagedInstanceBackupStorageTypeNotSupported - Backup storage type parameter is not allowed in the instance update operation.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 EmptyPDCInvalidDnsZone - This managed instance cannot be deployed because its DNS-zone does not match the DNS-prefix of its intended virtual cluster for subnet {0}. Although this virtual cluster is empty, its DNS-prefix cannot be changed. Empty virtual clusters will be automatically removed after several hours. Consider waiting for this virtual cluster to expire or manually deleting this virtual cluster and then creating the managed instance.\n\n * 400 InstancePoolNotEnoughCapacity - An instance pool does not have enough capacity\n\n * 400 ManagedInstanceFreemiumNotAvailableForInputParameters - Managed instance creation or update executed with SLO that is not allowed for freemium.\n\n * 400 ManagedInstanceFreemiumNotAvailableOnRegion - Creation of a freemium managed instance on a region that is not allowlisted for freemium.\n\n * 400 ManagementServiceSubnetMaintenanceInProgress - User tried to initiate managed instance create/update while incompatible maintenance is in progress.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ManagedInstanceFreemiumNotAvailableForSubscription - Freemium is not enabled for this subscription type.\n\n * 400 ManagedInstanceInvalidEditionForInstancePool - User tried to select invalid service tier for managed instance inside an existing instance pool.\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 ManagedInstanceInvalidSubnetForInstancePool - User tried to select invalid subnet for managed instance inside an existing instance pool.\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 ManagedInstanceZoneRedudantFeatureNotSupported - ZoneRedundant feature is not supported for the selected service tier. For more details visit aka.ms/sqlmi-service-tier-characteristics.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - Enabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - Disabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SubnetIdCantBeUpdated - Changing managed instance subnet is not supported operation. Please remove this parameter from the request.\n\n * 400 MigrationToAnotherVNetNotSupported - Selected subnet is in another Virtual Network. Moving managed instance to another Virtual Network is not possible. Please provide subnet from Virtual Network {0}.\n\n * 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - Provided subnet is having different DNS zone from the current. Changing instance DNS zone is not supported. Please provide subnet with same DNS zone, create a new subnet or provide empty one.\n\n * 400 MigrationToGen4SubnetNotSupported - It is not possible to update subnet while running on Gen4 hardware as it is being deprecated. Please upgrade your hardware from Gen4 to Gen5 as part of the changing managed instance subnet operation by specifying both parameters at the same time: destination subnet and hardware generation.\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - The operation could not be completed because some of the database files are exceeding maximum General Purpose file size limit of {0} GB.\n\n * 400 CloudLifterUnsupportedFeature - The functionality is not available on the Managed Instance at this time.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 OperationCanNotStartDueToMiLink - The '{0}' operation cannot be completed as there exists a database in a process of creation through Managed Instance link. Please wait for the link creation to complete, or delete the link, and retry the operation again.\n\n * 400 ManagedInstanceSloUpdateFailed - SLO '{0}' operation cannot succeed as the memory usage of '{1}' exceeds the quota.\n\n * 400 SourceAndTargetSubnetsMustBeVnetPeered - Subnet currently used by managed instance and provided destination subnet are part of the virtual networks that are not connected with virtual network peering, or have peering established but don't have allowed traffic. In order to move managed instance from one subnet to another, virtual network peering needs to be established from both source and target virtual network. Please configure virtual network requirements and then try the operation again. Learn more https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks. \n\n * 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - Subnet provided for managed instance deployment is located on subscription different than the one submitted for managed instance. Managed instance and subnet used for deploying the instance must be on the same subscription. Please provide another subnet or switch to the subnet subscription and then try the operation again.\n\n * 400 CreateManagedInstanceInvalidSubnetSize - User attempted to create managed instance in a subnet that is smaller than the allowed minimal subnet size.\n\n * 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - Subnet selected for managed instance migration has address range that overlaps with address range of subnet that holds geo replicated secondary instance. Please verify that your subnet is configured according to guidelines in https://aka.ms/move-managed-instance. \n\n * 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - Subnet selected for managed instance migration is not configured to enable communication with a geo replicated secondary instance. Please check if all of the required ports are open. To properly configure your subnet read the guidelines in https://aka.ms/move-managed-instance. \n\n * 400 ManagedInstanceLocalStorageUpdateSloDisabled - Update SLO for managed instances with local storage is not supported yet.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 GatewayInvalidEdition - '{0}' is not a valid database edition in this version of SQL Server.\n\n * 400 ManagedInstanceInvalidHardwareFamilyForInstancePool - User tried to select invalid hardware family for managed instance inside an existing instance pool.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 ManagedInstanceInvalidLicenseTypeForInstancePool - User tried to select invalid license type for managed instance inside an existing instance pool.\n\n * 400 ManagedInstanceUpdateSloFromVersionlessToVersionedNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 ManagedInstanceUpdateSloFromNewerToOlderVersionEditionNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 ManagedInstanceUpdateSloFromVersionedToVersionlessWorkerCLNotAllowed - Changing the database format is not supported for this managed instance. Check the database format property value specified and visit https://aka.ms/sqlmi-fwnov2022 for more details.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 ManagedInstanceVersionEditionParameterNotAllowedForUsing - Specifying the database format property value is not supported at this time.\n\n * 400 ManagedInstanceFreemiumInvalidArchitecture - A freemium instance can not be created in the specified subnet '(0)'.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ManagedInstanceWithGeoDRMoveToInstancePoolNotAllowed - Customer has attempted to move a standalone Managed Instance with an existing auto-failover group configured into an instance pool, which is not supported. Only standalone instances without existing auto-failover groups configured can be moved to instance pools.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerRegion - Creation of ZoneRedundant SQL MI is temporarily disabled on this region. You can create Zone Redundant SQL Managed Instances in many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerHardwareGeneration - Creation of ZoneRedundant SQL MI is temporarily disabled for this hardware generation on this region. You can create Zone Redundant SQL Managed Instances with different hardware generation on this region or many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceUpdateSloGeoPrimaryWithNewerVersionEditionThanSecondary - Database format change must be performed on the secondary instance of the failover group first. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 ManagedInstanceFreemiumInstanceAlreadyExists - Only one free SQL Managed Instance is allowed per subscription.\n\n * 400 ManagementServiceGeodrSecondaryDatabaseInCreation - The '{0}' operation cannot be completed as there exists a database in a process of creation through failover group deployment. Please wait for the failover group deployment to complete, or alternatively delete the failover group and retry the operation again.\n\n * 400 ManagedInstanceConversionRegularToFreemiumNotAllowed - User tried converting a Regular SQL Managed Instance to Free SQL Managed Instance.\n\n * 400 ManagedInstanceConversionFreemiumToRegularAndUpdateSLOWhileStoppedNotAllowed - User tried converting a Free SQL Managed Instance to Regular SQL Managed Instance and Update SLO in same request, while Instance is stopped.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 ManagedInstanceMaintenanceWindowChangeNotAllowedWhenInInstancePool - Maintenance window is set at instance pool level and cannot be set individually per pooled instance.\n\n * 400 ManagedInstanceMoveToInstancePoolExceedsDbCountLimit - Cannot move the instance into the pool due to pool database count limit.\n\n * 400 ManagedInstancePoolZoneRedundancyNotSupported - Cannot move a zone-redundant instance into the pool as zone-redundancy is not supported in pools.\n\n * 400 DeploymentIntoPrivateSubnetsNotAllowed - Deploying managed instances and instance pools into private subnets is not supported.\n\n * 400 StorageIOpsNotSupported - Storage IOps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidCollation - Invalid collation.\n\n * 400 StorageThroughputMBpsNotSupported - Storage throughput MBps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 StorageIOpsNotSupportedForSpecifiedEdition - Storage IOps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 StorageThroughputMBpsNotSupportedForSpecifiedEdition - Storage throughput MBps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 ManagedInstanceClassicVnetNotSupported - Managed Instance cannot be joined to a classic virtual network.\n\n * 400 AlterDbDeactivatedNotSupported - Database Operation failed for Server '{0}', Database '{1}' due to unexpected delay. Please try again.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetConfigHasNsg - User tried to inject Managed Server subnet with Network Security Groups.\n\n * 400 VnetConfigHasNoUdr - User tried to inject Managed Server subnet without default User Defined Route Table.\n\n * 400 VnetConfigHasInvalidUdr - User tried to inject Managed Server subnet with invalid User Defined Route Table.\n\n * 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.\n\n * 400 VnetConfigHasServiceEndpoints - User tried to inject Managed Server subnet with service endpoints.\n\n * 400 VnetSubnetIsInUse - User tried to inject Managed Server subnet that is not empty.\n\n * 400 VnetSubnetIsLocked - User tried to inject Managed Server subnet that is in locked scope.\n\n * 400 VnetSubnetIsGateway - User tried to inject Managed Server subnet that is Gateway subnet.\n\n * 400 VnetSubnetIsUnknown - User tried to inject Managed Server subnet that does not exist.\n\n * 400 VnetSubnetConflictWithIntendedPolicy - User tried to inject Managed Server subnet that has a conflict with IntendedPolicy.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 ManagedInstanceInvalidEditionForSku - The specified edition {0} is not consistent with the specified SKU {1}.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInCreateOfMI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the create operation.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagedInstanceInvalidLicenseType - The specified license type {0} is not valid.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInUpdateOfGPV1MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V1 Managed Instance.\n\n * 400 UnspecifiedTargetEditionAndFalseGPV2NotAllowedInUpdateOfGPV2MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value FALSE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 GPTargetEditionAndUnspecifiedGPV2NotAllowedInUpdateOFGPV2MI - Combination of General Purpose target edition (sku.name/sku.tier parameters) and unspecified value for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 BCTargetEditionAndSpecifiedGPV2ParamNotAllowedInCreateUpdateOfMI - Combination of Business Critical target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the create/update operation.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 UnspecifiedTargetEditionAndSpecifiedGPV2ParamNotAllowedInUpdateOfBCMI - Combination of unspecified target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the update operation of Business Critical Managed Instance.\n\n * 400 TotalMemoryMBNotSupported - Total memory MB parameter is not allowed in the instance create/update operation.\n\n * 400 TotalMemoryMBNotSupportedForSpecifiedEdition - Total memory MB parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 VnetResourceNotFound - Resource not found: '{0}'.\n\n * 400 InvalidTimezone - Invalid timezone.\n\n * 400 InvalidSubnetForGPV2Edition - General Purpose v2 edition of Managed Instance is not compatible with the specified subnet. Target subnet must be either empty, or all instances in it must run with November 2022 Feature Wave.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 TotalMemoryMBInvalidLimit - Total memory MB parameter has been set to an invalid limit.\n\n * 400 ManagedInstanceUpdateSloGPv2PerDatabaseFileLimitExceeded - The operation could not be completed because there is at least one database whose number of files is exceeding the limit of {0} files per database on General Purpose v2 edition.\n\n * 400 InstanceCollationUpdateNotSupported - User cannot change instance collation on Managed Instance.\n\n * 400 NextGenGPNotSupportedForCmwCustomers - Next-Gen General Purpose edition of Managed Instance does not support Custom Maintance Window.\n\n * 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - User can create a Managed Instance only with collation 'SQL_Latin1_General_CP1_CI_AS'.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedInstanceExceedMaxAzureStorage - The operation could not be completed because total allocated storage size for General Purpose instance would exceed {0}. Please reduce the number of database files and retry operation.\n\n * 400 ManagedInstanceHasGeoReplica - The operation could not be completed because instance has configured geo replicated secondary instance.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 StorageAccountFull - Managed Instance has reached the total capacity of underlying Azure storage account. Azure Premium Storage account is limited to 35TB of allocated space.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 ManagedInstanceRestoreToInstanceWithOlderVersionEdition - Restore operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 405 InvalidStorageIOpsLimitValue - Invalid storage IOps limit: {0} IOps. Storage IOps limit must be specified between {1} IOps and {2} IOps, in increments of {3} IOps.\n\n * 405 InvalidStorageThroughputMBpsLimitValue - Invalid storage throughput limit: {0} MBps. Storage throughput limit must be specified between {1} MBps and {2} MBps, in increments of {3} MBps.\n\n * 405 InvalidVcoreValue - vCore value {0} is not valid. Please specify a valid vCore value.\n\n * 405 InvalidHardwareGenerationValue - HardwareGeneration {0} is not valid. Please specify a valid HardwareGeneration value.\n\n * 405 InvalidStorageSizeValue - \"Invalid storage size: {0} GB. Storage size must be specified between {1} and {2} gigabytes, in increments of {3} GB.\n\n * 409 DistributedAvailabilityGroupDbEncryptedWithSmk - Managed database cannot be replicated from Managed Instance to SQL Server, as this managed database is encrypted with service managed key. Either decrypt the database on Managed Instance, or switch the encryption service protector to customer-managed (BYOK) and try again.\n\n * 409 DistributedAvailabilityGroupDbCannotBeEncryptedWhenPrimaryInMiLink - Database cannot be encrypted using the service managed key as it is being replicated from Managed Instance to SQL Server. Switch the encryption protector from service managed to customer managed (BYOK) on Managed Instance and ensure the encryption key from Managed Instance is imported on SQL Server.\n\n * 409 DistributedAvailabilityGroupProtectorCannotBeUpdtedToSmk - Switching the encryption protector from customer managed (BYOK) to service managed is not allowed as there exists database replication from Managed Instance to SQL Server supporting customer managed encryption only.\n\n * 409 DistributedAvailabilityGroupMiPrimaryWithGeodr - Database cannot be replicated from Managed Instance to SQL Server as there already exists database geo-replication from this Managed Instance to another Managed Instance using auto-failover groups. Disconnect this Managed Instance from the failover group, and try again.\n\n * 409 DistributedAvailabilityGroupFailoverSecondariesNotSynchronizing - Planned failover cannot be executed if secondaries are not synchronizing.\n\n * 409 DistributedAvailabilityGroupSetRoleInstanceAlreadyInRequestedRole - User attempted to perform setRole operation while managed instance link is already in requested role.\n\n * 409 DistributedAvailabilityGroupFailoverLogSendQueueSizeTooBig - Planned failover cannot be executed if send queue is too large.\n\n * 409 DistributedAvailabilityGroupFailoverRedoQueueSizeTooBig - Planned failover cannot be executed if redo queue is too large on secondary.\n\n * 409 DistributedAvailabilityGroupSetRoleChangeRoleAlreadyInProgress - Changing the server role cannot be executed at this time as there exist a previous role change in progress on Azure SQL Managed Instance. Only when the previous role change completes, a new request could be submitted. Please wait for the previous role change to complete and retry again.\n\n * 409 DistributedAvailabilityGroupSetRoleFailed - Setting the role has failed due to an unknown reason. Please check the error log file. If the issue persists, contact Azure support.\n\n * 409 DistributedAvailabilityGroupSetRolePrimaryPlannedNotSupported - User attempted to perform setRole operation to primary in planned fashion and that is not supported.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 409 ServerOverridePreconditionFailed - Failed to apply server override on category '{0}', because physical db or instance '{1}' in server '{2}' is currently not in 'Ready' or 'Deactivated' state.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ManagedInstanceIsBusy - The server '{0}' is currently busy. Please wait a few minutes before trying again.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 GatewayInternalServerError - The server encountered an unexpected exception.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -415,7 +430,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidDistributedAvailabilityGroupFailoverRequest - Distributed Availability Group Failover request body is empty or invalid.\n\n * 400 InvalidDistributedAvailabilityGroupFailoverInstanceRole - Planned failover can be executed on a link in the primary role only. Current state of the specified link is secondary.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidDnsZone - The operation has failed because you are attempting to deploy managed instance as a geo-replication secondary to the subnet {0} in which there already exists a managed instance. Deploying managed instance as a geo-replication secondary is supported only in cases when managed instance is the first instance deployed in a subnet. Consider deploying managed instance as a geo-replication secondary to a different subnet in which there are no existing managed instances, or if deploying to a subnet with existing managed instance disable the geo-replication option.\n\n * 400 HkCannotSwitchToInactive - The database cannot proceed with pricing-tier update as it has memory-optimized objects. Please drop such objects and try again.\n\n * 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - Invalid storage size: Storage size limit ({0} GB) is less that current storage used ({1} GB). Please specify higher storage size limit.\n\n * 400 InstanceTimezoneUpdateNotSupported - Instance timezone update not supported.\n\n * 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - Create Managed Instance with non-default timezone not supported.\n\n * 400 ManagedInstanceIpAddressRangeLimit - Cannot perform creation/scaling of the managed instance as there are not enough available IP addresses in the subnet for performing the operation.\n\n * 400 VnetDelegationNotAllowed - User tried to inject Managed Server to subnet which is delegated.\n\n * 400 SubnetHasResourcesOfDifferentType - User tried to create MI in subnet that has resources of different type.\n\n * 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - Update of Managed Instance with maintenance window settings is not allowed.\n\n * 400 OperationNotAllowedInCurrentGeodrConfiguration - The operation is not allowed because the current geo-replication configuration does not allow this combination of {0}. Change the setting on the geo-replication partner before applying the change on this instance.\n\n * 400 VnetPrepareNIPFailed - User tried to prepare subnet that has a conflict with NetworkIntentPolicy.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 ManagedInstanceDeprecatedHardwareFamily - Changing the hardware generation to deprecated {0} generation is not possible.\n\n * 400 ManagedInstanceBackupStorageTypeNotSupported - Backup storage type parameter is not allowed in the instance update operation.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 EmptyPDCInvalidDnsZone - This managed instance cannot be deployed because its DNS-zone does not match the DNS-prefix of its intended virtual cluster for subnet {0}. Although this virtual cluster is empty, its DNS-prefix cannot be changed. Empty virtual clusters will be automatically removed after several hours. Consider waiting for this virtual cluster to expire or manually deleting this virtual cluster and then creating the managed instance.\n\n * 400 InstancePoolNotEnoughCapacity - An instance pool does not have enough capacity\n\n * 400 ManagedInstanceFreemiumNotAvailableForInputParameters - Managed instance creation or update executed with SLO that is not allowed for freemium.\n\n * 400 ManagedInstanceFreemiumNotAvailableOnRegion - Creation of a freemium managed instance on a region that is not allowlisted for freemium.\n\n * 400 ManagementServiceSubnetMaintenanceInProgress - User tried to initiate managed instance create/update while incompatible maintenance is in progress.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ManagedInstanceFreemiumNotAvailableForSubscription - Freemium is not enabled for this subscription type.\n\n * 400 ManagedInstanceInvalidEditionForInstancePool - User tried to select invalid service tier for managed instance inside an existing instance pool.\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 ManagedInstanceInvalidSubnetForInstancePool - User tried to select invalid subnet for managed instance inside an existing instance pool.\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 ManagedInstanceZoneRedudantFeatureNotSupported - ZoneRedundant feature is not supported for the selected service tier. For more details visit aka.ms/sqlmi-service-tier-characteristics.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - Enabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - Disabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SubnetIdCantBeUpdated - Changing managed instance subnet is not supported operation. Please remove this parameter from the request.\n\n * 400 MigrationToAnotherVNetNotSupported - Selected subnet is in another Virtual Network. Moving managed instance to another Virtual Network is not possible. Please provide subnet from Virtual Network {0}.\n\n * 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - Provided subnet is having different DNS zone from the current. Changing instance DNS zone is not supported. Please provide subnet with same DNS zone, create a new subnet or provide empty one.\n\n * 400 MigrationToGen4SubnetNotSupported - It is not possible to update subnet while running on Gen4 hardware as it is being deprecated. Please upgrade your hardware from Gen4 to Gen5 as part of the changing managed instance subnet operation by specifying both parameters at the same time: destination subnet and hardware generation.\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - The operation could not be completed because some of the database files are exceeding maximum General Purpose file size limit of {0} GB.\n\n * 400 CloudLifterUnsupportedFeature - The functionality is not available on the Managed Instance at this time.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 OperationCanNotStartDueToMiLink - The '{0}' operation cannot be completed as there exists a database in a process of creation through Managed Instance link. Please wait for the link creation to complete, or delete the link, and retry the operation again.\n\n * 400 ManagedInstanceSloUpdateFailed - SLO '{0}' operation cannot succeed as the memory usage of '{1}' exceeds the quota.\n\n * 400 SourceAndTargetSubnetsMustBeVnetPeered - Subnet currently used by managed instance and provided destination subnet are part of the virtual networks that are not connected with virtual network peering, or have peering established but don't have allowed traffic. In order to move managed instance from one subnet to another, virtual network peering needs to be established from both source and target virtual network. Please configure virtual network requirements and then try the operation again. Learn more https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks. \n\n * 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - Subnet provided for managed instance deployment is located on subscription different than the one submitted for managed instance. Managed instance and subnet used for deploying the instance must be on the same subscription. Please provide another subnet or switch to the subnet subscription and then try the operation again.\n\n * 400 CreateManagedInstanceInvalidSubnetSize - User attempted to create managed instance in a subnet that is smaller than the allowed minimal subnet size.\n\n * 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - Subnet selected for managed instance migration has address range that overlaps with address range of subnet that holds geo replicated secondary instance. Please verify that your subnet is configured according to guidelines in https://aka.ms/move-managed-instance. \n\n * 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - Subnet selected for managed instance migration is not configured to enable communication with a geo replicated secondary instance. Please check if all of the required ports are open. To properly configure your subnet read the guidelines in https://aka.ms/move-managed-instance. \n\n * 400 ManagedInstanceLocalStorageUpdateSloDisabled - Update SLO for managed instances with local storage is not supported yet.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 GatewayInvalidEdition - '{0}' is not a valid database edition in this version of SQL Server.\n\n * 400 ManagedInstanceInvalidHardwareFamilyForInstancePool - User tried to select invalid hardware family for managed instance inside an existing instance pool.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 ManagedInstanceInvalidLicenseTypeForInstancePool - User tried to select invalid license type for managed instance inside an existing instance pool.\n\n * 400 ManagedInstanceUpdateSloFromVersionlessToVersionedNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 ManagedInstanceUpdateSloFromNewerToOlderVersionEditionNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 ManagedInstanceUpdateSloFromVersionedToVersionlessWorkerCLNotAllowed - Changing the database format is not supported for this managed instance. Check the database format property value specified and visit https://aka.ms/sqlmi-fwnov2022 for more details.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 ManagedInstanceVersionEditionParameterNotAllowedForUsing - Specifying the database format property value is not supported at this time.\n\n * 400 ManagedInstanceFreemiumInvalidArchitecture - A freemium instance can not be created in the specified subnet '(0)'.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ManagedInstanceGeoDRNotAllowedForInstancePool - Creating auto-failover group (GeoDR) is not supported for Managed Instances provisioned inside instance pools. Auto failover groups can be created only for standalone Managed Instances.\n\n * 400 ManagedInstanceWithGeoDRMoveToInstancePoolNotAllowed - Customer has attempted to move a standalone Managed Instance with an existing auto-failover group configured into an instance pool, which is not supported. Only standalone instances without existing auto-failover groups configured can be moved to instance pools.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerRegion - Creation of ZoneRedundant SQL MI is temporarily disabled on this region. You can create Zone Redundant SQL Managed Instances in many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerHardwareGeneration - Creation of ZoneRedundant SQL MI is temporarily disabled for this hardware generation on this region. You can create Zone Redundant SQL Managed Instances with different hardware generation on this region or many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceUpdateSloGeoPrimaryWithNewerVersionEditionThanSecondary - Database format change must be performed on the secondary instance of the failover group first. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 ManagedInstanceFreemiumInstanceAlreadyExists - Only one free SQL Managed Instance is allowed per subscription.\n\n * 400 ManagementServiceGeodrSecondaryDatabaseInCreation - The '{0}' operation cannot be completed as there exists a database in a process of creation through failover group deployment. Please wait for the failover group deployment to complete, or alternatively delete the failover group and retry the operation again.\n\n * 400 ManagedInstanceConversionRegularToFreemiumNotAllowed - User tried converting a Regular SQL Managed Instance to Free SQL Managed Instance.\n\n * 400 ManagedInstanceConversionFreemiumToRegularAndUpdateSLOWhileStoppedNotAllowed - User tried converting a Free SQL Managed Instance to Regular SQL Managed Instance and Update SLO in same request, while Instance is stopped.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 ManagedInstanceMaintenanceWindowChangeNotAllowedWhenInInstancePool - Maintenance window is set at instance pool level and cannot be set individually per pooled instance.\n\n * 400 ManagedInstanceMoveToInstancePoolExceedsDbCountLimit - Cannot move the instance into the pool due to pool database count limit.\n\n * 400 StorageIOpsNotSupported - Storage IOps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidCollation - Invalid collation.\n\n * 400 StorageThroughputMBpsNotSupported - Storage throughput MBps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 StorageIOpsNotSupportedForSpecifiedEdition - Storage IOps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 StorageThroughputMBpsNotSupportedForSpecifiedEdition - Storage throughput MBps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 ManagedInstanceClassicVnetNotSupported - Managed Instance cannot be joined to a classic virtual network.\n\n * 400 AlterDbDeactivatedNotSupported - Database Operation failed for Server '{0}', Database '{1}' due to unexpected delay. Please try again.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetConfigHasNsg - User tried to inject Managed Server subnet with Network Security Groups.\n\n * 400 VnetConfigHasNoUdr - User tried to inject Managed Server subnet without default User Defined Route Table.\n\n * 400 VnetConfigHasInvalidUdr - User tried to inject Managed Server subnet with invalid User Defined Route Table.\n\n * 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.\n\n * 400 VnetConfigHasServiceEndpoints - User tried to inject Managed Server subnet with service endpoints.\n\n * 400 VnetSubnetIsInUse - User tried to inject Managed Server subnet that is not empty.\n\n * 400 VnetSubnetIsLocked - User tried to inject Managed Server subnet that is in locked scope.\n\n * 400 VnetSubnetIsGateway - User tried to inject Managed Server subnet that is Gateway subnet.\n\n * 400 VnetSubnetIsUnknown - User tried to inject Managed Server subnet that does not exist.\n\n * 400 VnetSubnetConflictWithIntendedPolicy - User tried to inject Managed Server subnet that has a conflict with IntendedPolicy.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 ManagedInstanceInvalidEditionForSku - The specified edition {0} is not consistent with the specified SKU {1}.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInCreateOfMI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the create operation.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagedInstanceInvalidLicenseType - The specified license type {0} is not valid.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInUpdateOfGPV1MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V1 Managed Instance.\n\n * 400 UnspecifiedTargetEditionAndFalseGPV2NotAllowedInUpdateOfGPV2MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value FALSE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 GPTargetEditionAndUnspecifiedGPV2NotAllowedInUpdateOFGPV2MI - Combination of General Purpose target edition (sku.name/sku.tier parameters) and unspecified value for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 BCTargetEditionAndSpecifiedGPV2ParamNotAllowedInCreateUpdateOfMI - Combination of Business Critical target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the create/update operation.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 UnspecifiedTargetEditionAndSpecifiedGPV2ParamNotAllowedInUpdateOfBCMI - Combination of unspecified target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the update operation of Business Critical Managed Instance.\n\n * 400 TotalMemoryMBNotSupported - Total memory MB parameter is not allowed in the instance create/update operation.\n\n * 400 TotalMemoryMBNotSupportedForSpecifiedEdition - Total memory MB parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 VnetResourceNotFound - Resource not found: '{0}'.\n\n * 400 InvalidTimezone - Invalid timezone.\n\n * 400 InvalidSubnetForGPV2Edition - General Purpose v2 edition of Managed Instance is not compatible with the specified subnet. Target subnet must be either empty, or all instances in it must run with November 2022 Feature Wave.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 TotalMemoryMBInvalidLimit - Total memory MB parameter has been set to an invalid limit.\n\n * 400 ManagedInstanceUpdateSloGPv2PerDatabaseFileLimitExceeded - The operation could not be completed because there is at least one database whose number of files is exceeding the limit of {0} files per database on General Purpose v2 edition.\n\n * 400 InstanceCollationUpdateNotSupported - User cannot change instance collation on Managed Instance.\n\n * 400 NextGenGPNotSupportedForCmwCustomers - Next-Gen General Purpose edition of Managed Instance does not support Custom Maintenance Window.\n\n * 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - User can create a Managed Instance only with collation 'SQL_Latin1_General_CP1_CI_AS'.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedInstanceExceedMaxAzureStorage - The operation could not be completed because total allocated storage size for General Purpose instance would exceed {0}. Please reduce the number of database files and retry operation.\n\n * 400 ManagedInstanceHasGeoReplica - The operation could not be completed because instance has configured geo replicated secondary instance.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 StorageAccountFull - Managed Instance has reached the total capacity of underlying Azure storage account. Azure Premium Storage account is limited to 35TB of allocated space.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 ManagedInstanceRestoreToInstanceWithOlderVersionEdition - Restore operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 405 InvalidStorageIOpsLimitValue - Invalid storage IOps limit: {0} IOps. Storage IOps limit must be specified between {1} IOps and {2} IOps, in increments of {3} IOps.\n\n * 405 InvalidStorageThroughputMBpsLimitValue - Invalid storage throughput limit: {0} MBps. Storage throughput limit must be specified between {1} MBps and {2} MBps, in increments of {3} MBps.\n\n * 405 InvalidVcoreValue - vCore value {0} is not valid. Please specify a valid vCore value.\n\n * 405 InvalidHardwareGenerationValue - HardwareGeneration {0} is not valid. Please specify a valid HardwareGeneration value.\n\n * 405 InvalidStorageSizeValue - \"Invalid storage size: {0} GB. Storage size must be specified between {1} and {2} gigabytes, in increments of {3} GB.\n\n * 409 DistributedAvailabilityGroupDbEncryptedWithSmk - Managed database cannot be replicated from Managed Instance to SQL Server, as this managed database is encrypted with service managed key. Either decrypt the database on Managed Instance, or switch the encryption service protector to customer-managed (BYOK) and try again.\n\n * 409 DistributedAvailabilityGroupDbCannotBeEncryptedWhenPrimaryInMiLink - Database cannot be encrypted using the service managed key as it is being replicated from Managed Instance to SQL Server. Switch the encryption protector from service managed to customer managed (BYOK) on Managed Instance and ensure the encryption key from Managed Instance is imported on SQL Server.\n\n * 409 DistributedAvailabilityGroupProtectorCannotBeUpdtedToSmk - Switching the encryption protector from customer managed (BYOK) to service managed is not allowed as there exists database replication from Managed Instance to SQL Server supporting customer managed encryption only.\n\n * 409 DistributedAvailabilityGroupMiPrimaryWithGeodr - Database cannot be replicated from Managed Instance to SQL Server as there already exists database geo-replication from this Managed Instance to another Managed Instance using auto-failover groups. Disconnect this Managed Instance from the failover group, and try again.\n\n * 409 DistributedAvailabilityGroupFailoverSecondariesNotSynchronizing - Planned failover cannot be executed if secondaries are not synchronizing.\n\n * 409 DistributedAvailabilityGroupSetRoleInstanceAlreadyInRequestedRole - User attempted to perform setRole operation while managed instance link is already in requested role.\n\n * 409 DistributedAvailabilityGroupFailoverLogSendQueueSizeTooBig - Planned failover cannot be executed if send queue is too large.\n\n * 409 DistributedAvailabilityGroupFailoverRedoQueueSizeTooBig - Planned failover cannot be executed if redo queue is too large on secondary.\n\n * 409 DistributedAvailabilityGroupSetRoleChangeRoleAlreadyInProgress - Changing the server role cannot be executed at this time as there exist a previous role change in progress on Azure SQL Managed Instance. Only when the previous role change completes, a new request could be submitted. Please wait for the previous role change to complete and retry again.\n\n * 409 DistributedAvailabilityGroupSetRoleFailed - Setting the role has failed due to an unknown reason. Please check the error log file. If the issue persists, contact Azure support.\n\n * 409 DistributedAvailabilityGroupSetRolePrimaryPlannedNotSupported - User attempted to perform setRole operation to primary in planned fashion and that is not supported.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 409 ServerOverridePreconditionFailed - Failed to apply server override on category '{0}', because physical db or instance '{1}' in server '{2}' is currently not in 'Ready' or 'Deactivated' state.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ManagedInstanceIsBusy - The server '{0}' is currently busy. Please wait a few minutes before trying again.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 GatewayInternalServerError - The server encountered an unexpected exception.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 InvalidDistributedAvailabilityGroupFailoverRequest - Distributed Availability Group Failover request body is empty or invalid.\n\n * 400 InvalidDistributedAvailabilityGroupFailoverInstanceRole - Planned failover can be executed on a link in the primary role only. Current state of the specified link is secondary.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidDnsZone - The operation has failed because you are attempting to deploy managed instance as a geo-replication secondary to the subnet {0} in which there already exists a managed instance. Deploying managed instance as a geo-replication secondary is supported only in cases when managed instance is the first instance deployed in a subnet. Consider deploying managed instance as a geo-replication secondary to a different subnet in which there are no existing managed instances, or if deploying to a subnet with existing managed instance disable the geo-replication option.\n\n * 400 HkCannotSwitchToInactive - The database cannot proceed with pricing-tier update as it has memory-optimized objects. Please drop such objects and try again.\n\n * 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - Invalid storage size: Storage size limit ({0} GB) is less that current storage used ({1} GB). Please specify higher storage size limit.\n\n * 400 InstanceTimezoneUpdateNotSupported - Instance timezone update not supported.\n\n * 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - Create Managed Instance with non-default timezone not supported.\n\n * 400 ManagedInstanceIpAddressRangeLimit - Cannot perform creation/scaling of the managed instance as there are not enough available IP addresses in the subnet for performing the operation.\n\n * 400 VnetDelegationNotAllowed - User tried to inject Managed Server to subnet which is delegated.\n\n * 400 SubnetHasResourcesOfDifferentType - User tried to create MI in subnet that has resources of different type.\n\n * 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - Update of Managed Instance with maintenance window settings is not allowed.\n\n * 400 OperationNotAllowedInCurrentGeodrConfiguration - The operation is not allowed because the current geo-replication configuration does not allow this combination of {0}. Change the setting on the geo-replication partner before applying the change on this instance.\n\n * 400 VnetPrepareNIPFailed - User tried to prepare subnet that has a conflict with NetworkIntentPolicy.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 ManagedInstanceDeprecatedHardwareFamily - Changing the hardware generation to deprecated {0} generation is not possible.\n\n * 400 ManagedInstanceBackupStorageTypeNotSupported - Backup storage type parameter is not allowed in the instance update operation.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 EmptyPDCInvalidDnsZone - This managed instance cannot be deployed because its DNS-zone does not match the DNS-prefix of its intended virtual cluster for subnet {0}. Although this virtual cluster is empty, its DNS-prefix cannot be changed. Empty virtual clusters will be automatically removed after several hours. Consider waiting for this virtual cluster to expire or manually deleting this virtual cluster and then creating the managed instance.\n\n * 400 InstancePoolNotEnoughCapacity - An instance pool does not have enough capacity\n\n * 400 ManagedInstanceFreemiumNotAvailableForInputParameters - Managed instance creation or update executed with SLO that is not allowed for freemium.\n\n * 400 ManagedInstanceFreemiumNotAvailableOnRegion - Creation of a freemium managed instance on a region that is not allowlisted for freemium.\n\n * 400 ManagementServiceSubnetMaintenanceInProgress - User tried to initiate managed instance create/update while incompatible maintenance is in progress.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ManagedInstanceFreemiumNotAvailableForSubscription - Freemium is not enabled for this subscription type.\n\n * 400 ManagedInstanceInvalidEditionForInstancePool - User tried to select invalid service tier for managed instance inside an existing instance pool.\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 ManagedInstanceInvalidSubnetForInstancePool - User tried to select invalid subnet for managed instance inside an existing instance pool.\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 ManagedInstanceZoneRedudantFeatureNotSupported - ZoneRedundant feature is not supported for the selected service tier. For more details visit aka.ms/sqlmi-service-tier-characteristics.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - Enabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - Disabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SubnetIdCantBeUpdated - Changing managed instance subnet is not supported operation. Please remove this parameter from the request.\n\n * 400 MigrationToAnotherVNetNotSupported - Selected subnet is in another Virtual Network. Moving managed instance to another Virtual Network is not possible. Please provide subnet from Virtual Network {0}.\n\n * 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - Provided subnet is having different DNS zone from the current. Changing instance DNS zone is not supported. Please provide subnet with same DNS zone, create a new subnet or provide empty one.\n\n * 400 MigrationToGen4SubnetNotSupported - It is not possible to update subnet while running on Gen4 hardware as it is being deprecated. Please upgrade your hardware from Gen4 to Gen5 as part of the changing managed instance subnet operation by specifying both parameters at the same time: destination subnet and hardware generation.\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - The operation could not be completed because some of the database files are exceeding maximum General Purpose file size limit of {0} GB.\n\n * 400 CloudLifterUnsupportedFeature - The functionality is not available on the Managed Instance at this time.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 OperationCanNotStartDueToMiLink - The '{0}' operation cannot be completed as there exists a database in a process of creation through Managed Instance link. Please wait for the link creation to complete, or delete the link, and retry the operation again.\n\n * 400 ManagedInstanceSloUpdateFailed - SLO '{0}' operation cannot succeed as the memory usage of '{1}' exceeds the quota.\n\n * 400 SourceAndTargetSubnetsMustBeVnetPeered - Subnet currently used by managed instance and provided destination subnet are part of the virtual networks that are not connected with virtual network peering, or have peering established but don't have allowed traffic. In order to move managed instance from one subnet to another, virtual network peering needs to be established from both source and target virtual network. Please configure virtual network requirements and then try the operation again. Learn more https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks. \n\n * 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - Subnet provided for managed instance deployment is located on subscription different than the one submitted for managed instance. Managed instance and subnet used for deploying the instance must be on the same subscription. Please provide another subnet or switch to the subnet subscription and then try the operation again.\n\n * 400 CreateManagedInstanceInvalidSubnetSize - User attempted to create managed instance in a subnet that is smaller than the allowed minimal subnet size.\n\n * 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - Subnet selected for managed instance migration has address range that overlaps with address range of subnet that holds geo replicated secondary instance. Please verify that your subnet is configured according to guidelines in https://aka.ms/move-managed-instance. \n\n * 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - Subnet selected for managed instance migration is not configured to enable communication with a geo replicated secondary instance. Please check if all of the required ports are open. To properly configure your subnet read the guidelines in https://aka.ms/move-managed-instance. \n\n * 400 ManagedInstanceLocalStorageUpdateSloDisabled - Update SLO for managed instances with local storage is not supported yet.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 GatewayInvalidEdition - '{0}' is not a valid database edition in this version of SQL Server.\n\n * 400 ManagedInstanceInvalidHardwareFamilyForInstancePool - User tried to select invalid hardware family for managed instance inside an existing instance pool.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 ManagedInstanceInvalidLicenseTypeForInstancePool - User tried to select invalid license type for managed instance inside an existing instance pool.\n\n * 400 ManagedInstanceUpdateSloFromVersionlessToVersionedNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 ManagedInstanceUpdateSloFromNewerToOlderVersionEditionNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 ManagedInstanceUpdateSloFromVersionedToVersionlessWorkerCLNotAllowed - Changing the database format is not supported for this managed instance. Check the database format property value specified and visit https://aka.ms/sqlmi-fwnov2022 for more details.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 ManagedInstanceVersionEditionParameterNotAllowedForUsing - Specifying the database format property value is not supported at this time.\n\n * 400 ManagedInstanceFreemiumInvalidArchitecture - A freemium instance can not be created in the specified subnet '(0)'.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ManagedInstanceWithGeoDRMoveToInstancePoolNotAllowed - Customer has attempted to move a standalone Managed Instance with an existing auto-failover group configured into an instance pool, which is not supported. Only standalone instances without existing auto-failover groups configured can be moved to instance pools.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerRegion - Creation of ZoneRedundant SQL MI is temporarily disabled on this region. You can create Zone Redundant SQL Managed Instances in many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerHardwareGeneration - Creation of ZoneRedundant SQL MI is temporarily disabled for this hardware generation on this region. You can create Zone Redundant SQL Managed Instances with different hardware generation on this region or many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceUpdateSloGeoPrimaryWithNewerVersionEditionThanSecondary - Database format change must be performed on the secondary instance of the failover group first. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 ManagedInstanceFreemiumInstanceAlreadyExists - Only one free SQL Managed Instance is allowed per subscription.\n\n * 400 ManagementServiceGeodrSecondaryDatabaseInCreation - The '{0}' operation cannot be completed as there exists a database in a process of creation through failover group deployment. Please wait for the failover group deployment to complete, or alternatively delete the failover group and retry the operation again.\n\n * 400 ManagedInstanceConversionRegularToFreemiumNotAllowed - User tried converting a Regular SQL Managed Instance to Free SQL Managed Instance.\n\n * 400 ManagedInstanceConversionFreemiumToRegularAndUpdateSLOWhileStoppedNotAllowed - User tried converting a Free SQL Managed Instance to Regular SQL Managed Instance and Update SLO in same request, while Instance is stopped.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 ManagedInstanceMaintenanceWindowChangeNotAllowedWhenInInstancePool - Maintenance window is set at instance pool level and cannot be set individually per pooled instance.\n\n * 400 ManagedInstanceMoveToInstancePoolExceedsDbCountLimit - Cannot move the instance into the pool due to pool database count limit.\n\n * 400 ManagedInstancePoolZoneRedundancyNotSupported - Cannot move a zone-redundant instance into the pool as zone-redundancy is not supported in pools.\n\n * 400 DeploymentIntoPrivateSubnetsNotAllowed - Deploying managed instances and instance pools into private subnets is not supported.\n\n * 400 StorageIOpsNotSupported - Storage IOps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidCollation - Invalid collation.\n\n * 400 StorageThroughputMBpsNotSupported - Storage throughput MBps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 StorageIOpsNotSupportedForSpecifiedEdition - Storage IOps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 StorageThroughputMBpsNotSupportedForSpecifiedEdition - Storage throughput MBps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 ManagedInstanceClassicVnetNotSupported - Managed Instance cannot be joined to a classic virtual network.\n\n * 400 AlterDbDeactivatedNotSupported - Database Operation failed for Server '{0}', Database '{1}' due to unexpected delay. Please try again.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetConfigHasNsg - User tried to inject Managed Server subnet with Network Security Groups.\n\n * 400 VnetConfigHasNoUdr - User tried to inject Managed Server subnet without default User Defined Route Table.\n\n * 400 VnetConfigHasInvalidUdr - User tried to inject Managed Server subnet with invalid User Defined Route Table.\n\n * 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.\n\n * 400 VnetConfigHasServiceEndpoints - User tried to inject Managed Server subnet with service endpoints.\n\n * 400 VnetSubnetIsInUse - User tried to inject Managed Server subnet that is not empty.\n\n * 400 VnetSubnetIsLocked - User tried to inject Managed Server subnet that is in locked scope.\n\n * 400 VnetSubnetIsGateway - User tried to inject Managed Server subnet that is Gateway subnet.\n\n * 400 VnetSubnetIsUnknown - User tried to inject Managed Server subnet that does not exist.\n\n * 400 VnetSubnetConflictWithIntendedPolicy - User tried to inject Managed Server subnet that has a conflict with IntendedPolicy.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 ManagedInstanceInvalidEditionForSku - The specified edition {0} is not consistent with the specified SKU {1}.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInCreateOfMI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the create operation.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagedInstanceInvalidLicenseType - The specified license type {0} is not valid.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInUpdateOfGPV1MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V1 Managed Instance.\n\n * 400 UnspecifiedTargetEditionAndFalseGPV2NotAllowedInUpdateOfGPV2MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value FALSE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 GPTargetEditionAndUnspecifiedGPV2NotAllowedInUpdateOFGPV2MI - Combination of General Purpose target edition (sku.name/sku.tier parameters) and unspecified value for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 BCTargetEditionAndSpecifiedGPV2ParamNotAllowedInCreateUpdateOfMI - Combination of Business Critical target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the create/update operation.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 UnspecifiedTargetEditionAndSpecifiedGPV2ParamNotAllowedInUpdateOfBCMI - Combination of unspecified target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the update operation of Business Critical Managed Instance.\n\n * 400 TotalMemoryMBNotSupported - Total memory MB parameter is not allowed in the instance create/update operation.\n\n * 400 TotalMemoryMBNotSupportedForSpecifiedEdition - Total memory MB parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 VnetResourceNotFound - Resource not found: '{0}'.\n\n * 400 InvalidTimezone - Invalid timezone.\n\n * 400 InvalidSubnetForGPV2Edition - General Purpose v2 edition of Managed Instance is not compatible with the specified subnet. Target subnet must be either empty, or all instances in it must run with November 2022 Feature Wave.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 TotalMemoryMBInvalidLimit - Total memory MB parameter has been set to an invalid limit.\n\n * 400 ManagedInstanceUpdateSloGPv2PerDatabaseFileLimitExceeded - The operation could not be completed because there is at least one database whose number of files is exceeding the limit of {0} files per database on General Purpose v2 edition.\n\n * 400 InstanceCollationUpdateNotSupported - User cannot change instance collation on Managed Instance.\n\n * 400 NextGenGPNotSupportedForCmwCustomers - Next-Gen General Purpose edition of Managed Instance does not support Custom Maintance Window.\n\n * 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - User can create a Managed Instance only with collation 'SQL_Latin1_General_CP1_CI_AS'.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedInstanceExceedMaxAzureStorage - The operation could not be completed because total allocated storage size for General Purpose instance would exceed {0}. Please reduce the number of database files and retry operation.\n\n * 400 ManagedInstanceHasGeoReplica - The operation could not be completed because instance has configured geo replicated secondary instance.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 StorageAccountFull - Managed Instance has reached the total capacity of underlying Azure storage account. Azure Premium Storage account is limited to 35TB of allocated space.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 ManagedInstanceRestoreToInstanceWithOlderVersionEdition - Restore operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 405 InvalidStorageIOpsLimitValue - Invalid storage IOps limit: {0} IOps. Storage IOps limit must be specified between {1} IOps and {2} IOps, in increments of {3} IOps.\n\n * 405 InvalidStorageThroughputMBpsLimitValue - Invalid storage throughput limit: {0} MBps. Storage throughput limit must be specified between {1} MBps and {2} MBps, in increments of {3} MBps.\n\n * 405 InvalidVcoreValue - vCore value {0} is not valid. Please specify a valid vCore value.\n\n * 405 InvalidHardwareGenerationValue - HardwareGeneration {0} is not valid. Please specify a valid HardwareGeneration value.\n\n * 405 InvalidStorageSizeValue - \"Invalid storage size: {0} GB. Storage size must be specified between {1} and {2} gigabytes, in increments of {3} GB.\n\n * 409 DistributedAvailabilityGroupDbEncryptedWithSmk - Managed database cannot be replicated from Managed Instance to SQL Server, as this managed database is encrypted with service managed key. Either decrypt the database on Managed Instance, or switch the encryption service protector to customer-managed (BYOK) and try again.\n\n * 409 DistributedAvailabilityGroupDbCannotBeEncryptedWhenPrimaryInMiLink - Database cannot be encrypted using the service managed key as it is being replicated from Managed Instance to SQL Server. Switch the encryption protector from service managed to customer managed (BYOK) on Managed Instance and ensure the encryption key from Managed Instance is imported on SQL Server.\n\n * 409 DistributedAvailabilityGroupProtectorCannotBeUpdtedToSmk - Switching the encryption protector from customer managed (BYOK) to service managed is not allowed as there exists database replication from Managed Instance to SQL Server supporting customer managed encryption only.\n\n * 409 DistributedAvailabilityGroupMiPrimaryWithGeodr - Database cannot be replicated from Managed Instance to SQL Server as there already exists database geo-replication from this Managed Instance to another Managed Instance using auto-failover groups. Disconnect this Managed Instance from the failover group, and try again.\n\n * 409 DistributedAvailabilityGroupFailoverSecondariesNotSynchronizing - Planned failover cannot be executed if secondaries are not synchronizing.\n\n * 409 DistributedAvailabilityGroupSetRoleInstanceAlreadyInRequestedRole - User attempted to perform setRole operation while managed instance link is already in requested role.\n\n * 409 DistributedAvailabilityGroupFailoverLogSendQueueSizeTooBig - Planned failover cannot be executed if send queue is too large.\n\n * 409 DistributedAvailabilityGroupFailoverRedoQueueSizeTooBig - Planned failover cannot be executed if redo queue is too large on secondary.\n\n * 409 DistributedAvailabilityGroupSetRoleChangeRoleAlreadyInProgress - Changing the server role cannot be executed at this time as there exist a previous role change in progress on Azure SQL Managed Instance. Only when the previous role change completes, a new request could be submitted. Please wait for the previous role change to complete and retry again.\n\n * 409 DistributedAvailabilityGroupSetRoleFailed - Setting the role has failed due to an unknown reason. Please check the error log file. If the issue persists, contact Azure support.\n\n * 409 DistributedAvailabilityGroupSetRolePrimaryPlannedNotSupported - User attempted to perform setRole operation to primary in planned fashion and that is not supported.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 409 ServerOverridePreconditionFailed - Failed to apply server override on category '{0}', because physical db or instance '{1}' in server '{2}' is currently not in 'Ready' or 'Deactivated' state.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ManagedInstanceIsBusy - The server '{0}' is currently busy. Please wait a few minutes before trying again.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 GatewayInternalServerError - The server encountered an unexpected exception.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ElasticPools.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ElasticPools.json index 00eddacb862c..592116fe09e3 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ElasticPools.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ElasticPools.json @@ -53,7 +53,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 ElasticPoolScaleNotSupportedWithInaccessibleDatabases - The elastic pool contains inaccessible databases which have lost Azure Key Vault access required for TDE configuration. Please move the accessible databases to a different pool for scaling or restore the lost Azure Key Vault access for the inaccessible databases.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerQuotaExceeded - The server reached its limit for allowed Database Throughput Unit.\n\n * 400 SubscriptionVcoreQuotaExceeded - Could not perform the operation because subscription would exceed the allowed vCore quota.\n\n * 400 ElasticPoolAlreadyExists - The server already contains an elastic pool with the specified name.\n\n * 400 InvalidInputValueForEdition - Specified edition is not supported for elastic pool provisioning.\n\n * 400 ElasticPoolDtuBelowLimit - The requested DTU value is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDtuAboveLimit - The requested DTU value is too high for the requested elastic pool service tier.\n\n * 400 InvalidMaxSize - Invalid max size.\n\n * 400 ElasticPoolDbDtuMaxBelowLimit - The requested per database DTU max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbDtuMaxAboveLimit - The requested per database DTU max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseDtuMax - Attempting to set the DTU max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbDtuMinAboveLimit - The requested DTU min per database is too high for the requested service tier.\n\n * 400 ElasticPoolOverStorage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidInputValueForDatabaseDtuMin - Attempting to set the DTU min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 ElasticPoolDtuUnsupported - User tried to create or update an elastic pool with a DTU capacity that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolsNotEnabled - Elastic pools have not been enabled in this region.\n\n * 400 ElasticPoolNotEmpty - Request to delete an elastic pool that is not empty.\n\n * 400 ElasticPoolStorageBelowLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedGB - Attempting to set the elastic pool storage limit in gb which doesn't match the allowed values.\n\n * 400 ElasticPoolDatabaseLimit - The elastic pool has reached its limit for number of databases.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 InvalidInputValueDatabaseDtuMinLargerThanMax - Attempting to set the DTU min per database higher than the DTU max per database.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 ElasticPoolStorageBelowLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 ElasticPoolCapacityStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 ElasticPoolUpdateHkNotAllowed - The elastic pool cannot lower its service tier from Premium to Standard or Basic since one or more of its databases use memory-optimized objects.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 HSElasticPoolUpdateSloPRMSNotSupported - The service objective assignment for the database has failed. Please contact Microsoft customer support and provide the server name, database name and activity ID.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 ElasticPoolDbDtuMinBelowLimit - The requested per database DTU min is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxBelowLimit - The requested per database VCore max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxAboveLimit - The requested per database VCore max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMax - Attempting to set the VCore max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbVcoreMinBelowLimit - The requested per database VCore min is too low for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMin - Attempting to set the VCore min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 PartnerDBNotCompatibleForSGXEnclave - Attempt to set GeoDR link or update SLO for enclave enabled database is only supported when both database are running on DC-series hardware.\n\n * 400 InvalidInputValueDatabaseVcoreMinLargerThanMax - Attempting to set the VCore min per database higher than the VCore max per database.\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 CapacityGroupThresholdExceeded - Requested service level objective and storage size maps to specific capacity group and currently resources for this capacity group has reach threshold and further actions need sto be taken before more database can be placed in those rings.\n\n * 400 CapacityGroupThresholdCheckFail - Capacity group resource constraint check failed thus unable to verify whether enough capacity exist to complete the operation.\n\n * 400 InvalidPublicMaintenanceConfiguration - User tried to specify public maintenance configuration which cannot be converted to internal id (malformed or wrong region).\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ElasticPoolNotFound - The specified elastic pool does not exist for the specified server.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 ElasticPoolUpdateLinksNotInCatchup - Cannot update elastic pool while one of its databases is performing a copy or geo-replication failover operation.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 ElasticPoolFailedMoveDbToElasticPool - Failed to move the database into elastic pool due to internal resource constraints. This may be a transient condition, please retry.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 ElasticPoolScaleNotSupportedWithInaccessibleDatabases - The elastic pool contains inaccessible databases which have lost Azure Key Vault access required for TDE configuration. Please move the accessible databases to a different pool for scaling or restore the lost Azure Key Vault access for the inaccessible databases.\n\n * 400 CreateElasticPoolAttemptedWhenKeyRotationInProgress - The create elastic pool operation cannot be performed at this time due to ongoing Transparent Data Encryption (TDE) key rotation on the server. Please try the operation again later.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerQuotaExceeded - The server reached its limit for allowed Database Throughput Unit.\n\n * 400 SubscriptionVcoreQuotaExceeded - Could not perform the operation because subscription would exceed the allowed vCore quota.\n\n * 400 ElasticPoolAlreadyExists - The server already contains an elastic pool with the specified name.\n\n * 400 InvalidInputValueForEdition - Specified edition is not supported for elastic pool provisioning.\n\n * 400 ElasticPoolDtuBelowLimit - The requested DTU value is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDtuAboveLimit - The requested DTU value is too high for the requested elastic pool service tier.\n\n * 400 InvalidMaxSize - Invalid max size.\n\n * 400 ElasticPoolDbDtuMaxBelowLimit - The requested per database DTU max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbDtuMaxAboveLimit - The requested per database DTU max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseDtuMax - Attempting to set the DTU max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbDtuMinAboveLimit - The requested DTU min per database is too high for the requested service tier.\n\n * 400 ElasticPoolOverStorage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidInputValueForDatabaseDtuMin - Attempting to set the DTU min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 ElasticPoolDtuUnsupported - User tried to create or update an elastic pool with a DTU capacity that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolsNotEnabled - Elastic pools have not been enabled in this region.\n\n * 400 ElasticPoolNotEmpty - Request to delete an elastic pool that is not empty.\n\n * 400 ElasticPoolStorageBelowLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedGB - Attempting to set the elastic pool storage limit in gb which doesn't match the allowed values.\n\n * 400 ElasticPoolDatabaseLimit - The elastic pool has reached its limit for number of databases.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 InvalidInputValueDatabaseDtuMinLargerThanMax - Attempting to set the DTU min per database higher than the DTU max per database.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 ElasticPoolStorageBelowLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 ElasticPoolCapacityStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 ElasticPoolUpdateHkNotAllowed - The elastic pool cannot lower its service tier from Premium to Standard or Basic since one or more of its databases use memory-optimized objects.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 HSElasticPoolUpdateSloPRMSNotSupported - The service objective assignment for the database has failed. Please contact Microsoft customer support and provide the server name, database name and activity ID.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 ElasticPoolDbDtuMinBelowLimit - The requested per database DTU min is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxBelowLimit - The requested per database VCore max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxAboveLimit - The requested per database VCore max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMax - Attempting to set the VCore max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbVcoreMinBelowLimit - The requested per database VCore min is too low for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMin - Attempting to set the VCore min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 PartnerDBNotCompatibleForSGXEnclave - Attempt to set GeoDR link or update SLO for enclave enabled database is only supported when both database are running on DC-series hardware.\n\n * 400 InvalidInputValueDatabaseVcoreMinLargerThanMax - Attempting to set the VCore min per database higher than the VCore max per database.\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 CapacityGroupThresholdExceeded - Requested service level objective and storage size maps to specific capacity group and currently resources for this capacity group has reach threshold and further actions need sto be taken before more database can be placed in those rings.\n\n * 400 CapacityGroupThresholdCheckFail - Capacity group resource constraint check failed thus unable to verify whether enough capacity exist to complete the operation.\n\n * 400 InvalidPublicMaintenanceConfiguration - User tried to specify public maintenance configuration which cannot be converted to internal id (malformed or wrong region).\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ElasticPoolNotFound - The specified elastic pool does not exist for the specified server.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 ElasticPoolUpdateLinksNotInCatchup - Cannot update elastic pool while one of its databases is performing a copy or geo-replication failover operation.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 ElasticPoolFailedMoveDbToElasticPool - Failed to move the database into elastic pool due to internal resource constraints. This may be a transient condition, please retry.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -105,7 +105,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 ElasticPoolScaleNotSupportedWithInaccessibleDatabases - The elastic pool contains inaccessible databases which have lost Azure Key Vault access required for TDE configuration. Please move the accessible databases to a different pool for scaling or restore the lost Azure Key Vault access for the inaccessible databases.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerQuotaExceeded - The server reached its limit for allowed Database Throughput Unit.\n\n * 400 SubscriptionVcoreQuotaExceeded - Could not perform the operation because subscription would exceed the allowed vCore quota.\n\n * 400 ElasticPoolAlreadyExists - The server already contains an elastic pool with the specified name.\n\n * 400 InvalidInputValueForEdition - Specified edition is not supported for elastic pool provisioning.\n\n * 400 ElasticPoolDtuBelowLimit - The requested DTU value is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDtuAboveLimit - The requested DTU value is too high for the requested elastic pool service tier.\n\n * 400 InvalidMaxSize - Invalid max size.\n\n * 400 ElasticPoolDbDtuMaxBelowLimit - The requested per database DTU max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbDtuMaxAboveLimit - The requested per database DTU max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseDtuMax - Attempting to set the DTU max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbDtuMinAboveLimit - The requested DTU min per database is too high for the requested service tier.\n\n * 400 ElasticPoolOverStorage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidInputValueForDatabaseDtuMin - Attempting to set the DTU min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 ElasticPoolDtuUnsupported - User tried to create or update an elastic pool with a DTU capacity that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolsNotEnabled - Elastic pools have not been enabled in this region.\n\n * 400 ElasticPoolNotEmpty - Request to delete an elastic pool that is not empty.\n\n * 400 ElasticPoolStorageBelowLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedGB - Attempting to set the elastic pool storage limit in gb which doesn't match the allowed values.\n\n * 400 ElasticPoolDatabaseLimit - The elastic pool has reached its limit for number of databases.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 InvalidInputValueDatabaseDtuMinLargerThanMax - Attempting to set the DTU min per database higher than the DTU max per database.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 ElasticPoolStorageBelowLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 ElasticPoolCapacityStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 ElasticPoolUpdateHkNotAllowed - The elastic pool cannot lower its service tier from Premium to Standard or Basic since one or more of its databases use memory-optimized objects.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 HSElasticPoolUpdateSloPRMSNotSupported - The service objective assignment for the database has failed. Please contact Microsoft customer support and provide the server name, database name and activity ID.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 ElasticPoolDbDtuMinBelowLimit - The requested per database DTU min is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxBelowLimit - The requested per database VCore max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxAboveLimit - The requested per database VCore max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMax - Attempting to set the VCore max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbVcoreMinBelowLimit - The requested per database VCore min is too low for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMin - Attempting to set the VCore min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 PartnerDBNotCompatibleForSGXEnclave - Attempt to set GeoDR link or update SLO for enclave enabled database is only supported when both database are running on DC-series hardware.\n\n * 400 InvalidInputValueDatabaseVcoreMinLargerThanMax - Attempting to set the VCore min per database higher than the VCore max per database.\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 CapacityGroupThresholdExceeded - Requested service level objective and storage size maps to specific capacity group and currently resources for this capacity group has reach threshold and further actions need sto be taken before more database can be placed in those rings.\n\n * 400 CapacityGroupThresholdCheckFail - Capacity group resource constraint check failed thus unable to verify whether enough capacity exist to complete the operation.\n\n * 400 InvalidPublicMaintenanceConfiguration - User tried to specify public maintenance configuration which cannot be converted to internal id (malformed or wrong region).\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ElasticPoolNotFound - The specified elastic pool does not exist for the specified server.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 ElasticPoolUpdateLinksNotInCatchup - Cannot update elastic pool while one of its databases is performing a copy or geo-replication failover operation.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 ElasticPoolFailedMoveDbToElasticPool - Failed to move the database into elastic pool due to internal resource constraints. This may be a transient condition, please retry.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 ElasticPoolScaleNotSupportedWithInaccessibleDatabases - The elastic pool contains inaccessible databases which have lost Azure Key Vault access required for TDE configuration. Please move the accessible databases to a different pool for scaling or restore the lost Azure Key Vault access for the inaccessible databases.\n\n * 400 CreateElasticPoolAttemptedWhenKeyRotationInProgress - The create elastic pool operation cannot be performed at this time due to ongoing Transparent Data Encryption (TDE) key rotation on the server. Please try the operation again later.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerQuotaExceeded - The server reached its limit for allowed Database Throughput Unit.\n\n * 400 SubscriptionVcoreQuotaExceeded - Could not perform the operation because subscription would exceed the allowed vCore quota.\n\n * 400 ElasticPoolAlreadyExists - The server already contains an elastic pool with the specified name.\n\n * 400 InvalidInputValueForEdition - Specified edition is not supported for elastic pool provisioning.\n\n * 400 ElasticPoolDtuBelowLimit - The requested DTU value is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDtuAboveLimit - The requested DTU value is too high for the requested elastic pool service tier.\n\n * 400 InvalidMaxSize - Invalid max size.\n\n * 400 ElasticPoolDbDtuMaxBelowLimit - The requested per database DTU max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbDtuMaxAboveLimit - The requested per database DTU max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseDtuMax - Attempting to set the DTU max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbDtuMinAboveLimit - The requested DTU min per database is too high for the requested service tier.\n\n * 400 ElasticPoolOverStorage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidInputValueForDatabaseDtuMin - Attempting to set the DTU min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 ElasticPoolDtuUnsupported - User tried to create or update an elastic pool with a DTU capacity that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolsNotEnabled - Elastic pools have not been enabled in this region.\n\n * 400 ElasticPoolNotEmpty - Request to delete an elastic pool that is not empty.\n\n * 400 ElasticPoolStorageBelowLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedGB - Attempting to set the elastic pool storage limit in gb which doesn't match the allowed values.\n\n * 400 ElasticPoolDatabaseLimit - The elastic pool has reached its limit for number of databases.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 InvalidInputValueDatabaseDtuMinLargerThanMax - Attempting to set the DTU min per database higher than the DTU max per database.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 ElasticPoolStorageBelowLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 ElasticPoolCapacityStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 ElasticPoolUpdateHkNotAllowed - The elastic pool cannot lower its service tier from Premium to Standard or Basic since one or more of its databases use memory-optimized objects.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 HSElasticPoolUpdateSloPRMSNotSupported - The service objective assignment for the database has failed. Please contact Microsoft customer support and provide the server name, database name and activity ID.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 ElasticPoolDbDtuMinBelowLimit - The requested per database DTU min is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxBelowLimit - The requested per database VCore max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxAboveLimit - The requested per database VCore max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMax - Attempting to set the VCore max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbVcoreMinBelowLimit - The requested per database VCore min is too low for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMin - Attempting to set the VCore min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 PartnerDBNotCompatibleForSGXEnclave - Attempt to set GeoDR link or update SLO for enclave enabled database is only supported when both database are running on DC-series hardware.\n\n * 400 InvalidInputValueDatabaseVcoreMinLargerThanMax - Attempting to set the VCore min per database higher than the VCore max per database.\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 CapacityGroupThresholdExceeded - Requested service level objective and storage size maps to specific capacity group and currently resources for this capacity group has reach threshold and further actions need sto be taken before more database can be placed in those rings.\n\n * 400 CapacityGroupThresholdCheckFail - Capacity group resource constraint check failed thus unable to verify whether enough capacity exist to complete the operation.\n\n * 400 InvalidPublicMaintenanceConfiguration - User tried to specify public maintenance configuration which cannot be converted to internal id (malformed or wrong region).\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ElasticPoolNotFound - The specified elastic pool does not exist for the specified server.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 ElasticPoolUpdateLinksNotInCatchup - Cannot update elastic pool while one of its databases is performing a copy or geo-replication failover operation.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 ElasticPoolFailedMoveDbToElasticPool - Failed to move the database into elastic pool due to internal resource constraints. This may be a transient condition, please retry.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -173,13 +173,18 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 ElasticPoolScaleNotSupportedWithInaccessibleDatabases - The elastic pool contains inaccessible databases which have lost Azure Key Vault access required for TDE configuration. Please move the accessible databases to a different pool for scaling or restore the lost Azure Key Vault access for the inaccessible databases.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerQuotaExceeded - The server reached its limit for allowed Database Throughput Unit.\n\n * 400 SubscriptionVcoreQuotaExceeded - Could not perform the operation because subscription would exceed the allowed vCore quota.\n\n * 400 ElasticPoolAlreadyExists - The server already contains an elastic pool with the specified name.\n\n * 400 InvalidInputValueForEdition - Specified edition is not supported for elastic pool provisioning.\n\n * 400 ElasticPoolDtuBelowLimit - The requested DTU value is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDtuAboveLimit - The requested DTU value is too high for the requested elastic pool service tier.\n\n * 400 InvalidMaxSize - Invalid max size.\n\n * 400 ElasticPoolDbDtuMaxBelowLimit - The requested per database DTU max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbDtuMaxAboveLimit - The requested per database DTU max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseDtuMax - Attempting to set the DTU max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbDtuMinAboveLimit - The requested DTU min per database is too high for the requested service tier.\n\n * 400 ElasticPoolOverStorage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidInputValueForDatabaseDtuMin - Attempting to set the DTU min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 ElasticPoolDtuUnsupported - User tried to create or update an elastic pool with a DTU capacity that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolsNotEnabled - Elastic pools have not been enabled in this region.\n\n * 400 ElasticPoolNotEmpty - Request to delete an elastic pool that is not empty.\n\n * 400 ElasticPoolStorageBelowLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedGB - Attempting to set the elastic pool storage limit in gb which doesn't match the allowed values.\n\n * 400 ElasticPoolDatabaseLimit - The elastic pool has reached its limit for number of databases.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 InvalidInputValueDatabaseDtuMinLargerThanMax - Attempting to set the DTU min per database higher than the DTU max per database.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 ElasticPoolStorageBelowLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 ElasticPoolCapacityStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 ElasticPoolUpdateHkNotAllowed - The elastic pool cannot lower its service tier from Premium to Standard or Basic since one or more of its databases use memory-optimized objects.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 HSElasticPoolUpdateSloPRMSNotSupported - The service objective assignment for the database has failed. Please contact Microsoft customer support and provide the server name, database name and activity ID.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 ElasticPoolDbDtuMinBelowLimit - The requested per database DTU min is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxBelowLimit - The requested per database VCore max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxAboveLimit - The requested per database VCore max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMax - Attempting to set the VCore max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbVcoreMinBelowLimit - The requested per database VCore min is too low for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMin - Attempting to set the VCore min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 PartnerDBNotCompatibleForSGXEnclave - Attempt to set GeoDR link or update SLO for enclave enabled database is only supported when both database are running on DC-series hardware.\n\n * 400 InvalidInputValueDatabaseVcoreMinLargerThanMax - Attempting to set the VCore min per database higher than the VCore max per database.\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 CapacityGroupThresholdExceeded - Requested service level objective and storage size maps to specific capacity group and currently resources for this capacity group has reach threshold and further actions need sto be taken before more database can be placed in those rings.\n\n * 400 CapacityGroupThresholdCheckFail - Capacity group resource constraint check failed thus unable to verify whether enough capacity exist to complete the operation.\n\n * 400 InvalidPublicMaintenanceConfiguration - User tried to specify public maintenance configuration which cannot be converted to internal id (malformed or wrong region).\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSkuName - Invalid SKU name.\n\n * 400 MismatchedSkuNameAndCapacity - Mismatch between SKU name and capacity.\n\n * 400 MismatchedSkuNameAndTier - Mismatch between SKU name and tier.\n\n * 400 MismatchedSkuNameAndFamily - Mismatch between SKU name and family.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 AvailabilityZoneNotSupported - Requested availability zones for databases and elastic pools is not valid.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 ElasticPoolScaleNotSupportedWithInaccessibleDatabases - The elastic pool contains inaccessible databases which have lost Azure Key Vault access required for TDE configuration. Please move the accessible databases to a different pool for scaling or restore the lost Azure Key Vault access for the inaccessible databases.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerQuotaExceeded - The server reached its limit for allowed Database Throughput Unit.\n\n * 400 SubscriptionVcoreQuotaExceeded - Could not perform the operation because subscription would exceed the allowed vCore quota.\n\n * 400 ElasticPoolAlreadyExists - The server already contains an elastic pool with the specified name.\n\n * 400 InvalidInputValueForEdition - Specified edition is not supported for elastic pool provisioning.\n\n * 400 ElasticPoolDtuBelowLimit - The requested DTU value is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDtuAboveLimit - The requested DTU value is too high for the requested elastic pool service tier.\n\n * 400 InvalidMaxSize - Invalid max size.\n\n * 400 ElasticPoolDbDtuMaxBelowLimit - The requested per database DTU max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbDtuMaxAboveLimit - The requested per database DTU max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseDtuMax - Attempting to set the DTU max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbDtuMinAboveLimit - The requested DTU min per database is too high for the requested service tier.\n\n * 400 ElasticPoolOverStorage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidInputValueForDatabaseDtuMin - Attempting to set the DTU min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 ElasticPoolDtuUnsupported - User tried to create or update an elastic pool with a DTU capacity that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolsNotEnabled - Elastic pools have not been enabled in this region.\n\n * 400 ElasticPoolNotEmpty - Request to delete an elastic pool that is not empty.\n\n * 400 ElasticPoolStorageBelowLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedGB - Attempting to set the elastic pool storage limit in gb which doesn't match the allowed values.\n\n * 400 ElasticPoolDatabaseLimit - The elastic pool has reached its limit for number of databases.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 InvalidInputValueDatabaseDtuMinLargerThanMax - Attempting to set the DTU min per database higher than the DTU max per database.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 ElasticPoolStorageBelowLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 ElasticPoolCapacityStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 ElasticPoolUpdateHkNotAllowed - The elastic pool cannot lower its service tier from Premium to Standard or Basic since one or more of its databases use memory-optimized objects.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 HSElasticPoolUpdateSloPRMSNotSupported - The service objective assignment for the database has failed. Please contact Microsoft customer support and provide the server name, database name and activity ID.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 ElasticPoolDbDtuMinBelowLimit - The requested per database DTU min is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxBelowLimit - The requested per database VCore max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxAboveLimit - The requested per database VCore max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMax - Attempting to set the VCore max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbVcoreMinBelowLimit - The requested per database VCore min is too low for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMin - Attempting to set the VCore min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 PartnerDBNotCompatibleForSGXEnclave - Attempt to set GeoDR link or update SLO for enclave enabled database is only supported when both database are running on DC-series hardware.\n\n * 400 InvalidInputValueDatabaseVcoreMinLargerThanMax - Attempting to set the VCore min per database higher than the VCore max per database.\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 CapacityGroupThresholdExceeded - Requested service level objective and storage size maps to specific capacity group and currently resources for this capacity group has reach threshold and further actions need sto be taken before more database can be placed in those rings.\n\n * 400 CapacityGroupThresholdCheckFail - Capacity group resource constraint check failed thus unable to verify whether enough capacity exist to complete the operation.\n\n * 400 InvalidPublicMaintenanceConfiguration - User tried to specify public maintenance configuration which cannot be converted to internal id (malformed or wrong region).\n\n * 400 VBSEnclaveResourcePoolInvalidCombination - Adding a database with '{0}' preferredEnclaveType to an elastic pool '{1}' with '{2}' preferredEnclaveType is not supported. \nBefore adding the database to the elastic pool, ensure that the preferredEnclaveType is the same for both the database and the elastic pool. More information can be found on https://aka.ms/AlwaysEncryptedEnableSecureEnclaves\n\n * 400 VBSEnclaveNotSupportedForDW - The preferredEnclaveType is not supported for dedicated SQL Pools.\n\n * 400 VBSEnclaveNotSupportedForDCSeriesSLO - Configuring the 'VBS' preferredEnclaveType for databases using the DC-series hardware configuration is not supported. DC-series databases are pre-configured with Intel SGX enclaves. Virtualization based security (VBS) enclaves are not supported.\n\n * 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave - Configuring geo-replication is not supported for databases using different values of the preferredEnclaveType property. The primary '{0}' database on the '{1}' server uses the '{2}' preferredEnclaveType, whereas the specified preferredEnclaveType for the secondary '{3}' database on the '{4}' server is '{5}'.\n\n * 400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes - Planned failover between primary and secondary database with different preferredEnclaveType is not supported for Virtualization-based security (VBS) enclaves.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ElasticPoolNotFound - The specified elastic pool does not exist for the specified server.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ElasticPoolNotFound - The specified elastic pool does not exist for the specified server.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 ElasticPoolUpdateLinksNotInCatchup - Cannot update elastic pool while one of its databases is performing a copy or geo-replication failover operation.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 ElasticPoolUpdateLinksNotInCatchup - Cannot update elastic pool while one of its databases is performing a copy or geo-replication failover operation.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 ElasticPoolFailedMoveDbToElasticPool - Failed to move the database into elastic pool due to internal resource constraints. This may be a transient condition, please retry.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ElasticPoolFailedMoveDbToElasticPool - Failed to move the database into elastic pool due to internal resource constraints. This may be a transient condition, please retry.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 ElasticPoolScaleNotSupportedWithInaccessibleDatabases - The elastic pool contains inaccessible databases which have lost Azure Key Vault access required for TDE configuration. Please move the accessible databases to a different pool for scaling or restore the lost Azure Key Vault access for the inaccessible databases.\n\n * 400 CreateElasticPoolAttemptedWhenKeyRotationInProgress - The create elastic pool operation cannot be performed at this time due to ongoing Transparent Data Encryption (TDE) key rotation on the server. Please try the operation again later.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerQuotaExceeded - The server reached its limit for allowed Database Throughput Unit.\n\n * 400 SubscriptionVcoreQuotaExceeded - Could not perform the operation because subscription would exceed the allowed vCore quota.\n\n * 400 ElasticPoolAlreadyExists - The server already contains an elastic pool with the specified name.\n\n * 400 InvalidInputValueForEdition - Specified edition is not supported for elastic pool provisioning.\n\n * 400 ElasticPoolDtuBelowLimit - The requested DTU value is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDtuAboveLimit - The requested DTU value is too high for the requested elastic pool service tier.\n\n * 400 InvalidMaxSize - Invalid max size.\n\n * 400 ElasticPoolDbDtuMaxBelowLimit - The requested per database DTU max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbDtuMaxAboveLimit - The requested per database DTU max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseDtuMax - Attempting to set the DTU max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbDtuMinAboveLimit - The requested DTU min per database is too high for the requested service tier.\n\n * 400 ElasticPoolOverStorage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidInputValueForDatabaseDtuMin - Attempting to set the DTU min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 ElasticPoolDtuUnsupported - User tried to create or update an elastic pool with a DTU capacity that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolsNotEnabled - Elastic pools have not been enabled in this region.\n\n * 400 ElasticPoolNotEmpty - Request to delete an elastic pool that is not empty.\n\n * 400 ElasticPoolStorageBelowLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedGB - Attempting to set the elastic pool storage limit in gb which doesn't match the allowed values.\n\n * 400 ElasticPoolDatabaseLimit - The elastic pool has reached its limit for number of databases.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 InvalidInputValueDatabaseDtuMinLargerThanMax - Attempting to set the DTU min per database higher than the DTU max per database.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 ElasticPoolStorageBelowLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 ElasticPoolCapacityStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 ElasticPoolUpdateHkNotAllowed - The elastic pool cannot lower its service tier from Premium to Standard or Basic since one or more of its databases use memory-optimized objects.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 HSElasticPoolUpdateSloPRMSNotSupported - The service objective assignment for the database has failed. Please contact Microsoft customer support and provide the server name, database name and activity ID.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 ElasticPoolDbDtuMinBelowLimit - The requested per database DTU min is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxBelowLimit - The requested per database VCore max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxAboveLimit - The requested per database VCore max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMax - Attempting to set the VCore max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbVcoreMinBelowLimit - The requested per database VCore min is too low for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMin - Attempting to set the VCore min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 PartnerDBNotCompatibleForSGXEnclave - Attempt to set GeoDR link or update SLO for enclave enabled database is only supported when both database are running on DC-series hardware.\n\n * 400 InvalidInputValueDatabaseVcoreMinLargerThanMax - Attempting to set the VCore min per database higher than the VCore max per database.\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 CapacityGroupThresholdExceeded - Requested service level objective and storage size maps to specific capacity group and currently resources for this capacity group has reach threshold and further actions need sto be taken before more database can be placed in those rings.\n\n * 400 CapacityGroupThresholdCheckFail - Capacity group resource constraint check failed thus unable to verify whether enough capacity exist to complete the operation.\n\n * 400 InvalidPublicMaintenanceConfiguration - User tried to specify public maintenance configuration which cannot be converted to internal id (malformed or wrong region).\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSkuName - Invalid SKU name.\n\n * 400 MismatchedSkuNameAndCapacity - Mismatch between SKU name and capacity.\n\n * 400 MismatchedSkuNameAndTier - Mismatch between SKU name and tier.\n\n * 400 MismatchedSkuNameAndFamily - Mismatch between SKU name and family.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 AvailabilityZoneNotSupported - Requested availability zones for databases and elastic pools is not valid.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 ElasticPoolScaleNotSupportedWithInaccessibleDatabases - The elastic pool contains inaccessible databases which have lost Azure Key Vault access required for TDE configuration. Please move the accessible databases to a different pool for scaling or restore the lost Azure Key Vault access for the inaccessible databases.\n\n * 400 CreateElasticPoolAttemptedWhenKeyRotationInProgress - The create elastic pool operation cannot be performed at this time due to ongoing Transparent Data Encryption (TDE) key rotation on the server. Please try the operation again later.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerQuotaExceeded - The server reached its limit for allowed Database Throughput Unit.\n\n * 400 SubscriptionVcoreQuotaExceeded - Could not perform the operation because subscription would exceed the allowed vCore quota.\n\n * 400 ElasticPoolAlreadyExists - The server already contains an elastic pool with the specified name.\n\n * 400 InvalidInputValueForEdition - Specified edition is not supported for elastic pool provisioning.\n\n * 400 ElasticPoolDtuBelowLimit - The requested DTU value is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDtuAboveLimit - The requested DTU value is too high for the requested elastic pool service tier.\n\n * 400 InvalidMaxSize - Invalid max size.\n\n * 400 ElasticPoolDbDtuMaxBelowLimit - The requested per database DTU max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbDtuMaxAboveLimit - The requested per database DTU max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseDtuMax - Attempting to set the DTU max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbDtuMinAboveLimit - The requested DTU min per database is too high for the requested service tier.\n\n * 400 ElasticPoolOverStorage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidInputValueForDatabaseDtuMin - Attempting to set the DTU min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 ElasticPoolDtuUnsupported - User tried to create or update an elastic pool with a DTU capacity that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolsNotEnabled - Elastic pools have not been enabled in this region.\n\n * 400 ElasticPoolNotEmpty - Request to delete an elastic pool that is not empty.\n\n * 400 ElasticPoolStorageBelowLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedGB - Attempting to set the elastic pool storage limit in gb which doesn't match the allowed values.\n\n * 400 ElasticPoolDatabaseLimit - The elastic pool has reached its limit for number of databases.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 InvalidInputValueDatabaseDtuMinLargerThanMax - Attempting to set the DTU min per database higher than the DTU max per database.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 ElasticPoolStorageBelowLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 ElasticPoolCapacityStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 ElasticPoolUpdateHkNotAllowed - The elastic pool cannot lower its service tier from Premium to Standard or Basic since one or more of its databases use memory-optimized objects.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 HSElasticPoolUpdateSloPRMSNotSupported - The service objective assignment for the database has failed. Please contact Microsoft customer support and provide the server name, database name and activity ID.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 ElasticPoolDbDtuMinBelowLimit - The requested per database DTU min is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxBelowLimit - The requested per database VCore max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxAboveLimit - The requested per database VCore max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMax - Attempting to set the VCore max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbVcoreMinBelowLimit - The requested per database VCore min is too low for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMin - Attempting to set the VCore min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 PartnerDBNotCompatibleForSGXEnclave - Attempt to set GeoDR link or update SLO for enclave enabled database is only supported when both database are running on DC-series hardware.\n\n * 400 InvalidInputValueDatabaseVcoreMinLargerThanMax - Attempting to set the VCore min per database higher than the VCore max per database.\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 CapacityGroupThresholdExceeded - Requested service level objective and storage size maps to specific capacity group and currently resources for this capacity group has reach threshold and further actions need sto be taken before more database can be placed in those rings.\n\n * 400 CapacityGroupThresholdCheckFail - Capacity group resource constraint check failed thus unable to verify whether enough capacity exist to complete the operation.\n\n * 400 InvalidPublicMaintenanceConfiguration - User tried to specify public maintenance configuration which cannot be converted to internal id (malformed or wrong region).\n\n * 400 VBSEnclaveResourcePoolInvalidCombination - Adding a database with '{0}' preferredEnclaveType to an elastic pool '{1}' with '{2}' preferredEnclaveType is not supported. \nBefore adding the database to the elastic pool, ensure that the preferredEnclaveType is the same for both the database and the elastic pool. More information can be found on https://aka.ms/AlwaysEncryptedEnableSecureEnclaves\n\n * 400 VBSEnclaveNotSupportedForDW - The preferredEnclaveType is not supported for dedicated SQL Pools.\n\n * 400 VBSEnclaveNotSupportedForDCSeriesSLO - Configuring the 'VBS' preferredEnclaveType for databases using the DC-series hardware configuration is not supported. DC-series databases are pre-configured with Intel SGX enclaves. Virtualization based security (VBS) enclaves are not supported.\n\n * 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave - Configuring geo-replication is not supported for databases using different values of the preferredEnclaveType property. The primary '{0}' database on the '{1}' server uses the '{2}' preferredEnclaveType, whereas the specified preferredEnclaveType for the secondary '{3}' database on the '{4}' server is '{5}'.\n\n * 400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes - Planned failover between primary and secondary database with different preferredEnclaveType is not supported for Virtualization-based security (VBS) enclaves.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ElasticPoolNotFound - The specified elastic pool does not exist for the specified server.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ElasticPoolNotFound - The specified elastic pool does not exist for the specified server.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 ElasticPoolUpdateLinksNotInCatchup - Cannot update elastic pool while one of its databases is performing a copy or geo-replication failover operation.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 ElasticPoolUpdateLinksNotInCatchup - Cannot update elastic pool while one of its databases is performing a copy or geo-replication failover operation.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 ElasticPoolFailedMoveDbToElasticPool - Failed to move the database into elastic pool due to internal resource constraints. This may be a transient condition, please retry.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ElasticPoolFailedMoveDbToElasticPool - Failed to move the database into elastic pool due to internal resource constraints. This may be a transient condition, please retry.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Created the elastic pool", @@ -251,13 +256,18 @@ "description": "Deleted the elastic pool" }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 ElasticPoolScaleNotSupportedWithInaccessibleDatabases - The elastic pool contains inaccessible databases which have lost Azure Key Vault access required for TDE configuration. Please move the accessible databases to a different pool for scaling or restore the lost Azure Key Vault access for the inaccessible databases.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerQuotaExceeded - The server reached its limit for allowed Database Throughput Unit.\n\n * 400 SubscriptionVcoreQuotaExceeded - Could not perform the operation because subscription would exceed the allowed vCore quota.\n\n * 400 ElasticPoolAlreadyExists - The server already contains an elastic pool with the specified name.\n\n * 400 InvalidInputValueForEdition - Specified edition is not supported for elastic pool provisioning.\n\n * 400 ElasticPoolDtuBelowLimit - The requested DTU value is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDtuAboveLimit - The requested DTU value is too high for the requested elastic pool service tier.\n\n * 400 InvalidMaxSize - Invalid max size.\n\n * 400 ElasticPoolDbDtuMaxBelowLimit - The requested per database DTU max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbDtuMaxAboveLimit - The requested per database DTU max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseDtuMax - Attempting to set the DTU max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbDtuMinAboveLimit - The requested DTU min per database is too high for the requested service tier.\n\n * 400 ElasticPoolOverStorage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidInputValueForDatabaseDtuMin - Attempting to set the DTU min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 ElasticPoolDtuUnsupported - User tried to create or update an elastic pool with a DTU capacity that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolsNotEnabled - Elastic pools have not been enabled in this region.\n\n * 400 ElasticPoolNotEmpty - Request to delete an elastic pool that is not empty.\n\n * 400 ElasticPoolStorageBelowLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedGB - Attempting to set the elastic pool storage limit in gb which doesn't match the allowed values.\n\n * 400 ElasticPoolDatabaseLimit - The elastic pool has reached its limit for number of databases.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 InvalidInputValueDatabaseDtuMinLargerThanMax - Attempting to set the DTU min per database higher than the DTU max per database.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 ElasticPoolStorageBelowLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 ElasticPoolCapacityStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 ElasticPoolUpdateHkNotAllowed - The elastic pool cannot lower its service tier from Premium to Standard or Basic since one or more of its databases use memory-optimized objects.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 HSElasticPoolUpdateSloPRMSNotSupported - The service objective assignment for the database has failed. Please contact Microsoft customer support and provide the server name, database name and activity ID.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 ElasticPoolDbDtuMinBelowLimit - The requested per database DTU min is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxBelowLimit - The requested per database VCore max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxAboveLimit - The requested per database VCore max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMax - Attempting to set the VCore max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbVcoreMinBelowLimit - The requested per database VCore min is too low for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMin - Attempting to set the VCore min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 PartnerDBNotCompatibleForSGXEnclave - Attempt to set GeoDR link or update SLO for enclave enabled database is only supported when both database are running on DC-series hardware.\n\n * 400 InvalidInputValueDatabaseVcoreMinLargerThanMax - Attempting to set the VCore min per database higher than the VCore max per database.\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 CapacityGroupThresholdExceeded - Requested service level objective and storage size maps to specific capacity group and currently resources for this capacity group has reach threshold and further actions need sto be taken before more database can be placed in those rings.\n\n * 400 CapacityGroupThresholdCheckFail - Capacity group resource constraint check failed thus unable to verify whether enough capacity exist to complete the operation.\n\n * 400 InvalidPublicMaintenanceConfiguration - User tried to specify public maintenance configuration which cannot be converted to internal id (malformed or wrong region).\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ElasticPoolNotFound - The specified elastic pool does not exist for the specified server.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 ElasticPoolUpdateLinksNotInCatchup - Cannot update elastic pool while one of its databases is performing a copy or geo-replication failover operation.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 ElasticPoolFailedMoveDbToElasticPool - Failed to move the database into elastic pool due to internal resource constraints. This may be a transient condition, please retry.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 ElasticPoolScaleNotSupportedWithInaccessibleDatabases - The elastic pool contains inaccessible databases which have lost Azure Key Vault access required for TDE configuration. Please move the accessible databases to a different pool for scaling or restore the lost Azure Key Vault access for the inaccessible databases.\n\n * 400 CreateElasticPoolAttemptedWhenKeyRotationInProgress - The create elastic pool operation cannot be performed at this time due to ongoing Transparent Data Encryption (TDE) key rotation on the server. Please try the operation again later.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerQuotaExceeded - The server reached its limit for allowed Database Throughput Unit.\n\n * 400 SubscriptionVcoreQuotaExceeded - Could not perform the operation because subscription would exceed the allowed vCore quota.\n\n * 400 ElasticPoolAlreadyExists - The server already contains an elastic pool with the specified name.\n\n * 400 InvalidInputValueForEdition - Specified edition is not supported for elastic pool provisioning.\n\n * 400 ElasticPoolDtuBelowLimit - The requested DTU value is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDtuAboveLimit - The requested DTU value is too high for the requested elastic pool service tier.\n\n * 400 InvalidMaxSize - Invalid max size.\n\n * 400 ElasticPoolDbDtuMaxBelowLimit - The requested per database DTU max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbDtuMaxAboveLimit - The requested per database DTU max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseDtuMax - Attempting to set the DTU max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbDtuMinAboveLimit - The requested DTU min per database is too high for the requested service tier.\n\n * 400 ElasticPoolOverStorage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidInputValueForDatabaseDtuMin - Attempting to set the DTU min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 ElasticPoolDtuUnsupported - User tried to create or update an elastic pool with a DTU capacity that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolsNotEnabled - Elastic pools have not been enabled in this region.\n\n * 400 ElasticPoolNotEmpty - Request to delete an elastic pool that is not empty.\n\n * 400 ElasticPoolStorageBelowLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedGB - Attempting to set the elastic pool storage limit in gb which doesn't match the allowed values.\n\n * 400 ElasticPoolDatabaseLimit - The elastic pool has reached its limit for number of databases.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 InvalidInputValueDatabaseDtuMinLargerThanMax - Attempting to set the DTU min per database higher than the DTU max per database.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 ElasticPoolStorageBelowLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 ElasticPoolCapacityStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 ElasticPoolUpdateHkNotAllowed - The elastic pool cannot lower its service tier from Premium to Standard or Basic since one or more of its databases use memory-optimized objects.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 HSElasticPoolUpdateSloPRMSNotSupported - The service objective assignment for the database has failed. Please contact Microsoft customer support and provide the server name, database name and activity ID.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 ElasticPoolDbDtuMinBelowLimit - The requested per database DTU min is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxBelowLimit - The requested per database VCore max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxAboveLimit - The requested per database VCore max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMax - Attempting to set the VCore max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbVcoreMinBelowLimit - The requested per database VCore min is too low for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMin - Attempting to set the VCore min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 PartnerDBNotCompatibleForSGXEnclave - Attempt to set GeoDR link or update SLO for enclave enabled database is only supported when both database are running on DC-series hardware.\n\n * 400 InvalidInputValueDatabaseVcoreMinLargerThanMax - Attempting to set the VCore min per database higher than the VCore max per database.\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 CapacityGroupThresholdExceeded - Requested service level objective and storage size maps to specific capacity group and currently resources for this capacity group has reach threshold and further actions need sto be taken before more database can be placed in those rings.\n\n * 400 CapacityGroupThresholdCheckFail - Capacity group resource constraint check failed thus unable to verify whether enough capacity exist to complete the operation.\n\n * 400 InvalidPublicMaintenanceConfiguration - User tried to specify public maintenance configuration which cannot be converted to internal id (malformed or wrong region).\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ElasticPoolNotFound - The specified elastic pool does not exist for the specified server.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 ElasticPoolUpdateLinksNotInCatchup - Cannot update elastic pool while one of its databases is performing a copy or geo-replication failover operation.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 ElasticPoolFailedMoveDbToElasticPool - Failed to move the database into elastic pool due to internal resource constraints. This may be a transient condition, please retry.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Deleting the elastic pool is in progress." + "description": "Deleting the elastic pool is in progress.", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "Elastic pool did not exist" @@ -317,13 +327,18 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 ElasticPoolScaleNotSupportedWithInaccessibleDatabases - The elastic pool contains inaccessible databases which have lost Azure Key Vault access required for TDE configuration. Please move the accessible databases to a different pool for scaling or restore the lost Azure Key Vault access for the inaccessible databases.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerQuotaExceeded - The server reached its limit for allowed Database Throughput Unit.\n\n * 400 SubscriptionVcoreQuotaExceeded - Could not perform the operation because subscription would exceed the allowed vCore quota.\n\n * 400 ElasticPoolAlreadyExists - The server already contains an elastic pool with the specified name.\n\n * 400 InvalidInputValueForEdition - Specified edition is not supported for elastic pool provisioning.\n\n * 400 ElasticPoolDtuBelowLimit - The requested DTU value is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDtuAboveLimit - The requested DTU value is too high for the requested elastic pool service tier.\n\n * 400 InvalidMaxSize - Invalid max size.\n\n * 400 ElasticPoolDbDtuMaxBelowLimit - The requested per database DTU max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbDtuMaxAboveLimit - The requested per database DTU max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseDtuMax - Attempting to set the DTU max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbDtuMinAboveLimit - The requested DTU min per database is too high for the requested service tier.\n\n * 400 ElasticPoolOverStorage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidInputValueForDatabaseDtuMin - Attempting to set the DTU min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 ElasticPoolDtuUnsupported - User tried to create or update an elastic pool with a DTU capacity that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolsNotEnabled - Elastic pools have not been enabled in this region.\n\n * 400 ElasticPoolNotEmpty - Request to delete an elastic pool that is not empty.\n\n * 400 ElasticPoolStorageBelowLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedGB - Attempting to set the elastic pool storage limit in gb which doesn't match the allowed values.\n\n * 400 ElasticPoolDatabaseLimit - The elastic pool has reached its limit for number of databases.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 InvalidInputValueDatabaseDtuMinLargerThanMax - Attempting to set the DTU min per database higher than the DTU max per database.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 ElasticPoolStorageBelowLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 ElasticPoolCapacityStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 ElasticPoolUpdateHkNotAllowed - The elastic pool cannot lower its service tier from Premium to Standard or Basic since one or more of its databases use memory-optimized objects.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 HSElasticPoolUpdateSloPRMSNotSupported - The service objective assignment for the database has failed. Please contact Microsoft customer support and provide the server name, database name and activity ID.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 ElasticPoolDbDtuMinBelowLimit - The requested per database DTU min is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxBelowLimit - The requested per database VCore max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxAboveLimit - The requested per database VCore max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMax - Attempting to set the VCore max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbVcoreMinBelowLimit - The requested per database VCore min is too low for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMin - Attempting to set the VCore min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 PartnerDBNotCompatibleForSGXEnclave - Attempt to set GeoDR link or update SLO for enclave enabled database is only supported when both database are running on DC-series hardware.\n\n * 400 InvalidInputValueDatabaseVcoreMinLargerThanMax - Attempting to set the VCore min per database higher than the VCore max per database.\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 CapacityGroupThresholdExceeded - Requested service level objective and storage size maps to specific capacity group and currently resources for this capacity group has reach threshold and further actions need sto be taken before more database can be placed in those rings.\n\n * 400 CapacityGroupThresholdCheckFail - Capacity group resource constraint check failed thus unable to verify whether enough capacity exist to complete the operation.\n\n * 400 InvalidPublicMaintenanceConfiguration - User tried to specify public maintenance configuration which cannot be converted to internal id (malformed or wrong region).\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSkuName - Invalid SKU name.\n\n * 400 MismatchedSkuNameAndCapacity - Mismatch between SKU name and capacity.\n\n * 400 MismatchedSkuNameAndTier - Mismatch between SKU name and tier.\n\n * 400 MismatchedSkuNameAndFamily - Mismatch between SKU name and family.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 AvailabilityZoneNotSupported - Requested availability zones for databases and elastic pools is not valid.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 ElasticPoolScaleNotSupportedWithInaccessibleDatabases - The elastic pool contains inaccessible databases which have lost Azure Key Vault access required for TDE configuration. Please move the accessible databases to a different pool for scaling or restore the lost Azure Key Vault access for the inaccessible databases.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerQuotaExceeded - The server reached its limit for allowed Database Throughput Unit.\n\n * 400 SubscriptionVcoreQuotaExceeded - Could not perform the operation because subscription would exceed the allowed vCore quota.\n\n * 400 ElasticPoolAlreadyExists - The server already contains an elastic pool with the specified name.\n\n * 400 InvalidInputValueForEdition - Specified edition is not supported for elastic pool provisioning.\n\n * 400 ElasticPoolDtuBelowLimit - The requested DTU value is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDtuAboveLimit - The requested DTU value is too high for the requested elastic pool service tier.\n\n * 400 InvalidMaxSize - Invalid max size.\n\n * 400 ElasticPoolDbDtuMaxBelowLimit - The requested per database DTU max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbDtuMaxAboveLimit - The requested per database DTU max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseDtuMax - Attempting to set the DTU max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbDtuMinAboveLimit - The requested DTU min per database is too high for the requested service tier.\n\n * 400 ElasticPoolOverStorage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidInputValueForDatabaseDtuMin - Attempting to set the DTU min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 ElasticPoolDtuUnsupported - User tried to create or update an elastic pool with a DTU capacity that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolsNotEnabled - Elastic pools have not been enabled in this region.\n\n * 400 ElasticPoolNotEmpty - Request to delete an elastic pool that is not empty.\n\n * 400 ElasticPoolStorageBelowLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedGB - Attempting to set the elastic pool storage limit in gb which doesn't match the allowed values.\n\n * 400 ElasticPoolDatabaseLimit - The elastic pool has reached its limit for number of databases.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 InvalidInputValueDatabaseDtuMinLargerThanMax - Attempting to set the DTU min per database higher than the DTU max per database.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 ElasticPoolStorageBelowLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 ElasticPoolCapacityStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 ElasticPoolUpdateHkNotAllowed - The elastic pool cannot lower its service tier from Premium to Standard or Basic since one or more of its databases use memory-optimized objects.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 HSElasticPoolUpdateSloPRMSNotSupported - The service objective assignment for the database has failed. Please contact Microsoft customer support and provide the server name, database name and activity ID.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 ElasticPoolDbDtuMinBelowLimit - The requested per database DTU min is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxBelowLimit - The requested per database VCore max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxAboveLimit - The requested per database VCore max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMax - Attempting to set the VCore max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbVcoreMinBelowLimit - The requested per database VCore min is too low for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMin - Attempting to set the VCore min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 PartnerDBNotCompatibleForSGXEnclave - Attempt to set GeoDR link or update SLO for enclave enabled database is only supported when both database are running on DC-series hardware.\n\n * 400 InvalidInputValueDatabaseVcoreMinLargerThanMax - Attempting to set the VCore min per database higher than the VCore max per database.\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 CapacityGroupThresholdExceeded - Requested service level objective and storage size maps to specific capacity group and currently resources for this capacity group has reach threshold and further actions need sto be taken before more database can be placed in those rings.\n\n * 400 CapacityGroupThresholdCheckFail - Capacity group resource constraint check failed thus unable to verify whether enough capacity exist to complete the operation.\n\n * 400 InvalidPublicMaintenanceConfiguration - User tried to specify public maintenance configuration which cannot be converted to internal id (malformed or wrong region).\n\n * 400 VBSEnclaveResourcePoolInvalidCombination - Adding a database with '{0}' preferredEnclaveType to an elastic pool '{1}' with '{2}' preferredEnclaveType is not supported. \nBefore adding the database to the elastic pool, ensure that the preferredEnclaveType is the same for both the database and the elastic pool. More information can be found on https://aka.ms/AlwaysEncryptedEnableSecureEnclaves\n\n * 400 VBSEnclaveNotSupportedForDW - The preferredEnclaveType is not supported for dedicated SQL Pools.\n\n * 400 VBSEnclaveNotSupportedForDCSeriesSLO - Configuring the 'VBS' preferredEnclaveType for databases using the DC-series hardware configuration is not supported. DC-series databases are pre-configured with Intel SGX enclaves. Virtualization based security (VBS) enclaves are not supported.\n\n * 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave - Configuring geo-replication is not supported for databases using different values of the preferredEnclaveType property. The primary '{0}' database on the '{1}' server uses the '{2}' preferredEnclaveType, whereas the specified preferredEnclaveType for the secondary '{3}' database on the '{4}' server is '{5}'.\n\n * 400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes - Planned failover between primary and secondary database with different preferredEnclaveType is not supported for Virtualization-based security (VBS) enclaves.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ElasticPoolNotFound - The specified elastic pool does not exist for the specified server.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ElasticPoolNotFound - The specified elastic pool does not exist for the specified server.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 ElasticPoolUpdateLinksNotInCatchup - Cannot update elastic pool while one of its databases is performing a copy or geo-replication failover operation.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 ElasticPoolUpdateLinksNotInCatchup - Cannot update elastic pool while one of its databases is performing a copy or geo-replication failover operation.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 ElasticPoolFailedMoveDbToElasticPool - Failed to move the database into elastic pool due to internal resource constraints. This may be a transient condition, please retry.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ElasticPoolFailedMoveDbToElasticPool - Failed to move the database into elastic pool due to internal resource constraints. This may be a transient condition, please retry.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 ElasticPoolScaleNotSupportedWithInaccessibleDatabases - The elastic pool contains inaccessible databases which have lost Azure Key Vault access required for TDE configuration. Please move the accessible databases to a different pool for scaling or restore the lost Azure Key Vault access for the inaccessible databases.\n\n * 400 CreateElasticPoolAttemptedWhenKeyRotationInProgress - The create elastic pool operation cannot be performed at this time due to ongoing Transparent Data Encryption (TDE) key rotation on the server. Please try the operation again later.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerQuotaExceeded - The server reached its limit for allowed Database Throughput Unit.\n\n * 400 SubscriptionVcoreQuotaExceeded - Could not perform the operation because subscription would exceed the allowed vCore quota.\n\n * 400 ElasticPoolAlreadyExists - The server already contains an elastic pool with the specified name.\n\n * 400 InvalidInputValueForEdition - Specified edition is not supported for elastic pool provisioning.\n\n * 400 ElasticPoolDtuBelowLimit - The requested DTU value is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDtuAboveLimit - The requested DTU value is too high for the requested elastic pool service tier.\n\n * 400 InvalidMaxSize - Invalid max size.\n\n * 400 ElasticPoolDbDtuMaxBelowLimit - The requested per database DTU max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbDtuMaxAboveLimit - The requested per database DTU max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseDtuMax - Attempting to set the DTU max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbDtuMinAboveLimit - The requested DTU min per database is too high for the requested service tier.\n\n * 400 ElasticPoolOverStorage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidInputValueForDatabaseDtuMin - Attempting to set the DTU min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 ElasticPoolDtuUnsupported - User tried to create or update an elastic pool with a DTU capacity that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolsNotEnabled - Elastic pools have not been enabled in this region.\n\n * 400 ElasticPoolNotEmpty - Request to delete an elastic pool that is not empty.\n\n * 400 ElasticPoolStorageBelowLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedGB - Attempting to set the elastic pool storage limit in gb which doesn't match the allowed values.\n\n * 400 ElasticPoolDatabaseLimit - The elastic pool has reached its limit for number of databases.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 InvalidInputValueDatabaseDtuMinLargerThanMax - Attempting to set the DTU min per database higher than the DTU max per database.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 ElasticPoolStorageBelowLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 ElasticPoolCapacityStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 ElasticPoolUpdateHkNotAllowed - The elastic pool cannot lower its service tier from Premium to Standard or Basic since one or more of its databases use memory-optimized objects.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 HSElasticPoolUpdateSloPRMSNotSupported - The service objective assignment for the database has failed. Please contact Microsoft customer support and provide the server name, database name and activity ID.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 ElasticPoolDbDtuMinBelowLimit - The requested per database DTU min is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxBelowLimit - The requested per database VCore max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxAboveLimit - The requested per database VCore max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMax - Attempting to set the VCore max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbVcoreMinBelowLimit - The requested per database VCore min is too low for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMin - Attempting to set the VCore min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 PartnerDBNotCompatibleForSGXEnclave - Attempt to set GeoDR link or update SLO for enclave enabled database is only supported when both database are running on DC-series hardware.\n\n * 400 InvalidInputValueDatabaseVcoreMinLargerThanMax - Attempting to set the VCore min per database higher than the VCore max per database.\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 CapacityGroupThresholdExceeded - Requested service level objective and storage size maps to specific capacity group and currently resources for this capacity group has reach threshold and further actions need sto be taken before more database can be placed in those rings.\n\n * 400 CapacityGroupThresholdCheckFail - Capacity group resource constraint check failed thus unable to verify whether enough capacity exist to complete the operation.\n\n * 400 InvalidPublicMaintenanceConfiguration - User tried to specify public maintenance configuration which cannot be converted to internal id (malformed or wrong region).\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSkuName - Invalid SKU name.\n\n * 400 MismatchedSkuNameAndCapacity - Mismatch between SKU name and capacity.\n\n * 400 MismatchedSkuNameAndTier - Mismatch between SKU name and tier.\n\n * 400 MismatchedSkuNameAndFamily - Mismatch between SKU name and family.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 AvailabilityZoneNotSupported - Requested availability zones for databases and elastic pools is not valid.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 ElasticPoolScaleNotSupportedWithInaccessibleDatabases - The elastic pool contains inaccessible databases which have lost Azure Key Vault access required for TDE configuration. Please move the accessible databases to a different pool for scaling or restore the lost Azure Key Vault access for the inaccessible databases.\n\n * 400 CreateElasticPoolAttemptedWhenKeyRotationInProgress - The create elastic pool operation cannot be performed at this time due to ongoing Transparent Data Encryption (TDE) key rotation on the server. Please try the operation again later.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerQuotaExceeded - The server reached its limit for allowed Database Throughput Unit.\n\n * 400 SubscriptionVcoreQuotaExceeded - Could not perform the operation because subscription would exceed the allowed vCore quota.\n\n * 400 ElasticPoolAlreadyExists - The server already contains an elastic pool with the specified name.\n\n * 400 InvalidInputValueForEdition - Specified edition is not supported for elastic pool provisioning.\n\n * 400 ElasticPoolDtuBelowLimit - The requested DTU value is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDtuAboveLimit - The requested DTU value is too high for the requested elastic pool service tier.\n\n * 400 InvalidMaxSize - Invalid max size.\n\n * 400 ElasticPoolDbDtuMaxBelowLimit - The requested per database DTU max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbDtuMaxAboveLimit - The requested per database DTU max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseDtuMax - Attempting to set the DTU max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbDtuMinAboveLimit - The requested DTU min per database is too high for the requested service tier.\n\n * 400 ElasticPoolOverStorage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidInputValueForDatabaseDtuMin - Attempting to set the DTU min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 ElasticPoolDtuUnsupported - User tried to create or update an elastic pool with a DTU capacity that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolsNotEnabled - Elastic pools have not been enabled in this region.\n\n * 400 ElasticPoolNotEmpty - Request to delete an elastic pool that is not empty.\n\n * 400 ElasticPoolStorageBelowLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedGB - Attempting to set the elastic pool storage limit in gb which doesn't match the allowed values.\n\n * 400 ElasticPoolDatabaseLimit - The elastic pool has reached its limit for number of databases.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 InvalidInputValueDatabaseDtuMinLargerThanMax - Attempting to set the DTU min per database higher than the DTU max per database.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 ElasticPoolStorageBelowLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 ElasticPoolCapacityStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 ElasticPoolUpdateHkNotAllowed - The elastic pool cannot lower its service tier from Premium to Standard or Basic since one or more of its databases use memory-optimized objects.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 HSElasticPoolUpdateSloPRMSNotSupported - The service objective assignment for the database has failed. Please contact Microsoft customer support and provide the server name, database name and activity ID.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 ElasticPoolDbDtuMinBelowLimit - The requested per database DTU min is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxBelowLimit - The requested per database VCore max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxAboveLimit - The requested per database VCore max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMax - Attempting to set the VCore max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbVcoreMinBelowLimit - The requested per database VCore min is too low for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMin - Attempting to set the VCore min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 PartnerDBNotCompatibleForSGXEnclave - Attempt to set GeoDR link or update SLO for enclave enabled database is only supported when both database are running on DC-series hardware.\n\n * 400 InvalidInputValueDatabaseVcoreMinLargerThanMax - Attempting to set the VCore min per database higher than the VCore max per database.\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 CapacityGroupThresholdExceeded - Requested service level objective and storage size maps to specific capacity group and currently resources for this capacity group has reach threshold and further actions need sto be taken before more database can be placed in those rings.\n\n * 400 CapacityGroupThresholdCheckFail - Capacity group resource constraint check failed thus unable to verify whether enough capacity exist to complete the operation.\n\n * 400 InvalidPublicMaintenanceConfiguration - User tried to specify public maintenance configuration which cannot be converted to internal id (malformed or wrong region).\n\n * 400 VBSEnclaveResourcePoolInvalidCombination - Adding a database with '{0}' preferredEnclaveType to an elastic pool '{1}' with '{2}' preferredEnclaveType is not supported. \nBefore adding the database to the elastic pool, ensure that the preferredEnclaveType is the same for both the database and the elastic pool. More information can be found on https://aka.ms/AlwaysEncryptedEnableSecureEnclaves\n\n * 400 VBSEnclaveNotSupportedForDW - The preferredEnclaveType is not supported for dedicated SQL Pools.\n\n * 400 VBSEnclaveNotSupportedForDCSeriesSLO - Configuring the 'VBS' preferredEnclaveType for databases using the DC-series hardware configuration is not supported. DC-series databases are pre-configured with Intel SGX enclaves. Virtualization based security (VBS) enclaves are not supported.\n\n * 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave - Configuring geo-replication is not supported for databases using different values of the preferredEnclaveType property. The primary '{0}' database on the '{1}' server uses the '{2}' preferredEnclaveType, whereas the specified preferredEnclaveType for the secondary '{3}' database on the '{4}' server is '{5}'.\n\n * 400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes - Planned failover between primary and secondary database with different preferredEnclaveType is not supported for Virtualization-based security (VBS) enclaves.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ElasticPoolNotFound - The specified elastic pool does not exist for the specified server.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ElasticPoolNotFound - The specified elastic pool does not exist for the specified server.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 ElasticPoolUpdateLinksNotInCatchup - Cannot update elastic pool while one of its databases is performing a copy or geo-replication failover operation.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 ElasticPoolUpdateLinksNotInCatchup - Cannot update elastic pool while one of its databases is performing a copy or geo-replication failover operation.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 ElasticPoolFailedMoveDbToElasticPool - Failed to move the database into elastic pool due to internal resource constraints. This may be a transient condition, please retry.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ElasticPoolFailedMoveDbToElasticPool - Failed to move the database into elastic pool due to internal resource constraints. This may be a transient condition, please retry.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -397,7 +412,12 @@ } }, "202": { - "description": "Elastic pool failover is in progress." + "description": "Elastic pool failover is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/EncryptionProtectors.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/EncryptionProtectors.json index 20cd96a1eb84..7d1c6a3a497a 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/EncryptionProtectors.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/EncryptionProtectors.json @@ -173,7 +173,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -233,7 +238,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/FailoverGroups.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/FailoverGroups.json index 4fd8ac202f80..6ff1dbcb9e2b 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/FailoverGroups.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/FailoverGroups.json @@ -171,7 +171,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully created the failover group.", @@ -232,7 +237,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "The specified failover group does not exist." @@ -299,7 +309,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -359,7 +374,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -416,7 +436,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/InstanceFailoverGroups.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/InstanceFailoverGroups.json index 2272d53e0e21..71b321a8ae76 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/InstanceFailoverGroups.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/InstanceFailoverGroups.json @@ -49,7 +49,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary - The given primary field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the instance failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion - The provided partner managed instance region in the instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner region is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount - Only one managed instance pair is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid - The create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the instance failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues - Grace period value for the instance failover group must be greater than or equal to the '{0}' minutes minimum grace period\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update instance failover group request body should not modify the read-only property '{0}'.\n\n * 400 InstanceFailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of instance failover group.\n\n * 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription - Primary server and the partner server of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ServerEditionMismatch - Edition must be the same as the primary server when creating a replica server.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in an Instance Failover Group need to reside in different regions to provide isolation.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 InstanceFailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a instance failover group.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceEstablishingFailoverGroupGeoPrimaryWithNewerVersionEditionThanSecondary - Failover group cannot be created because database format of the primary instance is not compatible with the database format of the secondary instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 ManagedInstanceFailoverInFailoverGroupInstancesWithDifferentVersionEditions - Failover operation cannot be performed because of database format mismatch between the instances in the failover group. Consider upgrading the database format of the primary instance or deleting the failover group to promote current secondary instance to a stand-alone instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 ManagedInstanceUpdateSloOngoing - The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\n\n * 400 FailoverGroupRegionMismatch - Partner region specified in Failover Group need to match the region of the partner managed instance indicated.\n\n * 400 DnsZoneMismatch - The DNSZone on the partner server is different from the DNSZone on the source server. This breaks InstanceFailoverGroup functionality.\n\n * 400 GeoDrInstanceSizeMismatch - Primary managed instance and partner managed instance do not have the same storage size.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 GeoDrSecondaryInstanceNotEmpty - Secondary managed instance has user databases. To create an instance failover group the secondary managed instance needs to be empty.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ManagedInstanceContainsInaccessibleDatabases - The operation could not be completed because managed instance '{0}' contains databases that are in the Inaccessible state. Please either drop inaccessible databases or fix the issues with access to the customer-managed TDE protector key for managed instance before retrying operation. https://go.microsoft.com/fwlink/?linkid=2111623\n\n * 409 ManagedInstanceHasHybridLink - User tried to initiate operation that is not supported when managed instance has a hybrid link configured.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 InstanceFailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 InstanceFailoverGroupBusy - Instance failover group is busy with another operation.\n\n * 409 InstanceFailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Instance Failover Group name was supplied.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary - The given primary field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the instance failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion - The provided partner managed instance region in the instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner region is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount - Only one managed instance pair is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid - The create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the instance failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues - Grace period value for the instance failover group must be greater than or equal to the '{0}' minutes minimum grace period\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update instance failover group request body should not modify the read-only property '{0}'.\n\n * 400 InstanceFailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of instance failover group.\n\n * 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription - Primary server and the partner server of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ServerEditionMismatch - Edition must be the same as the primary server when creating a replica server.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in an Instance Failover Group need to reside in different regions to provide isolation.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 InstanceFailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a instance failover group.\n\n * 400 ManagedInstanceGeoDRNotAllowedForInstancePool - Creating auto-failover group (GeoDR) is not supported for Managed Instances provisioned inside instance pools. Auto failover groups can be created only for standalone Managed Instances.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceEstablishingFailoverGroupGeoPrimaryWithNewerVersionEditionThanSecondary - Failover group cannot be created because database format of the primary instance is not compatible with the database format of the secondary instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 ManagedInstanceFailoverInFailoverGroupInstancesWithDifferentVersionEditions - Failover operation cannot be performed because of database format mismatch between the instances in the failover group. Consider upgrading the database format of the primary instance or deleting the failover group to promote current secondary instance to a stand-alone instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 ManagedInstanceNotAllowedInGeoDRSetupWhenFreemium - Deploying failover group is not supported with the free Azure SQL Managed Instance offer.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 ManagedInstanceUpdateSloOngoing - The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\n\n * 400 FailoverGroupRegionMismatch - Partner region specified in Failover Group need to match the region of the partner managed instance indicated.\n\n * 400 DnsZoneMismatch - The DNSZone on the partner server is different from the DNSZone on the source server. This breaks InstanceFailoverGroup functionality.\n\n * 400 GeoDrInstanceSizeMismatch - Primary managed instance and partner managed instance do not have the same storage size.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 GeoDrSecondaryInstanceNotEmpty - Secondary managed instance has user databases. To create an instance failover group the secondary managed instance needs to be empty.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ManagedInstanceContainsInaccessibleDatabases - The operation could not be completed because managed instance '{0}' contains databases that are in the Inaccessible state. Please either drop inaccessible databases or fix the issues with access to the customer-managed TDE protector key for managed instance before retrying operation. https://go.microsoft.com/fwlink/?linkid=2111623\n\n * 409 ManagedInstanceHasHybridLink - User tried to initiate operation that is not supported when managed instance has a hybrid link configured.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 InstanceFailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 InstanceFailoverGroupBusy - Instance failover group is busy with another operation.\n\n * 409 InstanceFailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Instance Failover Group name was supplied.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -105,7 +105,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary - The given primary field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the instance failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion - The provided partner managed instance region in the instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner region is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount - Only one managed instance pair is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid - The create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the instance failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues - Grace period value for the instance failover group must be greater than or equal to the '{0}' minutes minimum grace period\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update instance failover group request body should not modify the read-only property '{0}'.\n\n * 400 InstanceFailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of instance failover group.\n\n * 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription - Primary server and the partner server of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ServerEditionMismatch - Edition must be the same as the primary server when creating a replica server.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in an Instance Failover Group need to reside in different regions to provide isolation.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 InstanceFailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a instance failover group.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceEstablishingFailoverGroupGeoPrimaryWithNewerVersionEditionThanSecondary - Failover group cannot be created because database format of the primary instance is not compatible with the database format of the secondary instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 ManagedInstanceFailoverInFailoverGroupInstancesWithDifferentVersionEditions - Failover operation cannot be performed because of database format mismatch between the instances in the failover group. Consider upgrading the database format of the primary instance or deleting the failover group to promote current secondary instance to a stand-alone instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 ManagedInstanceUpdateSloOngoing - The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\n\n * 400 FailoverGroupRegionMismatch - Partner region specified in Failover Group need to match the region of the partner managed instance indicated.\n\n * 400 DnsZoneMismatch - The DNSZone on the partner server is different from the DNSZone on the source server. This breaks InstanceFailoverGroup functionality.\n\n * 400 GeoDrInstanceSizeMismatch - Primary managed instance and partner managed instance do not have the same storage size.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 GeoDrSecondaryInstanceNotEmpty - Secondary managed instance has user databases. To create an instance failover group the secondary managed instance needs to be empty.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ManagedInstanceContainsInaccessibleDatabases - The operation could not be completed because managed instance '{0}' contains databases that are in the Inaccessible state. Please either drop inaccessible databases or fix the issues with access to the customer-managed TDE protector key for managed instance before retrying operation. https://go.microsoft.com/fwlink/?linkid=2111623\n\n * 409 ManagedInstanceHasHybridLink - User tried to initiate operation that is not supported when managed instance has a hybrid link configured.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 InstanceFailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 InstanceFailoverGroupBusy - Instance failover group is busy with another operation.\n\n * 409 InstanceFailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Instance Failover Group name was supplied.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary - The given primary field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the instance failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion - The provided partner managed instance region in the instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner region is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount - Only one managed instance pair is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid - The create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the instance failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues - Grace period value for the instance failover group must be greater than or equal to the '{0}' minutes minimum grace period\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update instance failover group request body should not modify the read-only property '{0}'.\n\n * 400 InstanceFailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of instance failover group.\n\n * 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription - Primary server and the partner server of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ServerEditionMismatch - Edition must be the same as the primary server when creating a replica server.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in an Instance Failover Group need to reside in different regions to provide isolation.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 InstanceFailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a instance failover group.\n\n * 400 ManagedInstanceGeoDRNotAllowedForInstancePool - Creating auto-failover group (GeoDR) is not supported for Managed Instances provisioned inside instance pools. Auto failover groups can be created only for standalone Managed Instances.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceEstablishingFailoverGroupGeoPrimaryWithNewerVersionEditionThanSecondary - Failover group cannot be created because database format of the primary instance is not compatible with the database format of the secondary instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 ManagedInstanceFailoverInFailoverGroupInstancesWithDifferentVersionEditions - Failover operation cannot be performed because of database format mismatch between the instances in the failover group. Consider upgrading the database format of the primary instance or deleting the failover group to promote current secondary instance to a stand-alone instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 ManagedInstanceNotAllowedInGeoDRSetupWhenFreemium - Deploying failover group is not supported with the free Azure SQL Managed Instance offer.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 ManagedInstanceUpdateSloOngoing - The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\n\n * 400 FailoverGroupRegionMismatch - Partner region specified in Failover Group need to match the region of the partner managed instance indicated.\n\n * 400 DnsZoneMismatch - The DNSZone on the partner server is different from the DNSZone on the source server. This breaks InstanceFailoverGroup functionality.\n\n * 400 GeoDrInstanceSizeMismatch - Primary managed instance and partner managed instance do not have the same storage size.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 GeoDrSecondaryInstanceNotEmpty - Secondary managed instance has user databases. To create an instance failover group the secondary managed instance needs to be empty.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ManagedInstanceContainsInaccessibleDatabases - The operation could not be completed because managed instance '{0}' contains databases that are in the Inaccessible state. Please either drop inaccessible databases or fix the issues with access to the customer-managed TDE protector key for managed instance before retrying operation. https://go.microsoft.com/fwlink/?linkid=2111623\n\n * 409 ManagedInstanceHasHybridLink - User tried to initiate operation that is not supported when managed instance has a hybrid link configured.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 InstanceFailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 InstanceFailoverGroupBusy - Instance failover group is busy with another operation.\n\n * 409 InstanceFailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Instance Failover Group name was supplied.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -165,13 +165,18 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary - The given primary field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the instance failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion - The provided partner managed instance region in the instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner region is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount - Only one managed instance pair is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid - The create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the instance failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues - Grace period value for the instance failover group must be greater than or equal to the '{0}' minutes minimum grace period\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update instance failover group request body should not modify the read-only property '{0}'.\n\n * 400 InstanceFailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of instance failover group.\n\n * 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription - Primary server and the partner server of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ServerEditionMismatch - Edition must be the same as the primary server when creating a replica server.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in an Instance Failover Group need to reside in different regions to provide isolation.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 InstanceFailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a instance failover group.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceEstablishingFailoverGroupGeoPrimaryWithNewerVersionEditionThanSecondary - Failover group cannot be created because database format of the primary instance is not compatible with the database format of the secondary instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 ManagedInstanceFailoverInFailoverGroupInstancesWithDifferentVersionEditions - Failover operation cannot be performed because of database format mismatch between the instances in the failover group. Consider upgrading the database format of the primary instance or deleting the failover group to promote current secondary instance to a stand-alone instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 ManagedInstanceUpdateSloOngoing - The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\n\n * 400 FailoverGroupRegionMismatch - Partner region specified in Failover Group need to match the region of the partner managed instance indicated.\n\n * 400 DnsZoneMismatch - The DNSZone on the partner server is different from the DNSZone on the source server. This breaks InstanceFailoverGroup functionality.\n\n * 400 GeoDrInstanceSizeMismatch - Primary managed instance and partner managed instance do not have the same storage size.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 GeoDrSecondaryInstanceNotEmpty - Secondary managed instance has user databases. To create an instance failover group the secondary managed instance needs to be empty.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ManagedInstanceContainsInaccessibleDatabases - The operation could not be completed because managed instance '{0}' contains databases that are in the Inaccessible state. Please either drop inaccessible databases or fix the issues with access to the customer-managed TDE protector key for managed instance before retrying operation. https://go.microsoft.com/fwlink/?linkid=2111623\n\n * 409 ManagedInstanceHasHybridLink - User tried to initiate operation that is not supported when managed instance has a hybrid link configured.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 InstanceFailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 InstanceFailoverGroupBusy - Instance failover group is busy with another operation.\n\n * 409 InstanceFailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Instance Failover Group name was supplied.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary - The given primary field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the instance failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion - The provided partner managed instance region in the instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner region is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount - Only one managed instance pair is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid - The create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the instance failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues - Grace period value for the instance failover group must be greater than or equal to the '{0}' minutes minimum grace period\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update instance failover group request body should not modify the read-only property '{0}'.\n\n * 400 InstanceFailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of instance failover group.\n\n * 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription - Primary server and the partner server of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ServerEditionMismatch - Edition must be the same as the primary server when creating a replica server.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in an Instance Failover Group need to reside in different regions to provide isolation.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 InstanceFailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a instance failover group.\n\n * 400 ManagedInstanceGeoDRNotAllowedForInstancePool - Creating auto-failover group (GeoDR) is not supported for Managed Instances provisioned inside instance pools. Auto failover groups can be created only for standalone Managed Instances.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceEstablishingFailoverGroupGeoPrimaryWithNewerVersionEditionThanSecondary - Failover group cannot be created because database format of the primary instance is not compatible with the database format of the secondary instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 ManagedInstanceFailoverInFailoverGroupInstancesWithDifferentVersionEditions - Failover operation cannot be performed because of database format mismatch between the instances in the failover group. Consider upgrading the database format of the primary instance or deleting the failover group to promote current secondary instance to a stand-alone instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 ManagedInstanceNotAllowedInGeoDRSetupWhenFreemium - Deploying failover group is not supported with the free Azure SQL Managed Instance offer.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 ManagedInstanceUpdateSloOngoing - The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\n\n * 400 FailoverGroupRegionMismatch - Partner region specified in Failover Group need to match the region of the partner managed instance indicated.\n\n * 400 DnsZoneMismatch - The DNSZone on the partner server is different from the DNSZone on the source server. This breaks InstanceFailoverGroup functionality.\n\n * 400 GeoDrInstanceSizeMismatch - Primary managed instance and partner managed instance do not have the same storage size.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 GeoDrSecondaryInstanceNotEmpty - Secondary managed instance has user databases. To create an instance failover group the secondary managed instance needs to be empty.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ManagedInstanceContainsInaccessibleDatabases - The operation could not be completed because managed instance '{0}' contains databases that are in the Inaccessible state. Please either drop inaccessible databases or fix the issues with access to the customer-managed TDE protector key for managed instance before retrying operation. https://go.microsoft.com/fwlink/?linkid=2111623\n\n * 409 ManagedInstanceHasHybridLink - User tried to initiate operation that is not supported when managed instance has a hybrid link configured.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 InstanceFailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 InstanceFailoverGroupBusy - Instance failover group is busy with another operation.\n\n * 409 InstanceFailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Instance Failover Group name was supplied.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully created the failover group.", @@ -223,13 +228,18 @@ "description": "Successfully deleted the failover group." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary - The given primary field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the instance failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion - The provided partner managed instance region in the instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner region is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount - Only one managed instance pair is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid - The create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the instance failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues - Grace period value for the instance failover group must be greater than or equal to the '{0}' minutes minimum grace period\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update instance failover group request body should not modify the read-only property '{0}'.\n\n * 400 InstanceFailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of instance failover group.\n\n * 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription - Primary server and the partner server of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ServerEditionMismatch - Edition must be the same as the primary server when creating a replica server.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in an Instance Failover Group need to reside in different regions to provide isolation.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 InstanceFailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a instance failover group.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceEstablishingFailoverGroupGeoPrimaryWithNewerVersionEditionThanSecondary - Failover group cannot be created because database format of the primary instance is not compatible with the database format of the secondary instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 ManagedInstanceFailoverInFailoverGroupInstancesWithDifferentVersionEditions - Failover operation cannot be performed because of database format mismatch between the instances in the failover group. Consider upgrading the database format of the primary instance or deleting the failover group to promote current secondary instance to a stand-alone instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 ManagedInstanceUpdateSloOngoing - The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\n\n * 400 FailoverGroupRegionMismatch - Partner region specified in Failover Group need to match the region of the partner managed instance indicated.\n\n * 400 DnsZoneMismatch - The DNSZone on the partner server is different from the DNSZone on the source server. This breaks InstanceFailoverGroup functionality.\n\n * 400 GeoDrInstanceSizeMismatch - Primary managed instance and partner managed instance do not have the same storage size.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 GeoDrSecondaryInstanceNotEmpty - Secondary managed instance has user databases. To create an instance failover group the secondary managed instance needs to be empty.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ManagedInstanceContainsInaccessibleDatabases - The operation could not be completed because managed instance '{0}' contains databases that are in the Inaccessible state. Please either drop inaccessible databases or fix the issues with access to the customer-managed TDE protector key for managed instance before retrying operation. https://go.microsoft.com/fwlink/?linkid=2111623\n\n * 409 ManagedInstanceHasHybridLink - User tried to initiate operation that is not supported when managed instance has a hybrid link configured.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 InstanceFailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 InstanceFailoverGroupBusy - Instance failover group is busy with another operation.\n\n * 409 InstanceFailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Instance Failover Group name was supplied.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary - The given primary field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the instance failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion - The provided partner managed instance region in the instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner region is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount - Only one managed instance pair is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid - The create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the instance failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues - Grace period value for the instance failover group must be greater than or equal to the '{0}' minutes minimum grace period\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update instance failover group request body should not modify the read-only property '{0}'.\n\n * 400 InstanceFailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of instance failover group.\n\n * 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription - Primary server and the partner server of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ServerEditionMismatch - Edition must be the same as the primary server when creating a replica server.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in an Instance Failover Group need to reside in different regions to provide isolation.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 InstanceFailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a instance failover group.\n\n * 400 ManagedInstanceGeoDRNotAllowedForInstancePool - Creating auto-failover group (GeoDR) is not supported for Managed Instances provisioned inside instance pools. Auto failover groups can be created only for standalone Managed Instances.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceEstablishingFailoverGroupGeoPrimaryWithNewerVersionEditionThanSecondary - Failover group cannot be created because database format of the primary instance is not compatible with the database format of the secondary instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 ManagedInstanceFailoverInFailoverGroupInstancesWithDifferentVersionEditions - Failover operation cannot be performed because of database format mismatch between the instances in the failover group. Consider upgrading the database format of the primary instance or deleting the failover group to promote current secondary instance to a stand-alone instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 ManagedInstanceNotAllowedInGeoDRSetupWhenFreemium - Deploying failover group is not supported with the free Azure SQL Managed Instance offer.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 ManagedInstanceUpdateSloOngoing - The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\n\n * 400 FailoverGroupRegionMismatch - Partner region specified in Failover Group need to match the region of the partner managed instance indicated.\n\n * 400 DnsZoneMismatch - The DNSZone on the partner server is different from the DNSZone on the source server. This breaks InstanceFailoverGroup functionality.\n\n * 400 GeoDrInstanceSizeMismatch - Primary managed instance and partner managed instance do not have the same storage size.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 GeoDrSecondaryInstanceNotEmpty - Secondary managed instance has user databases. To create an instance failover group the secondary managed instance needs to be empty.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ManagedInstanceContainsInaccessibleDatabases - The operation could not be completed because managed instance '{0}' contains databases that are in the Inaccessible state. Please either drop inaccessible databases or fix the issues with access to the customer-managed TDE protector key for managed instance before retrying operation. https://go.microsoft.com/fwlink/?linkid=2111623\n\n * 409 ManagedInstanceHasHybridLink - User tried to initiate operation that is not supported when managed instance has a hybrid link configured.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 InstanceFailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 InstanceFailoverGroupBusy - Instance failover group is busy with another operation.\n\n * 409 InstanceFailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Instance Failover Group name was supplied.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "The specified failover group does not exist." @@ -283,13 +293,18 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary - The given primary field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the instance failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion - The provided partner managed instance region in the instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner region is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount - Only one managed instance pair is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid - The create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the instance failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues - Grace period value for the instance failover group must be greater than or equal to the '{0}' minutes minimum grace period\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update instance failover group request body should not modify the read-only property '{0}'.\n\n * 400 InstanceFailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of instance failover group.\n\n * 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription - Primary server and the partner server of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ServerEditionMismatch - Edition must be the same as the primary server when creating a replica server.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in an Instance Failover Group need to reside in different regions to provide isolation.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 InstanceFailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a instance failover group.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceEstablishingFailoverGroupGeoPrimaryWithNewerVersionEditionThanSecondary - Failover group cannot be created because database format of the primary instance is not compatible with the database format of the secondary instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 ManagedInstanceFailoverInFailoverGroupInstancesWithDifferentVersionEditions - Failover operation cannot be performed because of database format mismatch between the instances in the failover group. Consider upgrading the database format of the primary instance or deleting the failover group to promote current secondary instance to a stand-alone instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 ManagedInstanceUpdateSloOngoing - The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\n\n * 400 FailoverGroupRegionMismatch - Partner region specified in Failover Group need to match the region of the partner managed instance indicated.\n\n * 400 DnsZoneMismatch - The DNSZone on the partner server is different from the DNSZone on the source server. This breaks InstanceFailoverGroup functionality.\n\n * 400 GeoDrInstanceSizeMismatch - Primary managed instance and partner managed instance do not have the same storage size.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 GeoDrSecondaryInstanceNotEmpty - Secondary managed instance has user databases. To create an instance failover group the secondary managed instance needs to be empty.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ManagedInstanceContainsInaccessibleDatabases - The operation could not be completed because managed instance '{0}' contains databases that are in the Inaccessible state. Please either drop inaccessible databases or fix the issues with access to the customer-managed TDE protector key for managed instance before retrying operation. https://go.microsoft.com/fwlink/?linkid=2111623\n\n * 409 ManagedInstanceHasHybridLink - User tried to initiate operation that is not supported when managed instance has a hybrid link configured.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 InstanceFailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 InstanceFailoverGroupBusy - Instance failover group is busy with another operation.\n\n * 409 InstanceFailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Instance Failover Group name was supplied.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary - The given primary field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the instance failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion - The provided partner managed instance region in the instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner region is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount - Only one managed instance pair is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid - The create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the instance failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues - Grace period value for the instance failover group must be greater than or equal to the '{0}' minutes minimum grace period\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update instance failover group request body should not modify the read-only property '{0}'.\n\n * 400 InstanceFailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of instance failover group.\n\n * 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription - Primary server and the partner server of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ServerEditionMismatch - Edition must be the same as the primary server when creating a replica server.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in an Instance Failover Group need to reside in different regions to provide isolation.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 InstanceFailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a instance failover group.\n\n * 400 ManagedInstanceGeoDRNotAllowedForInstancePool - Creating auto-failover group (GeoDR) is not supported for Managed Instances provisioned inside instance pools. Auto failover groups can be created only for standalone Managed Instances.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceEstablishingFailoverGroupGeoPrimaryWithNewerVersionEditionThanSecondary - Failover group cannot be created because database format of the primary instance is not compatible with the database format of the secondary instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 ManagedInstanceFailoverInFailoverGroupInstancesWithDifferentVersionEditions - Failover operation cannot be performed because of database format mismatch between the instances in the failover group. Consider upgrading the database format of the primary instance or deleting the failover group to promote current secondary instance to a stand-alone instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 ManagedInstanceNotAllowedInGeoDRSetupWhenFreemium - Deploying failover group is not supported with the free Azure SQL Managed Instance offer.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 ManagedInstanceUpdateSloOngoing - The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\n\n * 400 FailoverGroupRegionMismatch - Partner region specified in Failover Group need to match the region of the partner managed instance indicated.\n\n * 400 DnsZoneMismatch - The DNSZone on the partner server is different from the DNSZone on the source server. This breaks InstanceFailoverGroup functionality.\n\n * 400 GeoDrInstanceSizeMismatch - Primary managed instance and partner managed instance do not have the same storage size.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 GeoDrSecondaryInstanceNotEmpty - Secondary managed instance has user databases. To create an instance failover group the secondary managed instance needs to be empty.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ManagedInstanceContainsInaccessibleDatabases - The operation could not be completed because managed instance '{0}' contains databases that are in the Inaccessible state. Please either drop inaccessible databases or fix the issues with access to the customer-managed TDE protector key for managed instance before retrying operation. https://go.microsoft.com/fwlink/?linkid=2111623\n\n * 409 ManagedInstanceHasHybridLink - User tried to initiate operation that is not supported when managed instance has a hybrid link configured.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 InstanceFailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 InstanceFailoverGroupBusy - Instance failover group is busy with another operation.\n\n * 409 InstanceFailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Instance Failover Group name was supplied.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -340,13 +355,18 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary - The given primary field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the instance failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion - The provided partner managed instance region in the instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner region is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount - Only one managed instance pair is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid - The create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the instance failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues - Grace period value for the instance failover group must be greater than or equal to the '{0}' minutes minimum grace period\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update instance failover group request body should not modify the read-only property '{0}'.\n\n * 400 InstanceFailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of instance failover group.\n\n * 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription - Primary server and the partner server of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ServerEditionMismatch - Edition must be the same as the primary server when creating a replica server.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in an Instance Failover Group need to reside in different regions to provide isolation.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 InstanceFailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a instance failover group.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceEstablishingFailoverGroupGeoPrimaryWithNewerVersionEditionThanSecondary - Failover group cannot be created because database format of the primary instance is not compatible with the database format of the secondary instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 ManagedInstanceFailoverInFailoverGroupInstancesWithDifferentVersionEditions - Failover operation cannot be performed because of database format mismatch between the instances in the failover group. Consider upgrading the database format of the primary instance or deleting the failover group to promote current secondary instance to a stand-alone instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 ManagedInstanceUpdateSloOngoing - The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\n\n * 400 FailoverGroupRegionMismatch - Partner region specified in Failover Group need to match the region of the partner managed instance indicated.\n\n * 400 DnsZoneMismatch - The DNSZone on the partner server is different from the DNSZone on the source server. This breaks InstanceFailoverGroup functionality.\n\n * 400 GeoDrInstanceSizeMismatch - Primary managed instance and partner managed instance do not have the same storage size.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 GeoDrSecondaryInstanceNotEmpty - Secondary managed instance has user databases. To create an instance failover group the secondary managed instance needs to be empty.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ManagedInstanceContainsInaccessibleDatabases - The operation could not be completed because managed instance '{0}' contains databases that are in the Inaccessible state. Please either drop inaccessible databases or fix the issues with access to the customer-managed TDE protector key for managed instance before retrying operation. https://go.microsoft.com/fwlink/?linkid=2111623\n\n * 409 ManagedInstanceHasHybridLink - User tried to initiate operation that is not supported when managed instance has a hybrid link configured.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 InstanceFailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 InstanceFailoverGroupBusy - Instance failover group is busy with another operation.\n\n * 409 InstanceFailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Instance Failover Group name was supplied.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary - The given primary field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the instance failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion - The provided partner managed instance region in the instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner region is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount - Only one managed instance pair is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid - The create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the instance failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues - Grace period value for the instance failover group must be greater than or equal to the '{0}' minutes minimum grace period\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update instance failover group request body should not modify the read-only property '{0}'.\n\n * 400 InstanceFailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of instance failover group.\n\n * 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription - Primary server and the partner server of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ServerEditionMismatch - Edition must be the same as the primary server when creating a replica server.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in an Instance Failover Group need to reside in different regions to provide isolation.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 InstanceFailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a instance failover group.\n\n * 400 ManagedInstanceGeoDRNotAllowedForInstancePool - Creating auto-failover group (GeoDR) is not supported for Managed Instances provisioned inside instance pools. Auto failover groups can be created only for standalone Managed Instances.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceEstablishingFailoverGroupGeoPrimaryWithNewerVersionEditionThanSecondary - Failover group cannot be created because database format of the primary instance is not compatible with the database format of the secondary instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 ManagedInstanceFailoverInFailoverGroupInstancesWithDifferentVersionEditions - Failover operation cannot be performed because of database format mismatch between the instances in the failover group. Consider upgrading the database format of the primary instance or deleting the failover group to promote current secondary instance to a stand-alone instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 ManagedInstanceNotAllowedInGeoDRSetupWhenFreemium - Deploying failover group is not supported with the free Azure SQL Managed Instance offer.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 ManagedInstanceUpdateSloOngoing - The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\n\n * 400 FailoverGroupRegionMismatch - Partner region specified in Failover Group need to match the region of the partner managed instance indicated.\n\n * 400 DnsZoneMismatch - The DNSZone on the partner server is different from the DNSZone on the source server. This breaks InstanceFailoverGroup functionality.\n\n * 400 GeoDrInstanceSizeMismatch - Primary managed instance and partner managed instance do not have the same storage size.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 GeoDrSecondaryInstanceNotEmpty - Secondary managed instance has user databases. To create an instance failover group the secondary managed instance needs to be empty.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ManagedInstanceContainsInaccessibleDatabases - The operation could not be completed because managed instance '{0}' contains databases that are in the Inaccessible state. Please either drop inaccessible databases or fix the issues with access to the customer-managed TDE protector key for managed instance before retrying operation. https://go.microsoft.com/fwlink/?linkid=2111623\n\n * 409 ManagedInstanceHasHybridLink - User tried to initiate operation that is not supported when managed instance has a hybrid link configured.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 InstanceFailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 InstanceFailoverGroupBusy - Instance failover group is busy with another operation.\n\n * 409 InstanceFailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Instance Failover Group name was supplied.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/InstancePools.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/InstancePools.json index c01a3bf7da30..504bf587072d 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/InstancePools.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/InstancePools.json @@ -183,13 +183,18 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidMinimalTlsVersion - Invalid minimal TLS version.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled.\n\n * 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.\n\n * 400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool.\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 400 MissingSkuName - Sku name is required.\n\n * 400 InstancePoolRequestedVcoreCountIsInvalid - Requested vcore count for instance pool is invalid\n\n * 400 InstancePoolRequestMissingSku - Instance pool request is missing sku\n\n * 400 InstancePoolRequestMissingSkuTier - Instance pool request is missing sku tier\n\n * 400 InstancePoolRequestMissingSkuFamily - Instance pool request is missing sku family\n\n * 400 InstancePoolRequestedSubnetResourceIdIsInvalid - Subnet id for instance pool is null or empty\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 InstancePoolBusy - An instance pool is busy with another ongoing operation\n\n * 409 MiCreateFailedNonDelegatedSubnet - User tried to deploy Managed Instance or Managed Instance pool in subnet that is not delegated to Microsoft.Sql/managedInstances.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "description": "*** Error Responses: ***\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidMinimalTlsVersion - Invalid minimal TLS version.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled.\n\n * 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.\n\n * 400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool.\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 400 MissingSkuName - Sku name is required.\n\n * 400 InstancePoolRequestedVcoreCountIsInvalid - Requested vcore count for instance pool is invalid\n\n * 400 InstancePoolRequestMissingSku - Instance pool request is missing sku\n\n * 400 InstancePoolRequestMissingSkuTier - Instance pool request is missing sku tier\n\n * 400 InstancePoolRequestMissingSkuFamily - Instance pool request is missing sku family\n\n * 400 InstancePoolRequestedSubnetResourceIdIsInvalid - Subnet id for instance pool is null or empty\n\n * 400 DeploymentIntoPrivateSubnetsNotAllowed - Deploying managed instances and instance pools into private subnets is not supported.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 InstancePoolBusy - An instance pool is busy with another ongoing operation\n\n * 409 MiCreateFailedNonDelegatedSubnet - User tried to deploy Managed Instance or Managed Instance pool in subnet that is not delegated to Microsoft.Sql/managedInstances.\n\n * 409 MiCreateFailedNonDelegatedSubnet - User tried to deploy Managed Instance or Managed Instance pool in subnet that is not delegated to Microsoft.Sql/managedInstances.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully created the instance pool.", @@ -243,7 +248,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "The specified instance pool does not exist." @@ -303,7 +313,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/JobAgents.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/JobAgents.json index c4eace4f796b..35afbc9a6243 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/JobAgents.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/JobAgents.json @@ -159,7 +159,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully created the job agent.", @@ -219,7 +224,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "The specified job agent does not exist." @@ -282,7 +292,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/JobExecutions.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/JobExecutions.json index 4f3b9f0bdaf6..5a431161d930 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/JobExecutions.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/JobExecutions.json @@ -359,7 +359,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully started an execution for the job.", @@ -486,7 +491,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/JobPrivateEndpoints.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/JobPrivateEndpoints.json index 05a118a3c0bb..38172266c94a 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/JobPrivateEndpoints.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/JobPrivateEndpoints.json @@ -180,7 +180,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully created the private endpoint.", @@ -244,7 +249,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "The specified private endpoint does not exist." diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/Jobs.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/Jobs.json index bf7b8607230f..bd5598f0a259 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/Jobs.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/Jobs.json @@ -315,13 +315,13 @@ "startTime": { "format": "date-time", "description": "Schedule start time.", - "default": "0001-01-01T05:30:00+05:30", + "default": "0001-01-01T16:00:00-08:00", "type": "string" }, "endTime": { "format": "date-time", "description": "Schedule end time.", - "default": "9999-12-31T17:29:59+05:30", + "default": "9999-12-31T03:59:59-08:00", "type": "string" }, "type": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/LedgerDigestUploads.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/LedgerDigestUploads.json index d32abdd6d7e8..fe3b621eb2aa 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/LedgerDigestUploads.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/LedgerDigestUploads.json @@ -48,7 +48,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage or Azure Confidential Ledger endpoint.\n\n * 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI.\n\n * 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Please use the key name “current”.\n\n * 404 ResourceNotFound - The requested resource was not found.", + "description": "*** Error Responses: ***\n\n * 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage or Azure Confidential Ledger endpoint.\n\n * 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI.\n\n * 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Use the key name “current”.\n\n * 404 ResourceNotFound - The requested resource was not found.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -109,7 +109,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage or Azure Confidential Ledger endpoint.\n\n * 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI.\n\n * 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Please use the key name “current”.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.", + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage or Azure Confidential Ledger endpoint.\n\n * 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI.\n\n * 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Use the key name “current”.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -173,13 +173,18 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage or Azure Confidential Ledger endpoint.\n\n * 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI.\n\n * 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Please use the key name “current”.\n\n * 400 InvalidStorageAccountName - The specified storage account is not valid or does not exist.\n\n * 400 InvalidOperationOnNamedReplicas - The ledger digest storage cannot be configured on a named replica.\n\n * 400 NoServerIdentity - No identity is configured for specified server. For information on how to configure an identity for the server see https://go.microsoft.com/fwlink/?linkid=2156804\n\n * 400 SubscriptionDoesNotHaveServer - Subscription does not contain server.\n\n * 400 LedgerMissingDigestStorageEndPoint - User attempted to configure ledger digest storage without providing an endpoint\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered. The error message from Active Directory Authentication library (ADAL) is {0}.\n\n * 400 LedgerException - The server encountered an unexpected exception\n\n * 400 LedgerDigestUploadIsNotSupportedOnResourceType - Uploading ledger digests is currently not supported for this resource type.\n\n * 400 LedgerDigestUploadsNotSupportedOnGeoSecondary - The ledger digest storage cannot be configured on secondary databases.\n\n * 400 InvalidStorageAccountName - The specified storage account is not valid or does not exist.\n\n * 400 PreviousOperationInProgress - Uploading ledger digests is being enabled or disabled for database. Please wait for the previous request to complete.\n\n * 400 LedgerDigestUploadsNotSupportedOnGeoChaining - User attempted to set automatic upload of ledger digest in database configured with secondaries of secondaries.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage or Azure Confidential Ledger endpoint.\n\n * 400 InsufficientStorageAccountPermissions - Read or write operations are not allowed on the storage account.\n\n * 400 LedgerDigestOutboundFirewallRuleException - Failed to update ledger digest due to outbound firewall rules\n\n * 400 StorageAccountIsDisabled - The storage account is disabled.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SourceDatabaseNotFound - Specified database does not exist.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "description": "*** Error Responses: ***\n\n * 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage or Azure Confidential Ledger endpoint.\n\n * 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI.\n\n * 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Use the key name “current”.\n\n * 400 InvalidStorageAccountName - The specified storage account is not valid or does not exist.\n\n * 400 InvalidOperationOnNamedReplicas - The ledger digest storage cannot be configured on a named replica.\n\n * 400 NoServerIdentity - No identity is configured for specified server. For information on how to configure an identity for the server see https://go.microsoft.com/fwlink/?linkid=2156804\n\n * 400 SubscriptionDoesNotHaveServer - Subscription does not contain server.\n\n * 400 LedgerMissingDigestStorageEndPoint - User attempted to configure ledger digest storage without providing an endpoint\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered. The error message from Active Directory Authentication library (ADAL) is {0}.\n\n * 400 LedgerException - The server encountered an unexpected exception\n\n * 400 LedgerDigestUploadIsNotSupportedOnResourceType - Uploading ledger digests is currently not supported for this resource type.\n\n * 400 LedgerDigestUploadsNotSupportedOnGeoSecondary - The ledger digest storage cannot be configured on secondary databases.\n\n * 400 InvalidStorageAccountName - The specified storage account is not valid or does not exist.\n\n * 400 PreviousOperationInProgress - Uploading ledger digests is being enabled or disabled for database. Wait for the previous request to complete.\n\n * 400 LedgerDigestUploadsNotSupportedOnGeoChaining - User attempted to set automatic upload of ledger digest in database configured with secondaries of secondaries.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage or Azure Confidential Ledger endpoint.\n\n * 400 InsufficientStorageAccountPermissions - Read or write operations are not allowed on the storage account.\n\n * 400 LedgerDigestOutboundFirewallRuleException - Failed to update ledger digest due to outbound firewall rules\n\n * 400 StorageAccountIsDisabled - The storage account is disabled.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SourceDatabaseNotFound - Specified database does not exist.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Updating the ledger digest upload configuration is in progress." + "description": "Updating the ledger digest upload configuration is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -235,13 +240,18 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage or Azure Confidential Ledger endpoint.\n\n * 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI.\n\n * 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Please use the key name “current”.\n\n * 400 InvalidStorageAccountName - The specified storage account is not valid or does not exist.\n\n * 400 InvalidOperationOnNamedReplicas - The ledger digest storage cannot be configured on a named replica.\n\n * 400 NoServerIdentity - No identity is configured for specified server. For information on how to configure an identity for the server see https://go.microsoft.com/fwlink/?linkid=2156804\n\n * 400 SubscriptionDoesNotHaveServer - Subscription does not contain server.\n\n * 400 LedgerMissingDigestStorageEndPoint - User attempted to configure ledger digest storage without providing an endpoint\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered. The error message from Active Directory Authentication library (ADAL) is {0}.\n\n * 400 LedgerException - The server encountered an unexpected exception\n\n * 400 LedgerDigestUploadIsNotSupportedOnResourceType - Uploading ledger digests is currently not supported for this resource type.\n\n * 400 LedgerDigestUploadsNotSupportedOnGeoSecondary - The ledger digest storage cannot be configured on secondary databases.\n\n * 400 InvalidStorageAccountName - The specified storage account is not valid or does not exist.\n\n * 400 PreviousOperationInProgress - Uploading ledger digests is being enabled or disabled for database. Please wait for the previous request to complete.\n\n * 400 LedgerDigestUploadsNotSupportedOnGeoChaining - User attempted to set automatic upload of ledger digest in database configured with secondaries of secondaries.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage or Azure Confidential Ledger endpoint.\n\n * 400 InsufficientStorageAccountPermissions - Read or write operations are not allowed on the storage account.\n\n * 400 LedgerDigestOutboundFirewallRuleException - Failed to update ledger digest due to outbound firewall rules\n\n * 400 StorageAccountIsDisabled - The storage account is disabled.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SourceDatabaseNotFound - Specified database does not exist.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "description": "*** Error Responses: ***\n\n * 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage or Azure Confidential Ledger endpoint.\n\n * 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI.\n\n * 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Use the key name “current”.\n\n * 400 InvalidStorageAccountName - The specified storage account is not valid or does not exist.\n\n * 400 InvalidOperationOnNamedReplicas - The ledger digest storage cannot be configured on a named replica.\n\n * 400 NoServerIdentity - No identity is configured for specified server. For information on how to configure an identity for the server see https://go.microsoft.com/fwlink/?linkid=2156804\n\n * 400 SubscriptionDoesNotHaveServer - Subscription does not contain server.\n\n * 400 LedgerMissingDigestStorageEndPoint - User attempted to configure ledger digest storage without providing an endpoint\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered. The error message from Active Directory Authentication library (ADAL) is {0}.\n\n * 400 LedgerException - The server encountered an unexpected exception\n\n * 400 LedgerDigestUploadIsNotSupportedOnResourceType - Uploading ledger digests is currently not supported for this resource type.\n\n * 400 LedgerDigestUploadsNotSupportedOnGeoSecondary - The ledger digest storage cannot be configured on secondary databases.\n\n * 400 InvalidStorageAccountName - The specified storage account is not valid or does not exist.\n\n * 400 PreviousOperationInProgress - Uploading ledger digests is being enabled or disabled for database. Wait for the previous request to complete.\n\n * 400 LedgerDigestUploadsNotSupportedOnGeoChaining - User attempted to set automatic upload of ledger digest in database configured with secondaries of secondaries.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage or Azure Confidential Ledger endpoint.\n\n * 400 InsufficientStorageAccountPermissions - Read or write operations are not allowed on the storage account.\n\n * 400 LedgerDigestOutboundFirewallRuleException - Failed to update ledger digest due to outbound firewall rules\n\n * 400 StorageAccountIsDisabled - The storage account is disabled.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SourceDatabaseNotFound - Specified database does not exist.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Disabling the ledger digest upload is in progress." + "description": "Disabling the ledger digest upload is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/LocationCapabilities.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/LocationCapabilities.json index b4938307dec6..c06f91399bbc 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/LocationCapabilities.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/LocationCapabilities.json @@ -787,6 +787,11 @@ "readOnly": true, "x-ms-identifiers": [] }, + "isZoneResilientProvisioningAllowed": { + "description": "Whether or not the subscription is allowed to provision zone resilient resources.", + "type": "boolean", + "readOnly": true + }, "status": { "description": "The status of the capability.", "enum": [ diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/LongTermRetentionBackups.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/LongTermRetentionBackups.json index 663d9f86bfa1..fee8bfc5ceae 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/LongTermRetentionBackups.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/LongTermRetentionBackups.json @@ -360,7 +360,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -432,7 +437,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -509,7 +519,12 @@ } }, "202": { - "description": "Copying the backup is in progress." + "description": "Copying the backup is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -586,7 +601,12 @@ } }, "202": { - "description": "Updating the backup is in progress." + "description": "Updating the backup is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -956,7 +976,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -1031,7 +1056,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -1111,7 +1141,12 @@ } }, "202": { - "description": "Copying the backup is in progress." + "description": "Copying the backup is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -1191,7 +1226,12 @@ } }, "202": { - "description": "Updating the backup is in progress." + "description": "Updating the backup is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/LongTermRetentionManagedInstanceBackups.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/LongTermRetentionManagedInstanceBackups.json index caab5352ba0c..62352dac74aa 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/LongTermRetentionManagedInstanceBackups.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/LongTermRetentionManagedInstanceBackups.json @@ -311,7 +311,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -705,7 +710,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/LongTermRetentionPolicies.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/LongTermRetentionPolicies.json index 7ae87f0bace4..96bad8d1cf00 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/LongTermRetentionPolicies.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/LongTermRetentionPolicies.json @@ -182,7 +182,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/MaintenanceWindows.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/MaintenanceWindows.json index 2afa84cdd70e..f212a3cc5db5 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/MaintenanceWindows.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/MaintenanceWindows.json @@ -16,7 +16,7 @@ "application/json" ], "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/maintenanceWindows/current": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/maintenanceWindows/{maintenanceWindowName}": { "get": { "tags": [ "MaintenanceWindows" @@ -39,7 +39,7 @@ }, { "name": "maintenanceWindowName", - "in": "query", + "in": "path", "description": "Maintenance window name.", "required": true, "type": "string" @@ -59,7 +59,10 @@ } }, "default": { - "description": "*** Error Responses: ***" + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } } }, "x-ms-examples": { @@ -90,7 +93,7 @@ }, { "name": "maintenanceWindowName", - "in": "query", + "in": "path", "description": "Maintenance window name.", "required": true, "type": "string" @@ -115,7 +118,10 @@ "description": "Successfully set maintenance windows settings." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidMaintenanceWindowSelection - Invalid maintenance window selection." + "description": "*** Error Responses: ***\n\n * 400 InvalidMaintenanceWindowSelection - Invalid maintenance window selection.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } } }, "x-ms-examples": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedBackupShortTermRetentionPolicies.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedBackupShortTermRetentionPolicies.json index 64f53278b4e9..8cec1f2ca784 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedBackupShortTermRetentionPolicies.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedBackupShortTermRetentionPolicies.json @@ -182,7 +182,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -252,7 +257,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedDatabaseMoveOperations.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedDatabaseMoveOperations.json index 4c66f16b3e14..c04bee7242f5 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedDatabaseMoveOperations.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedDatabaseMoveOperations.json @@ -62,7 +62,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary - The given primary field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the instance failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion - The provided partner managed instance region in the instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner region is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount - Only one managed instance pair is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid - The create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the instance failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues - Grace period value for the instance failover group must be greater than or equal to the '{0}' minutes minimum grace period\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update instance failover group request body should not modify the read-only property '{0}'.\n\n * 400 InstanceFailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of instance failover group.\n\n * 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription - Primary server and the partner server of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 ManagedInstanceDatabaseCopyOrMoveToInstanceWithOlderVersionEdition - Operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 400 ManagedInstanceDatabaseLimitExceeded - This operation cannot start because specified target managed instance '{0}' already has maximum number of user databases.\n\n * 400 BrokenConnectivityBetweenInstances - Database '{0}' operation failed because there is no network connectivity between source instance '{1}' and target instance '{2}'.\n\n * 400 XtpServerStateMismatch - Both source and target servers do not support memory optimized data.\n\n * 400 SubnetOverlapBetweenInstances - Database '{0}' operation failed because there is no connectivity between source and target Azure SQL Managed Instance. This is because the target instance subnet has an overlapping address range with the subnet of the source instance.\n\n * 400 CrossTenantOperationNotSupported - Cross tenant operation is not supported.\n\n * 400 TargetInsufficientStorage - Attempt to move/restore/copy database on the destination instance with insufficient space.\n\n * 400 CrossResourceOperationNotSupported - Cross resource operation is not supported.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedDatabaseGPFileSizeLimitExceeded - Creating a copy of a managed database on different SQL Managed Instance with General Purpose service tier would violate data file size limit. See: 'https://docs.microsoft.com/azure/azure-sql/managed-instance/resource-limits#service-tier-characteristics'.\n\n * 400 ManagedInstanceGPStorageAccountLimitExceeded - Creating a copy of a database on different SQL Managed Instance with General Purpose service tier would violate storage account size limit. See: 'https://docs.microsoft.com/azure/azure-sql/managed-instance/resource-limits#service-tier-characteristics'.\n\n * 400 SystemDatabaseUnsupportedOperation - Unsupported operation for system database.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ServerEditionMismatch - Edition must be the same as the primary server when creating a replica server.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in an Instance Failover Group need to reside in different regions to provide isolation.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 InstanceFailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a instance failover group.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceEstablishingFailoverGroupGeoPrimaryWithNewerVersionEditionThanSecondary - Failover group cannot be created because database format of the primary instance is not compatible with the database format of the secondary instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 ManagedInstanceFailoverInFailoverGroupInstancesWithDifferentVersionEditions - Failover operation cannot be performed because of database format mismatch between the instances in the failover group. Consider upgrading the database format of the primary instance or deleting the failover group to promote current secondary instance to a stand-alone instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 ManagedInstanceUpdateSloOngoing - The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\n\n * 400 FailoverGroupRegionMismatch - Partner region specified in Failover Group need to match the region of the partner managed instance indicated.\n\n * 400 DnsZoneMismatch - The DNSZone on the partner server is different from the DNSZone on the source server. This breaks InstanceFailoverGroup functionality.\n\n * 400 GeoDrInstanceSizeMismatch - Primary managed instance and partner managed instance do not have the same storage size.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 GeoDrSecondaryInstanceNotEmpty - Secondary managed instance has user databases. To create an instance failover group the secondary managed instance needs to be empty.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 StorageAccountFull - Managed Instance has reached the total capacity of underlying Azure storage account. Azure Premium Storage account is limited to 35TB of allocated space.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 ManagedInstanceRestoreToInstanceWithOlderVersionEdition - Restore operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ManagedDatabaseMoveOperationResultsInvalidODataQuery - The specified OData query is either not valid or not supported\n\n * 404 CrossManagedInstanceDatabaseMovementNotExist - Database movement does not exist.\n\n * 404 ResourceNotFound - Invalid request specifying a non-existent resource.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ManagedInstanceContainsInaccessibleDatabases - The operation could not be completed because managed instance '{0}' contains databases that are in the Inaccessible state. Please either drop inaccessible databases or fix the issues with access to the customer-managed TDE protector key for managed instance before retrying operation. https://go.microsoft.com/fwlink/?linkid=2111623\n\n * 409 ManagedInstanceHasHybridLink - User tried to initiate operation that is not supported when managed instance has a hybrid link configured.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 InstanceFailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 InstanceFailoverGroupBusy - Instance failover group is busy with another operation.\n\n * 409 InstanceFailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Instance Failover Group name was supplied.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary - The given primary field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the instance failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion - The provided partner managed instance region in the instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner region is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount - Only one managed instance pair is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid - The create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the instance failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues - Grace period value for the instance failover group must be greater than or equal to the '{0}' minutes minimum grace period\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update instance failover group request body should not modify the read-only property '{0}'.\n\n * 400 InstanceFailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of instance failover group.\n\n * 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription - Primary server and the partner server of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 ManagedInstanceDatabaseCopyOrMoveToInstanceWithOlderVersionEdition - Operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 400 ManagedInstanceDatabaseLimitExceeded - This operation cannot start because specified target managed instance '{0}' already has maximum number of user databases.\n\n * 400 BrokenConnectivityBetweenInstances - Database '{0}' operation failed because there is no network connectivity between source instance '{1}' and target instance '{2}'.\n\n * 400 XtpServerStateMismatch - Both source and target servers do not support memory optimized data.\n\n * 400 SubnetOverlapBetweenInstances - Database '{0}' operation failed because there is no connectivity between source and target Azure SQL Managed Instance. This is because the target instance subnet has an overlapping address range with the subnet of the source instance.\n\n * 400 CrossTenantOperationNotSupported - Cross tenant operation is not supported.\n\n * 400 TargetInsufficientStorage - Attempt to move/restore/copy database on the destination instance with insufficient space.\n\n * 400 CrossResourceOperationNotSupported - Cross resource operation is not supported.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedDatabaseGPFileSizeLimitExceeded - Creating a copy of a managed database on different SQL Managed Instance with General Purpose service tier would violate data file size limit. See: 'https://docs.microsoft.com/azure/azure-sql/managed-instance/resource-limits#service-tier-characteristics'.\n\n * 400 ManagedInstanceGPStorageAccountLimitExceeded - Creating a copy of a database on different SQL Managed Instance with General Purpose service tier would violate storage account size limit. See: 'https://docs.microsoft.com/azure/azure-sql/managed-instance/resource-limits#service-tier-characteristics'.\n\n * 400 SystemDatabaseUnsupportedOperation - Unsupported operation for system database.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ServerEditionMismatch - Edition must be the same as the primary server when creating a replica server.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in an Instance Failover Group need to reside in different regions to provide isolation.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 InstanceFailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a instance failover group.\n\n * 400 ManagedInstanceGeoDRNotAllowedForInstancePool - Creating auto-failover group (GeoDR) is not supported for Managed Instances provisioned inside instance pools. Auto failover groups can be created only for standalone Managed Instances.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceEstablishingFailoverGroupGeoPrimaryWithNewerVersionEditionThanSecondary - Failover group cannot be created because database format of the primary instance is not compatible with the database format of the secondary instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 ManagedInstanceFailoverInFailoverGroupInstancesWithDifferentVersionEditions - Failover operation cannot be performed because of database format mismatch between the instances in the failover group. Consider upgrading the database format of the primary instance or deleting the failover group to promote current secondary instance to a stand-alone instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 ManagedInstanceNotAllowedInGeoDRSetupWhenFreemium - Deploying failover group is not supported with the free Azure SQL Managed Instance offer.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 ManagedInstanceUpdateSloOngoing - The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\n\n * 400 FailoverGroupRegionMismatch - Partner region specified in Failover Group need to match the region of the partner managed instance indicated.\n\n * 400 DnsZoneMismatch - The DNSZone on the partner server is different from the DNSZone on the source server. This breaks InstanceFailoverGroup functionality.\n\n * 400 GeoDrInstanceSizeMismatch - Primary managed instance and partner managed instance do not have the same storage size.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 GeoDrSecondaryInstanceNotEmpty - Secondary managed instance has user databases. To create an instance failover group the secondary managed instance needs to be empty.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 StorageAccountFull - Managed Instance has reached the total capacity of underlying Azure storage account. Azure Premium Storage account is limited to 35TB of allocated space.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 ManagedInstanceRestoreToInstanceWithOlderVersionEdition - Restore operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ManagedDatabaseMoveOperationResultsInvalidODataQuery - The specified OData query is either not valid or not supported\n\n * 404 CrossManagedInstanceDatabaseMovementNotExist - Database movement does not exist.\n\n * 404 ResourceNotFound - Invalid request specifying a non-existent resource.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ManagedInstanceContainsInaccessibleDatabases - The operation could not be completed because managed instance '{0}' contains databases that are in the Inaccessible state. Please either drop inaccessible databases or fix the issues with access to the customer-managed TDE protector key for managed instance before retrying operation. https://go.microsoft.com/fwlink/?linkid=2111623\n\n * 409 ManagedInstanceHasHybridLink - User tried to initiate operation that is not supported when managed instance has a hybrid link configured.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 InstanceFailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 InstanceFailoverGroupBusy - Instance failover group is busy with another operation.\n\n * 409 InstanceFailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Instance Failover Group name was supplied.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -124,7 +124,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary - The given primary field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the instance failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion - The provided partner managed instance region in the instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner region is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount - Only one managed instance pair is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid - The create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the instance failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues - Grace period value for the instance failover group must be greater than or equal to the '{0}' minutes minimum grace period\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update instance failover group request body should not modify the read-only property '{0}'.\n\n * 400 InstanceFailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of instance failover group.\n\n * 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription - Primary server and the partner server of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 ManagedInstanceDatabaseCopyOrMoveToInstanceWithOlderVersionEdition - Operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 400 ManagedInstanceDatabaseLimitExceeded - This operation cannot start because specified target managed instance '{0}' already has maximum number of user databases.\n\n * 400 BrokenConnectivityBetweenInstances - Database '{0}' operation failed because there is no network connectivity between source instance '{1}' and target instance '{2}'.\n\n * 400 XtpServerStateMismatch - Both source and target servers do not support memory optimized data.\n\n * 400 SubnetOverlapBetweenInstances - Database '{0}' operation failed because there is no connectivity between source and target Azure SQL Managed Instance. This is because the target instance subnet has an overlapping address range with the subnet of the source instance.\n\n * 400 CrossTenantOperationNotSupported - Cross tenant operation is not supported.\n\n * 400 TargetInsufficientStorage - Attempt to move/restore/copy database on the destination instance with insufficient space.\n\n * 400 CrossResourceOperationNotSupported - Cross resource operation is not supported.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedDatabaseGPFileSizeLimitExceeded - Creating a copy of a managed database on different SQL Managed Instance with General Purpose service tier would violate data file size limit. See: 'https://docs.microsoft.com/azure/azure-sql/managed-instance/resource-limits#service-tier-characteristics'.\n\n * 400 ManagedInstanceGPStorageAccountLimitExceeded - Creating a copy of a database on different SQL Managed Instance with General Purpose service tier would violate storage account size limit. See: 'https://docs.microsoft.com/azure/azure-sql/managed-instance/resource-limits#service-tier-characteristics'.\n\n * 400 SystemDatabaseUnsupportedOperation - Unsupported operation for system database.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ServerEditionMismatch - Edition must be the same as the primary server when creating a replica server.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in an Instance Failover Group need to reside in different regions to provide isolation.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 InstanceFailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a instance failover group.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceEstablishingFailoverGroupGeoPrimaryWithNewerVersionEditionThanSecondary - Failover group cannot be created because database format of the primary instance is not compatible with the database format of the secondary instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 ManagedInstanceFailoverInFailoverGroupInstancesWithDifferentVersionEditions - Failover operation cannot be performed because of database format mismatch between the instances in the failover group. Consider upgrading the database format of the primary instance or deleting the failover group to promote current secondary instance to a stand-alone instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 ManagedInstanceUpdateSloOngoing - The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\n\n * 400 FailoverGroupRegionMismatch - Partner region specified in Failover Group need to match the region of the partner managed instance indicated.\n\n * 400 DnsZoneMismatch - The DNSZone on the partner server is different from the DNSZone on the source server. This breaks InstanceFailoverGroup functionality.\n\n * 400 GeoDrInstanceSizeMismatch - Primary managed instance and partner managed instance do not have the same storage size.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 GeoDrSecondaryInstanceNotEmpty - Secondary managed instance has user databases. To create an instance failover group the secondary managed instance needs to be empty.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 StorageAccountFull - Managed Instance has reached the total capacity of underlying Azure storage account. Azure Premium Storage account is limited to 35TB of allocated space.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 ManagedInstanceRestoreToInstanceWithOlderVersionEdition - Restore operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 UnsupportedBackupStorageRedundancy - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 BackupSetNotFoundRecentPit - No backups were found to restore the database to the specified point in time. Please retry the operation. If the problem persists, contact support to restore the database.\n\n * 400 CannotUpdateIsLedgerDatabase - The ledger property of an existing database cannot be updated.\n\n * 400 LTRSterlingToVldbMigrationNotSupported - Cannot change service objective for database to Hyperscale as long-term retention is not yet supported on Hyperscale. Please disable long-term retention on the database and retry.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 InvalidPublicMaintenanceConfiguration - User tried to specify public maintenance configuration which cannot be converted to internal id (malformed or wrong region).\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 MaintenanceWindowNotSupportedForNamedReplica - User tried to create or update named replica with non-default maintenance window which is not supported.\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 InvalidStandbyGeoReadScale - User attempted to enable read scale on a standby geo database that does not support it.\n\n * 400 PerDatabaseCMKKeyRotationAttemptedWhileOldThumbprintInUse - Key Rotation for the TDE Protector at the database level is blocked when active transactions are holding up the log encrypted with old keys. Please refer to aka.ms/azuresqldbkeyrotation for possible strategies to workaround this issue.\n\n * 400 TierChangeUnsupportedDueToCDCEnabledDatabase - The database cannot update its sku because it is enabled for CDC.\n\n * 400 PerDBCMKNotSupportedWithLTR - Database-level CMK is not supported when Long-term Backup Retention is enabled on the database.\n\n * 400 VBSEnclaveNotSupportedForDW - The preferredEnclaveType is not supported for dedicated SQL Pools.\n\n * 400 VBSEnclaveNotSupportedForDCSeriesSLO - Configuring the 'VBS' preferredEnclaveType for databases using the DC-series hardware configuration is not supported. DC-series databases are pre-configured with Intel SGX enclaves. Virtualization based security (VBS) enclaves are not supported.\n\n * 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutDatabaseLevelEncryptionProtector - Database-level encryption protector must be set on the target database while attempting to copy or replicate a database encrypted with a database level key.\n\n * 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeys - While attempting to replicate a database configured with database level encryption protector, the current keys being used by the primary must be passed to the secondary database.\n\n * 400 PartnerDBNotCompatibleForSGXEnclave - Attempt to set GeoDR link or update SLO for enclave enabled database is only supported when both database are running on DC-series hardware.\n\n * 400 PerDatabaseCMKGeoPrimaryIsNotConfiguredWithDatabaseLevelEncryptionProtector - The geo-primary database must be configured with a database level encryption protector before setting a database level encryption protector on the geo-secondary.\n\n * 400 ElasticJobsNotSupportedOnAutoPauseEnabledDatabase - Auto-pause enabled serverless database is not supported as an Elastic Jobs database because job agent would prevent that database from pausing. You can either disable auto-pause on this serverless database or delete the job agent that is using this database. See here for more details: https://docs.microsoft.com/azure/azure-sql/database/serverless-tier-overview#auto-pausing\n\n * 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave - Configuring geo-replication is not supported for databases using different values of the preferredEnclaveType property. The primary '{0}' database on the '{1}' server uses the '{2}' preferredEnclaveType, whereas the specified preferredEnclaveType for the secondary '{3}' database on the '{4}' server is '{5}'.\n\n * 400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes - Planned failover between primary and secondary database with different preferredEnclaveType is not supported for Virtualization-based security (VBS) enclaves.\n\n * 400 PerDatabaseCMKGeoPrimaryIsConfiguredWithDatabaseLevelEncryptionProtector - The geo-primary database must not be configured with a database level encryption protector when failing over to a geo-secondary without a database level encryption protector.\n\n * 400 CreateDatabaseAttemptedWithRotationInProgress - The create database operation can not be performed at this time due to ongoing Transparent Data Encryption (TDE) key rotation on the server. Please try the operation again later.\n\n * 400 VBSEnclaveResourcePoolInvalidCombination - Adding a database with '{0}' preferredEnclaveType to an elastic pool '{1}' with '{2}' preferredEnclaveType is not supported. \nBefore adding the database to the elastic pool, ensure that the preferredEnclaveType is the same for both the database and the elastic pool. More information can be found on https://aka.ms/AlwaysEncryptedEnableSecureEnclaves\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 InvalidDatabaseCreateMode - Invalid request to create a database.\n\n * 400 MissingAsymmetricKeyOnTargetServer - Target server does not have access to an asymmetric key.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MultipleDroppedDatabasesWithTheSameName - Found multiple dropped databases with the same name on server.\n\n * 400 AzureKeyVaultClientError - The Azure Key Vault client encountered an error.\n\n * 400 AzureKeyVaultClientInfoError - An error occurred while obtaining information for the Azure Key Vault client.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 AzureKeyVaultKeyThumbprintIsDifferent - The operation could not be completed because the Azure Key Vault Key material is different than the current encryption protector key.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 HyperscaleReverseMigrationNotSupported - Reverse migration of a Hyperscale database to Sterling hit an unsupported scenario.\n\n * 400 UpdateSloOperationIdDoesNotExist - The action failed because no active update-slo operation detected for server: {0}, database: {1};. Please retry the operation by specifying valid parameters.\n\n * 400 ManualCutoverUnsupported - Invalid use of manual-cutover option. Please check current and requested service objective and retry the operation by specifying valid parameters.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 IsLedgerDatabaseIsNotSupportedOnResourceType - Changing the ledger property is not supported for this resource type.\n\n * 400 DatabaseNameInUse - Database already exists. Choose a different database name.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 UnableToCreateGeoChain - User attempted to create secondary database (chaining) even though automatic upload of ledger digests has been configured\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 TargetElasticPoolDoesNotExist - The elastic pool does not exist on a server.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 ElasticPoolNameRequired - User tried to create or update database to elastic pool service objective without specifying the name of the elastic pool.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 InvalidReadScaleEdition - User attempted to enable read scale on a database type that does not support it.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 GeoSecondaryMaxSizeUpdateFailed - The geo-secondary database is of a SLO that does not support the requested maxsize value or the geo-secondary is in an unsupported region or an update operation is already in progress on the geo-secondary database.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 SourceDatabaseEncryptionProtectorKeyUriRequiredForPerDatabaseCMKCopyOrReplication - Geo secondary database missing AKV of geo primary database\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 RequestedDatabaseSizeRequiresShrink - User attempted to ALTER DATABASE MODIFY MAXSIZE to modify the MAXSIZE for a database to a smaller size then the current size.\n\n * 400 CurrentDatabaseSizeExceedsDbMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 SecurityAzureKeyVaultGeoChainError - Creating secondary of secondary (a process known as chaining) is not supported when enabling Transparent Data Encryption using Azure Key Vault (BYOK).\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 UnsupportedCapacity - User tried to create or update database with capacity which is not supported.\n\n * 400 RestoreToFreeEditionNotSupported - Restore and GeoRestore target cannot be free database.\n\n * 400 RestoreNotSupportedForFreeEdition - Restore and GeoRestore are not supported for free database.\n\n * 400 InvalidDroppedDatabase - Source database dropped does not exist on server within the supported recovery period.\n\n * 400 InvalidLiveDatabase - Source database does not exist on server within the supported recovery period. If restoring a dropped database, please specify its deletion date.\n\n * 400 InvalidVldbRecoverySlo - The Hyperscale edition recovery requires both source and target databases to use Hyperscale service level objective.\n\n * 400 InvalidVldbRestoreSlo - The Hyperscale edition Point-In-Time restore requires both source and target databases to use Hyperscale service level objective.\n\n * 400 CannotSpecifyPoolOrSlo - Specifying an elastic pool and/or changing the service level objective or edition is not supported for edition.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 InvalidBackupStorageAccountType - User passed zrs/lrs during create/update of a database but it failed either because the customer is not whitelisted or because zrs is not available in the specified region.\n\n * 400 DatabaseInvalidSkuPropertyCombination - The properties of the requested sku are inconsistent. Please check that a valid combination is specified. See https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability for more details.\n\n * 400 DatabaseNamedReplicaPerDatabaseLimitExceeded - User tried create a named replica that would exceed the allowed number per primary database\n\n * 400 UnsupportedBackupStorageRedundancyForEdition - The requested backup storage redundancy is not supported for edition\n\n * 400 DatabaseIsCurrentlyPinned - Microsoft has pinned your database SQL Server engine version. To ensure your database does not hit production issues, any future scale operations on your database will be blocked until it has been un-pinned. Please contact Microsoft support for assistance with scaling.\n\n * 400 RestoreTargetEditionSizeInsufficient - User attempted to restore a database to an edition that is a smaller size than the current allocated size of the source.\n\n * 400 InvalidIdentityId - One or more identity id(s) provided are not valid ARM resource id(s). Please input valid id(s) and try again.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 DatabaseCreationBlockedForNonActivatedCMKServer - SQL Pool creations are blocked for CMK enabled workspaces until the workspace is activated. First, enable purge protection and grant the workspace Managed Identity the required permissions (Get, Wrap Key, Unwrap Key) on the Azure Key Vault of the workspace key. Next, activate your workspace after you have granted access.\n\n * 400 InvalidNumberOfIdentities - Only one user assigned managed identity is supported at the Database Level.\n\n * 400 NoRestorePointAvailable - The source database has not yet accomplished its first backup in order to support restore operations. Please retry the restore request later.\n\n * 400 DatabaseNamedReplicaChainingNotAllowed - User tried to create a named replica of a named replica which is not allowed.\n\n * 400 DatabaseNamedReplicaInvalidOperation - User attempted an unsupported operation on a named replica.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 DatabaseNamedReplicaInvalidSourceDatabase - User attempted to create a named replica in a different subscription or region than the source database.\n\n * 400 DatabaseNamedReplicaSourceDatabaseNotZoneRedundant - Zone Redundancy cannot be enabled on this Named Replica since the primary Hyperscale Database is not zone redundant.\n\n * 400 CannotAssignIdentityToMaster - Cannot assign an identity to a system database. Database identity cannot be assigned to 'master', 'model', 'tempdb', 'msdb', or 'resource' databases.\n\n * 400 PerDatabaseCMKDWNotSupported - Database-level CMK in preview is not supported for Datawarehouse edition.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 MissingThumbprintCrm - The restore operation of a CRM database failed because a required TDE certificate was missing. Please retry the restore operation to an existing elastic pool.\n\n * 400 ElasticPoolOverStorage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 RestoreTargetEditionSizeInsufficientV2 - User attempted to restore a database to an edition that is a smaller size than the allocated size of the restored database.\n\n * 400 ResourcePoolStorageLimitHitDuringRestore - The restored database can't be restored into the resource pool due to the remaining storage capacity in the pool.\n\n * 400 PerDatabaseCMKRestoreNotSupported - Database restore is not supported when Database-level CMK is configured in preview.\n\n * 400 PerDatabaseCMKHSNotSupported - Database-level CMK in preview is not supported for Hyperscale edition.\n\n * 400 PerDatabaseCMKGeoReplicationNotSupported - Geo Replication and Database Copy is not supported when Database-level CMK is configured in preview.\n\n * 400 InvalidStandbyGeoEdition - User attempted to create a DTU based standby geo.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 GeoRestoreBackupStorageTypeNotSupported - Database recovery requests are invalid when issued against a database that is not configured to use geo-redundant backup storage.\n\n * 400 RestoreHyperscaleToNonHyperscale - Restoring a Hyperscale database backup to a non-Hyperscale service tier or vice versa is not supported.\n\n * 400 SubscriptionDoesNotHaveAccessToServer - The subscription does not have access to the specified server(s)\n\n * 400 RecoveryPointDoesNotExist - The specified recovery point either does not exist or is not valid.\n\n * 400 LtrBackupNotFound - The specified long term retention backup does not exist.\n\n * 400 InvalidPointInTime - The specified point in time is not valid for the database.\n\n * 400 GeoRestoreCannotResolveTargetCluster - Cannot resolve target cluster for server\n\n * 400 CannotSpecifyEditionOrSloWhenRestoringToPool - Specifying the target service level objective or edition is not supported when restoring to an elastic pool.\n\n * 400 RestoreNotSupportedForGeoDrSecondary - Point-in-time restore and database recovery operations are not supported on databases that are currently configured as geo-secondaries.\n\n * 400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported - User attempted configuring backup retention policy on a Named Replica.\n\n * 400 GeoRedundantBackupsNotPermittedForSubscription - Geo-redundant backup storage is blocked for all databases under subscription '{0}' by preview feature 'Azure SQL Database Block Geo-redundant Backup Storage'. Please select a different backup storage redundancy.\n\n * 400 RestoreHyperscaleToNonHyperscaleElasticPool - Restoring a Hyperscale database to an elastic pool which is not Hyperscale or restoring a database which is not Hyperscale to a Hyperscale elastic pool is not supported.\n\n * 400 RestoreIneligibleDatabaseName - The specified target database name, '{0}', is reserved and cannot be used in a restore operation.\n\n * 400 RestoreNotSupportedForSystemDb - Restore and database recovery are not supported for system databases.\n\n * 400 RestoreIneligibleDroppedDatabaseShortLifespan - The source database, '{0}', dropped on '{1}', has not existed long enough to support restores.\n\n * 400 RestoreIneligibleLiveDatabaseShortLifespan - The source database, '{0}', has not yet accomplished its first backup in order to support restore operations. Please wait until at least the indicated earliest restore date '{1}' and resubmit the request.\n\n * 400 RestoreCrossServerDisabled - For point-in-time restores, the target logical server must be the same as the source logical server. Consider restoring to the source database's server, or using database copy or database recovery.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 RestoreSameServerRecoveryDisabled - Same-server recovery is currently not supported. Consider using point-in-time restore or recovering to a different server.\n\n * 400 RestoreNotSupportedFromLtrBackupToEdition - Restore from long-term retention backup to '{0}' edition not supported.\n\n * 400 RestoreNotSupportedFromExternalBackupToEdition - Restore from external backup to '{0}' edition not supported.\n\n * 400 UpdateToServerlessIfLtrIsNotDisabled - Enabling auto-pause for a serverless database is not supported if long-term backup retention is enabled.\n\n * 400 DuplicateRestoreOperation - A restore request with the same target database name '{0}' on server '{1}' already exists.\n\n * 400 ExternalBackupUriMalformed - The external backup storage container URI is malformed.\n\n * 400 ExternalBackupUriHostNotAllowed - The host name for the external backup storage container URI is not allowed.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 ExternalBackupUriInvalidSchemeOrPort - The external backup storage container URI uses an invalid scheme or port. Please use https and port 443.\n\n * 400 ExternalBackupVldbUnsupported - Hyperscale does not support external backup restore requests.\n\n * 400 InvalidPitrPriorToVldbMigration - For database '{0}', specified point-in-time '{1}' is prior to the Hyperscale migration time of '{2}'. Please specify a target edition or service level objective which is not Hyperscale when restoring to a point earlier than the Hyperscale migration.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 MissingKeyVaultUriForRestore - Azure Key Vault key URI '{0}' is required to successfully restore the database '{1}' under server '{2}'.\n\n * 400 BlockRestoreOnVldbGeoSecondary - Restore of Hyperscale database where source database is geo-secondary is not allowed.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 BackupSetNotFound - No backups were found to restore the database. Please contact support to restore the database.\n\n * 400 IncorrectAccessToAzureKeyVault - Target server does not have access to all AKV Uris created during the backup time.\n\n * 400 RestoreFailureSqlInstanceUnhealthy - Unable to connect to the instance in order to perform restore operation.\n\n * 400 BackupSetBroken - Backup set is broken.\n\n * 400 TimeoutDuringRestore - A timeout was encountered while trying to connect to the restore target.\n\n * 400 BrokenRestorePlanGapInLogBackups - The restore plan is broken because firstLsn of current log backup is not equal to lastLsn of prev log backup.\n\n * 400 FullBackupMissingChecksum - Provided full backup is missing checksum.\n\n * 400 RequiredBackupIsNotLastRestored - Migration cannot be completed because provided backup file name is not the name of the last backup file that is restored.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineDataFilesExist - Database backup contains incompatible physical layout. Non-online data files exist.\n\n * 400 IncompatiblePhysicalLayoutWrongNumberOfLogFiles - Database backup contains incompatible physical layout. Multiple log files are not supported.\n\n * 404 CrossManagedInstanceDatabaseMovementNotExist - Database movement does not exist.\n\n * 404 ResourceNotFound - Invalid request specifying a non-existent resource.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ManagedInstanceContainsInaccessibleDatabases - The operation could not be completed because managed instance '{0}' contains databases that are in the Inaccessible state. Please either drop inaccessible databases or fix the issues with access to the customer-managed TDE protector key for managed instance before retrying operation. https://go.microsoft.com/fwlink/?linkid=2111623\n\n * 409 ManagedInstanceHasHybridLink - User tried to initiate operation that is not supported when managed instance has a hybrid link configured.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 InstanceFailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 InstanceFailoverGroupBusy - Instance failover group is busy with another operation.\n\n * 409 InstanceFailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Instance Failover Group name was supplied.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 FreeDbAlreadyExists - Only one free database can exist for a subscription per region.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 UpdateSloFailedDatabaseTooBusy - Update SLO operation could not complete because database was too busy.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 TargetElasticPoolBeingUpdated - The update of elastic pool cannot be started because there is copy operation in progress for one of the databases in this elastic pool\n\n * 409 DatabaseCopyLimitPerReplicaReached - User reached the limit of concurrent database copies.\n\n * 409 ConflictRequestToUpdateBackupRedundancy - A conflict request to change backup storage redundancy is still in progress.\n\n * 409 DatabaseElasticPoolMaintenanceConflict - User tried to create or update a database with a specified maintenance configuration that conflicted with that of the elastic pool of the database.\n\n * 409 SubscriptionVcoreQuotaExceeded - Could not perform the operation because subscription would exceed the allowed vCore quota.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary - The given primary field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the instance failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion - The provided partner managed instance region in the instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner region is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount - Only one managed instance pair is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid - The create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the instance failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues - Grace period value for the instance failover group must be greater than or equal to the '{0}' minutes minimum grace period\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update instance failover group request body should not modify the read-only property '{0}'.\n\n * 400 InstanceFailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of instance failover group.\n\n * 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription - Primary server and the partner server of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 ManagedInstanceDatabaseCopyOrMoveToInstanceWithOlderVersionEdition - Operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 400 ManagedInstanceDatabaseLimitExceeded - This operation cannot start because specified target managed instance '{0}' already has maximum number of user databases.\n\n * 400 BrokenConnectivityBetweenInstances - Database '{0}' operation failed because there is no network connectivity between source instance '{1}' and target instance '{2}'.\n\n * 400 XtpServerStateMismatch - Both source and target servers do not support memory optimized data.\n\n * 400 SubnetOverlapBetweenInstances - Database '{0}' operation failed because there is no connectivity between source and target Azure SQL Managed Instance. This is because the target instance subnet has an overlapping address range with the subnet of the source instance.\n\n * 400 CrossTenantOperationNotSupported - Cross tenant operation is not supported.\n\n * 400 TargetInsufficientStorage - Attempt to move/restore/copy database on the destination instance with insufficient space.\n\n * 400 CrossResourceOperationNotSupported - Cross resource operation is not supported.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedDatabaseGPFileSizeLimitExceeded - Creating a copy of a managed database on different SQL Managed Instance with General Purpose service tier would violate data file size limit. See: 'https://docs.microsoft.com/azure/azure-sql/managed-instance/resource-limits#service-tier-characteristics'.\n\n * 400 ManagedInstanceGPStorageAccountLimitExceeded - Creating a copy of a database on different SQL Managed Instance with General Purpose service tier would violate storage account size limit. See: 'https://docs.microsoft.com/azure/azure-sql/managed-instance/resource-limits#service-tier-characteristics'.\n\n * 400 SystemDatabaseUnsupportedOperation - Unsupported operation for system database.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ServerEditionMismatch - Edition must be the same as the primary server when creating a replica server.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in an Instance Failover Group need to reside in different regions to provide isolation.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 InstanceFailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a instance failover group.\n\n * 400 ManagedInstanceGeoDRNotAllowedForInstancePool - Creating auto-failover group (GeoDR) is not supported for Managed Instances provisioned inside instance pools. Auto failover groups can be created only for standalone Managed Instances.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceEstablishingFailoverGroupGeoPrimaryWithNewerVersionEditionThanSecondary - Failover group cannot be created because database format of the primary instance is not compatible with the database format of the secondary instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 ManagedInstanceFailoverInFailoverGroupInstancesWithDifferentVersionEditions - Failover operation cannot be performed because of database format mismatch between the instances in the failover group. Consider upgrading the database format of the primary instance or deleting the failover group to promote current secondary instance to a stand-alone instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 ManagedInstanceNotAllowedInGeoDRSetupWhenFreemium - Deploying failover group is not supported with the free Azure SQL Managed Instance offer.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 ManagedInstanceUpdateSloOngoing - The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\n\n * 400 FailoverGroupRegionMismatch - Partner region specified in Failover Group need to match the region of the partner managed instance indicated.\n\n * 400 DnsZoneMismatch - The DNSZone on the partner server is different from the DNSZone on the source server. This breaks InstanceFailoverGroup functionality.\n\n * 400 GeoDrInstanceSizeMismatch - Primary managed instance and partner managed instance do not have the same storage size.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 GeoDrSecondaryInstanceNotEmpty - Secondary managed instance has user databases. To create an instance failover group the secondary managed instance needs to be empty.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 StorageAccountFull - Managed Instance has reached the total capacity of underlying Azure storage account. Azure Premium Storage account is limited to 35TB of allocated space.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 ManagedInstanceRestoreToInstanceWithOlderVersionEdition - Restore operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 UnsupportedBackupStorageRedundancy - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 BackupSetNotFoundRecentPit - No backups were found to restore the database to the specified point in time. Please retry the operation. If the problem persists, contact support to restore the database.\n\n * 400 CannotUpdateIsLedgerDatabase - The ledger property of an existing database cannot be updated.\n\n * 400 LTRSterlingToVldbMigrationNotSupported - Cannot change service objective for database to Hyperscale as long-term retention is not yet supported on Hyperscale. Please disable long-term retention on the database and retry.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 InvalidPublicMaintenanceConfiguration - User tried to specify public maintenance configuration which cannot be converted to internal id (malformed or wrong region).\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 MaintenanceWindowNotSupportedForNamedReplica - User tried to create or update named replica with non-default maintenance window which is not supported.\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 InvalidStandbyGeoReadScale - User attempted to enable read scale on a standby geo database that does not support it.\n\n * 400 PerDatabaseCMKKeyRotationAttemptedWhileOldThumbprintInUse - Key Rotation for the TDE Protector at the database level is blocked when active transactions are holding up the log encrypted with old keys. Please refer to aka.ms/azuresqldbkeyrotation for possible strategies to workaround this issue.\n\n * 400 TierChangeUnsupportedDueToCDCEnabledDatabase - The database cannot update its sku because it is enabled for CDC.\n\n * 400 PerDBCMKNotSupportedWithLTR - Database-level CMK is not supported when Long-term Backup Retention is enabled on the database.\n\n * 400 VBSEnclaveNotSupportedForDW - The preferredEnclaveType is not supported for dedicated SQL Pools.\n\n * 400 VBSEnclaveNotSupportedForDCSeriesSLO - Configuring the 'VBS' preferredEnclaveType for databases using the DC-series hardware configuration is not supported. DC-series databases are pre-configured with Intel SGX enclaves. Virtualization based security (VBS) enclaves are not supported.\n\n * 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutDatabaseLevelEncryptionProtector - Database-level encryption protector must be set on the target database while attempting to copy or replicate a database encrypted with a database level key.\n\n * 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeys - While attempting to replicate a database configured with database level encryption protector, the current keys being used by the primary must be passed to the secondary database.\n\n * 400 PartnerDBNotCompatibleForSGXEnclave - Attempt to set GeoDR link or update SLO for enclave enabled database is only supported when both database are running on DC-series hardware.\n\n * 400 PerDatabaseCMKGeoPrimaryIsNotConfiguredWithDatabaseLevelEncryptionProtector - The geo-primary database must be configured with a database level encryption protector before setting a database level encryption protector on the geo-secondary.\n\n * 400 ElasticJobsNotSupportedOnAutoPauseEnabledDatabase - Auto-pause enabled serverless database is not supported as an Elastic Jobs database because job agent would prevent that database from pausing. You can either disable auto-pause on this serverless database or delete the job agent that is using this database. See here for more details: https://docs.microsoft.com/azure/azure-sql/database/serverless-tier-overview#auto-pausing\n\n * 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave - Configuring geo-replication is not supported for databases using different values of the preferredEnclaveType property. The primary '{0}' database on the '{1}' server uses the '{2}' preferredEnclaveType, whereas the specified preferredEnclaveType for the secondary '{3}' database on the '{4}' server is '{5}'.\n\n * 400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes - Planned failover between primary and secondary database with different preferredEnclaveType is not supported for Virtualization-based security (VBS) enclaves.\n\n * 400 PerDatabaseCMKGeoPrimaryIsConfiguredWithDatabaseLevelEncryptionProtector - The geo-primary database must not be configured with a database level encryption protector when failing over to a geo-secondary without a database level encryption protector.\n\n * 400 CreateDatabaseAttemptedWithRotationInProgress - The create database operation can not be performed at this time due to ongoing Transparent Data Encryption (TDE) key rotation on the server. Please try the operation again later.\n\n * 400 VBSEnclaveResourcePoolInvalidCombination - Adding a database with '{0}' preferredEnclaveType to an elastic pool '{1}' with '{2}' preferredEnclaveType is not supported. \nBefore adding the database to the elastic pool, ensure that the preferredEnclaveType is the same for both the database and the elastic pool. More information can be found on https://aka.ms/AlwaysEncryptedEnableSecureEnclaves\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 InvalidDatabaseCreateMode - Invalid request to create a database.\n\n * 400 MissingAsymmetricKeyOnTargetServer - Target server does not have access to an asymmetric key.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MultipleDroppedDatabasesWithTheSameName - Found multiple dropped databases with the same name on server.\n\n * 400 AzureKeyVaultClientError - The Azure Key Vault client encountered an error.\n\n * 400 AzureKeyVaultClientInfoError - An error occurred while obtaining information for the Azure Key Vault client.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 AzureKeyVaultKeyThumbprintIsDifferent - The operation could not be completed because the Azure Key Vault Key material is different than the current encryption protector key.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 HyperscaleReverseMigrationNotSupported - Reverse migration of a Hyperscale database to Sterling hit an unsupported scenario.\n\n * 400 UpdateSloOperationIdDoesNotExist - The action failed because no active update-slo operation detected for server: {0}, database: {1};. Please retry the operation by specifying valid parameters.\n\n * 400 ManualCutoverUnsupported - Invalid use of manual-cutover option. Please check current and requested service objective and retry the operation by specifying valid parameters.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 IsLedgerDatabaseIsNotSupportedOnResourceType - Changing the ledger property is not supported for this resource type.\n\n * 400 DatabaseNameInUse - Database already exists. Choose a different database name.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 UnableToCreateGeoChain - User attempted to create secondary database (chaining) even though automatic upload of ledger digests has been configured\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 TargetElasticPoolDoesNotExist - The elastic pool does not exist on a server.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 ElasticPoolNameRequired - User tried to create or update database to elastic pool service objective without specifying the name of the elastic pool.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 InvalidReadScaleEdition - User attempted to enable read scale on a database type that does not support it.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 GeoSecondaryMaxSizeUpdateFailed - The geo-secondary database is of a SLO that does not support the requested maxsize value or the geo-secondary is in an unsupported region or an update operation is already in progress on the geo-secondary database.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 SourceDatabaseEncryptionProtectorKeyUriRequiredForPerDatabaseCMKCopyOrReplication - Geo secondary database missing AKV of geo primary database\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 RequestedDatabaseSizeRequiresShrink - User attempted to ALTER DATABASE MODIFY MAXSIZE to modify the MAXSIZE for a database to a smaller size then the current size.\n\n * 400 CurrentDatabaseSizeExceedsDbMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 SecurityAzureKeyVaultGeoChainError - Creating secondary of secondary (a process known as chaining) is not supported when enabling Transparent Data Encryption using Azure Key Vault (BYOK).\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 UnsupportedCapacity - User tried to create or update database with capacity which is not supported.\n\n * 400 RestoreToFreeEditionNotSupported - Restore and GeoRestore target cannot be free database.\n\n * 400 RestoreNotSupportedForFreeEdition - Restore and GeoRestore are not supported for free database.\n\n * 400 InvalidDroppedDatabase - Source database dropped does not exist on server within the supported recovery period.\n\n * 400 InvalidLiveDatabase - Source database does not exist on server within the supported recovery period. If restoring a dropped database, please specify its deletion date.\n\n * 400 InvalidVldbRecoverySlo - The Hyperscale edition recovery requires both source and target databases to use Hyperscale service level objective.\n\n * 400 InvalidVldbRestoreSlo - The Hyperscale edition Point-In-Time restore requires both source and target databases to use Hyperscale service level objective.\n\n * 400 CannotSpecifyPoolOrSlo - Specifying an elastic pool and/or changing the service level objective or edition is not supported for edition.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 InvalidBackupStorageAccountType - User passed zrs/lrs during create/update of a database but it failed either because the customer is not whitelisted or because zrs is not available in the specified region.\n\n * 400 DatabaseInvalidSkuPropertyCombination - The properties of the requested sku are inconsistent. Please check that a valid combination is specified. See https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability for more details.\n\n * 400 DatabaseNamedReplicaPerDatabaseLimitExceeded - User tried create a named replica that would exceed the allowed number per primary database\n\n * 400 UnsupportedBackupStorageRedundancyForEdition - The requested backup storage redundancy is not supported for edition\n\n * 400 DatabaseIsCurrentlyPinned - Microsoft has pinned your database SQL Server engine version. To ensure your database does not hit production issues, any future scale operations on your database will be blocked until it has been un-pinned. Please contact Microsoft support for assistance with scaling.\n\n * 400 RestoreTargetEditionSizeInsufficient - User attempted to restore a database to an edition that is a smaller size than the current allocated size of the source.\n\n * 400 InvalidIdentityId - One or more identity id(s) provided are not valid ARM resource id(s). Please input valid id(s) and try again.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 DatabaseCreationBlockedForNonActivatedCMKServer - SQL Pool creations are blocked for CMK enabled workspaces until the workspace is activated. First, enable purge protection and grant the workspace Managed Identity the required permissions (Get, Wrap Key, Unwrap Key) on the Azure Key Vault of the workspace key. Next, activate your workspace after you have granted access.\n\n * 400 InvalidNumberOfIdentities - Only one user assigned managed identity is supported at the Database Level.\n\n * 400 NoRestorePointAvailable - The source database has not yet accomplished its first backup in order to support restore operations. Please retry the restore request later.\n\n * 400 DatabaseNamedReplicaChainingNotAllowed - User tried to create a named replica of a named replica which is not allowed.\n\n * 400 DatabaseNamedReplicaInvalidOperation - User attempted an unsupported operation on a named replica.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 DatabaseNamedReplicaInvalidSourceDatabase - User attempted to create a named replica in a different subscription or region than the source database.\n\n * 400 DatabaseNamedReplicaSourceDatabaseNotZoneRedundant - Zone Redundancy cannot be enabled on this Named Replica since the primary Hyperscale Database is not zone redundant.\n\n * 400 CannotAssignIdentityToMaster - Cannot assign an identity to a system database. Database identity cannot be assigned to 'master', 'model', 'tempdb', 'msdb', or 'resource' databases.\n\n * 400 PerDatabaseCMKDWNotSupported - Database-level CMK in preview is not supported for Datawarehouse edition.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 MissingThumbprintCrm - The restore operation of a CRM database failed because a required TDE certificate was missing. Please retry the restore operation to an existing elastic pool.\n\n * 400 ElasticPoolOverStorage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 RestoreTargetEditionSizeInsufficientV2 - User attempted to restore a database to an edition that is a smaller size than the allocated size of the restored database.\n\n * 400 ResourcePoolStorageLimitHitDuringRestore - The restored database can't be restored into the resource pool due to the remaining storage capacity in the pool.\n\n * 400 PerDatabaseCMKRestoreNotSupported - Database restore is not supported when Database-level CMK is configured in preview.\n\n * 400 PerDatabaseCMKHSNotSupported - Database-level CMK in preview is not supported for Hyperscale edition.\n\n * 400 PerDatabaseCMKGeoReplicationNotSupported - Geo Replication and Database Copy is not supported when Database-level CMK is configured in preview.\n\n * 400 InvalidStandbyGeoEdition - User attempted to create a DTU based standby geo.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 GeoRestoreBackupStorageTypeNotSupported - Database recovery requests are invalid when issued against a database that is not configured to use geo-redundant backup storage.\n\n * 400 RestoreHyperscaleToNonHyperscale - Restoring a Hyperscale database backup to a non-Hyperscale service tier or vice versa is not supported.\n\n * 400 SubscriptionDoesNotHaveAccessToServer - The subscription does not have access to the specified server(s)\n\n * 400 RecoveryPointDoesNotExist - The specified recovery point either does not exist or is not valid.\n\n * 400 LtrBackupNotFound - The specified long term retention backup does not exist.\n\n * 400 InvalidPointInTime - The specified point in time is not valid for the database.\n\n * 400 GeoRestoreCannotResolveTargetCluster - Cannot resolve target cluster for server\n\n * 400 CannotSpecifyEditionOrSloWhenRestoringToPool - Specifying the target service level objective or edition is not supported when restoring to an elastic pool.\n\n * 400 RestoreNotSupportedForGeoDrSecondary - Point-in-time restore and database recovery operations are not supported on databases that are currently configured as geo-secondaries.\n\n * 400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported - User attempted configuring backup retention policy on a Named Replica.\n\n * 400 GeoRedundantBackupsNotPermittedForSubscription - Geo-redundant backup storage is blocked for all databases under subscription '{0}' by preview feature 'Azure SQL Database Block Geo-redundant Backup Storage'. Please select a different backup storage redundancy.\n\n * 400 RestoreHyperscaleToNonHyperscaleElasticPool - Restoring a Hyperscale database to an elastic pool which is not Hyperscale or restoring a database which is not Hyperscale to a Hyperscale elastic pool is not supported.\n\n * 400 RestoreIneligibleDatabaseName - The specified target database name, '{0}', is reserved and cannot be used in a restore operation.\n\n * 400 RestoreNotSupportedForSystemDb - Restore and database recovery are not supported for system databases.\n\n * 400 RestoreIneligibleDroppedDatabaseShortLifespan - The source database, '{0}', dropped on '{1}', has not existed long enough to support restores.\n\n * 400 RestoreIneligibleLiveDatabaseShortLifespan - The source database, '{0}', has not yet accomplished its first backup in order to support restore operations. Please wait until at least the indicated earliest restore date '{1}' and resubmit the request.\n\n * 400 RestoreCrossServerDisabled - For point-in-time restores, the target logical server must be the same as the source logical server. Consider restoring to the source database's server, or using database copy or database recovery.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 RestoreSameServerRecoveryDisabled - Same-server recovery is currently not supported. Consider using point-in-time restore or recovering to a different server.\n\n * 400 RestoreNotSupportedFromLtrBackupToEdition - Restore from long-term retention backup to '{0}' edition not supported.\n\n * 400 RestoreNotSupportedFromExternalBackupToEdition - Restore from external backup to '{0}' edition not supported.\n\n * 400 UpdateToServerlessIfLtrIsNotDisabled - Enabling auto-pause for a serverless database is not supported if long-term backup retention is enabled.\n\n * 400 DuplicateRestoreOperation - A restore request with the same target database name '{0}' on server '{1}' already exists.\n\n * 400 ExternalBackupUriMalformed - The external backup storage container URI is malformed.\n\n * 400 ExternalBackupUriHostNotAllowed - The host name for the external backup storage container URI is not allowed.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 ExternalBackupUriInvalidSchemeOrPort - The external backup storage container URI uses an invalid scheme or port. Please use https and port 443.\n\n * 400 ExternalBackupVldbUnsupported - Hyperscale does not support external backup restore requests.\n\n * 400 InvalidPitrPriorToVldbMigration - For database '{0}', specified point-in-time '{1}' is prior to the Hyperscale migration time of '{2}'. Please specify a target edition or service level objective which is not Hyperscale when restoring to a point earlier than the Hyperscale migration.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 MissingKeyVaultUriForRestore - Azure Key Vault key URI '{0}' is required to successfully restore the database '{1}' under server '{2}'.\n\n * 400 BlockRestoreOnVldbGeoSecondary - Restore of Hyperscale database where source database is geo-secondary is not allowed.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 BackupSetNotFound - No backups were found to restore the database. Please contact support to restore the database.\n\n * 400 IncorrectAccessToAzureKeyVault - Target server does not have access to all AKV Uris created during the backup time.\n\n * 400 RestoreFailureSqlInstanceUnhealthy - Unable to connect to the instance in order to perform restore operation.\n\n * 400 BackupSetBroken - Backup set is broken.\n\n * 400 TimeoutDuringRestore - A timeout was encountered while trying to connect to the restore target.\n\n * 400 BrokenRestorePlanGapInLogBackups - The restore plan is broken because firstLsn of current log backup is not equal to lastLsn of prev log backup.\n\n * 400 FullBackupMissingChecksum - Provided full backup is missing checksum.\n\n * 400 RequiredBackupIsNotLastRestored - Migration cannot be completed because provided backup file name is not the name of the last backup file that is restored.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineDataFilesExist - Database backup contains incompatible physical layout. Non-online data files exist.\n\n * 400 IncompatiblePhysicalLayoutWrongNumberOfLogFiles - Database backup contains incompatible physical layout. Multiple log files are not supported.\n\n * 404 CrossManagedInstanceDatabaseMovementNotExist - Database movement does not exist.\n\n * 404 ResourceNotFound - Invalid request specifying a non-existent resource.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ManagedInstanceContainsInaccessibleDatabases - The operation could not be completed because managed instance '{0}' contains databases that are in the Inaccessible state. Please either drop inaccessible databases or fix the issues with access to the customer-managed TDE protector key for managed instance before retrying operation. https://go.microsoft.com/fwlink/?linkid=2111623\n\n * 409 ManagedInstanceHasHybridLink - User tried to initiate operation that is not supported when managed instance has a hybrid link configured.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 InstanceFailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 InstanceFailoverGroupBusy - Instance failover group is busy with another operation.\n\n * 409 InstanceFailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Instance Failover Group name was supplied.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 FreeDbAlreadyExists - Only one free database can exist for a subscription per region.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 UpdateSloFailedDatabaseTooBusy - Update SLO operation could not complete because database was too busy.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 TargetElasticPoolBeingUpdated - The update of elastic pool cannot be started because there is copy operation in progress for one of the databases in this elastic pool\n\n * 409 DatabaseCopyLimitPerReplicaReached - User reached the limit of concurrent database copies.\n\n * 409 ConflictRequestToUpdateBackupRedundancy - A conflict request to change backup storage redundancy is still in progress.\n\n * 409 DatabaseElasticPoolMaintenanceConflict - User tried to create or update a database with a specified maintenance configuration that conflicted with that of the elastic pool of the database.\n\n * 409 SubscriptionVcoreQuotaExceeded - Could not perform the operation because subscription would exceed the allowed vCore quota.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedDatabaseVulnerabilityAssessmentScans.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedDatabaseVulnerabilityAssessmentScans.json index c8e0e6b9c3d3..f3ba679b196d 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedDatabaseVulnerabilityAssessmentScans.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedDatabaseVulnerabilityAssessmentScans.json @@ -292,7 +292,12 @@ } }, "202": { - "description": "Successfully started a Vulnerability Assessment database scan." + "description": "Successfully started a Vulnerability Assessment database scan.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedDatabases.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedDatabases.json index 353e84b5372f..8e08e225c103 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedDatabases.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedDatabases.json @@ -145,13 +145,18 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 StorageAccountFull - Managed Instance has reached the total capacity of underlying Azure storage account. Azure Premium Storage account is limited to 35TB of allocated space.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 CannotUpdateIsLedgerDatabase - The ledger property of an existing database cannot be updated.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 InvalidDatabaseCreateOrUpdateRequest - The request body for the create or update database operation is invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSourceDatabaseId - Invalid source database identifier.\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 InvalidCrossSubscriptionTargetManagedInstanceId - Invalid cross subscription target managed instance identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MissingCollation - Collation is required.\n\n * 400 MissingSourceDatabaseId - Missing source database identifier.\n\n * 400 MissingRestorePointInTime - Missing restore point in time\n\n * 400 MissingStorageContainerSasToken - Missing storage container SAS token\n\n * 400 MissingStorageContainerUri - Missing storage container URI\n\n * 400 RestorableDroppedDatabaseIdGivenForRestoreWithSourceDatabaseId - Cannot specify restorableDroppedDatabaseId when sourceDatabaseId is already given in restore create mode\n\n * 400 CrossSubscriptionRestorableDroppedDatabaseIdGivenForRestoreWithCrossSubscriptionSourceDatabaseId - Cannot specify crossSubscriptionRestorableDroppedDatabaseId when crossSubscriptionSourceDatabaseId is already given.\n\n * 400 MissmatchingCrossSubscriptionTargetManagedInstanceIdWithUrl - The provided crossSubscriptionTargetManagedInstanceId must match the instance in the URL.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidLongTermRetentionManagedInstanceBackupId - Invalid long term retention backup identifier for Managed Instances.\n\n * 400 LongTermRetentiontBackupOperationResultsInvalidODataQuery - The specified OData query is either not valid or not supported\n\n * 400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed - Changing backup storage redundancy is not allowed for LTR Copy operations.\n\n * 400 LtrRestoreFailedArchiveStorageTier - Restoring archived long-term retention backup is not supported. Restore can be performed only on rehydrated or regular long-term retention backups.\n\n * 400 LtrArchiveStorageTierNotEnabled - Archiving long-term retention backups is not enabled.\n\n * 400 LtrArchiveWrongParameters - ChangeLongTermRetentionBackupAccessTier is not supported for the desired (backupStorageAccessTier, operationMode) combination. Only (Archive, Move) and (Hot, Copy) are allowed.\n\n * 400 LTRArchiveRedundancyChangeFailed - Updating the backup storage redundancy type to zone-redundant storage is not supported when a long-term retention policy with the 'archive' backup storage access tier is set\n\n * 400 LongTermRetentionMigrationSubscriptionNotFound - The subscription could not be found.\n\n * 400 LtrOperationFailedBackupImmutable - Deleting Long Term Retention backup failed because the backup is immutable.\n\n * 400 LongTermRetentionMigrationRequestNotSupported - Subscription is not allowed LTR backup Migration feature.\n\n * 400 LongTermRetentionMigrationCrossClusterRequestNotSupported - Source and target subscriptions are not allowed to communicate for LTR backup copy feature.\n\n * 400 LongTermRetentionMigrationParameterMissing - Required parameter missing for the operation.\n\n * 400 LongTermRetentionMigrationSameServerNotSupported - LTR Copy feature is not supported to copy LTR backups within same server.\n\n * 400 LongTermRetentionMigrationTargetServerNotFound - Target server does not exists or is not ready for LTR backup copy operation.\n\n * 400 LongTermRetentionMigrationTargetDatabaseNotFound - Target Database does not exists on the server.\n\n * 400 LongTermRetentionMigrationStorageTypeNotSupported - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 LongTermRetentionMigrationStorageMismatch - Active backup redundancy of database does not match backup redundancy requested by customer.\n\n * 400 LongTermRetentionMigrationDatabaseTypeNotSupported - LTR migration is only supported for managed instance and Azure SQL DB LTR backups.\n\n * 400 ManagementServiceManagedServerDisabled - Operation failed since Managed Instance '{0}' is disabled. Please enable Managed Instance and try again.\n\n * 400 MiGeoRestoreWithWrongBackupStorageRedundancy - Geo-Restore is not allowed for managed instances with LRS/ZRS backup storage redundancy.\n\n * 400 LastBackupNameHasNewline - Please do not use forbidden characters ('\\n', '\\r') in lastBackupName.\n\n * 400 LastBackupNameHasNonAsciiCharacter - The operation was aborted because the 'LastBackupName' parameter contains invalid characters. Only ASCII characters are allowed.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled.\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 UpdatingInstanceAndBackupRedundancy - Instance zone redundancy and backup storage redundancy cannot be updated in the same request.\n\n * 400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled.\n\n * 400 RequestCantLandOnPaaSv2Platform - Request needs to land on PaaSv2 platform but PaaSv2 is not enabled.\n\n * 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.\n\n * 400 DeleteOfVersion2VirtualClusterIsDisabled - Delete of virtual cluster with version 2 is not enabled.\n\n * 400 DeleteOfVirtualClusterIsDisabled - Delete of virtual cluster is not enabled.\n\n * 400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool.\n\n * 400 DnsRefreshOnVirtualClusterIsDisabled - Refresh of DNS records on virtual cluster is not enabled.\n\n * 400 TimeoutDuringRestore - A timeout was encountered while trying to connect to the restore target.\n\n * 400 AutoCompleteMissingLastBackupName - Auto complete restore request must have lastBackupName parameter provided.\n\n * 400 MissingThumbprint - Can not find server certificate.\n\n * 400 BlobStorageServerFailure - Blob storage server failure has occurred.\n\n * 400 BackupSetNotFound - No backups were found to restore the database. Please contact support to restore the database.\n\n * 400 FullBackupNotFound - Full backup can not be found.\n\n * 400 RestoreFromStripedBackupsNotEnabled - Restoring from striped backups is not supported.\n\n * 400 BrokenRestorePlanNoFullBackup - The restore plan is broken because there is no full backup.\n\n * 400 BrokenRestorePlanWrongLogBackupLSN - The restore plan is broken because firstLsn of current log backup is not <= lastLsn of next log backup.\n\n * 400 BrokenRestorePlanWrongDiffBackupLSN - The restore plan is broken because firstLsn of diff backup is not >= firstLsn of full backup.\n\n * 400 BrokenRestorePlanGapInLogBackups - The restore plan is broken because firstLsn of current log backup is not equal to lastLsn of prev log backup.\n\n * 400 TargetServerDoesNotExist - The target server {0} does not exist or is not ready yet. Please check that it exists and retry the restore request.\n\n * 400 TargetServerRestoreNotAllowed - The target server {0} is currently not in a state that allows a restore to be started.\n\n * 400 XtpInitializedDuringRestore - Memory-optimized filegroup must be empty in order to be restored on General Purpose tier of SQL Database Managed Instance.\n\n * 400 FullBackupMissingChecksum - Provided full backup is missing checksum.\n\n * 400 FullBackupDamaged - Provided full backup is damaged.\n\n * 400 MissingStripeInBackupSet - Provided backup set has one or more missing stripes.\n\n * 400 BackupsFromMultipleDatabasesDetectedInTheContainerWhileRestoreInProgress - There are backups from multiple databases in the container folder. Please make sure the container folder has backups from a single database.{0}\n\n * 400 BrokenRestorePlanWrongDiffBaseGUID - The restore plan is broken because DifferentialBaseGuid of diff backup does not match BackupSetGuid of full backup.\n\n * 400 CorruptedPagesInBackupSet - Operation was aborted because RESTORE detected one or more corrupted pages in the backup set.\n\n * 400 ManagedIdentityIssueDetectedWhileRestoreInProgress - Managed identity is not set up properly. Please verify and try again.\n\n * 400 CorruptedPagesListMaintenance - Operation was aborted because an internal error occurred while processing the backup taken without checksum.\n\n * 400 StorageBrokenIssueDetectedWhileInProgress - Storage connection is broken. Retrying automatically...\n\n * 400 PartiallyContainedDatabaseUnsupported - \"Backup for a partially contained database is not supported.\"\n\n * 400 RequiredBackupIsNotLastRestored - Migration cannot be completed because provided backup file name is not the name of the last backup file that is restored.\n\n * 400 ManagedInstanceStorageLimitHit - The managed instance has reached its storage limit.\n\n * 400 IncompatiblePhysicalLayoutTooFewDataFiles - Database backup contains incompatible physical layout. No data files are found in the backup.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineDataFilesExist - Database backup contains incompatible physical layout. Non-online data files exist.\n\n * 400 IncompatiblePhysicalLayoutWrongNumberOfLogFiles - Database backup contains incompatible physical layout. Multiple log files are not supported.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineLogFilesExist - Database backup contains incompatible physical layout. Non-online log files exist.\n\n * 400 IncompatiblePhysicalLayoutTooManyNonDataLogFiles - Database backup contains incompatible physical layout. Too many non-data/log files.\n\n * 400 ExternalBackupAlreadySignaledToComplete - The restore request has already been signaled to complete.\n\n * 400 ExternalBackupRestoreHasNotBeenStarted - The restore request can only be completed once the restore has started.\n\n * 400 ExternalBackupUpgradeInProgress - The restore request cannot be completed, since upgrade is in progress.\n\n * 400 IncompatiblePhysicalLayoutTooManyXTPFiles - Database backup contains incompatible physical layout. Multiple files found in the filegroup that contains MEMORY_OPTIMIZED_DATA.\n\n * 400 BlobStorageFailure - Blob storage failure has occurred.\n\n * 400 BackupsFromMultipleDatabasesDetectedInTheContainerFromTheStart - There are backups from multiple databases in the container folder. Please make sure the container folder has backups from a single database.{0}\n\n * 400 ManagedIdentityIssueDetectedFromTheStart - Managed identity is not set up properly. Please verify and try again.\n\n * 400 StorageBrokenIssueDetectedAtTheStart - Storage connection is broken. Please verify and try again.\n\n * 400 StorageBrokenIssueDetectedTerminateRetries - Storage connection is still broken. Please verify and try again.\n\n * 400 BackupSetBroken - Backup set is broken.\n\n * 400 SqlRestoreError - Non retriable error occurred while restoring backup.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 LongTermRetentionMigrationBackupNotFound - LTR backup specified does not exists.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 LongTermRetentionMigrationRequestConflict - A conflict operation on this LTR backup is still in progress.\n\n * 409 LongTermRetentionMigrationBackupConflict - Another LTR backup with same backup time for target database exists.\n\n * 409 MiCreateFailedNonDelegatedSubnet - User tried to deploy Managed Instance or Managed Instance pool in subnet that is not delegated to Microsoft.Sql/managedInstances.\n\n * 409 ConflictingManagedInstanceOperation - An operation is currently in progress for the managed instance.\n\n * 409 BackupRedundancyUpdateAndInstanceRedundancyConflict - The instance is multi-az but backup storage is being updated from zone redundant to non-zone redundant.\n\n * 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress - Cannot update instance redundancy because backup storage redundancy update is in progress.\n\n * 409 InstanceRedundancyUpdateAndBackupRedundancyConflict - The backup storage is non-zone redundant but instance redundancy is being updated to zone redundant.\n\n * 409 BackupRedundancyUpdateConflict - Cannot update backup storage redundancy because a backup storage redundancy update is already in progress.\n\n * 409 MiDropFailedOnAuthLocks - User tried to drop last Managed Instance in subnet that has Lock applied on resource(s).\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 412 InstanceNotReadyForBackupRedundancyUpdate - Cannot update backup storage redundancy because the instance is not ready.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 500 LongTermRetentionMigrationRequestCopyFailed - Copy operation failed for LTR backup blobs.\n\n * 500 LongTermRetentionMigrationRestoreVerExceeded - Restore verification failed after max attempts were reached.\n\n * 500 LongTermRetentionMigrationRestoreVerFailed - Restore verification failed.\n\n * 500 LongTermRetentionMigrationRequestFailedToStartOnTarget - Failed to start LTR backup copy request in target region.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 StorageAccountFull - Managed Instance has reached the total capacity of underlying Azure storage account. Azure Premium Storage account is limited to 35TB of allocated space.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 CannotUpdateIsLedgerDatabase - The ledger property of an existing database cannot be updated.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 InvalidDatabaseCreateOrUpdateRequest - The request body for the create or update database operation is invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSourceDatabaseId - Invalid source database identifier.\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 InvalidCrossSubscriptionTargetManagedInstanceId - Invalid cross subscription target managed instance identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MissingCollation - Collation is required.\n\n * 400 MissingSourceDatabaseId - Missing source database identifier.\n\n * 400 MissingRestorePointInTime - Missing restore point in time\n\n * 400 MissingStorageContainerSasToken - Missing storage container SAS token\n\n * 400 MissingStorageContainerUri - Missing storage container URI\n\n * 400 RestorableDroppedDatabaseIdGivenForRestoreWithSourceDatabaseId - Cannot specify restorableDroppedDatabaseId when sourceDatabaseId is already given in restore create mode\n\n * 400 CrossSubscriptionRestorableDroppedDatabaseIdGivenForRestoreWithCrossSubscriptionSourceDatabaseId - Cannot specify crossSubscriptionRestorableDroppedDatabaseId when crossSubscriptionSourceDatabaseId is already given.\n\n * 400 MissmatchingCrossSubscriptionTargetManagedInstanceIdWithUrl - The provided crossSubscriptionTargetManagedInstanceId must match the instance in the URL.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidLongTermRetentionManagedInstanceBackupId - Invalid long term retention backup identifier for Managed Instances.\n\n * 400 LongTermRetentiontBackupOperationResultsInvalidODataQuery - The specified OData query is either not valid or not supported\n\n * 400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed - Changing backup storage redundancy is not allowed for LTR Copy operations.\n\n * 400 LtrRestoreFailedArchiveStorageTier - Restoring archived long-term retention backup is not supported. Restore can be performed only on rehydrated or regular long-term retention backups.\n\n * 400 LtrArchiveStorageTierNotEnabled - Archiving long-term retention backups is not enabled.\n\n * 400 LtrArchiveWrongParameters - ChangeLongTermRetentionBackupAccessTier is not supported for the desired (backupStorageAccessTier, operationMode) combination. Only (Archive, Move) and (Hot, Copy) are allowed.\n\n * 400 LTRArchiveRedundancyChangeFailed - Updating the backup storage redundancy type to zone-redundant storage is not supported when a long-term retention policy with the 'archive' backup storage access tier is set\n\n * 400 LongTermRetentionMigrationSubscriptionNotFound - The subscription could not be found.\n\n * 400 LtrOperationFailedBackupImmutable - Deleting Long Term Retention backup failed because the backup is immutable.\n\n * 400 LongTermRetentionMigrationRequestNotSupported - Subscription is not allowed LTR backup Migration feature.\n\n * 400 LongTermRetentionMigrationCrossClusterRequestNotSupported - Source and target subscriptions are not allowed to communicate for LTR backup copy feature.\n\n * 400 LongTermRetentionMigrationParameterMissing - Required parameter missing for the operation.\n\n * 400 LongTermRetentionMigrationSameServerNotSupported - LTR Copy feature is not supported to copy LTR backups within same server.\n\n * 400 LongTermRetentionMigrationTargetServerNotFound - Target server does not exists or is not ready for LTR backup copy operation.\n\n * 400 LongTermRetentionMigrationTargetDatabaseNotFound - Target Database does not exists on the server.\n\n * 400 LongTermRetentionMigrationStorageTypeNotSupported - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 LongTermRetentionMigrationStorageMismatch - Active backup redundancy of database does not match backup redundancy requested by customer.\n\n * 400 LongTermRetentionMigrationDatabaseTypeNotSupported - LTR migration is only supported for managed instance and Azure SQL DB LTR backups.\n\n * 400 ManagementServiceManagedServerDisabled - Operation failed since Managed Instance '{0}' is disabled. Please enable Managed Instance and try again.\n\n * 400 MiGeoRestoreWithWrongBackupStorageRedundancy - Geo-Restore is not allowed for managed instances with LRS/ZRS backup storage redundancy.\n\n * 400 LastBackupNameHasNewline - Please do not use forbidden characters ('\\n', '\\r') in lastBackupName.\n\n * 400 LastBackupNameHasNonAsciiCharacter - The operation was aborted because the 'LastBackupName' parameter contains invalid characters. Only ASCII characters are allowed.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 LRSCutoverDatabaseDoesNotExist - The operation was aborted because the database name specified in the request doesn't match any database name on the specified server.\n\n * 400 LRSCutoverDatabaseNotInRestoringState - The operation was aborted because the specified database is not in restoring state.\n\n * 400 LRSCutoverDatabaseAlreadyRestored - The operation was aborted because the specified database was already restored.\n\n * 400 LRSCutoverAlreadyInitiated - The operation was aborted because a cutover for the specified database is already in progress.\n\n * 400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled.\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 UpdatingInstanceAndBackupRedundancy - Instance zone redundancy and backup storage redundancy cannot be updated in the same request.\n\n * 400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled.\n\n * 400 RequestCantLandOnPaaSv2Platform - Request needs to land on PaaSv2 platform but PaaSv2 is not enabled.\n\n * 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.\n\n * 400 DeleteOfVersion2VirtualClusterIsDisabled - Delete of virtual cluster with version 2 is not enabled.\n\n * 400 DeleteOfVirtualClusterIsDisabled - Delete of virtual cluster is not enabled.\n\n * 400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool.\n\n * 400 DnsRefreshOnVirtualClusterIsDisabled - Refresh of DNS records on virtual cluster is not enabled.\n\n * 400 TimeoutDuringRestore - A timeout was encountered while trying to connect to the restore target.\n\n * 400 AutoCompleteMissingLastBackupName - Auto complete restore request must have lastBackupName parameter provided.\n\n * 400 MissingThumbprint - Can not find server certificate.\n\n * 400 BlobStorageServerFailure - Blob storage server failure has occurred.\n\n * 400 BackupSetNotFound - No backups were found to restore the database. Please contact support to restore the database.\n\n * 400 FullBackupNotFound - Full backup can not be found.\n\n * 400 RestoreFromStripedBackupsNotEnabled - Restoring from striped backups is not supported.\n\n * 400 BrokenRestorePlanNoFullBackup - The restore plan is broken because there is no full backup.\n\n * 400 BrokenRestorePlanWrongLogBackupLSN - The restore plan is broken because firstLsn of current log backup is not <= lastLsn of next log backup.\n\n * 400 BrokenRestorePlanWrongDiffBackupLSN - The restore plan is broken because firstLsn of diff backup is not >= firstLsn of full backup.\n\n * 400 BrokenRestorePlanGapInLogBackups - The restore plan is broken because firstLsn of current log backup is not equal to lastLsn of prev log backup.\n\n * 400 TargetServerDoesNotExist - The target server {0} does not exist or is not ready yet. Please check that it exists and retry the restore request.\n\n * 400 TargetServerRestoreNotAllowed - The target server {0} is currently not in a state that allows a restore to be started.\n\n * 400 XtpInitializedDuringRestore - Memory-optimized filegroup must be empty in order to be restored on General Purpose tier of SQL Database Managed Instance.\n\n * 400 FullBackupMissingChecksum - Provided full backup is missing checksum.\n\n * 400 FullBackupDamaged - Provided full backup is damaged.\n\n * 400 MissingStripeInBackupSet - Provided backup set has one or more missing stripes.\n\n * 400 BackupsFromMultipleDatabasesDetectedInTheContainerWhileRestoreInProgress - There are backups from multiple databases in the container folder. Please make sure the container folder has backups from a single database.{0}\n\n * 400 BrokenRestorePlanWrongDiffBaseGUID - The restore plan is broken because DifferentialBaseGuid of diff backup does not match BackupSetGuid of full backup.\n\n * 400 CorruptedPagesInBackupSet - Operation was aborted because RESTORE detected one or more corrupted pages in the backup set.\n\n * 400 ManagedIdentityIssueDetectedWhileRestoreInProgress - Managed identity is not set up properly. Please verify and try again.\n\n * 400 CorruptedPagesListMaintenance - Operation was aborted because an internal error occurred while processing the backup taken without checksum.\n\n * 400 StorageBrokenIssueDetectedWhileInProgress - Storage connection is broken. Retrying automatically...\n\n * 400 PartiallyContainedDatabaseUnsupported - \"Backup for a partially contained database is not supported.\"\n\n * 400 RequiredBackupIsNotLastRestored - Migration cannot be completed because provided backup file name is not the name of the last backup file that is restored.\n\n * 400 ManagedInstanceStorageLimitHit - The managed instance has reached its storage limit.\n\n * 400 IncompatiblePhysicalLayoutTooFewDataFiles - Database backup contains incompatible physical layout. No data files are found in the backup.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineDataFilesExist - Database backup contains incompatible physical layout. Non-online data files exist.\n\n * 400 IncompatiblePhysicalLayoutWrongNumberOfLogFiles - Database backup contains incompatible physical layout. Multiple log files are not supported.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineLogFilesExist - Database backup contains incompatible physical layout. Non-online log files exist.\n\n * 400 IncompatiblePhysicalLayoutTooManyNonDataLogFiles - Database backup contains incompatible physical layout. Too many non-data/log files.\n\n * 400 ExternalBackupAlreadySignaledToComplete - The restore request has already been signaled to complete.\n\n * 400 ExternalBackupRestoreHasNotBeenStarted - The restore request can only be completed once the restore has started.\n\n * 400 ExternalBackupUpgradeInProgress - The restore request cannot be completed, since upgrade is in progress.\n\n * 400 IncompatiblePhysicalLayoutTooManyXTPFiles - Database backup contains incompatible physical layout. Multiple files found in the filegroup that contains MEMORY_OPTIMIZED_DATA.\n\n * 400 BlobStorageFailure - Blob storage failure has occurred.\n\n * 400 BackupsFromMultipleDatabasesDetectedInTheContainerFromTheStart - There are backups from multiple databases in the container folder. Please make sure the container folder has backups from a single database.{0}\n\n * 400 ManagedIdentityIssueDetectedFromTheStart - Managed identity is not set up properly. Please verify and try again.\n\n * 400 StorageBrokenIssueDetectedAtTheStart - Storage connection is broken. Please verify and try again.\n\n * 400 StorageBrokenIssueDetectedTerminateRetries - Storage connection is still broken. Please verify and try again.\n\n * 400 BackupSetBroken - Backup set is broken.\n\n * 400 SqlRestoreError - Non retriable error occurred while restoring backup.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 LongTermRetentionMigrationBackupNotFound - LTR backup specified does not exists.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 LongTermRetentionMigrationRequestConflict - A conflict operation on this LTR backup is still in progress.\n\n * 409 LongTermRetentionMigrationBackupConflict - Another LTR backup with same backup time for target database exists.\n\n * 409 MiCreateFailedNonDelegatedSubnet - User tried to deploy Managed Instance or Managed Instance pool in subnet that is not delegated to Microsoft.Sql/managedInstances.\n\n * 409 ConflictingManagedInstanceOperation - An operation is currently in progress for the managed instance.\n\n * 409 BackupRedundancyUpdateAndInstanceRedundancyConflict - The instance is multi-az but backup storage is being updated from zone redundant to non-zone redundant.\n\n * 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress - Cannot update instance redundancy because backup storage redundancy update is in progress.\n\n * 409 InstanceRedundancyUpdateAndBackupRedundancyConflict - The backup storage is non-zone redundant but instance redundancy is being updated to zone redundant.\n\n * 409 BackupRedundancyUpdateConflict - Cannot update backup storage redundancy because a backup storage redundancy update is already in progress.\n\n * 409 MiDropFailedOnAuthLocks - User tried to drop last Managed Instance in subnet that has Lock applied on resource(s).\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 412 InstanceNotReadyForBackupRedundancyUpdate - Cannot update backup storage redundancy because the instance is not ready.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 500 LongTermRetentionMigrationRequestCopyFailed - Copy operation failed for LTR backup blobs.\n\n * 500 LongTermRetentionMigrationRestoreVerExceeded - Restore verification failed after max attempts were reached.\n\n * 500 LongTermRetentionMigrationRestoreVerFailed - Restore verification failed.\n\n * 500 LongTermRetentionMigrationRequestFailedToStartOnTarget - Failed to start LTR backup copy request in target region.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully created the database.", @@ -225,7 +230,12 @@ } }, "202": { - "description": "Deleting the managed database is in progress." + "description": "Deleting the managed database is in progress.", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "The specified managed database does not exist." @@ -284,7 +294,12 @@ } }, "202": { - "description": "Updating the managed database is in progress." + "description": "Updating the managed database is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -336,13 +351,18 @@ "description": "Successfully canceled move request." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidResourceManagedDatabaseMoveRequest - Invalid Managed Instance database move request.\n\n * 400 InvalidManagedDatabaseMoveTargetResourceId - Invalid Managed Instance database move target resource ID in the properties.\n\n * 400 InvalidMoveTargetResourceId - The target resource identifier in move request is invalid.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary - The given primary field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the instance failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion - The provided partner managed instance region in the instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner region is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount - Only one managed instance pair is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid - The create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the instance failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues - Grace period value for the instance failover group must be greater than or equal to the '{0}' minutes minimum grace period\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update instance failover group request body should not modify the read-only property '{0}'.\n\n * 400 InstanceFailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of instance failover group.\n\n * 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription - Primary server and the partner server of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 ManagedInstanceDatabaseCopyOrMoveToInstanceWithOlderVersionEdition - Operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 400 ManagedInstanceDatabaseLimitExceeded - This operation cannot start because specified target managed instance '{0}' already has maximum number of user databases.\n\n * 400 BrokenConnectivityBetweenInstances - Database '{0}' operation failed because there is no network connectivity between source instance '{1}' and target instance '{2}'.\n\n * 400 XtpServerStateMismatch - Both source and target servers do not support memory optimized data.\n\n * 400 SubnetOverlapBetweenInstances - Database '{0}' operation failed because there is no connectivity between source and target Azure SQL Managed Instance. This is because the target instance subnet has an overlapping address range with the subnet of the source instance.\n\n * 400 CrossTenantOperationNotSupported - Cross tenant operation is not supported.\n\n * 400 TargetInsufficientStorage - Attempt to move/restore/copy database on the destination instance with insufficient space.\n\n * 400 CrossResourceOperationNotSupported - Cross resource operation is not supported.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedDatabaseGPFileSizeLimitExceeded - Creating a copy of a managed database on different SQL Managed Instance with General Purpose service tier would violate data file size limit. See: 'https://docs.microsoft.com/azure/azure-sql/managed-instance/resource-limits#service-tier-characteristics'.\n\n * 400 ManagedInstanceGPStorageAccountLimitExceeded - Creating a copy of a database on different SQL Managed Instance with General Purpose service tier would violate storage account size limit. See: 'https://docs.microsoft.com/azure/azure-sql/managed-instance/resource-limits#service-tier-characteristics'.\n\n * 400 SystemDatabaseUnsupportedOperation - Unsupported operation for system database.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ServerEditionMismatch - Edition must be the same as the primary server when creating a replica server.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in an Instance Failover Group need to reside in different regions to provide isolation.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 InstanceFailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a instance failover group.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceEstablishingFailoverGroupGeoPrimaryWithNewerVersionEditionThanSecondary - Failover group cannot be created because database format of the primary instance is not compatible with the database format of the secondary instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 ManagedInstanceFailoverInFailoverGroupInstancesWithDifferentVersionEditions - Failover operation cannot be performed because of database format mismatch between the instances in the failover group. Consider upgrading the database format of the primary instance or deleting the failover group to promote current secondary instance to a stand-alone instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 ManagedInstanceUpdateSloOngoing - The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\n\n * 400 FailoverGroupRegionMismatch - Partner region specified in Failover Group need to match the region of the partner managed instance indicated.\n\n * 400 DnsZoneMismatch - The DNSZone on the partner server is different from the DNSZone on the source server. This breaks InstanceFailoverGroup functionality.\n\n * 400 GeoDrInstanceSizeMismatch - Primary managed instance and partner managed instance do not have the same storage size.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 GeoDrSecondaryInstanceNotEmpty - Secondary managed instance has user databases. To create an instance failover group the secondary managed instance needs to be empty.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 StorageAccountFull - Managed Instance has reached the total capacity of underlying Azure storage account. Azure Premium Storage account is limited to 35TB of allocated space.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 ManagedInstanceRestoreToInstanceWithOlderVersionEdition - Restore operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 CrossManagedInstanceDatabaseMovementNotExist - Database movement does not exist.\n\n * 404 ResourceNotFound - Invalid request specifying a non-existent resource.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ManagedInstanceContainsInaccessibleDatabases - The operation could not be completed because managed instance '{0}' contains databases that are in the Inaccessible state. Please either drop inaccessible databases or fix the issues with access to the customer-managed TDE protector key for managed instance before retrying operation. https://go.microsoft.com/fwlink/?linkid=2111623\n\n * 409 ManagedInstanceHasHybridLink - User tried to initiate operation that is not supported when managed instance has a hybrid link configured.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 InstanceFailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 InstanceFailoverGroupBusy - Instance failover group is busy with another operation.\n\n * 409 InstanceFailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Instance Failover Group name was supplied.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 InvalidResourceManagedDatabaseMoveRequest - Invalid Managed Instance database move request.\n\n * 400 InvalidManagedDatabaseMoveTargetResourceId - Invalid Managed Instance database move target resource ID in the properties.\n\n * 400 InvalidMoveTargetResourceId - The target resource identifier in move request is invalid.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary - The given primary field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the instance failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion - The provided partner managed instance region in the instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner region is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount - Only one managed instance pair is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid - The create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the instance failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues - Grace period value for the instance failover group must be greater than or equal to the '{0}' minutes minimum grace period\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update instance failover group request body should not modify the read-only property '{0}'.\n\n * 400 InstanceFailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of instance failover group.\n\n * 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription - Primary server and the partner server of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 ManagedInstanceDatabaseCopyOrMoveToInstanceWithOlderVersionEdition - Operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 400 ManagedInstanceDatabaseLimitExceeded - This operation cannot start because specified target managed instance '{0}' already has maximum number of user databases.\n\n * 400 BrokenConnectivityBetweenInstances - Database '{0}' operation failed because there is no network connectivity between source instance '{1}' and target instance '{2}'.\n\n * 400 XtpServerStateMismatch - Both source and target servers do not support memory optimized data.\n\n * 400 SubnetOverlapBetweenInstances - Database '{0}' operation failed because there is no connectivity between source and target Azure SQL Managed Instance. This is because the target instance subnet has an overlapping address range with the subnet of the source instance.\n\n * 400 CrossTenantOperationNotSupported - Cross tenant operation is not supported.\n\n * 400 TargetInsufficientStorage - Attempt to move/restore/copy database on the destination instance with insufficient space.\n\n * 400 CrossResourceOperationNotSupported - Cross resource operation is not supported.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedDatabaseGPFileSizeLimitExceeded - Creating a copy of a managed database on different SQL Managed Instance with General Purpose service tier would violate data file size limit. See: 'https://docs.microsoft.com/azure/azure-sql/managed-instance/resource-limits#service-tier-characteristics'.\n\n * 400 ManagedInstanceGPStorageAccountLimitExceeded - Creating a copy of a database on different SQL Managed Instance with General Purpose service tier would violate storage account size limit. See: 'https://docs.microsoft.com/azure/azure-sql/managed-instance/resource-limits#service-tier-characteristics'.\n\n * 400 SystemDatabaseUnsupportedOperation - Unsupported operation for system database.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ServerEditionMismatch - Edition must be the same as the primary server when creating a replica server.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in an Instance Failover Group need to reside in different regions to provide isolation.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 InstanceFailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a instance failover group.\n\n * 400 ManagedInstanceGeoDRNotAllowedForInstancePool - Creating auto-failover group (GeoDR) is not supported for Managed Instances provisioned inside instance pools. Auto failover groups can be created only for standalone Managed Instances.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceEstablishingFailoverGroupGeoPrimaryWithNewerVersionEditionThanSecondary - Failover group cannot be created because database format of the primary instance is not compatible with the database format of the secondary instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 ManagedInstanceFailoverInFailoverGroupInstancesWithDifferentVersionEditions - Failover operation cannot be performed because of database format mismatch between the instances in the failover group. Consider upgrading the database format of the primary instance or deleting the failover group to promote current secondary instance to a stand-alone instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 ManagedInstanceNotAllowedInGeoDRSetupWhenFreemium - Deploying failover group is not supported with the free Azure SQL Managed Instance offer.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 ManagedInstanceUpdateSloOngoing - The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\n\n * 400 FailoverGroupRegionMismatch - Partner region specified in Failover Group need to match the region of the partner managed instance indicated.\n\n * 400 DnsZoneMismatch - The DNSZone on the partner server is different from the DNSZone on the source server. This breaks InstanceFailoverGroup functionality.\n\n * 400 GeoDrInstanceSizeMismatch - Primary managed instance and partner managed instance do not have the same storage size.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 GeoDrSecondaryInstanceNotEmpty - Secondary managed instance has user databases. To create an instance failover group the secondary managed instance needs to be empty.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 StorageAccountFull - Managed Instance has reached the total capacity of underlying Azure storage account. Azure Premium Storage account is limited to 35TB of allocated space.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 ManagedInstanceRestoreToInstanceWithOlderVersionEdition - Restore operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 CrossManagedInstanceDatabaseMovementNotExist - Database movement does not exist.\n\n * 404 ResourceNotFound - Invalid request specifying a non-existent resource.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ManagedInstanceContainsInaccessibleDatabases - The operation could not be completed because managed instance '{0}' contains databases that are in the Inaccessible state. Please either drop inaccessible databases or fix the issues with access to the customer-managed TDE protector key for managed instance before retrying operation. https://go.microsoft.com/fwlink/?linkid=2111623\n\n * 409 ManagedInstanceHasHybridLink - User tried to initiate operation that is not supported when managed instance has a hybrid link configured.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 InstanceFailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 InstanceFailoverGroupBusy - Instance failover group is busy with another operation.\n\n * 409 InstanceFailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Instance Failover Group name was supplied.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Canceling move is in progress." + "description": "Canceling move is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -391,13 +411,18 @@ "description": "Successfully completed move request." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidResourceManagedDatabaseMoveRequest - Invalid Managed Instance database move request.\n\n * 400 InvalidManagedDatabaseMoveTargetResourceId - Invalid Managed Instance database move target resource ID in the properties.\n\n * 400 InvalidMoveTargetResourceId - The target resource identifier in move request is invalid.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary - The given primary field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the instance failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion - The provided partner managed instance region in the instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner region is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount - Only one managed instance pair is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid - The create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the instance failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues - Grace period value for the instance failover group must be greater than or equal to the '{0}' minutes minimum grace period\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update instance failover group request body should not modify the read-only property '{0}'.\n\n * 400 InstanceFailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of instance failover group.\n\n * 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription - Primary server and the partner server of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 ManagedInstanceDatabaseCopyOrMoveToInstanceWithOlderVersionEdition - Operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 400 ManagedInstanceDatabaseLimitExceeded - This operation cannot start because specified target managed instance '{0}' already has maximum number of user databases.\n\n * 400 BrokenConnectivityBetweenInstances - Database '{0}' operation failed because there is no network connectivity between source instance '{1}' and target instance '{2}'.\n\n * 400 XtpServerStateMismatch - Both source and target servers do not support memory optimized data.\n\n * 400 SubnetOverlapBetweenInstances - Database '{0}' operation failed because there is no connectivity between source and target Azure SQL Managed Instance. This is because the target instance subnet has an overlapping address range with the subnet of the source instance.\n\n * 400 CrossTenantOperationNotSupported - Cross tenant operation is not supported.\n\n * 400 TargetInsufficientStorage - Attempt to move/restore/copy database on the destination instance with insufficient space.\n\n * 400 CrossResourceOperationNotSupported - Cross resource operation is not supported.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedDatabaseGPFileSizeLimitExceeded - Creating a copy of a managed database on different SQL Managed Instance with General Purpose service tier would violate data file size limit. See: 'https://docs.microsoft.com/azure/azure-sql/managed-instance/resource-limits#service-tier-characteristics'.\n\n * 400 ManagedInstanceGPStorageAccountLimitExceeded - Creating a copy of a database on different SQL Managed Instance with General Purpose service tier would violate storage account size limit. See: 'https://docs.microsoft.com/azure/azure-sql/managed-instance/resource-limits#service-tier-characteristics'.\n\n * 400 SystemDatabaseUnsupportedOperation - Unsupported operation for system database.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ServerEditionMismatch - Edition must be the same as the primary server when creating a replica server.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in an Instance Failover Group need to reside in different regions to provide isolation.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 InstanceFailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a instance failover group.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceEstablishingFailoverGroupGeoPrimaryWithNewerVersionEditionThanSecondary - Failover group cannot be created because database format of the primary instance is not compatible with the database format of the secondary instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 ManagedInstanceFailoverInFailoverGroupInstancesWithDifferentVersionEditions - Failover operation cannot be performed because of database format mismatch between the instances in the failover group. Consider upgrading the database format of the primary instance or deleting the failover group to promote current secondary instance to a stand-alone instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 ManagedInstanceUpdateSloOngoing - The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\n\n * 400 FailoverGroupRegionMismatch - Partner region specified in Failover Group need to match the region of the partner managed instance indicated.\n\n * 400 DnsZoneMismatch - The DNSZone on the partner server is different from the DNSZone on the source server. This breaks InstanceFailoverGroup functionality.\n\n * 400 GeoDrInstanceSizeMismatch - Primary managed instance and partner managed instance do not have the same storage size.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 GeoDrSecondaryInstanceNotEmpty - Secondary managed instance has user databases. To create an instance failover group the secondary managed instance needs to be empty.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 StorageAccountFull - Managed Instance has reached the total capacity of underlying Azure storage account. Azure Premium Storage account is limited to 35TB of allocated space.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 ManagedInstanceRestoreToInstanceWithOlderVersionEdition - Restore operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 CrossManagedInstanceDatabaseMovementNotExist - Database movement does not exist.\n\n * 404 ResourceNotFound - Invalid request specifying a non-existent resource.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ManagedInstanceContainsInaccessibleDatabases - The operation could not be completed because managed instance '{0}' contains databases that are in the Inaccessible state. Please either drop inaccessible databases or fix the issues with access to the customer-managed TDE protector key for managed instance before retrying operation. https://go.microsoft.com/fwlink/?linkid=2111623\n\n * 409 ManagedInstanceHasHybridLink - User tried to initiate operation that is not supported when managed instance has a hybrid link configured.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 InstanceFailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 InstanceFailoverGroupBusy - Instance failover group is busy with another operation.\n\n * 409 InstanceFailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Instance Failover Group name was supplied.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 InvalidResourceManagedDatabaseMoveRequest - Invalid Managed Instance database move request.\n\n * 400 InvalidManagedDatabaseMoveTargetResourceId - Invalid Managed Instance database move target resource ID in the properties.\n\n * 400 InvalidMoveTargetResourceId - The target resource identifier in move request is invalid.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary - The given primary field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the instance failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion - The provided partner managed instance region in the instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner region is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount - Only one managed instance pair is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid - The create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the instance failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues - Grace period value for the instance failover group must be greater than or equal to the '{0}' minutes minimum grace period\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update instance failover group request body should not modify the read-only property '{0}'.\n\n * 400 InstanceFailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of instance failover group.\n\n * 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription - Primary server and the partner server of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 ManagedInstanceDatabaseCopyOrMoveToInstanceWithOlderVersionEdition - Operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 400 ManagedInstanceDatabaseLimitExceeded - This operation cannot start because specified target managed instance '{0}' already has maximum number of user databases.\n\n * 400 BrokenConnectivityBetweenInstances - Database '{0}' operation failed because there is no network connectivity between source instance '{1}' and target instance '{2}'.\n\n * 400 XtpServerStateMismatch - Both source and target servers do not support memory optimized data.\n\n * 400 SubnetOverlapBetweenInstances - Database '{0}' operation failed because there is no connectivity between source and target Azure SQL Managed Instance. This is because the target instance subnet has an overlapping address range with the subnet of the source instance.\n\n * 400 CrossTenantOperationNotSupported - Cross tenant operation is not supported.\n\n * 400 TargetInsufficientStorage - Attempt to move/restore/copy database on the destination instance with insufficient space.\n\n * 400 CrossResourceOperationNotSupported - Cross resource operation is not supported.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedDatabaseGPFileSizeLimitExceeded - Creating a copy of a managed database on different SQL Managed Instance with General Purpose service tier would violate data file size limit. See: 'https://docs.microsoft.com/azure/azure-sql/managed-instance/resource-limits#service-tier-characteristics'.\n\n * 400 ManagedInstanceGPStorageAccountLimitExceeded - Creating a copy of a database on different SQL Managed Instance with General Purpose service tier would violate storage account size limit. See: 'https://docs.microsoft.com/azure/azure-sql/managed-instance/resource-limits#service-tier-characteristics'.\n\n * 400 SystemDatabaseUnsupportedOperation - Unsupported operation for system database.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ServerEditionMismatch - Edition must be the same as the primary server when creating a replica server.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in an Instance Failover Group need to reside in different regions to provide isolation.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 InstanceFailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a instance failover group.\n\n * 400 ManagedInstanceGeoDRNotAllowedForInstancePool - Creating auto-failover group (GeoDR) is not supported for Managed Instances provisioned inside instance pools. Auto failover groups can be created only for standalone Managed Instances.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceEstablishingFailoverGroupGeoPrimaryWithNewerVersionEditionThanSecondary - Failover group cannot be created because database format of the primary instance is not compatible with the database format of the secondary instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 ManagedInstanceFailoverInFailoverGroupInstancesWithDifferentVersionEditions - Failover operation cannot be performed because of database format mismatch between the instances in the failover group. Consider upgrading the database format of the primary instance or deleting the failover group to promote current secondary instance to a stand-alone instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 ManagedInstanceNotAllowedInGeoDRSetupWhenFreemium - Deploying failover group is not supported with the free Azure SQL Managed Instance offer.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 ManagedInstanceUpdateSloOngoing - The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\n\n * 400 FailoverGroupRegionMismatch - Partner region specified in Failover Group need to match the region of the partner managed instance indicated.\n\n * 400 DnsZoneMismatch - The DNSZone on the partner server is different from the DNSZone on the source server. This breaks InstanceFailoverGroup functionality.\n\n * 400 GeoDrInstanceSizeMismatch - Primary managed instance and partner managed instance do not have the same storage size.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 GeoDrSecondaryInstanceNotEmpty - Secondary managed instance has user databases. To create an instance failover group the secondary managed instance needs to be empty.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 StorageAccountFull - Managed Instance has reached the total capacity of underlying Azure storage account. Azure Premium Storage account is limited to 35TB of allocated space.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 ManagedInstanceRestoreToInstanceWithOlderVersionEdition - Restore operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 CrossManagedInstanceDatabaseMovementNotExist - Database movement does not exist.\n\n * 404 ResourceNotFound - Invalid request specifying a non-existent resource.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ManagedInstanceContainsInaccessibleDatabases - The operation could not be completed because managed instance '{0}' contains databases that are in the Inaccessible state. Please either drop inaccessible databases or fix the issues with access to the customer-managed TDE protector key for managed instance before retrying operation. https://go.microsoft.com/fwlink/?linkid=2111623\n\n * 409 ManagedInstanceHasHybridLink - User tried to initiate operation that is not supported when managed instance has a hybrid link configured.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 InstanceFailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 InstanceFailoverGroupBusy - Instance failover group is busy with another operation.\n\n * 409 InstanceFailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Instance Failover Group name was supplied.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Completing move is in progress." + "description": "Completing move is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -452,7 +477,12 @@ } }, "202": { - "description": "Completing restore request is in progress." + "description": "Completing restore request is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -501,13 +531,18 @@ "description": "Successfully started move request." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidManagedInstanceBackupMode - Invalid Managed Instance backup mode in the properties.\n\n * 400 InvalidManagedInstanceCompleteMode - Invalid Managed Instance complete mode in the properties.\n\n * 400 InvalidResourceManagedDatabaseMoveRequest - Invalid Managed Instance database move request.\n\n * 400 InvalidManagedDatabaseMoveTargetResourceId - Invalid Managed Instance database move target resource ID in the properties.\n\n * 400 InvalidMoveTargetResourceId - The target resource identifier in move request is invalid.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 ManagedDatabaseMoveSourceAndTargetNameDoNotMatch - The specified database name '{0}' at the source instance and the specified database name '{1}' at the destination instance must be the same.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary - The given primary field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the instance failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion - The provided partner managed instance region in the instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner region is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount - Only one managed instance pair is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid - The create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the instance failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues - Grace period value for the instance failover group must be greater than or equal to the '{0}' minutes minimum grace period\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update instance failover group request body should not modify the read-only property '{0}'.\n\n * 400 InstanceFailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of instance failover group.\n\n * 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription - Primary server and the partner server of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 ManagedInstanceDatabaseCopyOrMoveToInstanceWithOlderVersionEdition - Operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 400 ManagedInstanceDatabaseLimitExceeded - This operation cannot start because specified target managed instance '{0}' already has maximum number of user databases.\n\n * 400 BrokenConnectivityBetweenInstances - Database '{0}' operation failed because there is no network connectivity between source instance '{1}' and target instance '{2}'.\n\n * 400 XtpServerStateMismatch - Both source and target servers do not support memory optimized data.\n\n * 400 SubnetOverlapBetweenInstances - Database '{0}' operation failed because there is no connectivity between source and target Azure SQL Managed Instance. This is because the target instance subnet has an overlapping address range with the subnet of the source instance.\n\n * 400 CrossTenantOperationNotSupported - Cross tenant operation is not supported.\n\n * 400 TargetInsufficientStorage - Attempt to move/restore/copy database on the destination instance with insufficient space.\n\n * 400 CrossResourceOperationNotSupported - Cross resource operation is not supported.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedDatabaseGPFileSizeLimitExceeded - Creating a copy of a managed database on different SQL Managed Instance with General Purpose service tier would violate data file size limit. See: 'https://docs.microsoft.com/azure/azure-sql/managed-instance/resource-limits#service-tier-characteristics'.\n\n * 400 ManagedInstanceGPStorageAccountLimitExceeded - Creating a copy of a database on different SQL Managed Instance with General Purpose service tier would violate storage account size limit. See: 'https://docs.microsoft.com/azure/azure-sql/managed-instance/resource-limits#service-tier-characteristics'.\n\n * 400 SystemDatabaseUnsupportedOperation - Unsupported operation for system database.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ServerEditionMismatch - Edition must be the same as the primary server when creating a replica server.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in an Instance Failover Group need to reside in different regions to provide isolation.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 InstanceFailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a instance failover group.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceEstablishingFailoverGroupGeoPrimaryWithNewerVersionEditionThanSecondary - Failover group cannot be created because database format of the primary instance is not compatible with the database format of the secondary instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 ManagedInstanceFailoverInFailoverGroupInstancesWithDifferentVersionEditions - Failover operation cannot be performed because of database format mismatch between the instances in the failover group. Consider upgrading the database format of the primary instance or deleting the failover group to promote current secondary instance to a stand-alone instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 ManagedInstanceUpdateSloOngoing - The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\n\n * 400 FailoverGroupRegionMismatch - Partner region specified in Failover Group need to match the region of the partner managed instance indicated.\n\n * 400 DnsZoneMismatch - The DNSZone on the partner server is different from the DNSZone on the source server. This breaks InstanceFailoverGroup functionality.\n\n * 400 GeoDrInstanceSizeMismatch - Primary managed instance and partner managed instance do not have the same storage size.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 GeoDrSecondaryInstanceNotEmpty - Secondary managed instance has user databases. To create an instance failover group the secondary managed instance needs to be empty.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 StorageAccountFull - Managed Instance has reached the total capacity of underlying Azure storage account. Azure Premium Storage account is limited to 35TB of allocated space.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 ManagedInstanceRestoreToInstanceWithOlderVersionEdition - Restore operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 UnsupportedBackupStorageRedundancy - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 BackupSetNotFoundRecentPit - No backups were found to restore the database to the specified point in time. Please retry the operation. If the problem persists, contact support to restore the database.\n\n * 400 CannotUpdateIsLedgerDatabase - The ledger property of an existing database cannot be updated.\n\n * 400 LTRSterlingToVldbMigrationNotSupported - Cannot change service objective for database to Hyperscale as long-term retention is not yet supported on Hyperscale. Please disable long-term retention on the database and retry.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 InvalidPublicMaintenanceConfiguration - User tried to specify public maintenance configuration which cannot be converted to internal id (malformed or wrong region).\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 MaintenanceWindowNotSupportedForNamedReplica - User tried to create or update named replica with non-default maintenance window which is not supported.\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 InvalidStandbyGeoReadScale - User attempted to enable read scale on a standby geo database that does not support it.\n\n * 400 PerDatabaseCMKKeyRotationAttemptedWhileOldThumbprintInUse - Key Rotation for the TDE Protector at the database level is blocked when active transactions are holding up the log encrypted with old keys. Please refer to aka.ms/azuresqldbkeyrotation for possible strategies to workaround this issue.\n\n * 400 TierChangeUnsupportedDueToCDCEnabledDatabase - The database cannot update its sku because it is enabled for CDC.\n\n * 400 PerDBCMKNotSupportedWithLTR - Database-level CMK is not supported when Long-term Backup Retention is enabled on the database.\n\n * 400 VBSEnclaveNotSupportedForDW - The preferredEnclaveType is not supported for dedicated SQL Pools.\n\n * 400 VBSEnclaveNotSupportedForDCSeriesSLO - Configuring the 'VBS' preferredEnclaveType for databases using the DC-series hardware configuration is not supported. DC-series databases are pre-configured with Intel SGX enclaves. Virtualization based security (VBS) enclaves are not supported.\n\n * 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutDatabaseLevelEncryptionProtector - Database-level encryption protector must be set on the target database while attempting to copy or replicate a database encrypted with a database level key.\n\n * 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeys - While attempting to replicate a database configured with database level encryption protector, the current keys being used by the primary must be passed to the secondary database.\n\n * 400 PartnerDBNotCompatibleForSGXEnclave - Attempt to set GeoDR link or update SLO for enclave enabled database is only supported when both database are running on DC-series hardware.\n\n * 400 PerDatabaseCMKGeoPrimaryIsNotConfiguredWithDatabaseLevelEncryptionProtector - The geo-primary database must be configured with a database level encryption protector before setting a database level encryption protector on the geo-secondary.\n\n * 400 ElasticJobsNotSupportedOnAutoPauseEnabledDatabase - Auto-pause enabled serverless database is not supported as an Elastic Jobs database because job agent would prevent that database from pausing. You can either disable auto-pause on this serverless database or delete the job agent that is using this database. See here for more details: https://docs.microsoft.com/azure/azure-sql/database/serverless-tier-overview#auto-pausing\n\n * 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave - Configuring geo-replication is not supported for databases using different values of the preferredEnclaveType property. The primary '{0}' database on the '{1}' server uses the '{2}' preferredEnclaveType, whereas the specified preferredEnclaveType for the secondary '{3}' database on the '{4}' server is '{5}'.\n\n * 400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes - Planned failover between primary and secondary database with different preferredEnclaveType is not supported for Virtualization-based security (VBS) enclaves.\n\n * 400 PerDatabaseCMKGeoPrimaryIsConfiguredWithDatabaseLevelEncryptionProtector - The geo-primary database must not be configured with a database level encryption protector when failing over to a geo-secondary without a database level encryption protector.\n\n * 400 CreateDatabaseAttemptedWithRotationInProgress - The create database operation can not be performed at this time due to ongoing Transparent Data Encryption (TDE) key rotation on the server. Please try the operation again later.\n\n * 400 VBSEnclaveResourcePoolInvalidCombination - Adding a database with '{0}' preferredEnclaveType to an elastic pool '{1}' with '{2}' preferredEnclaveType is not supported. \nBefore adding the database to the elastic pool, ensure that the preferredEnclaveType is the same for both the database and the elastic pool. More information can be found on https://aka.ms/AlwaysEncryptedEnableSecureEnclaves\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 InvalidDatabaseCreateMode - Invalid request to create a database.\n\n * 400 MissingAsymmetricKeyOnTargetServer - Target server does not have access to an asymmetric key.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MultipleDroppedDatabasesWithTheSameName - Found multiple dropped databases with the same name on server.\n\n * 400 AzureKeyVaultClientError - The Azure Key Vault client encountered an error.\n\n * 400 AzureKeyVaultClientInfoError - An error occurred while obtaining information for the Azure Key Vault client.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 AzureKeyVaultKeyThumbprintIsDifferent - The operation could not be completed because the Azure Key Vault Key material is different than the current encryption protector key.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 HyperscaleReverseMigrationNotSupported - Reverse migration of a Hyperscale database to Sterling hit an unsupported scenario.\n\n * 400 UpdateSloOperationIdDoesNotExist - The action failed because no active update-slo operation detected for server: {0}, database: {1};. Please retry the operation by specifying valid parameters.\n\n * 400 ManualCutoverUnsupported - Invalid use of manual-cutover option. Please check current and requested service objective and retry the operation by specifying valid parameters.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 IsLedgerDatabaseIsNotSupportedOnResourceType - Changing the ledger property is not supported for this resource type.\n\n * 400 DatabaseNameInUse - Database already exists. Choose a different database name.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 UnableToCreateGeoChain - User attempted to create secondary database (chaining) even though automatic upload of ledger digests has been configured\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 TargetElasticPoolDoesNotExist - The elastic pool does not exist on a server.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 ElasticPoolNameRequired - User tried to create or update database to elastic pool service objective without specifying the name of the elastic pool.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 InvalidReadScaleEdition - User attempted to enable read scale on a database type that does not support it.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 GeoSecondaryMaxSizeUpdateFailed - The geo-secondary database is of a SLO that does not support the requested maxsize value or the geo-secondary is in an unsupported region or an update operation is already in progress on the geo-secondary database.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 SourceDatabaseEncryptionProtectorKeyUriRequiredForPerDatabaseCMKCopyOrReplication - Geo secondary database missing AKV of geo primary database\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 RequestedDatabaseSizeRequiresShrink - User attempted to ALTER DATABASE MODIFY MAXSIZE to modify the MAXSIZE for a database to a smaller size then the current size.\n\n * 400 CurrentDatabaseSizeExceedsDbMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 SecurityAzureKeyVaultGeoChainError - Creating secondary of secondary (a process known as chaining) is not supported when enabling Transparent Data Encryption using Azure Key Vault (BYOK).\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 UnsupportedCapacity - User tried to create or update database with capacity which is not supported.\n\n * 400 RestoreToFreeEditionNotSupported - Restore and GeoRestore target cannot be free database.\n\n * 400 RestoreNotSupportedForFreeEdition - Restore and GeoRestore are not supported for free database.\n\n * 400 InvalidDroppedDatabase - Source database dropped does not exist on server within the supported recovery period.\n\n * 400 InvalidLiveDatabase - Source database does not exist on server within the supported recovery period. If restoring a dropped database, please specify its deletion date.\n\n * 400 InvalidVldbRecoverySlo - The Hyperscale edition recovery requires both source and target databases to use Hyperscale service level objective.\n\n * 400 InvalidVldbRestoreSlo - The Hyperscale edition Point-In-Time restore requires both source and target databases to use Hyperscale service level objective.\n\n * 400 CannotSpecifyPoolOrSlo - Specifying an elastic pool and/or changing the service level objective or edition is not supported for edition.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 InvalidBackupStorageAccountType - User passed zrs/lrs during create/update of a database but it failed either because the customer is not whitelisted or because zrs is not available in the specified region.\n\n * 400 DatabaseInvalidSkuPropertyCombination - The properties of the requested sku are inconsistent. Please check that a valid combination is specified. See https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability for more details.\n\n * 400 DatabaseNamedReplicaPerDatabaseLimitExceeded - User tried create a named replica that would exceed the allowed number per primary database\n\n * 400 UnsupportedBackupStorageRedundancyForEdition - The requested backup storage redundancy is not supported for edition\n\n * 400 DatabaseIsCurrentlyPinned - Microsoft has pinned your database SQL Server engine version. To ensure your database does not hit production issues, any future scale operations on your database will be blocked until it has been un-pinned. Please contact Microsoft support for assistance with scaling.\n\n * 400 RestoreTargetEditionSizeInsufficient - User attempted to restore a database to an edition that is a smaller size than the current allocated size of the source.\n\n * 400 InvalidIdentityId - One or more identity id(s) provided are not valid ARM resource id(s). Please input valid id(s) and try again.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 DatabaseCreationBlockedForNonActivatedCMKServer - SQL Pool creations are blocked for CMK enabled workspaces until the workspace is activated. First, enable purge protection and grant the workspace Managed Identity the required permissions (Get, Wrap Key, Unwrap Key) on the Azure Key Vault of the workspace key. Next, activate your workspace after you have granted access.\n\n * 400 InvalidNumberOfIdentities - Only one user assigned managed identity is supported at the Database Level.\n\n * 400 NoRestorePointAvailable - The source database has not yet accomplished its first backup in order to support restore operations. Please retry the restore request later.\n\n * 400 DatabaseNamedReplicaChainingNotAllowed - User tried to create a named replica of a named replica which is not allowed.\n\n * 400 DatabaseNamedReplicaInvalidOperation - User attempted an unsupported operation on a named replica.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 DatabaseNamedReplicaInvalidSourceDatabase - User attempted to create a named replica in a different subscription or region than the source database.\n\n * 400 DatabaseNamedReplicaSourceDatabaseNotZoneRedundant - Zone Redundancy cannot be enabled on this Named Replica since the primary Hyperscale Database is not zone redundant.\n\n * 400 CannotAssignIdentityToMaster - Cannot assign an identity to a system database. Database identity cannot be assigned to 'master', 'model', 'tempdb', 'msdb', or 'resource' databases.\n\n * 400 PerDatabaseCMKDWNotSupported - Database-level CMK in preview is not supported for Datawarehouse edition.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 MissingThumbprintCrm - The restore operation of a CRM database failed because a required TDE certificate was missing. Please retry the restore operation to an existing elastic pool.\n\n * 400 ElasticPoolOverStorage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 RestoreTargetEditionSizeInsufficientV2 - User attempted to restore a database to an edition that is a smaller size than the allocated size of the restored database.\n\n * 400 ResourcePoolStorageLimitHitDuringRestore - The restored database can't be restored into the resource pool due to the remaining storage capacity in the pool.\n\n * 400 PerDatabaseCMKRestoreNotSupported - Database restore is not supported when Database-level CMK is configured in preview.\n\n * 400 PerDatabaseCMKHSNotSupported - Database-level CMK in preview is not supported for Hyperscale edition.\n\n * 400 PerDatabaseCMKGeoReplicationNotSupported - Geo Replication and Database Copy is not supported when Database-level CMK is configured in preview.\n\n * 400 InvalidStandbyGeoEdition - User attempted to create a DTU based standby geo.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 GeoRestoreBackupStorageTypeNotSupported - Database recovery requests are invalid when issued against a database that is not configured to use geo-redundant backup storage.\n\n * 400 RestoreHyperscaleToNonHyperscale - Restoring a Hyperscale database backup to a non-Hyperscale service tier or vice versa is not supported.\n\n * 400 SubscriptionDoesNotHaveAccessToServer - The subscription does not have access to the specified server(s)\n\n * 400 RecoveryPointDoesNotExist - The specified recovery point either does not exist or is not valid.\n\n * 400 LtrBackupNotFound - The specified long term retention backup does not exist.\n\n * 400 InvalidPointInTime - The specified point in time is not valid for the database.\n\n * 400 GeoRestoreCannotResolveTargetCluster - Cannot resolve target cluster for server\n\n * 400 CannotSpecifyEditionOrSloWhenRestoringToPool - Specifying the target service level objective or edition is not supported when restoring to an elastic pool.\n\n * 400 RestoreNotSupportedForGeoDrSecondary - Point-in-time restore and database recovery operations are not supported on databases that are currently configured as geo-secondaries.\n\n * 400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported - User attempted configuring backup retention policy on a Named Replica.\n\n * 400 GeoRedundantBackupsNotPermittedForSubscription - Geo-redundant backup storage is blocked for all databases under subscription '{0}' by preview feature 'Azure SQL Database Block Geo-redundant Backup Storage'. Please select a different backup storage redundancy.\n\n * 400 RestoreHyperscaleToNonHyperscaleElasticPool - Restoring a Hyperscale database to an elastic pool which is not Hyperscale or restoring a database which is not Hyperscale to a Hyperscale elastic pool is not supported.\n\n * 400 RestoreIneligibleDatabaseName - The specified target database name, '{0}', is reserved and cannot be used in a restore operation.\n\n * 400 RestoreNotSupportedForSystemDb - Restore and database recovery are not supported for system databases.\n\n * 400 RestoreIneligibleDroppedDatabaseShortLifespan - The source database, '{0}', dropped on '{1}', has not existed long enough to support restores.\n\n * 400 RestoreIneligibleLiveDatabaseShortLifespan - The source database, '{0}', has not yet accomplished its first backup in order to support restore operations. Please wait until at least the indicated earliest restore date '{1}' and resubmit the request.\n\n * 400 RestoreCrossServerDisabled - For point-in-time restores, the target logical server must be the same as the source logical server. Consider restoring to the source database's server, or using database copy or database recovery.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 RestoreSameServerRecoveryDisabled - Same-server recovery is currently not supported. Consider using point-in-time restore or recovering to a different server.\n\n * 400 RestoreNotSupportedFromLtrBackupToEdition - Restore from long-term retention backup to '{0}' edition not supported.\n\n * 400 RestoreNotSupportedFromExternalBackupToEdition - Restore from external backup to '{0}' edition not supported.\n\n * 400 UpdateToServerlessIfLtrIsNotDisabled - Enabling auto-pause for a serverless database is not supported if long-term backup retention is enabled.\n\n * 400 DuplicateRestoreOperation - A restore request with the same target database name '{0}' on server '{1}' already exists.\n\n * 400 ExternalBackupUriMalformed - The external backup storage container URI is malformed.\n\n * 400 ExternalBackupUriHostNotAllowed - The host name for the external backup storage container URI is not allowed.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 ExternalBackupUriInvalidSchemeOrPort - The external backup storage container URI uses an invalid scheme or port. Please use https and port 443.\n\n * 400 ExternalBackupVldbUnsupported - Hyperscale does not support external backup restore requests.\n\n * 400 InvalidPitrPriorToVldbMigration - For database '{0}', specified point-in-time '{1}' is prior to the Hyperscale migration time of '{2}'. Please specify a target edition or service level objective which is not Hyperscale when restoring to a point earlier than the Hyperscale migration.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 MissingKeyVaultUriForRestore - Azure Key Vault key URI '{0}' is required to successfully restore the database '{1}' under server '{2}'.\n\n * 400 BlockRestoreOnVldbGeoSecondary - Restore of Hyperscale database where source database is geo-secondary is not allowed.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 BackupSetNotFound - No backups were found to restore the database. Please contact support to restore the database.\n\n * 400 IncorrectAccessToAzureKeyVault - Target server does not have access to all AKV Uris created during the backup time.\n\n * 400 RestoreFailureSqlInstanceUnhealthy - Unable to connect to the instance in order to perform restore operation.\n\n * 400 BackupSetBroken - Backup set is broken.\n\n * 400 TimeoutDuringRestore - A timeout was encountered while trying to connect to the restore target.\n\n * 400 BrokenRestorePlanGapInLogBackups - The restore plan is broken because firstLsn of current log backup is not equal to lastLsn of prev log backup.\n\n * 400 FullBackupMissingChecksum - Provided full backup is missing checksum.\n\n * 400 RequiredBackupIsNotLastRestored - Migration cannot be completed because provided backup file name is not the name of the last backup file that is restored.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineDataFilesExist - Database backup contains incompatible physical layout. Non-online data files exist.\n\n * 400 IncompatiblePhysicalLayoutWrongNumberOfLogFiles - Database backup contains incompatible physical layout. Multiple log files are not supported.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 CrossManagedInstanceDatabaseMovementNotExist - Database movement does not exist.\n\n * 404 ResourceNotFound - Invalid request specifying a non-existent resource.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ManagedInstanceContainsInaccessibleDatabases - The operation could not be completed because managed instance '{0}' contains databases that are in the Inaccessible state. Please either drop inaccessible databases or fix the issues with access to the customer-managed TDE protector key for managed instance before retrying operation. https://go.microsoft.com/fwlink/?linkid=2111623\n\n * 409 ManagedInstanceHasHybridLink - User tried to initiate operation that is not supported when managed instance has a hybrid link configured.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 InstanceFailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 InstanceFailoverGroupBusy - Instance failover group is busy with another operation.\n\n * 409 InstanceFailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Instance Failover Group name was supplied.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 FreeDbAlreadyExists - Only one free database can exist for a subscription per region.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 UpdateSloFailedDatabaseTooBusy - Update SLO operation could not complete because database was too busy.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 TargetElasticPoolBeingUpdated - The update of elastic pool cannot be started because there is copy operation in progress for one of the databases in this elastic pool\n\n * 409 DatabaseCopyLimitPerReplicaReached - User reached the limit of concurrent database copies.\n\n * 409 ConflictRequestToUpdateBackupRedundancy - A conflict request to change backup storage redundancy is still in progress.\n\n * 409 DatabaseElasticPoolMaintenanceConflict - User tried to create or update a database with a specified maintenance configuration that conflicted with that of the elastic pool of the database.\n\n * 409 SubscriptionVcoreQuotaExceeded - Could not perform the operation because subscription would exceed the allowed vCore quota.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 InvalidManagedInstanceBackupMode - Invalid Managed Instance backup mode in the properties.\n\n * 400 InvalidManagedInstanceCompleteMode - Invalid Managed Instance complete mode in the properties.\n\n * 400 InvalidResourceManagedDatabaseMoveRequest - Invalid Managed Instance database move request.\n\n * 400 InvalidManagedDatabaseMoveTargetResourceId - Invalid Managed Instance database move target resource ID in the properties.\n\n * 400 InvalidMoveTargetResourceId - The target resource identifier in move request is invalid.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 ManagedDatabaseMoveSourceAndTargetNameDoNotMatch - The specified database name '{0}' at the source instance and the specified database name '{1}' at the destination instance must be the same.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary - The given primary field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the instance failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion - The provided partner managed instance region in the instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner region is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount - Only one managed instance pair is supported.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid - The create or update instance failover group request body is empty or invalid.\n\n * 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the instance failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues - Grace period value for the instance failover group must be greater than or equal to the '{0}' minutes minimum grace period\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update instance failover group request body should not modify the read-only property '{0}'.\n\n * 400 InstanceFailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of instance failover group.\n\n * 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription - Primary server and the partner server of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 ManagedInstanceDatabaseCopyOrMoveToInstanceWithOlderVersionEdition - Operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 400 ManagedInstanceDatabaseLimitExceeded - This operation cannot start because specified target managed instance '{0}' already has maximum number of user databases.\n\n * 400 BrokenConnectivityBetweenInstances - Database '{0}' operation failed because there is no network connectivity between source instance '{1}' and target instance '{2}'.\n\n * 400 XtpServerStateMismatch - Both source and target servers do not support memory optimized data.\n\n * 400 SubnetOverlapBetweenInstances - Database '{0}' operation failed because there is no connectivity between source and target Azure SQL Managed Instance. This is because the target instance subnet has an overlapping address range with the subnet of the source instance.\n\n * 400 CrossTenantOperationNotSupported - Cross tenant operation is not supported.\n\n * 400 TargetInsufficientStorage - Attempt to move/restore/copy database on the destination instance with insufficient space.\n\n * 400 CrossResourceOperationNotSupported - Cross resource operation is not supported.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedDatabaseGPFileSizeLimitExceeded - Creating a copy of a managed database on different SQL Managed Instance with General Purpose service tier would violate data file size limit. See: 'https://docs.microsoft.com/azure/azure-sql/managed-instance/resource-limits#service-tier-characteristics'.\n\n * 400 ManagedInstanceGPStorageAccountLimitExceeded - Creating a copy of a database on different SQL Managed Instance with General Purpose service tier would violate storage account size limit. See: 'https://docs.microsoft.com/azure/azure-sql/managed-instance/resource-limits#service-tier-characteristics'.\n\n * 400 SystemDatabaseUnsupportedOperation - Unsupported operation for system database.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ServerEditionMismatch - Edition must be the same as the primary server when creating a replica server.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in an Instance Failover Group need to reside in different regions to provide isolation.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 InstanceFailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a instance failover group.\n\n * 400 ManagedInstanceGeoDRNotAllowedForInstancePool - Creating auto-failover group (GeoDR) is not supported for Managed Instances provisioned inside instance pools. Auto failover groups can be created only for standalone Managed Instances.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceEstablishingFailoverGroupGeoPrimaryWithNewerVersionEditionThanSecondary - Failover group cannot be created because database format of the primary instance is not compatible with the database format of the secondary instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 ManagedInstanceFailoverInFailoverGroupInstancesWithDifferentVersionEditions - Failover operation cannot be performed because of database format mismatch between the instances in the failover group. Consider upgrading the database format of the primary instance or deleting the failover group to promote current secondary instance to a stand-alone instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 ManagedInstanceNotAllowedInGeoDRSetupWhenFreemium - Deploying failover group is not supported with the free Azure SQL Managed Instance offer.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 ManagedInstanceUpdateSloOngoing - The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\n\n * 400 FailoverGroupRegionMismatch - Partner region specified in Failover Group need to match the region of the partner managed instance indicated.\n\n * 400 DnsZoneMismatch - The DNSZone on the partner server is different from the DNSZone on the source server. This breaks InstanceFailoverGroup functionality.\n\n * 400 GeoDrInstanceSizeMismatch - Primary managed instance and partner managed instance do not have the same storage size.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 GeoDrSecondaryInstanceNotEmpty - Secondary managed instance has user databases. To create an instance failover group the secondary managed instance needs to be empty.\n\n * 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - Networking configuration is incorrect. Primary server's replication traffic cannot reach secondary server.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 StorageAccountFull - Managed Instance has reached the total capacity of underlying Azure storage account. Azure Premium Storage account is limited to 35TB of allocated space.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 ManagedInstanceRestoreToInstanceWithOlderVersionEdition - Restore operation cannot be performed because database format of the source instance is not compatible with the database format of the destination instance. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 UnsupportedBackupStorageRedundancy - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 BackupSetNotFoundRecentPit - No backups were found to restore the database to the specified point in time. Please retry the operation. If the problem persists, contact support to restore the database.\n\n * 400 CannotUpdateIsLedgerDatabase - The ledger property of an existing database cannot be updated.\n\n * 400 LTRSterlingToVldbMigrationNotSupported - Cannot change service objective for database to Hyperscale as long-term retention is not yet supported on Hyperscale. Please disable long-term retention on the database and retry.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 InvalidPublicMaintenanceConfiguration - User tried to specify public maintenance configuration which cannot be converted to internal id (malformed or wrong region).\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 MaintenanceWindowNotSupportedForNamedReplica - User tried to create or update named replica with non-default maintenance window which is not supported.\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 InvalidStandbyGeoReadScale - User attempted to enable read scale on a standby geo database that does not support it.\n\n * 400 PerDatabaseCMKKeyRotationAttemptedWhileOldThumbprintInUse - Key Rotation for the TDE Protector at the database level is blocked when active transactions are holding up the log encrypted with old keys. Please refer to aka.ms/azuresqldbkeyrotation for possible strategies to workaround this issue.\n\n * 400 TierChangeUnsupportedDueToCDCEnabledDatabase - The database cannot update its sku because it is enabled for CDC.\n\n * 400 PerDBCMKNotSupportedWithLTR - Database-level CMK is not supported when Long-term Backup Retention is enabled on the database.\n\n * 400 VBSEnclaveNotSupportedForDW - The preferredEnclaveType is not supported for dedicated SQL Pools.\n\n * 400 VBSEnclaveNotSupportedForDCSeriesSLO - Configuring the 'VBS' preferredEnclaveType for databases using the DC-series hardware configuration is not supported. DC-series databases are pre-configured with Intel SGX enclaves. Virtualization based security (VBS) enclaves are not supported.\n\n * 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutDatabaseLevelEncryptionProtector - Database-level encryption protector must be set on the target database while attempting to copy or replicate a database encrypted with a database level key.\n\n * 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeys - While attempting to replicate a database configured with database level encryption protector, the current keys being used by the primary must be passed to the secondary database.\n\n * 400 PartnerDBNotCompatibleForSGXEnclave - Attempt to set GeoDR link or update SLO for enclave enabled database is only supported when both database are running on DC-series hardware.\n\n * 400 PerDatabaseCMKGeoPrimaryIsNotConfiguredWithDatabaseLevelEncryptionProtector - The geo-primary database must be configured with a database level encryption protector before setting a database level encryption protector on the geo-secondary.\n\n * 400 ElasticJobsNotSupportedOnAutoPauseEnabledDatabase - Auto-pause enabled serverless database is not supported as an Elastic Jobs database because job agent would prevent that database from pausing. You can either disable auto-pause on this serverless database or delete the job agent that is using this database. See here for more details: https://docs.microsoft.com/azure/azure-sql/database/serverless-tier-overview#auto-pausing\n\n * 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave - Configuring geo-replication is not supported for databases using different values of the preferredEnclaveType property. The primary '{0}' database on the '{1}' server uses the '{2}' preferredEnclaveType, whereas the specified preferredEnclaveType for the secondary '{3}' database on the '{4}' server is '{5}'.\n\n * 400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes - Planned failover between primary and secondary database with different preferredEnclaveType is not supported for Virtualization-based security (VBS) enclaves.\n\n * 400 PerDatabaseCMKGeoPrimaryIsConfiguredWithDatabaseLevelEncryptionProtector - The geo-primary database must not be configured with a database level encryption protector when failing over to a geo-secondary without a database level encryption protector.\n\n * 400 CreateDatabaseAttemptedWithRotationInProgress - The create database operation can not be performed at this time due to ongoing Transparent Data Encryption (TDE) key rotation on the server. Please try the operation again later.\n\n * 400 VBSEnclaveResourcePoolInvalidCombination - Adding a database with '{0}' preferredEnclaveType to an elastic pool '{1}' with '{2}' preferredEnclaveType is not supported. \nBefore adding the database to the elastic pool, ensure that the preferredEnclaveType is the same for both the database and the elastic pool. More information can be found on https://aka.ms/AlwaysEncryptedEnableSecureEnclaves\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 InvalidDatabaseCreateMode - Invalid request to create a database.\n\n * 400 MissingAsymmetricKeyOnTargetServer - Target server does not have access to an asymmetric key.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MultipleDroppedDatabasesWithTheSameName - Found multiple dropped databases with the same name on server.\n\n * 400 AzureKeyVaultClientError - The Azure Key Vault client encountered an error.\n\n * 400 AzureKeyVaultClientInfoError - An error occurred while obtaining information for the Azure Key Vault client.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 AzureKeyVaultKeyThumbprintIsDifferent - The operation could not be completed because the Azure Key Vault Key material is different than the current encryption protector key.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 HyperscaleReverseMigrationNotSupported - Reverse migration of a Hyperscale database to Sterling hit an unsupported scenario.\n\n * 400 UpdateSloOperationIdDoesNotExist - The action failed because no active update-slo operation detected for server: {0}, database: {1};. Please retry the operation by specifying valid parameters.\n\n * 400 ManualCutoverUnsupported - Invalid use of manual-cutover option. Please check current and requested service objective and retry the operation by specifying valid parameters.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 IsLedgerDatabaseIsNotSupportedOnResourceType - Changing the ledger property is not supported for this resource type.\n\n * 400 DatabaseNameInUse - Database already exists. Choose a different database name.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 UnableToCreateGeoChain - User attempted to create secondary database (chaining) even though automatic upload of ledger digests has been configured\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 TargetElasticPoolDoesNotExist - The elastic pool does not exist on a server.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 ElasticPoolNameRequired - User tried to create or update database to elastic pool service objective without specifying the name of the elastic pool.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 InvalidReadScaleEdition - User attempted to enable read scale on a database type that does not support it.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 GeoSecondaryMaxSizeUpdateFailed - The geo-secondary database is of a SLO that does not support the requested maxsize value or the geo-secondary is in an unsupported region or an update operation is already in progress on the geo-secondary database.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 SourceDatabaseEncryptionProtectorKeyUriRequiredForPerDatabaseCMKCopyOrReplication - Geo secondary database missing AKV of geo primary database\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 RequestedDatabaseSizeRequiresShrink - User attempted to ALTER DATABASE MODIFY MAXSIZE to modify the MAXSIZE for a database to a smaller size then the current size.\n\n * 400 CurrentDatabaseSizeExceedsDbMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 SecurityAzureKeyVaultGeoChainError - Creating secondary of secondary (a process known as chaining) is not supported when enabling Transparent Data Encryption using Azure Key Vault (BYOK).\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 UnsupportedCapacity - User tried to create or update database with capacity which is not supported.\n\n * 400 RestoreToFreeEditionNotSupported - Restore and GeoRestore target cannot be free database.\n\n * 400 RestoreNotSupportedForFreeEdition - Restore and GeoRestore are not supported for free database.\n\n * 400 InvalidDroppedDatabase - Source database dropped does not exist on server within the supported recovery period.\n\n * 400 InvalidLiveDatabase - Source database does not exist on server within the supported recovery period. If restoring a dropped database, please specify its deletion date.\n\n * 400 InvalidVldbRecoverySlo - The Hyperscale edition recovery requires both source and target databases to use Hyperscale service level objective.\n\n * 400 InvalidVldbRestoreSlo - The Hyperscale edition Point-In-Time restore requires both source and target databases to use Hyperscale service level objective.\n\n * 400 CannotSpecifyPoolOrSlo - Specifying an elastic pool and/or changing the service level objective or edition is not supported for edition.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 InvalidBackupStorageAccountType - User passed zrs/lrs during create/update of a database but it failed either because the customer is not whitelisted or because zrs is not available in the specified region.\n\n * 400 DatabaseInvalidSkuPropertyCombination - The properties of the requested sku are inconsistent. Please check that a valid combination is specified. See https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability for more details.\n\n * 400 DatabaseNamedReplicaPerDatabaseLimitExceeded - User tried create a named replica that would exceed the allowed number per primary database\n\n * 400 UnsupportedBackupStorageRedundancyForEdition - The requested backup storage redundancy is not supported for edition\n\n * 400 DatabaseIsCurrentlyPinned - Microsoft has pinned your database SQL Server engine version. To ensure your database does not hit production issues, any future scale operations on your database will be blocked until it has been un-pinned. Please contact Microsoft support for assistance with scaling.\n\n * 400 RestoreTargetEditionSizeInsufficient - User attempted to restore a database to an edition that is a smaller size than the current allocated size of the source.\n\n * 400 InvalidIdentityId - One or more identity id(s) provided are not valid ARM resource id(s). Please input valid id(s) and try again.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 DatabaseCreationBlockedForNonActivatedCMKServer - SQL Pool creations are blocked for CMK enabled workspaces until the workspace is activated. First, enable purge protection and grant the workspace Managed Identity the required permissions (Get, Wrap Key, Unwrap Key) on the Azure Key Vault of the workspace key. Next, activate your workspace after you have granted access.\n\n * 400 InvalidNumberOfIdentities - Only one user assigned managed identity is supported at the Database Level.\n\n * 400 NoRestorePointAvailable - The source database has not yet accomplished its first backup in order to support restore operations. Please retry the restore request later.\n\n * 400 DatabaseNamedReplicaChainingNotAllowed - User tried to create a named replica of a named replica which is not allowed.\n\n * 400 DatabaseNamedReplicaInvalidOperation - User attempted an unsupported operation on a named replica.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 DatabaseNamedReplicaInvalidSourceDatabase - User attempted to create a named replica in a different subscription or region than the source database.\n\n * 400 DatabaseNamedReplicaSourceDatabaseNotZoneRedundant - Zone Redundancy cannot be enabled on this Named Replica since the primary Hyperscale Database is not zone redundant.\n\n * 400 CannotAssignIdentityToMaster - Cannot assign an identity to a system database. Database identity cannot be assigned to 'master', 'model', 'tempdb', 'msdb', or 'resource' databases.\n\n * 400 PerDatabaseCMKDWNotSupported - Database-level CMK in preview is not supported for Datawarehouse edition.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 MissingThumbprintCrm - The restore operation of a CRM database failed because a required TDE certificate was missing. Please retry the restore operation to an existing elastic pool.\n\n * 400 ElasticPoolOverStorage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 RestoreTargetEditionSizeInsufficientV2 - User attempted to restore a database to an edition that is a smaller size than the allocated size of the restored database.\n\n * 400 ResourcePoolStorageLimitHitDuringRestore - The restored database can't be restored into the resource pool due to the remaining storage capacity in the pool.\n\n * 400 PerDatabaseCMKRestoreNotSupported - Database restore is not supported when Database-level CMK is configured in preview.\n\n * 400 PerDatabaseCMKHSNotSupported - Database-level CMK in preview is not supported for Hyperscale edition.\n\n * 400 PerDatabaseCMKGeoReplicationNotSupported - Geo Replication and Database Copy is not supported when Database-level CMK is configured in preview.\n\n * 400 InvalidStandbyGeoEdition - User attempted to create a DTU based standby geo.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 GeoRestoreBackupStorageTypeNotSupported - Database recovery requests are invalid when issued against a database that is not configured to use geo-redundant backup storage.\n\n * 400 RestoreHyperscaleToNonHyperscale - Restoring a Hyperscale database backup to a non-Hyperscale service tier or vice versa is not supported.\n\n * 400 SubscriptionDoesNotHaveAccessToServer - The subscription does not have access to the specified server(s)\n\n * 400 RecoveryPointDoesNotExist - The specified recovery point either does not exist or is not valid.\n\n * 400 LtrBackupNotFound - The specified long term retention backup does not exist.\n\n * 400 InvalidPointInTime - The specified point in time is not valid for the database.\n\n * 400 GeoRestoreCannotResolveTargetCluster - Cannot resolve target cluster for server\n\n * 400 CannotSpecifyEditionOrSloWhenRestoringToPool - Specifying the target service level objective or edition is not supported when restoring to an elastic pool.\n\n * 400 RestoreNotSupportedForGeoDrSecondary - Point-in-time restore and database recovery operations are not supported on databases that are currently configured as geo-secondaries.\n\n * 400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported - User attempted configuring backup retention policy on a Named Replica.\n\n * 400 GeoRedundantBackupsNotPermittedForSubscription - Geo-redundant backup storage is blocked for all databases under subscription '{0}' by preview feature 'Azure SQL Database Block Geo-redundant Backup Storage'. Please select a different backup storage redundancy.\n\n * 400 RestoreHyperscaleToNonHyperscaleElasticPool - Restoring a Hyperscale database to an elastic pool which is not Hyperscale or restoring a database which is not Hyperscale to a Hyperscale elastic pool is not supported.\n\n * 400 RestoreIneligibleDatabaseName - The specified target database name, '{0}', is reserved and cannot be used in a restore operation.\n\n * 400 RestoreNotSupportedForSystemDb - Restore and database recovery are not supported for system databases.\n\n * 400 RestoreIneligibleDroppedDatabaseShortLifespan - The source database, '{0}', dropped on '{1}', has not existed long enough to support restores.\n\n * 400 RestoreIneligibleLiveDatabaseShortLifespan - The source database, '{0}', has not yet accomplished its first backup in order to support restore operations. Please wait until at least the indicated earliest restore date '{1}' and resubmit the request.\n\n * 400 RestoreCrossServerDisabled - For point-in-time restores, the target logical server must be the same as the source logical server. Consider restoring to the source database's server, or using database copy or database recovery.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 RestoreSameServerRecoveryDisabled - Same-server recovery is currently not supported. Consider using point-in-time restore or recovering to a different server.\n\n * 400 RestoreNotSupportedFromLtrBackupToEdition - Restore from long-term retention backup to '{0}' edition not supported.\n\n * 400 RestoreNotSupportedFromExternalBackupToEdition - Restore from external backup to '{0}' edition not supported.\n\n * 400 UpdateToServerlessIfLtrIsNotDisabled - Enabling auto-pause for a serverless database is not supported if long-term backup retention is enabled.\n\n * 400 DuplicateRestoreOperation - A restore request with the same target database name '{0}' on server '{1}' already exists.\n\n * 400 ExternalBackupUriMalformed - The external backup storage container URI is malformed.\n\n * 400 ExternalBackupUriHostNotAllowed - The host name for the external backup storage container URI is not allowed.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 ExternalBackupUriInvalidSchemeOrPort - The external backup storage container URI uses an invalid scheme or port. Please use https and port 443.\n\n * 400 ExternalBackupVldbUnsupported - Hyperscale does not support external backup restore requests.\n\n * 400 InvalidPitrPriorToVldbMigration - For database '{0}', specified point-in-time '{1}' is prior to the Hyperscale migration time of '{2}'. Please specify a target edition or service level objective which is not Hyperscale when restoring to a point earlier than the Hyperscale migration.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 MissingKeyVaultUriForRestore - Azure Key Vault key URI '{0}' is required to successfully restore the database '{1}' under server '{2}'.\n\n * 400 BlockRestoreOnVldbGeoSecondary - Restore of Hyperscale database where source database is geo-secondary is not allowed.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 BackupSetNotFound - No backups were found to restore the database. Please contact support to restore the database.\n\n * 400 IncorrectAccessToAzureKeyVault - Target server does not have access to all AKV Uris created during the backup time.\n\n * 400 RestoreFailureSqlInstanceUnhealthy - Unable to connect to the instance in order to perform restore operation.\n\n * 400 BackupSetBroken - Backup set is broken.\n\n * 400 TimeoutDuringRestore - A timeout was encountered while trying to connect to the restore target.\n\n * 400 BrokenRestorePlanGapInLogBackups - The restore plan is broken because firstLsn of current log backup is not equal to lastLsn of prev log backup.\n\n * 400 FullBackupMissingChecksum - Provided full backup is missing checksum.\n\n * 400 RequiredBackupIsNotLastRestored - Migration cannot be completed because provided backup file name is not the name of the last backup file that is restored.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineDataFilesExist - Database backup contains incompatible physical layout. Non-online data files exist.\n\n * 400 IncompatiblePhysicalLayoutWrongNumberOfLogFiles - Database backup contains incompatible physical layout. Multiple log files are not supported.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 CrossManagedInstanceDatabaseMovementNotExist - Database movement does not exist.\n\n * 404 ResourceNotFound - Invalid request specifying a non-existent resource.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ManagedInstanceContainsInaccessibleDatabases - The operation could not be completed because managed instance '{0}' contains databases that are in the Inaccessible state. Please either drop inaccessible databases or fix the issues with access to the customer-managed TDE protector key for managed instance before retrying operation. https://go.microsoft.com/fwlink/?linkid=2111623\n\n * 409 ManagedInstanceHasHybridLink - User tried to initiate operation that is not supported when managed instance has a hybrid link configured.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 InstanceFailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 InstanceFailoverGroupBusy - Instance failover group is busy with another operation.\n\n * 409 InstanceFailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Instance Failover Group name was supplied.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication operation was performed on a database that is not in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 FreeDbAlreadyExists - Only one free database can exist for a subscription per region.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 UpdateSloFailedDatabaseTooBusy - Update SLO operation could not complete because database was too busy.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 TargetElasticPoolBeingUpdated - The update of elastic pool cannot be started because there is copy operation in progress for one of the databases in this elastic pool\n\n * 409 DatabaseCopyLimitPerReplicaReached - User reached the limit of concurrent database copies.\n\n * 409 ConflictRequestToUpdateBackupRedundancy - A conflict request to change backup storage redundancy is still in progress.\n\n * 409 DatabaseElasticPoolMaintenanceConflict - User tried to create or update a database with a specified maintenance configuration that conflicted with that of the elastic pool of the database.\n\n * 409 SubscriptionVcoreQuotaExceeded - Could not perform the operation because subscription would exceed the allowed vCore quota.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Starting move is in progress." + "description": "Starting move is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceAdministrators.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceAdministrators.json index dc1cb34dc6f5..8f8ab9086853 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceAdministrators.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceAdministrators.json @@ -171,7 +171,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully created the managed instance administrator.", @@ -234,7 +239,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceAdvancedThreatProtectionSettings.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceAdvancedThreatProtectionSettings.json index 0f37a8d39a65..e3acf3c65ba7 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceAdvancedThreatProtectionSettings.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceAdvancedThreatProtectionSettings.json @@ -173,7 +173,12 @@ } }, "202": { - "description": "Created request to set the Advanced Threat Protection state." + "description": "Created request to set the Advanced Threat Protection state.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceAzureADOnlyAuthentications.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceAzureADOnlyAuthentications.json index 2ecf35930a0a..4662fab50d2c 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceAzureADOnlyAuthentications.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceAzureADOnlyAuthentications.json @@ -173,7 +173,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully updated Azure Active Directory only authentication property.", @@ -234,7 +239,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "The specified Azure Active Directory only property does not exist." diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceEncryptionProtectors.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceEncryptionProtectors.json index 580869fcff21..5aa578159971 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceEncryptionProtectors.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceEncryptionProtectors.json @@ -173,7 +173,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -233,7 +238,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceKeys.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceKeys.json index 7fed7f88b227..d8808614ea61 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceKeys.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceKeys.json @@ -166,7 +166,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully created the managed instance key.", @@ -220,7 +225,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "The specified managed instance key does not exist." diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceLongTermRetentionPolicies.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceLongTermRetentionPolicies.json index cf1af23ec04e..2f606ce1f7e0 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceLongTermRetentionPolicies.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceLongTermRetentionPolicies.json @@ -182,7 +182,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceOperations.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceOperations.json index 745b98609713..7088fe08bfd0 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceOperations.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceOperations.json @@ -381,12 +381,7 @@ "Failed", "Canceled" ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "ManagementOperationStepState", - "modelAsString": true - } + "type": "string" } } } diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstancePrivateEndpointConnections.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstancePrivateEndpointConnections.json index 516e6a35c59a..4727a65fd8a7 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstancePrivateEndpointConnections.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstancePrivateEndpointConnections.json @@ -157,7 +157,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -204,7 +209,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "Private endpoint connection does not exist." diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceTdeCertificates.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceTdeCertificates.json index 4857d43edc0a..88aa97335154 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceTdeCertificates.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstanceTdeCertificates.json @@ -57,7 +57,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstances.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstances.json index 354d4066e5cb..f7185addee20 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstances.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedInstances.json @@ -157,7 +157,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 SubnetMissingRequiredDelegation - Selected subnet is not delegated for SQL Managed Instance.\n\n * 400 ManagementServiceManagedServerDisabled - Operation failed since Managed Instance '{0}' is disabled. Please enable Managed Instance and try again.\n\n * 400 MiGeoRestoreWithWrongBackupStorageRedundancy - Geo-Restore is not allowed for managed instances with LRS/ZRS backup storage redundancy.\n\n * 400 LastBackupNameHasNewline - Please do not use forbidden characters ('\\n', '\\r') in lastBackupName.\n\n * 400 LastBackupNameHasNonAsciiCharacter - The operation was aborted because the 'LastBackupName' parameter contains invalid characters. Only ASCII characters are allowed.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled.\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 UpdatingInstanceAndBackupRedundancy - Instance zone redundancy and backup storage redundancy cannot be updated in the same request.\n\n * 400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled.\n\n * 400 RequestCantLandOnPaaSv2Platform - Request needs to land on PaaSv2 platform but PaaSv2 is not enabled.\n\n * 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.\n\n * 400 DeleteOfVersion2VirtualClusterIsDisabled - Delete of virtual cluster with version 2 is not enabled.\n\n * 400 DeleteOfVirtualClusterIsDisabled - Delete of virtual cluster is not enabled.\n\n * 400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool.\n\n * 400 DnsRefreshOnVirtualClusterIsDisabled - Refresh of DNS records on virtual cluster is not enabled.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 ManagedInstanceNotInSubscriptionResourceGroup - Specified managed instance does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 MiCreateFailedNonDelegatedSubnet - User tried to deploy Managed Instance or Managed Instance pool in subnet that is not delegated to Microsoft.Sql/managedInstances.\n\n * 409 ConflictingManagedInstanceOperation - An operation is currently in progress for the managed instance.\n\n * 409 BackupRedundancyUpdateAndInstanceRedundancyConflict - The instance is multi-az but backup storage is being updated from zone redundant to non-zone redundant.\n\n * 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress - Cannot update instance redundancy because backup storage redundancy update is in progress.\n\n * 409 InstanceRedundancyUpdateAndBackupRedundancyConflict - The backup storage is non-zone redundant but instance redundancy is being updated to zone redundant.\n\n * 409 BackupRedundancyUpdateConflict - Cannot update backup storage redundancy because a backup storage redundancy update is already in progress.\n\n * 409 MiDropFailedOnAuthLocks - User tried to drop last Managed Instance in subnet that has Lock applied on resource(s).\n\n * 412 InstanceNotReadyForBackupRedundancyUpdate - Cannot update backup storage redundancy because the instance is not ready.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 SubnetMissingRequiredDelegation - Selected subnet is not delegated for SQL Managed Instance.\n\n * 400 ManagementServiceManagedServerDisabled - Operation failed since Managed Instance '{0}' is disabled. Please enable Managed Instance and try again.\n\n * 400 MiGeoRestoreWithWrongBackupStorageRedundancy - Geo-Restore is not allowed for managed instances with LRS/ZRS backup storage redundancy.\n\n * 400 LastBackupNameHasNewline - Please do not use forbidden characters ('\\n', '\\r') in lastBackupName.\n\n * 400 LastBackupNameHasNonAsciiCharacter - The operation was aborted because the 'LastBackupName' parameter contains invalid characters. Only ASCII characters are allowed.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 LRSCutoverDatabaseDoesNotExist - The operation was aborted because the database name specified in the request doesn't match any database name on the specified server.\n\n * 400 LRSCutoverDatabaseNotInRestoringState - The operation was aborted because the specified database is not in restoring state.\n\n * 400 LRSCutoverDatabaseAlreadyRestored - The operation was aborted because the specified database was already restored.\n\n * 400 LRSCutoverAlreadyInitiated - The operation was aborted because a cutover for the specified database is already in progress.\n\n * 400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled.\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 UpdatingInstanceAndBackupRedundancy - Instance zone redundancy and backup storage redundancy cannot be updated in the same request.\n\n * 400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled.\n\n * 400 RequestCantLandOnPaaSv2Platform - Request needs to land on PaaSv2 platform but PaaSv2 is not enabled.\n\n * 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.\n\n * 400 DeleteOfVersion2VirtualClusterIsDisabled - Delete of virtual cluster with version 2 is not enabled.\n\n * 400 DeleteOfVirtualClusterIsDisabled - Delete of virtual cluster is not enabled.\n\n * 400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool.\n\n * 400 DnsRefreshOnVirtualClusterIsDisabled - Refresh of DNS records on virtual cluster is not enabled.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 ManagedInstanceNotInSubscriptionResourceGroup - Specified managed instance does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 MiCreateFailedNonDelegatedSubnet - User tried to deploy Managed Instance or Managed Instance pool in subnet that is not delegated to Microsoft.Sql/managedInstances.\n\n * 409 ConflictingManagedInstanceOperation - An operation is currently in progress for the managed instance.\n\n * 409 BackupRedundancyUpdateAndInstanceRedundancyConflict - The instance is multi-az but backup storage is being updated from zone redundant to non-zone redundant.\n\n * 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress - Cannot update instance redundancy because backup storage redundancy update is in progress.\n\n * 409 InstanceRedundancyUpdateAndBackupRedundancyConflict - The backup storage is non-zone redundant but instance redundancy is being updated to zone redundant.\n\n * 409 BackupRedundancyUpdateConflict - Cannot update backup storage redundancy because a backup storage redundancy update is already in progress.\n\n * 409 MiDropFailedOnAuthLocks - User tried to drop last Managed Instance in subnet that has Lock applied on resource(s).\n\n * 412 InstanceNotReadyForBackupRedundancyUpdate - Cannot update backup storage redundancy because the instance is not ready.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -212,7 +212,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 SubnetMissingRequiredDelegation - Selected subnet is not delegated for SQL Managed Instance.\n\n * 400 ManagementServiceManagedServerDisabled - Operation failed since Managed Instance '{0}' is disabled. Please enable Managed Instance and try again.\n\n * 400 MiGeoRestoreWithWrongBackupStorageRedundancy - Geo-Restore is not allowed for managed instances with LRS/ZRS backup storage redundancy.\n\n * 400 LastBackupNameHasNewline - Please do not use forbidden characters ('\\n', '\\r') in lastBackupName.\n\n * 400 LastBackupNameHasNonAsciiCharacter - The operation was aborted because the 'LastBackupName' parameter contains invalid characters. Only ASCII characters are allowed.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled.\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 UpdatingInstanceAndBackupRedundancy - Instance zone redundancy and backup storage redundancy cannot be updated in the same request.\n\n * 400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled.\n\n * 400 RequestCantLandOnPaaSv2Platform - Request needs to land on PaaSv2 platform but PaaSv2 is not enabled.\n\n * 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.\n\n * 400 DeleteOfVersion2VirtualClusterIsDisabled - Delete of virtual cluster with version 2 is not enabled.\n\n * 400 DeleteOfVirtualClusterIsDisabled - Delete of virtual cluster is not enabled.\n\n * 400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool.\n\n * 400 DnsRefreshOnVirtualClusterIsDisabled - Refresh of DNS records on virtual cluster is not enabled.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 ManagedInstanceNotInSubscriptionResourceGroup - Specified managed instance does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 MiCreateFailedNonDelegatedSubnet - User tried to deploy Managed Instance or Managed Instance pool in subnet that is not delegated to Microsoft.Sql/managedInstances.\n\n * 409 ConflictingManagedInstanceOperation - An operation is currently in progress for the managed instance.\n\n * 409 BackupRedundancyUpdateAndInstanceRedundancyConflict - The instance is multi-az but backup storage is being updated from zone redundant to non-zone redundant.\n\n * 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress - Cannot update instance redundancy because backup storage redundancy update is in progress.\n\n * 409 InstanceRedundancyUpdateAndBackupRedundancyConflict - The backup storage is non-zone redundant but instance redundancy is being updated to zone redundant.\n\n * 409 BackupRedundancyUpdateConflict - Cannot update backup storage redundancy because a backup storage redundancy update is already in progress.\n\n * 409 MiDropFailedOnAuthLocks - User tried to drop last Managed Instance in subnet that has Lock applied on resource(s).\n\n * 412 InstanceNotReadyForBackupRedundancyUpdate - Cannot update backup storage redundancy because the instance is not ready.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 SubnetMissingRequiredDelegation - Selected subnet is not delegated for SQL Managed Instance.\n\n * 400 ManagementServiceManagedServerDisabled - Operation failed since Managed Instance '{0}' is disabled. Please enable Managed Instance and try again.\n\n * 400 MiGeoRestoreWithWrongBackupStorageRedundancy - Geo-Restore is not allowed for managed instances with LRS/ZRS backup storage redundancy.\n\n * 400 LastBackupNameHasNewline - Please do not use forbidden characters ('\\n', '\\r') in lastBackupName.\n\n * 400 LastBackupNameHasNonAsciiCharacter - The operation was aborted because the 'LastBackupName' parameter contains invalid characters. Only ASCII characters are allowed.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 LRSCutoverDatabaseDoesNotExist - The operation was aborted because the database name specified in the request doesn't match any database name on the specified server.\n\n * 400 LRSCutoverDatabaseNotInRestoringState - The operation was aborted because the specified database is not in restoring state.\n\n * 400 LRSCutoverDatabaseAlreadyRestored - The operation was aborted because the specified database was already restored.\n\n * 400 LRSCutoverAlreadyInitiated - The operation was aborted because a cutover for the specified database is already in progress.\n\n * 400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled.\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 UpdatingInstanceAndBackupRedundancy - Instance zone redundancy and backup storage redundancy cannot be updated in the same request.\n\n * 400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled.\n\n * 400 RequestCantLandOnPaaSv2Platform - Request needs to land on PaaSv2 platform but PaaSv2 is not enabled.\n\n * 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.\n\n * 400 DeleteOfVersion2VirtualClusterIsDisabled - Delete of virtual cluster with version 2 is not enabled.\n\n * 400 DeleteOfVirtualClusterIsDisabled - Delete of virtual cluster is not enabled.\n\n * 400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool.\n\n * 400 DnsRefreshOnVirtualClusterIsDisabled - Refresh of DNS records on virtual cluster is not enabled.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 ManagedInstanceNotInSubscriptionResourceGroup - Specified managed instance does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 MiCreateFailedNonDelegatedSubnet - User tried to deploy Managed Instance or Managed Instance pool in subnet that is not delegated to Microsoft.Sql/managedInstances.\n\n * 409 ConflictingManagedInstanceOperation - An operation is currently in progress for the managed instance.\n\n * 409 BackupRedundancyUpdateAndInstanceRedundancyConflict - The instance is multi-az but backup storage is being updated from zone redundant to non-zone redundant.\n\n * 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress - Cannot update instance redundancy because backup storage redundancy update is in progress.\n\n * 409 InstanceRedundancyUpdateAndBackupRedundancyConflict - The backup storage is non-zone redundant but instance redundancy is being updated to zone redundant.\n\n * 409 BackupRedundancyUpdateConflict - Cannot update backup storage redundancy because a backup storage redundancy update is already in progress.\n\n * 409 MiDropFailedOnAuthLocks - User tried to drop last Managed Instance in subnet that has Lock applied on resource(s).\n\n * 412 InstanceNotReadyForBackupRedundancyUpdate - Cannot update backup storage redundancy because the instance is not ready.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -267,13 +267,18 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 SubnetMissingRequiredDelegation - Selected subnet is not delegated for SQL Managed Instance.\n\n * 400 InvalidDnsZone - The operation has failed because you are attempting to deploy managed instance as a geo-replication secondary to the subnet {0} in which there already exists a managed instance. Deploying managed instance as a geo-replication secondary is supported only in cases when managed instance is the first instance deployed in a subnet. Consider deploying managed instance as a geo-replication secondary to a different subnet in which there are no existing managed instances, or if deploying to a subnet with existing managed instance disable the geo-replication option.\n\n * 400 HkCannotSwitchToInactive - The database cannot proceed with pricing-tier update as it has memory-optimized objects. Please drop such objects and try again.\n\n * 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - Invalid storage size: Storage size limit ({0} GB) is less that current storage used ({1} GB). Please specify higher storage size limit.\n\n * 400 InstanceTimezoneUpdateNotSupported - Instance timezone update not supported.\n\n * 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - Create Managed Instance with non-default timezone not supported.\n\n * 400 ManagedInstanceIpAddressRangeLimit - Cannot perform creation/scaling of the managed instance as there are not enough available IP addresses in the subnet for performing the operation.\n\n * 400 VnetDelegationNotAllowed - User tried to inject Managed Server to subnet which is delegated.\n\n * 400 SubnetHasResourcesOfDifferentType - User tried to create MI in subnet that has resources of different type.\n\n * 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - Update of Managed Instance with maintenance window settings is not allowed.\n\n * 400 OperationNotAllowedInCurrentGeodrConfiguration - The operation is not allowed because the current geo-replication configuration does not allow this combination of {0}. Change the setting on the geo-replication partner before applying the change on this instance.\n\n * 400 VnetPrepareNIPFailed - User tried to prepare subnet that has a conflict with NetworkIntentPolicy.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 ManagedInstanceDeprecatedHardwareFamily - Changing the hardware generation to deprecated {0} generation is not possible.\n\n * 400 ManagedInstanceBackupStorageTypeNotSupported - Backup storage type parameter is not allowed in the instance update operation.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 EmptyPDCInvalidDnsZone - This managed instance cannot be deployed because its DNS-zone does not match the DNS-prefix of its intended virtual cluster for subnet {0}. Although this virtual cluster is empty, its DNS-prefix cannot be changed. Empty virtual clusters will be automatically removed after several hours. Consider waiting for this virtual cluster to expire or manually deleting this virtual cluster and then creating the managed instance.\n\n * 400 InstancePoolNotEnoughCapacity - An instance pool does not have enough capacity\n\n * 400 ManagedInstanceFreemiumNotAvailableForInputParameters - Managed instance creation or update executed with SLO that is not allowed for freemium.\n\n * 400 ManagedInstanceFreemiumNotAvailableOnRegion - Creation of a freemium managed instance on a region that is not allowlisted for freemium.\n\n * 400 ManagementServiceSubnetMaintenanceInProgress - User tried to initiate managed instance create/update while incompatible maintenance is in progress.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ManagedInstanceFreemiumNotAvailableForSubscription - Freemium is not enabled for this subscription type.\n\n * 400 ManagedInstanceInvalidEditionForInstancePool - User tried to select invalid service tier for managed instance inside an existing instance pool.\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 ManagedInstanceInvalidSubnetForInstancePool - User tried to select invalid subnet for managed instance inside an existing instance pool.\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 ManagedInstanceZoneRedudantFeatureNotSupported - ZoneRedundant feature is not supported for the selected service tier. For more details visit aka.ms/sqlmi-service-tier-characteristics.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - Enabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - Disabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SubnetIdCantBeUpdated - Changing managed instance subnet is not supported operation. Please remove this parameter from the request.\n\n * 400 MigrationToAnotherVNetNotSupported - Selected subnet is in another Virtual Network. Moving managed instance to another Virtual Network is not possible. Please provide subnet from Virtual Network {0}.\n\n * 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - Provided subnet is having different DNS zone from the current. Changing instance DNS zone is not supported. Please provide subnet with same DNS zone, create a new subnet or provide empty one.\n\n * 400 MigrationToGen4SubnetNotSupported - It is not possible to update subnet while running on Gen4 hardware as it is being deprecated. Please upgrade your hardware from Gen4 to Gen5 as part of the changing managed instance subnet operation by specifying both parameters at the same time: destination subnet and hardware generation.\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - The operation could not be completed because some of the database files are exceeding maximum General Purpose file size limit of {0} GB.\n\n * 400 CloudLifterUnsupportedFeature - The functionality is not available on the Managed Instance at this time.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 OperationCanNotStartDueToMiLink - The '{0}' operation cannot be completed as there exists a database in a process of creation through Managed Instance link. Please wait for the link creation to complete, or delete the link, and retry the operation again.\n\n * 400 ManagedInstanceSloUpdateFailed - SLO '{0}' operation cannot succeed as the memory usage of '{1}' exceeds the quota.\n\n * 400 SourceAndTargetSubnetsMustBeVnetPeered - Subnet currently used by managed instance and provided destination subnet are part of the virtual networks that are not connected with virtual network peering, or have peering established but don't have allowed traffic. In order to move managed instance from one subnet to another, virtual network peering needs to be established from both source and target virtual network. Please configure virtual network requirements and then try the operation again. Learn more https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks. \n\n * 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - Subnet provided for managed instance deployment is located on subscription different than the one submitted for managed instance. Managed instance and subnet used for deploying the instance must be on the same subscription. Please provide another subnet or switch to the subnet subscription and then try the operation again.\n\n * 400 CreateManagedInstanceInvalidSubnetSize - User attempted to create managed instance in a subnet that is smaller than the allowed minimal subnet size.\n\n * 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - Subnet selected for managed instance migration has address range that overlaps with address range of subnet that holds geo replicated secondary instance. Please verify that your subnet is configured according to guidelines in https://aka.ms/move-managed-instance. \n\n * 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - Subnet selected for managed instance migration is not configured to enable communication with a geo replicated secondary instance. Please check if all of the required ports are open. To properly configure your subnet read the guidelines in https://aka.ms/move-managed-instance. \n\n * 400 ManagedInstanceLocalStorageUpdateSloDisabled - Update SLO for managed instances with local storage is not supported yet.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 GatewayInvalidEdition - '{0}' is not a valid database edition in this version of SQL Server.\n\n * 400 ManagedInstanceInvalidHardwareFamilyForInstancePool - User tried to select invalid hardware family for managed instance inside an existing instance pool.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 ManagedInstanceInvalidLicenseTypeForInstancePool - User tried to select invalid license type for managed instance inside an existing instance pool.\n\n * 400 ManagedInstanceUpdateSloFromVersionlessToVersionedNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 ManagedInstanceUpdateSloFromNewerToOlderVersionEditionNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 ManagedInstanceUpdateSloFromVersionedToVersionlessWorkerCLNotAllowed - Changing the database format is not supported for this managed instance. Check the database format property value specified and visit https://aka.ms/sqlmi-fwnov2022 for more details.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 ManagedInstanceVersionEditionParameterNotAllowedForUsing - Specifying the database format property value is not supported at this time.\n\n * 400 ManagedInstanceFreemiumInvalidArchitecture - A freemium instance can not be created in the specified subnet '(0)'.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ManagedInstanceGeoDRNotAllowedForInstancePool - Creating auto-failover group (GeoDR) is not supported for Managed Instances provisioned inside instance pools. Auto failover groups can be created only for standalone Managed Instances.\n\n * 400 ManagedInstanceWithGeoDRMoveToInstancePoolNotAllowed - Customer has attempted to move a standalone Managed Instance with an existing auto-failover group configured into an instance pool, which is not supported. Only standalone instances without existing auto-failover groups configured can be moved to instance pools.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerRegion - Creation of ZoneRedundant SQL MI is temporarily disabled on this region. You can create Zone Redundant SQL Managed Instances in many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerHardwareGeneration - Creation of ZoneRedundant SQL MI is temporarily disabled for this hardware generation on this region. You can create Zone Redundant SQL Managed Instances with different hardware generation on this region or many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceUpdateSloGeoPrimaryWithNewerVersionEditionThanSecondary - Database format change must be performed on the secondary instance of the failover group first. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 ManagedInstanceFreemiumInstanceAlreadyExists - Only one free SQL Managed Instance is allowed per subscription.\n\n * 400 ManagementServiceGeodrSecondaryDatabaseInCreation - The '{0}' operation cannot be completed as there exists a database in a process of creation through failover group deployment. Please wait for the failover group deployment to complete, or alternatively delete the failover group and retry the operation again.\n\n * 400 ManagedInstanceConversionRegularToFreemiumNotAllowed - User tried converting a Regular SQL Managed Instance to Free SQL Managed Instance.\n\n * 400 ManagedInstanceConversionFreemiumToRegularAndUpdateSLOWhileStoppedNotAllowed - User tried converting a Free SQL Managed Instance to Regular SQL Managed Instance and Update SLO in same request, while Instance is stopped.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 ManagedInstanceMaintenanceWindowChangeNotAllowedWhenInInstancePool - Maintenance window is set at instance pool level and cannot be set individually per pooled instance.\n\n * 400 ManagedInstanceMoveToInstancePoolExceedsDbCountLimit - Cannot move the instance into the pool due to pool database count limit.\n\n * 400 StorageIOpsNotSupported - Storage IOps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidCollation - Invalid collation.\n\n * 400 StorageThroughputMBpsNotSupported - Storage throughput MBps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 StorageIOpsNotSupportedForSpecifiedEdition - Storage IOps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 StorageThroughputMBpsNotSupportedForSpecifiedEdition - Storage throughput MBps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 ManagedInstanceClassicVnetNotSupported - Managed Instance cannot be joined to a classic virtual network.\n\n * 400 AlterDbDeactivatedNotSupported - Database Operation failed for Server '{0}', Database '{1}' due to unexpected delay. Please try again.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetConfigHasNsg - User tried to inject Managed Server subnet with Network Security Groups.\n\n * 400 VnetConfigHasNoUdr - User tried to inject Managed Server subnet without default User Defined Route Table.\n\n * 400 VnetConfigHasInvalidUdr - User tried to inject Managed Server subnet with invalid User Defined Route Table.\n\n * 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.\n\n * 400 VnetConfigHasServiceEndpoints - User tried to inject Managed Server subnet with service endpoints.\n\n * 400 VnetSubnetIsInUse - User tried to inject Managed Server subnet that is not empty.\n\n * 400 VnetSubnetIsLocked - User tried to inject Managed Server subnet that is in locked scope.\n\n * 400 VnetSubnetIsGateway - User tried to inject Managed Server subnet that is Gateway subnet.\n\n * 400 VnetSubnetIsUnknown - User tried to inject Managed Server subnet that does not exist.\n\n * 400 VnetSubnetConflictWithIntendedPolicy - User tried to inject Managed Server subnet that has a conflict with IntendedPolicy.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 ManagedInstanceInvalidEditionForSku - The specified edition {0} is not consistent with the specified SKU {1}.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInCreateOfMI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the create operation.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagedInstanceInvalidLicenseType - The specified license type {0} is not valid.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInUpdateOfGPV1MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V1 Managed Instance.\n\n * 400 UnspecifiedTargetEditionAndFalseGPV2NotAllowedInUpdateOfGPV2MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value FALSE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 GPTargetEditionAndUnspecifiedGPV2NotAllowedInUpdateOFGPV2MI - Combination of General Purpose target edition (sku.name/sku.tier parameters) and unspecified value for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 BCTargetEditionAndSpecifiedGPV2ParamNotAllowedInCreateUpdateOfMI - Combination of Business Critical target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the create/update operation.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 UnspecifiedTargetEditionAndSpecifiedGPV2ParamNotAllowedInUpdateOfBCMI - Combination of unspecified target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the update operation of Business Critical Managed Instance.\n\n * 400 TotalMemoryMBNotSupported - Total memory MB parameter is not allowed in the instance create/update operation.\n\n * 400 TotalMemoryMBNotSupportedForSpecifiedEdition - Total memory MB parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 VnetResourceNotFound - Resource not found: '{0}'.\n\n * 400 InvalidTimezone - Invalid timezone.\n\n * 400 InvalidSubnetForGPV2Edition - General Purpose v2 edition of Managed Instance is not compatible with the specified subnet. Target subnet must be either empty, or all instances in it must run with November 2022 Feature Wave.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 TotalMemoryMBInvalidLimit - Total memory MB parameter has been set to an invalid limit.\n\n * 400 ManagedInstanceUpdateSloGPv2PerDatabaseFileLimitExceeded - The operation could not be completed because there is at least one database whose number of files is exceeding the limit of {0} files per database on General Purpose v2 edition.\n\n * 400 InstanceCollationUpdateNotSupported - User cannot change instance collation on Managed Instance.\n\n * 400 NextGenGPNotSupportedForCmwCustomers - Next-Gen General Purpose edition of Managed Instance does not support Custom Maintenance Window.\n\n * 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - User can create a Managed Instance only with collation 'SQL_Latin1_General_CP1_CI_AS'.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedInstanceExceedMaxAzureStorage - The operation could not be completed because total allocated storage size for General Purpose instance would exceed {0}. Please reduce the number of database files and retry operation.\n\n * 400 ManagedInstanceHasGeoReplica - The operation could not be completed because instance has configured geo replicated secondary instance.\n\n * 400 InvalidManagedServerDnsZonePartner - The resource URI of the geo-primary managed instance specified in the create request is invalid. Please ensure that the property is of the format /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/managedInstances/{managedInstanceName}\n\n * 400 ManagementServiceManagedServerDisabled - Operation failed since Managed Instance '{0}' is disabled. Please enable Managed Instance and try again.\n\n * 400 MiGeoRestoreWithWrongBackupStorageRedundancy - Geo-Restore is not allowed for managed instances with LRS/ZRS backup storage redundancy.\n\n * 400 LastBackupNameHasNewline - Please do not use forbidden characters ('\\n', '\\r') in lastBackupName.\n\n * 400 LastBackupNameHasNonAsciiCharacter - The operation was aborted because the 'LastBackupName' parameter contains invalid characters. Only ASCII characters are allowed.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled.\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 UpdatingInstanceAndBackupRedundancy - Instance zone redundancy and backup storage redundancy cannot be updated in the same request.\n\n * 400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled.\n\n * 400 RequestCantLandOnPaaSv2Platform - Request needs to land on PaaSv2 platform but PaaSv2 is not enabled.\n\n * 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.\n\n * 400 DeleteOfVersion2VirtualClusterIsDisabled - Delete of virtual cluster with version 2 is not enabled.\n\n * 400 DeleteOfVirtualClusterIsDisabled - Delete of virtual cluster is not enabled.\n\n * 400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool.\n\n * 400 DnsRefreshOnVirtualClusterIsDisabled - Refresh of DNS records on virtual cluster is not enabled.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidMinimalTlsVersion - Invalid minimal TLS version.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled.\n\n * 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.\n\n * 400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool.\n\n * 400 InvalidMaintenanceWindowSettings - Invalid maintenance window settings.\n\n * 400 InvalidMaintenanceWindowProperty - Invalid maintenance window property was specified.\n\n * 400 InvalidMaintenanceWindowPropertyNull - Invalid maintenance window with required properties null.\n\n * 400 InvalidMaintenanceWindowTypeWithPropertySpecified - Maintenance window type must not have certain properties specified.\n\n * 400 UpdateOfParameterNotSupported - Update of '{0}' is not supported.\n\n * 400 MaintenancePolicyInvalidDayOfWeek - The provided value for dayOfWeek is not valid. Please use one of the following values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.\n\n * 400 MaintenancePolicyFeatureIsDisabled - Assigning customer maintenance policy is not enabled for provided subscription. Please use maintenanceConfigurationId property instead.\n\n * 400 MaintenancePolicyInvalidType - The provided value for w type is not valid. Please use one of the following values: SystemDefined, CustomerDefined.\n\n * 400 MaintenancePolicyInvalidMaintenanceConfigurationId - The provided value for maintenanceConfigurationId is not valid. Please check Public Maintenance Configuration list to get the list of available configurations.\n\n * 400 MaintenancePolicyInvalidStartHour - The provided value for startHour is not valid. Start time represents the hour of the day when maintenance event should start. Accepted values are 00-23. Please retry with appropriate value.\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidExternalAdministratorLogin - Invalid or missing external administrator login name.\n\n * 400 InvalidExternalAdministratorSid - Invalid or missing external administrator object id.\n\n * 400 InvalidExternalAdministratorTenantId - Invalid or missing external administrator tenant id.\n\n * 400 ExternalAdministratorPrincipalType - Invalid or missing external administrator principal type. Please select from User, Application or Group.\n\n * 400 MissingExternalAdministratorWithAadOnlyAuth - In order to use Azure AD Only Authentication, please provide details of an external administrator.\n\n * 400 ExternalAdministratorLoginSameAsSqlAdmin - The names of the Azure Active Directory administrator and of the server admin account must be different. Please provide different values.\n\n * 400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed - Changing backup storage redundancy is not allowed for LTR Copy operations.\n\n * 400 LtrRestoreFailedArchiveStorageTier - Restoring archived long-term retention backup is not supported. Restore can be performed only on rehydrated or regular long-term retention backups.\n\n * 400 LtrArchiveStorageTierNotEnabled - Archiving long-term retention backups is not enabled.\n\n * 400 LtrArchiveWrongParameters - ChangeLongTermRetentionBackupAccessTier is not supported for the desired (backupStorageAccessTier, operationMode) combination. Only (Archive, Move) and (Hot, Copy) are allowed.\n\n * 400 LTRArchiveRedundancyChangeFailed - Updating the backup storage redundancy type to zone-redundant storage is not supported when a long-term retention policy with the 'archive' backup storage access tier is set\n\n * 400 LongTermRetentionMigrationSubscriptionNotFound - The subscription could not be found.\n\n * 400 LtrOperationFailedBackupImmutable - Deleting Long Term Retention backup failed because the backup is immutable.\n\n * 400 LongTermRetentionMigrationRequestNotSupported - Subscription is not allowed LTR backup Migration feature.\n\n * 400 LongTermRetentionMigrationCrossClusterRequestNotSupported - Source and target subscriptions are not allowed to communicate for LTR backup copy feature.\n\n * 400 LongTermRetentionMigrationParameterMissing - Required parameter missing for the operation.\n\n * 400 LongTermRetentionMigrationSameServerNotSupported - LTR Copy feature is not supported to copy LTR backups within same server.\n\n * 400 LongTermRetentionMigrationTargetServerNotFound - Target server does not exists or is not ready for LTR backup copy operation.\n\n * 400 LongTermRetentionMigrationTargetDatabaseNotFound - Target Database does not exists on the server.\n\n * 400 LongTermRetentionMigrationStorageTypeNotSupported - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 LongTermRetentionMigrationStorageMismatch - Active backup redundancy of database does not match backup redundancy requested by customer.\n\n * 400 LongTermRetentionMigrationDatabaseTypeNotSupported - LTR migration is only supported for managed instance and Azure SQL DB LTR backups.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 MissingKeyVaultUriForRestore - Azure Key Vault key URI '{0}' is required to successfully restore the database '{1}' under server '{2}'.\n\n * 400 AzureKeyVaultKeyUsedOnGeoPrimary - The operation could not be completed because the Azure Key Vault Key name {0} is currently set as encryption protector on geo-primary.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 SecurityAzureKeyVaultGeoChainError - Creating secondary of secondary (a process known as chaining) is not supported when enabling Transparent Data Encryption using Azure Key Vault (BYOK).\n\n * 400 PerDatabaseCMKDWNotSupported - Database-level CMK in preview is not supported for Datawarehouse edition.\n\n * 400 BlockSystemAssignedIdentityForCrossTenantCMK - Cross tenant CMK can only be configured when the server is configured with a User Assigned Managed Identity. Refer to https://aka.ms/sqltdebyokumi to configure User Assigned Managed Identity.\n\n * 400 CannotDropDatabaseAKVError - The database {0} on server {1} cannot be safely dropped because it is encrypted with a customer managed key that is no longer accessible to take the last backup before drop. Please restore Azure Key Vault Access on the server and revalidate the keys to make this database accessible and then proceed with the drop. For details see https://aka.ms/tdecmkrestorability\n\n * 400 CreateDatabaseAttemptedWithRotationInProgress - The create database operation can not be performed at this time due to ongoing Transparent Data Encryption (TDE) key rotation on the server. Please try the operation again later.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 PerDatabaseCMKRestoreNotSupported - Database restore is not supported when Database-level CMK is configured in preview.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 PerDatabaseCMKHSNotSupported - Database-level CMK in preview is not supported for Hyperscale edition.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 CMKOperationNotAllowed - User tried to perform an operation on the server when the server did not have Azure Key Vault Access.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 AzureKeyVaultKeyNameCurrentlyInUse - The operation could not be completed because the Azure Key Vault Key name {0} is currently in use.\n\n * 400 AzureKeyVaultKeyThumbprintIsDifferent - The operation could not be completed because the Azure Key Vault Key material is different than the current encryption protector key.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 OldGenerationOfAKVKeyBeingUsedError - Using an old version of AKV key as TDE protector is not allowed. Please use the latest version of the AKV key as the encryption protector\n\n * 400 PerDatabaseCMKMissingIdentityOnGeoSecondaryDatabase - Per Database CMK identity not setup on the target database.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 ManagedInstanceNotInSubscriptionResourceGroup - Specified managed instance does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 LongTermRetentionMigrationBackupNotFound - LTR backup specified does not exists.\n\n * 405 InvalidStorageIOpsLimitValue - Invalid storage IOps limit: {0} IOps. Storage IOps limit must be specified between {1} IOps and {2} IOps, in increments of {3} IOps.\n\n * 405 InvalidStorageThroughputMBpsLimitValue - Invalid storage throughput limit: {0} MBps. Storage throughput limit must be specified between {1} MBps and {2} MBps, in increments of {3} MBps.\n\n * 405 InvalidVcoreValue - vCore value {0} is not valid. Please specify a valid vCore value.\n\n * 405 InvalidHardwareGenerationValue - HardwareGeneration {0} is not valid. Please specify a valid HardwareGeneration value.\n\n * 405 InvalidStorageSizeValue - \"Invalid storage size: {0} GB. Storage size must be specified between {1} and {2} gigabytes, in increments of {3} GB.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 409 ServerOverridePreconditionFailed - Failed to apply server override on category '{0}', because physical db or instance '{1}' in server '{2}' is currently not in 'Ready' or 'Deactivated' state.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ManagedInstanceIsBusy - The server '{0}' is currently busy. Please wait a few minutes before trying again.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 409 MiCreateFailedNonDelegatedSubnet - User tried to deploy Managed Instance or Managed Instance pool in subnet that is not delegated to Microsoft.Sql/managedInstances.\n\n * 409 ConflictingManagedInstanceOperation - An operation is currently in progress for the managed instance.\n\n * 409 BackupRedundancyUpdateAndInstanceRedundancyConflict - The instance is multi-az but backup storage is being updated from zone redundant to non-zone redundant.\n\n * 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress - Cannot update instance redundancy because backup storage redundancy update is in progress.\n\n * 409 InstanceRedundancyUpdateAndBackupRedundancyConflict - The backup storage is non-zone redundant but instance redundancy is being updated to zone redundant.\n\n * 409 BackupRedundancyUpdateConflict - Cannot update backup storage redundancy because a backup storage redundancy update is already in progress.\n\n * 409 MiDropFailedOnAuthLocks - User tried to drop last Managed Instance in subnet that has Lock applied on resource(s).\n\n * 409 LongTermRetentionMigrationRequestConflict - A conflict operation on this LTR backup is still in progress.\n\n * 409 LongTermRetentionMigrationBackupConflict - Another LTR backup with same backup time for target database exists.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 412 InstanceNotReadyForBackupRedundancyUpdate - Cannot update backup storage redundancy because the instance is not ready.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 GatewayInternalServerError - The server encountered an unexpected exception.\n\n * 500 LongTermRetentionMigrationRequestCopyFailed - Copy operation failed for LTR backup blobs.\n\n * 500 LongTermRetentionMigrationRestoreVerExceeded - Restore verification failed after max attempts were reached.\n\n * 500 LongTermRetentionMigrationRestoreVerFailed - Restore verification failed.\n\n * 500 LongTermRetentionMigrationRequestFailedToStartOnTarget - Failed to start LTR backup copy request in target region.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 SubnetMissingRequiredDelegation - Selected subnet is not delegated for SQL Managed Instance.\n\n * 400 InvalidDnsZone - The operation has failed because you are attempting to deploy managed instance as a geo-replication secondary to the subnet {0} in which there already exists a managed instance. Deploying managed instance as a geo-replication secondary is supported only in cases when managed instance is the first instance deployed in a subnet. Consider deploying managed instance as a geo-replication secondary to a different subnet in which there are no existing managed instances, or if deploying to a subnet with existing managed instance disable the geo-replication option.\n\n * 400 HkCannotSwitchToInactive - The database cannot proceed with pricing-tier update as it has memory-optimized objects. Please drop such objects and try again.\n\n * 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - Invalid storage size: Storage size limit ({0} GB) is less that current storage used ({1} GB). Please specify higher storage size limit.\n\n * 400 InstanceTimezoneUpdateNotSupported - Instance timezone update not supported.\n\n * 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - Create Managed Instance with non-default timezone not supported.\n\n * 400 ManagedInstanceIpAddressRangeLimit - Cannot perform creation/scaling of the managed instance as there are not enough available IP addresses in the subnet for performing the operation.\n\n * 400 VnetDelegationNotAllowed - User tried to inject Managed Server to subnet which is delegated.\n\n * 400 SubnetHasResourcesOfDifferentType - User tried to create MI in subnet that has resources of different type.\n\n * 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - Update of Managed Instance with maintenance window settings is not allowed.\n\n * 400 OperationNotAllowedInCurrentGeodrConfiguration - The operation is not allowed because the current geo-replication configuration does not allow this combination of {0}. Change the setting on the geo-replication partner before applying the change on this instance.\n\n * 400 VnetPrepareNIPFailed - User tried to prepare subnet that has a conflict with NetworkIntentPolicy.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 ManagedInstanceDeprecatedHardwareFamily - Changing the hardware generation to deprecated {0} generation is not possible.\n\n * 400 ManagedInstanceBackupStorageTypeNotSupported - Backup storage type parameter is not allowed in the instance update operation.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 EmptyPDCInvalidDnsZone - This managed instance cannot be deployed because its DNS-zone does not match the DNS-prefix of its intended virtual cluster for subnet {0}. Although this virtual cluster is empty, its DNS-prefix cannot be changed. Empty virtual clusters will be automatically removed after several hours. Consider waiting for this virtual cluster to expire or manually deleting this virtual cluster and then creating the managed instance.\n\n * 400 InstancePoolNotEnoughCapacity - An instance pool does not have enough capacity\n\n * 400 ManagedInstanceFreemiumNotAvailableForInputParameters - Managed instance creation or update executed with SLO that is not allowed for freemium.\n\n * 400 ManagedInstanceFreemiumNotAvailableOnRegion - Creation of a freemium managed instance on a region that is not allowlisted for freemium.\n\n * 400 ManagementServiceSubnetMaintenanceInProgress - User tried to initiate managed instance create/update while incompatible maintenance is in progress.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ManagedInstanceFreemiumNotAvailableForSubscription - Freemium is not enabled for this subscription type.\n\n * 400 ManagedInstanceInvalidEditionForInstancePool - User tried to select invalid service tier for managed instance inside an existing instance pool.\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 ManagedInstanceInvalidSubnetForInstancePool - User tried to select invalid subnet for managed instance inside an existing instance pool.\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 ManagedInstanceZoneRedudantFeatureNotSupported - ZoneRedundant feature is not supported for the selected service tier. For more details visit aka.ms/sqlmi-service-tier-characteristics.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - Enabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - Disabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SubnetIdCantBeUpdated - Changing managed instance subnet is not supported operation. Please remove this parameter from the request.\n\n * 400 MigrationToAnotherVNetNotSupported - Selected subnet is in another Virtual Network. Moving managed instance to another Virtual Network is not possible. Please provide subnet from Virtual Network {0}.\n\n * 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - Provided subnet is having different DNS zone from the current. Changing instance DNS zone is not supported. Please provide subnet with same DNS zone, create a new subnet or provide empty one.\n\n * 400 MigrationToGen4SubnetNotSupported - It is not possible to update subnet while running on Gen4 hardware as it is being deprecated. Please upgrade your hardware from Gen4 to Gen5 as part of the changing managed instance subnet operation by specifying both parameters at the same time: destination subnet and hardware generation.\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - The operation could not be completed because some of the database files are exceeding maximum General Purpose file size limit of {0} GB.\n\n * 400 CloudLifterUnsupportedFeature - The functionality is not available on the Managed Instance at this time.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 OperationCanNotStartDueToMiLink - The '{0}' operation cannot be completed as there exists a database in a process of creation through Managed Instance link. Please wait for the link creation to complete, or delete the link, and retry the operation again.\n\n * 400 ManagedInstanceSloUpdateFailed - SLO '{0}' operation cannot succeed as the memory usage of '{1}' exceeds the quota.\n\n * 400 SourceAndTargetSubnetsMustBeVnetPeered - Subnet currently used by managed instance and provided destination subnet are part of the virtual networks that are not connected with virtual network peering, or have peering established but don't have allowed traffic. In order to move managed instance from one subnet to another, virtual network peering needs to be established from both source and target virtual network. Please configure virtual network requirements and then try the operation again. Learn more https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks. \n\n * 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - Subnet provided for managed instance deployment is located on subscription different than the one submitted for managed instance. Managed instance and subnet used for deploying the instance must be on the same subscription. Please provide another subnet or switch to the subnet subscription and then try the operation again.\n\n * 400 CreateManagedInstanceInvalidSubnetSize - User attempted to create managed instance in a subnet that is smaller than the allowed minimal subnet size.\n\n * 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - Subnet selected for managed instance migration has address range that overlaps with address range of subnet that holds geo replicated secondary instance. Please verify that your subnet is configured according to guidelines in https://aka.ms/move-managed-instance. \n\n * 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - Subnet selected for managed instance migration is not configured to enable communication with a geo replicated secondary instance. Please check if all of the required ports are open. To properly configure your subnet read the guidelines in https://aka.ms/move-managed-instance. \n\n * 400 ManagedInstanceLocalStorageUpdateSloDisabled - Update SLO for managed instances with local storage is not supported yet.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 GatewayInvalidEdition - '{0}' is not a valid database edition in this version of SQL Server.\n\n * 400 ManagedInstanceInvalidHardwareFamilyForInstancePool - User tried to select invalid hardware family for managed instance inside an existing instance pool.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 ManagedInstanceInvalidLicenseTypeForInstancePool - User tried to select invalid license type for managed instance inside an existing instance pool.\n\n * 400 ManagedInstanceUpdateSloFromVersionlessToVersionedNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 ManagedInstanceUpdateSloFromNewerToOlderVersionEditionNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 ManagedInstanceUpdateSloFromVersionedToVersionlessWorkerCLNotAllowed - Changing the database format is not supported for this managed instance. Check the database format property value specified and visit https://aka.ms/sqlmi-fwnov2022 for more details.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 ManagedInstanceVersionEditionParameterNotAllowedForUsing - Specifying the database format property value is not supported at this time.\n\n * 400 ManagedInstanceFreemiumInvalidArchitecture - A freemium instance can not be created in the specified subnet '(0)'.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ManagedInstanceWithGeoDRMoveToInstancePoolNotAllowed - Customer has attempted to move a standalone Managed Instance with an existing auto-failover group configured into an instance pool, which is not supported. Only standalone instances without existing auto-failover groups configured can be moved to instance pools.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerRegion - Creation of ZoneRedundant SQL MI is temporarily disabled on this region. You can create Zone Redundant SQL Managed Instances in many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerHardwareGeneration - Creation of ZoneRedundant SQL MI is temporarily disabled for this hardware generation on this region. You can create Zone Redundant SQL Managed Instances with different hardware generation on this region or many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceUpdateSloGeoPrimaryWithNewerVersionEditionThanSecondary - Database format change must be performed on the secondary instance of the failover group first. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 ManagedInstanceFreemiumInstanceAlreadyExists - Only one free SQL Managed Instance is allowed per subscription.\n\n * 400 ManagementServiceGeodrSecondaryDatabaseInCreation - The '{0}' operation cannot be completed as there exists a database in a process of creation through failover group deployment. Please wait for the failover group deployment to complete, or alternatively delete the failover group and retry the operation again.\n\n * 400 ManagedInstanceConversionRegularToFreemiumNotAllowed - User tried converting a Regular SQL Managed Instance to Free SQL Managed Instance.\n\n * 400 ManagedInstanceConversionFreemiumToRegularAndUpdateSLOWhileStoppedNotAllowed - User tried converting a Free SQL Managed Instance to Regular SQL Managed Instance and Update SLO in same request, while Instance is stopped.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 ManagedInstanceMaintenanceWindowChangeNotAllowedWhenInInstancePool - Maintenance window is set at instance pool level and cannot be set individually per pooled instance.\n\n * 400 ManagedInstanceMoveToInstancePoolExceedsDbCountLimit - Cannot move the instance into the pool due to pool database count limit.\n\n * 400 ManagedInstancePoolZoneRedundancyNotSupported - Cannot move a zone-redundant instance into the pool as zone-redundancy is not supported in pools.\n\n * 400 DeploymentIntoPrivateSubnetsNotAllowed - Deploying managed instances and instance pools into private subnets is not supported.\n\n * 400 StorageIOpsNotSupported - Storage IOps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidCollation - Invalid collation.\n\n * 400 StorageThroughputMBpsNotSupported - Storage throughput MBps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 StorageIOpsNotSupportedForSpecifiedEdition - Storage IOps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 StorageThroughputMBpsNotSupportedForSpecifiedEdition - Storage throughput MBps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 ManagedInstanceClassicVnetNotSupported - Managed Instance cannot be joined to a classic virtual network.\n\n * 400 AlterDbDeactivatedNotSupported - Database Operation failed for Server '{0}', Database '{1}' due to unexpected delay. Please try again.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetConfigHasNsg - User tried to inject Managed Server subnet with Network Security Groups.\n\n * 400 VnetConfigHasNoUdr - User tried to inject Managed Server subnet without default User Defined Route Table.\n\n * 400 VnetConfigHasInvalidUdr - User tried to inject Managed Server subnet with invalid User Defined Route Table.\n\n * 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.\n\n * 400 VnetConfigHasServiceEndpoints - User tried to inject Managed Server subnet with service endpoints.\n\n * 400 VnetSubnetIsInUse - User tried to inject Managed Server subnet that is not empty.\n\n * 400 VnetSubnetIsLocked - User tried to inject Managed Server subnet that is in locked scope.\n\n * 400 VnetSubnetIsGateway - User tried to inject Managed Server subnet that is Gateway subnet.\n\n * 400 VnetSubnetIsUnknown - User tried to inject Managed Server subnet that does not exist.\n\n * 400 VnetSubnetConflictWithIntendedPolicy - User tried to inject Managed Server subnet that has a conflict with IntendedPolicy.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 ManagedInstanceInvalidEditionForSku - The specified edition {0} is not consistent with the specified SKU {1}.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInCreateOfMI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the create operation.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagedInstanceInvalidLicenseType - The specified license type {0} is not valid.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInUpdateOfGPV1MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V1 Managed Instance.\n\n * 400 UnspecifiedTargetEditionAndFalseGPV2NotAllowedInUpdateOfGPV2MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value FALSE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 GPTargetEditionAndUnspecifiedGPV2NotAllowedInUpdateOFGPV2MI - Combination of General Purpose target edition (sku.name/sku.tier parameters) and unspecified value for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 BCTargetEditionAndSpecifiedGPV2ParamNotAllowedInCreateUpdateOfMI - Combination of Business Critical target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the create/update operation.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 UnspecifiedTargetEditionAndSpecifiedGPV2ParamNotAllowedInUpdateOfBCMI - Combination of unspecified target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the update operation of Business Critical Managed Instance.\n\n * 400 TotalMemoryMBNotSupported - Total memory MB parameter is not allowed in the instance create/update operation.\n\n * 400 TotalMemoryMBNotSupportedForSpecifiedEdition - Total memory MB parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 VnetResourceNotFound - Resource not found: '{0}'.\n\n * 400 InvalidTimezone - Invalid timezone.\n\n * 400 InvalidSubnetForGPV2Edition - General Purpose v2 edition of Managed Instance is not compatible with the specified subnet. Target subnet must be either empty, or all instances in it must run with November 2022 Feature Wave.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 TotalMemoryMBInvalidLimit - Total memory MB parameter has been set to an invalid limit.\n\n * 400 ManagedInstanceUpdateSloGPv2PerDatabaseFileLimitExceeded - The operation could not be completed because there is at least one database whose number of files is exceeding the limit of {0} files per database on General Purpose v2 edition.\n\n * 400 InstanceCollationUpdateNotSupported - User cannot change instance collation on Managed Instance.\n\n * 400 NextGenGPNotSupportedForCmwCustomers - Next-Gen General Purpose edition of Managed Instance does not support Custom Maintance Window.\n\n * 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - User can create a Managed Instance only with collation 'SQL_Latin1_General_CP1_CI_AS'.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedInstanceExceedMaxAzureStorage - The operation could not be completed because total allocated storage size for General Purpose instance would exceed {0}. Please reduce the number of database files and retry operation.\n\n * 400 ManagedInstanceHasGeoReplica - The operation could not be completed because instance has configured geo replicated secondary instance.\n\n * 400 InvalidManagedServerDnsZonePartner - The resource URI of the geo-primary managed instance specified in the create request is invalid. Please ensure that the property is of the format /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/managedInstances/{managedInstanceName}\n\n * 400 ManagementServiceManagedServerDisabled - Operation failed since Managed Instance '{0}' is disabled. Please enable Managed Instance and try again.\n\n * 400 MiGeoRestoreWithWrongBackupStorageRedundancy - Geo-Restore is not allowed for managed instances with LRS/ZRS backup storage redundancy.\n\n * 400 LastBackupNameHasNewline - Please do not use forbidden characters ('\\n', '\\r') in lastBackupName.\n\n * 400 LastBackupNameHasNonAsciiCharacter - The operation was aborted because the 'LastBackupName' parameter contains invalid characters. Only ASCII characters are allowed.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 LRSCutoverDatabaseDoesNotExist - The operation was aborted because the database name specified in the request doesn't match any database name on the specified server.\n\n * 400 LRSCutoverDatabaseNotInRestoringState - The operation was aborted because the specified database is not in restoring state.\n\n * 400 LRSCutoverDatabaseAlreadyRestored - The operation was aborted because the specified database was already restored.\n\n * 400 LRSCutoverAlreadyInitiated - The operation was aborted because a cutover for the specified database is already in progress.\n\n * 400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled.\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 UpdatingInstanceAndBackupRedundancy - Instance zone redundancy and backup storage redundancy cannot be updated in the same request.\n\n * 400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled.\n\n * 400 RequestCantLandOnPaaSv2Platform - Request needs to land on PaaSv2 platform but PaaSv2 is not enabled.\n\n * 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.\n\n * 400 DeleteOfVersion2VirtualClusterIsDisabled - Delete of virtual cluster with version 2 is not enabled.\n\n * 400 DeleteOfVirtualClusterIsDisabled - Delete of virtual cluster is not enabled.\n\n * 400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool.\n\n * 400 DnsRefreshOnVirtualClusterIsDisabled - Refresh of DNS records on virtual cluster is not enabled.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidMinimalTlsVersion - Invalid minimal TLS version.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled.\n\n * 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.\n\n * 400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool.\n\n * 400 InvalidMaintenanceWindowSettings - Invalid maintenance window settings.\n\n * 400 InvalidMaintenanceWindowProperty - Invalid maintenance window property was specified.\n\n * 400 InvalidMaintenanceWindowPropertyNull - Invalid maintenance window with required properties null.\n\n * 400 InvalidMaintenanceWindowTypeWithPropertySpecified - Maintenance window type must not have certain properties specified.\n\n * 400 UpdateOfParameterNotSupported - Update of '{0}' is not supported.\n\n * 400 MaintenancePolicyInvalidDayOfWeek - The provided value for dayOfWeek is not valid. Please use one of the following values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.\n\n * 400 MaintenancePolicyFeatureIsDisabled - Assigning customer maintenance policy is not enabled for provided subscription. Please use maintenanceConfigurationId property instead.\n\n * 400 MaintenancePolicyInvalidType - The provided value for w type is not valid. Please use one of the following values: SystemDefined, CustomerDefined.\n\n * 400 MaintenancePolicyInvalidMaintenanceConfigurationId - The provided value for maintenanceConfigurationId is not valid. Please check Public Maintenance Configuration list to get the list of available configurations.\n\n * 400 MaintenancePolicyInvalidStartHour - The provided value for startHour is not valid. Start time represents the hour of the day when maintenance event should start. Accepted values are 00-23. Please retry with appropriate value.\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidExternalAdministratorLogin - Invalid or missing external administrator login name.\n\n * 400 InvalidExternalAdministratorSid - Invalid or missing external administrator object id.\n\n * 400 InvalidExternalAdministratorTenantId - Invalid or missing external administrator tenant id.\n\n * 400 ExternalAdministratorPrincipalType - Invalid or missing external administrator principal type. Please select from User, Application or Group.\n\n * 400 MissingExternalAdministratorWithAadOnlyAuth - In order to use Azure AD Only Authentication, please provide details of an external administrator.\n\n * 400 ExternalAdministratorLoginSameAsSqlAdmin - The names of the Azure Active Directory administrator and of the server admin account must be different. Please provide different values.\n\n * 400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed - Changing backup storage redundancy is not allowed for LTR Copy operations.\n\n * 400 LtrRestoreFailedArchiveStorageTier - Restoring archived long-term retention backup is not supported. Restore can be performed only on rehydrated or regular long-term retention backups.\n\n * 400 LtrArchiveStorageTierNotEnabled - Archiving long-term retention backups is not enabled.\n\n * 400 LtrArchiveWrongParameters - ChangeLongTermRetentionBackupAccessTier is not supported for the desired (backupStorageAccessTier, operationMode) combination. Only (Archive, Move) and (Hot, Copy) are allowed.\n\n * 400 LTRArchiveRedundancyChangeFailed - Updating the backup storage redundancy type to zone-redundant storage is not supported when a long-term retention policy with the 'archive' backup storage access tier is set\n\n * 400 LongTermRetentionMigrationSubscriptionNotFound - The subscription could not be found.\n\n * 400 LtrOperationFailedBackupImmutable - Deleting Long Term Retention backup failed because the backup is immutable.\n\n * 400 LongTermRetentionMigrationRequestNotSupported - Subscription is not allowed LTR backup Migration feature.\n\n * 400 LongTermRetentionMigrationCrossClusterRequestNotSupported - Source and target subscriptions are not allowed to communicate for LTR backup copy feature.\n\n * 400 LongTermRetentionMigrationParameterMissing - Required parameter missing for the operation.\n\n * 400 LongTermRetentionMigrationSameServerNotSupported - LTR Copy feature is not supported to copy LTR backups within same server.\n\n * 400 LongTermRetentionMigrationTargetServerNotFound - Target server does not exists or is not ready for LTR backup copy operation.\n\n * 400 LongTermRetentionMigrationTargetDatabaseNotFound - Target Database does not exists on the server.\n\n * 400 LongTermRetentionMigrationStorageTypeNotSupported - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 LongTermRetentionMigrationStorageMismatch - Active backup redundancy of database does not match backup redundancy requested by customer.\n\n * 400 LongTermRetentionMigrationDatabaseTypeNotSupported - LTR migration is only supported for managed instance and Azure SQL DB LTR backups.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 MissingKeyVaultUriForRestore - Azure Key Vault key URI '{0}' is required to successfully restore the database '{1}' under server '{2}'.\n\n * 400 AzureKeyVaultKeyUsedOnGeoPrimary - The operation could not be completed because the Azure Key Vault Key name {0} is currently set as encryption protector on geo-primary.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 SecurityAzureKeyVaultGeoChainError - Creating secondary of secondary (a process known as chaining) is not supported when enabling Transparent Data Encryption using Azure Key Vault (BYOK).\n\n * 400 PerDatabaseCMKDWNotSupported - Database-level CMK in preview is not supported for Datawarehouse edition.\n\n * 400 BlockSystemAssignedIdentityForCrossTenantCMK - Cross tenant CMK can only be configured when the server is configured with a User Assigned Managed Identity. Refer to https://aka.ms/sqltdebyokumi to configure User Assigned Managed Identity.\n\n * 400 CannotDropDatabaseAKVError - The database {0} on server {1} cannot be safely dropped because it is encrypted with a customer managed key that is no longer accessible to take the last backup before drop. Please restore Azure Key Vault Access on the server and revalidate the keys to make this database accessible and then proceed with the drop. For details see https://aka.ms/tdecmkrestorability\n\n * 400 CreateDatabaseAttemptedWithRotationInProgress - The create database operation can not be performed at this time due to ongoing Transparent Data Encryption (TDE) key rotation on the server. Please try the operation again later.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 PerDatabaseCMKRestoreNotSupported - Database restore is not supported when Database-level CMK is configured in preview.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 PerDatabaseCMKHSNotSupported - Database-level CMK in preview is not supported for Hyperscale edition.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 CMKOperationNotAllowed - User tried to perform an operation on the server when the server did not have Azure Key Vault Access.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 AzureKeyVaultKeyNameCurrentlyInUse - The operation could not be completed because the Azure Key Vault Key name {0} is currently in use.\n\n * 400 AzureKeyVaultKeyThumbprintIsDifferent - The operation could not be completed because the Azure Key Vault Key material is different than the current encryption protector key.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 OldGenerationOfAKVKeyBeingUsedError - Using an old version of AKV key as TDE protector is not allowed. Please use the latest version of the AKV key as the encryption protector\n\n * 400 PerDatabaseCMKMissingIdentityOnGeoSecondaryDatabase - Per Database CMK identity not setup on the target database.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 ManagedInstanceNotInSubscriptionResourceGroup - Specified managed instance does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 LongTermRetentionMigrationBackupNotFound - LTR backup specified does not exists.\n\n * 405 InvalidStorageIOpsLimitValue - Invalid storage IOps limit: {0} IOps. Storage IOps limit must be specified between {1} IOps and {2} IOps, in increments of {3} IOps.\n\n * 405 InvalidStorageThroughputMBpsLimitValue - Invalid storage throughput limit: {0} MBps. Storage throughput limit must be specified between {1} MBps and {2} MBps, in increments of {3} MBps.\n\n * 405 InvalidVcoreValue - vCore value {0} is not valid. Please specify a valid vCore value.\n\n * 405 InvalidHardwareGenerationValue - HardwareGeneration {0} is not valid. Please specify a valid HardwareGeneration value.\n\n * 405 InvalidStorageSizeValue - \"Invalid storage size: {0} GB. Storage size must be specified between {1} and {2} gigabytes, in increments of {3} GB.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 409 ServerOverridePreconditionFailed - Failed to apply server override on category '{0}', because physical db or instance '{1}' in server '{2}' is currently not in 'Ready' or 'Deactivated' state.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ManagedInstanceIsBusy - The server '{0}' is currently busy. Please wait a few minutes before trying again.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 409 MiCreateFailedNonDelegatedSubnet - User tried to deploy Managed Instance or Managed Instance pool in subnet that is not delegated to Microsoft.Sql/managedInstances.\n\n * 409 ConflictingManagedInstanceOperation - An operation is currently in progress for the managed instance.\n\n * 409 BackupRedundancyUpdateAndInstanceRedundancyConflict - The instance is multi-az but backup storage is being updated from zone redundant to non-zone redundant.\n\n * 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress - Cannot update instance redundancy because backup storage redundancy update is in progress.\n\n * 409 InstanceRedundancyUpdateAndBackupRedundancyConflict - The backup storage is non-zone redundant but instance redundancy is being updated to zone redundant.\n\n * 409 BackupRedundancyUpdateConflict - Cannot update backup storage redundancy because a backup storage redundancy update is already in progress.\n\n * 409 MiDropFailedOnAuthLocks - User tried to drop last Managed Instance in subnet that has Lock applied on resource(s).\n\n * 409 LongTermRetentionMigrationRequestConflict - A conflict operation on this LTR backup is still in progress.\n\n * 409 LongTermRetentionMigrationBackupConflict - Another LTR backup with same backup time for target database exists.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 412 InstanceNotReadyForBackupRedundancyUpdate - Cannot update backup storage redundancy because the instance is not ready.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 GatewayInternalServerError - The server encountered an unexpected exception.\n\n * 500 LongTermRetentionMigrationRequestCopyFailed - Copy operation failed for LTR backup blobs.\n\n * 500 LongTermRetentionMigrationRestoreVerExceeded - Restore verification failed after max attempts were reached.\n\n * 500 LongTermRetentionMigrationRestoreVerFailed - Restore verification failed.\n\n * 500 LongTermRetentionMigrationRequestFailedToStartOnTarget - Failed to start LTR backup copy request in target region.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully created the managed instance.", @@ -317,13 +322,18 @@ "description": "Successfully deleted the managed instance." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 SubnetMissingRequiredDelegation - Selected subnet is not delegated for SQL Managed Instance.\n\n * 400 ManagementServiceManagedServerDisabled - Operation failed since Managed Instance '{0}' is disabled. Please enable Managed Instance and try again.\n\n * 400 MiGeoRestoreWithWrongBackupStorageRedundancy - Geo-Restore is not allowed for managed instances with LRS/ZRS backup storage redundancy.\n\n * 400 LastBackupNameHasNewline - Please do not use forbidden characters ('\\n', '\\r') in lastBackupName.\n\n * 400 LastBackupNameHasNonAsciiCharacter - The operation was aborted because the 'LastBackupName' parameter contains invalid characters. Only ASCII characters are allowed.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled.\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 UpdatingInstanceAndBackupRedundancy - Instance zone redundancy and backup storage redundancy cannot be updated in the same request.\n\n * 400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled.\n\n * 400 RequestCantLandOnPaaSv2Platform - Request needs to land on PaaSv2 platform but PaaSv2 is not enabled.\n\n * 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.\n\n * 400 DeleteOfVersion2VirtualClusterIsDisabled - Delete of virtual cluster with version 2 is not enabled.\n\n * 400 DeleteOfVirtualClusterIsDisabled - Delete of virtual cluster is not enabled.\n\n * 400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool.\n\n * 400 DnsRefreshOnVirtualClusterIsDisabled - Refresh of DNS records on virtual cluster is not enabled.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 ManagedInstanceNotInSubscriptionResourceGroup - Specified managed instance does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 MiCreateFailedNonDelegatedSubnet - User tried to deploy Managed Instance or Managed Instance pool in subnet that is not delegated to Microsoft.Sql/managedInstances.\n\n * 409 ConflictingManagedInstanceOperation - An operation is currently in progress for the managed instance.\n\n * 409 BackupRedundancyUpdateAndInstanceRedundancyConflict - The instance is multi-az but backup storage is being updated from zone redundant to non-zone redundant.\n\n * 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress - Cannot update instance redundancy because backup storage redundancy update is in progress.\n\n * 409 InstanceRedundancyUpdateAndBackupRedundancyConflict - The backup storage is non-zone redundant but instance redundancy is being updated to zone redundant.\n\n * 409 BackupRedundancyUpdateConflict - Cannot update backup storage redundancy because a backup storage redundancy update is already in progress.\n\n * 409 MiDropFailedOnAuthLocks - User tried to drop last Managed Instance in subnet that has Lock applied on resource(s).\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 412 InstanceNotReadyForBackupRedundancyUpdate - Cannot update backup storage redundancy because the instance is not ready.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 SubnetMissingRequiredDelegation - Selected subnet is not delegated for SQL Managed Instance.\n\n * 400 ManagementServiceManagedServerDisabled - Operation failed since Managed Instance '{0}' is disabled. Please enable Managed Instance and try again.\n\n * 400 MiGeoRestoreWithWrongBackupStorageRedundancy - Geo-Restore is not allowed for managed instances with LRS/ZRS backup storage redundancy.\n\n * 400 LastBackupNameHasNewline - Please do not use forbidden characters ('\\n', '\\r') in lastBackupName.\n\n * 400 LastBackupNameHasNonAsciiCharacter - The operation was aborted because the 'LastBackupName' parameter contains invalid characters. Only ASCII characters are allowed.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 LRSCutoverDatabaseDoesNotExist - The operation was aborted because the database name specified in the request doesn't match any database name on the specified server.\n\n * 400 LRSCutoverDatabaseNotInRestoringState - The operation was aborted because the specified database is not in restoring state.\n\n * 400 LRSCutoverDatabaseAlreadyRestored - The operation was aborted because the specified database was already restored.\n\n * 400 LRSCutoverAlreadyInitiated - The operation was aborted because a cutover for the specified database is already in progress.\n\n * 400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled.\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 UpdatingInstanceAndBackupRedundancy - Instance zone redundancy and backup storage redundancy cannot be updated in the same request.\n\n * 400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled.\n\n * 400 RequestCantLandOnPaaSv2Platform - Request needs to land on PaaSv2 platform but PaaSv2 is not enabled.\n\n * 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.\n\n * 400 DeleteOfVersion2VirtualClusterIsDisabled - Delete of virtual cluster with version 2 is not enabled.\n\n * 400 DeleteOfVirtualClusterIsDisabled - Delete of virtual cluster is not enabled.\n\n * 400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool.\n\n * 400 DnsRefreshOnVirtualClusterIsDisabled - Refresh of DNS records on virtual cluster is not enabled.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 ManagedInstanceNotInSubscriptionResourceGroup - Specified managed instance does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 MiCreateFailedNonDelegatedSubnet - User tried to deploy Managed Instance or Managed Instance pool in subnet that is not delegated to Microsoft.Sql/managedInstances.\n\n * 409 ConflictingManagedInstanceOperation - An operation is currently in progress for the managed instance.\n\n * 409 BackupRedundancyUpdateAndInstanceRedundancyConflict - The instance is multi-az but backup storage is being updated from zone redundant to non-zone redundant.\n\n * 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress - Cannot update instance redundancy because backup storage redundancy update is in progress.\n\n * 409 InstanceRedundancyUpdateAndBackupRedundancyConflict - The backup storage is non-zone redundant but instance redundancy is being updated to zone redundant.\n\n * 409 BackupRedundancyUpdateConflict - Cannot update backup storage redundancy because a backup storage redundancy update is already in progress.\n\n * 409 MiDropFailedOnAuthLocks - User tried to drop last Managed Instance in subnet that has Lock applied on resource(s).\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 412 InstanceNotReadyForBackupRedundancyUpdate - Cannot update backup storage redundancy because the instance is not ready.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Successfully initiated deletion of the managed instance." + "description": "Successfully initiated deletion of the managed instance.", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "The specified managed instance does not exist." @@ -373,13 +383,18 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 SubnetMissingRequiredDelegation - Selected subnet is not delegated for SQL Managed Instance.\n\n * 400 InvalidDnsZone - The operation has failed because you are attempting to deploy managed instance as a geo-replication secondary to the subnet {0} in which there already exists a managed instance. Deploying managed instance as a geo-replication secondary is supported only in cases when managed instance is the first instance deployed in a subnet. Consider deploying managed instance as a geo-replication secondary to a different subnet in which there are no existing managed instances, or if deploying to a subnet with existing managed instance disable the geo-replication option.\n\n * 400 HkCannotSwitchToInactive - The database cannot proceed with pricing-tier update as it has memory-optimized objects. Please drop such objects and try again.\n\n * 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - Invalid storage size: Storage size limit ({0} GB) is less that current storage used ({1} GB). Please specify higher storage size limit.\n\n * 400 InstanceTimezoneUpdateNotSupported - Instance timezone update not supported.\n\n * 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - Create Managed Instance with non-default timezone not supported.\n\n * 400 ManagedInstanceIpAddressRangeLimit - Cannot perform creation/scaling of the managed instance as there are not enough available IP addresses in the subnet for performing the operation.\n\n * 400 VnetDelegationNotAllowed - User tried to inject Managed Server to subnet which is delegated.\n\n * 400 SubnetHasResourcesOfDifferentType - User tried to create MI in subnet that has resources of different type.\n\n * 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - Update of Managed Instance with maintenance window settings is not allowed.\n\n * 400 OperationNotAllowedInCurrentGeodrConfiguration - The operation is not allowed because the current geo-replication configuration does not allow this combination of {0}. Change the setting on the geo-replication partner before applying the change on this instance.\n\n * 400 VnetPrepareNIPFailed - User tried to prepare subnet that has a conflict with NetworkIntentPolicy.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 ManagedInstanceDeprecatedHardwareFamily - Changing the hardware generation to deprecated {0} generation is not possible.\n\n * 400 ManagedInstanceBackupStorageTypeNotSupported - Backup storage type parameter is not allowed in the instance update operation.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 EmptyPDCInvalidDnsZone - This managed instance cannot be deployed because its DNS-zone does not match the DNS-prefix of its intended virtual cluster for subnet {0}. Although this virtual cluster is empty, its DNS-prefix cannot be changed. Empty virtual clusters will be automatically removed after several hours. Consider waiting for this virtual cluster to expire or manually deleting this virtual cluster and then creating the managed instance.\n\n * 400 InstancePoolNotEnoughCapacity - An instance pool does not have enough capacity\n\n * 400 ManagedInstanceFreemiumNotAvailableForInputParameters - Managed instance creation or update executed with SLO that is not allowed for freemium.\n\n * 400 ManagedInstanceFreemiumNotAvailableOnRegion - Creation of a freemium managed instance on a region that is not allowlisted for freemium.\n\n * 400 ManagementServiceSubnetMaintenanceInProgress - User tried to initiate managed instance create/update while incompatible maintenance is in progress.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ManagedInstanceFreemiumNotAvailableForSubscription - Freemium is not enabled for this subscription type.\n\n * 400 ManagedInstanceInvalidEditionForInstancePool - User tried to select invalid service tier for managed instance inside an existing instance pool.\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 ManagedInstanceInvalidSubnetForInstancePool - User tried to select invalid subnet for managed instance inside an existing instance pool.\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 ManagedInstanceZoneRedudantFeatureNotSupported - ZoneRedundant feature is not supported for the selected service tier. For more details visit aka.ms/sqlmi-service-tier-characteristics.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - Enabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - Disabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SubnetIdCantBeUpdated - Changing managed instance subnet is not supported operation. Please remove this parameter from the request.\n\n * 400 MigrationToAnotherVNetNotSupported - Selected subnet is in another Virtual Network. Moving managed instance to another Virtual Network is not possible. Please provide subnet from Virtual Network {0}.\n\n * 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - Provided subnet is having different DNS zone from the current. Changing instance DNS zone is not supported. Please provide subnet with same DNS zone, create a new subnet or provide empty one.\n\n * 400 MigrationToGen4SubnetNotSupported - It is not possible to update subnet while running on Gen4 hardware as it is being deprecated. Please upgrade your hardware from Gen4 to Gen5 as part of the changing managed instance subnet operation by specifying both parameters at the same time: destination subnet and hardware generation.\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - The operation could not be completed because some of the database files are exceeding maximum General Purpose file size limit of {0} GB.\n\n * 400 CloudLifterUnsupportedFeature - The functionality is not available on the Managed Instance at this time.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 OperationCanNotStartDueToMiLink - The '{0}' operation cannot be completed as there exists a database in a process of creation through Managed Instance link. Please wait for the link creation to complete, or delete the link, and retry the operation again.\n\n * 400 ManagedInstanceSloUpdateFailed - SLO '{0}' operation cannot succeed as the memory usage of '{1}' exceeds the quota.\n\n * 400 SourceAndTargetSubnetsMustBeVnetPeered - Subnet currently used by managed instance and provided destination subnet are part of the virtual networks that are not connected with virtual network peering, or have peering established but don't have allowed traffic. In order to move managed instance from one subnet to another, virtual network peering needs to be established from both source and target virtual network. Please configure virtual network requirements and then try the operation again. Learn more https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks. \n\n * 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - Subnet provided for managed instance deployment is located on subscription different than the one submitted for managed instance. Managed instance and subnet used for deploying the instance must be on the same subscription. Please provide another subnet or switch to the subnet subscription and then try the operation again.\n\n * 400 CreateManagedInstanceInvalidSubnetSize - User attempted to create managed instance in a subnet that is smaller than the allowed minimal subnet size.\n\n * 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - Subnet selected for managed instance migration has address range that overlaps with address range of subnet that holds geo replicated secondary instance. Please verify that your subnet is configured according to guidelines in https://aka.ms/move-managed-instance. \n\n * 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - Subnet selected for managed instance migration is not configured to enable communication with a geo replicated secondary instance. Please check if all of the required ports are open. To properly configure your subnet read the guidelines in https://aka.ms/move-managed-instance. \n\n * 400 ManagedInstanceLocalStorageUpdateSloDisabled - Update SLO for managed instances with local storage is not supported yet.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 GatewayInvalidEdition - '{0}' is not a valid database edition in this version of SQL Server.\n\n * 400 ManagedInstanceInvalidHardwareFamilyForInstancePool - User tried to select invalid hardware family for managed instance inside an existing instance pool.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 ManagedInstanceInvalidLicenseTypeForInstancePool - User tried to select invalid license type for managed instance inside an existing instance pool.\n\n * 400 ManagedInstanceUpdateSloFromVersionlessToVersionedNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 ManagedInstanceUpdateSloFromNewerToOlderVersionEditionNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 ManagedInstanceUpdateSloFromVersionedToVersionlessWorkerCLNotAllowed - Changing the database format is not supported for this managed instance. Check the database format property value specified and visit https://aka.ms/sqlmi-fwnov2022 for more details.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 ManagedInstanceVersionEditionParameterNotAllowedForUsing - Specifying the database format property value is not supported at this time.\n\n * 400 ManagedInstanceFreemiumInvalidArchitecture - A freemium instance can not be created in the specified subnet '(0)'.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ManagedInstanceGeoDRNotAllowedForInstancePool - Creating auto-failover group (GeoDR) is not supported for Managed Instances provisioned inside instance pools. Auto failover groups can be created only for standalone Managed Instances.\n\n * 400 ManagedInstanceWithGeoDRMoveToInstancePoolNotAllowed - Customer has attempted to move a standalone Managed Instance with an existing auto-failover group configured into an instance pool, which is not supported. Only standalone instances without existing auto-failover groups configured can be moved to instance pools.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerRegion - Creation of ZoneRedundant SQL MI is temporarily disabled on this region. You can create Zone Redundant SQL Managed Instances in many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerHardwareGeneration - Creation of ZoneRedundant SQL MI is temporarily disabled for this hardware generation on this region. You can create Zone Redundant SQL Managed Instances with different hardware generation on this region or many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceUpdateSloGeoPrimaryWithNewerVersionEditionThanSecondary - Database format change must be performed on the secondary instance of the failover group first. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 ManagedInstanceFreemiumInstanceAlreadyExists - Only one free SQL Managed Instance is allowed per subscription.\n\n * 400 ManagementServiceGeodrSecondaryDatabaseInCreation - The '{0}' operation cannot be completed as there exists a database in a process of creation through failover group deployment. Please wait for the failover group deployment to complete, or alternatively delete the failover group and retry the operation again.\n\n * 400 ManagedInstanceConversionRegularToFreemiumNotAllowed - User tried converting a Regular SQL Managed Instance to Free SQL Managed Instance.\n\n * 400 ManagedInstanceConversionFreemiumToRegularAndUpdateSLOWhileStoppedNotAllowed - User tried converting a Free SQL Managed Instance to Regular SQL Managed Instance and Update SLO in same request, while Instance is stopped.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 ManagedInstanceMaintenanceWindowChangeNotAllowedWhenInInstancePool - Maintenance window is set at instance pool level and cannot be set individually per pooled instance.\n\n * 400 ManagedInstanceMoveToInstancePoolExceedsDbCountLimit - Cannot move the instance into the pool due to pool database count limit.\n\n * 400 StorageIOpsNotSupported - Storage IOps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidCollation - Invalid collation.\n\n * 400 StorageThroughputMBpsNotSupported - Storage throughput MBps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 StorageIOpsNotSupportedForSpecifiedEdition - Storage IOps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 StorageThroughputMBpsNotSupportedForSpecifiedEdition - Storage throughput MBps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 ManagedInstanceClassicVnetNotSupported - Managed Instance cannot be joined to a classic virtual network.\n\n * 400 AlterDbDeactivatedNotSupported - Database Operation failed for Server '{0}', Database '{1}' due to unexpected delay. Please try again.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetConfigHasNsg - User tried to inject Managed Server subnet with Network Security Groups.\n\n * 400 VnetConfigHasNoUdr - User tried to inject Managed Server subnet without default User Defined Route Table.\n\n * 400 VnetConfigHasInvalidUdr - User tried to inject Managed Server subnet with invalid User Defined Route Table.\n\n * 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.\n\n * 400 VnetConfigHasServiceEndpoints - User tried to inject Managed Server subnet with service endpoints.\n\n * 400 VnetSubnetIsInUse - User tried to inject Managed Server subnet that is not empty.\n\n * 400 VnetSubnetIsLocked - User tried to inject Managed Server subnet that is in locked scope.\n\n * 400 VnetSubnetIsGateway - User tried to inject Managed Server subnet that is Gateway subnet.\n\n * 400 VnetSubnetIsUnknown - User tried to inject Managed Server subnet that does not exist.\n\n * 400 VnetSubnetConflictWithIntendedPolicy - User tried to inject Managed Server subnet that has a conflict with IntendedPolicy.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 ManagedInstanceInvalidEditionForSku - The specified edition {0} is not consistent with the specified SKU {1}.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInCreateOfMI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the create operation.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagedInstanceInvalidLicenseType - The specified license type {0} is not valid.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInUpdateOfGPV1MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V1 Managed Instance.\n\n * 400 UnspecifiedTargetEditionAndFalseGPV2NotAllowedInUpdateOfGPV2MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value FALSE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 GPTargetEditionAndUnspecifiedGPV2NotAllowedInUpdateOFGPV2MI - Combination of General Purpose target edition (sku.name/sku.tier parameters) and unspecified value for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 BCTargetEditionAndSpecifiedGPV2ParamNotAllowedInCreateUpdateOfMI - Combination of Business Critical target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the create/update operation.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 UnspecifiedTargetEditionAndSpecifiedGPV2ParamNotAllowedInUpdateOfBCMI - Combination of unspecified target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the update operation of Business Critical Managed Instance.\n\n * 400 TotalMemoryMBNotSupported - Total memory MB parameter is not allowed in the instance create/update operation.\n\n * 400 TotalMemoryMBNotSupportedForSpecifiedEdition - Total memory MB parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 VnetResourceNotFound - Resource not found: '{0}'.\n\n * 400 InvalidTimezone - Invalid timezone.\n\n * 400 InvalidSubnetForGPV2Edition - General Purpose v2 edition of Managed Instance is not compatible with the specified subnet. Target subnet must be either empty, or all instances in it must run with November 2022 Feature Wave.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 TotalMemoryMBInvalidLimit - Total memory MB parameter has been set to an invalid limit.\n\n * 400 ManagedInstanceUpdateSloGPv2PerDatabaseFileLimitExceeded - The operation could not be completed because there is at least one database whose number of files is exceeding the limit of {0} files per database on General Purpose v2 edition.\n\n * 400 InstanceCollationUpdateNotSupported - User cannot change instance collation on Managed Instance.\n\n * 400 NextGenGPNotSupportedForCmwCustomers - Next-Gen General Purpose edition of Managed Instance does not support Custom Maintenance Window.\n\n * 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - User can create a Managed Instance only with collation 'SQL_Latin1_General_CP1_CI_AS'.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedInstanceExceedMaxAzureStorage - The operation could not be completed because total allocated storage size for General Purpose instance would exceed {0}. Please reduce the number of database files and retry operation.\n\n * 400 ManagedInstanceHasGeoReplica - The operation could not be completed because instance has configured geo replicated secondary instance.\n\n * 400 ManagementServiceManagedServerDisabled - Operation failed since Managed Instance '{0}' is disabled. Please enable Managed Instance and try again.\n\n * 400 MiGeoRestoreWithWrongBackupStorageRedundancy - Geo-Restore is not allowed for managed instances with LRS/ZRS backup storage redundancy.\n\n * 400 LastBackupNameHasNewline - Please do not use forbidden characters ('\\n', '\\r') in lastBackupName.\n\n * 400 LastBackupNameHasNonAsciiCharacter - The operation was aborted because the 'LastBackupName' parameter contains invalid characters. Only ASCII characters are allowed.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled.\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 UpdatingInstanceAndBackupRedundancy - Instance zone redundancy and backup storage redundancy cannot be updated in the same request.\n\n * 400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled.\n\n * 400 RequestCantLandOnPaaSv2Platform - Request needs to land on PaaSv2 platform but PaaSv2 is not enabled.\n\n * 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.\n\n * 400 DeleteOfVersion2VirtualClusterIsDisabled - Delete of virtual cluster with version 2 is not enabled.\n\n * 400 DeleteOfVirtualClusterIsDisabled - Delete of virtual cluster is not enabled.\n\n * 400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool.\n\n * 400 DnsRefreshOnVirtualClusterIsDisabled - Refresh of DNS records on virtual cluster is not enabled.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidMinimalTlsVersion - Invalid minimal TLS version.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled.\n\n * 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.\n\n * 400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool.\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidExternalAdministratorLogin - Invalid or missing external administrator login name.\n\n * 400 InvalidExternalAdministratorSid - Invalid or missing external administrator object id.\n\n * 400 InvalidExternalAdministratorTenantId - Invalid or missing external administrator tenant id.\n\n * 400 ExternalAdministratorPrincipalType - Invalid or missing external administrator principal type. Please select from User, Application or Group.\n\n * 400 MissingExternalAdministratorWithAadOnlyAuth - In order to use Azure AD Only Authentication, please provide details of an external administrator.\n\n * 400 ExternalAdministratorLoginSameAsSqlAdmin - The names of the Azure Active Directory administrator and of the server admin account must be different. Please provide different values.\n\n * 400 InvalidMaintenanceWindowSettings - Invalid maintenance window settings.\n\n * 400 InvalidMaintenanceWindowProperty - Invalid maintenance window property was specified.\n\n * 400 InvalidMaintenanceWindowPropertyNull - Invalid maintenance window with required properties null.\n\n * 400 InvalidMaintenanceWindowTypeWithPropertySpecified - Maintenance window type must not have certain properties specified.\n\n * 400 UpdateOfParameterNotSupported - Update of '{0}' is not supported.\n\n * 400 MaintenancePolicyInvalidDayOfWeek - The provided value for dayOfWeek is not valid. Please use one of the following values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.\n\n * 400 MaintenancePolicyFeatureIsDisabled - Assigning customer maintenance policy is not enabled for provided subscription. Please use maintenanceConfigurationId property instead.\n\n * 400 MaintenancePolicyInvalidType - The provided value for w type is not valid. Please use one of the following values: SystemDefined, CustomerDefined.\n\n * 400 MaintenancePolicyInvalidMaintenanceConfigurationId - The provided value for maintenanceConfigurationId is not valid. Please check Public Maintenance Configuration list to get the list of available configurations.\n\n * 400 MaintenancePolicyInvalidStartHour - The provided value for startHour is not valid. Start time represents the hour of the day when maintenance event should start. Accepted values are 00-23. Please retry with appropriate value.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 MissingKeyVaultUriForRestore - Azure Key Vault key URI '{0}' is required to successfully restore the database '{1}' under server '{2}'.\n\n * 400 AzureKeyVaultKeyUsedOnGeoPrimary - The operation could not be completed because the Azure Key Vault Key name {0} is currently set as encryption protector on geo-primary.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 SecurityAzureKeyVaultGeoChainError - Creating secondary of secondary (a process known as chaining) is not supported when enabling Transparent Data Encryption using Azure Key Vault (BYOK).\n\n * 400 PerDatabaseCMKDWNotSupported - Database-level CMK in preview is not supported for Datawarehouse edition.\n\n * 400 BlockSystemAssignedIdentityForCrossTenantCMK - Cross tenant CMK can only be configured when the server is configured with a User Assigned Managed Identity. Refer to https://aka.ms/sqltdebyokumi to configure User Assigned Managed Identity.\n\n * 400 CannotDropDatabaseAKVError - The database {0} on server {1} cannot be safely dropped because it is encrypted with a customer managed key that is no longer accessible to take the last backup before drop. Please restore Azure Key Vault Access on the server and revalidate the keys to make this database accessible and then proceed with the drop. For details see https://aka.ms/tdecmkrestorability\n\n * 400 CreateDatabaseAttemptedWithRotationInProgress - The create database operation can not be performed at this time due to ongoing Transparent Data Encryption (TDE) key rotation on the server. Please try the operation again later.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 PerDatabaseCMKRestoreNotSupported - Database restore is not supported when Database-level CMK is configured in preview.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 PerDatabaseCMKHSNotSupported - Database-level CMK in preview is not supported for Hyperscale edition.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 CMKOperationNotAllowed - User tried to perform an operation on the server when the server did not have Azure Key Vault Access.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 AzureKeyVaultKeyNameCurrentlyInUse - The operation could not be completed because the Azure Key Vault Key name {0} is currently in use.\n\n * 400 AzureKeyVaultKeyThumbprintIsDifferent - The operation could not be completed because the Azure Key Vault Key material is different than the current encryption protector key.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 OldGenerationOfAKVKeyBeingUsedError - Using an old version of AKV key as TDE protector is not allowed. Please use the latest version of the AKV key as the encryption protector\n\n * 400 PerDatabaseCMKMissingIdentityOnGeoSecondaryDatabase - Per Database CMK identity not setup on the target database.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 ManagedInstanceNotInSubscriptionResourceGroup - Specified managed instance does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 405 InvalidStorageIOpsLimitValue - Invalid storage IOps limit: {0} IOps. Storage IOps limit must be specified between {1} IOps and {2} IOps, in increments of {3} IOps.\n\n * 405 InvalidStorageThroughputMBpsLimitValue - Invalid storage throughput limit: {0} MBps. Storage throughput limit must be specified between {1} MBps and {2} MBps, in increments of {3} MBps.\n\n * 405 InvalidVcoreValue - vCore value {0} is not valid. Please specify a valid vCore value.\n\n * 405 InvalidHardwareGenerationValue - HardwareGeneration {0} is not valid. Please specify a valid HardwareGeneration value.\n\n * 405 InvalidStorageSizeValue - \"Invalid storage size: {0} GB. Storage size must be specified between {1} and {2} gigabytes, in increments of {3} GB.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 409 ServerOverridePreconditionFailed - Failed to apply server override on category '{0}', because physical db or instance '{1}' in server '{2}' is currently not in 'Ready' or 'Deactivated' state.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ManagedInstanceIsBusy - The server '{0}' is currently busy. Please wait a few minutes before trying again.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 409 MiCreateFailedNonDelegatedSubnet - User tried to deploy Managed Instance or Managed Instance pool in subnet that is not delegated to Microsoft.Sql/managedInstances.\n\n * 409 ConflictingManagedInstanceOperation - An operation is currently in progress for the managed instance.\n\n * 409 BackupRedundancyUpdateAndInstanceRedundancyConflict - The instance is multi-az but backup storage is being updated from zone redundant to non-zone redundant.\n\n * 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress - Cannot update instance redundancy because backup storage redundancy update is in progress.\n\n * 409 InstanceRedundancyUpdateAndBackupRedundancyConflict - The backup storage is non-zone redundant but instance redundancy is being updated to zone redundant.\n\n * 409 BackupRedundancyUpdateConflict - Cannot update backup storage redundancy because a backup storage redundancy update is already in progress.\n\n * 409 MiDropFailedOnAuthLocks - User tried to drop last Managed Instance in subnet that has Lock applied on resource(s).\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 412 InstanceNotReadyForBackupRedundancyUpdate - Cannot update backup storage redundancy because the instance is not ready.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 GatewayInternalServerError - The server encountered an unexpected exception.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 SubnetMissingRequiredDelegation - Selected subnet is not delegated for SQL Managed Instance.\n\n * 400 InvalidDnsZone - The operation has failed because you are attempting to deploy managed instance as a geo-replication secondary to the subnet {0} in which there already exists a managed instance. Deploying managed instance as a geo-replication secondary is supported only in cases when managed instance is the first instance deployed in a subnet. Consider deploying managed instance as a geo-replication secondary to a different subnet in which there are no existing managed instances, or if deploying to a subnet with existing managed instance disable the geo-replication option.\n\n * 400 HkCannotSwitchToInactive - The database cannot proceed with pricing-tier update as it has memory-optimized objects. Please drop such objects and try again.\n\n * 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - Invalid storage size: Storage size limit ({0} GB) is less that current storage used ({1} GB). Please specify higher storage size limit.\n\n * 400 InstanceTimezoneUpdateNotSupported - Instance timezone update not supported.\n\n * 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - Create Managed Instance with non-default timezone not supported.\n\n * 400 ManagedInstanceIpAddressRangeLimit - Cannot perform creation/scaling of the managed instance as there are not enough available IP addresses in the subnet for performing the operation.\n\n * 400 VnetDelegationNotAllowed - User tried to inject Managed Server to subnet which is delegated.\n\n * 400 SubnetHasResourcesOfDifferentType - User tried to create MI in subnet that has resources of different type.\n\n * 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - Update of Managed Instance with maintenance window settings is not allowed.\n\n * 400 OperationNotAllowedInCurrentGeodrConfiguration - The operation is not allowed because the current geo-replication configuration does not allow this combination of {0}. Change the setting on the geo-replication partner before applying the change on this instance.\n\n * 400 VnetPrepareNIPFailed - User tried to prepare subnet that has a conflict with NetworkIntentPolicy.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 ManagedInstanceDeprecatedHardwareFamily - Changing the hardware generation to deprecated {0} generation is not possible.\n\n * 400 ManagedInstanceBackupStorageTypeNotSupported - Backup storage type parameter is not allowed in the instance update operation.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 EmptyPDCInvalidDnsZone - This managed instance cannot be deployed because its DNS-zone does not match the DNS-prefix of its intended virtual cluster for subnet {0}. Although this virtual cluster is empty, its DNS-prefix cannot be changed. Empty virtual clusters will be automatically removed after several hours. Consider waiting for this virtual cluster to expire or manually deleting this virtual cluster and then creating the managed instance.\n\n * 400 InstancePoolNotEnoughCapacity - An instance pool does not have enough capacity\n\n * 400 ManagedInstanceFreemiumNotAvailableForInputParameters - Managed instance creation or update executed with SLO that is not allowed for freemium.\n\n * 400 ManagedInstanceFreemiumNotAvailableOnRegion - Creation of a freemium managed instance on a region that is not allowlisted for freemium.\n\n * 400 ManagementServiceSubnetMaintenanceInProgress - User tried to initiate managed instance create/update while incompatible maintenance is in progress.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ManagedInstanceFreemiumNotAvailableForSubscription - Freemium is not enabled for this subscription type.\n\n * 400 ManagedInstanceInvalidEditionForInstancePool - User tried to select invalid service tier for managed instance inside an existing instance pool.\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 ManagedInstanceInvalidSubnetForInstancePool - User tried to select invalid subnet for managed instance inside an existing instance pool.\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 ManagedInstanceZoneRedudantFeatureNotSupported - ZoneRedundant feature is not supported for the selected service tier. For more details visit aka.ms/sqlmi-service-tier-characteristics.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - Enabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - Disabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SubnetIdCantBeUpdated - Changing managed instance subnet is not supported operation. Please remove this parameter from the request.\n\n * 400 MigrationToAnotherVNetNotSupported - Selected subnet is in another Virtual Network. Moving managed instance to another Virtual Network is not possible. Please provide subnet from Virtual Network {0}.\n\n * 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - Provided subnet is having different DNS zone from the current. Changing instance DNS zone is not supported. Please provide subnet with same DNS zone, create a new subnet or provide empty one.\n\n * 400 MigrationToGen4SubnetNotSupported - It is not possible to update subnet while running on Gen4 hardware as it is being deprecated. Please upgrade your hardware from Gen4 to Gen5 as part of the changing managed instance subnet operation by specifying both parameters at the same time: destination subnet and hardware generation.\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - The operation could not be completed because some of the database files are exceeding maximum General Purpose file size limit of {0} GB.\n\n * 400 CloudLifterUnsupportedFeature - The functionality is not available on the Managed Instance at this time.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 OperationCanNotStartDueToMiLink - The '{0}' operation cannot be completed as there exists a database in a process of creation through Managed Instance link. Please wait for the link creation to complete, or delete the link, and retry the operation again.\n\n * 400 ManagedInstanceSloUpdateFailed - SLO '{0}' operation cannot succeed as the memory usage of '{1}' exceeds the quota.\n\n * 400 SourceAndTargetSubnetsMustBeVnetPeered - Subnet currently used by managed instance and provided destination subnet are part of the virtual networks that are not connected with virtual network peering, or have peering established but don't have allowed traffic. In order to move managed instance from one subnet to another, virtual network peering needs to be established from both source and target virtual network. Please configure virtual network requirements and then try the operation again. Learn more https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks. \n\n * 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - Subnet provided for managed instance deployment is located on subscription different than the one submitted for managed instance. Managed instance and subnet used for deploying the instance must be on the same subscription. Please provide another subnet or switch to the subnet subscription and then try the operation again.\n\n * 400 CreateManagedInstanceInvalidSubnetSize - User attempted to create managed instance in a subnet that is smaller than the allowed minimal subnet size.\n\n * 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - Subnet selected for managed instance migration has address range that overlaps with address range of subnet that holds geo replicated secondary instance. Please verify that your subnet is configured according to guidelines in https://aka.ms/move-managed-instance. \n\n * 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - Subnet selected for managed instance migration is not configured to enable communication with a geo replicated secondary instance. Please check if all of the required ports are open. To properly configure your subnet read the guidelines in https://aka.ms/move-managed-instance. \n\n * 400 ManagedInstanceLocalStorageUpdateSloDisabled - Update SLO for managed instances with local storage is not supported yet.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 GatewayInvalidEdition - '{0}' is not a valid database edition in this version of SQL Server.\n\n * 400 ManagedInstanceInvalidHardwareFamilyForInstancePool - User tried to select invalid hardware family for managed instance inside an existing instance pool.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 ManagedInstanceInvalidLicenseTypeForInstancePool - User tried to select invalid license type for managed instance inside an existing instance pool.\n\n * 400 ManagedInstanceUpdateSloFromVersionlessToVersionedNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 ManagedInstanceUpdateSloFromNewerToOlderVersionEditionNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 ManagedInstanceUpdateSloFromVersionedToVersionlessWorkerCLNotAllowed - Changing the database format is not supported for this managed instance. Check the database format property value specified and visit https://aka.ms/sqlmi-fwnov2022 for more details.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 ManagedInstanceVersionEditionParameterNotAllowedForUsing - Specifying the database format property value is not supported at this time.\n\n * 400 ManagedInstanceFreemiumInvalidArchitecture - A freemium instance can not be created in the specified subnet '(0)'.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ManagedInstanceWithGeoDRMoveToInstancePoolNotAllowed - Customer has attempted to move a standalone Managed Instance with an existing auto-failover group configured into an instance pool, which is not supported. Only standalone instances without existing auto-failover groups configured can be moved to instance pools.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerRegion - Creation of ZoneRedundant SQL MI is temporarily disabled on this region. You can create Zone Redundant SQL Managed Instances in many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerHardwareGeneration - Creation of ZoneRedundant SQL MI is temporarily disabled for this hardware generation on this region. You can create Zone Redundant SQL Managed Instances with different hardware generation on this region or many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceUpdateSloGeoPrimaryWithNewerVersionEditionThanSecondary - Database format change must be performed on the secondary instance of the failover group first. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 ManagedInstanceFreemiumInstanceAlreadyExists - Only one free SQL Managed Instance is allowed per subscription.\n\n * 400 ManagementServiceGeodrSecondaryDatabaseInCreation - The '{0}' operation cannot be completed as there exists a database in a process of creation through failover group deployment. Please wait for the failover group deployment to complete, or alternatively delete the failover group and retry the operation again.\n\n * 400 ManagedInstanceConversionRegularToFreemiumNotAllowed - User tried converting a Regular SQL Managed Instance to Free SQL Managed Instance.\n\n * 400 ManagedInstanceConversionFreemiumToRegularAndUpdateSLOWhileStoppedNotAllowed - User tried converting a Free SQL Managed Instance to Regular SQL Managed Instance and Update SLO in same request, while Instance is stopped.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 ManagedInstanceMaintenanceWindowChangeNotAllowedWhenInInstancePool - Maintenance window is set at instance pool level and cannot be set individually per pooled instance.\n\n * 400 ManagedInstanceMoveToInstancePoolExceedsDbCountLimit - Cannot move the instance into the pool due to pool database count limit.\n\n * 400 ManagedInstancePoolZoneRedundancyNotSupported - Cannot move a zone-redundant instance into the pool as zone-redundancy is not supported in pools.\n\n * 400 DeploymentIntoPrivateSubnetsNotAllowed - Deploying managed instances and instance pools into private subnets is not supported.\n\n * 400 StorageIOpsNotSupported - Storage IOps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidCollation - Invalid collation.\n\n * 400 StorageThroughputMBpsNotSupported - Storage throughput MBps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 StorageIOpsNotSupportedForSpecifiedEdition - Storage IOps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 StorageThroughputMBpsNotSupportedForSpecifiedEdition - Storage throughput MBps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 ManagedInstanceClassicVnetNotSupported - Managed Instance cannot be joined to a classic virtual network.\n\n * 400 AlterDbDeactivatedNotSupported - Database Operation failed for Server '{0}', Database '{1}' due to unexpected delay. Please try again.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetConfigHasNsg - User tried to inject Managed Server subnet with Network Security Groups.\n\n * 400 VnetConfigHasNoUdr - User tried to inject Managed Server subnet without default User Defined Route Table.\n\n * 400 VnetConfigHasInvalidUdr - User tried to inject Managed Server subnet with invalid User Defined Route Table.\n\n * 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.\n\n * 400 VnetConfigHasServiceEndpoints - User tried to inject Managed Server subnet with service endpoints.\n\n * 400 VnetSubnetIsInUse - User tried to inject Managed Server subnet that is not empty.\n\n * 400 VnetSubnetIsLocked - User tried to inject Managed Server subnet that is in locked scope.\n\n * 400 VnetSubnetIsGateway - User tried to inject Managed Server subnet that is Gateway subnet.\n\n * 400 VnetSubnetIsUnknown - User tried to inject Managed Server subnet that does not exist.\n\n * 400 VnetSubnetConflictWithIntendedPolicy - User tried to inject Managed Server subnet that has a conflict with IntendedPolicy.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 ManagedInstanceInvalidEditionForSku - The specified edition {0} is not consistent with the specified SKU {1}.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInCreateOfMI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the create operation.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagedInstanceInvalidLicenseType - The specified license type {0} is not valid.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInUpdateOfGPV1MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V1 Managed Instance.\n\n * 400 UnspecifiedTargetEditionAndFalseGPV2NotAllowedInUpdateOfGPV2MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value FALSE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 GPTargetEditionAndUnspecifiedGPV2NotAllowedInUpdateOFGPV2MI - Combination of General Purpose target edition (sku.name/sku.tier parameters) and unspecified value for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 BCTargetEditionAndSpecifiedGPV2ParamNotAllowedInCreateUpdateOfMI - Combination of Business Critical target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the create/update operation.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 UnspecifiedTargetEditionAndSpecifiedGPV2ParamNotAllowedInUpdateOfBCMI - Combination of unspecified target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the update operation of Business Critical Managed Instance.\n\n * 400 TotalMemoryMBNotSupported - Total memory MB parameter is not allowed in the instance create/update operation.\n\n * 400 TotalMemoryMBNotSupportedForSpecifiedEdition - Total memory MB parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 VnetResourceNotFound - Resource not found: '{0}'.\n\n * 400 InvalidTimezone - Invalid timezone.\n\n * 400 InvalidSubnetForGPV2Edition - General Purpose v2 edition of Managed Instance is not compatible with the specified subnet. Target subnet must be either empty, or all instances in it must run with November 2022 Feature Wave.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 TotalMemoryMBInvalidLimit - Total memory MB parameter has been set to an invalid limit.\n\n * 400 ManagedInstanceUpdateSloGPv2PerDatabaseFileLimitExceeded - The operation could not be completed because there is at least one database whose number of files is exceeding the limit of {0} files per database on General Purpose v2 edition.\n\n * 400 InstanceCollationUpdateNotSupported - User cannot change instance collation on Managed Instance.\n\n * 400 NextGenGPNotSupportedForCmwCustomers - Next-Gen General Purpose edition of Managed Instance does not support Custom Maintance Window.\n\n * 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - User can create a Managed Instance only with collation 'SQL_Latin1_General_CP1_CI_AS'.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedInstanceExceedMaxAzureStorage - The operation could not be completed because total allocated storage size for General Purpose instance would exceed {0}. Please reduce the number of database files and retry operation.\n\n * 400 ManagedInstanceHasGeoReplica - The operation could not be completed because instance has configured geo replicated secondary instance.\n\n * 400 ManagementServiceManagedServerDisabled - Operation failed since Managed Instance '{0}' is disabled. Please enable Managed Instance and try again.\n\n * 400 MiGeoRestoreWithWrongBackupStorageRedundancy - Geo-Restore is not allowed for managed instances with LRS/ZRS backup storage redundancy.\n\n * 400 LastBackupNameHasNewline - Please do not use forbidden characters ('\\n', '\\r') in lastBackupName.\n\n * 400 LastBackupNameHasNonAsciiCharacter - The operation was aborted because the 'LastBackupName' parameter contains invalid characters. Only ASCII characters are allowed.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 LRSCutoverDatabaseDoesNotExist - The operation was aborted because the database name specified in the request doesn't match any database name on the specified server.\n\n * 400 LRSCutoverDatabaseNotInRestoringState - The operation was aborted because the specified database is not in restoring state.\n\n * 400 LRSCutoverDatabaseAlreadyRestored - The operation was aborted because the specified database was already restored.\n\n * 400 LRSCutoverAlreadyInitiated - The operation was aborted because a cutover for the specified database is already in progress.\n\n * 400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled.\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 UpdatingInstanceAndBackupRedundancy - Instance zone redundancy and backup storage redundancy cannot be updated in the same request.\n\n * 400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled.\n\n * 400 RequestCantLandOnPaaSv2Platform - Request needs to land on PaaSv2 platform but PaaSv2 is not enabled.\n\n * 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.\n\n * 400 DeleteOfVersion2VirtualClusterIsDisabled - Delete of virtual cluster with version 2 is not enabled.\n\n * 400 DeleteOfVirtualClusterIsDisabled - Delete of virtual cluster is not enabled.\n\n * 400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool.\n\n * 400 DnsRefreshOnVirtualClusterIsDisabled - Refresh of DNS records on virtual cluster is not enabled.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidMinimalTlsVersion - Invalid minimal TLS version.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled.\n\n * 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.\n\n * 400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool.\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidExternalAdministratorLogin - Invalid or missing external administrator login name.\n\n * 400 InvalidExternalAdministratorSid - Invalid or missing external administrator object id.\n\n * 400 InvalidExternalAdministratorTenantId - Invalid or missing external administrator tenant id.\n\n * 400 ExternalAdministratorPrincipalType - Invalid or missing external administrator principal type. Please select from User, Application or Group.\n\n * 400 MissingExternalAdministratorWithAadOnlyAuth - In order to use Azure AD Only Authentication, please provide details of an external administrator.\n\n * 400 ExternalAdministratorLoginSameAsSqlAdmin - The names of the Azure Active Directory administrator and of the server admin account must be different. Please provide different values.\n\n * 400 InvalidMaintenanceWindowSettings - Invalid maintenance window settings.\n\n * 400 InvalidMaintenanceWindowProperty - Invalid maintenance window property was specified.\n\n * 400 InvalidMaintenanceWindowPropertyNull - Invalid maintenance window with required properties null.\n\n * 400 InvalidMaintenanceWindowTypeWithPropertySpecified - Maintenance window type must not have certain properties specified.\n\n * 400 UpdateOfParameterNotSupported - Update of '{0}' is not supported.\n\n * 400 MaintenancePolicyInvalidDayOfWeek - The provided value for dayOfWeek is not valid. Please use one of the following values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.\n\n * 400 MaintenancePolicyFeatureIsDisabled - Assigning customer maintenance policy is not enabled for provided subscription. Please use maintenanceConfigurationId property instead.\n\n * 400 MaintenancePolicyInvalidType - The provided value for w type is not valid. Please use one of the following values: SystemDefined, CustomerDefined.\n\n * 400 MaintenancePolicyInvalidMaintenanceConfigurationId - The provided value for maintenanceConfigurationId is not valid. Please check Public Maintenance Configuration list to get the list of available configurations.\n\n * 400 MaintenancePolicyInvalidStartHour - The provided value for startHour is not valid. Start time represents the hour of the day when maintenance event should start. Accepted values are 00-23. Please retry with appropriate value.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 AkvHostNotResolvingFromNode - AKV host '{0}' is not resolvable from SQL, on server '{1}'.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 MissingKeyVaultUriForRestore - Azure Key Vault key URI '{0}' is required to successfully restore the database '{1}' under server '{2}'.\n\n * 400 AzureKeyVaultKeyUsedOnGeoPrimary - The operation could not be completed because the Azure Key Vault Key name {0} is currently set as encryption protector on geo-primary.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SameKeyUriNotFoundOnRemoteServer - Secondary server does not have the key material from the same key vault as the primary server's encryption protector with key auto-rotation enabled.\n\n * 400 SameKeyMaterialNotFoundOnRemoteServer - Secondary server does not have the key material of the primary server's encryption protector.\n\n * 400 SecurityAzureKeyVaultGeoChainError - Creating secondary of secondary (a process known as chaining) is not supported when enabling Transparent Data Encryption using Azure Key Vault (BYOK).\n\n * 400 PerDatabaseCMKDWNotSupported - Database-level CMK in preview is not supported for Datawarehouse edition.\n\n * 400 BlockSystemAssignedIdentityForCrossTenantCMK - Cross tenant CMK can only be configured when the server is configured with a User Assigned Managed Identity. Refer to https://aka.ms/sqltdebyokumi to configure User Assigned Managed Identity.\n\n * 400 CannotDropDatabaseAKVError - The database {0} on server {1} cannot be safely dropped because it is encrypted with a customer managed key that is no longer accessible to take the last backup before drop. Please restore Azure Key Vault Access on the server and revalidate the keys to make this database accessible and then proceed with the drop. For details see https://aka.ms/tdecmkrestorability\n\n * 400 CreateDatabaseAttemptedWithRotationInProgress - The create database operation can not be performed at this time due to ongoing Transparent Data Encryption (TDE) key rotation on the server. Please try the operation again later.\n\n * 400 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 400 PerDatabaseCMKRestoreNotSupported - Database restore is not supported when Database-level CMK is configured in preview.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 PerDatabaseCMKHSNotSupported - Database-level CMK in preview is not supported for Hyperscale edition.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 CMKOperationNotAllowed - User tried to perform an operation on the server when the server did not have Azure Key Vault Access.\n\n * 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' is not reachable from SQL, on server '{1}'.\n\n * 400 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 400 AzureKeyVaultKeyNameCurrentlyInUse - The operation could not be completed because the Azure Key Vault Key name {0} is currently in use.\n\n * 400 AzureKeyVaultKeyThumbprintIsDifferent - The operation could not be completed because the Azure Key Vault Key material is different than the current encryption protector key.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 OldGenerationOfAKVKeyBeingUsedError - Using an old version of AKV key as TDE protector is not allowed. Please use the latest version of the AKV key as the encryption protector\n\n * 400 PerDatabaseCMKMissingIdentityOnGeoSecondaryDatabase - Per Database CMK identity not setup on the target database.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 400 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 ManagedInstanceNotInSubscriptionResourceGroup - Specified managed instance does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 405 InvalidStorageIOpsLimitValue - Invalid storage IOps limit: {0} IOps. Storage IOps limit must be specified between {1} IOps and {2} IOps, in increments of {3} IOps.\n\n * 405 InvalidStorageThroughputMBpsLimitValue - Invalid storage throughput limit: {0} MBps. Storage throughput limit must be specified between {1} MBps and {2} MBps, in increments of {3} MBps.\n\n * 405 InvalidVcoreValue - vCore value {0} is not valid. Please specify a valid vCore value.\n\n * 405 InvalidHardwareGenerationValue - HardwareGeneration {0} is not valid. Please specify a valid HardwareGeneration value.\n\n * 405 InvalidStorageSizeValue - \"Invalid storage size: {0} GB. Storage size must be specified between {1} and {2} gigabytes, in increments of {3} GB.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 409 ServerOverridePreconditionFailed - Failed to apply server override on category '{0}', because physical db or instance '{1}' in server '{2}' is currently not in 'Ready' or 'Deactivated' state.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ManagedInstanceIsBusy - The server '{0}' is currently busy. Please wait a few minutes before trying again.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 409 MiCreateFailedNonDelegatedSubnet - User tried to deploy Managed Instance or Managed Instance pool in subnet that is not delegated to Microsoft.Sql/managedInstances.\n\n * 409 ConflictingManagedInstanceOperation - An operation is currently in progress for the managed instance.\n\n * 409 BackupRedundancyUpdateAndInstanceRedundancyConflict - The instance is multi-az but backup storage is being updated from zone redundant to non-zone redundant.\n\n * 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress - Cannot update instance redundancy because backup storage redundancy update is in progress.\n\n * 409 InstanceRedundancyUpdateAndBackupRedundancyConflict - The backup storage is non-zone redundant but instance redundancy is being updated to zone redundant.\n\n * 409 BackupRedundancyUpdateConflict - Cannot update backup storage redundancy because a backup storage redundancy update is already in progress.\n\n * 409 MiDropFailedOnAuthLocks - User tried to drop last Managed Instance in subnet that has Lock applied on resource(s).\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 412 InstanceNotReadyForBackupRedundancyUpdate - Cannot update backup storage redundancy because the instance is not ready.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 GatewayInternalServerError - The server encountered an unexpected exception.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -447,7 +462,12 @@ } }, "202": { - "description": "Managed instance failover is in progress." + "description": "Managed instance failover is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -538,7 +558,12 @@ } }, "202": { - "description": "Refreshing external governance enablement status." + "description": "Refreshing external governance enablement status.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -587,7 +612,12 @@ } }, "202": { - "description": "Starting the managed instance is in progress." + "description": "Starting the managed instance is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -636,7 +666,12 @@ } }, "202": { - "description": "Stopping the managed instance is in progress." + "description": "Stopping the managed instance is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedLedgerDigestUploads.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedLedgerDigestUploads.json index bd0f5da2e113..84dc1ff48dd3 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedLedgerDigestUploads.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedLedgerDigestUploads.json @@ -48,7 +48,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage or Azure Confidential Ledger endpoint.\n\n * 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI.\n\n * 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Please use the key name “current”.\n\n * 404 ResourceNotFound - The requested resource was not found.", + "description": "*** Error Responses: ***\n\n * 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage or Azure Confidential Ledger endpoint.\n\n * 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI.\n\n * 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Use the key name “current”.\n\n * 404 ResourceNotFound - The requested resource was not found.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -109,7 +109,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage or Azure Confidential Ledger endpoint.\n\n * 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI.\n\n * 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Please use the key name “current”.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.", + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage or Azure Confidential Ledger endpoint.\n\n * 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI.\n\n * 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Use the key name “current”.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -175,13 +175,18 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage or Azure Confidential Ledger endpoint.\n\n * 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI.\n\n * 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Please use the key name “current”.\n\n * 400 InvalidStorageAccountName - The specified storage account is not valid or does not exist.\n\n * 400 InvalidOperationOnNamedReplicas - The ledger digest storage cannot be configured on a named replica.\n\n * 400 NoServerIdentity - No identity is configured for specified server. For information on how to configure an identity for the server see https://go.microsoft.com/fwlink/?linkid=2156804\n\n * 400 SubscriptionDoesNotHaveServer - Subscription does not contain server.\n\n * 400 LedgerMissingDigestStorageEndPoint - User attempted to configure ledger digest storage without providing an endpoint\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered. The error message from Active Directory Authentication library (ADAL) is {0}.\n\n * 400 LedgerException - The server encountered an unexpected exception\n\n * 400 LedgerDigestUploadIsNotSupportedOnResourceType - Uploading ledger digests is currently not supported for this resource type.\n\n * 400 LedgerDigestUploadsNotSupportedOnGeoSecondary - The ledger digest storage cannot be configured on secondary databases.\n\n * 400 InvalidStorageAccountName - The specified storage account is not valid or does not exist.\n\n * 400 PreviousOperationInProgress - Uploading ledger digests is being enabled or disabled for database. Please wait for the previous request to complete.\n\n * 400 LedgerDigestUploadsNotSupportedOnGeoChaining - User attempted to set automatic upload of ledger digest in database configured with secondaries of secondaries.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage or Azure Confidential Ledger endpoint.\n\n * 400 InsufficientStorageAccountPermissions - Read or write operations are not allowed on the storage account.\n\n * 400 StorageAccountIsDisabled - The storage account is disabled.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SourceDatabaseNotFound - Specified database does not exist.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "description": "*** Error Responses: ***\n\n * 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage or Azure Confidential Ledger endpoint.\n\n * 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI.\n\n * 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Use the key name “current”.\n\n * 400 InvalidStorageAccountName - The specified storage account is not valid or does not exist.\n\n * 400 InvalidOperationOnNamedReplicas - The ledger digest storage cannot be configured on a named replica.\n\n * 400 NoServerIdentity - No identity is configured for specified server. For information on how to configure an identity for the server see https://go.microsoft.com/fwlink/?linkid=2156804\n\n * 400 SubscriptionDoesNotHaveServer - Subscription does not contain server.\n\n * 400 LedgerMissingDigestStorageEndPoint - User attempted to configure ledger digest storage without providing an endpoint\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered. The error message from Active Directory Authentication library (ADAL) is {0}.\n\n * 400 LedgerException - The server encountered an unexpected exception\n\n * 400 LedgerDigestUploadIsNotSupportedOnResourceType - Uploading ledger digests is currently not supported for this resource type.\n\n * 400 LedgerDigestUploadsNotSupportedOnGeoSecondary - The ledger digest storage cannot be configured on secondary databases.\n\n * 400 InvalidStorageAccountName - The specified storage account is not valid or does not exist.\n\n * 400 PreviousOperationInProgress - Uploading ledger digests is being enabled or disabled for database. Wait for the previous request to complete.\n\n * 400 LedgerDigestUploadsNotSupportedOnGeoChaining - User attempted to set automatic upload of ledger digest in database configured with secondaries of secondaries.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage or Azure Confidential Ledger endpoint.\n\n * 400 InsufficientStorageAccountPermissions - Read or write operations are not allowed on the storage account.\n\n * 400 StorageAccountIsDisabled - The storage account is disabled.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SourceDatabaseNotFound - Specified database does not exist.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Updating the ledger digest upload configuration is in progress." + "description": "Updating the ledger digest upload configuration is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -237,13 +242,18 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage or Azure Confidential Ledger endpoint.\n\n * 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI.\n\n * 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Please use the key name “current”.\n\n * 400 InvalidStorageAccountName - The specified storage account is not valid or does not exist.\n\n * 400 InvalidOperationOnNamedReplicas - The ledger digest storage cannot be configured on a named replica.\n\n * 400 NoServerIdentity - No identity is configured for specified server. For information on how to configure an identity for the server see https://go.microsoft.com/fwlink/?linkid=2156804\n\n * 400 SubscriptionDoesNotHaveServer - Subscription does not contain server.\n\n * 400 LedgerMissingDigestStorageEndPoint - User attempted to configure ledger digest storage without providing an endpoint\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered. The error message from Active Directory Authentication library (ADAL) is {0}.\n\n * 400 LedgerException - The server encountered an unexpected exception\n\n * 400 LedgerDigestUploadIsNotSupportedOnResourceType - Uploading ledger digests is currently not supported for this resource type.\n\n * 400 LedgerDigestUploadsNotSupportedOnGeoSecondary - The ledger digest storage cannot be configured on secondary databases.\n\n * 400 InvalidStorageAccountName - The specified storage account is not valid or does not exist.\n\n * 400 PreviousOperationInProgress - Uploading ledger digests is being enabled or disabled for database. Please wait for the previous request to complete.\n\n * 400 LedgerDigestUploadsNotSupportedOnGeoChaining - User attempted to set automatic upload of ledger digest in database configured with secondaries of secondaries.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage or Azure Confidential Ledger endpoint.\n\n * 400 InsufficientStorageAccountPermissions - Read or write operations are not allowed on the storage account.\n\n * 400 StorageAccountIsDisabled - The storage account is disabled.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SourceDatabaseNotFound - Specified database does not exist.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "description": "*** Error Responses: ***\n\n * 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage or Azure Confidential Ledger endpoint.\n\n * 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI.\n\n * 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Use the key name “current”.\n\n * 400 InvalidStorageAccountName - The specified storage account is not valid or does not exist.\n\n * 400 InvalidOperationOnNamedReplicas - The ledger digest storage cannot be configured on a named replica.\n\n * 400 NoServerIdentity - No identity is configured for specified server. For information on how to configure an identity for the server see https://go.microsoft.com/fwlink/?linkid=2156804\n\n * 400 SubscriptionDoesNotHaveServer - Subscription does not contain server.\n\n * 400 LedgerMissingDigestStorageEndPoint - User attempted to configure ledger digest storage without providing an endpoint\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered. The error message from Active Directory Authentication library (ADAL) is {0}.\n\n * 400 LedgerException - The server encountered an unexpected exception\n\n * 400 LedgerDigestUploadIsNotSupportedOnResourceType - Uploading ledger digests is currently not supported for this resource type.\n\n * 400 LedgerDigestUploadsNotSupportedOnGeoSecondary - The ledger digest storage cannot be configured on secondary databases.\n\n * 400 InvalidStorageAccountName - The specified storage account is not valid or does not exist.\n\n * 400 PreviousOperationInProgress - Uploading ledger digests is being enabled or disabled for database. Wait for the previous request to complete.\n\n * 400 LedgerDigestUploadsNotSupportedOnGeoChaining - User attempted to set automatic upload of ledger digest in database configured with secondaries of secondaries.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage or Azure Confidential Ledger endpoint.\n\n * 400 InsufficientStorageAccountPermissions - Read or write operations are not allowed on the storage account.\n\n * 400 StorageAccountIsDisabled - The storage account is disabled.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SourceDatabaseNotFound - Specified database does not exist.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Disabling the ledger digest upload is in progress." + "description": "Disabling the ledger digest upload is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies.json index 0f39b559003b..62ee4bd5ce04 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies.json @@ -191,7 +191,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -264,7 +269,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedServerDnsAliases.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedServerDnsAliases.json index ee9e1bc10017..445f5b3372c8 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedServerDnsAliases.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedServerDnsAliases.json @@ -156,7 +156,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully created a managed server DNS alias.", @@ -209,7 +214,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "The specified managed server DNS alias does not exist." @@ -272,7 +282,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedServerSecurityAlertPolicies.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedServerSecurityAlertPolicies.json index 0615303848b6..1b96363a2e04 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedServerSecurityAlertPolicies.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ManagedServerSecurityAlertPolicies.json @@ -173,7 +173,12 @@ } }, "202": { - "description": "Created request to set the server threat detection policy." + "description": "Created request to set the server threat detection policy.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/NetworkSecurityPerimeterConfigurations.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/NetworkSecurityPerimeterConfigurations.json index c4f1cc7736de..baa804c80a32 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/NetworkSecurityPerimeterConfigurations.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/NetworkSecurityPerimeterConfigurations.json @@ -150,7 +150,12 @@ } }, "202": { - "description": "Reconcile NSP Configuration operation accepted" + "description": "Reconcile NSP Configuration operation accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/OutboundFirewallRules.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/OutboundFirewallRules.json index ad28cbb747de..9025a6624de8 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/OutboundFirewallRules.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/OutboundFirewallRules.json @@ -148,7 +148,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully created outbound firewall rule.", @@ -201,7 +206,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "Outbound firewall rule does not exist." diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/PrivateEndpointConnections.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/PrivateEndpointConnections.json index 0262aca5f51c..1091d121019a 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/PrivateEndpointConnections.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/PrivateEndpointConnections.json @@ -157,7 +157,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -204,7 +209,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "Private endpoint connection does not exist." diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/RecoverableManagedDatabases.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/RecoverableManagedDatabases.json index f8ea03b4ddda..5554dadf16f4 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/RecoverableManagedDatabases.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/RecoverableManagedDatabases.json @@ -45,7 +45,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ManagementServiceManagedServerDisabled - Operation failed since Managed Instance '{0}' is disabled. Please enable Managed Instance and try again.\n\n * 400 MiGeoRestoreWithWrongBackupStorageRedundancy - Geo-Restore is not allowed for managed instances with LRS/ZRS backup storage redundancy.\n\n * 400 LastBackupNameHasNewline - Please do not use forbidden characters ('\\n', '\\r') in lastBackupName.\n\n * 400 LastBackupNameHasNonAsciiCharacter - The operation was aborted because the 'LastBackupName' parameter contains invalid characters. Only ASCII characters are allowed.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled.\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 UpdatingInstanceAndBackupRedundancy - Instance zone redundancy and backup storage redundancy cannot be updated in the same request.\n\n * 400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled.\n\n * 400 RequestCantLandOnPaaSv2Platform - Request needs to land on PaaSv2 platform but PaaSv2 is not enabled.\n\n * 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.\n\n * 400 DeleteOfVersion2VirtualClusterIsDisabled - Delete of virtual cluster with version 2 is not enabled.\n\n * 400 DeleteOfVirtualClusterIsDisabled - Delete of virtual cluster is not enabled.\n\n * 400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool.\n\n * 400 DnsRefreshOnVirtualClusterIsDisabled - Refresh of DNS records on virtual cluster is not enabled.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 MiCreateFailedNonDelegatedSubnet - User tried to deploy Managed Instance or Managed Instance pool in subnet that is not delegated to Microsoft.Sql/managedInstances.\n\n * 409 ConflictingManagedInstanceOperation - An operation is currently in progress for the managed instance.\n\n * 409 BackupRedundancyUpdateAndInstanceRedundancyConflict - The instance is multi-az but backup storage is being updated from zone redundant to non-zone redundant.\n\n * 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress - Cannot update instance redundancy because backup storage redundancy update is in progress.\n\n * 409 InstanceRedundancyUpdateAndBackupRedundancyConflict - The backup storage is non-zone redundant but instance redundancy is being updated to zone redundant.\n\n * 409 BackupRedundancyUpdateConflict - Cannot update backup storage redundancy because a backup storage redundancy update is already in progress.\n\n * 409 MiDropFailedOnAuthLocks - User tried to drop last Managed Instance in subnet that has Lock applied on resource(s).\n\n * 412 InstanceNotReadyForBackupRedundancyUpdate - Cannot update backup storage redundancy because the instance is not ready.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ManagementServiceManagedServerDisabled - Operation failed since Managed Instance '{0}' is disabled. Please enable Managed Instance and try again.\n\n * 400 MiGeoRestoreWithWrongBackupStorageRedundancy - Geo-Restore is not allowed for managed instances with LRS/ZRS backup storage redundancy.\n\n * 400 LastBackupNameHasNewline - Please do not use forbidden characters ('\\n', '\\r') in lastBackupName.\n\n * 400 LastBackupNameHasNonAsciiCharacter - The operation was aborted because the 'LastBackupName' parameter contains invalid characters. Only ASCII characters are allowed.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 LRSCutoverDatabaseDoesNotExist - The operation was aborted because the database name specified in the request doesn't match any database name on the specified server.\n\n * 400 LRSCutoverDatabaseNotInRestoringState - The operation was aborted because the specified database is not in restoring state.\n\n * 400 LRSCutoverDatabaseAlreadyRestored - The operation was aborted because the specified database was already restored.\n\n * 400 LRSCutoverAlreadyInitiated - The operation was aborted because a cutover for the specified database is already in progress.\n\n * 400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled.\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 UpdatingInstanceAndBackupRedundancy - Instance zone redundancy and backup storage redundancy cannot be updated in the same request.\n\n * 400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled.\n\n * 400 RequestCantLandOnPaaSv2Platform - Request needs to land on PaaSv2 platform but PaaSv2 is not enabled.\n\n * 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.\n\n * 400 DeleteOfVersion2VirtualClusterIsDisabled - Delete of virtual cluster with version 2 is not enabled.\n\n * 400 DeleteOfVirtualClusterIsDisabled - Delete of virtual cluster is not enabled.\n\n * 400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool.\n\n * 400 DnsRefreshOnVirtualClusterIsDisabled - Refresh of DNS records on virtual cluster is not enabled.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 MiCreateFailedNonDelegatedSubnet - User tried to deploy Managed Instance or Managed Instance pool in subnet that is not delegated to Microsoft.Sql/managedInstances.\n\n * 409 ConflictingManagedInstanceOperation - An operation is currently in progress for the managed instance.\n\n * 409 BackupRedundancyUpdateAndInstanceRedundancyConflict - The instance is multi-az but backup storage is being updated from zone redundant to non-zone redundant.\n\n * 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress - Cannot update instance redundancy because backup storage redundancy update is in progress.\n\n * 409 InstanceRedundancyUpdateAndBackupRedundancyConflict - The backup storage is non-zone redundant but instance redundancy is being updated to zone redundant.\n\n * 409 BackupRedundancyUpdateConflict - Cannot update backup storage redundancy because a backup storage redundancy update is already in progress.\n\n * 409 MiDropFailedOnAuthLocks - User tried to drop last Managed Instance in subnet that has Lock applied on resource(s).\n\n * 412 InstanceNotReadyForBackupRedundancyUpdate - Cannot update backup storage redundancy because the instance is not ready.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -96,7 +96,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidRecoverableDatabaseId - Invalid recoverable database identifier.\n\n * 400 ManagementServiceManagedServerDisabled - Operation failed since Managed Instance '{0}' is disabled. Please enable Managed Instance and try again.\n\n * 400 MiGeoRestoreWithWrongBackupStorageRedundancy - Geo-Restore is not allowed for managed instances with LRS/ZRS backup storage redundancy.\n\n * 400 LastBackupNameHasNewline - Please do not use forbidden characters ('\\n', '\\r') in lastBackupName.\n\n * 400 LastBackupNameHasNonAsciiCharacter - The operation was aborted because the 'LastBackupName' parameter contains invalid characters. Only ASCII characters are allowed.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled.\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 UpdatingInstanceAndBackupRedundancy - Instance zone redundancy and backup storage redundancy cannot be updated in the same request.\n\n * 400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled.\n\n * 400 RequestCantLandOnPaaSv2Platform - Request needs to land on PaaSv2 platform but PaaSv2 is not enabled.\n\n * 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.\n\n * 400 DeleteOfVersion2VirtualClusterIsDisabled - Delete of virtual cluster with version 2 is not enabled.\n\n * 400 DeleteOfVirtualClusterIsDisabled - Delete of virtual cluster is not enabled.\n\n * 400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool.\n\n * 400 DnsRefreshOnVirtualClusterIsDisabled - Refresh of DNS records on virtual cluster is not enabled.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 MiCreateFailedNonDelegatedSubnet - User tried to deploy Managed Instance or Managed Instance pool in subnet that is not delegated to Microsoft.Sql/managedInstances.\n\n * 409 ConflictingManagedInstanceOperation - An operation is currently in progress for the managed instance.\n\n * 409 BackupRedundancyUpdateAndInstanceRedundancyConflict - The instance is multi-az but backup storage is being updated from zone redundant to non-zone redundant.\n\n * 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress - Cannot update instance redundancy because backup storage redundancy update is in progress.\n\n * 409 InstanceRedundancyUpdateAndBackupRedundancyConflict - The backup storage is non-zone redundant but instance redundancy is being updated to zone redundant.\n\n * 409 BackupRedundancyUpdateConflict - Cannot update backup storage redundancy because a backup storage redundancy update is already in progress.\n\n * 409 MiDropFailedOnAuthLocks - User tried to drop last Managed Instance in subnet that has Lock applied on resource(s).\n\n * 412 InstanceNotReadyForBackupRedundancyUpdate - Cannot update backup storage redundancy because the instance is not ready.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidRecoverableDatabaseId - Invalid recoverable database identifier.\n\n * 400 ManagementServiceManagedServerDisabled - Operation failed since Managed Instance '{0}' is disabled. Please enable Managed Instance and try again.\n\n * 400 MiGeoRestoreWithWrongBackupStorageRedundancy - Geo-Restore is not allowed for managed instances with LRS/ZRS backup storage redundancy.\n\n * 400 LastBackupNameHasNewline - Please do not use forbidden characters ('\\n', '\\r') in lastBackupName.\n\n * 400 LastBackupNameHasNonAsciiCharacter - The operation was aborted because the 'LastBackupName' parameter contains invalid characters. Only ASCII characters are allowed.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 LRSCutoverDatabaseDoesNotExist - The operation was aborted because the database name specified in the request doesn't match any database name on the specified server.\n\n * 400 LRSCutoverDatabaseNotInRestoringState - The operation was aborted because the specified database is not in restoring state.\n\n * 400 LRSCutoverDatabaseAlreadyRestored - The operation was aborted because the specified database was already restored.\n\n * 400 LRSCutoverAlreadyInitiated - The operation was aborted because a cutover for the specified database is already in progress.\n\n * 400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled.\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 UpdatingInstanceAndBackupRedundancy - Instance zone redundancy and backup storage redundancy cannot be updated in the same request.\n\n * 400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled.\n\n * 400 RequestCantLandOnPaaSv2Platform - Request needs to land on PaaSv2 platform but PaaSv2 is not enabled.\n\n * 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.\n\n * 400 DeleteOfVersion2VirtualClusterIsDisabled - Delete of virtual cluster with version 2 is not enabled.\n\n * 400 DeleteOfVirtualClusterIsDisabled - Delete of virtual cluster is not enabled.\n\n * 400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool.\n\n * 400 DnsRefreshOnVirtualClusterIsDisabled - Refresh of DNS records on virtual cluster is not enabled.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 MiCreateFailedNonDelegatedSubnet - User tried to deploy Managed Instance or Managed Instance pool in subnet that is not delegated to Microsoft.Sql/managedInstances.\n\n * 409 ConflictingManagedInstanceOperation - An operation is currently in progress for the managed instance.\n\n * 409 BackupRedundancyUpdateAndInstanceRedundancyConflict - The instance is multi-az but backup storage is being updated from zone redundant to non-zone redundant.\n\n * 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress - Cannot update instance redundancy because backup storage redundancy update is in progress.\n\n * 409 InstanceRedundancyUpdateAndBackupRedundancyConflict - The backup storage is non-zone redundant but instance redundancy is being updated to zone redundant.\n\n * 409 BackupRedundancyUpdateConflict - Cannot update backup storage redundancy because a backup storage redundancy update is already in progress.\n\n * 409 MiDropFailedOnAuthLocks - User tried to drop last Managed Instance in subnet that has Lock applied on resource(s).\n\n * 412 InstanceNotReadyForBackupRedundancyUpdate - Cannot update backup storage redundancy because the instance is not ready.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ReplicationLinks.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ReplicationLinks.json index 3b4953167cc0..22e211bd3f87 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ReplicationLinks.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ReplicationLinks.json @@ -166,7 +166,12 @@ } }, "202": { - "description": "Update operation is in progress." + "description": "Update operation is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -216,7 +221,12 @@ } }, "202": { - "description": "Deletion operation is in progress." + "description": "Deletion operation is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -277,7 +287,12 @@ } }, "202": { - "description": "Update operation is in progress." + "description": "Update operation is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -333,7 +348,12 @@ } }, "202": { - "description": "Failover operation is in progress." + "description": "Failover operation is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -389,7 +409,12 @@ } }, "202": { - "description": "Failover operation is in progress." + "description": "Failover operation is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/RestorePoints.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/RestorePoints.json index f9a7100b9010..0c454007f422 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/RestorePoints.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/RestorePoints.json @@ -112,7 +112,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully created the restore point request.", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerAdvancedThreatProtectionSettings.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerAdvancedThreatProtectionSettings.json index cdb8e66bc6a7..4b504d93c6d1 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerAdvancedThreatProtectionSettings.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerAdvancedThreatProtectionSettings.json @@ -173,7 +173,12 @@ } }, "202": { - "description": "Created request to set the Advanced Threat Protection state." + "description": "Created request to set the Advanced Threat Protection state.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerAdvisors.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerAdvisors.json index f5cfa00952a9..67991bff5275 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerAdvisors.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerAdvisors.json @@ -583,7 +583,9 @@ "details": { "description": "Gets additional details specific to this recommended action.", "type": "object", - "additionalProperties": true, + "additionalProperties": { + "type": "object" + }, "readOnly": true } } diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerAzureADAdministrators.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerAzureADAdministrators.json index 6a4cb57e208d..37ac8b12c197 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerAzureADAdministrators.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerAzureADAdministrators.json @@ -173,7 +173,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully created a Azure Active Directory administrator.", @@ -234,7 +239,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "The specified Azure Active Directory administrator does not exist." diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerAzureADOnlyAuthentications.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerAzureADOnlyAuthentications.json index f9dc41ffb483..c6747a8e691e 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerAzureADOnlyAuthentications.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerAzureADOnlyAuthentications.json @@ -173,7 +173,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully updated Azure Active Directory only authentication property.", @@ -234,7 +239,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "The specified Azure Active Directory only property does not exist." diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerConnectionPolicies.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerConnectionPolicies.json index 006489b73559..b73e817e9fe5 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerConnectionPolicies.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerConnectionPolicies.json @@ -173,7 +173,12 @@ } }, "202": { - "description": "Updating the server connection policy is in progress." + "description": "Updating the server connection policy is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerDevOpsAudit.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerDevOpsAudit.json index edb05cb1d462..bd1dbf719ce2 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerDevOpsAudit.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerDevOpsAudit.json @@ -171,7 +171,12 @@ } }, "202": { - "description": "Updating the audit DevOps settings is in progress." + "description": "Updating the audit DevOps settings is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerDnsAliases.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerDnsAliases.json index e5312f784ec1..6b86b4895522 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerDnsAliases.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerDnsAliases.json @@ -162,7 +162,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully created a server DNS alias.", @@ -220,7 +225,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "The specified server DNS alias does not exist." @@ -288,7 +298,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerKeys.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerKeys.json index e49bcf6c2675..06408d7121ff 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerKeys.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerKeys.json @@ -159,7 +159,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully created the server key.", @@ -213,7 +218,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "The specified server key does not exist." diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerSecurityAlertPolicies.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerSecurityAlertPolicies.json index dcb8d2d34190..6e8f04f617d0 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerSecurityAlertPolicies.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerSecurityAlertPolicies.json @@ -173,7 +173,12 @@ } }, "202": { - "description": "Created request to set the server threat detection policy." + "description": "Created request to set the server threat detection policy.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerTrustCertificates.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerTrustCertificates.json index c8fdcfb7e20c..33dc21a3f0ec 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerTrustCertificates.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerTrustCertificates.json @@ -97,7 +97,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidDnsZone - The operation has failed because you are attempting to deploy managed instance as a geo-replication secondary to the subnet {0} in which there already exists a managed instance. Deploying managed instance as a geo-replication secondary is supported only in cases when managed instance is the first instance deployed in a subnet. Consider deploying managed instance as a geo-replication secondary to a different subnet in which there are no existing managed instances, or if deploying to a subnet with existing managed instance disable the geo-replication option.\n\n * 400 HkCannotSwitchToInactive - The database cannot proceed with pricing-tier update as it has memory-optimized objects. Please drop such objects and try again.\n\n * 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - Invalid storage size: Storage size limit ({0} GB) is less that current storage used ({1} GB). Please specify higher storage size limit.\n\n * 400 InstanceTimezoneUpdateNotSupported - Instance timezone update not supported.\n\n * 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - Create Managed Instance with non-default timezone not supported.\n\n * 400 ManagedInstanceIpAddressRangeLimit - Cannot perform creation/scaling of the managed instance as there are not enough available IP addresses in the subnet for performing the operation.\n\n * 400 VnetDelegationNotAllowed - User tried to inject Managed Server to subnet which is delegated.\n\n * 400 SubnetHasResourcesOfDifferentType - User tried to create MI in subnet that has resources of different type.\n\n * 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - Update of Managed Instance with maintenance window settings is not allowed.\n\n * 400 OperationNotAllowedInCurrentGeodrConfiguration - The operation is not allowed because the current geo-replication configuration does not allow this combination of {0}. Change the setting on the geo-replication partner before applying the change on this instance.\n\n * 400 VnetPrepareNIPFailed - User tried to prepare subnet that has a conflict with NetworkIntentPolicy.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 ManagedInstanceDeprecatedHardwareFamily - Changing the hardware generation to deprecated {0} generation is not possible.\n\n * 400 ManagedInstanceBackupStorageTypeNotSupported - Backup storage type parameter is not allowed in the instance update operation.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 EmptyPDCInvalidDnsZone - This managed instance cannot be deployed because its DNS-zone does not match the DNS-prefix of its intended virtual cluster for subnet {0}. Although this virtual cluster is empty, its DNS-prefix cannot be changed. Empty virtual clusters will be automatically removed after several hours. Consider waiting for this virtual cluster to expire or manually deleting this virtual cluster and then creating the managed instance.\n\n * 400 InstancePoolNotEnoughCapacity - An instance pool does not have enough capacity\n\n * 400 ManagedInstanceFreemiumNotAvailableForInputParameters - Managed instance creation or update executed with SLO that is not allowed for freemium.\n\n * 400 ManagedInstanceFreemiumNotAvailableOnRegion - Creation of a freemium managed instance on a region that is not allowlisted for freemium.\n\n * 400 ManagementServiceSubnetMaintenanceInProgress - User tried to initiate managed instance create/update while incompatible maintenance is in progress.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ManagedInstanceFreemiumNotAvailableForSubscription - Freemium is not enabled for this subscription type.\n\n * 400 ManagedInstanceInvalidEditionForInstancePool - User tried to select invalid service tier for managed instance inside an existing instance pool.\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 ManagedInstanceInvalidSubnetForInstancePool - User tried to select invalid subnet for managed instance inside an existing instance pool.\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 ManagedInstanceZoneRedudantFeatureNotSupported - ZoneRedundant feature is not supported for the selected service tier. For more details visit aka.ms/sqlmi-service-tier-characteristics.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - Enabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - Disabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SubnetIdCantBeUpdated - Changing managed instance subnet is not supported operation. Please remove this parameter from the request.\n\n * 400 MigrationToAnotherVNetNotSupported - Selected subnet is in another Virtual Network. Moving managed instance to another Virtual Network is not possible. Please provide subnet from Virtual Network {0}.\n\n * 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - Provided subnet is having different DNS zone from the current. Changing instance DNS zone is not supported. Please provide subnet with same DNS zone, create a new subnet or provide empty one.\n\n * 400 MigrationToGen4SubnetNotSupported - It is not possible to update subnet while running on Gen4 hardware as it is being deprecated. Please upgrade your hardware from Gen4 to Gen5 as part of the changing managed instance subnet operation by specifying both parameters at the same time: destination subnet and hardware generation.\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - The operation could not be completed because some of the database files are exceeding maximum General Purpose file size limit of {0} GB.\n\n * 400 CloudLifterUnsupportedFeature - The functionality is not available on the Managed Instance at this time.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 OperationCanNotStartDueToMiLink - The '{0}' operation cannot be completed as there exists a database in a process of creation through Managed Instance link. Please wait for the link creation to complete, or delete the link, and retry the operation again.\n\n * 400 ManagedInstanceSloUpdateFailed - SLO '{0}' operation cannot succeed as the memory usage of '{1}' exceeds the quota.\n\n * 400 SourceAndTargetSubnetsMustBeVnetPeered - Subnet currently used by managed instance and provided destination subnet are part of the virtual networks that are not connected with virtual network peering, or have peering established but don't have allowed traffic. In order to move managed instance from one subnet to another, virtual network peering needs to be established from both source and target virtual network. Please configure virtual network requirements and then try the operation again. Learn more https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks. \n\n * 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - Subnet provided for managed instance deployment is located on subscription different than the one submitted for managed instance. Managed instance and subnet used for deploying the instance must be on the same subscription. Please provide another subnet or switch to the subnet subscription and then try the operation again.\n\n * 400 CreateManagedInstanceInvalidSubnetSize - User attempted to create managed instance in a subnet that is smaller than the allowed minimal subnet size.\n\n * 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - Subnet selected for managed instance migration has address range that overlaps with address range of subnet that holds geo replicated secondary instance. Please verify that your subnet is configured according to guidelines in https://aka.ms/move-managed-instance. \n\n * 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - Subnet selected for managed instance migration is not configured to enable communication with a geo replicated secondary instance. Please check if all of the required ports are open. To properly configure your subnet read the guidelines in https://aka.ms/move-managed-instance. \n\n * 400 ManagedInstanceLocalStorageUpdateSloDisabled - Update SLO for managed instances with local storage is not supported yet.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 GatewayInvalidEdition - '{0}' is not a valid database edition in this version of SQL Server.\n\n * 400 ManagedInstanceInvalidHardwareFamilyForInstancePool - User tried to select invalid hardware family for managed instance inside an existing instance pool.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 ManagedInstanceInvalidLicenseTypeForInstancePool - User tried to select invalid license type for managed instance inside an existing instance pool.\n\n * 400 ManagedInstanceUpdateSloFromVersionlessToVersionedNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 ManagedInstanceUpdateSloFromNewerToOlderVersionEditionNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 ManagedInstanceUpdateSloFromVersionedToVersionlessWorkerCLNotAllowed - Changing the database format is not supported for this managed instance. Check the database format property value specified and visit https://aka.ms/sqlmi-fwnov2022 for more details.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 ManagedInstanceVersionEditionParameterNotAllowedForUsing - Specifying the database format property value is not supported at this time.\n\n * 400 ManagedInstanceFreemiumInvalidArchitecture - A freemium instance can not be created in the specified subnet '(0)'.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ManagedInstanceGeoDRNotAllowedForInstancePool - Creating auto-failover group (GeoDR) is not supported for Managed Instances provisioned inside instance pools. Auto failover groups can be created only for standalone Managed Instances.\n\n * 400 ManagedInstanceWithGeoDRMoveToInstancePoolNotAllowed - Customer has attempted to move a standalone Managed Instance with an existing auto-failover group configured into an instance pool, which is not supported. Only standalone instances without existing auto-failover groups configured can be moved to instance pools.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerRegion - Creation of ZoneRedundant SQL MI is temporarily disabled on this region. You can create Zone Redundant SQL Managed Instances in many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerHardwareGeneration - Creation of ZoneRedundant SQL MI is temporarily disabled for this hardware generation on this region. You can create Zone Redundant SQL Managed Instances with different hardware generation on this region or many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceUpdateSloGeoPrimaryWithNewerVersionEditionThanSecondary - Database format change must be performed on the secondary instance of the failover group first. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 ManagedInstanceFreemiumInstanceAlreadyExists - Only one free SQL Managed Instance is allowed per subscription.\n\n * 400 ManagementServiceGeodrSecondaryDatabaseInCreation - The '{0}' operation cannot be completed as there exists a database in a process of creation through failover group deployment. Please wait for the failover group deployment to complete, or alternatively delete the failover group and retry the operation again.\n\n * 400 ManagedInstanceConversionRegularToFreemiumNotAllowed - User tried converting a Regular SQL Managed Instance to Free SQL Managed Instance.\n\n * 400 ManagedInstanceConversionFreemiumToRegularAndUpdateSLOWhileStoppedNotAllowed - User tried converting a Free SQL Managed Instance to Regular SQL Managed Instance and Update SLO in same request, while Instance is stopped.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 ManagedInstanceMaintenanceWindowChangeNotAllowedWhenInInstancePool - Maintenance window is set at instance pool level and cannot be set individually per pooled instance.\n\n * 400 ManagedInstanceMoveToInstancePoolExceedsDbCountLimit - Cannot move the instance into the pool due to pool database count limit.\n\n * 400 StorageIOpsNotSupported - Storage IOps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidCollation - Invalid collation.\n\n * 400 StorageThroughputMBpsNotSupported - Storage throughput MBps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 StorageIOpsNotSupportedForSpecifiedEdition - Storage IOps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 StorageThroughputMBpsNotSupportedForSpecifiedEdition - Storage throughput MBps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 ManagedInstanceClassicVnetNotSupported - Managed Instance cannot be joined to a classic virtual network.\n\n * 400 AlterDbDeactivatedNotSupported - Database Operation failed for Server '{0}', Database '{1}' due to unexpected delay. Please try again.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetConfigHasNsg - User tried to inject Managed Server subnet with Network Security Groups.\n\n * 400 VnetConfigHasNoUdr - User tried to inject Managed Server subnet without default User Defined Route Table.\n\n * 400 VnetConfigHasInvalidUdr - User tried to inject Managed Server subnet with invalid User Defined Route Table.\n\n * 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.\n\n * 400 VnetConfigHasServiceEndpoints - User tried to inject Managed Server subnet with service endpoints.\n\n * 400 VnetSubnetIsInUse - User tried to inject Managed Server subnet that is not empty.\n\n * 400 VnetSubnetIsLocked - User tried to inject Managed Server subnet that is in locked scope.\n\n * 400 VnetSubnetIsGateway - User tried to inject Managed Server subnet that is Gateway subnet.\n\n * 400 VnetSubnetIsUnknown - User tried to inject Managed Server subnet that does not exist.\n\n * 400 VnetSubnetConflictWithIntendedPolicy - User tried to inject Managed Server subnet that has a conflict with IntendedPolicy.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 ManagedInstanceInvalidEditionForSku - The specified edition {0} is not consistent with the specified SKU {1}.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInCreateOfMI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the create operation.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagedInstanceInvalidLicenseType - The specified license type {0} is not valid.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInUpdateOfGPV1MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V1 Managed Instance.\n\n * 400 UnspecifiedTargetEditionAndFalseGPV2NotAllowedInUpdateOfGPV2MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value FALSE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 GPTargetEditionAndUnspecifiedGPV2NotAllowedInUpdateOFGPV2MI - Combination of General Purpose target edition (sku.name/sku.tier parameters) and unspecified value for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 BCTargetEditionAndSpecifiedGPV2ParamNotAllowedInCreateUpdateOfMI - Combination of Business Critical target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the create/update operation.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 UnspecifiedTargetEditionAndSpecifiedGPV2ParamNotAllowedInUpdateOfBCMI - Combination of unspecified target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the update operation of Business Critical Managed Instance.\n\n * 400 TotalMemoryMBNotSupported - Total memory MB parameter is not allowed in the instance create/update operation.\n\n * 400 TotalMemoryMBNotSupportedForSpecifiedEdition - Total memory MB parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 VnetResourceNotFound - Resource not found: '{0}'.\n\n * 400 InvalidTimezone - Invalid timezone.\n\n * 400 InvalidSubnetForGPV2Edition - General Purpose v2 edition of Managed Instance is not compatible with the specified subnet. Target subnet must be either empty, or all instances in it must run with November 2022 Feature Wave.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 TotalMemoryMBInvalidLimit - Total memory MB parameter has been set to an invalid limit.\n\n * 400 ManagedInstanceUpdateSloGPv2PerDatabaseFileLimitExceeded - The operation could not be completed because there is at least one database whose number of files is exceeding the limit of {0} files per database on General Purpose v2 edition.\n\n * 400 InstanceCollationUpdateNotSupported - User cannot change instance collation on Managed Instance.\n\n * 400 NextGenGPNotSupportedForCmwCustomers - Next-Gen General Purpose edition of Managed Instance does not support Custom Maintenance Window.\n\n * 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - User can create a Managed Instance only with collation 'SQL_Latin1_General_CP1_CI_AS'.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedInstanceExceedMaxAzureStorage - The operation could not be completed because total allocated storage size for General Purpose instance would exceed {0}. Please reduce the number of database files and retry operation.\n\n * 400 ManagedInstanceHasGeoReplica - The operation could not be completed because instance has configured geo replicated secondary instance.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 405 InvalidStorageIOpsLimitValue - Invalid storage IOps limit: {0} IOps. Storage IOps limit must be specified between {1} IOps and {2} IOps, in increments of {3} IOps.\n\n * 405 InvalidStorageThroughputMBpsLimitValue - Invalid storage throughput limit: {0} MBps. Storage throughput limit must be specified between {1} MBps and {2} MBps, in increments of {3} MBps.\n\n * 405 InvalidVcoreValue - vCore value {0} is not valid. Please specify a valid vCore value.\n\n * 405 InvalidHardwareGenerationValue - HardwareGeneration {0} is not valid. Please specify a valid HardwareGeneration value.\n\n * 405 InvalidStorageSizeValue - \"Invalid storage size: {0} GB. Storage size must be specified between {1} and {2} gigabytes, in increments of {3} GB.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 409 ServerOverridePreconditionFailed - Failed to apply server override on category '{0}', because physical db or instance '{1}' in server '{2}' is currently not in 'Ready' or 'Deactivated' state.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ManagedInstanceIsBusy - The server '{0}' is currently busy. Please wait a few minutes before trying again.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 GatewayInternalServerError - The server encountered an unexpected exception.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 InvalidDnsZone - The operation has failed because you are attempting to deploy managed instance as a geo-replication secondary to the subnet {0} in which there already exists a managed instance. Deploying managed instance as a geo-replication secondary is supported only in cases when managed instance is the first instance deployed in a subnet. Consider deploying managed instance as a geo-replication secondary to a different subnet in which there are no existing managed instances, or if deploying to a subnet with existing managed instance disable the geo-replication option.\n\n * 400 HkCannotSwitchToInactive - The database cannot proceed with pricing-tier update as it has memory-optimized objects. Please drop such objects and try again.\n\n * 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - Invalid storage size: Storage size limit ({0} GB) is less that current storage used ({1} GB). Please specify higher storage size limit.\n\n * 400 InstanceTimezoneUpdateNotSupported - Instance timezone update not supported.\n\n * 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - Create Managed Instance with non-default timezone not supported.\n\n * 400 ManagedInstanceIpAddressRangeLimit - Cannot perform creation/scaling of the managed instance as there are not enough available IP addresses in the subnet for performing the operation.\n\n * 400 VnetDelegationNotAllowed - User tried to inject Managed Server to subnet which is delegated.\n\n * 400 SubnetHasResourcesOfDifferentType - User tried to create MI in subnet that has resources of different type.\n\n * 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - Update of Managed Instance with maintenance window settings is not allowed.\n\n * 400 OperationNotAllowedInCurrentGeodrConfiguration - The operation is not allowed because the current geo-replication configuration does not allow this combination of {0}. Change the setting on the geo-replication partner before applying the change on this instance.\n\n * 400 VnetPrepareNIPFailed - User tried to prepare subnet that has a conflict with NetworkIntentPolicy.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 ManagedInstanceDeprecatedHardwareFamily - Changing the hardware generation to deprecated {0} generation is not possible.\n\n * 400 ManagedInstanceBackupStorageTypeNotSupported - Backup storage type parameter is not allowed in the instance update operation.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 EmptyPDCInvalidDnsZone - This managed instance cannot be deployed because its DNS-zone does not match the DNS-prefix of its intended virtual cluster for subnet {0}. Although this virtual cluster is empty, its DNS-prefix cannot be changed. Empty virtual clusters will be automatically removed after several hours. Consider waiting for this virtual cluster to expire or manually deleting this virtual cluster and then creating the managed instance.\n\n * 400 InstancePoolNotEnoughCapacity - An instance pool does not have enough capacity\n\n * 400 ManagedInstanceFreemiumNotAvailableForInputParameters - Managed instance creation or update executed with SLO that is not allowed for freemium.\n\n * 400 ManagedInstanceFreemiumNotAvailableOnRegion - Creation of a freemium managed instance on a region that is not allowlisted for freemium.\n\n * 400 ManagementServiceSubnetMaintenanceInProgress - User tried to initiate managed instance create/update while incompatible maintenance is in progress.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ManagedInstanceFreemiumNotAvailableForSubscription - Freemium is not enabled for this subscription type.\n\n * 400 ManagedInstanceInvalidEditionForInstancePool - User tried to select invalid service tier for managed instance inside an existing instance pool.\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 ManagedInstanceInvalidSubnetForInstancePool - User tried to select invalid subnet for managed instance inside an existing instance pool.\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 ManagedInstanceZoneRedudantFeatureNotSupported - ZoneRedundant feature is not supported for the selected service tier. For more details visit aka.ms/sqlmi-service-tier-characteristics.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - Enabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - Disabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SubnetIdCantBeUpdated - Changing managed instance subnet is not supported operation. Please remove this parameter from the request.\n\n * 400 MigrationToAnotherVNetNotSupported - Selected subnet is in another Virtual Network. Moving managed instance to another Virtual Network is not possible. Please provide subnet from Virtual Network {0}.\n\n * 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - Provided subnet is having different DNS zone from the current. Changing instance DNS zone is not supported. Please provide subnet with same DNS zone, create a new subnet or provide empty one.\n\n * 400 MigrationToGen4SubnetNotSupported - It is not possible to update subnet while running on Gen4 hardware as it is being deprecated. Please upgrade your hardware from Gen4 to Gen5 as part of the changing managed instance subnet operation by specifying both parameters at the same time: destination subnet and hardware generation.\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - The operation could not be completed because some of the database files are exceeding maximum General Purpose file size limit of {0} GB.\n\n * 400 CloudLifterUnsupportedFeature - The functionality is not available on the Managed Instance at this time.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 OperationCanNotStartDueToMiLink - The '{0}' operation cannot be completed as there exists a database in a process of creation through Managed Instance link. Please wait for the link creation to complete, or delete the link, and retry the operation again.\n\n * 400 ManagedInstanceSloUpdateFailed - SLO '{0}' operation cannot succeed as the memory usage of '{1}' exceeds the quota.\n\n * 400 SourceAndTargetSubnetsMustBeVnetPeered - Subnet currently used by managed instance and provided destination subnet are part of the virtual networks that are not connected with virtual network peering, or have peering established but don't have allowed traffic. In order to move managed instance from one subnet to another, virtual network peering needs to be established from both source and target virtual network. Please configure virtual network requirements and then try the operation again. Learn more https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks. \n\n * 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - Subnet provided for managed instance deployment is located on subscription different than the one submitted for managed instance. Managed instance and subnet used for deploying the instance must be on the same subscription. Please provide another subnet or switch to the subnet subscription and then try the operation again.\n\n * 400 CreateManagedInstanceInvalidSubnetSize - User attempted to create managed instance in a subnet that is smaller than the allowed minimal subnet size.\n\n * 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - Subnet selected for managed instance migration has address range that overlaps with address range of subnet that holds geo replicated secondary instance. Please verify that your subnet is configured according to guidelines in https://aka.ms/move-managed-instance. \n\n * 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - Subnet selected for managed instance migration is not configured to enable communication with a geo replicated secondary instance. Please check if all of the required ports are open. To properly configure your subnet read the guidelines in https://aka.ms/move-managed-instance. \n\n * 400 ManagedInstanceLocalStorageUpdateSloDisabled - Update SLO for managed instances with local storage is not supported yet.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 GatewayInvalidEdition - '{0}' is not a valid database edition in this version of SQL Server.\n\n * 400 ManagedInstanceInvalidHardwareFamilyForInstancePool - User tried to select invalid hardware family for managed instance inside an existing instance pool.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 ManagedInstanceInvalidLicenseTypeForInstancePool - User tried to select invalid license type for managed instance inside an existing instance pool.\n\n * 400 ManagedInstanceUpdateSloFromVersionlessToVersionedNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 ManagedInstanceUpdateSloFromNewerToOlderVersionEditionNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 ManagedInstanceUpdateSloFromVersionedToVersionlessWorkerCLNotAllowed - Changing the database format is not supported for this managed instance. Check the database format property value specified and visit https://aka.ms/sqlmi-fwnov2022 for more details.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 ManagedInstanceVersionEditionParameterNotAllowedForUsing - Specifying the database format property value is not supported at this time.\n\n * 400 ManagedInstanceFreemiumInvalidArchitecture - A freemium instance can not be created in the specified subnet '(0)'.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ManagedInstanceWithGeoDRMoveToInstancePoolNotAllowed - Customer has attempted to move a standalone Managed Instance with an existing auto-failover group configured into an instance pool, which is not supported. Only standalone instances without existing auto-failover groups configured can be moved to instance pools.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerRegion - Creation of ZoneRedundant SQL MI is temporarily disabled on this region. You can create Zone Redundant SQL Managed Instances in many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerHardwareGeneration - Creation of ZoneRedundant SQL MI is temporarily disabled for this hardware generation on this region. You can create Zone Redundant SQL Managed Instances with different hardware generation on this region or many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceUpdateSloGeoPrimaryWithNewerVersionEditionThanSecondary - Database format change must be performed on the secondary instance of the failover group first. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 ManagedInstanceFreemiumInstanceAlreadyExists - Only one free SQL Managed Instance is allowed per subscription.\n\n * 400 ManagementServiceGeodrSecondaryDatabaseInCreation - The '{0}' operation cannot be completed as there exists a database in a process of creation through failover group deployment. Please wait for the failover group deployment to complete, or alternatively delete the failover group and retry the operation again.\n\n * 400 ManagedInstanceConversionRegularToFreemiumNotAllowed - User tried converting a Regular SQL Managed Instance to Free SQL Managed Instance.\n\n * 400 ManagedInstanceConversionFreemiumToRegularAndUpdateSLOWhileStoppedNotAllowed - User tried converting a Free SQL Managed Instance to Regular SQL Managed Instance and Update SLO in same request, while Instance is stopped.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 ManagedInstanceMaintenanceWindowChangeNotAllowedWhenInInstancePool - Maintenance window is set at instance pool level and cannot be set individually per pooled instance.\n\n * 400 ManagedInstanceMoveToInstancePoolExceedsDbCountLimit - Cannot move the instance into the pool due to pool database count limit.\n\n * 400 ManagedInstancePoolZoneRedundancyNotSupported - Cannot move a zone-redundant instance into the pool as zone-redundancy is not supported in pools.\n\n * 400 DeploymentIntoPrivateSubnetsNotAllowed - Deploying managed instances and instance pools into private subnets is not supported.\n\n * 400 StorageIOpsNotSupported - Storage IOps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidCollation - Invalid collation.\n\n * 400 StorageThroughputMBpsNotSupported - Storage throughput MBps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 StorageIOpsNotSupportedForSpecifiedEdition - Storage IOps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 StorageThroughputMBpsNotSupportedForSpecifiedEdition - Storage throughput MBps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 ManagedInstanceClassicVnetNotSupported - Managed Instance cannot be joined to a classic virtual network.\n\n * 400 AlterDbDeactivatedNotSupported - Database Operation failed for Server '{0}', Database '{1}' due to unexpected delay. Please try again.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetConfigHasNsg - User tried to inject Managed Server subnet with Network Security Groups.\n\n * 400 VnetConfigHasNoUdr - User tried to inject Managed Server subnet without default User Defined Route Table.\n\n * 400 VnetConfigHasInvalidUdr - User tried to inject Managed Server subnet with invalid User Defined Route Table.\n\n * 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.\n\n * 400 VnetConfigHasServiceEndpoints - User tried to inject Managed Server subnet with service endpoints.\n\n * 400 VnetSubnetIsInUse - User tried to inject Managed Server subnet that is not empty.\n\n * 400 VnetSubnetIsLocked - User tried to inject Managed Server subnet that is in locked scope.\n\n * 400 VnetSubnetIsGateway - User tried to inject Managed Server subnet that is Gateway subnet.\n\n * 400 VnetSubnetIsUnknown - User tried to inject Managed Server subnet that does not exist.\n\n * 400 VnetSubnetConflictWithIntendedPolicy - User tried to inject Managed Server subnet that has a conflict with IntendedPolicy.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 ManagedInstanceInvalidEditionForSku - The specified edition {0} is not consistent with the specified SKU {1}.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInCreateOfMI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the create operation.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagedInstanceInvalidLicenseType - The specified license type {0} is not valid.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInUpdateOfGPV1MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V1 Managed Instance.\n\n * 400 UnspecifiedTargetEditionAndFalseGPV2NotAllowedInUpdateOfGPV2MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value FALSE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 GPTargetEditionAndUnspecifiedGPV2NotAllowedInUpdateOFGPV2MI - Combination of General Purpose target edition (sku.name/sku.tier parameters) and unspecified value for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 BCTargetEditionAndSpecifiedGPV2ParamNotAllowedInCreateUpdateOfMI - Combination of Business Critical target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the create/update operation.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 UnspecifiedTargetEditionAndSpecifiedGPV2ParamNotAllowedInUpdateOfBCMI - Combination of unspecified target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the update operation of Business Critical Managed Instance.\n\n * 400 TotalMemoryMBNotSupported - Total memory MB parameter is not allowed in the instance create/update operation.\n\n * 400 TotalMemoryMBNotSupportedForSpecifiedEdition - Total memory MB parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 VnetResourceNotFound - Resource not found: '{0}'.\n\n * 400 InvalidTimezone - Invalid timezone.\n\n * 400 InvalidSubnetForGPV2Edition - General Purpose v2 edition of Managed Instance is not compatible with the specified subnet. Target subnet must be either empty, or all instances in it must run with November 2022 Feature Wave.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 TotalMemoryMBInvalidLimit - Total memory MB parameter has been set to an invalid limit.\n\n * 400 ManagedInstanceUpdateSloGPv2PerDatabaseFileLimitExceeded - The operation could not be completed because there is at least one database whose number of files is exceeding the limit of {0} files per database on General Purpose v2 edition.\n\n * 400 InstanceCollationUpdateNotSupported - User cannot change instance collation on Managed Instance.\n\n * 400 NextGenGPNotSupportedForCmwCustomers - Next-Gen General Purpose edition of Managed Instance does not support Custom Maintance Window.\n\n * 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - User can create a Managed Instance only with collation 'SQL_Latin1_General_CP1_CI_AS'.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedInstanceExceedMaxAzureStorage - The operation could not be completed because total allocated storage size for General Purpose instance would exceed {0}. Please reduce the number of database files and retry operation.\n\n * 400 ManagedInstanceHasGeoReplica - The operation could not be completed because instance has configured geo replicated secondary instance.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 405 InvalidStorageIOpsLimitValue - Invalid storage IOps limit: {0} IOps. Storage IOps limit must be specified between {1} IOps and {2} IOps, in increments of {3} IOps.\n\n * 405 InvalidStorageThroughputMBpsLimitValue - Invalid storage throughput limit: {0} MBps. Storage throughput limit must be specified between {1} MBps and {2} MBps, in increments of {3} MBps.\n\n * 405 InvalidVcoreValue - vCore value {0} is not valid. Please specify a valid vCore value.\n\n * 405 InvalidHardwareGenerationValue - HardwareGeneration {0} is not valid. Please specify a valid HardwareGeneration value.\n\n * 405 InvalidStorageSizeValue - \"Invalid storage size: {0} GB. Storage size must be specified between {1} and {2} gigabytes, in increments of {3} GB.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 409 ServerOverridePreconditionFailed - Failed to apply server override on category '{0}', because physical db or instance '{1}' in server '{2}' is currently not in 'Ready' or 'Deactivated' state.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ManagedInstanceIsBusy - The server '{0}' is currently busy. Please wait a few minutes before trying again.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 GatewayInternalServerError - The server encountered an unexpected exception.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -153,13 +153,18 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidDnsZone - The operation has failed because you are attempting to deploy managed instance as a geo-replication secondary to the subnet {0} in which there already exists a managed instance. Deploying managed instance as a geo-replication secondary is supported only in cases when managed instance is the first instance deployed in a subnet. Consider deploying managed instance as a geo-replication secondary to a different subnet in which there are no existing managed instances, or if deploying to a subnet with existing managed instance disable the geo-replication option.\n\n * 400 HkCannotSwitchToInactive - The database cannot proceed with pricing-tier update as it has memory-optimized objects. Please drop such objects and try again.\n\n * 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - Invalid storage size: Storage size limit ({0} GB) is less that current storage used ({1} GB). Please specify higher storage size limit.\n\n * 400 InstanceTimezoneUpdateNotSupported - Instance timezone update not supported.\n\n * 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - Create Managed Instance with non-default timezone not supported.\n\n * 400 ManagedInstanceIpAddressRangeLimit - Cannot perform creation/scaling of the managed instance as there are not enough available IP addresses in the subnet for performing the operation.\n\n * 400 VnetDelegationNotAllowed - User tried to inject Managed Server to subnet which is delegated.\n\n * 400 SubnetHasResourcesOfDifferentType - User tried to create MI in subnet that has resources of different type.\n\n * 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - Update of Managed Instance with maintenance window settings is not allowed.\n\n * 400 OperationNotAllowedInCurrentGeodrConfiguration - The operation is not allowed because the current geo-replication configuration does not allow this combination of {0}. Change the setting on the geo-replication partner before applying the change on this instance.\n\n * 400 VnetPrepareNIPFailed - User tried to prepare subnet that has a conflict with NetworkIntentPolicy.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 ManagedInstanceDeprecatedHardwareFamily - Changing the hardware generation to deprecated {0} generation is not possible.\n\n * 400 ManagedInstanceBackupStorageTypeNotSupported - Backup storage type parameter is not allowed in the instance update operation.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 EmptyPDCInvalidDnsZone - This managed instance cannot be deployed because its DNS-zone does not match the DNS-prefix of its intended virtual cluster for subnet {0}. Although this virtual cluster is empty, its DNS-prefix cannot be changed. Empty virtual clusters will be automatically removed after several hours. Consider waiting for this virtual cluster to expire or manually deleting this virtual cluster and then creating the managed instance.\n\n * 400 InstancePoolNotEnoughCapacity - An instance pool does not have enough capacity\n\n * 400 ManagedInstanceFreemiumNotAvailableForInputParameters - Managed instance creation or update executed with SLO that is not allowed for freemium.\n\n * 400 ManagedInstanceFreemiumNotAvailableOnRegion - Creation of a freemium managed instance on a region that is not allowlisted for freemium.\n\n * 400 ManagementServiceSubnetMaintenanceInProgress - User tried to initiate managed instance create/update while incompatible maintenance is in progress.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ManagedInstanceFreemiumNotAvailableForSubscription - Freemium is not enabled for this subscription type.\n\n * 400 ManagedInstanceInvalidEditionForInstancePool - User tried to select invalid service tier for managed instance inside an existing instance pool.\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 ManagedInstanceInvalidSubnetForInstancePool - User tried to select invalid subnet for managed instance inside an existing instance pool.\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 ManagedInstanceZoneRedudantFeatureNotSupported - ZoneRedundant feature is not supported for the selected service tier. For more details visit aka.ms/sqlmi-service-tier-characteristics.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - Enabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - Disabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SubnetIdCantBeUpdated - Changing managed instance subnet is not supported operation. Please remove this parameter from the request.\n\n * 400 MigrationToAnotherVNetNotSupported - Selected subnet is in another Virtual Network. Moving managed instance to another Virtual Network is not possible. Please provide subnet from Virtual Network {0}.\n\n * 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - Provided subnet is having different DNS zone from the current. Changing instance DNS zone is not supported. Please provide subnet with same DNS zone, create a new subnet or provide empty one.\n\n * 400 MigrationToGen4SubnetNotSupported - It is not possible to update subnet while running on Gen4 hardware as it is being deprecated. Please upgrade your hardware from Gen4 to Gen5 as part of the changing managed instance subnet operation by specifying both parameters at the same time: destination subnet and hardware generation.\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - The operation could not be completed because some of the database files are exceeding maximum General Purpose file size limit of {0} GB.\n\n * 400 CloudLifterUnsupportedFeature - The functionality is not available on the Managed Instance at this time.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 OperationCanNotStartDueToMiLink - The '{0}' operation cannot be completed as there exists a database in a process of creation through Managed Instance link. Please wait for the link creation to complete, or delete the link, and retry the operation again.\n\n * 400 ManagedInstanceSloUpdateFailed - SLO '{0}' operation cannot succeed as the memory usage of '{1}' exceeds the quota.\n\n * 400 SourceAndTargetSubnetsMustBeVnetPeered - Subnet currently used by managed instance and provided destination subnet are part of the virtual networks that are not connected with virtual network peering, or have peering established but don't have allowed traffic. In order to move managed instance from one subnet to another, virtual network peering needs to be established from both source and target virtual network. Please configure virtual network requirements and then try the operation again. Learn more https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks. \n\n * 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - Subnet provided for managed instance deployment is located on subscription different than the one submitted for managed instance. Managed instance and subnet used for deploying the instance must be on the same subscription. Please provide another subnet or switch to the subnet subscription and then try the operation again.\n\n * 400 CreateManagedInstanceInvalidSubnetSize - User attempted to create managed instance in a subnet that is smaller than the allowed minimal subnet size.\n\n * 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - Subnet selected for managed instance migration has address range that overlaps with address range of subnet that holds geo replicated secondary instance. Please verify that your subnet is configured according to guidelines in https://aka.ms/move-managed-instance. \n\n * 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - Subnet selected for managed instance migration is not configured to enable communication with a geo replicated secondary instance. Please check if all of the required ports are open. To properly configure your subnet read the guidelines in https://aka.ms/move-managed-instance. \n\n * 400 ManagedInstanceLocalStorageUpdateSloDisabled - Update SLO for managed instances with local storage is not supported yet.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 GatewayInvalidEdition - '{0}' is not a valid database edition in this version of SQL Server.\n\n * 400 ManagedInstanceInvalidHardwareFamilyForInstancePool - User tried to select invalid hardware family for managed instance inside an existing instance pool.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 ManagedInstanceInvalidLicenseTypeForInstancePool - User tried to select invalid license type for managed instance inside an existing instance pool.\n\n * 400 ManagedInstanceUpdateSloFromVersionlessToVersionedNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 ManagedInstanceUpdateSloFromNewerToOlderVersionEditionNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 ManagedInstanceUpdateSloFromVersionedToVersionlessWorkerCLNotAllowed - Changing the database format is not supported for this managed instance. Check the database format property value specified and visit https://aka.ms/sqlmi-fwnov2022 for more details.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 ManagedInstanceVersionEditionParameterNotAllowedForUsing - Specifying the database format property value is not supported at this time.\n\n * 400 ManagedInstanceFreemiumInvalidArchitecture - A freemium instance can not be created in the specified subnet '(0)'.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ManagedInstanceGeoDRNotAllowedForInstancePool - Creating auto-failover group (GeoDR) is not supported for Managed Instances provisioned inside instance pools. Auto failover groups can be created only for standalone Managed Instances.\n\n * 400 ManagedInstanceWithGeoDRMoveToInstancePoolNotAllowed - Customer has attempted to move a standalone Managed Instance with an existing auto-failover group configured into an instance pool, which is not supported. Only standalone instances without existing auto-failover groups configured can be moved to instance pools.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerRegion - Creation of ZoneRedundant SQL MI is temporarily disabled on this region. You can create Zone Redundant SQL Managed Instances in many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerHardwareGeneration - Creation of ZoneRedundant SQL MI is temporarily disabled for this hardware generation on this region. You can create Zone Redundant SQL Managed Instances with different hardware generation on this region or many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceUpdateSloGeoPrimaryWithNewerVersionEditionThanSecondary - Database format change must be performed on the secondary instance of the failover group first. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 ManagedInstanceFreemiumInstanceAlreadyExists - Only one free SQL Managed Instance is allowed per subscription.\n\n * 400 ManagementServiceGeodrSecondaryDatabaseInCreation - The '{0}' operation cannot be completed as there exists a database in a process of creation through failover group deployment. Please wait for the failover group deployment to complete, or alternatively delete the failover group and retry the operation again.\n\n * 400 ManagedInstanceConversionRegularToFreemiumNotAllowed - User tried converting a Regular SQL Managed Instance to Free SQL Managed Instance.\n\n * 400 ManagedInstanceConversionFreemiumToRegularAndUpdateSLOWhileStoppedNotAllowed - User tried converting a Free SQL Managed Instance to Regular SQL Managed Instance and Update SLO in same request, while Instance is stopped.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 ManagedInstanceMaintenanceWindowChangeNotAllowedWhenInInstancePool - Maintenance window is set at instance pool level and cannot be set individually per pooled instance.\n\n * 400 ManagedInstanceMoveToInstancePoolExceedsDbCountLimit - Cannot move the instance into the pool due to pool database count limit.\n\n * 400 StorageIOpsNotSupported - Storage IOps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidCollation - Invalid collation.\n\n * 400 StorageThroughputMBpsNotSupported - Storage throughput MBps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 StorageIOpsNotSupportedForSpecifiedEdition - Storage IOps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 StorageThroughputMBpsNotSupportedForSpecifiedEdition - Storage throughput MBps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 ManagedInstanceClassicVnetNotSupported - Managed Instance cannot be joined to a classic virtual network.\n\n * 400 AlterDbDeactivatedNotSupported - Database Operation failed for Server '{0}', Database '{1}' due to unexpected delay. Please try again.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetConfigHasNsg - User tried to inject Managed Server subnet with Network Security Groups.\n\n * 400 VnetConfigHasNoUdr - User tried to inject Managed Server subnet without default User Defined Route Table.\n\n * 400 VnetConfigHasInvalidUdr - User tried to inject Managed Server subnet with invalid User Defined Route Table.\n\n * 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.\n\n * 400 VnetConfigHasServiceEndpoints - User tried to inject Managed Server subnet with service endpoints.\n\n * 400 VnetSubnetIsInUse - User tried to inject Managed Server subnet that is not empty.\n\n * 400 VnetSubnetIsLocked - User tried to inject Managed Server subnet that is in locked scope.\n\n * 400 VnetSubnetIsGateway - User tried to inject Managed Server subnet that is Gateway subnet.\n\n * 400 VnetSubnetIsUnknown - User tried to inject Managed Server subnet that does not exist.\n\n * 400 VnetSubnetConflictWithIntendedPolicy - User tried to inject Managed Server subnet that has a conflict with IntendedPolicy.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 ManagedInstanceInvalidEditionForSku - The specified edition {0} is not consistent with the specified SKU {1}.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInCreateOfMI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the create operation.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagedInstanceInvalidLicenseType - The specified license type {0} is not valid.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInUpdateOfGPV1MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V1 Managed Instance.\n\n * 400 UnspecifiedTargetEditionAndFalseGPV2NotAllowedInUpdateOfGPV2MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value FALSE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 GPTargetEditionAndUnspecifiedGPV2NotAllowedInUpdateOFGPV2MI - Combination of General Purpose target edition (sku.name/sku.tier parameters) and unspecified value for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 BCTargetEditionAndSpecifiedGPV2ParamNotAllowedInCreateUpdateOfMI - Combination of Business Critical target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the create/update operation.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 UnspecifiedTargetEditionAndSpecifiedGPV2ParamNotAllowedInUpdateOfBCMI - Combination of unspecified target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the update operation of Business Critical Managed Instance.\n\n * 400 TotalMemoryMBNotSupported - Total memory MB parameter is not allowed in the instance create/update operation.\n\n * 400 TotalMemoryMBNotSupportedForSpecifiedEdition - Total memory MB parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 VnetResourceNotFound - Resource not found: '{0}'.\n\n * 400 InvalidTimezone - Invalid timezone.\n\n * 400 InvalidSubnetForGPV2Edition - General Purpose v2 edition of Managed Instance is not compatible with the specified subnet. Target subnet must be either empty, or all instances in it must run with November 2022 Feature Wave.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 TotalMemoryMBInvalidLimit - Total memory MB parameter has been set to an invalid limit.\n\n * 400 ManagedInstanceUpdateSloGPv2PerDatabaseFileLimitExceeded - The operation could not be completed because there is at least one database whose number of files is exceeding the limit of {0} files per database on General Purpose v2 edition.\n\n * 400 InstanceCollationUpdateNotSupported - User cannot change instance collation on Managed Instance.\n\n * 400 NextGenGPNotSupportedForCmwCustomers - Next-Gen General Purpose edition of Managed Instance does not support Custom Maintenance Window.\n\n * 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - User can create a Managed Instance only with collation 'SQL_Latin1_General_CP1_CI_AS'.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedInstanceExceedMaxAzureStorage - The operation could not be completed because total allocated storage size for General Purpose instance would exceed {0}. Please reduce the number of database files and retry operation.\n\n * 400 ManagedInstanceHasGeoReplica - The operation could not be completed because instance has configured geo replicated secondary instance.\n\n * 400 MissingPublicBlob - The public blob is missing.\n\n * 400 InvalidPublicBlob - Invalid public blob specified, reason: '{0}'.\n\n * 400 MissingCertificateName - The certificate name is missing.\n\n * 400 CertificateAlreadyExists - A certificate with a given name already exists or this certificate already has been added to the database.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 405 InvalidStorageIOpsLimitValue - Invalid storage IOps limit: {0} IOps. Storage IOps limit must be specified between {1} IOps and {2} IOps, in increments of {3} IOps.\n\n * 405 InvalidStorageThroughputMBpsLimitValue - Invalid storage throughput limit: {0} MBps. Storage throughput limit must be specified between {1} MBps and {2} MBps, in increments of {3} MBps.\n\n * 405 InvalidVcoreValue - vCore value {0} is not valid. Please specify a valid vCore value.\n\n * 405 InvalidHardwareGenerationValue - HardwareGeneration {0} is not valid. Please specify a valid HardwareGeneration value.\n\n * 405 InvalidStorageSizeValue - \"Invalid storage size: {0} GB. Storage size must be specified between {1} and {2} gigabytes, in increments of {3} GB.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 409 ServerOverridePreconditionFailed - Failed to apply server override on category '{0}', because physical db or instance '{1}' in server '{2}' is currently not in 'Ready' or 'Deactivated' state.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ManagedInstanceIsBusy - The server '{0}' is currently busy. Please wait a few minutes before trying again.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 GatewayInternalServerError - The server encountered an unexpected exception.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidDnsZone - The operation has failed because you are attempting to deploy managed instance as a geo-replication secondary to the subnet {0} in which there already exists a managed instance. Deploying managed instance as a geo-replication secondary is supported only in cases when managed instance is the first instance deployed in a subnet. Consider deploying managed instance as a geo-replication secondary to a different subnet in which there are no existing managed instances, or if deploying to a subnet with existing managed instance disable the geo-replication option.\n\n * 400 HkCannotSwitchToInactive - The database cannot proceed with pricing-tier update as it has memory-optimized objects. Please drop such objects and try again.\n\n * 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - Invalid storage size: Storage size limit ({0} GB) is less that current storage used ({1} GB). Please specify higher storage size limit.\n\n * 400 InstanceTimezoneUpdateNotSupported - Instance timezone update not supported.\n\n * 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - Create Managed Instance with non-default timezone not supported.\n\n * 400 ManagedInstanceIpAddressRangeLimit - Cannot perform creation/scaling of the managed instance as there are not enough available IP addresses in the subnet for performing the operation.\n\n * 400 VnetDelegationNotAllowed - User tried to inject Managed Server to subnet which is delegated.\n\n * 400 SubnetHasResourcesOfDifferentType - User tried to create MI in subnet that has resources of different type.\n\n * 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - Update of Managed Instance with maintenance window settings is not allowed.\n\n * 400 OperationNotAllowedInCurrentGeodrConfiguration - The operation is not allowed because the current geo-replication configuration does not allow this combination of {0}. Change the setting on the geo-replication partner before applying the change on this instance.\n\n * 400 VnetPrepareNIPFailed - User tried to prepare subnet that has a conflict with NetworkIntentPolicy.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 ManagedInstanceDeprecatedHardwareFamily - Changing the hardware generation to deprecated {0} generation is not possible.\n\n * 400 ManagedInstanceBackupStorageTypeNotSupported - Backup storage type parameter is not allowed in the instance update operation.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 EmptyPDCInvalidDnsZone - This managed instance cannot be deployed because its DNS-zone does not match the DNS-prefix of its intended virtual cluster for subnet {0}. Although this virtual cluster is empty, its DNS-prefix cannot be changed. Empty virtual clusters will be automatically removed after several hours. Consider waiting for this virtual cluster to expire or manually deleting this virtual cluster and then creating the managed instance.\n\n * 400 InstancePoolNotEnoughCapacity - An instance pool does not have enough capacity\n\n * 400 ManagedInstanceFreemiumNotAvailableForInputParameters - Managed instance creation or update executed with SLO that is not allowed for freemium.\n\n * 400 ManagedInstanceFreemiumNotAvailableOnRegion - Creation of a freemium managed instance on a region that is not allowlisted for freemium.\n\n * 400 ManagementServiceSubnetMaintenanceInProgress - User tried to initiate managed instance create/update while incompatible maintenance is in progress.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ManagedInstanceFreemiumNotAvailableForSubscription - Freemium is not enabled for this subscription type.\n\n * 400 ManagedInstanceInvalidEditionForInstancePool - User tried to select invalid service tier for managed instance inside an existing instance pool.\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 ManagedInstanceInvalidSubnetForInstancePool - User tried to select invalid subnet for managed instance inside an existing instance pool.\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 ManagedInstanceZoneRedudantFeatureNotSupported - ZoneRedundant feature is not supported for the selected service tier. For more details visit aka.ms/sqlmi-service-tier-characteristics.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - Enabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - Disabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SubnetIdCantBeUpdated - Changing managed instance subnet is not supported operation. Please remove this parameter from the request.\n\n * 400 MigrationToAnotherVNetNotSupported - Selected subnet is in another Virtual Network. Moving managed instance to another Virtual Network is not possible. Please provide subnet from Virtual Network {0}.\n\n * 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - Provided subnet is having different DNS zone from the current. Changing instance DNS zone is not supported. Please provide subnet with same DNS zone, create a new subnet or provide empty one.\n\n * 400 MigrationToGen4SubnetNotSupported - It is not possible to update subnet while running on Gen4 hardware as it is being deprecated. Please upgrade your hardware from Gen4 to Gen5 as part of the changing managed instance subnet operation by specifying both parameters at the same time: destination subnet and hardware generation.\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - The operation could not be completed because some of the database files are exceeding maximum General Purpose file size limit of {0} GB.\n\n * 400 CloudLifterUnsupportedFeature - The functionality is not available on the Managed Instance at this time.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 OperationCanNotStartDueToMiLink - The '{0}' operation cannot be completed as there exists a database in a process of creation through Managed Instance link. Please wait for the link creation to complete, or delete the link, and retry the operation again.\n\n * 400 ManagedInstanceSloUpdateFailed - SLO '{0}' operation cannot succeed as the memory usage of '{1}' exceeds the quota.\n\n * 400 SourceAndTargetSubnetsMustBeVnetPeered - Subnet currently used by managed instance and provided destination subnet are part of the virtual networks that are not connected with virtual network peering, or have peering established but don't have allowed traffic. In order to move managed instance from one subnet to another, virtual network peering needs to be established from both source and target virtual network. Please configure virtual network requirements and then try the operation again. Learn more https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks. \n\n * 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - Subnet provided for managed instance deployment is located on subscription different than the one submitted for managed instance. Managed instance and subnet used for deploying the instance must be on the same subscription. Please provide another subnet or switch to the subnet subscription and then try the operation again.\n\n * 400 CreateManagedInstanceInvalidSubnetSize - User attempted to create managed instance in a subnet that is smaller than the allowed minimal subnet size.\n\n * 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - Subnet selected for managed instance migration has address range that overlaps with address range of subnet that holds geo replicated secondary instance. Please verify that your subnet is configured according to guidelines in https://aka.ms/move-managed-instance. \n\n * 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - Subnet selected for managed instance migration is not configured to enable communication with a geo replicated secondary instance. Please check if all of the required ports are open. To properly configure your subnet read the guidelines in https://aka.ms/move-managed-instance. \n\n * 400 ManagedInstanceLocalStorageUpdateSloDisabled - Update SLO for managed instances with local storage is not supported yet.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 GatewayInvalidEdition - '{0}' is not a valid database edition in this version of SQL Server.\n\n * 400 ManagedInstanceInvalidHardwareFamilyForInstancePool - User tried to select invalid hardware family for managed instance inside an existing instance pool.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 ManagedInstanceInvalidLicenseTypeForInstancePool - User tried to select invalid license type for managed instance inside an existing instance pool.\n\n * 400 ManagedInstanceUpdateSloFromVersionlessToVersionedNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 ManagedInstanceUpdateSloFromNewerToOlderVersionEditionNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 ManagedInstanceUpdateSloFromVersionedToVersionlessWorkerCLNotAllowed - Changing the database format is not supported for this managed instance. Check the database format property value specified and visit https://aka.ms/sqlmi-fwnov2022 for more details.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 ManagedInstanceVersionEditionParameterNotAllowedForUsing - Specifying the database format property value is not supported at this time.\n\n * 400 ManagedInstanceFreemiumInvalidArchitecture - A freemium instance can not be created in the specified subnet '(0)'.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ManagedInstanceWithGeoDRMoveToInstancePoolNotAllowed - Customer has attempted to move a standalone Managed Instance with an existing auto-failover group configured into an instance pool, which is not supported. Only standalone instances without existing auto-failover groups configured can be moved to instance pools.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerRegion - Creation of ZoneRedundant SQL MI is temporarily disabled on this region. You can create Zone Redundant SQL Managed Instances in many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerHardwareGeneration - Creation of ZoneRedundant SQL MI is temporarily disabled for this hardware generation on this region. You can create Zone Redundant SQL Managed Instances with different hardware generation on this region or many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceUpdateSloGeoPrimaryWithNewerVersionEditionThanSecondary - Database format change must be performed on the secondary instance of the failover group first. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 ManagedInstanceFreemiumInstanceAlreadyExists - Only one free SQL Managed Instance is allowed per subscription.\n\n * 400 ManagementServiceGeodrSecondaryDatabaseInCreation - The '{0}' operation cannot be completed as there exists a database in a process of creation through failover group deployment. Please wait for the failover group deployment to complete, or alternatively delete the failover group and retry the operation again.\n\n * 400 ManagedInstanceConversionRegularToFreemiumNotAllowed - User tried converting a Regular SQL Managed Instance to Free SQL Managed Instance.\n\n * 400 ManagedInstanceConversionFreemiumToRegularAndUpdateSLOWhileStoppedNotAllowed - User tried converting a Free SQL Managed Instance to Regular SQL Managed Instance and Update SLO in same request, while Instance is stopped.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 ManagedInstanceMaintenanceWindowChangeNotAllowedWhenInInstancePool - Maintenance window is set at instance pool level and cannot be set individually per pooled instance.\n\n * 400 ManagedInstanceMoveToInstancePoolExceedsDbCountLimit - Cannot move the instance into the pool due to pool database count limit.\n\n * 400 ManagedInstancePoolZoneRedundancyNotSupported - Cannot move a zone-redundant instance into the pool as zone-redundancy is not supported in pools.\n\n * 400 DeploymentIntoPrivateSubnetsNotAllowed - Deploying managed instances and instance pools into private subnets is not supported.\n\n * 400 StorageIOpsNotSupported - Storage IOps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidCollation - Invalid collation.\n\n * 400 StorageThroughputMBpsNotSupported - Storage throughput MBps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 StorageIOpsNotSupportedForSpecifiedEdition - Storage IOps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 StorageThroughputMBpsNotSupportedForSpecifiedEdition - Storage throughput MBps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 ManagedInstanceClassicVnetNotSupported - Managed Instance cannot be joined to a classic virtual network.\n\n * 400 AlterDbDeactivatedNotSupported - Database Operation failed for Server '{0}', Database '{1}' due to unexpected delay. Please try again.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetConfigHasNsg - User tried to inject Managed Server subnet with Network Security Groups.\n\n * 400 VnetConfigHasNoUdr - User tried to inject Managed Server subnet without default User Defined Route Table.\n\n * 400 VnetConfigHasInvalidUdr - User tried to inject Managed Server subnet with invalid User Defined Route Table.\n\n * 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.\n\n * 400 VnetConfigHasServiceEndpoints - User tried to inject Managed Server subnet with service endpoints.\n\n * 400 VnetSubnetIsInUse - User tried to inject Managed Server subnet that is not empty.\n\n * 400 VnetSubnetIsLocked - User tried to inject Managed Server subnet that is in locked scope.\n\n * 400 VnetSubnetIsGateway - User tried to inject Managed Server subnet that is Gateway subnet.\n\n * 400 VnetSubnetIsUnknown - User tried to inject Managed Server subnet that does not exist.\n\n * 400 VnetSubnetConflictWithIntendedPolicy - User tried to inject Managed Server subnet that has a conflict with IntendedPolicy.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 ManagedInstanceInvalidEditionForSku - The specified edition {0} is not consistent with the specified SKU {1}.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInCreateOfMI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the create operation.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagedInstanceInvalidLicenseType - The specified license type {0} is not valid.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInUpdateOfGPV1MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V1 Managed Instance.\n\n * 400 UnspecifiedTargetEditionAndFalseGPV2NotAllowedInUpdateOfGPV2MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value FALSE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 GPTargetEditionAndUnspecifiedGPV2NotAllowedInUpdateOFGPV2MI - Combination of General Purpose target edition (sku.name/sku.tier parameters) and unspecified value for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 BCTargetEditionAndSpecifiedGPV2ParamNotAllowedInCreateUpdateOfMI - Combination of Business Critical target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the create/update operation.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 UnspecifiedTargetEditionAndSpecifiedGPV2ParamNotAllowedInUpdateOfBCMI - Combination of unspecified target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the update operation of Business Critical Managed Instance.\n\n * 400 TotalMemoryMBNotSupported - Total memory MB parameter is not allowed in the instance create/update operation.\n\n * 400 TotalMemoryMBNotSupportedForSpecifiedEdition - Total memory MB parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 VnetResourceNotFound - Resource not found: '{0}'.\n\n * 400 InvalidTimezone - Invalid timezone.\n\n * 400 InvalidSubnetForGPV2Edition - General Purpose v2 edition of Managed Instance is not compatible with the specified subnet. Target subnet must be either empty, or all instances in it must run with November 2022 Feature Wave.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 TotalMemoryMBInvalidLimit - Total memory MB parameter has been set to an invalid limit.\n\n * 400 ManagedInstanceUpdateSloGPv2PerDatabaseFileLimitExceeded - The operation could not be completed because there is at least one database whose number of files is exceeding the limit of {0} files per database on General Purpose v2 edition.\n\n * 400 InstanceCollationUpdateNotSupported - User cannot change instance collation on Managed Instance.\n\n * 400 NextGenGPNotSupportedForCmwCustomers - Next-Gen General Purpose edition of Managed Instance does not support Custom Maintance Window.\n\n * 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - User can create a Managed Instance only with collation 'SQL_Latin1_General_CP1_CI_AS'.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedInstanceExceedMaxAzureStorage - The operation could not be completed because total allocated storage size for General Purpose instance would exceed {0}. Please reduce the number of database files and retry operation.\n\n * 400 ManagedInstanceHasGeoReplica - The operation could not be completed because instance has configured geo replicated secondary instance.\n\n * 400 MissingPublicBlob - The public blob is missing.\n\n * 400 InvalidPublicBlob - Invalid public blob specified, reason: '{0}'.\n\n * 400 MissingCertificateName - The certificate name is missing.\n\n * 400 CertificateAlreadyExists - A certificate with a given name already exists or this certificate already has been added to the database.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 405 InvalidStorageIOpsLimitValue - Invalid storage IOps limit: {0} IOps. Storage IOps limit must be specified between {1} IOps and {2} IOps, in increments of {3} IOps.\n\n * 405 InvalidStorageThroughputMBpsLimitValue - Invalid storage throughput limit: {0} MBps. Storage throughput limit must be specified between {1} MBps and {2} MBps, in increments of {3} MBps.\n\n * 405 InvalidVcoreValue - vCore value {0} is not valid. Please specify a valid vCore value.\n\n * 405 InvalidHardwareGenerationValue - HardwareGeneration {0} is not valid. Please specify a valid HardwareGeneration value.\n\n * 405 InvalidStorageSizeValue - \"Invalid storage size: {0} GB. Storage size must be specified between {1} and {2} gigabytes, in increments of {3} GB.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 409 ServerOverridePreconditionFailed - Failed to apply server override on category '{0}', because physical db or instance '{1}' in server '{2}' is currently not in 'Ready' or 'Deactivated' state.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ManagedInstanceIsBusy - The server '{0}' is currently busy. Please wait a few minutes before trying again.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 GatewayInternalServerError - The server encountered an unexpected exception.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Accepted request for creating server trust certificate." + "description": "Accepted request for creating server trust certificate.", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Certificate is successfully created.", @@ -207,13 +212,18 @@ "description": "Certificate successfully deleted." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidDnsZone - The operation has failed because you are attempting to deploy managed instance as a geo-replication secondary to the subnet {0} in which there already exists a managed instance. Deploying managed instance as a geo-replication secondary is supported only in cases when managed instance is the first instance deployed in a subnet. Consider deploying managed instance as a geo-replication secondary to a different subnet in which there are no existing managed instances, or if deploying to a subnet with existing managed instance disable the geo-replication option.\n\n * 400 HkCannotSwitchToInactive - The database cannot proceed with pricing-tier update as it has memory-optimized objects. Please drop such objects and try again.\n\n * 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - Invalid storage size: Storage size limit ({0} GB) is less that current storage used ({1} GB). Please specify higher storage size limit.\n\n * 400 InstanceTimezoneUpdateNotSupported - Instance timezone update not supported.\n\n * 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - Create Managed Instance with non-default timezone not supported.\n\n * 400 ManagedInstanceIpAddressRangeLimit - Cannot perform creation/scaling of the managed instance as there are not enough available IP addresses in the subnet for performing the operation.\n\n * 400 VnetDelegationNotAllowed - User tried to inject Managed Server to subnet which is delegated.\n\n * 400 SubnetHasResourcesOfDifferentType - User tried to create MI in subnet that has resources of different type.\n\n * 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - Update of Managed Instance with maintenance window settings is not allowed.\n\n * 400 OperationNotAllowedInCurrentGeodrConfiguration - The operation is not allowed because the current geo-replication configuration does not allow this combination of {0}. Change the setting on the geo-replication partner before applying the change on this instance.\n\n * 400 VnetPrepareNIPFailed - User tried to prepare subnet that has a conflict with NetworkIntentPolicy.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 ManagedInstanceDeprecatedHardwareFamily - Changing the hardware generation to deprecated {0} generation is not possible.\n\n * 400 ManagedInstanceBackupStorageTypeNotSupported - Backup storage type parameter is not allowed in the instance update operation.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 EmptyPDCInvalidDnsZone - This managed instance cannot be deployed because its DNS-zone does not match the DNS-prefix of its intended virtual cluster for subnet {0}. Although this virtual cluster is empty, its DNS-prefix cannot be changed. Empty virtual clusters will be automatically removed after several hours. Consider waiting for this virtual cluster to expire or manually deleting this virtual cluster and then creating the managed instance.\n\n * 400 InstancePoolNotEnoughCapacity - An instance pool does not have enough capacity\n\n * 400 ManagedInstanceFreemiumNotAvailableForInputParameters - Managed instance creation or update executed with SLO that is not allowed for freemium.\n\n * 400 ManagedInstanceFreemiumNotAvailableOnRegion - Creation of a freemium managed instance on a region that is not allowlisted for freemium.\n\n * 400 ManagementServiceSubnetMaintenanceInProgress - User tried to initiate managed instance create/update while incompatible maintenance is in progress.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ManagedInstanceFreemiumNotAvailableForSubscription - Freemium is not enabled for this subscription type.\n\n * 400 ManagedInstanceInvalidEditionForInstancePool - User tried to select invalid service tier for managed instance inside an existing instance pool.\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 ManagedInstanceInvalidSubnetForInstancePool - User tried to select invalid subnet for managed instance inside an existing instance pool.\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 ManagedInstanceZoneRedudantFeatureNotSupported - ZoneRedundant feature is not supported for the selected service tier. For more details visit aka.ms/sqlmi-service-tier-characteristics.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - Enabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - Disabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SubnetIdCantBeUpdated - Changing managed instance subnet is not supported operation. Please remove this parameter from the request.\n\n * 400 MigrationToAnotherVNetNotSupported - Selected subnet is in another Virtual Network. Moving managed instance to another Virtual Network is not possible. Please provide subnet from Virtual Network {0}.\n\n * 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - Provided subnet is having different DNS zone from the current. Changing instance DNS zone is not supported. Please provide subnet with same DNS zone, create a new subnet or provide empty one.\n\n * 400 MigrationToGen4SubnetNotSupported - It is not possible to update subnet while running on Gen4 hardware as it is being deprecated. Please upgrade your hardware from Gen4 to Gen5 as part of the changing managed instance subnet operation by specifying both parameters at the same time: destination subnet and hardware generation.\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - The operation could not be completed because some of the database files are exceeding maximum General Purpose file size limit of {0} GB.\n\n * 400 CloudLifterUnsupportedFeature - The functionality is not available on the Managed Instance at this time.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 OperationCanNotStartDueToMiLink - The '{0}' operation cannot be completed as there exists a database in a process of creation through Managed Instance link. Please wait for the link creation to complete, or delete the link, and retry the operation again.\n\n * 400 ManagedInstanceSloUpdateFailed - SLO '{0}' operation cannot succeed as the memory usage of '{1}' exceeds the quota.\n\n * 400 SourceAndTargetSubnetsMustBeVnetPeered - Subnet currently used by managed instance and provided destination subnet are part of the virtual networks that are not connected with virtual network peering, or have peering established but don't have allowed traffic. In order to move managed instance from one subnet to another, virtual network peering needs to be established from both source and target virtual network. Please configure virtual network requirements and then try the operation again. Learn more https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks. \n\n * 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - Subnet provided for managed instance deployment is located on subscription different than the one submitted for managed instance. Managed instance and subnet used for deploying the instance must be on the same subscription. Please provide another subnet or switch to the subnet subscription and then try the operation again.\n\n * 400 CreateManagedInstanceInvalidSubnetSize - User attempted to create managed instance in a subnet that is smaller than the allowed minimal subnet size.\n\n * 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - Subnet selected for managed instance migration has address range that overlaps with address range of subnet that holds geo replicated secondary instance. Please verify that your subnet is configured according to guidelines in https://aka.ms/move-managed-instance. \n\n * 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - Subnet selected for managed instance migration is not configured to enable communication with a geo replicated secondary instance. Please check if all of the required ports are open. To properly configure your subnet read the guidelines in https://aka.ms/move-managed-instance. \n\n * 400 ManagedInstanceLocalStorageUpdateSloDisabled - Update SLO for managed instances with local storage is not supported yet.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 GatewayInvalidEdition - '{0}' is not a valid database edition in this version of SQL Server.\n\n * 400 ManagedInstanceInvalidHardwareFamilyForInstancePool - User tried to select invalid hardware family for managed instance inside an existing instance pool.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 ManagedInstanceInvalidLicenseTypeForInstancePool - User tried to select invalid license type for managed instance inside an existing instance pool.\n\n * 400 ManagedInstanceUpdateSloFromVersionlessToVersionedNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 ManagedInstanceUpdateSloFromNewerToOlderVersionEditionNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 ManagedInstanceUpdateSloFromVersionedToVersionlessWorkerCLNotAllowed - Changing the database format is not supported for this managed instance. Check the database format property value specified and visit https://aka.ms/sqlmi-fwnov2022 for more details.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 ManagedInstanceVersionEditionParameterNotAllowedForUsing - Specifying the database format property value is not supported at this time.\n\n * 400 ManagedInstanceFreemiumInvalidArchitecture - A freemium instance can not be created in the specified subnet '(0)'.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ManagedInstanceGeoDRNotAllowedForInstancePool - Creating auto-failover group (GeoDR) is not supported for Managed Instances provisioned inside instance pools. Auto failover groups can be created only for standalone Managed Instances.\n\n * 400 ManagedInstanceWithGeoDRMoveToInstancePoolNotAllowed - Customer has attempted to move a standalone Managed Instance with an existing auto-failover group configured into an instance pool, which is not supported. Only standalone instances without existing auto-failover groups configured can be moved to instance pools.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerRegion - Creation of ZoneRedundant SQL MI is temporarily disabled on this region. You can create Zone Redundant SQL Managed Instances in many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerHardwareGeneration - Creation of ZoneRedundant SQL MI is temporarily disabled for this hardware generation on this region. You can create Zone Redundant SQL Managed Instances with different hardware generation on this region or many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceUpdateSloGeoPrimaryWithNewerVersionEditionThanSecondary - Database format change must be performed on the secondary instance of the failover group first. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 ManagedInstanceFreemiumInstanceAlreadyExists - Only one free SQL Managed Instance is allowed per subscription.\n\n * 400 ManagementServiceGeodrSecondaryDatabaseInCreation - The '{0}' operation cannot be completed as there exists a database in a process of creation through failover group deployment. Please wait for the failover group deployment to complete, or alternatively delete the failover group and retry the operation again.\n\n * 400 ManagedInstanceConversionRegularToFreemiumNotAllowed - User tried converting a Regular SQL Managed Instance to Free SQL Managed Instance.\n\n * 400 ManagedInstanceConversionFreemiumToRegularAndUpdateSLOWhileStoppedNotAllowed - User tried converting a Free SQL Managed Instance to Regular SQL Managed Instance and Update SLO in same request, while Instance is stopped.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 ManagedInstanceMaintenanceWindowChangeNotAllowedWhenInInstancePool - Maintenance window is set at instance pool level and cannot be set individually per pooled instance.\n\n * 400 ManagedInstanceMoveToInstancePoolExceedsDbCountLimit - Cannot move the instance into the pool due to pool database count limit.\n\n * 400 StorageIOpsNotSupported - Storage IOps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidCollation - Invalid collation.\n\n * 400 StorageThroughputMBpsNotSupported - Storage throughput MBps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 StorageIOpsNotSupportedForSpecifiedEdition - Storage IOps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 StorageThroughputMBpsNotSupportedForSpecifiedEdition - Storage throughput MBps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 ManagedInstanceClassicVnetNotSupported - Managed Instance cannot be joined to a classic virtual network.\n\n * 400 AlterDbDeactivatedNotSupported - Database Operation failed for Server '{0}', Database '{1}' due to unexpected delay. Please try again.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetConfigHasNsg - User tried to inject Managed Server subnet with Network Security Groups.\n\n * 400 VnetConfigHasNoUdr - User tried to inject Managed Server subnet without default User Defined Route Table.\n\n * 400 VnetConfigHasInvalidUdr - User tried to inject Managed Server subnet with invalid User Defined Route Table.\n\n * 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.\n\n * 400 VnetConfigHasServiceEndpoints - User tried to inject Managed Server subnet with service endpoints.\n\n * 400 VnetSubnetIsInUse - User tried to inject Managed Server subnet that is not empty.\n\n * 400 VnetSubnetIsLocked - User tried to inject Managed Server subnet that is in locked scope.\n\n * 400 VnetSubnetIsGateway - User tried to inject Managed Server subnet that is Gateway subnet.\n\n * 400 VnetSubnetIsUnknown - User tried to inject Managed Server subnet that does not exist.\n\n * 400 VnetSubnetConflictWithIntendedPolicy - User tried to inject Managed Server subnet that has a conflict with IntendedPolicy.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 ManagedInstanceInvalidEditionForSku - The specified edition {0} is not consistent with the specified SKU {1}.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInCreateOfMI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the create operation.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagedInstanceInvalidLicenseType - The specified license type {0} is not valid.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInUpdateOfGPV1MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V1 Managed Instance.\n\n * 400 UnspecifiedTargetEditionAndFalseGPV2NotAllowedInUpdateOfGPV2MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value FALSE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 GPTargetEditionAndUnspecifiedGPV2NotAllowedInUpdateOFGPV2MI - Combination of General Purpose target edition (sku.name/sku.tier parameters) and unspecified value for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 BCTargetEditionAndSpecifiedGPV2ParamNotAllowedInCreateUpdateOfMI - Combination of Business Critical target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the create/update operation.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 UnspecifiedTargetEditionAndSpecifiedGPV2ParamNotAllowedInUpdateOfBCMI - Combination of unspecified target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the update operation of Business Critical Managed Instance.\n\n * 400 TotalMemoryMBNotSupported - Total memory MB parameter is not allowed in the instance create/update operation.\n\n * 400 TotalMemoryMBNotSupportedForSpecifiedEdition - Total memory MB parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 VnetResourceNotFound - Resource not found: '{0}'.\n\n * 400 InvalidTimezone - Invalid timezone.\n\n * 400 InvalidSubnetForGPV2Edition - General Purpose v2 edition of Managed Instance is not compatible with the specified subnet. Target subnet must be either empty, or all instances in it must run with November 2022 Feature Wave.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 TotalMemoryMBInvalidLimit - Total memory MB parameter has been set to an invalid limit.\n\n * 400 ManagedInstanceUpdateSloGPv2PerDatabaseFileLimitExceeded - The operation could not be completed because there is at least one database whose number of files is exceeding the limit of {0} files per database on General Purpose v2 edition.\n\n * 400 InstanceCollationUpdateNotSupported - User cannot change instance collation on Managed Instance.\n\n * 400 NextGenGPNotSupportedForCmwCustomers - Next-Gen General Purpose edition of Managed Instance does not support Custom Maintenance Window.\n\n * 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - User can create a Managed Instance only with collation 'SQL_Latin1_General_CP1_CI_AS'.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedInstanceExceedMaxAzureStorage - The operation could not be completed because total allocated storage size for General Purpose instance would exceed {0}. Please reduce the number of database files and retry operation.\n\n * 400 ManagedInstanceHasGeoReplica - The operation could not be completed because instance has configured geo replicated secondary instance.\n\n * 400 MissingCertificateName - The certificate name is missing.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 405 InvalidStorageIOpsLimitValue - Invalid storage IOps limit: {0} IOps. Storage IOps limit must be specified between {1} IOps and {2} IOps, in increments of {3} IOps.\n\n * 405 InvalidStorageThroughputMBpsLimitValue - Invalid storage throughput limit: {0} MBps. Storage throughput limit must be specified between {1} MBps and {2} MBps, in increments of {3} MBps.\n\n * 405 InvalidVcoreValue - vCore value {0} is not valid. Please specify a valid vCore value.\n\n * 405 InvalidHardwareGenerationValue - HardwareGeneration {0} is not valid. Please specify a valid HardwareGeneration value.\n\n * 405 InvalidStorageSizeValue - \"Invalid storage size: {0} GB. Storage size must be specified between {1} and {2} gigabytes, in increments of {3} GB.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 409 ServerOverridePreconditionFailed - Failed to apply server override on category '{0}', because physical db or instance '{1}' in server '{2}' is currently not in 'Ready' or 'Deactivated' state.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ManagedInstanceIsBusy - The server '{0}' is currently busy. Please wait a few minutes before trying again.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 GatewayInternalServerError - The server encountered an unexpected exception.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidDnsZone - The operation has failed because you are attempting to deploy managed instance as a geo-replication secondary to the subnet {0} in which there already exists a managed instance. Deploying managed instance as a geo-replication secondary is supported only in cases when managed instance is the first instance deployed in a subnet. Consider deploying managed instance as a geo-replication secondary to a different subnet in which there are no existing managed instances, or if deploying to a subnet with existing managed instance disable the geo-replication option.\n\n * 400 HkCannotSwitchToInactive - The database cannot proceed with pricing-tier update as it has memory-optimized objects. Please drop such objects and try again.\n\n * 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - Invalid storage size: Storage size limit ({0} GB) is less that current storage used ({1} GB). Please specify higher storage size limit.\n\n * 400 InstanceTimezoneUpdateNotSupported - Instance timezone update not supported.\n\n * 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - Create Managed Instance with non-default timezone not supported.\n\n * 400 ManagedInstanceIpAddressRangeLimit - Cannot perform creation/scaling of the managed instance as there are not enough available IP addresses in the subnet for performing the operation.\n\n * 400 VnetDelegationNotAllowed - User tried to inject Managed Server to subnet which is delegated.\n\n * 400 SubnetHasResourcesOfDifferentType - User tried to create MI in subnet that has resources of different type.\n\n * 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - Update of Managed Instance with maintenance window settings is not allowed.\n\n * 400 OperationNotAllowedInCurrentGeodrConfiguration - The operation is not allowed because the current geo-replication configuration does not allow this combination of {0}. Change the setting on the geo-replication partner before applying the change on this instance.\n\n * 400 VnetPrepareNIPFailed - User tried to prepare subnet that has a conflict with NetworkIntentPolicy.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 ManagedInstanceDeprecatedHardwareFamily - Changing the hardware generation to deprecated {0} generation is not possible.\n\n * 400 ManagedInstanceBackupStorageTypeNotSupported - Backup storage type parameter is not allowed in the instance update operation.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 EmptyPDCInvalidDnsZone - This managed instance cannot be deployed because its DNS-zone does not match the DNS-prefix of its intended virtual cluster for subnet {0}. Although this virtual cluster is empty, its DNS-prefix cannot be changed. Empty virtual clusters will be automatically removed after several hours. Consider waiting for this virtual cluster to expire or manually deleting this virtual cluster and then creating the managed instance.\n\n * 400 InstancePoolNotEnoughCapacity - An instance pool does not have enough capacity\n\n * 400 ManagedInstanceFreemiumNotAvailableForInputParameters - Managed instance creation or update executed with SLO that is not allowed for freemium.\n\n * 400 ManagedInstanceFreemiumNotAvailableOnRegion - Creation of a freemium managed instance on a region that is not allowlisted for freemium.\n\n * 400 ManagementServiceSubnetMaintenanceInProgress - User tried to initiate managed instance create/update while incompatible maintenance is in progress.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ManagedInstanceFreemiumNotAvailableForSubscription - Freemium is not enabled for this subscription type.\n\n * 400 ManagedInstanceInvalidEditionForInstancePool - User tried to select invalid service tier for managed instance inside an existing instance pool.\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 ManagedInstanceInvalidSubnetForInstancePool - User tried to select invalid subnet for managed instance inside an existing instance pool.\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 ManagedInstanceZoneRedudantFeatureNotSupported - ZoneRedundant feature is not supported for the selected service tier. For more details visit aka.ms/sqlmi-service-tier-characteristics.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - Enabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - Disabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SubnetIdCantBeUpdated - Changing managed instance subnet is not supported operation. Please remove this parameter from the request.\n\n * 400 MigrationToAnotherVNetNotSupported - Selected subnet is in another Virtual Network. Moving managed instance to another Virtual Network is not possible. Please provide subnet from Virtual Network {0}.\n\n * 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - Provided subnet is having different DNS zone from the current. Changing instance DNS zone is not supported. Please provide subnet with same DNS zone, create a new subnet or provide empty one.\n\n * 400 MigrationToGen4SubnetNotSupported - It is not possible to update subnet while running on Gen4 hardware as it is being deprecated. Please upgrade your hardware from Gen4 to Gen5 as part of the changing managed instance subnet operation by specifying both parameters at the same time: destination subnet and hardware generation.\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - The operation could not be completed because some of the database files are exceeding maximum General Purpose file size limit of {0} GB.\n\n * 400 CloudLifterUnsupportedFeature - The functionality is not available on the Managed Instance at this time.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 OperationCanNotStartDueToMiLink - The '{0}' operation cannot be completed as there exists a database in a process of creation through Managed Instance link. Please wait for the link creation to complete, or delete the link, and retry the operation again.\n\n * 400 ManagedInstanceSloUpdateFailed - SLO '{0}' operation cannot succeed as the memory usage of '{1}' exceeds the quota.\n\n * 400 SourceAndTargetSubnetsMustBeVnetPeered - Subnet currently used by managed instance and provided destination subnet are part of the virtual networks that are not connected with virtual network peering, or have peering established but don't have allowed traffic. In order to move managed instance from one subnet to another, virtual network peering needs to be established from both source and target virtual network. Please configure virtual network requirements and then try the operation again. Learn more https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks. \n\n * 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - Subnet provided for managed instance deployment is located on subscription different than the one submitted for managed instance. Managed instance and subnet used for deploying the instance must be on the same subscription. Please provide another subnet or switch to the subnet subscription and then try the operation again.\n\n * 400 CreateManagedInstanceInvalidSubnetSize - User attempted to create managed instance in a subnet that is smaller than the allowed minimal subnet size.\n\n * 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - Subnet selected for managed instance migration has address range that overlaps with address range of subnet that holds geo replicated secondary instance. Please verify that your subnet is configured according to guidelines in https://aka.ms/move-managed-instance. \n\n * 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - Subnet selected for managed instance migration is not configured to enable communication with a geo replicated secondary instance. Please check if all of the required ports are open. To properly configure your subnet read the guidelines in https://aka.ms/move-managed-instance. \n\n * 400 ManagedInstanceLocalStorageUpdateSloDisabled - Update SLO for managed instances with local storage is not supported yet.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 GatewayInvalidEdition - '{0}' is not a valid database edition in this version of SQL Server.\n\n * 400 ManagedInstanceInvalidHardwareFamilyForInstancePool - User tried to select invalid hardware family for managed instance inside an existing instance pool.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 ManagedInstanceInvalidLicenseTypeForInstancePool - User tried to select invalid license type for managed instance inside an existing instance pool.\n\n * 400 ManagedInstanceUpdateSloFromVersionlessToVersionedNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 ManagedInstanceUpdateSloFromNewerToOlderVersionEditionNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 ManagedInstanceUpdateSloFromVersionedToVersionlessWorkerCLNotAllowed - Changing the database format is not supported for this managed instance. Check the database format property value specified and visit https://aka.ms/sqlmi-fwnov2022 for more details.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 ManagedInstanceVersionEditionParameterNotAllowedForUsing - Specifying the database format property value is not supported at this time.\n\n * 400 ManagedInstanceFreemiumInvalidArchitecture - A freemium instance can not be created in the specified subnet '(0)'.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ManagedInstanceWithGeoDRMoveToInstancePoolNotAllowed - Customer has attempted to move a standalone Managed Instance with an existing auto-failover group configured into an instance pool, which is not supported. Only standalone instances without existing auto-failover groups configured can be moved to instance pools.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerRegion - Creation of ZoneRedundant SQL MI is temporarily disabled on this region. You can create Zone Redundant SQL Managed Instances in many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerHardwareGeneration - Creation of ZoneRedundant SQL MI is temporarily disabled for this hardware generation on this region. You can create Zone Redundant SQL Managed Instances with different hardware generation on this region or many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceUpdateSloGeoPrimaryWithNewerVersionEditionThanSecondary - Database format change must be performed on the secondary instance of the failover group first. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 ManagedInstanceFreemiumInstanceAlreadyExists - Only one free SQL Managed Instance is allowed per subscription.\n\n * 400 ManagementServiceGeodrSecondaryDatabaseInCreation - The '{0}' operation cannot be completed as there exists a database in a process of creation through failover group deployment. Please wait for the failover group deployment to complete, or alternatively delete the failover group and retry the operation again.\n\n * 400 ManagedInstanceConversionRegularToFreemiumNotAllowed - User tried converting a Regular SQL Managed Instance to Free SQL Managed Instance.\n\n * 400 ManagedInstanceConversionFreemiumToRegularAndUpdateSLOWhileStoppedNotAllowed - User tried converting a Free SQL Managed Instance to Regular SQL Managed Instance and Update SLO in same request, while Instance is stopped.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 ManagedInstanceMaintenanceWindowChangeNotAllowedWhenInInstancePool - Maintenance window is set at instance pool level and cannot be set individually per pooled instance.\n\n * 400 ManagedInstanceMoveToInstancePoolExceedsDbCountLimit - Cannot move the instance into the pool due to pool database count limit.\n\n * 400 ManagedInstancePoolZoneRedundancyNotSupported - Cannot move a zone-redundant instance into the pool as zone-redundancy is not supported in pools.\n\n * 400 DeploymentIntoPrivateSubnetsNotAllowed - Deploying managed instances and instance pools into private subnets is not supported.\n\n * 400 StorageIOpsNotSupported - Storage IOps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidCollation - Invalid collation.\n\n * 400 StorageThroughputMBpsNotSupported - Storage throughput MBps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 StorageIOpsNotSupportedForSpecifiedEdition - Storage IOps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 StorageThroughputMBpsNotSupportedForSpecifiedEdition - Storage throughput MBps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 ManagedInstanceClassicVnetNotSupported - Managed Instance cannot be joined to a classic virtual network.\n\n * 400 AlterDbDeactivatedNotSupported - Database Operation failed for Server '{0}', Database '{1}' due to unexpected delay. Please try again.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetConfigHasNsg - User tried to inject Managed Server subnet with Network Security Groups.\n\n * 400 VnetConfigHasNoUdr - User tried to inject Managed Server subnet without default User Defined Route Table.\n\n * 400 VnetConfigHasInvalidUdr - User tried to inject Managed Server subnet with invalid User Defined Route Table.\n\n * 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.\n\n * 400 VnetConfigHasServiceEndpoints - User tried to inject Managed Server subnet with service endpoints.\n\n * 400 VnetSubnetIsInUse - User tried to inject Managed Server subnet that is not empty.\n\n * 400 VnetSubnetIsLocked - User tried to inject Managed Server subnet that is in locked scope.\n\n * 400 VnetSubnetIsGateway - User tried to inject Managed Server subnet that is Gateway subnet.\n\n * 400 VnetSubnetIsUnknown - User tried to inject Managed Server subnet that does not exist.\n\n * 400 VnetSubnetConflictWithIntendedPolicy - User tried to inject Managed Server subnet that has a conflict with IntendedPolicy.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 ManagedInstanceInvalidEditionForSku - The specified edition {0} is not consistent with the specified SKU {1}.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInCreateOfMI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the create operation.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagedInstanceInvalidLicenseType - The specified license type {0} is not valid.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInUpdateOfGPV1MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V1 Managed Instance.\n\n * 400 UnspecifiedTargetEditionAndFalseGPV2NotAllowedInUpdateOfGPV2MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value FALSE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 GPTargetEditionAndUnspecifiedGPV2NotAllowedInUpdateOFGPV2MI - Combination of General Purpose target edition (sku.name/sku.tier parameters) and unspecified value for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 BCTargetEditionAndSpecifiedGPV2ParamNotAllowedInCreateUpdateOfMI - Combination of Business Critical target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the create/update operation.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 UnspecifiedTargetEditionAndSpecifiedGPV2ParamNotAllowedInUpdateOfBCMI - Combination of unspecified target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the update operation of Business Critical Managed Instance.\n\n * 400 TotalMemoryMBNotSupported - Total memory MB parameter is not allowed in the instance create/update operation.\n\n * 400 TotalMemoryMBNotSupportedForSpecifiedEdition - Total memory MB parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 VnetResourceNotFound - Resource not found: '{0}'.\n\n * 400 InvalidTimezone - Invalid timezone.\n\n * 400 InvalidSubnetForGPV2Edition - General Purpose v2 edition of Managed Instance is not compatible with the specified subnet. Target subnet must be either empty, or all instances in it must run with November 2022 Feature Wave.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 TotalMemoryMBInvalidLimit - Total memory MB parameter has been set to an invalid limit.\n\n * 400 ManagedInstanceUpdateSloGPv2PerDatabaseFileLimitExceeded - The operation could not be completed because there is at least one database whose number of files is exceeding the limit of {0} files per database on General Purpose v2 edition.\n\n * 400 InstanceCollationUpdateNotSupported - User cannot change instance collation on Managed Instance.\n\n * 400 NextGenGPNotSupportedForCmwCustomers - Next-Gen General Purpose edition of Managed Instance does not support Custom Maintance Window.\n\n * 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - User can create a Managed Instance only with collation 'SQL_Latin1_General_CP1_CI_AS'.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedInstanceExceedMaxAzureStorage - The operation could not be completed because total allocated storage size for General Purpose instance would exceed {0}. Please reduce the number of database files and retry operation.\n\n * 400 ManagedInstanceHasGeoReplica - The operation could not be completed because instance has configured geo replicated secondary instance.\n\n * 400 MissingCertificateName - The certificate name is missing.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 405 InvalidStorageIOpsLimitValue - Invalid storage IOps limit: {0} IOps. Storage IOps limit must be specified between {1} IOps and {2} IOps, in increments of {3} IOps.\n\n * 405 InvalidStorageThroughputMBpsLimitValue - Invalid storage throughput limit: {0} MBps. Storage throughput limit must be specified between {1} MBps and {2} MBps, in increments of {3} MBps.\n\n * 405 InvalidVcoreValue - vCore value {0} is not valid. Please specify a valid vCore value.\n\n * 405 InvalidHardwareGenerationValue - HardwareGeneration {0} is not valid. Please specify a valid HardwareGeneration value.\n\n * 405 InvalidStorageSizeValue - \"Invalid storage size: {0} GB. Storage size must be specified between {1} and {2} gigabytes, in increments of {3} GB.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 409 ServerOverridePreconditionFailed - Failed to apply server override on category '{0}', because physical db or instance '{1}' in server '{2}' is currently not in 'Ready' or 'Deactivated' state.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ManagedInstanceIsBusy - The server '{0}' is currently busy. Please wait a few minutes before trying again.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 GatewayInternalServerError - The server encountered an unexpected exception.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Accepted request for deleting server trust certificate." + "description": "Accepted request for deleting server trust certificate.", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "Certificate resource not found." diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerTrustGroups.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerTrustGroups.json index 6ae4853483f0..e7f81d931000 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerTrustGroups.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerTrustGroups.json @@ -171,7 +171,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully created the server trust group.", @@ -229,7 +234,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "The specified server trust group does not exist." diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/Servers.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/Servers.json index d448a30136ca..daec60d9f8cd 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/Servers.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/Servers.json @@ -256,13 +256,18 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 PECsNotExistingToDenyPublicNetworkAccess - Unable to set Deny Public Network Access to Yes since there is no private endpoint enabled to access the server. Please set up private endpoints and retry the operation (https://docs.microsoft.com/azure/sql-database/sql-database-private-endpoint-overview#how-to-set-up-private-link-for-azure-sql-database).\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 Ipv6FeatureNotEnabled - User tried to turn on Ipv6 support on the server without enabling feature flag on subscription, or the feature support is currently disabled in the region.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 CMKOperationNotAllowed - User tried to perform an operation on the server when the server did not have Azure Key Vault Access.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 InvalidMinimalTlsVersion - Invalid minimal TLS version.\n\n * 400 InvalidExternalAdministratorLogin - Invalid or missing external administrator login name.\n\n * 400 InvalidExternalAdministratorSid - Invalid or missing external administrator object id.\n\n * 400 InvalidExternalAdministratorTenantId - Invalid or missing external administrator tenant id.\n\n * 400 ExternalAdministratorPrincipalType - Invalid or missing external administrator principal type. Please select from User, Application or Group.\n\n * 400 MissingExternalAdministratorWithAadOnlyAuth - In order to use Azure AD Only Authentication, please provide details of an external administrator.\n\n * 400 ExternalAdministratorLoginSameAsSqlAdmin - The names of the Azure Active Directory administrator and of the server admin account must be different. Please provide different values.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 UpsertLogicalServerRequestAlreadyInProgress - An ongoing logical server request is already in progress, please try your request again later.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 PECsNotExistingToDenyPublicNetworkAccess - Unable to set Deny Public Network Access to Yes since there is no private endpoint enabled to access the server. Please set up private endpoints and retry the operation (https://docs.microsoft.com/azure/sql-database/sql-database-private-endpoint-overview#how-to-set-up-private-link-for-azure-sql-database).\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 Ipv6FeatureNotEnabled - User tried to turn on Ipv6 support on the server without enabling feature flag on subscription, or the feature support is currently disabled in the region.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 CMKOperationNotAllowed - User tried to perform an operation on the server when the server did not have Azure Key Vault Access.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 InvalidMinimalTlsVersion - Invalid minimal TLS version.\n\n * 400 InvalidExternalAdministratorLogin - Invalid or missing external administrator login name.\n\n * 400 InvalidExternalAdministratorSid - Invalid or missing external administrator object id.\n\n * 400 InvalidExternalAdministratorTenantId - Invalid or missing external administrator tenant id.\n\n * 400 ExternalAdministratorPrincipalType - Invalid or missing external administrator principal type. Please select from User, Application or Group.\n\n * 400 MissingExternalAdministratorWithAadOnlyAuth - In order to use Azure AD Only Authentication, please provide details of an external administrator.\n\n * 400 ExternalAdministratorLoginSameAsSqlAdmin - The names of the Azure Active Directory administrator and of the server admin account must be different. Please provide different values.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 UpsertLogicalServerRequestAlreadyInProgress - An ongoing logical server request is already in progress, please try your request again later.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully created the server.", @@ -303,13 +308,18 @@ "description": "Successfully deleted the server." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 CannotDropDatabaseAKVError - The database {0} on server {1} cannot be safely dropped because it is encrypted with a customer managed key that is no longer accessible to take the last backup before drop. Please restore Azure Key Vault Access on the server and revalidate the keys to make this database accessible and then proceed with the drop. For details see https://aka.ms/tdecmkrestorability\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 DropLogicalServerAlreadyInProgress - Server is already being dropped.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 CannotDropDatabaseAKVError - The database {0} on server {1} cannot be safely dropped because it is encrypted with a customer managed key that is no longer accessible to take the last backup before drop. Please restore Azure Key Vault Access on the server and revalidate the keys to make this database accessible and then proceed with the drop. For details see https://aka.ms/tdecmkrestorability\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 DropLogicalServerAlreadyInProgress - Server is already being dropped.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "The specified server does not exist." @@ -359,13 +369,18 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 PECsNotExistingToDenyPublicNetworkAccess - Unable to set Deny Public Network Access to Yes since there is no private endpoint enabled to access the server. Please set up private endpoints and retry the operation (https://docs.microsoft.com/azure/sql-database/sql-database-private-endpoint-overview#how-to-set-up-private-link-for-azure-sql-database).\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 Ipv6FeatureNotEnabled - User tried to turn on Ipv6 support on the server without enabling feature flag on subscription, or the feature support is currently disabled in the region.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 CMKOperationNotAllowed - User tried to perform an operation on the server when the server did not have Azure Key Vault Access.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 InvalidMinimalTlsVersion - Invalid minimal TLS version.\n\n * 400 InvalidExternalAdministratorLogin - Invalid or missing external administrator login name.\n\n * 400 InvalidExternalAdministratorSid - Invalid or missing external administrator object id.\n\n * 400 InvalidExternalAdministratorTenantId - Invalid or missing external administrator tenant id.\n\n * 400 ExternalAdministratorPrincipalType - Invalid or missing external administrator principal type. Please select from User, Application or Group.\n\n * 400 MissingExternalAdministratorWithAadOnlyAuth - In order to use Azure AD Only Authentication, please provide details of an external administrator.\n\n * 400 ExternalAdministratorLoginSameAsSqlAdmin - The names of the Azure Active Directory administrator and of the server admin account must be different. Please provide different values.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 UpsertLogicalServerRequestAlreadyInProgress - An ongoing logical server request is already in progress, please try your request again later.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 PECsNotExistingToDenyPublicNetworkAccess - Unable to set Deny Public Network Access to Yes since there is no private endpoint enabled to access the server. Please set up private endpoints and retry the operation (https://docs.microsoft.com/azure/sql-database/sql-database-private-endpoint-overview#how-to-set-up-private-link-for-azure-sql-database).\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 Ipv6FeatureNotEnabled - User tried to turn on Ipv6 support on the server without enabling feature flag on subscription, or the feature support is currently disabled in the region.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 CMKOperationNotAllowed - User tried to perform an operation on the server when the server did not have Azure Key Vault Access.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 InvalidMinimalTlsVersion - Invalid minimal TLS version.\n\n * 400 InvalidExternalAdministratorLogin - Invalid or missing external administrator login name.\n\n * 400 InvalidExternalAdministratorSid - Invalid or missing external administrator object id.\n\n * 400 InvalidExternalAdministratorTenantId - Invalid or missing external administrator tenant id.\n\n * 400 ExternalAdministratorPrincipalType - Invalid or missing external administrator principal type. Please select from User, Application or Group.\n\n * 400 MissingExternalAdministratorWithAadOnlyAuth - In order to use Azure AD Only Authentication, please provide details of an external administrator.\n\n * 400 ExternalAdministratorLoginSameAsSqlAdmin - The names of the Azure Active Directory administrator and of the server admin account must be different. Please provide different values.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 UpsertLogicalServerRequestAlreadyInProgress - An ongoing logical server request is already in progress, please try your request again later.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -420,7 +435,12 @@ } }, "202": { - "description": "Importing the database is in progress." + "description": "Importing the database is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -466,13 +486,18 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } }, "202": { - "description": "Refreshing external governance enablement status." + "description": "Refreshing external governance enablement status.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/SqlVulnerabilityAssessmentExecuteScan.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/SqlVulnerabilityAssessmentExecuteScan.json index 694b863ac6f0..628354130483 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/SqlVulnerabilityAssessmentExecuteScan.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/SqlVulnerabilityAssessmentExecuteScan.json @@ -76,7 +76,12 @@ } }, "202": { - "description": "Successfully started a Vulnerability Assessment database scan." + "description": "Successfully started a Vulnerability Assessment database scan.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/SyncAgents.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/SyncAgents.json index a918648c692a..da127cc93868 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/SyncAgents.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/SyncAgents.json @@ -171,7 +171,12 @@ } }, "202": { - "description": "Creating or updating the sync agent is in progress." + "description": "Creating or updating the sync agent is in progress.", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully created the sync agent.", @@ -232,7 +237,12 @@ } }, "202": { - "description": "Deleting the sync agent is in progress." + "description": "Deleting the sync agent is in progress.", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "The specified sync agent does not exist." diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/SyncGroups.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/SyncGroups.json index efe646ce621a..7d578d10406f 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/SyncGroups.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/SyncGroups.json @@ -226,7 +226,12 @@ } }, "202": { - "description": "Creating or updating the sync group is in progress." + "description": "Creating or updating the sync group is in progress.", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully created the sync group.", @@ -290,7 +295,12 @@ } }, "202": { - "description": "Deleting the sync group is in progress." + "description": "Deleting the sync group is in progress.", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "The specified sync group does not exist." @@ -360,7 +370,12 @@ } }, "202": { - "description": "Updating the sync group is in progress." + "description": "Updating the sync group is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -626,7 +641,12 @@ } }, "202": { - "description": "The sync hub schema refresh operation is on going." + "description": "The sync hub schema refresh operation is on going.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/SyncMembers.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/SyncMembers.json index d5e6e4f707d1..7a19eb3182d4 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/SyncMembers.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/SyncMembers.json @@ -201,7 +201,12 @@ } }, "202": { - "description": "Creating or updating the sync member is in progress." + "description": "Creating or updating the sync member is in progress.", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully created the sync member.", @@ -272,7 +277,12 @@ } }, "202": { - "description": "Deleting the sync member is in progress." + "description": "Deleting the sync member is in progress.", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "The specified sync member does not exist." @@ -349,7 +359,12 @@ } }, "202": { - "description": "Updating the sync member is in progress." + "description": "Updating the sync member is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -413,7 +428,12 @@ } }, "202": { - "description": "The sync member schema refresh operation is on going." + "description": "The sync member schema refresh operation is on going.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/TdeCertificates.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/TdeCertificates.json index 6f1890b60561..e0d5a91c6564 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/TdeCertificates.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/TdeCertificates.json @@ -57,7 +57,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/TimeZones.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/TimeZones.json index 2103866e9243..c623527a4f7c 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/TimeZones.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/TimeZones.json @@ -45,7 +45,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidDnsZone - The operation has failed because you are attempting to deploy managed instance as a geo-replication secondary to the subnet {0} in which there already exists a managed instance. Deploying managed instance as a geo-replication secondary is supported only in cases when managed instance is the first instance deployed in a subnet. Consider deploying managed instance as a geo-replication secondary to a different subnet in which there are no existing managed instances, or if deploying to a subnet with existing managed instance disable the geo-replication option.\n\n * 400 HkCannotSwitchToInactive - The database cannot proceed with pricing-tier update as it has memory-optimized objects. Please drop such objects and try again.\n\n * 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - Invalid storage size: Storage size limit ({0} GB) is less that current storage used ({1} GB). Please specify higher storage size limit.\n\n * 400 InstanceTimezoneUpdateNotSupported - Instance timezone update not supported.\n\n * 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - Create Managed Instance with non-default timezone not supported.\n\n * 400 ManagedInstanceIpAddressRangeLimit - Cannot perform creation/scaling of the managed instance as there are not enough available IP addresses in the subnet for performing the operation.\n\n * 400 VnetDelegationNotAllowed - User tried to inject Managed Server to subnet which is delegated.\n\n * 400 SubnetHasResourcesOfDifferentType - User tried to create MI in subnet that has resources of different type.\n\n * 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - Update of Managed Instance with maintenance window settings is not allowed.\n\n * 400 OperationNotAllowedInCurrentGeodrConfiguration - The operation is not allowed because the current geo-replication configuration does not allow this combination of {0}. Change the setting on the geo-replication partner before applying the change on this instance.\n\n * 400 VnetPrepareNIPFailed - User tried to prepare subnet that has a conflict with NetworkIntentPolicy.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 ManagedInstanceDeprecatedHardwareFamily - Changing the hardware generation to deprecated {0} generation is not possible.\n\n * 400 ManagedInstanceBackupStorageTypeNotSupported - Backup storage type parameter is not allowed in the instance update operation.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 EmptyPDCInvalidDnsZone - This managed instance cannot be deployed because its DNS-zone does not match the DNS-prefix of its intended virtual cluster for subnet {0}. Although this virtual cluster is empty, its DNS-prefix cannot be changed. Empty virtual clusters will be automatically removed after several hours. Consider waiting for this virtual cluster to expire or manually deleting this virtual cluster and then creating the managed instance.\n\n * 400 InstancePoolNotEnoughCapacity - An instance pool does not have enough capacity\n\n * 400 ManagedInstanceFreemiumNotAvailableForInputParameters - Managed instance creation or update executed with SLO that is not allowed for freemium.\n\n * 400 ManagedInstanceFreemiumNotAvailableOnRegion - Creation of a freemium managed instance on a region that is not allowlisted for freemium.\n\n * 400 ManagementServiceSubnetMaintenanceInProgress - User tried to initiate managed instance create/update while incompatible maintenance is in progress.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ManagedInstanceFreemiumNotAvailableForSubscription - Freemium is not enabled for this subscription type.\n\n * 400 ManagedInstanceInvalidEditionForInstancePool - User tried to select invalid service tier for managed instance inside an existing instance pool.\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 ManagedInstanceInvalidSubnetForInstancePool - User tried to select invalid subnet for managed instance inside an existing instance pool.\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 ManagedInstanceZoneRedudantFeatureNotSupported - ZoneRedundant feature is not supported for the selected service tier. For more details visit aka.ms/sqlmi-service-tier-characteristics.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - Enabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - Disabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SubnetIdCantBeUpdated - Changing managed instance subnet is not supported operation. Please remove this parameter from the request.\n\n * 400 MigrationToAnotherVNetNotSupported - Selected subnet is in another Virtual Network. Moving managed instance to another Virtual Network is not possible. Please provide subnet from Virtual Network {0}.\n\n * 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - Provided subnet is having different DNS zone from the current. Changing instance DNS zone is not supported. Please provide subnet with same DNS zone, create a new subnet or provide empty one.\n\n * 400 MigrationToGen4SubnetNotSupported - It is not possible to update subnet while running on Gen4 hardware as it is being deprecated. Please upgrade your hardware from Gen4 to Gen5 as part of the changing managed instance subnet operation by specifying both parameters at the same time: destination subnet and hardware generation.\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - The operation could not be completed because some of the database files are exceeding maximum General Purpose file size limit of {0} GB.\n\n * 400 CloudLifterUnsupportedFeature - The functionality is not available on the Managed Instance at this time.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 OperationCanNotStartDueToMiLink - The '{0}' operation cannot be completed as there exists a database in a process of creation through Managed Instance link. Please wait for the link creation to complete, or delete the link, and retry the operation again.\n\n * 400 ManagedInstanceSloUpdateFailed - SLO '{0}' operation cannot succeed as the memory usage of '{1}' exceeds the quota.\n\n * 400 SourceAndTargetSubnetsMustBeVnetPeered - Subnet currently used by managed instance and provided destination subnet are part of the virtual networks that are not connected with virtual network peering, or have peering established but don't have allowed traffic. In order to move managed instance from one subnet to another, virtual network peering needs to be established from both source and target virtual network. Please configure virtual network requirements and then try the operation again. Learn more https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks. \n\n * 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - Subnet provided for managed instance deployment is located on subscription different than the one submitted for managed instance. Managed instance and subnet used for deploying the instance must be on the same subscription. Please provide another subnet or switch to the subnet subscription and then try the operation again.\n\n * 400 CreateManagedInstanceInvalidSubnetSize - User attempted to create managed instance in a subnet that is smaller than the allowed minimal subnet size.\n\n * 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - Subnet selected for managed instance migration has address range that overlaps with address range of subnet that holds geo replicated secondary instance. Please verify that your subnet is configured according to guidelines in https://aka.ms/move-managed-instance. \n\n * 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - Subnet selected for managed instance migration is not configured to enable communication with a geo replicated secondary instance. Please check if all of the required ports are open. To properly configure your subnet read the guidelines in https://aka.ms/move-managed-instance. \n\n * 400 ManagedInstanceLocalStorageUpdateSloDisabled - Update SLO for managed instances with local storage is not supported yet.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 GatewayInvalidEdition - '{0}' is not a valid database edition in this version of SQL Server.\n\n * 400 ManagedInstanceInvalidHardwareFamilyForInstancePool - User tried to select invalid hardware family for managed instance inside an existing instance pool.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 ManagedInstanceInvalidLicenseTypeForInstancePool - User tried to select invalid license type for managed instance inside an existing instance pool.\n\n * 400 ManagedInstanceUpdateSloFromVersionlessToVersionedNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 ManagedInstanceUpdateSloFromNewerToOlderVersionEditionNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 ManagedInstanceUpdateSloFromVersionedToVersionlessWorkerCLNotAllowed - Changing the database format is not supported for this managed instance. Check the database format property value specified and visit https://aka.ms/sqlmi-fwnov2022 for more details.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 ManagedInstanceVersionEditionParameterNotAllowedForUsing - Specifying the database format property value is not supported at this time.\n\n * 400 ManagedInstanceFreemiumInvalidArchitecture - A freemium instance can not be created in the specified subnet '(0)'.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ManagedInstanceGeoDRNotAllowedForInstancePool - Creating auto-failover group (GeoDR) is not supported for Managed Instances provisioned inside instance pools. Auto failover groups can be created only for standalone Managed Instances.\n\n * 400 ManagedInstanceWithGeoDRMoveToInstancePoolNotAllowed - Customer has attempted to move a standalone Managed Instance with an existing auto-failover group configured into an instance pool, which is not supported. Only standalone instances without existing auto-failover groups configured can be moved to instance pools.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerRegion - Creation of ZoneRedundant SQL MI is temporarily disabled on this region. You can create Zone Redundant SQL Managed Instances in many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerHardwareGeneration - Creation of ZoneRedundant SQL MI is temporarily disabled for this hardware generation on this region. You can create Zone Redundant SQL Managed Instances with different hardware generation on this region or many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceUpdateSloGeoPrimaryWithNewerVersionEditionThanSecondary - Database format change must be performed on the secondary instance of the failover group first. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 ManagedInstanceFreemiumInstanceAlreadyExists - Only one free SQL Managed Instance is allowed per subscription.\n\n * 400 ManagementServiceGeodrSecondaryDatabaseInCreation - The '{0}' operation cannot be completed as there exists a database in a process of creation through failover group deployment. Please wait for the failover group deployment to complete, or alternatively delete the failover group and retry the operation again.\n\n * 400 ManagedInstanceConversionRegularToFreemiumNotAllowed - User tried converting a Regular SQL Managed Instance to Free SQL Managed Instance.\n\n * 400 ManagedInstanceConversionFreemiumToRegularAndUpdateSLOWhileStoppedNotAllowed - User tried converting a Free SQL Managed Instance to Regular SQL Managed Instance and Update SLO in same request, while Instance is stopped.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 ManagedInstanceMaintenanceWindowChangeNotAllowedWhenInInstancePool - Maintenance window is set at instance pool level and cannot be set individually per pooled instance.\n\n * 400 ManagedInstanceMoveToInstancePoolExceedsDbCountLimit - Cannot move the instance into the pool due to pool database count limit.\n\n * 400 StorageIOpsNotSupported - Storage IOps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidCollation - Invalid collation.\n\n * 400 StorageThroughputMBpsNotSupported - Storage throughput MBps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 StorageIOpsNotSupportedForSpecifiedEdition - Storage IOps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 StorageThroughputMBpsNotSupportedForSpecifiedEdition - Storage throughput MBps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 ManagedInstanceClassicVnetNotSupported - Managed Instance cannot be joined to a classic virtual network.\n\n * 400 AlterDbDeactivatedNotSupported - Database Operation failed for Server '{0}', Database '{1}' due to unexpected delay. Please try again.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetConfigHasNsg - User tried to inject Managed Server subnet with Network Security Groups.\n\n * 400 VnetConfigHasNoUdr - User tried to inject Managed Server subnet without default User Defined Route Table.\n\n * 400 VnetConfigHasInvalidUdr - User tried to inject Managed Server subnet with invalid User Defined Route Table.\n\n * 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.\n\n * 400 VnetConfigHasServiceEndpoints - User tried to inject Managed Server subnet with service endpoints.\n\n * 400 VnetSubnetIsInUse - User tried to inject Managed Server subnet that is not empty.\n\n * 400 VnetSubnetIsLocked - User tried to inject Managed Server subnet that is in locked scope.\n\n * 400 VnetSubnetIsGateway - User tried to inject Managed Server subnet that is Gateway subnet.\n\n * 400 VnetSubnetIsUnknown - User tried to inject Managed Server subnet that does not exist.\n\n * 400 VnetSubnetConflictWithIntendedPolicy - User tried to inject Managed Server subnet that has a conflict with IntendedPolicy.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 ManagedInstanceInvalidEditionForSku - The specified edition {0} is not consistent with the specified SKU {1}.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInCreateOfMI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the create operation.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagedInstanceInvalidLicenseType - The specified license type {0} is not valid.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInUpdateOfGPV1MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V1 Managed Instance.\n\n * 400 UnspecifiedTargetEditionAndFalseGPV2NotAllowedInUpdateOfGPV2MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value FALSE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 GPTargetEditionAndUnspecifiedGPV2NotAllowedInUpdateOFGPV2MI - Combination of General Purpose target edition (sku.name/sku.tier parameters) and unspecified value for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 BCTargetEditionAndSpecifiedGPV2ParamNotAllowedInCreateUpdateOfMI - Combination of Business Critical target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the create/update operation.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 UnspecifiedTargetEditionAndSpecifiedGPV2ParamNotAllowedInUpdateOfBCMI - Combination of unspecified target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the update operation of Business Critical Managed Instance.\n\n * 400 TotalMemoryMBNotSupported - Total memory MB parameter is not allowed in the instance create/update operation.\n\n * 400 TotalMemoryMBNotSupportedForSpecifiedEdition - Total memory MB parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 VnetResourceNotFound - Resource not found: '{0}'.\n\n * 400 InvalidTimezone - Invalid timezone.\n\n * 400 InvalidSubnetForGPV2Edition - General Purpose v2 edition of Managed Instance is not compatible with the specified subnet. Target subnet must be either empty, or all instances in it must run with November 2022 Feature Wave.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 TotalMemoryMBInvalidLimit - Total memory MB parameter has been set to an invalid limit.\n\n * 400 ManagedInstanceUpdateSloGPv2PerDatabaseFileLimitExceeded - The operation could not be completed because there is at least one database whose number of files is exceeding the limit of {0} files per database on General Purpose v2 edition.\n\n * 400 InstanceCollationUpdateNotSupported - User cannot change instance collation on Managed Instance.\n\n * 400 NextGenGPNotSupportedForCmwCustomers - Next-Gen General Purpose edition of Managed Instance does not support Custom Maintenance Window.\n\n * 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - User can create a Managed Instance only with collation 'SQL_Latin1_General_CP1_CI_AS'.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedInstanceExceedMaxAzureStorage - The operation could not be completed because total allocated storage size for General Purpose instance would exceed {0}. Please reduce the number of database files and retry operation.\n\n * 400 ManagedInstanceHasGeoReplica - The operation could not be completed because instance has configured geo replicated secondary instance.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 405 InvalidStorageIOpsLimitValue - Invalid storage IOps limit: {0} IOps. Storage IOps limit must be specified between {1} IOps and {2} IOps, in increments of {3} IOps.\n\n * 405 InvalidStorageThroughputMBpsLimitValue - Invalid storage throughput limit: {0} MBps. Storage throughput limit must be specified between {1} MBps and {2} MBps, in increments of {3} MBps.\n\n * 405 InvalidVcoreValue - vCore value {0} is not valid. Please specify a valid vCore value.\n\n * 405 InvalidHardwareGenerationValue - HardwareGeneration {0} is not valid. Please specify a valid HardwareGeneration value.\n\n * 405 InvalidStorageSizeValue - \"Invalid storage size: {0} GB. Storage size must be specified between {1} and {2} gigabytes, in increments of {3} GB.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 409 ServerOverridePreconditionFailed - Failed to apply server override on category '{0}', because physical db or instance '{1}' in server '{2}' is currently not in 'Ready' or 'Deactivated' state.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ManagedInstanceIsBusy - The server '{0}' is currently busy. Please wait a few minutes before trying again.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 GatewayInternalServerError - The server encountered an unexpected exception.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 InvalidDnsZone - The operation has failed because you are attempting to deploy managed instance as a geo-replication secondary to the subnet {0} in which there already exists a managed instance. Deploying managed instance as a geo-replication secondary is supported only in cases when managed instance is the first instance deployed in a subnet. Consider deploying managed instance as a geo-replication secondary to a different subnet in which there are no existing managed instances, or if deploying to a subnet with existing managed instance disable the geo-replication option.\n\n * 400 HkCannotSwitchToInactive - The database cannot proceed with pricing-tier update as it has memory-optimized objects. Please drop such objects and try again.\n\n * 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - Invalid storage size: Storage size limit ({0} GB) is less that current storage used ({1} GB). Please specify higher storage size limit.\n\n * 400 InstanceTimezoneUpdateNotSupported - Instance timezone update not supported.\n\n * 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - Create Managed Instance with non-default timezone not supported.\n\n * 400 ManagedInstanceIpAddressRangeLimit - Cannot perform creation/scaling of the managed instance as there are not enough available IP addresses in the subnet for performing the operation.\n\n * 400 VnetDelegationNotAllowed - User tried to inject Managed Server to subnet which is delegated.\n\n * 400 SubnetHasResourcesOfDifferentType - User tried to create MI in subnet that has resources of different type.\n\n * 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - Update of Managed Instance with maintenance window settings is not allowed.\n\n * 400 OperationNotAllowedInCurrentGeodrConfiguration - The operation is not allowed because the current geo-replication configuration does not allow this combination of {0}. Change the setting on the geo-replication partner before applying the change on this instance.\n\n * 400 VnetPrepareNIPFailed - User tried to prepare subnet that has a conflict with NetworkIntentPolicy.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 ManagedInstanceDeprecatedHardwareFamily - Changing the hardware generation to deprecated {0} generation is not possible.\n\n * 400 ManagedInstanceBackupStorageTypeNotSupported - Backup storage type parameter is not allowed in the instance update operation.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 EmptyPDCInvalidDnsZone - This managed instance cannot be deployed because its DNS-zone does not match the DNS-prefix of its intended virtual cluster for subnet {0}. Although this virtual cluster is empty, its DNS-prefix cannot be changed. Empty virtual clusters will be automatically removed after several hours. Consider waiting for this virtual cluster to expire or manually deleting this virtual cluster and then creating the managed instance.\n\n * 400 InstancePoolNotEnoughCapacity - An instance pool does not have enough capacity\n\n * 400 ManagedInstanceFreemiumNotAvailableForInputParameters - Managed instance creation or update executed with SLO that is not allowed for freemium.\n\n * 400 ManagedInstanceFreemiumNotAvailableOnRegion - Creation of a freemium managed instance on a region that is not allowlisted for freemium.\n\n * 400 ManagementServiceSubnetMaintenanceInProgress - User tried to initiate managed instance create/update while incompatible maintenance is in progress.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ManagedInstanceFreemiumNotAvailableForSubscription - Freemium is not enabled for this subscription type.\n\n * 400 ManagedInstanceInvalidEditionForInstancePool - User tried to select invalid service tier for managed instance inside an existing instance pool.\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 ManagedInstanceInvalidSubnetForInstancePool - User tried to select invalid subnet for managed instance inside an existing instance pool.\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 ManagedInstanceZoneRedudantFeatureNotSupported - ZoneRedundant feature is not supported for the selected service tier. For more details visit aka.ms/sqlmi-service-tier-characteristics.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - Enabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - Disabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SubnetIdCantBeUpdated - Changing managed instance subnet is not supported operation. Please remove this parameter from the request.\n\n * 400 MigrationToAnotherVNetNotSupported - Selected subnet is in another Virtual Network. Moving managed instance to another Virtual Network is not possible. Please provide subnet from Virtual Network {0}.\n\n * 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - Provided subnet is having different DNS zone from the current. Changing instance DNS zone is not supported. Please provide subnet with same DNS zone, create a new subnet or provide empty one.\n\n * 400 MigrationToGen4SubnetNotSupported - It is not possible to update subnet while running on Gen4 hardware as it is being deprecated. Please upgrade your hardware from Gen4 to Gen5 as part of the changing managed instance subnet operation by specifying both parameters at the same time: destination subnet and hardware generation.\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - The operation could not be completed because some of the database files are exceeding maximum General Purpose file size limit of {0} GB.\n\n * 400 CloudLifterUnsupportedFeature - The functionality is not available on the Managed Instance at this time.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 OperationCanNotStartDueToMiLink - The '{0}' operation cannot be completed as there exists a database in a process of creation through Managed Instance link. Please wait for the link creation to complete, or delete the link, and retry the operation again.\n\n * 400 ManagedInstanceSloUpdateFailed - SLO '{0}' operation cannot succeed as the memory usage of '{1}' exceeds the quota.\n\n * 400 SourceAndTargetSubnetsMustBeVnetPeered - Subnet currently used by managed instance and provided destination subnet are part of the virtual networks that are not connected with virtual network peering, or have peering established but don't have allowed traffic. In order to move managed instance from one subnet to another, virtual network peering needs to be established from both source and target virtual network. Please configure virtual network requirements and then try the operation again. Learn more https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks. \n\n * 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - Subnet provided for managed instance deployment is located on subscription different than the one submitted for managed instance. Managed instance and subnet used for deploying the instance must be on the same subscription. Please provide another subnet or switch to the subnet subscription and then try the operation again.\n\n * 400 CreateManagedInstanceInvalidSubnetSize - User attempted to create managed instance in a subnet that is smaller than the allowed minimal subnet size.\n\n * 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - Subnet selected for managed instance migration has address range that overlaps with address range of subnet that holds geo replicated secondary instance. Please verify that your subnet is configured according to guidelines in https://aka.ms/move-managed-instance. \n\n * 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - Subnet selected for managed instance migration is not configured to enable communication with a geo replicated secondary instance. Please check if all of the required ports are open. To properly configure your subnet read the guidelines in https://aka.ms/move-managed-instance. \n\n * 400 ManagedInstanceLocalStorageUpdateSloDisabled - Update SLO for managed instances with local storage is not supported yet.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 GatewayInvalidEdition - '{0}' is not a valid database edition in this version of SQL Server.\n\n * 400 ManagedInstanceInvalidHardwareFamilyForInstancePool - User tried to select invalid hardware family for managed instance inside an existing instance pool.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 ManagedInstanceInvalidLicenseTypeForInstancePool - User tried to select invalid license type for managed instance inside an existing instance pool.\n\n * 400 ManagedInstanceUpdateSloFromVersionlessToVersionedNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 ManagedInstanceUpdateSloFromNewerToOlderVersionEditionNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 ManagedInstanceUpdateSloFromVersionedToVersionlessWorkerCLNotAllowed - Changing the database format is not supported for this managed instance. Check the database format property value specified and visit https://aka.ms/sqlmi-fwnov2022 for more details.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 ManagedInstanceVersionEditionParameterNotAllowedForUsing - Specifying the database format property value is not supported at this time.\n\n * 400 ManagedInstanceFreemiumInvalidArchitecture - A freemium instance can not be created in the specified subnet '(0)'.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ManagedInstanceWithGeoDRMoveToInstancePoolNotAllowed - Customer has attempted to move a standalone Managed Instance with an existing auto-failover group configured into an instance pool, which is not supported. Only standalone instances without existing auto-failover groups configured can be moved to instance pools.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerRegion - Creation of ZoneRedundant SQL MI is temporarily disabled on this region. You can create Zone Redundant SQL Managed Instances in many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerHardwareGeneration - Creation of ZoneRedundant SQL MI is temporarily disabled for this hardware generation on this region. You can create Zone Redundant SQL Managed Instances with different hardware generation on this region or many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceUpdateSloGeoPrimaryWithNewerVersionEditionThanSecondary - Database format change must be performed on the secondary instance of the failover group first. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 ManagedInstanceFreemiumInstanceAlreadyExists - Only one free SQL Managed Instance is allowed per subscription.\n\n * 400 ManagementServiceGeodrSecondaryDatabaseInCreation - The '{0}' operation cannot be completed as there exists a database in a process of creation through failover group deployment. Please wait for the failover group deployment to complete, or alternatively delete the failover group and retry the operation again.\n\n * 400 ManagedInstanceConversionRegularToFreemiumNotAllowed - User tried converting a Regular SQL Managed Instance to Free SQL Managed Instance.\n\n * 400 ManagedInstanceConversionFreemiumToRegularAndUpdateSLOWhileStoppedNotAllowed - User tried converting a Free SQL Managed Instance to Regular SQL Managed Instance and Update SLO in same request, while Instance is stopped.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 ManagedInstanceMaintenanceWindowChangeNotAllowedWhenInInstancePool - Maintenance window is set at instance pool level and cannot be set individually per pooled instance.\n\n * 400 ManagedInstanceMoveToInstancePoolExceedsDbCountLimit - Cannot move the instance into the pool due to pool database count limit.\n\n * 400 ManagedInstancePoolZoneRedundancyNotSupported - Cannot move a zone-redundant instance into the pool as zone-redundancy is not supported in pools.\n\n * 400 DeploymentIntoPrivateSubnetsNotAllowed - Deploying managed instances and instance pools into private subnets is not supported.\n\n * 400 StorageIOpsNotSupported - Storage IOps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidCollation - Invalid collation.\n\n * 400 StorageThroughputMBpsNotSupported - Storage throughput MBps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 StorageIOpsNotSupportedForSpecifiedEdition - Storage IOps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 StorageThroughputMBpsNotSupportedForSpecifiedEdition - Storage throughput MBps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 ManagedInstanceClassicVnetNotSupported - Managed Instance cannot be joined to a classic virtual network.\n\n * 400 AlterDbDeactivatedNotSupported - Database Operation failed for Server '{0}', Database '{1}' due to unexpected delay. Please try again.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetConfigHasNsg - User tried to inject Managed Server subnet with Network Security Groups.\n\n * 400 VnetConfigHasNoUdr - User tried to inject Managed Server subnet without default User Defined Route Table.\n\n * 400 VnetConfigHasInvalidUdr - User tried to inject Managed Server subnet with invalid User Defined Route Table.\n\n * 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.\n\n * 400 VnetConfigHasServiceEndpoints - User tried to inject Managed Server subnet with service endpoints.\n\n * 400 VnetSubnetIsInUse - User tried to inject Managed Server subnet that is not empty.\n\n * 400 VnetSubnetIsLocked - User tried to inject Managed Server subnet that is in locked scope.\n\n * 400 VnetSubnetIsGateway - User tried to inject Managed Server subnet that is Gateway subnet.\n\n * 400 VnetSubnetIsUnknown - User tried to inject Managed Server subnet that does not exist.\n\n * 400 VnetSubnetConflictWithIntendedPolicy - User tried to inject Managed Server subnet that has a conflict with IntendedPolicy.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 ManagedInstanceInvalidEditionForSku - The specified edition {0} is not consistent with the specified SKU {1}.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInCreateOfMI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the create operation.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagedInstanceInvalidLicenseType - The specified license type {0} is not valid.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInUpdateOfGPV1MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V1 Managed Instance.\n\n * 400 UnspecifiedTargetEditionAndFalseGPV2NotAllowedInUpdateOfGPV2MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value FALSE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 GPTargetEditionAndUnspecifiedGPV2NotAllowedInUpdateOFGPV2MI - Combination of General Purpose target edition (sku.name/sku.tier parameters) and unspecified value for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 BCTargetEditionAndSpecifiedGPV2ParamNotAllowedInCreateUpdateOfMI - Combination of Business Critical target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the create/update operation.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 UnspecifiedTargetEditionAndSpecifiedGPV2ParamNotAllowedInUpdateOfBCMI - Combination of unspecified target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the update operation of Business Critical Managed Instance.\n\n * 400 TotalMemoryMBNotSupported - Total memory MB parameter is not allowed in the instance create/update operation.\n\n * 400 TotalMemoryMBNotSupportedForSpecifiedEdition - Total memory MB parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 VnetResourceNotFound - Resource not found: '{0}'.\n\n * 400 InvalidTimezone - Invalid timezone.\n\n * 400 InvalidSubnetForGPV2Edition - General Purpose v2 edition of Managed Instance is not compatible with the specified subnet. Target subnet must be either empty, or all instances in it must run with November 2022 Feature Wave.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 TotalMemoryMBInvalidLimit - Total memory MB parameter has been set to an invalid limit.\n\n * 400 ManagedInstanceUpdateSloGPv2PerDatabaseFileLimitExceeded - The operation could not be completed because there is at least one database whose number of files is exceeding the limit of {0} files per database on General Purpose v2 edition.\n\n * 400 InstanceCollationUpdateNotSupported - User cannot change instance collation on Managed Instance.\n\n * 400 NextGenGPNotSupportedForCmwCustomers - Next-Gen General Purpose edition of Managed Instance does not support Custom Maintance Window.\n\n * 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - User can create a Managed Instance only with collation 'SQL_Latin1_General_CP1_CI_AS'.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedInstanceExceedMaxAzureStorage - The operation could not be completed because total allocated storage size for General Purpose instance would exceed {0}. Please reduce the number of database files and retry operation.\n\n * 400 ManagedInstanceHasGeoReplica - The operation could not be completed because instance has configured geo replicated secondary instance.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 405 InvalidStorageIOpsLimitValue - Invalid storage IOps limit: {0} IOps. Storage IOps limit must be specified between {1} IOps and {2} IOps, in increments of {3} IOps.\n\n * 405 InvalidStorageThroughputMBpsLimitValue - Invalid storage throughput limit: {0} MBps. Storage throughput limit must be specified between {1} MBps and {2} MBps, in increments of {3} MBps.\n\n * 405 InvalidVcoreValue - vCore value {0} is not valid. Please specify a valid vCore value.\n\n * 405 InvalidHardwareGenerationValue - HardwareGeneration {0} is not valid. Please specify a valid HardwareGeneration value.\n\n * 405 InvalidStorageSizeValue - \"Invalid storage size: {0} GB. Storage size must be specified between {1} and {2} gigabytes, in increments of {3} GB.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 409 ServerOverridePreconditionFailed - Failed to apply server override on category '{0}', because physical db or instance '{1}' in server '{2}' is currently not in 'Ready' or 'Deactivated' state.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ManagedInstanceIsBusy - The server '{0}' is currently busy. Please wait a few minutes before trying again.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 GatewayInternalServerError - The server encountered an unexpected exception.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -96,7 +96,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidDnsZone - The operation has failed because you are attempting to deploy managed instance as a geo-replication secondary to the subnet {0} in which there already exists a managed instance. Deploying managed instance as a geo-replication secondary is supported only in cases when managed instance is the first instance deployed in a subnet. Consider deploying managed instance as a geo-replication secondary to a different subnet in which there are no existing managed instances, or if deploying to a subnet with existing managed instance disable the geo-replication option.\n\n * 400 HkCannotSwitchToInactive - The database cannot proceed with pricing-tier update as it has memory-optimized objects. Please drop such objects and try again.\n\n * 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - Invalid storage size: Storage size limit ({0} GB) is less that current storage used ({1} GB). Please specify higher storage size limit.\n\n * 400 InstanceTimezoneUpdateNotSupported - Instance timezone update not supported.\n\n * 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - Create Managed Instance with non-default timezone not supported.\n\n * 400 ManagedInstanceIpAddressRangeLimit - Cannot perform creation/scaling of the managed instance as there are not enough available IP addresses in the subnet for performing the operation.\n\n * 400 VnetDelegationNotAllowed - User tried to inject Managed Server to subnet which is delegated.\n\n * 400 SubnetHasResourcesOfDifferentType - User tried to create MI in subnet that has resources of different type.\n\n * 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - Update of Managed Instance with maintenance window settings is not allowed.\n\n * 400 OperationNotAllowedInCurrentGeodrConfiguration - The operation is not allowed because the current geo-replication configuration does not allow this combination of {0}. Change the setting on the geo-replication partner before applying the change on this instance.\n\n * 400 VnetPrepareNIPFailed - User tried to prepare subnet that has a conflict with NetworkIntentPolicy.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 ManagedInstanceDeprecatedHardwareFamily - Changing the hardware generation to deprecated {0} generation is not possible.\n\n * 400 ManagedInstanceBackupStorageTypeNotSupported - Backup storage type parameter is not allowed in the instance update operation.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 EmptyPDCInvalidDnsZone - This managed instance cannot be deployed because its DNS-zone does not match the DNS-prefix of its intended virtual cluster for subnet {0}. Although this virtual cluster is empty, its DNS-prefix cannot be changed. Empty virtual clusters will be automatically removed after several hours. Consider waiting for this virtual cluster to expire or manually deleting this virtual cluster and then creating the managed instance.\n\n * 400 InstancePoolNotEnoughCapacity - An instance pool does not have enough capacity\n\n * 400 ManagedInstanceFreemiumNotAvailableForInputParameters - Managed instance creation or update executed with SLO that is not allowed for freemium.\n\n * 400 ManagedInstanceFreemiumNotAvailableOnRegion - Creation of a freemium managed instance on a region that is not allowlisted for freemium.\n\n * 400 ManagementServiceSubnetMaintenanceInProgress - User tried to initiate managed instance create/update while incompatible maintenance is in progress.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ManagedInstanceFreemiumNotAvailableForSubscription - Freemium is not enabled for this subscription type.\n\n * 400 ManagedInstanceInvalidEditionForInstancePool - User tried to select invalid service tier for managed instance inside an existing instance pool.\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 ManagedInstanceInvalidSubnetForInstancePool - User tried to select invalid subnet for managed instance inside an existing instance pool.\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 ManagedInstanceZoneRedudantFeatureNotSupported - ZoneRedundant feature is not supported for the selected service tier. For more details visit aka.ms/sqlmi-service-tier-characteristics.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - Enabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - Disabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SubnetIdCantBeUpdated - Changing managed instance subnet is not supported operation. Please remove this parameter from the request.\n\n * 400 MigrationToAnotherVNetNotSupported - Selected subnet is in another Virtual Network. Moving managed instance to another Virtual Network is not possible. Please provide subnet from Virtual Network {0}.\n\n * 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - Provided subnet is having different DNS zone from the current. Changing instance DNS zone is not supported. Please provide subnet with same DNS zone, create a new subnet or provide empty one.\n\n * 400 MigrationToGen4SubnetNotSupported - It is not possible to update subnet while running on Gen4 hardware as it is being deprecated. Please upgrade your hardware from Gen4 to Gen5 as part of the changing managed instance subnet operation by specifying both parameters at the same time: destination subnet and hardware generation.\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - The operation could not be completed because some of the database files are exceeding maximum General Purpose file size limit of {0} GB.\n\n * 400 CloudLifterUnsupportedFeature - The functionality is not available on the Managed Instance at this time.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 OperationCanNotStartDueToMiLink - The '{0}' operation cannot be completed as there exists a database in a process of creation through Managed Instance link. Please wait for the link creation to complete, or delete the link, and retry the operation again.\n\n * 400 ManagedInstanceSloUpdateFailed - SLO '{0}' operation cannot succeed as the memory usage of '{1}' exceeds the quota.\n\n * 400 SourceAndTargetSubnetsMustBeVnetPeered - Subnet currently used by managed instance and provided destination subnet are part of the virtual networks that are not connected with virtual network peering, or have peering established but don't have allowed traffic. In order to move managed instance from one subnet to another, virtual network peering needs to be established from both source and target virtual network. Please configure virtual network requirements and then try the operation again. Learn more https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks. \n\n * 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - Subnet provided for managed instance deployment is located on subscription different than the one submitted for managed instance. Managed instance and subnet used for deploying the instance must be on the same subscription. Please provide another subnet or switch to the subnet subscription and then try the operation again.\n\n * 400 CreateManagedInstanceInvalidSubnetSize - User attempted to create managed instance in a subnet that is smaller than the allowed minimal subnet size.\n\n * 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - Subnet selected for managed instance migration has address range that overlaps with address range of subnet that holds geo replicated secondary instance. Please verify that your subnet is configured according to guidelines in https://aka.ms/move-managed-instance. \n\n * 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - Subnet selected for managed instance migration is not configured to enable communication with a geo replicated secondary instance. Please check if all of the required ports are open. To properly configure your subnet read the guidelines in https://aka.ms/move-managed-instance. \n\n * 400 ManagedInstanceLocalStorageUpdateSloDisabled - Update SLO for managed instances with local storage is not supported yet.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 GatewayInvalidEdition - '{0}' is not a valid database edition in this version of SQL Server.\n\n * 400 ManagedInstanceInvalidHardwareFamilyForInstancePool - User tried to select invalid hardware family for managed instance inside an existing instance pool.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 ManagedInstanceInvalidLicenseTypeForInstancePool - User tried to select invalid license type for managed instance inside an existing instance pool.\n\n * 400 ManagedInstanceUpdateSloFromVersionlessToVersionedNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 ManagedInstanceUpdateSloFromNewerToOlderVersionEditionNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 ManagedInstanceUpdateSloFromVersionedToVersionlessWorkerCLNotAllowed - Changing the database format is not supported for this managed instance. Check the database format property value specified and visit https://aka.ms/sqlmi-fwnov2022 for more details.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 ManagedInstanceVersionEditionParameterNotAllowedForUsing - Specifying the database format property value is not supported at this time.\n\n * 400 ManagedInstanceFreemiumInvalidArchitecture - A freemium instance can not be created in the specified subnet '(0)'.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ManagedInstanceGeoDRNotAllowedForInstancePool - Creating auto-failover group (GeoDR) is not supported for Managed Instances provisioned inside instance pools. Auto failover groups can be created only for standalone Managed Instances.\n\n * 400 ManagedInstanceWithGeoDRMoveToInstancePoolNotAllowed - Customer has attempted to move a standalone Managed Instance with an existing auto-failover group configured into an instance pool, which is not supported. Only standalone instances without existing auto-failover groups configured can be moved to instance pools.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerRegion - Creation of ZoneRedundant SQL MI is temporarily disabled on this region. You can create Zone Redundant SQL Managed Instances in many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerHardwareGeneration - Creation of ZoneRedundant SQL MI is temporarily disabled for this hardware generation on this region. You can create Zone Redundant SQL Managed Instances with different hardware generation on this region or many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceUpdateSloGeoPrimaryWithNewerVersionEditionThanSecondary - Database format change must be performed on the secondary instance of the failover group first. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 ManagedInstanceFreemiumInstanceAlreadyExists - Only one free SQL Managed Instance is allowed per subscription.\n\n * 400 ManagementServiceGeodrSecondaryDatabaseInCreation - The '{0}' operation cannot be completed as there exists a database in a process of creation through failover group deployment. Please wait for the failover group deployment to complete, or alternatively delete the failover group and retry the operation again.\n\n * 400 ManagedInstanceConversionRegularToFreemiumNotAllowed - User tried converting a Regular SQL Managed Instance to Free SQL Managed Instance.\n\n * 400 ManagedInstanceConversionFreemiumToRegularAndUpdateSLOWhileStoppedNotAllowed - User tried converting a Free SQL Managed Instance to Regular SQL Managed Instance and Update SLO in same request, while Instance is stopped.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 ManagedInstanceMaintenanceWindowChangeNotAllowedWhenInInstancePool - Maintenance window is set at instance pool level and cannot be set individually per pooled instance.\n\n * 400 ManagedInstanceMoveToInstancePoolExceedsDbCountLimit - Cannot move the instance into the pool due to pool database count limit.\n\n * 400 StorageIOpsNotSupported - Storage IOps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidCollation - Invalid collation.\n\n * 400 StorageThroughputMBpsNotSupported - Storage throughput MBps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 StorageIOpsNotSupportedForSpecifiedEdition - Storage IOps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 StorageThroughputMBpsNotSupportedForSpecifiedEdition - Storage throughput MBps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 ManagedInstanceClassicVnetNotSupported - Managed Instance cannot be joined to a classic virtual network.\n\n * 400 AlterDbDeactivatedNotSupported - Database Operation failed for Server '{0}', Database '{1}' due to unexpected delay. Please try again.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetConfigHasNsg - User tried to inject Managed Server subnet with Network Security Groups.\n\n * 400 VnetConfigHasNoUdr - User tried to inject Managed Server subnet without default User Defined Route Table.\n\n * 400 VnetConfigHasInvalidUdr - User tried to inject Managed Server subnet with invalid User Defined Route Table.\n\n * 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.\n\n * 400 VnetConfigHasServiceEndpoints - User tried to inject Managed Server subnet with service endpoints.\n\n * 400 VnetSubnetIsInUse - User tried to inject Managed Server subnet that is not empty.\n\n * 400 VnetSubnetIsLocked - User tried to inject Managed Server subnet that is in locked scope.\n\n * 400 VnetSubnetIsGateway - User tried to inject Managed Server subnet that is Gateway subnet.\n\n * 400 VnetSubnetIsUnknown - User tried to inject Managed Server subnet that does not exist.\n\n * 400 VnetSubnetConflictWithIntendedPolicy - User tried to inject Managed Server subnet that has a conflict with IntendedPolicy.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 ManagedInstanceInvalidEditionForSku - The specified edition {0} is not consistent with the specified SKU {1}.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInCreateOfMI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the create operation.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagedInstanceInvalidLicenseType - The specified license type {0} is not valid.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInUpdateOfGPV1MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V1 Managed Instance.\n\n * 400 UnspecifiedTargetEditionAndFalseGPV2NotAllowedInUpdateOfGPV2MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value FALSE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 GPTargetEditionAndUnspecifiedGPV2NotAllowedInUpdateOFGPV2MI - Combination of General Purpose target edition (sku.name/sku.tier parameters) and unspecified value for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 BCTargetEditionAndSpecifiedGPV2ParamNotAllowedInCreateUpdateOfMI - Combination of Business Critical target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the create/update operation.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 UnspecifiedTargetEditionAndSpecifiedGPV2ParamNotAllowedInUpdateOfBCMI - Combination of unspecified target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the update operation of Business Critical Managed Instance.\n\n * 400 TotalMemoryMBNotSupported - Total memory MB parameter is not allowed in the instance create/update operation.\n\n * 400 TotalMemoryMBNotSupportedForSpecifiedEdition - Total memory MB parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 VnetResourceNotFound - Resource not found: '{0}'.\n\n * 400 InvalidTimezone - Invalid timezone.\n\n * 400 InvalidSubnetForGPV2Edition - General Purpose v2 edition of Managed Instance is not compatible with the specified subnet. Target subnet must be either empty, or all instances in it must run with November 2022 Feature Wave.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 TotalMemoryMBInvalidLimit - Total memory MB parameter has been set to an invalid limit.\n\n * 400 ManagedInstanceUpdateSloGPv2PerDatabaseFileLimitExceeded - The operation could not be completed because there is at least one database whose number of files is exceeding the limit of {0} files per database on General Purpose v2 edition.\n\n * 400 InstanceCollationUpdateNotSupported - User cannot change instance collation on Managed Instance.\n\n * 400 NextGenGPNotSupportedForCmwCustomers - Next-Gen General Purpose edition of Managed Instance does not support Custom Maintenance Window.\n\n * 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - User can create a Managed Instance only with collation 'SQL_Latin1_General_CP1_CI_AS'.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedInstanceExceedMaxAzureStorage - The operation could not be completed because total allocated storage size for General Purpose instance would exceed {0}. Please reduce the number of database files and retry operation.\n\n * 400 ManagedInstanceHasGeoReplica - The operation could not be completed because instance has configured geo replicated secondary instance.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 405 InvalidStorageIOpsLimitValue - Invalid storage IOps limit: {0} IOps. Storage IOps limit must be specified between {1} IOps and {2} IOps, in increments of {3} IOps.\n\n * 405 InvalidStorageThroughputMBpsLimitValue - Invalid storage throughput limit: {0} MBps. Storage throughput limit must be specified between {1} MBps and {2} MBps, in increments of {3} MBps.\n\n * 405 InvalidVcoreValue - vCore value {0} is not valid. Please specify a valid vCore value.\n\n * 405 InvalidHardwareGenerationValue - HardwareGeneration {0} is not valid. Please specify a valid HardwareGeneration value.\n\n * 405 InvalidStorageSizeValue - \"Invalid storage size: {0} GB. Storage size must be specified between {1} and {2} gigabytes, in increments of {3} GB.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 409 ServerOverridePreconditionFailed - Failed to apply server override on category '{0}', because physical db or instance '{1}' in server '{2}' is currently not in 'Ready' or 'Deactivated' state.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ManagedInstanceIsBusy - The server '{0}' is currently busy. Please wait a few minutes before trying again.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 GatewayInternalServerError - The server encountered an unexpected exception.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", + "description": "*** Error Responses: ***\n\n * 400 InvalidDnsZone - The operation has failed because you are attempting to deploy managed instance as a geo-replication secondary to the subnet {0} in which there already exists a managed instance. Deploying managed instance as a geo-replication secondary is supported only in cases when managed instance is the first instance deployed in a subnet. Consider deploying managed instance as a geo-replication secondary to a different subnet in which there are no existing managed instances, or if deploying to a subnet with existing managed instance disable the geo-replication option.\n\n * 400 HkCannotSwitchToInactive - The database cannot proceed with pricing-tier update as it has memory-optimized objects. Please drop such objects and try again.\n\n * 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - Invalid storage size: Storage size limit ({0} GB) is less that current storage used ({1} GB). Please specify higher storage size limit.\n\n * 400 InstanceTimezoneUpdateNotSupported - Instance timezone update not supported.\n\n * 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - Create Managed Instance with non-default timezone not supported.\n\n * 400 ManagedInstanceIpAddressRangeLimit - Cannot perform creation/scaling of the managed instance as there are not enough available IP addresses in the subnet for performing the operation.\n\n * 400 VnetDelegationNotAllowed - User tried to inject Managed Server to subnet which is delegated.\n\n * 400 SubnetHasResourcesOfDifferentType - User tried to create MI in subnet that has resources of different type.\n\n * 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - Update of Managed Instance with maintenance window settings is not allowed.\n\n * 400 OperationNotAllowedInCurrentGeodrConfiguration - The operation is not allowed because the current geo-replication configuration does not allow this combination of {0}. Change the setting on the geo-replication partner before applying the change on this instance.\n\n * 400 VnetPrepareNIPFailed - User tried to prepare subnet that has a conflict with NetworkIntentPolicy.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 ManagedInstanceDeprecatedHardwareFamily - Changing the hardware generation to deprecated {0} generation is not possible.\n\n * 400 ManagedInstanceBackupStorageTypeNotSupported - Backup storage type parameter is not allowed in the instance update operation.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 EmptyPDCInvalidDnsZone - This managed instance cannot be deployed because its DNS-zone does not match the DNS-prefix of its intended virtual cluster for subnet {0}. Although this virtual cluster is empty, its DNS-prefix cannot be changed. Empty virtual clusters will be automatically removed after several hours. Consider waiting for this virtual cluster to expire or manually deleting this virtual cluster and then creating the managed instance.\n\n * 400 InstancePoolNotEnoughCapacity - An instance pool does not have enough capacity\n\n * 400 ManagedInstanceFreemiumNotAvailableForInputParameters - Managed instance creation or update executed with SLO that is not allowed for freemium.\n\n * 400 ManagedInstanceFreemiumNotAvailableOnRegion - Creation of a freemium managed instance on a region that is not allowlisted for freemium.\n\n * 400 ManagementServiceSubnetMaintenanceInProgress - User tried to initiate managed instance create/update while incompatible maintenance is in progress.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 ManagedInstanceFreemiumNotAvailableForSubscription - Freemium is not enabled for this subscription type.\n\n * 400 ManagedInstanceInvalidEditionForInstancePool - User tried to select invalid service tier for managed instance inside an existing instance pool.\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 ManagedInstanceInvalidSubnetForInstancePool - User tried to select invalid subnet for managed instance inside an existing instance pool.\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 ManagedInstanceZoneRedudantFeatureNotSupported - ZoneRedundant feature is not supported for the selected service tier. For more details visit aka.ms/sqlmi-service-tier-characteristics.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - Enabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - Disabling zoneRedundant feature is not possible once managed instance is created. For more details visit aka.ms/sqlmi-high-availability.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 SubnetIdCantBeUpdated - Changing managed instance subnet is not supported operation. Please remove this parameter from the request.\n\n * 400 MigrationToAnotherVNetNotSupported - Selected subnet is in another Virtual Network. Moving managed instance to another Virtual Network is not possible. Please provide subnet from Virtual Network {0}.\n\n * 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - Provided subnet is having different DNS zone from the current. Changing instance DNS zone is not supported. Please provide subnet with same DNS zone, create a new subnet or provide empty one.\n\n * 400 MigrationToGen4SubnetNotSupported - It is not possible to update subnet while running on Gen4 hardware as it is being deprecated. Please upgrade your hardware from Gen4 to Gen5 as part of the changing managed instance subnet operation by specifying both parameters at the same time: destination subnet and hardware generation.\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - The operation could not be completed because some of the database files are exceeding maximum General Purpose file size limit of {0} GB.\n\n * 400 CloudLifterUnsupportedFeature - The functionality is not available on the Managed Instance at this time.\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 OperationCanNotStartDueToMiLink - The '{0}' operation cannot be completed as there exists a database in a process of creation through Managed Instance link. Please wait for the link creation to complete, or delete the link, and retry the operation again.\n\n * 400 ManagedInstanceSloUpdateFailed - SLO '{0}' operation cannot succeed as the memory usage of '{1}' exceeds the quota.\n\n * 400 SourceAndTargetSubnetsMustBeVnetPeered - Subnet currently used by managed instance and provided destination subnet are part of the virtual networks that are not connected with virtual network peering, or have peering established but don't have allowed traffic. In order to move managed instance from one subnet to another, virtual network peering needs to be established from both source and target virtual network. Please configure virtual network requirements and then try the operation again. Learn more https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks. \n\n * 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - Subnet provided for managed instance deployment is located on subscription different than the one submitted for managed instance. Managed instance and subnet used for deploying the instance must be on the same subscription. Please provide another subnet or switch to the subnet subscription and then try the operation again.\n\n * 400 CreateManagedInstanceInvalidSubnetSize - User attempted to create managed instance in a subnet that is smaller than the allowed minimal subnet size.\n\n * 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - Subnet selected for managed instance migration has address range that overlaps with address range of subnet that holds geo replicated secondary instance. Please verify that your subnet is configured according to guidelines in https://aka.ms/move-managed-instance. \n\n * 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - Subnet selected for managed instance migration is not configured to enable communication with a geo replicated secondary instance. Please check if all of the required ports are open. To properly configure your subnet read the guidelines in https://aka.ms/move-managed-instance. \n\n * 400 ManagedInstanceLocalStorageUpdateSloDisabled - Update SLO for managed instances with local storage is not supported yet.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 GatewayInvalidEdition - '{0}' is not a valid database edition in this version of SQL Server.\n\n * 400 ManagedInstanceInvalidHardwareFamilyForInstancePool - User tried to select invalid hardware family for managed instance inside an existing instance pool.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 ManagedInstanceInvalidLicenseTypeForInstancePool - User tried to select invalid license type for managed instance inside an existing instance pool.\n\n * 400 ManagedInstanceUpdateSloFromVersionlessToVersionedNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 ManagedInstanceUpdateSloFromNewerToOlderVersionEditionNotAllowed - Changing the database format from '{0}' to '{1}' is not supported. Check the database format property value specified and visit https://aka.ms/sqlmidatabaseformat for more details.\n\n * 400 InstanceFailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 ManagedInstanceUpdateSloFromVersionedToVersionlessWorkerCLNotAllowed - Changing the database format is not supported for this managed instance. Check the database format property value specified and visit https://aka.ms/sqlmi-fwnov2022 for more details.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 ManagedInstanceVersionEditionParameterNotAllowedForUsing - Specifying the database format property value is not supported at this time.\n\n * 400 ManagedInstanceFreemiumInvalidArchitecture - A freemium instance can not be created in the specified subnet '(0)'.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ManagedInstanceWithGeoDRMoveToInstancePoolNotAllowed - Customer has attempted to move a standalone Managed Instance with an existing auto-failover group configured into an instance pool, which is not supported. Only standalone instances without existing auto-failover groups configured can be moved to instance pools.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerRegion - Creation of ZoneRedundant SQL MI is temporarily disabled on this region. You can create Zone Redundant SQL Managed Instances in many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceZoneRedudantFeatureTemporarilyDisabledPerHardwareGeneration - Creation of ZoneRedundant SQL MI is temporarily disabled for this hardware generation on this region. You can create Zone Redundant SQL Managed Instances with different hardware generation on this region or many other regions in Azure. https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/high-availability-sla?view=azuresql-mi#zone-redundant-availability.\n\n * 400 ManagedInstanceUpdateSloGeoPrimaryWithNewerVersionEditionThanSecondary - Database format change must be performed on the secondary instance of the failover group first. See https://go.microsoft.com/fwlink/?linkid=2251601 for more details.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 ManagedInstanceFreemiumInstanceAlreadyExists - Only one free SQL Managed Instance is allowed per subscription.\n\n * 400 ManagementServiceGeodrSecondaryDatabaseInCreation - The '{0}' operation cannot be completed as there exists a database in a process of creation through failover group deployment. Please wait for the failover group deployment to complete, or alternatively delete the failover group and retry the operation again.\n\n * 400 ManagedInstanceConversionRegularToFreemiumNotAllowed - User tried converting a Regular SQL Managed Instance to Free SQL Managed Instance.\n\n * 400 ManagedInstanceConversionFreemiumToRegularAndUpdateSLOWhileStoppedNotAllowed - User tried converting a Free SQL Managed Instance to Regular SQL Managed Instance and Update SLO in same request, while Instance is stopped.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 ManagedInstanceMaintenanceWindowChangeNotAllowedWhenInInstancePool - Maintenance window is set at instance pool level and cannot be set individually per pooled instance.\n\n * 400 ManagedInstanceMoveToInstancePoolExceedsDbCountLimit - Cannot move the instance into the pool due to pool database count limit.\n\n * 400 ManagedInstancePoolZoneRedundancyNotSupported - Cannot move a zone-redundant instance into the pool as zone-redundancy is not supported in pools.\n\n * 400 DeploymentIntoPrivateSubnetsNotAllowed - Deploying managed instances and instance pools into private subnets is not supported.\n\n * 400 StorageIOpsNotSupported - Storage IOps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidCollation - Invalid collation.\n\n * 400 StorageThroughputMBpsNotSupported - Storage throughput MBps parameter is not allowed in the instance create/update operation.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 StorageIOpsNotSupportedForSpecifiedEdition - Storage IOps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 StorageThroughputMBpsNotSupportedForSpecifiedEdition - Storage throughput MBps parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 ManagedInstanceClassicVnetNotSupported - Managed Instance cannot be joined to a classic virtual network.\n\n * 400 AlterDbDeactivatedNotSupported - Database Operation failed for Server '{0}', Database '{1}' due to unexpected delay. Please try again.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetConfigHasNsg - User tried to inject Managed Server subnet with Network Security Groups.\n\n * 400 VnetConfigHasNoUdr - User tried to inject Managed Server subnet without default User Defined Route Table.\n\n * 400 VnetConfigHasInvalidUdr - User tried to inject Managed Server subnet with invalid User Defined Route Table.\n\n * 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.\n\n * 400 VnetConfigHasServiceEndpoints - User tried to inject Managed Server subnet with service endpoints.\n\n * 400 VnetSubnetIsInUse - User tried to inject Managed Server subnet that is not empty.\n\n * 400 VnetSubnetIsLocked - User tried to inject Managed Server subnet that is in locked scope.\n\n * 400 VnetSubnetIsGateway - User tried to inject Managed Server subnet that is Gateway subnet.\n\n * 400 VnetSubnetIsUnknown - User tried to inject Managed Server subnet that does not exist.\n\n * 400 VnetSubnetConflictWithIntendedPolicy - User tried to inject Managed Server subnet that has a conflict with IntendedPolicy.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 ManagedInstanceInvalidEditionForSku - The specified edition {0} is not consistent with the specified SKU {1}.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInCreateOfMI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the create operation.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ManagedInstanceInvalidLicenseType - The specified license type {0} is not valid.\n\n * 400 UnspecifiedTargetEditionAndTrueGPV2NotAllowedInUpdateOfGPV1MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value TRUE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V1 Managed Instance.\n\n * 400 UnspecifiedTargetEditionAndFalseGPV2NotAllowedInUpdateOfGPV2MI - Combination of unspecified target edition (sku.name/sku.tier parameters) and the value FALSE for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 GPTargetEditionAndUnspecifiedGPV2NotAllowedInUpdateOFGPV2MI - Combination of General Purpose target edition (sku.name/sku.tier parameters) and unspecified value for the isGeneralPurposeV2 parameter is not allowed in the update operation of General Purpose V2 Managed Instance.\n\n * 400 BCTargetEditionAndSpecifiedGPV2ParamNotAllowedInCreateUpdateOfMI - Combination of Business Critical target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the create/update operation.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 UnspecifiedTargetEditionAndSpecifiedGPV2ParamNotAllowedInUpdateOfBCMI - Combination of unspecified target edition (sku.name/sku.tier parameters) with a specified isGeneralPurposeV2 parameter is not allowed in the update operation of Business Critical Managed Instance.\n\n * 400 TotalMemoryMBNotSupported - Total memory MB parameter is not allowed in the instance create/update operation.\n\n * 400 TotalMemoryMBNotSupportedForSpecifiedEdition - Total memory MB parameter is not allowed in the instance create/update operation for the specified edition.\n\n * 400 VnetResourceNotFound - Resource not found: '{0}'.\n\n * 400 InvalidTimezone - Invalid timezone.\n\n * 400 InvalidSubnetForGPV2Edition - General Purpose v2 edition of Managed Instance is not compatible with the specified subnet. Target subnet must be either empty, or all instances in it must run with November 2022 Feature Wave.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 TotalMemoryMBInvalidLimit - Total memory MB parameter has been set to an invalid limit.\n\n * 400 ManagedInstanceUpdateSloGPv2PerDatabaseFileLimitExceeded - The operation could not be completed because there is at least one database whose number of files is exceeding the limit of {0} files per database on General Purpose v2 edition.\n\n * 400 InstanceCollationUpdateNotSupported - User cannot change instance collation on Managed Instance.\n\n * 400 NextGenGPNotSupportedForCmwCustomers - Next-Gen General Purpose edition of Managed Instance does not support Custom Maintance Window.\n\n * 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - User can create a Managed Instance only with collation 'SQL_Latin1_General_CP1_CI_AS'.\n\n * 400 ManagedInstanceOperationInProgress - The operation could not be completed because {0} operation is in progress. Please wait for the operation in progress to complete and try again.\n\n * 400 ManagedInstanceExceedMaxAzureStorage - The operation could not be completed because total allocated storage size for General Purpose instance would exceed {0}. Please reduce the number of database files and retry operation.\n\n * 400 ManagedInstanceHasGeoReplica - The operation could not be completed because instance has configured geo replicated secondary instance.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 405 InvalidStorageIOpsLimitValue - Invalid storage IOps limit: {0} IOps. Storage IOps limit must be specified between {1} IOps and {2} IOps, in increments of {3} IOps.\n\n * 405 InvalidStorageThroughputMBpsLimitValue - Invalid storage throughput limit: {0} MBps. Storage throughput limit must be specified between {1} MBps and {2} MBps, in increments of {3} MBps.\n\n * 405 InvalidVcoreValue - vCore value {0} is not valid. Please specify a valid vCore value.\n\n * 405 InvalidHardwareGenerationValue - HardwareGeneration {0} is not valid. Please specify a valid HardwareGeneration value.\n\n * 405 InvalidStorageSizeValue - \"Invalid storage size: {0} GB. Storage size must be specified between {1} and {2} gigabytes, in increments of {3} GB.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 409 ServerOverridePreconditionFailed - Failed to apply server override on category '{0}', because physical db or instance '{1}' in server '{2}' is currently not in 'Ready' or 'Deactivated' state.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ManagedInstanceIsBusy - The server '{0}' is currently busy. Please wait a few minutes before trying again.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 GatewayInternalServerError - The server encountered an unexpected exception.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/TransparentDataEncryptions.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/TransparentDataEncryptions.json index df20ac07d5e7..74ab96ce27b0 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/TransparentDataEncryptions.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/TransparentDataEncryptions.json @@ -206,7 +206,12 @@ } }, "202": { - "description": "Creating or updating the database transparent data encryption configuration is in progress." + "description": "Creating or updating the database transparent data encryption configuration is in progress.", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully created the database transparent data encryption state.", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/VirtualClusters.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/VirtualClusters.json index 20b6d9a29475..375e8846b388 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/VirtualClusters.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/VirtualClusters.json @@ -169,7 +169,12 @@ } }, "202": { - "description": "Deleting the virtual cluster is in progress." + "description": "Deleting the virtual cluster is in progress.", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "The specified virtual cluster does not exist." @@ -225,7 +230,12 @@ } }, "202": { - "description": "Updating the virtual cluster is in progress." + "description": "Updating the virtual cluster is in progress.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -271,7 +281,12 @@ } }, "202": { - "description": "Successfully started synchronize of DNS servers inside virtual cluster." + "description": "Successfully started synchronize of DNS servers inside virtual cluster.", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/VirtualNetworkRules.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/VirtualNetworkRules.json index 60ff5943b2ff..1183e42414d6 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/VirtualNetworkRules.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/VirtualNetworkRules.json @@ -159,7 +159,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully created a virtual network rule.", @@ -213,7 +218,12 @@ } }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "The specified virtual network rule does not exist." diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/WorkloadClassifiers.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/WorkloadClassifiers.json index 515bbde179cf..5aa3efd00c1d 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/WorkloadClassifiers.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/WorkloadClassifiers.json @@ -189,7 +189,12 @@ } }, "202": { - "description": "Create or update for the workload classifier is in progress." + "description": "Create or update for the workload classifier is in progress.", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully created the workload classifier.", @@ -256,7 +261,12 @@ } }, "202": { - "description": "Deleting the workload classifier is in progress." + "description": "Deleting the workload classifier is in progress.", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "The specified workload classifier does not exist." diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/WorkloadGroups.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/WorkloadGroups.json index 1679a8caa0b2..dfcea2ddf618 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/WorkloadGroups.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/WorkloadGroups.json @@ -168,7 +168,12 @@ } }, "202": { - "description": "Create or update for the workload group accepted." + "description": "Create or update for the workload group accepted.", + "headers": { + "Location": { + "type": "string" + } + } }, "201": { "description": "Successfully created the workload group.", @@ -228,7 +233,12 @@ } }, "202": { - "description": "Deleting the workload group is in progress." + "description": "Deleting the workload group is in progress.", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "The specified workload group does not exist." diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/examples/DatabaseSqlVulnerabilityAssessmentScan.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/examples/DatabaseSqlVulnerabilityAssessmentScan.json index 9140a7405a5f..2dcccfeb3c42 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/examples/DatabaseSqlVulnerabilityAssessmentScan.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/examples/DatabaseSqlVulnerabilityAssessmentScan.json @@ -21,7 +21,7 @@ "server": "vulnerabilityassessmenttest-6411", "database": "testdb", "sqlVersion": "15.0.2000", - "startTime": "2020-06-23T12:19:00.6455136+05:30", + "startTime": "2020-06-22T23:49:00.6455136-07:00", "endTime": "2020-06-23T06:49:00.7236217Z", "highSeverityFailedRulesCount": 3, "mediumSeverityFailedRulesCount": 2, @@ -30,7 +30,7 @@ "totalFailedRulesCount": 6, "totalRulesCount": 26, "isBaselineApplied": false, - "lastScanTime": "2020-06-23T12:19:00.6455136+05:30" + "lastScanTime": "2020-06-22T23:49:00.6455136-07:00" } } } diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/examples/DatabaseSqlVulnerabilityAssessmentScanRecordsListByDatabase.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/examples/DatabaseSqlVulnerabilityAssessmentScanRecordsListByDatabase.json index 5826bf024067..3dadd637491d 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/examples/DatabaseSqlVulnerabilityAssessmentScanRecordsListByDatabase.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/examples/DatabaseSqlVulnerabilityAssessmentScanRecordsListByDatabase.json @@ -22,7 +22,7 @@ "server": "vulnerabilityassessmenttest-6411", "database": "testdb", "sqlVersion": "15.0.2000", - "startTime": "2020-06-23T12:19:00.6455136+05:30", + "startTime": "2020-06-22T23:49:00.6455136-07:00", "endTime": "2020-06-23T06:49:00.7236217Z", "highSeverityFailedRulesCount": 3, "mediumSeverityFailedRulesCount": 2, @@ -31,7 +31,7 @@ "totalFailedRulesCount": 6, "totalRulesCount": 26, "isBaselineApplied": false, - "lastScanTime": "2020-06-23T12:19:00.6455136+05:30" + "lastScanTime": "2020-06-22T23:49:00.6455136-07:00" } }, { @@ -45,7 +45,7 @@ "server": "vulnerabilityassessmenttest-6411", "database": "testdb", "sqlVersion": "15.0.2000", - "startTime": "2020-06-23T12:19:00.6455136+05:30", + "startTime": "2020-06-22T23:49:00.6455136-07:00", "endTime": "2020-06-23T06:49:00.7236217Z", "highSeverityFailedRulesCount": 3, "mediumSeverityFailedRulesCount": 2, @@ -54,7 +54,7 @@ "totalFailedRulesCount": 6, "totalRulesCount": 26, "isBaselineApplied": false, - "lastScanTime": "2020-06-23T12:19:00.6455136+05:30" + "lastScanTime": "2020-06-22T23:49:00.6455136-07:00" } }, { @@ -68,7 +68,7 @@ "server": "vulnerabilityassessmenttest-6411", "database": "testdb", "sqlVersion": "15.0.2000", - "startTime": "2020-06-23T12:19:00.6455136+05:30", + "startTime": "2020-06-22T23:49:00.6455136-07:00", "endTime": "2020-06-23T06:49:00.7236217Z", "highSeverityFailedRulesCount": 3, "mediumSeverityFailedRulesCount": 2, @@ -77,7 +77,7 @@ "totalFailedRulesCount": 6, "totalRulesCount": 26, "isBaselineApplied": false, - "lastScanTime": "2020-06-23T12:19:00.6455136+05:30" + "lastScanTime": "2020-06-22T23:49:00.6455136-07:00" } } ] diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/examples/LocationCapabilityListByLocation.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/examples/LocationCapabilityListByLocation.json index e05ed6b97377..674bd7e0a75d 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/examples/LocationCapabilityListByLocation.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/examples/LocationCapabilityListByLocation.json @@ -3249,7 +3249,8 @@ ] } ], - "status": "Available" + "status": "Available", + "isZoneResilientProvisioningAllowed": false } } } diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/examples/SqlVulnerabilityAssessmentScan.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/examples/SqlVulnerabilityAssessmentScan.json index bf2eb73ac677..40723bd7bbec 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/examples/SqlVulnerabilityAssessmentScan.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/examples/SqlVulnerabilityAssessmentScan.json @@ -21,7 +21,7 @@ "server": "vulnerabilityassessmenttest-6411", "database": "master", "sqlVersion": "15.0.2000", - "startTime": "2020-06-23T12:19:00.6455136+05:30", + "startTime": "2020-06-22T23:49:00.6455136-07:00", "endTime": "2020-06-23T06:49:00.7236217Z", "highSeverityFailedRulesCount": 3, "mediumSeverityFailedRulesCount": 2, @@ -30,7 +30,7 @@ "totalFailedRulesCount": 6, "totalRulesCount": 26, "isBaselineApplied": false, - "lastScanTime": "2020-06-23T12:19:00.6455136+05:30" + "lastScanTime": "2020-06-22T23:49:00.6455136-07:00" } } } diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/examples/SqlVulnerabilityAssessmentScanRecordsListByDatabase.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/examples/SqlVulnerabilityAssessmentScanRecordsListByDatabase.json index 3477b8ec4248..9a8e6b28a928 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/examples/SqlVulnerabilityAssessmentScanRecordsListByDatabase.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/examples/SqlVulnerabilityAssessmentScanRecordsListByDatabase.json @@ -22,7 +22,7 @@ "server": "vulnerabilityassessmenttest-6411", "database": "master", "sqlVersion": "15.0.2000", - "startTime": "2020-06-23T12:19:00.6455136+05:30", + "startTime": "2020-06-22T23:49:00.6455136-07:00", "endTime": "2020-06-23T06:49:00.7236217Z", "highSeverityFailedRulesCount": 3, "mediumSeverityFailedRulesCount": 2, @@ -31,7 +31,7 @@ "totalFailedRulesCount": 6, "totalRulesCount": 26, "isBaselineApplied": false, - "lastScanTime": "2020-06-23T12:19:00.6455136+05:30" + "lastScanTime": "2020-06-22T23:49:00.6455136-07:00" } }, { @@ -45,7 +45,7 @@ "server": "vulnerabilityassessmenttest-6411", "database": "master", "sqlVersion": "15.0.2000", - "startTime": "2020-06-23T12:19:00.6455136+05:30", + "startTime": "2020-06-22T23:49:00.6455136-07:00", "endTime": "2020-06-23T06:49:00.7236217Z", "highSeverityFailedRulesCount": 3, "mediumSeverityFailedRulesCount": 2, @@ -54,7 +54,7 @@ "totalFailedRulesCount": 6, "totalRulesCount": 26, "isBaselineApplied": false, - "lastScanTime": "2020-06-23T12:19:00.6455136+05:30" + "lastScanTime": "2020-06-22T23:49:00.6455136-07:00" } }, { @@ -68,7 +68,7 @@ "server": "vulnerabilityassessmenttest-6411", "database": "master", "sqlVersion": "15.0.2000", - "startTime": "2020-06-23T12:19:00.6455136+05:30", + "startTime": "2020-06-22T23:49:00.6455136-07:00", "endTime": "2020-06-23T06:49:00.7236217Z", "highSeverityFailedRulesCount": 0, "mediumSeverityFailedRulesCount": 0, @@ -77,7 +77,7 @@ "totalFailedRulesCount": 6, "totalRulesCount": 26, "isBaselineApplied": true, - "lastScanTime": "2020-06-23T12:19:00.6455136+05:30" + "lastScanTime": "2020-06-22T23:49:00.6455136-07:00" } } ]